Rework how resource class resolver use inheritance

This commits comes with many changes:

1. The resource class resolver now works well with inheritance and is
able to resolve resources using the ApiPlatform resource list (more
clever)
2. This change adds a new feature: inherited items from api resources
now are working as an api, a new behat test proves it
3. some parts of api platform were not compatible because it does not
uses the resource resolver but "get class" to get the resource, theses
parts are also fixed

Notice: the cache from the resource class resolver is removed here. It
was introduced in 2015 and was probably a great improvement, but since
2016 resources are not re-genarated on each call to the factory but we
call instead a cached factory. This cache was just adding complexity so
I removed it.

Author: Nek-

features/bootstrap/DoctrineContext.php

@@ -74,6 +74,8 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyOffer;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyProduct;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyProperty;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyTableInheritanceNotApiResourceChild;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyTableInheritanceNotApiResourceChild as DummyTableInheritanceNotApiResourceChildDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddableDummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddedDummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\FileConfigDummy;
@@ -165,6 +167,17 @@ public function thereAreDummyObjects(int $nb)
         $this->manager->flush();
     }
 
+    /**
+     * @When some dummy table inheritance data but not api resource child are created
+     */
+    public function someDummyTableInheritanceDataButNotApiResourceChildAreCreated()
+    {
+        $dummy = $this->buildDummyTableInheritanceNotApiResourceChild();
+        $dummy->setName('Foobarbaz inheritance');
+        $this->manager->persist($dummy);
+        $this->manager->flush();
+    }
+
     /**
      * @Given there are :nb foo objects with fake names
      */
@@ -1272,6 +1285,14 @@ private function buildDummy()
         return $this->isOrm() ? new Dummy() : new DummyDocument();
     }
 
+    /**
+     * @return DummyTableInheritanceNotApiResourceChild|DummyTableInheritanceNotApiResourceChildDocument
+     */
+    private function buildDummyTableInheritanceNotApiResourceChild()
+    {
+        return $this->isOrm() ? new DummyTableInheritanceNotApiResourceChild() : new DummyTableInheritanceNotApiResourceChildDocument();
+    }
+
     /**
      * @return DummyAggregateOffer|DummyAggregateOfferDocument
      */

features/main/table_inheritance.feature

