Throw an error when no identifier is defined (#3871)

api-platform · Dec 2, 2020 · b5be5e0 · b5be5e0
1 parent 1494ae8
commit b5be5e0
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 0 deletions.
diff --git a/src/Api/IdentifiersExtractor.php b/src/Api/IdentifiersExtractor.php
@@ -57,6 +57,10 @@ public function getIdentifiersFromResourceClass(string $resourceClass): array
             }
         }
 
+        if (!$identifiers) {
+            throw new RuntimeException(sprintf('No identifier defined "%s". You should add #[\ApiPlatform\Core\Annotation\ApiProperty(identifier: true)]" on the property identifying the resource."', $resourceClass));
+        }
+
         return $identifiers;
     }
 

diff --git a/tests/Api/IdentifiersExtractorTest.php b/tests/Api/IdentifiersExtractorTest.php
@@ -202,6 +202,20 @@ public function testGetsIdentifiersFromCorrectResourceClass(): void
         $this->assertSame(['foo' => 'woot'], $identifiersExtractor->getIdentifiersFromItem($item));
     }
 
+    public function testNoIdentifiers(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('No identifier defined "ApiPlatform\\Core\\Tests\\Fixtures\\TestBundle\\Entity\\Dummy". You should add #[\ApiPlatform\Core\Annotation\ApiProperty(identifier: true)]" on the property identifying the resource.');
+        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
+        $propertyNameCollectionFactoryProphecy->create(Dummy::class)->willReturn(new PropertyNameCollection(['foo']));
+        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
+        $propertyMetadataFactoryProphecy->create(Dummy::class, 'foo')->willReturn(new PropertyMetadata());
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
+        $identifiersExtractor = new IdentifiersExtractor($propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal(), null, $resourceClassResolverProphecy->reveal());
+
+        $identifiersExtractor->getIdentifiersFromResourceClass(Dummy::class);
+    }
+
     /**
      * @group legacy
      * @expectedDeprecation Not injecting ApiPlatform\Core\Api\ResourceClassResolverInterface in the IdentifiersExtractor might introduce cache issues with object identifiers.

diff --git a/tests/Fixtures/TestBundle/Entity/DummyForAdditionalFieldsInput.php b/tests/Fixtures/TestBundle/Entity/DummyForAdditionalFieldsInput.php
@@ -13,13 +13,19 @@
 
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
 
+use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
 
 /**
  * @ApiResource
  */
 final class DummyForAdditionalFieldsInput
 {
+    /**
+     * @ApiProperty(identifier=true)
+     */
+    public $id;
+
     private $dummyName;
 
     public function __construct(string $dummyName)

diff --git a/tests/Fixtures/TestBundle/Model/ResourceBarInterface.php b/tests/Fixtures/TestBundle/Model/ResourceBarInterface.php
@@ -13,7 +13,12 @@
 
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Model;
 
+use ApiPlatform\Core\Annotation\ApiProperty;
+
 interface ResourceBarInterface
 {
+    /**
+     * @ApiProperty(identifier=true)
+     */
     public function getBar(): ?string;
 }