Fix Cached identifiers extractor support for stringable identifers. (#1781)

* add missing test coverage for stringable identifiers

* fix test method names

* support string castable identifiers in CachedIdentifiersExtractor

Author: bendavies

src/Api/CachedIdentifiersExtractor.php

@@ -76,6 +76,11 @@ public function getIdentifiersFromItem($item): array
                 continue;
             }
 
+            if (method_exists($identifiers[$propertyName], '__toString')) {
+                $identifiers[$propertyName] = (string) $identifiers[$propertyName];
+                continue;
+            }
+
             $relatedResourceClass = $this->getObjectClass($identifiers[$propertyName]);
             if (!$relatedIdentifiers = $this->localCache[$relatedResourceClass] ?? false) {
                 $relatedCacheKey = self::CACHE_KEY_PREFIX.md5($relatedResourceClass);

tests/Api/CachedIdentifiersExtractorTest.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Api\CachedIdentifiersExtractor;
 use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Doctrine\Generator\Uuid;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\RelatedDummy;
 use PHPUnit\Framework\TestCase;
@@ -26,7 +27,16 @@
  */
 class CachedIdentifiersExtractorTest extends TestCase
 {
-    public function testFirstPass()
+    public function identifiersProvider()
+    {
+        yield [1, 1];
+        yield [$uuid = new Uuid(), $uuid->__toString()];
+    }
+
+    /**
+     * @dataProvider identifiersProvider
+     */
+    public function testFirstPass($identifier, $identifierValue)
     {
         $key = 'iri_identifiers'.md5(Dummy::class);
 
@@ -39,14 +49,14 @@ public function testFirstPass()
         $cacheItemPool->save($cacheItem)->shouldBeCalled();
 
         $dummy = new Dummy();
-        $dummy->setId(1);
+        $dummy->setId($identifier);
 
         $decoration = $this->prophesize(IdentifiersExtractorInterface::class);
-        $decoration->getIdentifiersFromItem($dummy)->shouldBeCalled()->willReturn(['id' => 1]);
+        $decoration->getIdentifiersFromItem($dummy)->shouldBeCalled()->willReturn(['id' => $identifierValue]);
 
         $identifiersExtractor = new CachedIdentifiersExtractor($cacheItemPool->reveal(), $decoration->reveal(), null);
 
-        $expectedResult = ['id' => 1];
+        $expectedResult = ['id' => $identifierValue];
         $this->assertEquals($expectedResult, $identifiersExtractor->getIdentifiersFromItem($dummy));
         $this->assertEquals($expectedResult, $identifiersExtractor->getIdentifiersFromItem($dummy), 'Trigger the local cache');
 
@@ -57,7 +67,10 @@ public function testFirstPass()
         $this->assertEquals($expectedResult, $identifiersExtractor->getIdentifiersFromResourceClass(Dummy::class), 'Trigger the local cache');
     }
 
-    public function testSecondPass()
+    /**
+     * @dataProvider identifiersProvider
+     */
+    public function testSecondPass($identifier, $identifierValue)
     {
         $key = 'iri_identifiers'.md5(Dummy::class);
 
@@ -69,19 +82,19 @@ public function testSecondPass()
         $cacheItemPool->getItem($key)->shouldBeCalled()->willReturn($cacheItem);
 
         $dummy = new Dummy();
-        $dummy->setId(1);
+        $dummy->setId($identifier);
 
         $decoration = $this->prophesize(IdentifiersExtractorInterface::class);
         $decoration->getIdentifiersFromItem($dummy)->shouldNotBeCalled();
 
         $identifiersExtractor = new CachedIdentifiersExtractor($cacheItemPool->reveal(), $decoration->reveal(), null);
 
-        $expectedResult = ['id' => 1];
+        $expectedResult = ['id' => $identifierValue];
         $this->assertEquals($expectedResult, $identifiersExtractor->getIdentifiersFromItem($dummy));
         $this->assertEquals($expectedResult, $identifiersExtractor->getIdentifiersFromItem($dummy), 'Trigger the local cache');
     }
 
-    public function testSecondPassWithRelatedNotCached()
+    public function testFirstPassWithRelated()
     {
         $key = 'iri_identifiers'.md5(Dummy::class);
         $keyRelated = 'iri_identifiers'.md5(RelatedDummy::class);
@@ -114,7 +127,7 @@ public function testSecondPassWithRelatedNotCached()
         $this->assertEquals($expectedResult, $identifiersExtractor->getIdentifiersFromItem($dummy), 'Trigger the local cache');
     }
 
-    public function testSecondPassWithRelatedCached()
+    public function testSecondPassWithRelated()
     {
         $key = 'iri_identifiers'.md5(Dummy::class);
         $keyRelated = 'iri_identifiers'.md5(RelatedDummy::class);

tests/Api/IdentifiersExtractorTest.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
 use ApiPlatform\Core\Metadata\Property\PropertyNameCollection;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Doctrine\Generator\Uuid;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\RelatedDummy;
 use PHPUnit\Framework\TestCase;
@@ -78,6 +79,18 @@ public function testGetIdentifiersFromItem()
         $this->assertEquals(['id' => 1], $identifiersExtractor->getIdentifiersFromItem($dummy));
     }
 
+    public function testGetStringableIdentifiersFromItem()
+    {
+        list($propertyNameCollectionFactoryProphecy, $propertyMetadataFactoryProphecy) = $this->getMetadataFactoryProphecies(Dummy::class, ['id']);
+
+        $identifiersExtractor = new IdentifiersExtractor($propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal());
+
+        $dummy = new Dummy();
+        $dummy->setId(new Uuid());
+
+        $this->assertEquals(['id' => 'foo'], $identifiersExtractor->getIdentifiersFromItem($dummy));
+    }
+
     public function testGetCompositeIdentifiersFromItem()
     {
         list($propertyNameCollectionFactoryProphecy, $propertyMetadataFactoryProphecy) = $this->getMetadataFactoryProphecies(Dummy::class, ['id', 'name']);