Fix resource resolution for interface as resources

Before this patch, when you configure an interface as resource the
serializer was not understanding the implementation was a resource.

It also fix the behavior of child of ApiResources that were not detected
as it.

Author: Nek-

features/main/table_inheritance.feature

@@ -307,6 +307,16 @@ Feature: Table inheritance
            "items": {
              "type": "object",
              "properties": {
+               "@type": {
+                 "type": "string",
+                 "pattern": "^ResourceInterface$",
+                 "required": "true"
+               },
+               "@id": {
+                 "type": "string",
+                 "pattern": "^/resource_interfaces/",
+                 "required": "true"
+               },
                "foo": {
                  "type": "string",
                  "required": "true"
@@ -338,6 +348,16 @@ Feature: Table inheritance
           "type": "string",
           "pattern": "ResourceInterface$"
         },
+        "@id": {
+          "type": "string",
+          "pattern": "^/resource_interfaces",
+          "required": "true"
+        },
+        "@type": {
+          "type": "string",
+          "pattern": "^ResourceInterface$",
+          "required": "true"
+        },
         "foo": {
           "type": "string",
           "required": "true"

src/Api/IdentifiersExtractor.php

@@ -67,7 +67,9 @@ public function getIdentifiersFromResourceClass(string $resourceClass): array
     public function getIdentifiersFromItem($item): array
     {
         $identifiers = [];
-        $resourceClass = $this->getObjectClass($item);
+        $type = $this->getObjectClass($item);
+        $resourceClass = $this->resourceClassResolver->isResourceClass($type) ? $this->resourceClassResolver->getResourceClass($item) : $type;
+
         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);
             $identifier = $propertyMetadata->isIdentifier();

src/Api/IriConverterInterface.php

@@ -21,6 +21,8 @@
  * Converts item and resources to IRI and vice versa.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @deprecated in favor of ResourceIriConverterInterface to be removed in ApiPlatform 3.0
  */
 interface IriConverterInterface
 {
@@ -41,6 +43,10 @@ public function getItemFromIri(string $iri, array $context = []);
      *
      * @throws InvalidArgumentException
      * @throws RuntimeException
+     *
+     * @return string Class name of resource
+     *
+     * @deprecated in favor of `ResourceIriConverterInterface::getIriFromItemWithResource`
      */
     public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string;
 

src/Api/ResourceClassResolver.php

@@ -47,18 +47,27 @@ public function getResourceClass($value, string $resourceClass = null, bool $str
             throw new InvalidArgumentException(sprintf('No resource class found.'));
         }
 
+        $resolvedResourceClass = null;
+        foreach ($this->resourceNameCollectionFactory->create() as $currentResourceClass) {
+            if ($resourceClass === $currentResourceClass) {
+                $resolvedResourceClass = $currentResourceClass;
+            }
+            if (null === $resolvedResourceClass && is_subclass_of($type, $currentResourceClass)) {
+                $resolvedResourceClass = $currentResourceClass;
+            }
+        }
+        if (null !== $resolvedResourceClass) {
+            $resourceClass = $resolvedResourceClass;
+        }
+
         if (
             null === $type
             || ((!$strict || $resourceClass === $type) && $isResourceClass = $this->isResourceClass($type))
+            || null !== $resolvedResourceClass && interface_exists($resourceClass)
         ) {
             return $resourceClass;
         }
 
-        // The Resource is an interface
-        if ($value instanceof $resourceClass && $type !== $resourceClass && interface_exists($resourceClass)) {
-            throw new InvalidArgumentException(sprintf('The given object\'s resource is the interface "%s", finding a class is not possible.', $resourceClass));
-        }
-
         if (
             ($isResourceClass ?? $this->isResourceClass($type))
             || (is_subclass_of($type, $resourceClass) && $this->isResourceClass($resourceClass))
@@ -79,7 +88,7 @@ public function isResourceClass(string $type): bool
         }
 
         foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
-            if ($type === $resourceClass) {
+            if ($type === $resourceClass || is_subclass_of($type, $resourceClass)) {
                 return $this->localIsResourceClassCache[$type] = true;
             }
         }

src/Api/ResourceClassResolverInterface.php

@@ -25,12 +25,20 @@ interface ResourceClassResolverInterface
     /**
      * Guesses the associated resource.
      *
+     * @param object $value         Object you're playing with
+     * @param string $resourceClass Resource class it is supposed to be (could be parent class for instance)
+     * @param bool   $strict        value must be type of resource class given or it will return type
+     *
      * @throws InvalidArgumentException
+     *
+     * @return string Resolved resource class
      */
     public function getResourceClass($value, string $resourceClass = null, bool $strict = false): string;
 
     /**
-     * Is the given class a resource class?
+     * Is the given class name an api platform resource?
+     *
+     * @param string $type FQCN of the resource
      */
     public function isResourceClass(string $type): bool;
 }

src/Api/ResourceIriConverterInterface.php

@@ -0,0 +1,38 @@
+<?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\Core\Api;
+
+use ApiPlatform\Core\Exception\InvalidArgumentException;
+use ApiPlatform\Core\Exception\RuntimeException;
+
+/**
+ * Converts item and resources to IRI and vice versa.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+interface ResourceIriConverterInterface extends IriConverterInterface
+{
+    /**
+     * Gets the IRI associated with the given item and resource class.
+     *
+     * @param object $item
+     * @param string $resourceClass resource class to use for generation
+     *
+     * @throws InvalidArgumentException
+     * @throws RuntimeException
+     *
+     * @return string Class name of resource
+     */
+    public function getIriFromItemWithResource($item, string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string;
+}

src/Bridge/Symfony/Routing/IriConverter.php

@@ -15,8 +15,8 @@
 
 use ApiPlatform\Core\Api\IdentifiersExtractor;
 use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
-use ApiPlatform\Core\Api\IriConverterInterface;
 use ApiPlatform\Core\Api\OperationType;
+use ApiPlatform\Core\Api\ResourceIriConverterInterface;
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
 use ApiPlatform\Core\DataProvider\OperationDataProviderTrait;
@@ -40,7 +40,7 @@
  *
  * @author Kévin Dunglas <[email protected]>
  */
-final class IriConverter implements IriConverterInterface
+final class IriConverter implements ResourceIriConverterInterface
 {
     use ClassInfoTrait;
     use OperationDataProviderTrait;
@@ -112,10 +112,21 @@ public function getItemFromIri(string $iri, array $context = [])
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated use `getIriFromItemWithResource` instead to be removed in ApiPlatform 3.0
      */
     public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
     {
         $resourceClass = $this->getObjectClass($item);
+
+        return $this->getIriFromItemWithResource($item, $resourceClass, $referenceType);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIriFromItemWithResource($item, string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
+    {
         $routeName = $this->routeNameResolver->getRouteName($resourceClass, OperationType::ITEM);
 
         try {

src/JsonLd/Serializer/ItemNormalizer.php

@@ -72,7 +72,7 @@ public function normalize($object, $format = null, array $context = [])
         // Use resolved resource class instead of given resource class to support multiple inheritance child types
         $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class'] ?? null, true);
         $context = $this->initContext($resourceClass, $context);
-        $iri = $this->iriConverter->getIriFromItem($object);
+        $iri = $this->iriConverter->getIriFromItemWithResource($object, $resourceClass);
         $context['iri'] = $iri;
         $context['api_normalize'] = true;
 

tests/Api/ResourceClassResolverTest.php

@@ -170,7 +170,7 @@ public function testGetResourceClassWithChildResource()
 
         $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
 
-        $this->assertEquals(DummyTableInheritanceChild::class, $resourceClassResolver->getResourceClass($t, DummyTableInheritance::class));
+        $this->assertEquals(DummyTableInheritance::class, $resourceClassResolver->getResourceClass($t, DummyTableInheritance::class));
     }
 
     public function testGetResourceClassWithInterfaceResource()
@@ -183,4 +183,33 @@ public function testGetResourceClassWithInterfaceResource()
         $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
         $resourceClassResolver->getResourceClass($dummy, DummyResourceInterface::class, true);
     }
+
+    public function testGetResourceClassWithoutSecondParameterIsAccurate()
+    {
+        $dummy = new DummyResourceImplementation();
+        $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyResourceInterface::class]))->shouldBeCalled();
+
+        $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
+        $this->assertEquals(DummyResourceInterface::class, $resourceClassResolver->getResourceClass($dummy));
+    }
+
+    public function testGetResourceInterfaceWithResourceClassParameterReturnTheResouceClass()
+    {
+        $dummy = new DummyResourceImplementation();
+        $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyResourceInterface::class]))->shouldBeCalled();
+
+        $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
+        $this->assertEquals(DummyResourceInterface::class, $resourceClassResolver->getResourceClass($dummy, DummyResourceInterface::class));
+    }
+
+    public function testInterfaceCanBeResourceClass()
+    {
+        $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyResourceInterface::class]))->shouldBeCalled();
+
+        $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
+        $this->assertTrue($resourceClassResolver->isResourceClass(DummyResourceImplementation::class));
+    }
 }