Test metadata (#4732)

soyuka · web-flow · commit f6cdf899537c · 2022-04-27T17:44:12.000+02:00
* test: run 3.x metadata on php 8.1

* fix gql
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -156,6 +156,9 @@ jobs:
           else
             vendor/bin/simple-phpunit --log-junit build/logs/phpunit/junit.xml
           fi
+      - name: Run PHPUnit 8.1+ tests
+        if: (startsWith(matrix.php, '8.1'))
+        run: ./vendor/bin/simple-phpunit --stop-on-failure tests/Metadata/Resource/Factory/
       - name: Upload test artifacts
         if: always()
         uses: actions/upload-artifact@v1
diff --git a/src/Metadata/Delete.php b/src/Metadata/Delete.php
@@ -88,8 +88,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(self::METHOD_DELETE, ...\func_get_args());
diff --git a/src/Metadata/Get.php b/src/Metadata/Get.php
@@ -88,8 +88,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(self::METHOD_GET, ...\func_get_args());
diff --git a/src/Metadata/GetCollection.php b/src/Metadata/GetCollection.php
@@ -88,8 +88,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(self::METHOD_GET, ...\func_get_args());
diff --git a/src/Metadata/GraphQl/DeleteMutation.php b/src/Metadata/GraphQl/DeleteMutation.php
@@ -16,7 +16,7 @@
 use ApiPlatform\Metadata\DeleteOperationInterface;
 
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
-class DeleteMutation extends Operation implements DeleteOperationInterface
+class DeleteMutation extends Mutation implements DeleteOperationInterface
 {
     /**
      * {@inheritdoc}
@@ -68,8 +68,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
 ) {
         parent::__construct(...\func_get_args());
diff --git a/src/Metadata/GraphQl/Mutation.php b/src/Metadata/GraphQl/Mutation.php
@@ -66,8 +66,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(...\func_get_args());
diff --git a/src/Metadata/GraphQl/Query.php b/src/Metadata/GraphQl/Query.php
@@ -66,8 +66,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(...\func_get_args());
diff --git a/src/Metadata/GraphQl/QueryCollection.php b/src/Metadata/GraphQl/QueryCollection.php
@@ -68,8 +68,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(...\func_get_args());
diff --git a/src/Metadata/GraphQl/Subscription.php b/src/Metadata/GraphQl/Subscription.php
@@ -66,8 +66,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(...\func_get_args());
diff --git a/src/Metadata/HttpOperation.php b/src/Metadata/HttpOperation.php
@@ -117,6 +117,8 @@ class HttpOperation extends Operation
      * @param bool|null         $validate                       https://api-platform.com/docs/core/events/#the-event-system
      * @param bool|null         $write                          https://api-platform.com/docs/core/events/#the-event-system
      * @param bool|null         $serialize                      https://api-platform.com/docs/core/events/#the-event-system
+     * @param mixed|null        $provider
+     * @param mixed|null        $processor
      */
     public function __construct(
         string $method = self::METHOD_GET,
@@ -189,8 +191,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         $this->method = $method;
diff --git a/src/Metadata/Patch.php b/src/Metadata/Patch.php
@@ -89,8 +89,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(self::METHOD_PATCH, ...\func_get_args());
diff --git a/src/Metadata/Post.php b/src/Metadata/Post.php
@@ -89,8 +89,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(self::METHOD_POST, ...\func_get_args());
diff --git a/src/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php b/src/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php
@@ -87,11 +87,6 @@ public function create(string $resourceClass, string $property, array $options =
             $apiProperty = $this->withDeprecatedAttributes($apiProperty, $propertyMetadata['attributes']);
         }
 
-        if (isset($propertyMetadata['iri'])) {
-            trigger_deprecation('api-platform', '2.7', 'Using "iri" is deprecated, use "types" instead.');
-            $apiProperty = $apiProperty->withTypes([$propertyMetadata['iri']]);
-        }
-
         return $apiProperty;
     }
 
@@ -136,11 +131,6 @@ private function update(ApiProperty $propertyMetadata, array $metadata): ApiProp
             $propertyMetadata = $this->withDeprecatedAttributes($propertyMetadata, $metadata['attributes']);
         }
 
-        if (isset($metadata['iri'])) {
-            trigger_deprecation('api-platform', '2.7', 'Using "iri" is deprecated, use "types" instead.');
-            $propertyMetadata = $propertyMetadata->withTypes([$metadata['iri']]);
-        }
-
         return $propertyMetadata;
     }
 }
