[FrameworkBundle] Deprecate setting the collect_serializer_data to false

mtarld · mtarld · commit 2f40ad4d5e6e · 2025-03-29T11:15:12.000+01:00
diff --git a/UPGRADE-7.3.md b/UPGRADE-7.3.md
@@ -56,6 +56,7 @@ FrameworkBundle
    because its default value will change in version 8.0
  * Deprecate the `--show-arguments` option of the `container:debug` command, as arguments are now always shown
  * Deprecate the `framework.validation.cache` config option
+ * Deprecate setting the `framework.profiler.collect_serializer_data` config option to `false`
 
 Ldap
 ----
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -19,6 +19,7 @@ CHANGELOG
  * Add DI alias from `ServicesResetterInterface` to `services_resetter`
  * Add `methods` argument in `#[IsCsrfTokenValid]` attribute
  * Allow configuring the logging channel per type of exceptions
+ * Deprecate setting the `framework.profiler.collect_serializer_data` config option to `false`
 
 7.2
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -429,7 +429,7 @@ public function load(array $configs, ContainerBuilder $container): void
             }
             $loggers[$exception['log_channel']] = new Reference('monolog.logger.'.$exception['log_channel'], ContainerInterface::NULL_ON_INVALID_REFERENCE);
         }
-        
+
         $exceptionListener
             ->replaceArgument(3, $config['exceptions'])
             ->setArgument(4, $loggers)
@@ -984,6 +984,10 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
             $loader->load('notifier_debug.php');
         }
 
+        if (false === $config['collect_serializer_data']) {
+            trigger_deprecation('symfony/framework-bundle', '7.3', 'Setting the "framework.profiler.collect_serializer_data" config option to "false" is deprecated.');
+        }
+
         if ($this->isInitializedConfigEnabled('serializer') && $config['collect_serializer_data']) {
             $loader->load('serializer_debug.php');
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php
@@ -7,6 +7,7 @@
     'php_errors' => ['log' => true],
     'profiler' => [
         'enabled' => true,
+        'collect_serializer_data' => true,
     ],
     'serializer' => [
         'enabled' => true,
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler.xml
@@ -9,7 +9,7 @@
     <framework:config http-method-override="false" handle-all-throwables="true">
         <framework:annotations enabled="false" />
         <framework:php-errors log="true" />
-        <framework:profiler enabled="true" />
+        <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/xml/profiler_collect_serializer_data.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler_collect_serializer_data.xml
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml
@@ -6,5 +6,6 @@ framework:
         log: true
     profiler:
         enabled: true
+        collect_serializer_data: true
     serializer:
         enabled: true
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler_collect_serializer_data.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler_collect_serializer_data.yml
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -278,22 +278,13 @@ public function testDisabledProfiler()
 
     public function testProfilerCollectSerializerDataEnabled()
     {
-        $container = $this->createContainerFromFile('profiler_collect_serializer_data');
+        $container = $this->createContainerFromFile('profiler');
 
         $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');
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/config/framework.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/config/framework.yml
@@ -18,6 +18,8 @@ framework:
         cookie_samesite: lax
     php_errors:
         log: true
+    profiler:
+        collect_serializer_data: true
 
 services:
     logger: { class: Psr\Log\NullLogger }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/FirewallEntryPoint/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/FirewallEntryPoint/config.yml
@@ -17,7 +17,9 @@ framework:
         cookie_samesite: lax
     php_errors:
         log: true
-    profiler: { only_exceptions: false }
+    profiler:
+        only_exceptions: false
+        collect_serializer_data: true
 
 services:
     logger: { class: Psr\Log\NullLogger }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/config/framework.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/config/framework.yml
@@ -18,7 +18,9 @@ framework:
         cookie_samesite: lax
     php_errors:
         log: true
-    profiler: { only_exceptions: false }
+    profiler:
+        only_exceptions: false
+        collect_serializer_data: true
 
 services:
     logger: { class: Psr\Log\NullLogger }
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Tests/Functional/WebProfilerBundleKernel.php b/src/Symfony/Bundle/WebProfilerBundle/Tests/Functional/WebProfilerBundleKernel.php
@@ -55,7 +55,7 @@ protected function configureContainer(ContainerBuilder $container, LoaderInterfa
             'http_method_override' => false,
             'php_errors' => ['log' => true],
             'secret' => 'foo-secret',
-            'profiler' => ['only_exceptions' => false],
+            'profiler' => ['only_exceptions' => false, 'collect_serializer_data' => true],
             'session' => ['handler_id' => null, 'storage_factory_id' => 'session.storage.factory.mock_file', 'cookie-secure' => 'auto', 'cookie-samesite' => 'lax'],
             'router' => ['utf8' => true],
         ];

Original file line number	Diff line number	Diff line change
`@@ -429,7 +429,7 @@ public function load(array $configs, ContainerBuilder $container): void`
`429`	`429`	`}`
`430`	`430`	`$loggers[$exception['log_channel']] = new Reference('monolog.logger.'.$exception['log_channel'], ContainerInterface::NULL_ON_INVALID_REFERENCE);`
`431`	`431`	`}`
`432`		`-`
	`432`	`+`
`433`	`433`	`$exceptionListener`
`434`	`434`	`->replaceArgument(3, $config['exceptions'])`
`435`	`435`	`->setArgument(4, $loggers)`
`@@ -984,6 +984,10 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $`
`984`	`984`	`$loader->load('notifier_debug.php');`
`985`	`985`	`}`
`986`	`986`
	`987`	`+ if (false === $config['collect_serializer_data']) {`
	`988`	`+ trigger_deprecation('symfony/framework-bundle', '7.3', 'Setting the "framework.profiler.collect_serializer_data" config option to "false" is deprecated.');`
	`989`	`+ }`
	`990`	`+`
`987`	`991`	`if ($this->isInitializedConfigEnabled('serializer') && $config['collect_serializer_data']) {`
`988`	`992`	`$loader->load('serializer_debug.php');`
`989`	`993`	`}`