bug #49706 Stop stopwatch events in case of exception (MatTheCat)

fabpot · fabpot · commit 0874ea8f3c68 · 2023-03-17T12:32:02.000+01:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- Stop stopwatch events in case of exception | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #49677 | License | MIT | Doc PR | N/A Stopwatch events need to be stopped even if an exception occurred, else they will appear to span across the whole request timeline. The following screenshots were taken with `RouterListener` throwing in debug mode following a [`NoConfigurationException`](https://github.com/symfony/symfony/blob/0362350a720e38df55531ab0cf726a082d3d34d4/src/Symfony/Component/Routing/Exception/NoConfigurationException.php): <details> <summary>Before</summary> <img src="https://user-images.githubusercontent.com/243674/224777379-1209dfde-8086-49e3-af56-147ceda3e6c9.png" alt=""> </details> <details> <summary>After</summary> <img src="https://user-images.githubusercontent.com/1898254/225371948-a21acf87-203c-49f9-b73a-4947e9a5092a.png" alt=""> </details> Commits ------- beca17a Stop stopwatch events in case of exception
diff --git a/src/Symfony/Component/EventDispatcher/Debug/WrappedListener.php b/src/Symfony/Component/EventDispatcher/Debug/WrappedListener.php
@@ -114,10 +114,12 @@ public function __invoke(object $event, string $eventName, EventDispatcherInterf
 
         $e = $this->stopwatch->start($this->name, 'event_listener');
 
-        ($this->optimizedListener ?? $this->listener)($event, $eventName, $dispatcher);
-
-        if ($e->isStarted()) {
-            $e->stop();
+        try {
+            ($this->optimizedListener ?? $this->listener)($event, $eventName, $dispatcher);
+        } finally {
+            if ($e->isStarted()) {
+                $e->stop();
+            }
         }
 
         if ($event instanceof StoppableEventInterface && $event->isPropagationStopped()) {
diff --git a/src/Symfony/Component/EventDispatcher/Tests/Debug/WrappedListenerTest.php b/src/Symfony/Component/EventDispatcher/Tests/Debug/WrappedListenerTest.php
@@ -15,6 +15,7 @@
 use Symfony\Component\EventDispatcher\Debug\WrappedListener;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\Stopwatch\StopwatchEvent;
 
 class WrappedListenerTest extends TestCase
 {
@@ -42,6 +43,25 @@ public static function provideListenersToDescribe()
             [\Closure::fromCallable(function () {}), 'closure'],
         ];
     }
+
+    public function testStopwatchEventIsStoppedWhenListenerThrows()
+    {
+        $stopwatchEvent = $this->createMock(StopwatchEvent::class);
+        $stopwatchEvent->expects(self::once())->method('isStarted')->willReturn(true);
+        $stopwatchEvent->expects(self::once())->method('stop');
+
+        $stopwatch = $this->createStub(Stopwatch::class);
+        $stopwatch->method('start')->willReturn($stopwatchEvent);
+
+        $dispatcher = $this->createStub(EventDispatcherInterface::class);
+
+        $wrappedListener = new WrappedListener(function () { throw new \Exception(); }, null, $stopwatch, $dispatcher);
+
+        try {
+            $wrappedListener(new \stdClass(), 'foo', $dispatcher);
+        } catch (\Exception $ex) {
+        }
+    }
 }
 
 class FooListener
diff --git a/src/Symfony/Component/HttpKernel/Controller/TraceableArgumentResolver.php b/src/Symfony/Component/HttpKernel/Controller/TraceableArgumentResolver.php
@@ -35,10 +35,10 @@ public function getArguments(Request $request, callable $controller)
     {
         $e = $this->stopwatch->start('controller.get_arguments');
 
-        $ret = $this->resolver->getArguments($request, $controller);
-
-        $e->stop();
-
-        return $ret;
+        try {
+            return $this->resolver->getArguments($request, $controller);
+        } finally {
+            $e->stop();
+        }
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Controller/TraceableControllerResolver.php b/src/Symfony/Component/HttpKernel/Controller/TraceableControllerResolver.php
@@ -35,10 +35,10 @@ public function getController(Request $request)
     {
         $e = $this->stopwatch->start('controller.get_callable');
 
-        $ret = $this->resolver->getController($request);
-
-        $e->stop();
-
-        return $ret;
+        try {
+            return $this->resolver->getController($request);
+        } finally {
+            $e->stop();
+        }
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/TraceableArgumentResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/TraceableArgumentResolverTest.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Controller;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
+use Symfony\Component\HttpKernel\Controller\TraceableArgumentResolver;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\Stopwatch\StopwatchEvent;
+
+class TraceableArgumentResolverTest extends TestCase
+{
+    public function testStopwatchEventIsStoppedWhenResolverThrows()
+    {
+        $stopwatchEvent = $this->createMock(StopwatchEvent::class);
+        $stopwatchEvent->expects(self::once())->method('stop');
+
+        $stopwatch = $this->createStub(Stopwatch::class);
+        $stopwatch->method('start')->willReturn($stopwatchEvent);
+
+        $resolver = new class() implements ArgumentResolverInterface {
+            public function getArguments(Request $request, callable $controller)
+            {
+                throw new \Exception();
+            }
+        };
+
+        $traceableResolver = new TraceableArgumentResolver($resolver, $stopwatch);
+
+        try {
+            $traceableResolver->getArguments(new Request(), function () {});
+        } catch (\Exception $ex) {
+        }
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/TraceableControllerResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/TraceableControllerResolverTest.php
@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Controller;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
+use Symfony\Component\HttpKernel\Controller\TraceableControllerResolver;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\Stopwatch\StopwatchEvent;
+
+class TraceableControllerResolverTest extends TestCase
+{
+    public function testStopwatchEventIsStoppedWhenResolverThrows()
+    {
+        $stopwatchEvent = $this->createMock(StopwatchEvent::class);
+        $stopwatchEvent->expects(self::once())->method('stop');
+
+        $stopwatch = $this->createStub(Stopwatch::class);
+        $stopwatch->method('start')->willReturn($stopwatchEvent);
+
+        $resolver = new class() implements ControllerResolverInterface {
+            public function getController(Request $request)
+            {
+                throw new \Exception();
+            }
+        };
+
+        $traceableResolver = new TraceableControllerResolver($resolver, $stopwatch);
+        try {
+            $traceableResolver->getController(new Request());
+        } catch (\Exception $ex) {
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,10 @@ public function getArguments(Request $request, callable $controller)`
`35`	`35`	`{`
`36`	`36`	`$e = $this->stopwatch->start('controller.get_arguments');`
`37`	`37`
`38`		`- $ret = $this->resolver->getArguments($request, $controller);`
`39`		`-`
`40`		`- $e->stop();`
`41`		`-`
`42`		`- return $ret;`
	`38`	`+ try {`
	`39`	`+ return $this->resolver->getArguments($request, $controller);`
	`40`	`+ } finally {`
	`41`	`+ $e->stop();`
	`42`	`+ }`
`43`	`43`	`}`
`44`	`44`	`}`