[FrameworkBundle] Disable Serializer data collect by default

symfony · nicolas-grekas · Jun 9, 2022 · Jun 9, 2022 · Jun 9, 2022 · d0cf7594896eee5ff46bdb40743e8eac9b7eb9df
commit d0cf7594896eee5ff46bdb40743e8eac9b7eb9df
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -15,6 +15,7 @@ CHANGELOG
  * Add tag `routing.condition_service` to autoconfigure routing condition services
  * Automatically register kernel methods marked with the `Symfony\Component\Routing\Annotation\Route` attribute or annotation as controllers in `MicroKernelTrait`
  * Deprecate not setting the `http_method_override` config option. The default value will change to `false` in 7.0.
+
8000
 * Add `framework.profiler.collect_serializer_data` config option, set it to `true` to enable the serializer data collector and profiler panel
 
 6.0
 ---

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -325,6 +325,7 @@ private function addProfilerSection(ArrayNodeDefinition $rootNode)
                         ->booleanNode('only_exceptions')->defaultFalse()->end()
                         ->booleanNode('only_main_requests')->defaultFalse()->end()
                         ->scalarNode('dsn')->defaultValue('file:%kernel.cache_dir%/profiler')->end()
+                        ->booleanNode('collect_serializer_data')->info('Enables the serializer data collector and profiler panel')->defaultFalse()->end()
                     ->end()
                 ->end()
             ->end()

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -826,7 +826,7 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
             $loader->load('notifier_debug.php');
         }
 
-        if ($this->serializerConfigEnabled) {
+        if ($this->serializerConfigEnabled && $config['collect_serializer_data']) {
             $loader->load('serializer_debug.php');
         }
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -103,6 +103,7 @@
         <xsd:attribute name="username" type="xsd:string" />
         <xsd:attribute name="password" type="xsd:string" />
         <xsd:attribute name="lifetime" type="xsd:string" />
+        <xsd:attribute name="collect-serializer-data" type="xsd:boolean" />
     </xsd:complexType>
 
     <xsd:complexType name="router">

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -468,6 +468,7 @@ protected static function getBundleDefaultConfig()
                 'dsn' => 'file:%kernel.cache_dir%/profiler',
                 'collect' => true,
                 'collect_parameter' => null,
+                'collect_serializer_data' => false,
             ],
             'translator' => [
                 'enabled' => !class_exists(FullStack::class),

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php
@@ -5,4 +5,7 @@
     'profiler' => [
         'enabled' => true,
     ],
+    'serializer' => [
+        'enabled' => true
+    ],
 ]);
diff --git a/...ameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php b/...ameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php
@@ -0,0 +1,12 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'http_method_override' => false,
+    'profiler' => [
+        'enabled' => true,
+        'collect_serializer_data' => true,
+    ],
+    'serializer' => [
+        'enabled' => true,
+    ]
+]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler.xml
@@ -8,5 +8,6 @@
 
     <framework:config http-method-override="false">
         <framework:profiler enabled="true" />
+        <framework:serializer enabled="true" />
     </framework:config>
 </container>
diff --git a/...ameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler_collect_serializer_data.xml b/...ameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler_collect_serializer_data.xml
@@ -0,0 +1,13 @@
+<?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 https://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config http-method-override="false">
+        <framework:profiler enabled="true" collect-serializer-data="true" />
+        <framework:serializer enabled="true" />
+    </framework:config>
+</container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml
@@ -2,3 +2,5 @@ framework:
     http_method_override: false
     profiler:
         enabled: true
+    serializer:
+        enabled: true
diff --git a/...ameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler_collect_serializer_data.yml b/...ameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler_collect_serializer_data.yml
@@ -0,0 +1,7 @@
+framework:
+    http_method_override: false
+    serializer:
+        enabled: true
+    profiler:
+        enabled: true
+        collect_serializer_data: true
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -253,6 +253,24 @@ public function testDisabledProfiler()
         $this->assertFalse($container->hasDefinition('data_collector.config'), '->registerProfilerConfiguration() does not load collectors.xml');
     }
 
+    public function testProfilerCollectSerializerDataEnabled()
+    {
+        $container = $this->createContainerFromFile('profiler_collect_serializer_data');
+
+        $this->assertTrue($container->hasDefinition('profiler'));
+        $this->assertTrue($container->hasDefinition('serializer.data_collector'));
+        $this->assertTrue($container->hasDefinition('debug.serializer'));
+    }
+
+    public function testProfilerCollectSerializerDataDefaultDisabled()
+    {
+        $container = $this->createContainerFromFile('profiler');
+
+        $this->assertTrue($container->hasDefinition('profiler'));
+        $this->assertFalse($container->hasDefinition('serializer.data_collector'));
+        $this->assertFalse($container->hasDefinition('debug.serializer'));
+    }
+
     public function testWorkflows()
     {
         $container = $this->createContainerFromFile('workflows');