[DDEV] Support for `xhprof`/`xhgui`

[sreichel]

Description (*)

Support https://github.com/ddev/ddev-xhgui

• git-ignore config-file
• updated unittest

Related Pull Requests

1. see https://github.com/ddev/ddev-xhgui/pull/33

Manual testing scenarios (*)

Using DDEV ...

• add ddev.xhgui.php to app/etc/includes

if (getenv('IS_DDEV_PROJECT') && getenv('NO_XHGUI') !== '1') {
    if (file_exists($xhgui = '/mnt/ddev_config/xhgui/collector/xhgui.collector.php')) {
        require_once $xhgui;
    }
}

• ddev xhprof ... to enable profiler
• ddev xhgui ... to watch results

[addison74]

@sreichel - Before starting testing I would like to clarify all the steps based on the description.

1. Install the perftools/php-profiler package using the command

ddev composer require perftools/php-profiler --dev

2. Edit the app/Mage.php file just after the / AUTOLOADER PATCH / section to include the collector

if (file_exists("/mnt/ddev_config/xhgui/collector/xhgui.collector.php")) {
 require_once "/mnt/ddev_config/xhgui/collector/xhgui.collector.php";
}

3. Create a file named ddev.xhgui.php in the app/etc/includes directory with this content

<?php
if (getenv('IS_DDEV_PROJECT') && getenv('NO_XHGUI') !== '1') {
    if (file_exists($xhgui = '/mnt/ddev_config/xhgui/collector/xhgui.collector.php')) {
        require_once $xhgui;
    }
}

4. Run the ddev xhprof command to start profiling. XHGui is now available at https://yourproject.ddev.site:8142.

5. Run the ddev xhgui to watch results.

Have I missed anything so far? It will help me to add this information in this file https://github.com/OpenMage/magento-lts/blob/f39a667c9d9eda4c4c015e29f40c78d8ed2dec38/docs/content/developers/ddev.md, after merging.

In this comment https://github.com/ddev/ddev-xhgui/pull/33#issuecomment-2450269258 you say the step 2 from above has no effect, we don't need to edit app/Mage.php, but it is still in the DDEV-XHGui documentation.

[sreichel]

Have I missed anything so far?

No. This should be all.

In this comment https://github.com/ddev/ddev-xhgui/pull/33#issuecomment-2450269258 you say the step 2 from above has no effect, we don't need to edit app/Mage.php, but it is still in the DDEV-XHGui documentation.

DOC will be updated later.

[addison74]

OK. Please resolve the conflict related to the composer.lock file.

[sreichel]

It will help me to add this information in this file.

Thanks. :)

But wait for https://github.com/ddev/ddev-xhgui/pull/33. This could be automated a bit.