@@ -20,15 +20,18 @@ Feature: Table inheritance
       "properties": {
         "@type": {
           "type": "string",
-          "pattern": "^DummyTableInheritanceChild$"
+          "pattern": "^DummyTableInheritanceChild$",
+          "required": "true"
         },
         "@context": {
           "type": "string",
-          "pattern": "^/contexts/DummyTableInheritanceChild$"
+          "pattern": "^/contexts/DummyTableInheritanceChild$",
+          "required": "true"
         },
         "@id": {
           "type": "string",
-          "pattern": "^/dummy_table_inheritance_children/1$"
+          "pattern": "^/dummy_table_inheritance_children/1$",
+          "required": "true"
         },
         "name": {
           "type": "string",
@@ -61,7 +64,8 @@ Feature: Table inheritance
             "properties": {
               "@type": {
                 "type": "string",
-                "pattern": "^DummyTableInheritanceChild$"
+                "pattern": "^DummyTableInheritanceChild$",
+                "required": "true"
               },
               "name": {
                 "type": "string",
@@ -81,6 +85,40 @@ Feature: Table inheritance
     """
 
   @createSchema
+  Scenario: Some children not api resources are created in the app
+    When some dummy table inheritance data but not api resource child are created
+    And I send a "GET" request to "/dummy_table_inheritances"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be valid according to this schema:
+    """
+    {
+      "type": "object",
+      "properties": {
+        "hydra:member": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "@type": {
+                "type": "string",
+                "pattern": "^DummyTableInheritance(Child)?$",
+                "required": "true"
+              },
+              "name": {
+                "type": "string",
+                "required": "true"
+              }
+            }
+          },
+          "minItems": 1
+        }
+      },
+      "required": ["hydra:member"]
+    }
+    """
+
   Scenario: Create a table inherited resource
     When I add "Content-Type" header equal to "application/ld+json"
     And I send a "POST" request to "/dummy_table_inheritance_children" with body:
@@ -97,15 +135,18 @@ Feature: Table inheritance
       "properties": {
         "@type": {
           "type": "string",
-          "pattern": "^DummyTableInheritanceChild$"
+          "pattern": "^DummyTableInheritanceChild$",
+          "required": "true"
         },
         "@context": {
           "type": "string",
-          "pattern": "^/contexts/DummyTableInheritanceChild$"
+          "pattern": "^/contexts/DummyTableInheritanceChild$",
+          "required": "true"
         },
         "@id": {
           "type": "string",
-          "pattern": "^/dummy_table_inheritance_children/1$"
+          "pattern": "^/dummy_table_inheritance_children/1$",
+          "required": "true"
         },
         "name": {
           "type": "string",
@@ -136,15 +177,18 @@ Feature: Table inheritance
       "properties": {
         "@type": {
           "type": "string",
-          "pattern": "^DummyTableInheritanceDifferentChild$"
+          "pattern": "^DummyTableInheritanceDifferentChild$",
+          "required": "true"
         },
         "@context": {
           "type": "string",
-          "pattern": "^/contexts/DummyTableInheritanceDifferentChild$"
+          "pattern": "^/contexts/DummyTableInheritanceDifferentChild$",
+          "required": "true"
         },
         "@id": {
           "type": "string",
-          "pattern": "^/dummy_table_inheritance_different_children/2$"
+          "pattern": "^/dummy_table_inheritance_different_children/2$",
+          "required": "true"
         },
         "name": {
           "type": "string",
@@ -181,15 +225,18 @@ Feature: Table inheritance
       "properties": {
         "@type": {
           "type": "string",
-          "pattern": "^DummyTableInheritanceRelated$"
+          "pattern": "^DummyTableInheritanceRelated$",
+          "required": "true"
         },
         "@context": {
           "type": "string",
-          "pattern": "^/contexts/DummyTableInheritanceRelated$"
+          "pattern": "^/contexts/DummyTableInheritanceRelated$",
+          "required": "true"
         },
         "@id": {
           "type": "string",
-          "pattern": "^/dummy_table_inheritance_relateds/1$"
+          "pattern": "^/dummy_table_inheritance_relateds/1$",
+          "required": "true"
         },
         "children": {
           "items": {
@@ -199,7 +246,8 @@ Feature: Table inheritance
                 "properties": {
                   "@type": {
                     "type": "string",
-                    "pattern": "^DummyTableInheritanceChild$"
+                    "pattern": "^DummyTableInheritanceChild$",
+                    "required": "true"
                   },
                   "name": {
                     "type": "string",
@@ -215,7 +263,8 @@ Feature: Table inheritance
                 "properties": {
                   "@type": {
                     "type": "string",
-                    "pattern": "^DummyTableInheritanceDifferentChild$"
+                    "pattern": "^DummyTableInheritanceDifferentChild$",
+                    "required": "true"
                   },
                   "name": {
                     "type": "string",
@@ -255,7 +304,8 @@ Feature: Table inheritance
                 "properties": {
                   "@type": {
                     "type": "string",
-                    "pattern": "^DummyTableInheritanceChild$"
+                    "pattern": "^DummyTableInheritanceChild$",
+                    "required": "true"
                   },
                   "name": {
                     "type": "string",
@@ -271,7 +321,8 @@ Feature: Table inheritance
                 "properties": {
                   "@type": {
                     "type": "string",
-                    "pattern": "^DummyTableInheritanceDifferentChild$"
+                    "pattern": "^DummyTableInheritanceDifferentChild$",
+                    "required": "true"
                   },
                   "name": {
                     "type": "string",

src/Api/IdentifiersExtractor.php

@@ -67,8 +67,10 @@ public function getIdentifiersFromResourceClass(string $resourceClass): array
     public function getIdentifiersFromItem($item): array
     {
         $identifiers = [];
-        $type = $this->getObjectClass($item);
-        $resourceClass = $this->resourceClassResolver->isResourceClass($type) ? $this->resourceClassResolver->getResourceClass($item) : $type;
+        $resourceClass = $this->getObjectClass($item);
+        if (null !== $this->resourceClassResolver) { // BC Layer
+            $resourceClass = $this->resourceClassResolver->isResourceClass($resourceClass) ? $this->resourceClassResolver->getResourceClass($item) : $resourceClass;
+        }
 
         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
             $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);

src/Api/ResourceClassResolver.php

@@ -28,7 +28,6 @@ final class ResourceClassResolver implements ResourceClassResolverInterface
     use ClassInfoTrait;
 
     private $resourceNameCollectionFactory;
-    private $localIsResourceClassCache = [];
 
     public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory)
     {
@@ -56,20 +55,27 @@ public function getResourceClass($value, string $resourceClass = null, bool $str
                 $resolvedResourceClass = $currentResourceClass;
             }
         }
+
         if (null !== $resolvedResourceClass) {
             $resourceClass = $resolvedResourceClass;
         }
 
+        $typeIsStrictResourceClass = $this->isStrictResourceClass($type);
+        if ($strict && $typeIsStrictResourceClass) {
+            return $type;
+        }
+
+        $typeIsResourceClass = $this->isResourceClass($type);
         if (
             null === $type
-            || ((!$strict || $resourceClass === $type) && $isResourceClass = $this->isResourceClass($type))
-            || null !== $resolvedResourceClass && interface_exists($resourceClass)
+            || (((!$strict || $resourceClass === $type)) && $typeIsResourceClass)
+            || null !== $resolvedResourceClass && (interface_exists($resourceClass) || !$typeIsStrictResourceClass)
         ) {
             return $resourceClass;
         }
 
         if (
-            ($isResourceClass ?? $this->isResourceClass($type))
+            $typeIsResourceClass
             || (is_subclass_of($type, $resourceClass) && $this->isResourceClass($resourceClass))
         ) {
             return $type;
@@ -83,16 +89,28 @@ public function getResourceClass($value, string $resourceClass = null, bool $str
      */
     public function isResourceClass(string $type): bool
     {
-        if (isset($this->localIsResourceClassCache[$type])) {
-            return $this->localIsResourceClassCache[$type];
+        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
+            if ($type === $resourceClass || is_subclass_of($type, $resourceClass)) {
+                return true;
+            }
         }
 
+        return false;
+    }
+
+    /**
+     * Same of isResourceClass but more strict: it ignores inheritance.
+     *
+     * @param string $type FQCN of an object
+     */
+    private function isStrictResourceClass(string $type): bool
+    {
         foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
-            if ($type === $resourceClass || is_subclass_of($type, $resourceClass)) {
-                return $this->localIsResourceClassCache[$type] = true;
+            if ($type === $resourceClass) {
+                return true;
             }
         }
 
-        return $this->localIsResourceClassCache[$type] = false;
+        return false;
     }
 }

src/Api/ResourceClassResolverInterface.php

@@ -25,7 +25,7 @@ interface ResourceClassResolverInterface
     /**
      * Guesses the associated resource.
      *
-     * @param object $value         Object you're playing with
+     * @param mixed  $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
      *

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -121,7 +121,10 @@ private function reset(): void
     private function storeEntityToPublish($entity, string $property): void
     {
         $resourceClass = $this->getObjectClass($entity);
-        if (!$this->resourceClassResolver->isResourceClass($resourceClass)) {
+
+        if ($this->resourceClassResolver->isResourceClass($resourceClass)) {
+            $resourceClass = $this->resourceClassResolver->getResourceClass($entity);
+        } else {
             return;
         }
 

tests/Api/IdentifiersExtractorTest.php

@@ -179,6 +179,7 @@ private function getResourceClassResolver()
         $resourceClassResolver->isResourceClass(Argument::type('string'))->will(function ($args) {
             return !(Uuid::class === $args[0]);
         });
+        $resourceClassResolver->getResourceClass(Argument::any())->will(function ($args) {return \get_class($args[0]); });
 
         return $resourceClassResolver->reveal();
     }

tests/Api/ResourceClassResolverTest.php

@@ -24,6 +24,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyTableInheritance;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyTableInheritanceChild;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyTableInheritanceNotApiResourceChild;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -175,13 +176,12 @@ public function testGetResourceClassWithChildResource()
 
     public function testGetResourceClassWithInterfaceResource()
     {
-        $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage("The given object's resource is the interface \"ApiPlatform\Core\Tests\Fixtures\DummyResourceInterface\", finding a class is not possible.");
         $dummy = new DummyResourceImplementation();
         $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyResourceInterface::class]))->shouldBeCalled();
 
         $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
-        $resourceClassResolver->getResourceClass($dummy, DummyResourceInterface::class, true);
+        $this->assertEquals(DummyResourceInterface::class, $resourceClassResolver->getResourceClass($dummy, DummyResourceInterface::class, true));
     }
 
     public function testGetResourceClassWithoutSecondParameterIsAccurate()
@@ -212,4 +212,26 @@ public function testInterfaceCanBeResourceClass()
         $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
         $this->assertTrue($resourceClassResolver->isResourceClass(DummyResourceImplementation::class));
     }
+
+    public function testItResolveParentResourceClassOfChildrenOfResourceClasses()
+    {
+        $dummy = new DummyTableInheritanceNotApiResourceChild();
+        $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyTableInheritance::class]))->shouldBeCalled();
+
+        $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
+//        $this->assertTrue($resourceClassResolver->isResourceClass(DummyTableInheritanceNotApiResourceChild::class));
+//        $this->assertEquals(DummyTableInheritance::class, $resourceClassResolver->getResourceClass($dummy));
+        $this->assertEquals(DummyTableInheritance::class, $resourceClassResolver->getResourceClass($dummy, DummyTableInheritance::class, true));
+    }
+
+    public function testItResolveChildWhenParentAndChildrenAreResourcesAndIsStrict()
+    {
+        $dummy = new DummyTableInheritanceChild();
+        $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyTableInheritance::class, DummyTableInheritanceChild::class]))->shouldBeCalled();
+
+        $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
+        $this->assertEquals(DummyTableInheritanceChild::class, $resourceClassResolver->getResourceClass($dummy, DummyTableInheritance::class, true));
+    }
 }