[FrameworkBundle][HttpKernel] Add the ability to enable the profiler using a parameter

Author: dunglas

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 5.4
 ---
 
+ * Add the ability to enable the profiler using a request query parameter, body parameter or attribute
  * Deprecate `AbstractTestSessionListener::getSession` inject a session in the request instead
  * Deprecate the `fileLinkFormat` parameter of `DebugHandlersListener`
  * Add support for configuring log level, and status code by exception class

EventListener/ProfilerListener.php

@@ -36,13 +36,14 @@ class ProfilerListener implements EventSubscriberInterface
     protected $exception;
     protected $profiles;
     protected $requestStack;
+    protected $collectParameter;
     protected $parents;
 
     /**
      * @param bool $onlyException    True if the profiler only collects data when an exception occurs, false otherwise
      * @param bool $onlyMainRequests True if the profiler only collects data when the request is the main request, false otherwise
      */
-    public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMainRequests = false)
+    public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMainRequests = false, string $collectParameter = null)
     {
         $this->profiler = $profiler;
         $this->matcher = $matcher;
@@ -51,6 +52,7 @@ public function __construct(Profiler $profiler, RequestStack $requestStack, Requ
         $this->profiles = new \SplObjectStorage();
         $this->parents = new \SplObjectStorage();
         $this->requestStack = $requestStack;
+        $this->collectParameter = $collectParameter;
     }
 
     /**
@@ -79,6 +81,10 @@ public function onKernelResponse(ResponseEvent $event)
         }
 
         $request = $event->getRequest();
+        if (null !== $this->collectParameter && null !== $collectParameterValue = $request->get($this->collectParameter)) {
+            true === $collectParameterValue || filter_var($collectParameterValue, \FILTER_VALIDATE_BOOLEAN) ? $this->profiler->enable() : $this->profiler->disable();
+        }
+
         $exception = $this->exception;
         $this->exception = null;
 

Tests/EventListener/ProfilerListenerTest.php

@@ -59,4 +59,42 @@ public function testKernelTerminate()
 
         $listener->onKernelTerminate(new TerminateEvent($kernel, $mainRequest, $response));
     }
+
+    /**
+     * @dataProvider collectRequestProvider
+     */
+    public function testCollectParameter(Request $request, ?bool $enable)
+    {
+        $profile = new Profile('token');
+
+        $profiler = $this->createMock(Profiler::class);
+        $profiler->expects($this->once())
+            ->method('collect')
+            ->willReturn($profile);
+
+        $profiler
+            ->expects(null === $enable ? $this->never() : $this->once())
+            ->method($enable ? 'enable' : 'disable');
+
+        $kernel = $this->createMock(HttpKernelInterface::class);
+        $response = new Response();
+
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
+
+        $listener = new ProfilerListener($profiler, $requestStack, null, false, false, 'profile');
+
+        $listener->onKernelResponse(new ResponseEvent($kernel, $request, Kernel::MAIN_REQUEST, $response));
+    }
+
+    public function collectRequestProvider(): iterable
+    {
+        yield [Request::create('/'), null];
+        yield [Request::create('/', 'GET', ['profile' => '1']), true];
+        yield [Request::create('/', 'GET', ['profile' => '0']), false];
+
+        $request = Request::create('/');
+        $request->attributes->set('profile', true);
+        yield [$request, true];
+    }
 }