fix: a check, and add tests

api-platform · dunglas · Jul 24, 2023 · Jul 24, 2023 · Jul 24, 2023 · Jul 24, 2023
commit 5ae5f045555736fbd9b363d3ee38ba2a0d2a1be7
diff --git a/src/Elasticsearch/Serializer/ItemNormalizer.php b/src/Elasticsearch/Serializer/ItemNormalizer.php
@@ -15,6 +15,7 @@
 
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Exception\LogicException;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\SerializerAwareInterface;
@@ -39,8 +40,10 @@ public function __construct(private readonly NormalizerInterface $decorated)
      */
     public function hasCacheableSupportsMethod(): bool
     {
-        if (!$this->decorated instanceof CacheableSupportsMethodInterface) {
-            throw new LogicException(sprintf('The decorated normalizer must be an instance of "%s".', CacheableSupportsMethodInterface::class));
+        trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
+
+        if (!$this->decorated instanceof BaseCacheableSupportsMethodInterface) {
+            throw new LogicException(sprintf('The decorated normalizer must be an instance of "%s".', BaseCacheableSupportsMethodInterface::class));
         }
 
         return $this->decorated->hasCacheableSupportsMethod();
@@ -96,11 +99,11 @@ public function getSupportedTypes($format): array
         if (!method_exists($this->decorated, 'getSupportedTypes')) {
             return [
                 DocumentNormalizer::FORMAT => null,
-                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+                '*' => $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
             ];
         }
 
-        return DocumentNormalizer::FORMAT !== $format ? $this->decorated->getSupportedTypes($format) : [];
+        return DocumentNormalizer::FORMAT === $format ? $this->decorated->getSupportedTypes($format) : [];
     }
 
     /**

diff --git a/src/GraphQl/Serializer/ObjectNormalizer.php b/src/GraphQl/Serializer/ObjectNormalizer.php
@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
@@ -49,7 +50,7 @@ public function getSupportedTypes($format): array
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->decorated, 'getSupportedTypes')) {
             return [
-                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+                '*' => $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
             ];
         }
 
@@ -63,7 +64,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
+        return $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 
     /**

diff --git a/src/Hal/Serializer/ObjectNormalizer.php b/src/Hal/Serializer/ObjectNormalizer.php
@@ -16,6 +16,7 @@
 use ApiPlatform\Api\IriConverterInterface;
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Exception\LogicException;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -44,7 +45,7 @@ public function getSupportedTypes($format): array
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->decorated, 'getSupportedTypes')) {
             return [
-                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+                '*' => $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
             ];
         }
 
@@ -58,7 +59,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
+        return $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 
     /**

diff --git a/src/Hydra/Serializer/CollectionFiltersNormalizer.php b/src/Hydra/Serializer/CollectionFiltersNormalizer.php
@@ -22,6 +22,7 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -54,7 +55,7 @@ public function getSupportedTypes($format): array
     {
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->collectionNormalizer, 'getSupportedTypes')) {
-            return ['*' => $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod()];
+            return ['*' => $this->collectionNormalizer instanceof BaseCacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod()];
         }
 
         return $this->collectionNormalizer->getSupportedTypes($format);
@@ -64,7 +65,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
+        return $this->collectionNormalizer instanceof BaseCacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
     }
 
     /**

diff --git a/src/Hydra/Serializer/PartialCollectionViewNormalizer.php b/src/Hydra/Serializer/PartialCollectionViewNormalizer.php
@@ -22,6 +22,7 @@
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -111,7 +112,7 @@ public function getSupportedTypes($format): array
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->collectionNormalizer, 'getSupportedTypes')) {
             return [
-                '*' => $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod(),
+                '*' => $this->collectionNormalizer instanceof BaseCacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod(),
             ];
         }
 
@@ -122,7 +123,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
+        return $this->collectionNormalizer instanceof BaseCacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();
     }
 
     /**

diff --git a/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php b/src/JsonApi/Serializer/ConstraintViolationListNormalizer.php
@@ -61,7 +61,7 @@ public function supportsNormalization(mixed $data, string $format = null, array
 
     public function getSupportedTypes($format): array
     {
-        return (self::FORMAT === $format) ? [ConstraintViolationListInterface::class => true] : [];
+        return self::FORMAT === $format ? [ConstraintViolationListInterface::class => true] : [];
     }
 
     public function hasCacheableSupportsMethod(): bool

diff --git a/src/JsonApi/Serializer/ObjectNormalizer.php b/src/JsonApi/Serializer/ObjectNormalizer.php
@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
@@ -47,7 +48,7 @@ public function getSupportedTypes($format): array
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->decorated, 'getSupportedTypes')) {
             return [
-                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+                '*' => $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
             ];
         }
 
@@ -58,7 +59,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
+        return $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 
     /**

diff --git a/src/JsonLd/Serializer/ObjectNormalizer.php b/src/JsonLd/Serializer/ObjectNormalizer.php
@@ -17,6 +17,7 @@
 use ApiPlatform\Exception\InvalidArgumentException;
 use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
@@ -46,7 +47,7 @@ public function getSupportedTypes($format): array
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->decorated, 'getSupportedTypes')) {
             return [
-                '*' => $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
+                '*' => $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod(),
             ];
         }
 
@@ -57,7 +58,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
+        return $this->decorated instanceof BaseCacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
     }
 
     /**

diff --git a/src/OpenApi/Serializer/ApiGatewayNormalizer.php b/src/OpenApi/Serializer/ApiGatewayNormalizer.php
@@ -13,8 +13,8 @@
 
 namespace ApiPlatform\OpenApi\Serializer;
 
-use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
@@ -124,7 +124,7 @@ public function getSupportedTypes($format): array
     {
         // @deprecated remove condition when support for symfony versions under 6.3 is dropped
         if (!method_exists($this->documentationNormalizer, 'getSupportedTypes')) {
-            return ['*' => $this->documentationNormalizer instanceof CacheableSupportsMethodInterface && $this->documentationNormalizer->hasCacheableSupportsMethod()];
+            return ['*' => $this->documentationNormalizer instanceof BaseCacheableSupportsMethodInterface && $this->documentationNormalizer->hasCacheableSupportsMethod()];
         }
 
         return $this->documentationNormalizer->getSupportedTypes($format);
@@ -137,7 +137,7 @@ public function hasCacheableSupportsMethod(): bool
     {
         trigger_deprecation('api-platform/core', '3.1', 'The "%s()" method is deprecated, use "getSupportedTypes()" instead.', __METHOD__);
 
-        return $this->documentationNormalizer instanceof CacheableSupportsMethodInterface && $this->documentationNormalizer->hasCacheableSupportsMethod();
+        return $this->documentationNormalizer instanceof BaseCacheableSupportsMethodInterface && $this->documentationNormalizer->hasCacheableSupportsMethod();
     }
 
     private function isLocalRef(string $ref): bool

diff --git a/src/OpenApi/Serializer/CacheableSupportsMethodInterface.php b/src/OpenApi/Serializer/CacheableSupportsMethodInterface.php
@@ -0,0 +1,46 @@
+<?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\OpenApi\Serializer;
+
+use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface as BaseCacheableSupportsMethodInterface;
+use Symfony\Component\Serializer\Serializer;
+
+if (method_exists(Serializer::class, 'getSupportedTypes')) {
+    /**
+     * Backward compatibility layer for getSupportedTypes().
+     *
+     * @internal
+     *
+     * @author Kévin Dunglas <[email protected]>
+     *
+     * @todo remove this interface when dropping support for Serializer < 6.3
+     */
+    interface CacheableSupportsMethodInterface
+    {
+        public function getSupportedTypes(?string $format): array;
+    }
+} else {
+    /**
+     * Backward compatibility layer for NormalizerInterface::getSupportedTypes().
+     *
+     * @internal
+     *
+     * @author Kévin Dunglas <[email protected]>
+     *
+     * @todo remove this interface when dropping support for Serializer < 6.3
+     */
+    interface CacheableSupportsMethodInterface extends BaseCacheableSupportsMethodInterface
+    {
+    }
+}
diff --git a/src/OpenApi/Serializer/OpenApiNormalizer.php b/src/OpenApi/Serializer/OpenApiNormalizer.php
@@ -15,7 +15,6 @@
 
 use ApiPlatform\OpenApi\Model\Paths;
 use ApiPlatform\OpenApi\OpenApi;
