fix: deprecate data transformers (#4722)

Author: soyuka

src/Core/Bridge/Symfony/Messenger/DataTransformer.php

@@ -13,10 +13,86 @@
 
 namespace ApiPlatform\Core\Bridge\Symfony\Messenger;
 
-class_exists(\ApiPlatform\Symfony\Messenger\DataTransformer::class);
+use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Exception\OperationNotFoundException;
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Util\ClassInfoTrait;
 
-if (false) {
-    final class DataTransformer extends \ApiPlatform\Symfony\Messenger\DataTransformer
+/**
+ * Transforms an Input to itself. This gives the ability to send the Input to a
+ * message handler and process it asynchronously.
+ *
+ * @author Antoine Bluchet <[email protected]>
+ */
+final class DataTransformer implements DataTransformerInterface
+{
+    use ClassInfoTrait;
+
+    /**
+     * @var ResourceMetadataCollectionFactoryInterface|ResourceMetadataFactoryInterface
+     */
+    private $resourceMetadataFactory;
+
+    public function __construct($resourceMetadataFactory)
     {
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
+
+        if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
+            trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return object
+     */
+    public function transform($object, string $to, array $context = [])
+    {
+        return $object;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supportsTransformation($data, string $to, array $context = []): bool
+    {
+        if (
+            \is_object($data) // data is not normalized yet, it should be an array
+            ||
+            null === ($context['input']['class'] ?? null)
+        ) {
+            return false;
+        }
+
+        if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
+            try {
+                $resourceMetadataCollection = $this->resourceMetadataFactory->create($context['resource_class'] ?? $to);
+                $operation = $resourceMetadataCollection->getOperation($context['operation_name'] ?? null);
+
+                return 'input' === $operation->getMessenger();
+            } catch (OperationNotFoundException $e) {
+                return false;
+            }
+        }
+
+        $metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? $to);
+
+        if (isset($context['graphql_operation_name'])) {
+            return 'input' === $metadata->getGraphqlAttribute($context['graphql_operation_name'], 'messenger', null, true);
+        }
+
+        if (!isset($context['operation_type'])) {
+            return 'input' === $metadata->getAttribute('messenger');
+        }
+
+        return 'input' === $metadata->getTypedOperationAttribute(
+                                $context['operation_type'],
+                                $context[$context['operation_type'].'_operation_name'] ?? '',
+                                'messenger',
+                                null,
+                                true
+                            );
     }
 }

src/DataTransformer/DataTransformerInitializerInterface.php renamed to src/Core/DataTransformer/DataTransformerInitializerInterface.php

@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\DataTransformer;
+namespace ApiPlatform\Core\DataTransformer;
 
 interface DataTransformerInitializerInterface extends DataTransformerInterface
 {

src/DataTransformer/DataTransformerInterface.php renamed to src/Core/DataTransformer/DataTransformerInterface.php

@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\DataTransformer;
+namespace ApiPlatform\Core\DataTransformer;
 
 /**
  * Transforms a DTO or an Anonymous class to a Resource object.

src/Serializer/AbstractItemNormalizer.php

@@ -16,12 +16,13 @@
 use ApiPlatform\Api\IriConverterInterface;
 use ApiPlatform\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
+use ApiPlatform\Core\Bridge\Symfony\Messenger\DataTransformer as MessengerDataTransformer;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
+use ApiPlatform\Core\DataTransformer\DataTransformerInitializerInterface;
+use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface as LegacyPropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
-use ApiPlatform\DataTransformer\DataTransformerInitializerInterface;
-use ApiPlatform\DataTransformer\DataTransformerInterface;
 use ApiPlatform\Exception\InvalidArgumentException;
 use ApiPlatform\Exception\InvalidValueException;
 use ApiPlatform\Exception\ItemNotFoundException;
@@ -110,6 +111,16 @@ public function __construct(PropertyNameCollectionFactoryInterface $propertyName
         $this->allowPlainIdentifiers = $allowPlainIdentifiers;
 
         $this->dataTransformers = $dataTransformers;
+
+        // Just skip our data transformer to trigger a proper deprecation
+        $customDataTransformers = array_filter(\is_array($dataTransformers) ? $dataTransformers : iterator_to_array($dataTransformers), function ($dataTransformer) {
+            return !$dataTransformer instanceof MessengerDataTransformer;
+        });
+
+        if (\count($customDataTransformers)) {
+            trigger_deprecation('api-platform/core', '2.7', 'The DataTransformer pattern is deprecated, use a Provider or a Processor and either use your input or return a new output there.');
+        }
+
         if ($resourceMetadataFactory && !$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
         }

src/Symfony/Bundle/Resources/config/messenger.xml

@@ -21,7 +21,7 @@
             <tag name="api_platform.state_processor" priority="-900" />
         </service>
 
-        <service id="api_platform.messenger.data_transformer" class="ApiPlatform\Symfony\Messenger\DataTransformer" public="false">
+        <service id="api_platform.messenger.data_transformer" class="ApiPlatform\Core\Bridge\Symfony\Messenger\DataTransformer" public="false">
             <argument type="service" id="api_platform.metadata.resource.metadata_collection_factory.retro_compatible" />
 
             <tag name="api_platform.data_transformer" priority="-10" />

src/Symfony/Messenger/DataTransformer.php

@@ -65,10 +65,6 @@
     ApiPlatform\Core\DataProvider\PaginatorInterface::class => ApiPlatform\State\Pagination\PaginatorInterface::class,
     ApiPlatform\Core\DataProvider\PartialPaginatorInterface::class => ApiPlatform\State\Pagination\PartialPaginatorInterface::class,
 
-    // DataTransformer
-    ApiPlatform\Core\DataTransformer\DataTransformerInitializerInterface::class => ApiPlatform\DataTransformer\DataTransformerInitializerInterface::class,
-    ApiPlatform\Core\DataTransformer\DataTransformerInterface::class => ApiPlatform\DataTransformer\DataTransformerInterface::class,
-
     // Documentation
     ApiPlatform\Core\Documentation\DocumentationInterface::class => ApiPlatform\Documentation\DocumentationInterface::class,
 

src/deprecated_interfaces.php

@@ -188,7 +188,6 @@ class_alias($interfaceName, $oldInterfaceName);
     // Bridge\Symfony\Messenger
     ApiPlatform\Core\Bridge\Symfony\Messenger\ContextStamp::class => ApiPlatform\Symfony\Messenger\ContextStamp::class,
     ApiPlatform\Core\Bridge\Symfony\Messenger\DispatchTrait::class => ApiPlatform\Symfony\Messenger\DispatchTrait::class,
-    ApiPlatform\Core\Bridge\Symfony\Messenger\DataTransformer::class => ApiPlatform\Symfony\Messenger\DataTransformer::class,
     ApiPlatform\Core\Bridge\Symfony\Messenger\RemoveStamp::class => ApiPlatform\Symfony\Messenger\RemoveStamp::class,
 
     // Bridge\Symfony\PropertyInfo\Metadata\Property => Metadata\Property

src/deprecation.php

@@ -14,10 +14,10 @@
 namespace ApiPlatform\Tests\Symfony\Messenger;
 
 use ApiPlatform\Core\Api\OperationType;
+use ApiPlatform\Core\Bridge\Symfony\Messenger\DataTransformer;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Core\Tests\ProphecyTrait;
-use ApiPlatform\Symfony\Messenger\DataTransformer;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Dummy;
 use PHPUnit\Framework\TestCase;
 

tests/Symfony/Messenger/DataTransformerTest.php renamed to tests/Core/Bridge/Symfony/Messenger/DataTransformerTest.php

@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Tests\Fixtures\TestBundle\DataTransformer;
 
-use ApiPlatform\DataTransformer\DataTransformerInterface;
+use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
 use ApiPlatform\Serializer\AbstractItemNormalizer;
 use ApiPlatform\Tests\Fixtures\TestBundle\Document\DummyDtoCustom as DummyDtoCustomDocument;
 use ApiPlatform\Tests\Fixtures\TestBundle\Dto\CustomInputDto;