feature #43138 [FrameworkBundle][HttpKernel] Add the ability to enable the profiler using a parameter (dunglas)

This PR was squashed before being merged into the 5.4 branch.

Discussion
----------

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

| Q             | A
| ------------- | ---
| Branch?       | 5.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | n/a
| License       | MIT
| Doc PR        | todo

The Symfony Profiler is a convenient development tool, however, in some cases, it has a huge overhead.
I used Blackfire to benchmark a development environment on a real-world project and noticed that the average response time was reduced by 30% just by disabling the profiler.

This PR adds a new configuration option allowing to enable and disable the profiler on a per request basis using a query parameter, a form field (for `POST` requests), or a request attribute. This PR allows keeping the benefit of this tool while improving the developer experience.

To enable it:

```yaml
framework:
    profiler:
        collect: false # Disable collection by default
        collect_parameter: profile # Enable it if the parameter is set
```

Note: it's also possible to enable the collection by default and to disable it using the parameter

Then, to have the profiler, the user just has to add `?profile=1` to any URL.

Commits
-------

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

Author: fabpot

CHANGELOG.md

@@ -9,6 +9,7 @@ CHANGELOG
  * Add `set_content_language_from_locale` config option to automatically set the `Content-Language` HTTP response header based on the Request locale
  * Deprecate the `framework.translator.enabled_locales`, use `framework.enabled_locales` instead
  * Add autowiring alias for `HttpCache\StoreInterface`
+ * Add the ability to enable the profiler using a request query parameter, body parameter or attribute
  * Deprecate the `AdapterInterface` autowiring alias, use `CacheItemPoolInterface` instead
  * Deprecate the public `profiler` service to private
  * Deprecate `get()`, `has()`, `getDoctrine()`, and `dispatchMessage()` in `AbstractController`, use method/constructor injection instead

DependencyInjection/Configuration.php

@@ -315,6 +315,7 @@ private function addProfilerSection(ArrayNodeDefinition $rootNode)
                     ->canBeEnabled()
                     ->children()
                         ->booleanNode('collect')->defaultTrue()->end()
+                        ->scalarNode('collect_parameter')->defaultNull()->info('The name of the parameter to use to enable or disable collection on a per request basis')->end()
                         ->booleanNode('only_exceptions')->defaultFalse()->end()
                         ->booleanNode('only_main_requests')->defaultFalse()->end()
                         ->booleanNode('only_master_requests')->setDeprecated('symfony/framework-bundle', '5.3', 'Option "%node%" at "%path%" is deprecated, use "only_main_requests" instead.')->defaultFalse()->end()

DependencyInjection/FrameworkExtension.php

@@ -778,6 +778,9 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
         $container->getDefinition('profiler')
             ->addArgument($config['collect'])
             ->addTag('kernel.reset', ['method' => 'reset']);
+
+        $container->getDefinition('profiler_listener')
+            ->addArgument($config['collect_parameter']);
     }
 
     private function registerWorkflowConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)

Resources/config/schema/symfony-1.0.xsd

@@ -91,6 +91,7 @@
 
     <xsd:complexType name="profiler">
         <xsd:attribute name="collect" type="xsd:string" />
+        <xsd:attribute name="collect-parameter" type="xsd:string" />
         <xsd:attribute name="only-exceptions" type="xsd:string" />
         <xsd:attribute name="only-main-requests" type="xsd:string" />
         <xsd:attribute name="only-master-requests" type="xsd:string" />

Tests/DependencyInjection/ConfigurationTest.php

@@ -405,6 +405,7 @@ protected static function getBundleDefaultConfig()
                 'only_main_requests' => false,
                 'dsn' => 'file:%kernel.cache_dir%/profiler',
                 'collect' => true,
+                'collect_parameter' => null,
             ],
             'translator' => [
                 'enabled' => !class_exists(FullStack::class),

Tests/Functional/ProfilerTest.php

@@ -36,6 +36,27 @@ public function testProfilerIsDisabled($insulate)
         $this->assertNull($client->getProfile());
     }
 
+    /**
+     * @dataProvider getConfigs
+     */
+    public function testProfilerCollectParameter($insulate)
+    {
+        $client = $this->createClient(['test_case' => 'ProfilerCollectParameter', 'root_config' => 'config.yml']);
+        if ($insulate) {
+            $client->insulate();
+        }
+
+        $client->request('GET', '/profiler');
+        $this->assertNull($client->getProfile());
+
+        // enable the profiler for the next request
+        $client->request('GET', '/profiler?profile=1');
+        $this->assertIsObject($client->getProfile());
+
+        $client->request('GET', '/profiler');
+        $this->assertNull($client->getProfile());
+    }
+
     public function getConfigs()
     {
         return [

Tests/Functional/app/ProfilerCollectParameter/bundles.php

@@ -0,0 +1,18 @@
+<?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.
+ */
+
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\TestBundle;
+
+return [
+    new FrameworkBundle(),
+    new TestBundle(),
+];

Tests/Functional/app/ProfilerCollectParameter/config.yml

@@ -0,0 +1,8 @@
+imports:
+    - { resource: ../config/default.yml }
+
+framework:
+    profiler:
+        enabled: true
+        collect: false
+        collect_parameter: profile

Tests/Functional/app/ProfilerCollectParameter/routing.yml

@@ -0,0 +1,2 @@
+_sessiontest_bundle:
+    resource: '@TestBundle/Resources/config/routing.yml'