-use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

diff --git a/src/OpenApi/Tests/Serializer/ApiGatewayNormalizerTest.php b/src/OpenApi/Tests/Serializer/ApiGatewayNormalizerTest.php
@@ -35,9 +35,9 @@ final class ApiGatewayNormalizerTest extends TestCase
     public function testSupportsNormalization(): void
     {
         $normalizerProphecy = $this->prophesize(NormalizerInterface::class);
-        $normalizerProphecy->willImplement(CacheableSupportsMethodInterface::class);
         $normalizerProphecy->supportsNormalization(OpenApiNormalizer::FORMAT, OpenApi::class)->willReturn(true);
         if (!method_exists(Serializer::class, 'getSupportedTypes')) {
+            $normalizerProphecy->willImplement(CacheableSupportsMethodInterface::class);
             $normalizerProphecy->hasCacheableSupportsMethod()->willReturn(true);
         }
 

diff --git a/src/Serializer/AbstractItemNormalizer.php b/src/Serializer/AbstractItemNormalizer.php
@@ -89,9 +89,7 @@ public function supportsNormalization(mixed $data, string $format = null, array
 
     public function getSupportedTypes(?string $format): array
     {
-        return [
-            '*' => true,
-        ];
+        return ['*' => true];
     }
 
     /**

diff --git a/src/Serializer/CacheableSupportsMethodInterface.php b/src/Serializer/CacheableSupportsMethodInterface.php
@@ -42,5 +42,6 @@ public function getSupportedTypes(?string $format): array;
      */
     interface CacheableSupportsMethodInterface extends BaseCacheableSupportsMethodInterface
     {
+        public function getSupportedTypes(?string $format): array;
     }
 }
diff --git a/tests/Elasticsearch/Serializer/ItemNormalizerTest.php b/tests/Elasticsearch/Serializer/ItemNormalizerTest.php
@@ -111,6 +111,10 @@ public function testSetSerializer(): void
      */
     public function testHasCacheableSupportsMethodWithDecoratedNormalizerNotAnInstanceOfCacheableSupportsMethodInterface(): void
     {
+        if (method_exists(Serializer::class, 'getSupportedTypes')) {
+            $this->markTestSkipped('Symfony Serializer >= 6.3');
+        }
+
         $this->expectException(LogicException::class);
         $this->expectExceptionMessage(sprintf('The decorated normalizer must be an instance of "%s".', CacheableSupportsMethodInterface::class));
 
@@ -140,4 +144,12 @@ public function testSetSerializerWithDecoratedNormalizerNotAnInstanceOfSerialize
 
         (new ItemNormalizer($this->prophesize(NormalizerInterface::class)->reveal()))->setSerializer($this->prophesize(SerializerInterface::class)->reveal());
     }
+
+    public function testGetSupportedTypes(): void
+    {
+        $this->normalizerProphecy->getSupportedTypes(Argument::any())->willReturn(['*' => true]);
+
+        $this->assertEmpty($this->itemNormalizer->getSupportedTypes('json'));
+        $this->assertSame(['*' => true], $this->itemNormalizer->getSupportedTypes($this->itemNormalizer::FORMAT));
+    }
 }