diff --git a/src/Metadata/Put.php b/src/Metadata/Put.php
@@ -89,8 +89,8 @@ public function __construct(
         ?bool $forceEager = null,
         ?int $priority = null,
         ?string $name = null,
-        ?string $provider = null,
-        ?string $processor = null,
+        $provider = null,
+        $processor = null,
         array $extraProperties = []
     ) {
         parent::__construct(self::METHOD_PUT, ...\func_get_args());
diff --git a/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php b/src/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactory.php
@@ -20,6 +20,7 @@
 use ApiPlatform\Metadata\Delete;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\GraphQl\DeleteMutation;
 use ApiPlatform\Metadata\GraphQl\Mutation;
 use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
 use ApiPlatform\Metadata\GraphQl\Query;
@@ -207,10 +208,6 @@ private function getOperationWithDefaults(ApiResource $resource, $operation): ar
                 $operation = $operation->withDescription(ucfirst("{$operation->getName()}s a {$resource->getShortName()}."));
             }
 
-            // if ('delete' === $operation->getName()) {
-            //     $operation = $operation->withDelete(true);
-            // }
-
             return [$operation->getName(), $operation];
         }
 
@@ -293,7 +290,7 @@ private function hasSameOperation(ApiResource $resource, string $operationClass,
     private function addDefaultGraphQlOperations(ApiResource $resource): ApiResource
     {
         $graphQlOperations = [];
-        foreach ([new QueryCollection(), new Query(), (new Mutation())->withName('update'), (new Mutation())->withName('delete'), (new Mutation())->withName('create')] as $i => $operation) {
+        foreach ([new QueryCollection(), new Query(), (new Mutation())->withName('update'), (new DeleteMutation())->withName('delete'), (new Mutation())->withName('create')] as $i => $operation) {
             [$key, $operation] = $this->getOperationWithDefaults($resource, $operation);
             $graphQlOperations[$key] = $operation;
         }
diff --git a/tests/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactoryTest.php b/tests/Metadata/Resource/Factory/AttributesResourceMetadataCollectionFactoryTest.php
@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\Delete;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\GraphQl\DeleteMutation;
 use ApiPlatform\Metadata\GraphQl\Mutation;
 use ApiPlatform\Metadata\GraphQl\Query;
 use ApiPlatform\Metadata\GraphQl\QueryCollection;
@@ -30,6 +31,8 @@
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\AttributeDefaultOperations;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\AttributeResource;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\AttributeResources;
+use ApiPlatform\Tests\Fixtures\TestBundle\State\AttributeResourceProcessor;
+use ApiPlatform\Tests\Fixtures\TestBundle\State\AttributeResourceProvider;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -39,14 +42,14 @@ class AttributesResourceMetadataCollectionFactoryTest extends TestCase
 {
     use ProphecyTrait;
 
-    private function getDefaultGraphqlOperations(string $shortName, string $class): array
+    private function getDefaultGraphqlOperations(string $shortName, string $class, mixed $provider = null): array
     {
         return [
-            'collection_query' => new QueryCollection(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true]),
-            'item_query' => new Query(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true]),
-            'update' => new Mutation(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], name: 'update', description: "Updates a $shortName."),
-            'delete' => new Mutation(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], delete: true, name: 'delete', description: "Deletes a $shortName."),
-            'create' => new Mutation(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], name: 'create', description: "Creates a $shortName."),
+            'collection_query' => new QueryCollection(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], provider: $provider),
+            'item_query' => new Query(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], provider: $provider),
+            'update' => new Mutation(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], name: 'update', description: "Updates a $shortName.", provider: $provider),
+            'delete' => new DeleteMutation(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], name: 'delete', description: "Deletes a $shortName.", provider: $provider),
+            'create' => new Mutation(shortName: $shortName, class: $class, normalizationContext: ['skip_null_values' => true], name: 'create', description: "Creates a $shortName.", provider: $provider),
         ];
     }
 
@@ -60,18 +63,19 @@ public function testCreate(): void
                     shortName: 'AttributeResource',
                     normalizationContext: ['skip_null_values' => true],
                     class: AttributeResource::class,
+                    provider: AttributeResourceProvider::class,
                     operations: [
                         '_api_AttributeResource_get' => new Get(
-                            shortName: 'AttributeResource', class: AttributeResource::class, normalizationContext: ['skip_null_values' => true], priority: 1
+                            shortName: 'AttributeResource', class: AttributeResource::class, normalizationContext: ['skip_null_values' => true], priority: 1, provider: AttributeResourceProvider::class,
                         ),
                         '_api_AttributeResource_put' => new Put(
-                            shortName: 'AttributeResource', class: AttributeResource::class, normalizationContext: ['skip_null_values' => true], priority: 2
+                            shortName: 'AttributeResource', class: AttributeResource::class, normalizationContext: ['skip_null_values' => true], priority: 2, provider: AttributeResourceProvider::class,
                         ),
                         '_api_AttributeResource_delete' => new Delete(
-                            shortName: 'AttributeResource', class: AttributeResource::class, normalizationContext: ['skip_null_values' => true], priority: 3
+                            shortName: 'AttributeResource', class: AttributeResource::class, normalizationContext: ['skip_null_values' => true], priority: 3, provider: AttributeResourceProvider::class,
                         ),
                     ],
