test: fix Hal/Serializer tests (#38)

* test: fix Hal/Serializer tests

* Update src/Hal/Serializer/EntrypointNormalizer.php

Co-authored-by: Antoine Bluchet <[email protected]>

* Apply suggestions from code review

c

* fix: review

Co-authored-by: Antoine Bluchet <[email protected]>

Author: 2 people

src/Hal/Serializer/CollectionNormalizer.php

@@ -14,8 +14,6 @@
 namespace ApiPlatform\Hal\Serializer;
 
 use ApiPlatform\Api\ResourceClassResolverInterface;
-use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
-use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
 use ApiPlatform\Serializer\AbstractCollectionNormalizer;
 use ApiPlatform\Util\IriHelper;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
@@ -43,14 +41,9 @@ protected function getPaginationData($object, array $context = []): array
         [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
         $parsed = IriHelper::parseIri($context['uri'] ?? '/', $this->pageParameterName);
 
-        /** @var ResourceMetadata|ResourceMetadataCollection */
         $metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? '');
-        if ($metadata instanceof ResourceMetadataCollection) {
-            $operation = $metadata->getOperation($context['operation_name'] ?? null);
-            $urlGenerationStrategy = $operation->getUrlGenerationStrategy();
-        } else {
-            $urlGenerationStrategy = $metadata->getAttribute('url_generation_strategy');
-        }
+        $operation = $metadata->getOperation($context['operation_name'] ?? null);
+        $urlGenerationStrategy = $operation->getUrlGenerationStrategy();
 
         $data = [
             '_links' => [

src/Hal/Serializer/EntrypointNormalizer.php

@@ -16,14 +16,10 @@
 use ApiPlatform\Api\Entrypoint;
 use ApiPlatform\Api\IriConverterInterface;
 use ApiPlatform\Api\UrlGeneratorInterface;
-use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
-use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Exception\InvalidArgumentException;
 use ApiPlatform\Metadata\CollectionOperationInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
-use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
 use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -36,27 +32,15 @@ final class EntrypointNormalizer implements NormalizerInterface, CacheableSuppor
 {
     public const FORMAT = 'jsonhal';
 
-    /**
-     * @var ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface
-     */
     private $resourceMetadataFactory;
-    /** @var LegacyIriConverterInterface|IriConverterInterface */
     private $iriConverter;
     private $urlGenerator;
 
-    public function __construct($resourceMetadataFactory, $iriConverter, UrlGeneratorInterface $urlGenerator)
+    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, IriConverterInterface $iriConverter, UrlGeneratorInterface $urlGenerator)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->iriConverter = $iriConverter;
         $this->urlGenerator = $urlGenerator;
-
-        if ($iriConverter instanceof LegacyIriConverterInterface) {
-            trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
-        }
-
-        if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
-            trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
-        }
     }
 
     /**
@@ -67,32 +51,19 @@ public function normalize($object, $format = null, array $context = []): array
         $entrypoint = ['_links' => ['self' => ['href' => $this->urlGenerator->generate('api_entrypoint')]]];
 
         foreach ($object->getResourceNameCollection() as $resourceClass) {
-            /** @var ResourceMetadata|ResourceMetadataCollection */
             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
 
-            if ($resourceMetadata instanceof ResourceMetadata) {
-                if (!$resourceMetadata->getCollectionOperations()) {
-                    continue;
-                }
-
-                try {
-                    $entrypoint['_links'][lcfirst($resourceMetadata->getShortName())]['href'] = $this->iriConverter->getIriFromResourceClass($resourceClass);
-                } catch (InvalidArgumentException $ex) {
-                    // Ignore resources without GET operations
-                }
-            }
-
             foreach ($resourceMetadata as $resource) {
-                foreach ($resource->getOperations() as $operationName => $operation) {
+                foreach ($resource->getOperations() as $operation) {
                     /** @var Operation $operation */
                     if (!$operation instanceof CollectionOperationInterface) {
                         continue;
                     }
 
                     try {
-                        $href = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromResourceClass($resourceClass) : $this->iriConverter->getIriFromResource($operation->getClass(), UrlGeneratorInterface::ABS_PATH, $operation);
+                        $href = $this->iriConverter->getIriFromResource($operation->getClass(), UrlGeneratorInterface::ABS_PATH, $operation);
                         $entrypoint['_links'][lcfirst($operation->getShortName())]['href'] = $href;
-                    } catch (InvalidArgumentException $ex) {
+                    } catch (InvalidArgumentException) {
                         // Ignore resources without GET operations
                     }
                 }

src/Hal/Serializer/ObjectNormalizer.php

@@ -14,7 +14,6 @@
 namespace ApiPlatform\Hal\Serializer;
 
 use ApiPlatform\Api\IriConverterInterface;
-use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
 use Symfony\Component\Serializer\Exception\LogicException;
 use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
@@ -31,14 +30,10 @@ final class ObjectNormalizer implements NormalizerInterface, DenormalizerInterfa
     private $decorated;
     private $iriConverter;
 
-    public function __construct(NormalizerInterface $decorated, $iriConverter)
+    public function __construct(NormalizerInterface $decorated, IriConverterInterface $iriConverter)
     {
         $this->decorated = $decorated;
         $this->iriConverter = $iriConverter;
-
-        if ($iriConverter instanceof LegacyIriConverterInterface) {
-            trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
-        }
     }
 
     /**
@@ -81,7 +76,7 @@ public function normalize($object, $format = null, array $context = [])
         $metadata = [
             '_links' => [
                 'self' => [
-                    'href' => $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($originalResource) : $this->iriConverter->getIriFromResource($originalResource),
+                    'href' => $this->iriConverter->getIriFromResource($originalResource),
                 ],
             ],
         ];

src/Serializer/AbstractCollectionNormalizer.php

@@ -14,7 +14,6 @@
 namespace ApiPlatform\Serializer;
 
 use ApiPlatform\Api\ResourceClassResolverInterface;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use ApiPlatform\State\Pagination\PartialPaginatorInterface;
@@ -43,12 +42,9 @@ abstract class AbstractCollectionNormalizer implements NormalizerInterface, Norm
     protected $resourceClassResolver;
     protected $pageParameterName;
 
-    /**
-     * @var ResourceMetadataCollectionFactoryInterface|ResourceMetadataFactoryInterface
-     */
     protected $resourceMetadataFactory;
 
-    public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, $resourceMetadataFactory = null)
+    public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null)
     {
         $this->resourceClassResolver = $resourceClassResolver;
         $this->pageParameterName = $pageParameterName;

src/Serializer/AbstractItemNormalizer.php

@@ -59,22 +59,14 @@ abstract class AbstractItemNormalizer extends AbstractObjectNormalizer
      * @var PropertyNameCollectionFactoryInterface
      */
     protected $propertyNameCollectionFactory;
-    /**
-     * @var LegacyPropertyMetadataFactoryInterface|PropertyMetadataFactoryInterface
-     */
     protected $propertyMetadataFactory;
-    /**
-     * @var LegacyIriConverterInterface|IriConverterInterface
-     */
     protected $iriConverter;
     protected $resourceClassResolver;
     protected $resourceAccessChecker;
     protected $propertyAccessor;
-    protected $allowPlainIdentifiers;
-    protected $dataTransformers = [];
     protected $localCache = [];
 
-    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
+    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
     {
         if (!isset($defaultContext['circular_reference_handler'])) {
             $defaultContext['circular_reference_handler'] = function ($object) {

tests/Hal/Serializer/CollectionNormalizerTest.php

@@ -14,9 +14,12 @@
 namespace ApiPlatform\Tests\Hal\Serializer;
 
 use ApiPlatform\Api\ResourceClassResolverInterface;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
-use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Hal\Serializer\CollectionNormalizer;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\Operations;
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use ApiPlatform\State\Pagination\PartialPaginatorInterface;
 use ApiPlatform\Tests\ProphecyTrait;
@@ -34,7 +37,7 @@ class CollectionNormalizerTest extends TestCase
     public function testSupportsNormalize()
     {
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
-        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
         $normalizer = new CollectionNormalizer($resourceClassResolverProphecy->reveal(), 'page', $resourceMetadataFactoryProphecy->reveal());
 
         $this->assertTrue($normalizer->supportsNormalization([], CollectionNormalizer::FORMAT));
@@ -48,7 +51,7 @@ public function testNormalizeApiSubLevel()
     {
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->getResourceClass()->shouldNotBeCalled();
-        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
 
         $itemNormalizer = $this->prophesize(NormalizerInterface::class);
         $itemNormalizer->normalize('bar', null, ['api_sub_level' => true])->willReturn(22);
@@ -142,20 +145,26 @@ private function normalizePaginator($partial = false)
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->getResourceClass($paginatorProphecy, 'Foo')->willReturn('Foo');
 
-        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
-        $resourceMetadataFactoryProphecy->create('Foo')->willReturn(new ResourceMetadata());
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
+        $resourceMetadataFactoryProphecy->create('Foo')->willReturn(new ResourceMetadataCollection('Foo', [
+            (new ApiResource())->withShortName('Foo')->withOperations(new Operations([
+                'bar' => (new GetCollection())->withShortName('Foo'),
+            ])),
+        ]));
 
         $itemNormalizer = $this->prophesize(NormalizerInterface::class);
         $itemNormalizer->normalize('foo', CollectionNormalizer::FORMAT, [
-            'api_sub_level' => true,
             'resource_class' => 'Foo',
+            'operation_name' => 'bar',
+            'api_sub_level' => true,
         ])->willReturn(['_links' => ['self' => '/me'], 'name' => 'Kévin']);
 
         $normalizer = new CollectionNormalizer($resourceClassResolverProphecy->reveal(), 'page', $resourceMetadataFactoryProphecy->reveal());
         $normalizer->setNormalizer($itemNormalizer->reveal());
 
         return $normalizer->normalize($paginatorProphecy->reveal(), CollectionNormalizer::FORMAT, [
             'resource_class' => 'Foo',
+            'operation_name' => 'bar',
         ]);
     }
 }

tests/Hal/Serializer/EntrypointNormalizerTest.php

@@ -14,11 +14,14 @@
 namespace ApiPlatform\Tests\Hal\Serializer;
 
 use ApiPlatform\Api\Entrypoint;
+use ApiPlatform\Api\IriConverterInterface;
 use ApiPlatform\Api\UrlGeneratorInterface;
-use ApiPlatform\Core\Api\IriConverterInterface;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
-use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Hal\Serializer\EntrypointNormalizer;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\Operations;
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
 use ApiPlatform\Metadata\Resource\ResourceNameCollection;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Dummy;
 use ApiPlatform\Tests\ProphecyTrait;
@@ -37,7 +40,7 @@ public function testSupportNormalization()
         $collection = new ResourceNameCollection();
         $entrypoint = new Entrypoint($collection);
 
-        $factoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $factoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
         $urlGeneratorProphecy = $this->prophesize(UrlGeneratorInterface::class);
 
@@ -53,11 +56,18 @@ public function testNormalize()
     {
         $collection = new ResourceNameCollection([Dummy::class]);
         $entrypoint = new Entrypoint($collection);
-        $factoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
-        $factoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadata('Dummy', null, null, null, ['get']))->shouldBeCalled();
+        $factoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
+        $operation = (new GetCollection())->withShortName('Dummy')->withClass(Dummy::class);
+        $factoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadataCollection('Dummy', [
+            (new ApiResource('Dummy'))
+                ->withShortName('Dummy')
+                ->withOperations(new Operations([
+                    'get' => $operation,
+                ])),
+        ]))->shouldBeCalled();
 
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
-        $iriConverterProphecy->getIriFromResourceClass(Dummy::class)->willReturn('/api/dummies')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromResource(Dummy::class, UrlGeneratorInterface::ABS_PATH, $operation)->willReturn('/api/dummies')->shouldBeCalled();
 
         $urlGeneratorProphecy = $this->prophesize(UrlGeneratorInterface::class);
         $urlGeneratorProphecy->generate('api_entrypoint')->willReturn('/api')->shouldBeCalled();