Merge pull request #4057 from alanpoulain/merge-2.6

Merge 2.6

.github/workflows/ci.yml

@@ -522,8 +522,8 @@ jobs:
       - name: Update project dependencies
         run: |
           composer update --no-interaction --no-progress --ansi
-      # - name: Require Symfony Uid
-      #   run: composer require symfony/uid --dev --no-interaction --no-progress --ansi
+      - name: Require Symfony Uid
+        run: composer require symfony/uid --dev --no-interaction --no-progress --ansi
       - name: Install PHPUnit
         run: vendor/bin/simple-phpunit --version
       - name: Clear test app cache
@@ -762,6 +762,7 @@ jobs:
       matrix:
         php:
           - '7.4'
+          - '8.0'
       fail-fast: false
     env:
       APP_ENV: sqlite
@@ -786,10 +787,14 @@ jobs:
           path: ${{ steps.composercache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
+      - name: Set Composer platform config
+        if: (startsWith(matrix.php, '8.0'))
+        run: |
+            composer config platform.php 7.4.99
       - name: Update project dependencies
-        run: composer update --no-interaction --no-progress --ansi --ignore-platform-reqs
+        run: composer update --no-interaction --no-progress --ansi
       - name: Require Symfony Uid
-        run: composer require symfony/uid --dev --no-interaction --no-progress --ansi --ignore-platform-reqs
+        run: composer require symfony/uid --dev --no-interaction --no-progress --ansi
       - name: Install phpunit
         run: vendor/bin/simple-phpunit --version
       - name: Clear test app cache
@@ -805,6 +810,7 @@ jobs:
       matrix:
         php:
           - '7.4'
+          - '8.0'
       fail-fast: false
     env:
       APP_ENV: sqlite
@@ -829,10 +835,14 @@ jobs:
           path: ${{ steps.composercache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
+      - name: Set Composer platform config
+        if: (startsWith(matrix.php, '8.0'))
+        run: |
+            composer config platform.php 7.4.99
       - name: Update project dependencies
-        run: composer update --no-interaction --no-progress --ansi --ignore-platform-reqs
+        run: composer update --no-interaction --no-progress --ansi
       - name: Require Symfony Uid
-        run: composer require symfony/uid --dev --no-interaction --no-progress --ansi --ignore-platform-reqs
+        run: composer require symfony/uid --dev --no-interaction --no-progress --ansi
       - name: Install phpunit
         run: vendor/bin/simple-phpunit --version
       - name: Clear test app cache

CHANGELOG.md

@@ -4,6 +4,21 @@
 
 * MongoDB: `date_immutable` support (#3940)
 
+## 2.6.3
+
+* Mercure: Do not use data in options when deleting (#4056)
+
+## 2.6.2
+
+* Validation: properties regex pattern is now compliant with ECMA 262 (#4027)
+* OpenApi: normalizer is now backward compatible (#4016), fix the name converter issue changing OpenApi properties (#4019)
+* Identifiers: Break after transforming the identifier (#3985), use the identifiers context to transform with multiple classes (#4029)
+* JsonSchema: Revert `ALLOW_EXTRA_ATTRIBUTE=false` as it is a BC break and will be done in 3.0 instead see #3881 (#4007)
+* Subresource: fix ApiSubresource maxDepth option (#3986), recursive issue in the profiler (#4023)
+* OpenApi: Allow `requestBody` and `parameters` via the `openapi_context` (#4001), make `openapi_context` work on subresources (#4004), sort paths (#4013)
+* Config: Allow disabling OpenAPI and Swagger UI without loosing the schema (#3968 and #4018), fix pagination defaults (#4011)
+* DataPersister: context propagation fix (#3983)
+
 ## 2.6.1
 
 * Fix defaults when using attributes (#3978)

features/hydra/collection.feature

@@ -203,9 +203,13 @@ Feature: Collections support
             "hydra:next": {"pattern": "^/dummies\\?partial=1&page=8$"},
             "hydra:previous": {"pattern": "^/dummies\\?partial=1&page=6$"}
           },
-          "additionalProperties": false
+          "required": ["@id", "@type", "hydra:next", "hydra:previous"],
+          "additionalProperties": false,
+          "maxProperties": 4
         }
-      }
+      },
+      "required": ["@context", "@id", "@type", "hydra:member", "hydra:view", "hydra:search"],
+      "maxProperties": 6
     }
     """
 
@@ -275,16 +279,16 @@ Feature: Collections support
     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:
-  """
-  {
-    "@id":"/dummies?page=3",
-    "@type":"hydra:PartialCollectionView",
-    "hydra:first":"/dummies?page=1",
-    "hydra:last":"/dummies?page=10",
-    "hydra:previous":"/dummies?page=2",
-    "hydra:next":"/dummies?page=4"
-  }
-  """
+    """
+    {
+      "@id":"/dummies?page=3",
+      "@type":"hydra:PartialCollectionView",
+      "hydra:first":"/dummies?page=1",
+      "hydra:last":"/dummies?page=10",
+      "hydra:previous":"/dummies?page=2",
+      "hydra:next":"/dummies?page=4"
+    }
+    """
   Scenario: Filter with exact match
     When I send a "GET" request to "/dummies?id=8"
     Then the response status code should be 200

features/jsonapi/related-resouces-inclusion.feature

@@ -602,7 +602,7 @@ Feature: JSON API Inclusion of Related Resources
     Then the response status code should be 200
     And the response should be in JSON
     And the JSON should be valid according to the JSON API schema
-    And the JSON should be equal to:
+    And the JSON should be a superset of:
     """
     {
         "links": {

phpstan.neon.dist

@@ -92,7 +92,7 @@ parameters:
 		# Expected, due to PHP 8 attributes
 		- '#ReflectionProperty::getAttributes\(\)#'
 		- '#ReflectionMethod::getAttributes\(\)#'
-		- '#ReflectionClass<mixed>::getAttributes\(\)#'
+		- '#ReflectionClass<object>::getAttributes\(\)#'
 		- '#Constructor of class ApiPlatform\\Core\\Annotation\\ApiResource has an unused parameter#'
 		- '#Constructor of class ApiPlatform\\Core\\Annotation\\ApiProperty has an unused parameter#'
 
@@ -118,9 +118,3 @@ parameters:
 		-
 			message: "#Call to function method_exists\\(\\) with ApiPlatform\\\\Core\\\\JsonApi\\\\Serializer\\\\ItemNormalizer and 'setCircularReferenc…' will always evaluate to false\\.#"
 			path: tests/JsonApi/Serializer/ItemNormalizerTest.php
-		# Waiting to be fixed by https://github.com/Roave/BetterReflection/issues/663
-		-
-			message: '#Call to private method getNestedFieldPath\(\) of class ApiPlatform\\Core\\Bridge\\Elasticsearch\\DataProvider\\Filter\\AbstractFilter\.#'
-			paths:
-				- src/Bridge/Elasticsearch/DataProvider/Filter/OrderFilter.php
-				- src/Bridge/Elasticsearch/DataProvider/Filter/AbstractSearchFilter.php

src/Annotation/ApiResource.php

@@ -148,7 +148,7 @@ final class ApiResource
      * @param bool|array   $mercure                        https://api-platform.com/docs/core/mercure
      * @param bool         $messenger                      https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus
      * @param array        $normalizationContext           https://api-platform.com/docs/core/serialization/#using-serialization-groups
-     * @param array        $openapiContext                 https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
+     * @param array        $openapiContext                 https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
      * @param array        $order                          https://api-platform.com/docs/core/default-order/#overriding-default-order
      * @param string|false $output                         https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
      * @param bool         $paginationClientEnabled        https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1
@@ -167,7 +167,7 @@ final class ApiResource
      * @param string       $securityPostDenormalizeMessage https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
      * @param bool         $stateless
      * @param string       $sunset                         https://api-platform.com/docs/core/deprecations/#setting-the-sunset-http-header-to-indicate-when-a-resource-or-an-operation-will-be-removed
-     * @param array        $swaggerContext                 https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
+     * @param array        $swaggerContext                 https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
      * @param array        $validationGroups               https://api-platform.com/docs/core/validation/#using-validation-groups
      * @param int          $urlGenerationStrategy
      *

src/Annotation/ApiSubresource.php

@@ -20,6 +20,9 @@
  *
  * @Annotation
  * @Target({"METHOD", "PROPERTY"})
+ * @Attributes(
+ *     @Attribute("maxDepth", type="int"),
+ * )
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD)]
 final class ApiSubresource
@@ -36,6 +39,8 @@ public function __construct($maxDepth = null)
     {
         if (!\is_array($maxDepth)) { // @phpstan-ignore-line
             $this->maxDepth = $maxDepth;
+        } else {
+            $this->maxDepth = $maxDepth['maxDepth'] ?? null;
         }
     }
 }

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -213,7 +213,7 @@ private function publishUpdate($object, array $options, string $type): void
             // and I'm not a fond of this approach.
             $iri = $options['topics'] ?? $object->iri;
             /** @var string $data */
-            $data = $options['data'] ?? json_encode(['@id' => $object->id]);
+            $data = json_encode(['@id' => $object->id]);
         } else {
             $resourceClass = $this->getObjectClass($object);
             $context = $options['normalization_context'] ?? $this->resourceMetadataFactory->create($resourceClass)->getAttribute('normalization_context', []);

src/Bridge/Symfony/Bundle/DataCollector/RequestDataCollector.php

@@ -72,15 +72,20 @@ public function collect(Request $request, Response $response, \Throwable $except
             ++$counters['ignored_filters'];
         }
 
+        $requestAttributes = RequestAttributesExtractor::extractAttributes($request);
+        if (isset($requestAttributes['previous_data'])) {
+            $requestAttributes['previous_data'] = $this->cloneVar($requestAttributes['previous_data']);
+        }
+
         $this->data = [
             'resource_class' => $resourceClass,
             'resource_metadata' => $resourceMetadata ? $this->cloneVar($resourceMetadata) : null,
             'acceptable_content_types' => $request->getAcceptableContentTypes(),
-            'request_attributes' => RequestAttributesExtractor::extractAttributes($request),
             'filters' => $filters,
             'counters' => $counters,
             'dataProviders' => [],
             'dataPersisters' => ['responses' => []],
+            'request_attributes' => $requestAttributes,
         ];
 
         if ($this->collectionDataProvider instanceof TraceableChainCollectionDataProvider) {

src/Bridge/Symfony/Bundle/DataPersister/TraceableChainDataPersister.php

@@ -73,7 +73,7 @@ private function tracePersisters($data, array $context = [])
         $found = false;
         foreach ($this->persisters as $persister) {
             if (
-                ($this->persistersResponse[\get_class($persister)] = $found ? false : $persister->supports($data))
+                ($this->persistersResponse[\get_class($persister)] = $found ? false : $persister->supports($data, $context))
                 &&
                 !($persister instanceof ResumableDataPersisterInterface && $persister->resumable()) && !$found
             ) {

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -185,7 +185,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
         $container->setParameter('api_platform.collection.exists_parameter_name', $config['collection']['exists_parameter_name']);
         $container->setParameter('api_platform.collection.order', $config['defaults']['order'] ?? $config['collection']['order']);
         $container->setParameter('api_platform.collection.order_parameter_name', $config['collection']['order_parameter_name']);
-        $container->setParameter('api_platform.collection.pagination.enabled', $this->isConfigEnabled($container, $config['defaults']['pagination_enabled'] ?? $config['collection']['pagination']));
+        $container->setParameter('api_platform.collection.pagination.enabled', $config['defaults']['pagination_enabled'] ?? $this->isConfigEnabled($container, $config['collection']['pagination']));
         $container->setParameter('api_platform.collection.pagination.partial', $config['defaults']['pagination_partial'] ?? $config['collection']['pagination']['partial']);
         $container->setParameter('api_platform.collection.pagination.client_enabled', $config['defaults']['pagination_client_enabled'] ?? $config['collection']['pagination']['client_enabled']);
         $container->setParameter('api_platform.collection.pagination.client_items_per_page', $config['defaults']['pagination_client_items_per_page'] ?? $config['collection']['pagination']['client_items_per_page']);
@@ -397,6 +397,10 @@ private function registerSwaggerConfiguration(ContainerBuilder $container, array
         $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']);
         $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']);
         $container->setParameter('api_platform.swagger.api_keys', $config['swagger']['api_keys']);
+
+        if (true === $config['openapi']['backward_compatibility_layer']) {
+            $container->getDefinition('api_platform.swagger.normalizer.documentation')->addArgument($container->getDefinition('api_platform.openapi.normalizer'));
+        }
     }
 
     private function registerJsonApiConfiguration(array $formats, XmlFileLoader $loader): void

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -483,6 +483,7 @@ private function addOpenApiSection(ArrayNodeDefinition $rootNode): void
                                 ->scalarNode('email')->defaultNull()->info('The email address of the contact person/organization. MUST be in the format of an email address.')->end()
                             ->end()
                         ->end()
+                        ->booleanNode('backward_compatibility_layer')->defaultTrue()->info('Enable this to decorate the "api_platform.swagger.normalizer.documentation" instead of decorating the OpenAPI factory.')->end()
                         ->scalarNode('termsOfService')->defaultNull()->info('A URL to the Terms of Service for the API. MUST be in the format of a URL.')->end()
                         ->arrayNode('license')
                         ->addDefaultsIfNotSet()

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -275,11 +275,11 @@
         </service>
 
         <service id="api_platform.identifier.integer" class="ApiPlatform\Core\Identifier\Normalizer\IntegerDenormalizer" public="false">
-            <tag name="api_platform.identifier.denormalizer" />
+            <tag name="api_platform.identifier.denormalizer" priority="-100" />
         </service>
 
         <service id="api_platform.identifier.date_normalizer" class="ApiPlatform\Core\Identifier\Normalizer\DateTimeIdentifierDenormalizer" public="false">
-            <tag name="api_platform.identifier.denormalizer" />
+            <tag name="api_platform.identifier.denormalizer" priority="-100" />
         </service>
 
         <!-- Subresources -->

src/Bridge/Symfony/Bundle/Resources/config/openapi.xml

@@ -6,8 +6,26 @@
 
     <services>
         <service id="api_platform.openapi.normalizer" class="ApiPlatform\Core\OpenApi\Serializer\OpenApiNormalizer" public="false">
-            <argument type="service" id="serializer.normalizer.object" />
-            <tag name="serializer.normalizer" priority="-785" />
+            <argument type="service">
+                <service class="Symfony\Component\Serializer\Serializer">
+                    <argument type="collection">
+                        <argument type="service">
+                            <service class="Symfony\Component\Serializer\Normalizer\ObjectNormalizer">
+                                <argument>null</argument>
+                                <argument>null</argument>
+                                <argument type="service" id="api_platform.property_accessor"/>
+                                <argument type="service" id="api_platform.property_info"/>
+                            </service>
+                        </argument>
+                    </argument>
+                    <argument type="collection">
+                        <argument type="service" id="serializer.encoder.json" />
+                    </argument>
+                </service>
+            </argument>
+
+            <!-- Just after the DocumentationNormalizer see swagger.xml -->
+            <tag name="serializer.normalizer" priority="-795" />
         </service>
         <service id="ApiPlatform\Core\OpenApi\Serializer\OpenApiNormalizer" alias="api_platform.openapi.normalizer" />
 

src/Bridge/Symfony/Bundle/Resources/config/ramsey_uuid.xml

@@ -6,7 +6,7 @@
 
     <services>
         <service id="api_platform.identifier.uuid_normalizer" class="ApiPlatform\Core\Bridge\RamseyUuid\Identifier\Normalizer\UuidNormalizer" public="false">
-            <tag name="api_platform.identifier.denormalizer" />
+            <tag name="api_platform.identifier.denormalizer" priority="-100" />
         </service>
 
         <service id="api_platform.serializer.uuid_denormalizer" class="ApiPlatform\Core\Bridge\RamseyUuid\Serializer\UuidDenormalizer" public="false">

src/Bridge/Symfony/Bundle/Test/ApiTestAssertionsTrait.php

@@ -20,7 +20,6 @@
 use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface;
 use PHPUnit\Framework\ExpectationFailedException;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
-use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 /**
@@ -112,14 +111,14 @@ public static function assertMatchesJsonSchema($jsonSchema, ?int $checkMode = nu
 
     public static function assertMatchesResourceCollectionJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
     {
-        $schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::COLLECTION, $operationName, null, [AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false]);
+        $schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::COLLECTION, $operationName, null);
 
         static::assertMatchesJsonSchema($schema->getArrayCopy());
     }
 
     public static function assertMatchesResourceItemJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
     {
-        $schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::ITEM, $operationName, null, [AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false]);
+        $schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::ITEM, $operationName, null);
 
         static::assertMatchesJsonSchema($schema->getArrayCopy());
     }

src/Bridge/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaRegexRestriction.php

@@ -29,7 +29,7 @@ class PropertySchemaRegexRestriction implements PropertySchemaRestrictionMetadat
      */
     public function create(Constraint $constraint, PropertyMetadata $propertyMetadata): array
     {
-        return isset($constraint->pattern) ? ['pattern' => $constraint->pattern] : [];
+        return $constraint instanceof Regex && $constraint->getHtmlPattern() ? ['pattern' => $constraint->getHtmlPattern()] : [];
     }
 
     /**