[FrameworkBundle] added a way to disable the profiler

Before:

  enabled: true  # the profiler is enabled and data are collected

  enabled: false # the profiler is enabled but data are not collected (data can be collected on demand)

  No way to disable the profiler

After:

  enabled: true  # the profiler is enabled and data are collected
  collect: true

  enabled: true  # the profiler is enabled but data are not collected (data can be collected on demand)
  collect: false

  enabled: false # the profiler is disabled

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -4,6 +4,8 @@ CHANGELOG
 2.3.0
 -----
 
+ * [BC BREAK] added a way to disable the profiler (when disabling the profiler, it is now completely removed)
+   To get the same "disabled" behavior as before, set `enabled` to `true` and `collect` to `false`
  * [BC BREAK] the `Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RegisterKernelListenersPass` was moved
    to `Component\HttpKernel\DependencyInjection\RegisterListenersPass`
  * added ControllerNameParser::build() which converts a controller short notation (a:b:c) to a class::method notation

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -139,6 +139,7 @@ private function addProfilerSection(ArrayNodeDefinition $rootNode)
                     ->info('profiler configuration')
                     ->canBeEnabled()
                     ->children()
+                        ->booleanNode('collect')->defaultTrue()->end()
                         ->booleanNode('only_exceptions')->defaultFalse()->end()
                         ->booleanNode('only_master_requests')->defaultFalse()->end()
                         ->scalarNode('dsn')->defaultValue('file:%kernel.cache_dir%/profiler')->end()

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -91,11 +91,7 @@ public function load(array $configs, ContainerBuilder $container)
         $this->registerValidationConfiguration($config['validation'], $container, $loader);
         $this->registerEsiConfiguration($config['esi'], $container, $loader);
         $this->registerFragmentsConfiguration($config['fragments'], $container, $loader);
-
-        if (isset($config['profiler']) && isset($config['profiler']['enabled']) && $config['profiler']['enabled']) {
-            $this->registerProfilerConfiguration($config['profiler'], $container, $loader);
-        }
-
+        $this->registerProfilerConfiguration($config['profiler'], $container, $loader);
         $this->registerTranslatorConfiguration($config['translator'], $container);
 
         if (isset($config['router'])) {
@@ -213,6 +209,10 @@ private function registerFragmentsConfiguration(array $config, ContainerBuilder
      */
     private function registerProfilerConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
     {
+        if (!$this->isConfigEnabled($container, $config)) {
+            return;
+        }
+
         $loader->load('profiling.xml');
         $loader->load('collectors.xml');
 
@@ -258,7 +258,7 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
             }
         }
 
-        if (!$this->isConfigEnabled($container, $config)) {
+        if (!$config['collect']) {
             $container->getDefinition('profiler')->addMethodCall('disable', array());
         }
     }

src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd

@@ -53,6 +53,7 @@
             <xsd:element name="matcher" type="profiler_matcher" minOccurs="0" maxOccurs="1" />
         </xsd:all>
 
+        <xsd:attribute name="collect" type="xsd:string" />
         <xsd:attribute name="only-exceptions" type="xsd:string" />
         <xsd:attribute name="only-master-requests" type="xsd:string" />
         <xsd:attribute name="enabled" type="xsd:string" />

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

@@ -111,6 +111,7 @@ protected static function getBundleDefaultConfig()
                 'username'             => '',
                 'password'             => '',
                 'lifetime'             => 86400,
+                'collect'              => true,
             ),
             'translator'          => array(
                 'enabled'  => false,

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php

@@ -15,6 +15,7 @@
     ),
     'profiler' => array(
         'only_exceptions' => true,
+        'enabled' => false,
     ),
     'router' => array(
         'resource'     => '%kernel.root_dir%/config/routing.xml',

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php

@@ -0,0 +1,7 @@
+<?php
+
+$container->loadFromExtension('framework', array(
+    'profiler' => array(
+        'enabled' => true,
+    ),
+));

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml

@@ -10,7 +10,7 @@
         <framework:csrf-protection enabled="true" field-name="_csrf" />
         <framework:form />
         <framework:esi enabled="true" />
-        <framework:profiler only-exceptions="true" />
+        <framework:profiler only-exceptions="true" enabled="false" />
         <framework:router resource="%kernel.root_dir%/config/routing.xml" type="xml" />
         <framework:session gc-maxlifetime="90000" gc-probability="1" gc-divisor="108" storage-id="session.storage.native" handler-id="session.handler.native_file" name="_SYMFONY" cookie-lifetime="86400" cookie-path="/" cookie-domain="example.com" cookie-secure="true" cookie-httponly="true" save-path="/path/to/sessions" />
         <framework:templating assets-version="SomeVersionScheme" cache="/path/to/cache" >

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config>
+        <framework:profiler enabled="true" />
+    </framework:config>
+</container>

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml

@@ -11,6 +11,7 @@ framework:
         enabled: true
     profiler:
         only_exceptions: true
+        enabled: false
     router:
         resource:     %kernel.root_dir%/config/routing.xml
         type:         xml

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml

@@ -0,0 +1,3 @@
+framework:
+    profiler:
+        enabled: true

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php

@@ -54,23 +54,20 @@ public function testEsi()
         $this->assertTrue($container->hasDefinition('esi'), '->registerEsiConfiguration() loads esi.xml');
     }
 
-    public function testProfiler()
+    public function testEnabledProfiler()
     {
-        $container = $this->createContainerFromFile('full');
+        $container = $this->createContainerFromFile('profiler');
 
         $this->assertTrue($container->hasDefinition('profiler'), '->registerProfilerConfiguration() loads profiling.xml');
         $this->assertTrue($container->hasDefinition('data_collector.config'), '->registerProfilerConfiguration() loads collectors.xml');
-        $this->assertTrue($container->getParameter('profiler_listener.only_exceptions'));
-        $this->assertEquals('%profiler_listener.only_exceptions%', $container->getDefinition('profiler_listener')->getArgument(2));
     }
 
     public function testDisabledProfiler()
     {
-        $container = $this->createContainerFromFile('full_disabled');
+        $container = $this->createContainerFromFile('full');
 
         $this->assertFalse($container->hasDefinition('profiler'), '->registerProfilerConfiguration() does not load profiling.xml');
         $this->assertFalse($container->hasDefinition('data_collector.config'), '->registerProfilerConfiguration() does not load collectors.xml');
-        $this->assertFalse($container->hasParameter('profiler_listener.only_exceptions'));
     }
 
     public function testRouter()

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ProfilerTest.php

@@ -33,7 +33,7 @@ public function testProfilerIsDisabled($insulate)
         $client->enableProfiler();
         $crawler = $client->request('GET', '/profiler');
         $profile = $client->getProfile();
-        $this->assertFalse(is_object($profile));
+        $this->assertTrue(is_object($profile));
 
         $client->request('GET', '/profiler');
         $this->assertFalse($client->getProfile());

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Profiler/config.yml

@@ -3,4 +3,5 @@ imports:
 
 framework:
     profiler:
-        enabled: false
+        enabled: true
+        collect: false