[HttpKernel] Fix TimeDataCollector

herndlm · herndlm · commit db1a9c254797 · 2021-09-01T10:29:51.000+02:00
In order for the `TimeDataCollector` to work properly the `X-Debug-Token` from the response header needs to be used which was removed in #42331 to fix #36623. Fixes #42804
diff --git a/src/Symfony/Component/HttpKernel/Debug/TraceableEventDispatcher.php b/src/Symfony/Component/HttpKernel/Debug/TraceableEventDispatcher.php
@@ -41,7 +41,7 @@ protected function beforeDispatch(string $eventName, $event)
                 }
                 break;
             case KernelEvents::TERMINATE:
-                $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');
+                $sectionId = $this->determineStopwatchToken($event);
                 if (null === $sectionId) {
                     break;
                 }
@@ -68,7 +68,7 @@ protected function afterDispatch(string $eventName, $event)
                 $this->stopwatch->start('controller', 'section');
                 break;
             case KernelEvents::RESPONSE:
-                $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');
+                $sectionId = $this->determineStopwatchToken($event);
                 if (null === $sectionId) {
                     break;
                 }
@@ -77,7 +77,7 @@ protected function afterDispatch(string $eventName, $event)
             case KernelEvents::TERMINATE:
                 // In the special case described in the `preDispatch` method above, the `$token` section
                 // does not exist, then closing it throws an exception which must be caught.
-                $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');
+                $sectionId = $this->determineStopwatchToken($event);
                 if (null === $sectionId) {
                     break;
                 }
@@ -88,4 +88,9 @@ protected function afterDispatch(string $eventName, $event)
                 break;
         }
     }
+
+    private function determineStopwatchToken($event)
+    {
+        return $event->getResponse()->headers->get('X-Debug-Token') ?? $event->getRequest()->attributes->get('_stopwatch_token');
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Debug/TraceableEventDispatcherTest.php b/src/Symfony/Component/HttpKernel/Tests/Debug/TraceableEventDispatcherTest.php
@@ -45,6 +45,26 @@ public function testStopwatchSections()
         ], array_keys($events));
     }
 
+    public function testStopwatchSectionsWithProfilerToken()
+    {
+        $dispatcher = new TraceableEventDispatcher(new EventDispatcher(), $stopwatch = new Stopwatch());
+        $kernel = $this->getHttpKernel($dispatcher, new Response('', 200, ['X-Debug-Token' => '292e1e']));
+        $request = Request::create('/');
+        $response = $kernel->handle($request);
+        $kernel->terminate($request, $response);
+
+        $events = $stopwatch->getSectionEvents($response->headers->get('X-Debug-Token'));
+        $this->assertEquals([
+            '__section__',
+            'kernel.request',
+            'kernel.controller',
+            'kernel.controller_arguments',
+            'controller',
+            'kernel.response',
+            'kernel.terminate',
+        ], array_keys($events));
+    }
+
     public function testStopwatchCheckControllerOnRequestEvent()
     {
         $stopwatch = $this->getMockBuilder(Stopwatch::class)
@@ -110,11 +130,11 @@ public function testListenerCanRemoveItselfWhenExecuted()
         $this->assertCount(1, $eventDispatcher->getListeners('foo'), 'expected listener1 to be removed');
     }
 
-    protected function getHttpKernel($dispatcher)
+    protected function getHttpKernel($dispatcher, Response $response = null)
     {
         $controllerResolver = $this->createMock(ControllerResolverInterface::class);
-        $controllerResolver->expects($this->once())->method('getController')->willReturn(function () {
-            return new Response();
+        $controllerResolver->expects($this->once())->method('getController')->willReturn(function () use ($response) {
+            return $response ?? new Response();
         });
         $argumentResolver = $this->createMock(ArgumentResolverInterface::class);
         $argumentResolver->expects($this->once())->method('getArguments')->willReturn([]);

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ protected function beforeDispatch(string $eventName, $event)`
`41`	`41`	`}`
`42`	`42`	`break;`
`43`	`43`	`case KernelEvents::TERMINATE:`
`44`		`- $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');`
	`44`	`+ $sectionId = $this->determineStopwatchToken($event);`
`45`	`45`	`if (null === $sectionId) {`
`46`	`46`	`break;`
`47`	`47`	`}`
`@@ -68,7 +68,7 @@ protected function afterDispatch(string $eventName, $event)`
`68`	`68`	`$this->stopwatch->start('controller', 'section');`
`69`	`69`	`break;`
`70`	`70`	`case KernelEvents::RESPONSE:`
`71`		`- $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');`
	`71`	`+ $sectionId = $this->determineStopwatchToken($event);`
`72`	`72`	`if (null === $sectionId) {`
`73`	`73`	`break;`
`74`	`74`	`}`
`@@ -77,7 +77,7 @@ protected function afterDispatch(string $eventName, $event)`
`77`	`77`	`case KernelEvents::TERMINATE:`
`78`	`78`	// In the special case described in the `preDispatch` method above, the `$token` section
`79`	`79`	`// does not exist, then closing it throws an exception which must be caught.`
`80`		`- $sectionId = $event->getRequest()->attributes->get('_stopwatch_token');`
	`80`	`+ $sectionId = $this->determineStopwatchToken($event);`
`81`	`81`	`if (null === $sectionId) {`
`82`	`82`	`break;`
`83`	`83`	`}`
`@@ -88,4 +88,9 @@ protected function afterDispatch(string $eventName, $event)`
`88`	`88`	`break;`
`89`	`89`	`}`
`90`	`90`	`}`
	`91`	`+`
	`92`	`+ private function determineStopwatchToken($event)`
	`93`	`+ {`
	`94`	`+ return $event->getResponse()->headers->get('X-Debug-Token') ?? $event->getRequest()->attributes->get('_stopwatch_token');`
	`95`	`+ }`
`91`	`96`	`}`