Change xdebug trigger method to improve performance

[danstaver]

Description Today, you have to manually enable/disable xdebug, which is taking time, and sometime the user can forget to enable it and wonders why the breakpoint didnt trigger, or, you have the option to always have it enabled, which is negatively affecting performance in local.

It would be great if we could have the same logic in place as what today adobe commerce cloud has, where, even in production i can trigger xdebug, without it affecting regular users https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/develop/test/debug#debug-for-pro-staging-and-production What we could try to do, implement something similar to comment #2 from https://github.com/magento/magento-cloud-docker/issues/112#issuecomment-565345812

Steps To Reproduce

1. N/A

Expected Result

• xdebug triggers only when XDEBUG_SESSION cookie present in request. This request is being sent to a separate process with loaded and configured xdebug extension
• if XDEBUG_SESSION cookie not present, request is sent to a process which does not have xdebug loaded at all

Actual Result xdebug is either enabled or disabled (but, even if enabled or disabled, the extension is still loaded)

[jarzebowsky]

I will share my knowledge to simplify the debugging to minimalist setup. Give me some time to prepare PR.

[markshust]

Hey @danstaver and @Jarzebowsky,

The bin/xdebug script was completely rebuilt in early February (sorry that I forgot to update this ticket). It now starts faster and has a status when running bin/xdebug.

That said, having two containers running here would be cool. @Jarzebowsky if you can offer a minimal setup to get this working, that would be cool! I don't think it would take much to set this up based on the comment at https://github.com/magento/magento-cloud-docker/issues/112#issuecomment-565345812 — I think the only way to do this would be some sort of zero-config setup so the user would never need to run bin/xdebug again (neat).

[jarzebowsky]

That's exactly what I have prepared for two companies, adjusted to their needs. It's kinda exceeding timeframe I dropped but as soon I will have spare time - will prepare PR - that for sure would be a game changer feature.

[jarzebowsky]

I have prepared the changes and managed to have it working with small further work to do on my side.

@markshust I would need some instructions regarding how I'm supposed to prepare PR with new docker image(s). Currently I just changed directive to force build from Dockerfile defined locally.

I would also have some future change suggestions to the repository.

If we would be able to resolve those during the weekend the PR will be dropped also at this timeframe 😁

[dosubot[bot]]

Hi, @danstaver. I'm Dosu (https://dosu.dev), and I'm helping the docker-magento team manage their backlog and am marking this issue as stale.

Issue Summary:

• You proposed improving xdebug performance by enabling it only when triggered via an XDEBUG_SESSION cookie to reduce overhead and user errors.
• @Jarzebowsky has been working on a minimal setup and plans to submit a PR for this enhancement.
• @markshust supports the idea and mentioned recent improvements to the bin/xdebug script.
• Progress has been made, and guidance was requested on submitting a PR with new Docker images.
• The enhancement aims to streamline debugging with a zero-config approach but remains unresolved.

Next Steps:

• Please let me know if this issue is still relevant to the latest version of docker-magento by commenting here to keep the discussion open.
• If I don’t hear back within 30 days, this issue will be automatically closed.

Thanks for your understanding and contribution!

[jarzebowsky]

Yes it's waiting for @markshust some time already

[dosubot[bot]]

@markshust, the user @Jarzebowsky has indicated this issue is still waiting for your input regarding the xdebug performance improvements and the related PR. Could you please assist with this when you have a chance?