[FrameworkBundle] Deprecate setting the collect_serializer_data to false

Author: mtarld

CHANGELOG.md

@@ -21,6 +21,7 @@ CHANGELOG
  * Allow configuring the logging channel per type of exceptions
  * Enable service argument resolution on classes that use the `#[Route]` attribute,
    the `#[AsController]` attribute is no longer required
+ * Deprecate setting the `framework.profiler.collect_serializer_data` config option to `false`
 
 7.2
 ---

DependencyInjection/FrameworkExtension.php

@@ -988,6 +988,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');
         }

Tests/DependencyInjection/Fixtures/php/profiler.php

@@ -7,6 +7,7 @@
     'php_errors' => ['log' => true],
     'profiler' => [
         'enabled' => true,
+        'collect_serializer_data' => true,
     ],
     'serializer' => [
         'enabled' => true,

Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php

@@ -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>

Tests/DependencyInjection/Fixtures/xml/profiler.xml

@@ -6,5 +6,6 @@ framework:
         log: true
     profiler:
         enabled: true
+        collect_serializer_data: true
     serializer:
         enabled: true

Tests/DependencyInjection/Fixtures/xml/profiler_collect_serializer_data.xml

@@ -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');

Tests/DependencyInjection/Fixtures/yml/profiler.yml

@@ -18,6 +18,8 @@ framework:
         cookie_samesite: lax
     php_errors:
         log: true
+    profiler:
+        collect_serializer_data: true
 
 services:
     logger: { class: Psr\Log\NullLogger }