fix(serializer): deprecate SerializerAwareProviderInterface and SerializableProvider (#7348)

Author: vinceAmstoutz

src/State/SerializerAwareProviderInterface.php

@@ -19,6 +19,8 @@
  * Injects serializer in providers.
  *
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated in 4.2, to be removed in 5.0 because it violates the dependency injection principle.
  */
 interface SerializerAwareProviderInterface
 {

src/State/SerializerAwareProviderTrait.php

@@ -30,6 +30,13 @@ trait SerializerAwareProviderTrait
 
     public function setSerializerLocator(ContainerInterface $serializerLocator): void
     {
+        trigger_deprecation(
+            'api-platform/core',
+            '4.2',
+            'The "%s" interface is deprecated and will be removed in 5.0. It violates the dependency injection principle.',
+            SerializerAwareProviderInterface::class
+        );
+
         $this->serializerLocator = $serializerLocator;
     }
 

src/Symfony/Bundle/ApiPlatformBundle.php

@@ -44,6 +44,7 @@ public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 
+        // TODO: remove in 5.x
         $container->addCompilerPass(new DataProviderPass());
         // Run the compiler pass before the {@see ResolveInstanceofConditionalsPass} to allow autoconfiguration of generated filter definitions.
         $container->addCompilerPass(new AttributeFilterPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 101);

src/Symfony/Bundle/DependencyInjection/Compiler/DataProviderPass.php

@@ -21,10 +21,12 @@
 /**
  * Registers data providers.
  *
- * @internal
+ * @internal since 4.2
  *
  * @author Kévin Dunglas <[email protected]>
  * @author Vincent Chalamon <[email protected]>
+ *
+ * TODO: remove in 5.x
  */
 final class DataProviderPass implements CompilerPassInterface
 {

tests/Fixtures/TestBundle/State/SerializableProvider.php

@@ -20,6 +20,8 @@
 
 /**
  * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated in 4.2, to be removed in 5.0 because it violates the dependency injection principle.
  */
 class SerializableProvider implements ProviderInterface, SerializerAwareProviderInterface
 {

tests/Symfony/Bundle/ApiPlatformBundleTest.php

@@ -43,6 +43,7 @@ class ApiPlatformBundleTest extends TestCase
     public function testBuild(): void
     {
         $containerProphecy = $this->prophesize(ContainerBuilder::class);
+        // TODO: remove in 5.x
         $containerProphecy->addCompilerPass(Argument::type(DataProviderPass::class))->willReturn($containerProphecy->reveal())->shouldBeCalled();
         $containerProphecy->addCompilerPass(Argument::type(AttributeFilterPass::class), PassConfig::TYPE_BEFORE_OPTIMIZATION, 101)->willReturn($containerProphecy->reveal())->shouldBeCalled();
         $containerProphecy->addCompilerPass(Argument::type(AttributeResourcePass::class))->shouldBeCalled()->willReturn($containerProphecy->reveal())->shouldBeCalled();