Add XML and YAML support for new Resource attribute (api-platform#4382)

* feat: add XML and YAML support for new Resource attribute

* feat: add unit tests

* feat: add Metadata compatibility tests

* feat: support properties out of resources

* fix: service inheritance

* fix: schema

* fix: a function cannot provide a Generator and an object|null

* chore: do not load yaml/xml ORM resources on ODM

* fix: CI

* fix: rollback securityPostValidation on Operation (should be handler in another PR)

* fix: mongodb tests

* fix: fix ApiLoader legacy operationName

* fix: schema validator

* fix: graphql BC layer

* fix: hal behat scenarios

* fix: ignore tests/Core/Behat contexts from PHPStan analysis

* fix tests

* fix: BC layer Behat tests

* fix: yaml services decoration

* fix: revert change that broke everything

* fix: phpunit tests

* fix: read legacy identifiers from properties

* feat: move Extractor functions to trait

* fix: Behat coverage

* fix: coveralls

Co-authored-by: soyuka <[email protected]>

Author: vincentchalamon

.github/workflows/ci.yml

@@ -138,12 +138,12 @@ jobs:
         run: |
           composer remove --dev --no-interaction --no-progress --no-update --ansi \
             doctrine/mongodb-odm \
-            doctrine/mongodb-odm-bundle \
+            doctrine/mongodb-odm-bundle
       - name: Remove ElasticSearch
         if: startsWith(matrix.php, '7.1') || startsWith(matrix.php, '7.2')
         run: |
           composer remove --dev --no-interaction --no-progress --no-update --ansi \
-            elasticsearch/elasticsearch \
+            elasticsearch/elasticsearch
       - name: Update project dependencies
         run: composer update --no-interaction --no-progress --ansi
       - name: Require Symfony components
@@ -181,9 +181,9 @@ jobs:
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          composer global require --prefer-dist --no-interaction --no-progress --ansi cedx/coveralls
+          composer global require --prefer-dist --no-interaction --no-progress --ansi php-coveralls/php-coveralls
           export PATH="$PATH:$HOME/.composer/vendor/bin"
-          coveralls build/logs/phpunit/clover.xml
+          php-coveralls --coverage_clover=build/logs/phpunit/clover.xml
         continue-on-error: true
 
   behat:
@@ -231,12 +231,12 @@ jobs:
         run: |
           composer remove --dev --no-interaction --no-progress --no-update --ansi \
             doctrine/mongodb-odm \
-            doctrine/mongodb-odm-bundle \
+            doctrine/mongodb-odm-bundle
       - name: Remove ElasticSearch
         if: startsWith(matrix.php, '7.1') || startsWith(matrix.php, '7.2')
         run: |
           composer remove --dev --no-interaction --no-progress --no-update --ansi \
-            elasticsearch/elasticsearch \
+            elasticsearch/elasticsearch
       - name: Update project dependencies
         run: composer update --no-interaction --no-progress --ansi
       - name: Require Symfony components
@@ -250,7 +250,7 @@ jobs:
       - name: Clear test app cache (php 8.0)
         if: (startsWith(matrix.php, '8.'))
         run: rm -Rf tests/Fixtures/app/var/cache/*
-      - name: Run Behat tests
+      - name: Run Behat tests (PHP < 8)
         if: (!startsWith(matrix.php, '8.'))
         run: |
           mkdir -p build/logs/behat
@@ -263,7 +263,7 @@ jobs:
               vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction --tags='~@php8'
             fi
           fi
-      - name: Run Behat tests
+      - name: Run Behat tests (PHP 8)
         if: (startsWith(matrix.php, '8.'))
         run: |
           mkdir -p build/logs/behat
@@ -300,9 +300,9 @@ jobs:
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          composer global require --prefer-dist --no-interaction --no-progress --ansi cedx/coveralls
+          composer global require --prefer-dist --no-interaction --no-progress --ansi php-coveralls/php-coveralls
           export PATH="$PATH:$HOME/.composer/vendor/bin"
-          coveralls build/logs/behat/clover.xml
+          php-coveralls --coverage_clover=build/logs/behat/clover.xml
         continue-on-error: true
       - name: Export OpenAPI documents
         run: |
@@ -593,9 +593,9 @@ jobs:
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          composer global require --prefer-dist --no-interaction --no-progress --ansi cedx/coveralls
+          composer global require --prefer-dist --no-interaction --no-progress --ansi php-coveralls/php-coveralls
           export PATH="$PATH:$HOME/.composer/vendor/bin"
-          coveralls build/logs/behat/clover.xml
+          php-coveralls --coverage_clover=build/logs/behat/clover.xml
         continue-on-error: true
 
   elasticsearch:
@@ -1117,8 +1117,8 @@ jobs:
       - name: Run Behat tests
         run: |
           mkdir -p build/logs/behat
-          vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction --tags='~@php8'
-      - name: Run Behat tests
+          vendor/bin/behat --out=std --format=progress --format=junit --out=build/logs/behat/junit --profile=default --no-interaction --tags='~@php8' --tags='~@v3'
+      - name: Run Behat tests (PHP 8)
         if: (startsWith(matrix.php, '8.'))
         run: |
           mkdir -p build/logs/behat

.gitignore

@@ -11,5 +11,7 @@
 /swagger.yaml
 /tests/Fixtures/app/var/
 /tests/Fixtures/app/public/bundles/
+/tests/Metadata/Extractor/Adapter/*.xml
+/tests/Metadata/Extractor/Adapter/*.yaml
 /vendor/
 /Dockerfile

behat.yml.dist

@@ -142,4 +142,3 @@ elasticsearch-coverage:
         - 'ApiPlatform\Core\Tests\Behat\CoverageContext'
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'behatch:context:rest'
-

features/main/crud.feature

@@ -1,3 +1,4 @@
+# todo remove @v3 tag in 3.0
 Feature: Create-Retrieve-Update-Delete
   In order to use an hypermedia API
   As a client software developer
@@ -649,3 +650,129 @@ Feature: Create-Retrieve-Update-Delete
           "foo": "bar"
       }
     """
+
+  @v3
+  Scenario: Get a resource in v3 configured in YAML
+    Given there is a Program
+    When I send a "GET" request to "/programs/1"
+    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 equal to:
+    """
+    {
+      "@context": "/contexts/Program",
+      "@id": "/programs/1",
+      "@type": "Program",
+      "id": 1,
+      "name": "Lorem ipsum 1",
+      "date": "2015-03-01T10:00:00+00:00",
+      "author": "/users/1"
+    }
+    """
+
+  @v3
+  Scenario: Get a collection resource in v3 configured in YAML
+    Given there are 3 Programs
+    When I send a "GET" request to "/users/1/programs"
+    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 equal to:
+    """
+    {
+      "@context": "/contexts/Program",
+      "@id": "/users/1/programs",
+      "@type": "hydra:Collection",
+      "hydra:member": [
+        {
+          "@id": "/programs/1",
+          "@type": "Program",
+          "id": 1,
+          "name": "Lorem ipsum 1",
+          "date": "2015-03-01T10:00:00+00:00",
+          "author": "/users/1"
+        },
+        {
+          "@id": "/programs/2",
+          "@type": "Program",
+          "id": 2,
+          "name": "Lorem ipsum 2",
+          "date": "2015-03-02T10:00:00+00:00",
+          "author": "/users/1"
+        },
+        {
+          "@id": "/programs/3",
+          "@type": "Program",
+          "id": 3,
+          "name": "Lorem ipsum 3",
+          "date": "2015-03-03T10:00:00+00:00",
+          "author": "/users/1"
+        }
+      ],
+      "hydra:totalItems": 3
+    }
+    """
+
+  @v3
+  Scenario: Get a resource in v3 configured in XML
+    Given there is a Comment
+    When I send a "GET" request to "/comments/1"
+    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 equal to:
+    """
+    {
+      "@context": "/contexts/Comment",
+      "@id": "/comments/1",
+      "@type": "Comment",
+      "id": 1,
+      "comment": "Lorem ipsum dolor sit amet 1",
+      "date": "2015-03-01T10:00:00+00:00",
+      "author": "/users/1"
+    }
+    """
+
+  @v3
+  Scenario: Get a collection resource in v3 configured in XML
+    Given there are 3 Comments
+    When I send a "GET" request to "/users/1/comments"
+    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 equal to:
+    """
+    {
+      "@context": "/contexts/Comment",
+      "@id": "/users/1/comments",
+      "@type": "hydra:Collection",
+      "hydra:member": [
+        {
+          "@id": "/comments/1",
+          "@type": "Comment",
+          "id": 1,
+          "comment": "Lorem ipsum dolor sit amet 1",
+          "date": "2015-03-01T10:00:00+00:00",
+          "author": "/users/1"
+        },
+        {
+          "@id": "/comments/2",
+          "@type": "Comment",
+          "id": 2,
+          "comment": "Lorem ipsum dolor sit amet 2",
+          "date": "2015-03-02T10:00:00+00:00",
+          "author": "/users/1"
+        },
+        {
+          "@id": "/comments/3",
+          "@type": "Comment",
+          "id": 3,
+          "comment": "Lorem ipsum dolor sit amet 3",
+          "date": "2015-03-03T10:00:00+00:00",
+          "author": "/users/1"
+        }
+      ],
+      "hydra:totalItems": 3
+    }
+    """

features/main/table_inheritance.feature

@@ -445,7 +445,7 @@ Feature: Table inheritance
     }
     """
 
-   Scenario: Get the parent interface collection
+  Scenario: Get the parent interface collection
     When I send a "GET" request to "/resource_interfaces"
     Then the response status code should be 200
     And the response should be in JSON

phpstan.neon.dist

@@ -38,6 +38,7 @@ parameters:
 		- tests/Symfony/Bundle/Test/WebTestCaseTest.php
 		- tests/Core/ProphecyTrait.php
 		- tests/Core/Behat/CoverageContext.php
+		- tests/Core/Behat/DoctrineContext.php
 		- tests/Fixtures/TestBundle/Security/AbstractSecurityUser.php
 		# Templates for Maker
 		- src/Core/Bridge/Symfony/Maker/Resources/skeleton

src/Core/Bridge/Symfony/Routing/RouteNameGenerator.php

@@ -46,13 +46,19 @@ public static function generate(string $operationName, string $resourceShortName
             throw new InvalidArgumentException('Subresource operations are not supported by the RouteNameGenerator.');
         }
 
-        return sprintf(
-            '%s%s_%s_%s',
+        $operationName = sprintf(
+            '%s%s_%s',
             static::ROUTE_NAME_PREFIX,
             self::inflector($resourceShortName),
-            $operationName,
-            $operationType
+            $operationName
         );
+
+        // prevent api_foo_get_collection_collection
+        if ("_$operationType" !== substr($operationName, -\strlen("_$operationType"))) {
+            $operationName .= "_$operationType";
+        }
+
+        return $operationName;
     }
 
     /**

src/Core/Metadata/Extractor/XmlExtractor.php

@@ -14,6 +14,8 @@
 namespace ApiPlatform\Core\Metadata\Extractor;
 
 use ApiPlatform\Exception\InvalidArgumentException;
+use ApiPlatform\Metadata\Extractor\AbstractResourceExtractor;
+use ApiPlatform\Metadata\Extractor\PropertyExtractorInterface;
 use Symfony\Component\Config\Util\XmlUtils;
 
 /**
@@ -22,11 +24,33 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Antoine Bluchet <[email protected]>
  * @author Baptiste Meyer <[email protected]>
+ * @author Vincent Chalamon <[email protected]>
+ *
+ * @deprecated since 2.7, to remove in 3.0 (replaced by ApiPlatform\Metadata\Extractor\XmlExtractor)
  */
-final class XmlExtractor extends AbstractExtractor
+final class XmlExtractor extends AbstractResourceExtractor implements PropertyExtractorInterface
 {
     public const RESOURCE_SCHEMA = __DIR__.'/../schema/metadata.xsd';
 
+    private $properties;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getProperties(): array
+    {
+        if (null !== $this->properties) {
+            return $this->properties;
+        }
+
+        $this->properties = [];
+        foreach ($this->paths as $path) {
+            $this->extractPath($path);
+        }
+
+        return $this->properties;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -46,23 +70,24 @@ protected function extractPath(string $path)
                 'shortName' => $this->phpizeAttribute($resource, 'shortName', 'string'),
                 'description' => $this->phpizeAttribute($resource, 'description', 'string'),
                 'iri' => $this->phpizeAttribute($resource, 'iri', 'string'),
-                'itemOperations' => $this->getOperations($resource, 'itemOperation'),
-                'collectionOperations' => $this->getOperations($resource, 'collectionOperation'),
-                'subresourceOperations' => $this->getOperations($resource, 'subresourceOperation'),
-                'graphql' => $this->getOperations($resource, 'operation'),
-                'attributes' => $this->getAttributes($resource, 'attribute') ?: null,
-                'properties' => $this->getProperties($resource) ?: null,
+                'itemOperations' => $this->extractOperations($resource, 'itemOperation'),
+                'collectionOperations' => $this->extractOperations($resource, 'collectionOperation'),
+                'subresourceOperations' => $this->extractOperations($resource, 'subresourceOperation'),
+                'graphql' => $this->extractOperations($resource, 'operation'),
+                'attributes' => $this->extractAttributes($resource, 'attribute') ?: null,
+                'properties' => $this->extractProperties($resource) ?: null,
             ];
+            $this->properties[$resourceClass] = $this->resources[$resourceClass]['properties'];
         }
     }
 
     /**
      * Returns the array containing configured operations. Returns NULL if there is no operation configuration.
      */