diff --git a/tests/Hal/Serializer/CollectionNormalizerTest.php b/tests/Hal/Serializer/CollectionNormalizerTest.php
@@ -50,6 +50,12 @@ public function testSupportsNormalize(): void
         $this->assertFalse($normalizer->supportsNormalization([], 'xml', ['resource_class' => 'Foo']));
         $this->assertFalse($normalizer->supportsNormalization(new \ArrayObject(), 'xml', ['resource_class' => 'Foo']));
 
+        $this->assertEmpty($normalizer->getSupportedTypes('json'));
+        $this->assertSame([
+            'native-array' => true,
+            '\Traversable' => true,
+        ], $normalizer->getSupportedTypes($normalizer::FORMAT));
+
         if (!method_exists(Serializer::class, 'getSupportedTypes')) {
             $this->assertTrue($normalizer->hasCacheableSupportsMethod());
         }

diff --git a/tests/Hal/Serializer/EntrypointNormalizerTest.php b/tests/Hal/Serializer/EntrypointNormalizerTest.php
@@ -53,6 +53,9 @@ public function testSupportNormalization(): void
         $this->assertFalse($normalizer->supportsNormalization($entrypoint, 'json'));
         $this->assertFalse($normalizer->supportsNormalization(new \stdClass(), EntrypointNormalizer::FORMAT));
 
+        $this->assertEmpty($normalizer->getSupportedTypes('json'));
+        $this->assertSame([Entrypoint::class => true], $normalizer->getSupportedTypes($normalizer::FORMAT));
+
         if (!method_exists(Serializer::class, 'getSupportedTypes')) {
             $this->assertTrue($normalizer->hasCacheableSupportsMethod());
         }

diff --git a/tests/Hal/Serializer/ItemNormalizerTest.php b/tests/Hal/Serializer/ItemNormalizerTest.php
@@ -95,9 +95,11 @@ public function testSupportsNormalization(): void
             $nameConverter->reveal()
         );
 
-        $this->assertTrue($normalizer->supportsNormalization($dummy, 'jsonhal'));
+        $this->assertTrue($normalizer->supportsNormalization($dummy, $normalizer::FORMAT));
         $this->assertFalse($normalizer->supportsNormalization($dummy, 'xml'));
-        $this->assertFalse($normalizer->supportsNormalization($std, 'jsonhal'));
+        $this->assertFalse($normalizer->supportsNormalization($std, $normalizer::FORMAT));
+        $this->assertEmpty($normalizer->getSupportedTypes('xml'));
+        $this->assertSame(['*' => true], $normalizer->getSupportedTypes($normalizer::FORMAT));
 
         if (!method_exists(Serializer::class, 'getSupportedTypes')) {
             $this->assertTrue($normalizer->hasCacheableSupportsMethod());
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,5 +42,6 @@ public function getSupportedTypes(?string $format): array; @@
          */
         interface CacheableSupportsMethodInterface extends BaseCacheableSupportsMethodInterface
         {
+            public function getSupportedTypes(?string $format): array;
         }
     }