feature #52950 [WebProfilerBundle] Set XDEBUG_IGNORE option for all XHR (adrolter)

fabpot · fabpot · commit 31b6a568850a · 2024-03-17T07:54:26.000Z
This PR was squashed before being merged into the 7.1 branch. Discussion ---------- [WebProfilerBundle] Set `XDEBUG_IGNORE` option for all XHR | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | N/A | License | MIT When using an Xdebug browser extension with Symfony, toolbar requests are also processed by Xdebug because the browser extension has set an `XDEBUG_*` cookie on the page. This leads to superfluous breakpoint triggering when debugging at lower levels of the codebase, as well as a performance hit with no gain for every toolbar request, junk profiler/trace output blobs, etc. The only sane way to prevent this behavior seems to be for the cookie to never be sent, as Xdebug has no mechanism for ignoring requests to certain URIs, and detecting this condition at the webserver and rewriting the request before passing it off to PHP is also non-trivial. This PR detects the `XDEBUG_*` cookie and removes it before conducting XHR, then re-sets it after the fact. Thanks! Commits ------- ae07ed0 [WebProfilerBundle] Set `XDEBUG_IGNORE` option for all XHR
diff --git a/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md b/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Set `XDEBUG_IGNORE` query parameter when sending toolbar XHR
+
 6.4
 ---
 
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/toolbar_js.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/toolbar_js.html.twig
@@ -51,6 +51,9 @@
             }
 
             var request = function(url, onSuccess, onError, payload, options, tries) {
+                url = new URL(url);
+                url.searchParams.set('XDEBUG_IGNORE', '1');
+                url = url.toString();
                 var xhr = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject('Microsoft.XMLHTTP');
                 options = options || {};
                 options.retry = options.retry || false;

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,9 @@`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`var request = function(url, onSuccess, onError, payload, options, tries) {`
	`54`	`+ url = new URL(url);`
	`55`	`+ url.searchParams.set('XDEBUG_IGNORE', '1');`
	`56`	`+ url = url.toString();`
`54`	`57`	`var xhr = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject('Microsoft.XMLHTTP');`
`55`	`58`	`options = options \|\| {};`
`56`	`59`	`options.retry = options.retry \|\| false;`