Create new CLI command: enable/disable Magento Profiler

[vrann]

In order to help developers to work with the Magento, create new commands which will simplify the debugging of the application. Currently, enabling of these setting require doing that either with the UI or changing the configuration of the di.xml.

Create CLI command which will make possible to enable/disable Magento Profiler

[okorshenko]

Hi @SasiKiranK please let us know if you are still working in this issue. Thank you

[osrecio]

Can I help with this task?

[okorshenko]

Hi @osrecio Sure! I will assign it to you. Thank you

[osrecio]

Hi @vrann and @okorshenko , I have question about this task:

In file: app/bootstrap.php $_SERVER['MAGE_PROFILER'] is not empty.
The problem of this that you can do:SetEnv MAGE_PROFILER "html" in your .htaccess but you can have another HTTP Server like nginx.

Can I move this Enviroment Variable to env.php like MAGE_MODE ?

I think is better approach, I can keep 2 ways from $_SERVER and from env.php What do you think?

Thanks!

[peterjaap]

@osrecio I don't think it's a good idea to move it to env.php. The reason being that env.php is not yet parsed by app/bootstrap.php by the time it now initializes the profiler, thereby eliminating the possibility to profile everything before the moment it parses env.php.

My suggestion would be to use a flagfile (like ./var/profiler.flag) to activate the profiler, and use the CLI command to add/remove it and set the profiler type (html, csvfile or something custom).

Quick write-out (I'll be happy to create a PR for it);

Instead of this part in app/bootstrap.php;

if (!empty($_SERVER['MAGE_PROFILER'])
    && isset($_SERVER['HTTP_ACCEPT'])
    && strpos($_SERVER['HTTP_ACCEPT'], 'text/html') !== false
) {
    \Magento\Framework\Profiler::applyConfig(
        $_SERVER['MAGE_PROFILER'],
        BP,
        !empty($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
    );
}

We use;

if (
    (!empty($_SERVER['MAGE_PROFILER']) || file_exists(BP . '/var/profiler.flag'))
    && isset($_SERVER['HTTP_ACCEPT'])
    && strpos($_SERVER['HTTP_ACCEPT'], 'text/html') !== false
) {
    \Magento\Framework\Profiler::applyConfig(
        ((isset($_SERVER['MAGE_PROFILER']) && strlen($_SERVER['MAGE_PROFILER']) ? $_SERVER['MAGE_PROFILER'] : file_get_contents(BP . '/var/profiler.flag')),
        BP,
        !empty($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
    );
}

And then use php bin/magento dev:profiler:enable <type> (with type default html) and php bin/magento dev:profiler:disable to enable the profiler by creating the flagfile and disable the profiler by removing the file.

[osrecio]

GO ahead with PR, I forgot this task :) . I think your idea is good, I like it like maintenance file, etc

Thanks @peterjaap

[peterjaap]

@osrecio 45 minutes booooom 🔥

[osrecio]

You’re the best 😎

[okorshenko]

Delivered to 2.2-develop branch.
The feature will be a part of 2.2.3

[keharper]

@peterjaap I need to know more about these commands so that they can be documented.

• Are they intended to replace the functionality described at http://devdocs.magento.com/guides/v2.2/config-guide/bootstrap/mage-profiler.html ?

• What happens if the profiler is already enabled and you run the enable command?

• Can the enable command take any arguments other than html or csvfile?

[peterjaap]

@keharper

1. It does not replace it per se, it is just another way to enable/disable the profiler. Also, this new command does not enable you to enable the dependency graph option.
2. It will just enable it again (/still); https://github.com/magento/magento2/pull/11407/files#diff-30813cda1ee05b4cd04f143198b6d5e1R90
3. No. It will give a warning in that case; https://github.com/magento/magento2/pull/11407/files#diff-30813cda1ee05b4cd04f143198b6d5e1R85

[magento-engcom-team]

Hi @vrann. Thank you for your report.
The issue has been fixed in magento-engcom/magento2ce#1359 by @magento-engcom-team in 2.3-develop branch
Related commit(s):

• 1db3f8f
• 412d228
• 02620b0
• 57c5d8a
• 94a3f03
• 0d557dc
• 48baf59
• dc3bb78
• 0ab4533
• 00f64b0
• 440a1b5
• 4ed8f5b
• 656eeb5
• fd2f731
• 2c1a23f
• f7ff71a
• ac9bcfa
• 55debe0
• 3495086
• d678f15
• bf8ee30
• 335c91c
• c5a823f
• 696a5a5

The fix will be available with the upcoming 2.3.0 release.