Merge mutator pass & new mutator collection interfaces

Author: loic425

src/Metadata/Mutator/OperationMutatorCollectionInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Metadata\Mutator;
+
+use ApiPlatform\Metadata\OperationMutatorInterface;
+use Psr\Container\ContainerInterface;
+
+/**
+ * @template T of OperationMutatorInterface
+ *
+ * @extends ContainerInterface<T>
+ */
+
+interface OperationMutatorCollectionInterface extends ContainerInterface
+{
+    public function get(string $id): array;
+}

src/Metadata/Mutator/OperationMutatorCollection.php renamed to src/Metadata/Mutator/OperationResourceMutatorCollection.php

@@ -14,9 +14,11 @@
 namespace ApiPlatform\Metadata\Mutator;
 
 use ApiPlatform\Metadata\OperationMutatorInterface;
-use Psr\Container\ContainerInterface;
 
-final class OperationMutatorCollection implements ContainerInterface
+/**
+ * @internal
+ */
+final class OperationResourceMutatorCollection implements OperationMutatorCollectionInterface
 {
     private array $mutators = [];
 

src/Metadata/Mutator/ResourceMutatorCollectionInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Metadata\Mutator;
+
+use ApiPlatform\Metadata\ResourceMutatorInterface;
+use Psr\Container\ContainerInterface;
+
+/**
+ * @template T of ResourceMutatorInterface
+ *
+ * @extends ContainerInterface<T>
+ */
+
+interface ResourceMutatorCollectionInterface extends ContainerInterface
+{
+    public function get(string $id): array;
+}

src/Metadata/Mutator/ResourceMutatorCollection.php renamed to src/Metadata/Mutator/ResourceResourceMutatorCollection.php

@@ -14,9 +14,11 @@
 namespace ApiPlatform\Metadata\Mutator;
 
 use ApiPlatform\Metadata\ResourceMutatorInterface;
-use Psr\Container\ContainerInterface;
 
-final class ResourceMutatorCollection implements ContainerInterface
+/**
+ * @internal
+ */
+final class ResourceResourceMutatorCollection implements ResourceMutatorCollectionInterface
 {
     private array $mutators;
 

src/Metadata/Resource/Factory/MutatorResourceMetadataCollectionFactory.php

@@ -14,22 +14,17 @@
 namespace ApiPlatform\Metadata\Resource\Factory;
 
 use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Mutator\OperationMutatorCollectionInterface;
+use ApiPlatform\Metadata\Mutator\ResourceMutatorCollectionInterface;
 use ApiPlatform\Metadata\Operation;
-use ApiPlatform\Metadata\OperationMutatorInterface;
 use ApiPlatform\Metadata\Operations;
 use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
-use ApiPlatform\Metadata\ResourceMutatorInterface;
-use Psr\Container\ContainerInterface;
 
 final class MutatorResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
 {
-    /**
-     * @param ContainerInterface<ResourceMutatorInterface[]>  $resourceMutators
-     * @param ContainerInterface<OperationMutatorInterface[]> $operationMutators
-     */
     public function __construct(
-        private readonly ContainerInterface $resourceMutators,
-        private readonly ContainerInterface $operationMutators,
+        private readonly ResourceMutatorCollectionInterface $resourceMutators,
+        private readonly OperationMutatorCollectionInterface $operationMutators,
         private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
     ) {
     }

src/Metadata/Tests/Resource/Factory/MutatorResourceMetadataCollectionFactoryTest.php

@@ -15,8 +15,8 @@
 
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\HttpOperation;
-use ApiPlatform\Metadata\Mutator\OperationMutatorCollection;
-use ApiPlatform\Metadata\Mutator\ResourceMutatorCollection;
+use ApiPlatform\Metadata\Mutator\OperationResourceMutatorCollection;
+use ApiPlatform\Metadata\Mutator\ResourceResourceMutatorCollection;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\OperationMutatorInterface;
 use ApiPlatform\Metadata\Operations;
@@ -35,10 +35,10 @@ public function testMutateResource(): void
         $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
         $resourceMetadataCollection[] = (new ApiResource())->withClass($resourceClass);
 
-        $resourceMutatorCollection = new ResourceMutatorCollection();
+        $resourceMutatorCollection = new ResourceResourceMutatorCollection();
         $resourceMutatorCollection->addMutator($resourceClass, new DummyResourceMutator());
 
-        $customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory($resourceMutatorCollection, new OperationMutatorCollection(), $decorated);
+        $customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory($resourceMutatorCollection, new OperationResourceMutatorCollection(), $decorated);
 
         $decorated->expects($this->once())->method('create')->with($resourceClass)->willReturn(
             $resourceMetadataCollection,
@@ -62,10 +62,10 @@ public function testMutateOperation(): void
         $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
         $resourceMetadataCollection[] = (new ApiResource())->withClass($resourceClass)->withOperations($operations);
 
-        $operationMutatorCollection = new OperationMutatorCollection();
+        $operationMutatorCollection = new OperationResourceMutatorCollection();
         $operationMutatorCollection->addMutator('_api_Dummy_get', new DummyOperationMutator());
 
-        $customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory(new ResourceMutatorCollection(), $operationMutatorCollection, $decorated);
+        $customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory(new ResourceResourceMutatorCollection(), $operationMutatorCollection, $decorated);
 
         $decorated->expects($this->once())->method('create')->with($resourceClass)->willReturn(
             $resourceMetadataCollection,

src/Symfony/Bundle/ApiPlatformBundle.php

@@ -24,8 +24,7 @@
 use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\GraphQlResolverPass;
 use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\GraphQlTypePass;
 use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\MetadataAwareNameConverterPass;
-use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\OperationMutatorPass;
-use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\ResourceMutatorPass;
+use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\MutatorPass;
 use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\SerializerMappingLoaderPass;
 use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\TestClientPass;
 use ApiPlatform\Symfony\Bundle\DependencyInjection\Compiler\TestMercureHubPass;
@@ -64,7 +63,6 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new TestMercureHubPass());
         $container->addCompilerPass(new AuthenticatorManagerPass());
         $container->addCompilerPass(new SerializerMappingLoaderPass());
-        $container->addCompilerPass(new ResourceMutatorPass());
-        $container->addCompilerPass(new OperationMutatorPass());
+        $container->addCompilerPass(new MutatorPass());
     }
 }

src/Symfony/Bundle/DependencyInjection/Compiler/OperationMutatorPass.php renamed to src/Symfony/Bundle/DependencyInjection/Compiler/MutatorPass.php

@@ -17,9 +17,35 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-class OperationMutatorPass implements CompilerPassInterface
+final class MutatorPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
+    {
+        $this->processResourceMutators($container);
+        $this->processOperationMutators($container);
+    }
+
+    public function processResourceMutators(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition('api_platform.metadata.mutator_collection.resource')) {
+            return;
+        }
+
+        $definition = $container->getDefinition('api_platform.metadata.mutator_collection.resource');
+
+        $mutators = $container->findTaggedServiceIds('api_platform.resource_mutator');
+
+        foreach ($mutators as $id => $tags) {
+            foreach ($tags as $tag) {
+                $definition->addMethodCall('add', [
+                    $tag['resourceClass'],
+                    new Reference($id),
+                ]);
+            }
+        }
+    }
+
+    private function processOperationMutators(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('api_platform.metadata.mutator_collection.operation')) {
             return;

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

@@ -5,8 +5,8 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
-        <service id="api_platform.metadata.mutator_collection.resource" class="ApiPlatform\Metadata\Mutator\ResourceMutatorCollection" public="false" />
+        <service id="api_platform.metadata.mutator_collection.resource" class="ResourceResourceMutatorCollection" public="false" />
 
-        <service id="api_platform.metadata.mutator_collection.operation" class="ApiPlatform\Metadata\Mutator\OperationMutatorCollection" public="false" />
+        <service id="api_platform.metadata.mutator_collection.operation" class="OperationResourceMutatorCollection" public="false" />
     </services>
 </container>