From 408d09a8235631bcb51224ab77e4a0e855db31bd Mon Sep 17 00:00:00 2001 From: Mathias Arlaud Date: Fri, 28 Mar 2025 09:42:19 +0100 Subject: [PATCH] [FrameworkBundle] Deprecate setting the `collect_serializer_data` to `false` --- UPGRADE-7.3.md | 15 +++++++++++++++ src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md | 1 + .../DependencyInjection/FrameworkExtension.php | 4 ++++ .../DependencyInjection/Fixtures/php/profiler.php | 1 + .../php/profiler_collect_serializer_data.php | 15 --------------- .../DependencyInjection/Fixtures/xml/profiler.xml | 2 +- .../xml/profiler_collect_serializer_data.xml | 15 --------------- .../DependencyInjection/Fixtures/yml/profiler.yml | 1 + .../yml/profiler_collect_serializer_data.yml | 11 ----------- .../FrameworkExtensionTestCase.php | 11 +---------- .../Tests/Functional/app/config/framework.yml | 2 ++ .../Functional/app/FirewallEntryPoint/config.yml | 4 +++- .../Tests/Functional/app/config/framework.yml | 4 +++- .../Tests/Functional/WebProfilerBundleKernel.php | 2 +- 14 files changed, 33 insertions(+), 55 deletions(-) delete mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php delete mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler_collect_serializer_data.xml delete mode 100644 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler_collect_serializer_data.yml diff --git a/UPGRADE-7.3.md b/UPGRADE-7.3.md index 436ef0272544e..35a6a08eaf99c 100644 --- a/UPGRADE-7.3.md +++ b/UPGRADE-7.3.md @@ -58,6 +58,21 @@ 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` + + When set to `true`, normalizers must be injected using the `NormalizerInterface`, and not using any concrete implementation. + + Before: + + ```php + public function __construct(ObjectNormalizer $normalizer) {} + ``` + + After: + + ```php + public function __construct(#[Autowire('@serializer.normalizer.object')] NormalizerInterface $normalizer) {} + ``` Ldap ---- diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md index 9975642622b13..6c4daeb6df85d 100644 --- a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md +++ b/src/Symfony/Bundle/FrameworkBundle/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 --- diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php index 7e500af886941..f6440e3de9910 100644 --- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php +++ b/src/Symfony/Bundle/FrameworkBundle/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'); } diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler.php index faf76bbc76a8f..99e2a52cf611f 100644 --- 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 deleted file mode 100644 index 99e2a52cf611f..0000000000000 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/profiler_collect_serializer_data.php +++ /dev/null @@ -1,15 +0,0 @@ -loadFromExtension('framework', [ - 'annotations' => false, - 'http_method_override' => false, - 'handle_all_throwables' => true, - 'php_errors' => ['log' => true], - '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 index ffbff7f21e1bb..34d44d91ce1bd 100644 --- 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 @@ - + 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 deleted file mode 100644 index 34d44d91ce1bd..0000000000000 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/profiler_collect_serializer_data.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler.yml index 5c867fc8907db..2ccec1685c6b1 100644 --- 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 deleted file mode 100644 index 5fe74b290568a..0000000000000 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/profiler_collect_serializer_data.yml +++ /dev/null @@ -1,11 +0,0 @@ -framework: - annotations: false - http_method_override: false - handle_all_throwables: true - php_errors: - log: true - serializer: - enabled: true - profiler: - enabled: true - collect_serializer_data: true diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php index 8bddf53be6b5d..d942c122c826a 100644 --- 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 index 1eaee513c899b..ac051614bdd55 100644 --- 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 index 9d6b4caee1707..31b0af34088a3 100644 --- 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 index c197fcaa4c25e..0f2e1344d0e71 100644 --- 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 index 6438960287411..f4a9f939e274b 100644 --- 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], ];