-    private function getOperations(\SimpleXMLElement $resource, string $operationType): ?array
+    private function extractOperations(\SimpleXMLElement $resource, string $operationType): ?array
     {
         $graphql = 'operation' === $operationType;
-        if (!$graphql && $legacyOperations = $this->getAttributes($resource, $operationType)) {
+        if (!$graphql && $legacyOperations = $this->extractAttributes($resource, $operationType)) {
             @trigger_error(
                 sprintf('Configuring "%1$s" tags without using a parent "%1$ss" tag is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3', $operationType),
                 \E_USER_DEPRECATED
@@ -76,17 +101,17 @@ private function getOperations(\SimpleXMLElement $resource, string $operationTyp
             return null;
         }
 
-        return $this->getAttributes($resource->{$operationsParent}, $operationType, true);
+        return $this->extractAttributes($resource->{$operationsParent}, $operationType, true);
     }
 
     /**
      * Recursively transforms an attribute structure into an associative array.
      */
-    private function getAttributes(\SimpleXMLElement $resource, string $elementName, bool $topLevel = false): array
+    private function extractAttributes(\SimpleXMLElement $resource, string $elementName, bool $topLevel = false): array
     {
         $attributes = [];
         foreach ($resource->{$elementName} as $attribute) {
-            $value = isset($attribute->attribute[0]) ? $this->getAttributes($attribute, 'attribute') : $this->phpizeContent($attribute);
+            $value = isset($attribute->attribute[0]) ? $this->extractAttributes($attribute, 'attribute') : $this->phpizeContent($attribute);
             // allow empty operations definition, like <collectionOperation name="post" />
             if ($topLevel && '' === $value) {
                 $value = [];
@@ -104,7 +129,7 @@ private function getAttributes(\SimpleXMLElement $resource, string $elementName,
     /**
      * Gets metadata of a property.
      */
-    private function getProperties(\SimpleXMLElement $resource): array
+    private function extractProperties(\SimpleXMLElement $resource): array
     {
         $properties = [];
         foreach ($resource->property as $property) {
@@ -117,7 +142,7 @@ private function getProperties(\SimpleXMLElement $resource): array
                 'required' => $this->phpizeAttribute($property, 'required', 'bool'),
                 'identifier' => $this->phpizeAttribute($property, 'identifier', 'bool'),
                 'iri' => $this->phpizeAttribute($property, 'iri', 'string'),
-                'attributes' => $this->getAttributes($property, 'attribute'),
+                'attributes' => $this->extractAttributes($property, 'attribute'),
                 'subresource' => $property->subresource ? [
                     'collection' => $this->phpizeAttribute($property->subresource, 'collection', 'bool'),
                     'resourceClass' => $this->resolve($this->phpizeAttribute($property->subresource, 'resourceClass', 'string')),