-                    graphQlOperations: $this->getDefaultGraphqlOperations('AttributeResource', AttributeResource::class)
+                    graphQlOperations: $this->getDefaultGraphqlOperations('AttributeResource', AttributeResource::class, AttributeResourceProvider::class)
                 ),
                 new ApiResource(
                     shortName: 'AttributeResource',
@@ -84,19 +88,25 @@ class: AttributeResource::class,
                             shortName: 'AttributeResource',
                             inputFormats: ['json' => ['application/merge-patch+json']],
                             priority: 4,
-                            status: 301
+                            status: 301,
+                            provider: AttributeResourceProvider::class,
+                            processor: [AttributeResourceProcessor::class, 'process']
                         ),
                         '_api_/dummy/{dummyId}/attribute_resources/{identifier}.{_format}_patch' => new Patch(
                             class: AttributeResource::class,
                             uriTemplate: '/dummy/{dummyId}/attribute_resources/{identifier}.{_format}',
                             shortName: 'AttributeResource',
                             inputFormats: ['json' => ['application/merge-patch+json']],
                             priority: 5,
-                            status: 301
+                            status: 301,
+                            provider: AttributeResourceProvider::class,
+                            processor: [AttributeResourceProcessor::class, 'process']
                         ),
                     ],
                     inputFormats: ['json' => ['application/merge-patch+json']],
-                    status: 301
+                    status: 301,
+                    provider: AttributeResourceProvider::class,
+                    processor: [AttributeResourceProcessor::class, 'process']
                 ),
             ]),
             $attributeResourceMetadataCollectionFactory->create(AttributeResource::class)
@@ -109,15 +119,16 @@ class: AttributeResource::class,
                     shortName: 'AttributeResources',
                     normalizationContext: ['skip_null_values' => true],
                     class: AttributeResources::class,
+                    provider: AttributeResourceProvider::class,
                     operations: [
                         '_api_/attribute_resources.{_format}_get_collection' => new GetCollection(
-                            shortName: 'AttributeResources', class: AttributeResources::class, uriTemplate: '/attribute_resources.{_format}', normalizationContext: ['skip_null_values' => true], priority: 1
+                            shortName: 'AttributeResources', class: AttributeResources::class, uriTemplate: '/attribute_resources.{_format}', normalizationContext: ['skip_null_values' => true], priority: 1, provider: AttributeResourceProvider::class,
                         ),
                         '_api_/attribute_resources.{_format}_post' => new Post(
-                            shortName: 'AttributeResources', class: AttributeResources::class, uriTemplate: '/attribute_resources.{_format}', normalizationContext: ['skip_null_values' => true], priority: 2
+                            shortName: 'AttributeResources', class: AttributeResources::class, uriTemplate: '/attribute_resources.{_format}', normalizationContext: ['skip_null_values' => true], priority: 2, provider: AttributeResourceProvider::class,
                         ),
                     ],
-                    graphQlOperations: $this->getDefaultGraphqlOperations('AttributeResources', AttributeResources::class)
+                    graphQlOperations: $this->getDefaultGraphqlOperations('AttributeResources', AttributeResources::class, AttributeResourceProvider::class)
                 ),
             ]),
             $attributeResourceMetadataCollectionFactory->create(AttributeResources::class)
@@ -128,7 +139,7 @@ public function testCreateWithDefaults(): void
     {
         $attributeResourceMetadataCollectionFactory = new AttributesResourceMetadataCollectionFactory(null, null, ['attributes' => ['cache_headers' => ['max_age' => 60], 'non_existing_attribute' => 'foo']]);
 
-        $operation = new HttpOperation(shortName: 'AttributeDefaultOperations', class: AttributeDefaultOperations::class, collection: false, cacheHeaders: ['max_age' => 60], paginationItemsPerPage: 10);
+        $operation = new HttpOperation(shortName: 'AttributeDefaultOperations', class: AttributeDefaultOperations::class, cacheHeaders: ['max_age' => 60], paginationItemsPerPage: 10);
         $this->assertEquals(new ResourceMetadataCollection(AttributeDefaultOperations::class, [
             new ApiResource(
                 shortName: 'AttributeDefaultOperations',
diff --git a/tests/Metadata/Resource/Factory/LinkFactoryTest.php b/tests/Metadata/Resource/Factory/LinkFactoryTest.php
@@ -54,7 +54,7 @@ public function testCreateLinksFromIdentifiers(array $propertyNames, bool $compo
 
         self::assertEquals(
             $expectedLinks,
-            $linkFactory->createLinksFromIdentifiers((new Get())->withClass(AttributeResource::class)->withCompositeIdentifier($compositeIdentifier))
+            $linkFactory->createLinksFromIdentifiers((new Get())->withClass(AttributeResource::class))
         );
     }
 
diff --git a/tests/Metadata/Resource/Factory/UriTemplateResourceMetadataCollectionFactoryTest.php b/tests/Metadata/Resource/Factory/UriTemplateResourceMetadataCollectionFactoryTest.php
