Merge 2.6 onto main

.github/workflows/ci.yml

@@ -17,10 +17,8 @@ jobs:
     strategy:
       matrix:
         php:
-          - '8'
+          - '8.0'
       fail-fast: false
-    env:
-      PHP_CS_FIXER_FUTURE_MODE: '1'
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -42,7 +40,7 @@ jobs:
     strategy:
       matrix:
         php:
-          - '8'
+          - '8.0'
       fail-fast: false
     env:
       APP_DEBUG: '1' # https://github.com/phpstan/phpstan-symfony/issues/37

.php-cs-fixer.dist.php

@@ -36,8 +36,6 @@
         '@PHPUnit60Migration:risky' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
-        'single_line_comment_style' => false, // Temporary fix for compatibility with PHP 8 attributes, see https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5284
-        'comment_to_phpdoc' => true, // Temporary fix for compatibility with PHP 8 attributes, see https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5284
         'align_multiline_comment' => [
             'comment_type' => 'phpdocs_like',
         ],
@@ -76,9 +74,10 @@
             ],
         ],
         'no_superfluous_elseif' => true,
-        'no_superfluous_phpdoc_tags' => [
-            'allow_mixed' => false,
-        ],
+        // To re-enable in API Platform 3: https://github.com/symfony/symfony/issues/43021
+        //'no_superfluous_phpdoc_tags' => [
+        //    'allow_mixed' => false,
+        //],
         'no_unset_cast' => true,
         'no_unset_on_property' => true,
         'no_useless_else' => true,

CHANGELOG.md

@@ -46,6 +46,20 @@
 * Add support for `security_post_validation` attribute
 * Mark the GraphQL subsystem as stable (#4500)
 
+## 2.6.6
+
+* fix(json-schema): consider `SplFileInfo` class as a binary type (#4332)
+* fix(json-schema): use `collectionKeyType` for building JSON Schema (#4385)
+* fix(openapi): failing recursion on api resources with "paths" key (#4325)
+* fix(graphql): make sure form content type is recognized as a multipart request (#4461)
+* fix(doctrine): handle inverse side of OneToOne association in Doctrine search filter (#4366)
+* fix(doctrine): usage of deprecated DBAL type constants (#4399)
+* fix(test): fix `REMOTE_ADDR` support in `ApiTestCase` (#4446)
+* fix(docs): use `asset_package` for all assets (#4470)
+* fix(docs): upgrade Swagger UI to version 3.52.3 (#4477)
+* fix(docs): upgrade ReDoc to version 2.0.0-rc.56 (#4477)
+* fix(docs): upgrade Swagger UI to version 2.0.0-rc.56 (#4477)
+
 ## 2.6.5
 
 * Fix various usage of various deprecated methods

composer.json

@@ -73,6 +73,7 @@
         "symfony/framework-bundle": "^4.4 || ^5.1",
         "symfony/http-client": "^4.4 || ^5.1",
         "symfony/maker-bundle": "^1.24",
+        "symfony/intl": "^4.4 || ^5.3",
         "symfony/mercure-bundle": "*",
         "symfony/messenger": "^4.4 || ^5.1",
         "symfony/phpunit-bridge": "^5.1.7",

features/jsonld/non_resource.feature

@@ -38,6 +38,34 @@ Feature: JSON-LD non-resource handling
     }
     """
 
+  Scenario: Get a resource containing a raw object with selected properties
+    Given there are 1 dummy objects with relatedDummy and its thirdLevel
+    When I send a "GET" request to "/contain_non_resources/1?properties[]=id&properties[nested][notAResource][]=foo&properties[notAResource][]=bar"
+    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 a superset of:
+    """
+    {
+      "@context": "/contexts/ContainNonResource",
+      "@id": "/contain_non_resources/1",
+      "@type": "ContainNonResource",
+      "id": 1,
+      "nested": {
+        "@id": "/contain_non_resources/1-nested",
+        "@type": "ContainNonResource",
+        "notAResource": {
+          "@type": "NotAResource",
+          "foo": "f2"
+        }
+      },
+      "notAResource": {
+        "@type": "NotAResource",
+        "bar": "b1"
+      }
+    }
+    """
+
   @!mongodb
   @createSchema
   Scenario: Create a resource that has a non-resource relation.

src/Api/IdentifiersExtractor.php

@@ -75,6 +75,8 @@ public function getIdentifiersFromItem($item, string $operationName = null, arra
 
     /**
      * Gets the value of the given class property.
+     *
+     * @param mixed $item
      */
     private function getIdentifierValue($item, string $class, string $property, string $parameterName)
     {

src/Core/Api/ResourceClassResolverInterface.php

@@ -27,6 +27,7 @@ interface ResourceClassResolverInterface
      *
      * @param string $resourceClass The expected resource class
      * @param bool   $strict        If true, value must match the expected resource class
+     * @param mixed  $value
      *
      * @throws InvalidArgumentException
      */

src/Core/Bridge/Doctrine/Common/DataPersister.php

@@ -80,6 +80,8 @@ public function remove($data, array $context = [])
 
     /**
      * Gets the Doctrine object manager associated with given data.
+     *
+     * @param mixed $data
      */
     private function getManager($data): ?DoctrineObjectManager
     {
@@ -88,6 +90,8 @@ private function getManager($data): ?DoctrineObjectManager
 
     /**
      * Checks if doctrine does not manage data automatically.
+     *
+     * @param mixed $data
      */
     private function isDeferredExplicit(DoctrineObjectManager $manager, $data): bool
     {

src/Core/Bridge/Doctrine/EventListener/WriteListener.php

@@ -71,6 +71,8 @@ public function onKernelView(ViewEvent $event): void
 
     /**
      * Gets the manager if applicable.
+     *
+     * @param mixed $data
      */
     private function getManager(string $resourceClass, $data): ?ObjectManager
     {

src/Core/Bridge/Doctrine/MongoDbOdm/CollectionDataProvider.php

@@ -38,6 +38,7 @@ final class CollectionDataProvider implements CollectionDataProviderInterface, R
 
     /**
      * @param AggregationCollectionExtensionInterface[] $collectionExtensions
+     * @param mixed                                     $resourceMetadataFactory
      */
     public function __construct(ManagerRegistry $managerRegistry, $resourceMetadataFactory, iterable $collectionExtensions = [])
     {
@@ -56,7 +57,7 @@ public function supports(string $resourceClass, string $operationName = null, ar
      *
      * @throws RuntimeException
      */
-    public function getCollection(string $resourceClass, string $operationName = null, array $context = [])
+    public function getCollection(string $resourceClass, string $operationName = null, array $context = []): iterable
     {
         /** @var DocumentManager $manager */
         $manager = $this->managerRegistry->getManagerForClass($resourceClass);

src/Core/Bridge/Doctrine/MongoDbOdm/Extension/FilterExtension.php

@@ -37,7 +37,8 @@ final class FilterExtension implements AggregationCollectionExtensionInterface
     private $resourceMetadataFactory;
 
     /**
-     * @param ContainerInterface|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
+     * @param ContainerInterface|FilterCollection $filterLocator           The new filter locator or the deprecated filter collection
+     * @param mixed                               $resourceMetadataFactory
      */
     public function __construct($resourceMetadataFactory, $filterLocator)
     {

src/Core/Bridge/Doctrine/MongoDbOdm/Extension/OrderExtension.php

@@ -19,7 +19,9 @@
 use ApiPlatform\Exception\OperationNotFoundException;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
+use Doctrine\ODM\MongoDB\Aggregation\Stage\Sort;
 use Doctrine\Persistence\ManagerRegistry;
+use OutOfRangeException;
 
 /**
  * Applies selected ordering while querying resource collection.
@@ -56,6 +58,11 @@ public function __construct(string $order = null, $resourceMetadataFactory = nul
      */
     public function applyToCollection(Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
     {
+        // Do not apply order if already defined on $aggregationBuilder
+        if ($this->hasSortStage($aggregationBuilder)) {
+            return;
+        }
+
         $classMetaData = $this->getClassMetadata($resourceClass);
         $identifiers = $classMetaData->getIdentifier();
         if (null !== $this->resourceMetadataFactory) {
@@ -107,4 +114,27 @@ protected function getManagerRegistry(): ManagerRegistry
     {
         return $this->managerRegistry;
     }
+
+    private function hasSortStage(Builder $aggregationBuilder): bool
+    {
+        $shouldStop = false;
+        $index = 0;
+
+        do {
+            try {
+                if ($aggregationBuilder->getStage($index) instanceof Sort) {
+                    // If at least one stage is sort, then it has sorting
+                    return true;
+                }
+            } catch (OutOfRangeException $outOfRangeException) {
+                // There is no more stages on the aggregation builder
+                $shouldStop = true;
+            }
+
+            ++$index;
+        } while (!$shouldStop);
+
+        // No stage was sort, and we iterated through all stages
+        return false;
+    }
 }

src/Core/Bridge/Doctrine/MongoDbOdm/Filter/AbstractFilter.php

@@ -60,6 +60,8 @@ public function apply(Builder $aggregationBuilder, string $resourceClass, string
 
     /**
      * Passes a property through the filter.
+     *
+     * @param mixed $value
      */
     abstract protected function filterProperty(string $property, $value, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = []);
 

src/Core/Bridge/Doctrine/MongoDbOdm/Filter/DateFilter.php

@@ -107,6 +107,8 @@ protected function filterProperty(string $property, $values, Builder $aggregatio
 
     /**
      * Adds the match stage according to the chosen null management.
+     *
+     * @param mixed $value
      */
     private function addMatch(Builder $aggregationBuilder, string $field, string $operator, $value, string $nullManagement = null): void
     {

src/Core/Bridge/Doctrine/MongoDbOdm/Filter/SearchFilter.php

@@ -149,6 +149,8 @@ protected function filterProperty(string $property, $value, Builder $aggregation
 
     /**
      * Add equality match stage according to the strategy.
+     *
+     * @param mixed $values
      */
     private function addEqualityMatchStrategy(string $strategy, Builder $aggregationBuilder, string $field, string $matchField, $values, bool $caseSensitive, ClassMetadata $metadata): void
     {
@@ -166,6 +168,8 @@ private function addEqualityMatchStrategy(string $strategy, Builder $aggregation
     /**
      * Get equality match value according to the strategy.
      *
+     * @param mixed $value
+     *
      * @throws InvalidArgumentException If strategy does not exist
      *
      * @return Regex|string

src/Core/Bridge/Doctrine/MongoDbOdm/ItemDataProvider.php

@@ -46,6 +46,7 @@ final class ItemDataProvider implements DenormalizedIdentifiersAwareItemDataProv
 
     /**
      * @param AggregationItemExtensionInterface[] $itemExtensions
+     * @param mixed                               $resourceMetadataFactory
      */
     public function __construct(ManagerRegistry $managerRegistry, $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $itemExtensions = [])
     {

src/Core/Bridge/Doctrine/MongoDbOdm/PropertyInfo/DoctrineExtractor.php

@@ -43,8 +43,10 @@ public function __construct(ObjectManager $objectManager)
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[]|null
      */
-    public function getProperties($class, array $context = [])
+    public function getProperties($class, array $context = []): ?array
     {
         if (null === $metadata = $this->getMetadata($class)) {
             return null;
@@ -55,8 +57,10 @@ public function getProperties($class, array $context = [])
 
     /**
      * {@inheritdoc}
+     *
+     * @return Type[]|null
      */
-    public function getTypes($class, $property, array $context = [])
+    public function getTypes($class, $property, array $context = []): ?array
     {
         if (null === $metadata = $this->getMetadata($class)) {
             return null;

src/Core/Bridge/Doctrine/MongoDbOdm/SubresourceDataProvider.php

@@ -53,6 +53,7 @@ final class SubresourceDataProvider implements SubresourceDataProviderInterface
     /**
      * @param AggregationCollectionExtensionInterface[] $collectionExtensions
      * @param AggregationItemExtensionInterface[]       $itemExtensions
+     * @param mixed                                     $resourceMetadataFactory
      */
     public function __construct(ManagerRegistry $managerRegistry, $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $collectionExtensions = [], iterable $itemExtensions = [])
     {

src/Core/Bridge/Doctrine/Orm/CollectionDataProvider.php

@@ -53,7 +53,7 @@ public function supports(string $resourceClass, string $operationName = null, ar
      *
      * @throws RuntimeException
      */
-    public function getCollection(string $resourceClass, string $operationName = null, array $context = [])
+    public function getCollection(string $resourceClass, string $operationName = null, array $context = []): iterable
     {
         /** @var EntityManagerInterface $manager */
         $manager = $this->managerRegistry->getManagerForClass($resourceClass);

src/Core/Bridge/Doctrine/Orm/Extension/EagerLoadingExtension.php

@@ -57,6 +57,8 @@ final class EagerLoadingExtension implements ContextAwareQueryCollectionExtensio
 
     /**
      * @TODO move $fetchPartial after $forceEager (@soyuka) in 3.0
+     *
+     * @param mixed $resourceMetadataFactory
      */
     public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, $resourceMetadataFactory, int $maxJoins = 30, bool $forceEager = true, RequestStack $requestStack = null, SerializerContextBuilderInterface $serializerContextBuilder = null, bool $fetchPartial = false, ClassMetadataFactoryInterface $classMetadataFactory = null)
     {

src/Core/Bridge/Doctrine/Orm/Extension/FilterExtension.php

@@ -40,7 +40,8 @@ final class FilterExtension implements ContextAwareQueryCollectionExtensionInter
     private $resourceMetadataFactory;
 
     /**
-     * @param ContainerInterface|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
+     * @param ContainerInterface|FilterCollection $filterLocator           The new filter locator or the deprecated filter collection
+     * @param mixed                               $resourceMetadataFactory
      */
     public function __construct($resourceMetadataFactory, $filterLocator)
     {

src/Core/Bridge/Doctrine/Orm/Extension/OrderExtension.php

@@ -56,6 +56,12 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
             throw new InvalidArgumentException('The "$resourceClass" parameter must not be null');
         }
 
+        // Do not apply order if already defined on queryBuilder
+        $orderByDqlPart = $queryBuilder->getDQLPart('orderBy');
+        if (\is_array($orderByDqlPart) && \count($orderByDqlPart) > 0) {
+            return;
+        }
+
         $rootAlias = $queryBuilder->getRootAliases()[0];
 
         $classMetaData = $queryBuilder->getEntityManager()->getClassMetadata($resourceClass);

src/Core/Bridge/Doctrine/Orm/Extension/PaginationExtension.php

@@ -158,7 +158,7 @@ public function supportsResult(string $resourceClass, string $operationName = nu
     /**
      * {@inheritdoc}
      */
-    public function getResult(QueryBuilder $queryBuilder, string $resourceClass = null, string $operationName = null, array $context = [])
+    public function getResult(QueryBuilder $queryBuilder, string $resourceClass = null, string $operationName = null, array $context = []): iterable
     {
         $query = $queryBuilder->getQuery();
 

src/Core/Bridge/Doctrine/Orm/Filter/AbstractFilter.php

@@ -75,6 +75,8 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q
 
     /**
      * Passes a property through the filter.
+     *
+     * @param mixed $value
      */
     abstract protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null/*, array $context = []*/);
 

src/Core/Bridge/Doctrine/Orm/Filter/DateFilter.php

@@ -130,6 +130,7 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
      * Adds the where clause according to the chosen null management.
      *
      * @param string|DBALType $type
+     * @param mixed           $value
      */
     protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, $value, string $nullManagement = null, $type = null)
     {

src/Core/Bridge/Doctrine/Orm/Filter/SearchFilter.php

@@ -150,7 +150,7 @@ protected function filterProperty(string $property, $value, QueryBuilder $queryB
 
         $associationAlias = $alias;
         $associationField = $field;
-        if ($metadata->isCollectionValuedAssociation($associationField)) {
+        if ($metadata->isCollectionValuedAssociation($associationField) || $metadata->isAssociationInverseSide($field)) {
             $associationAlias = QueryBuilderHelper::addJoinOnce($queryBuilder, $queryNameGenerator, $alias, $associationField);
             $associationField = $associationFieldIdentifier;
         }
@@ -161,6 +161,8 @@ protected function filterProperty(string $property, $value, QueryBuilder $queryB
     /**
      * Adds where clause according to the strategy.
      *
+     * @param mixed $values
+     *
      * @throws InvalidArgumentException If strategy does not exist
      */
     protected function addWhereByStrategy(string $strategy, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, $values, bool $caseSensitive)

src/Core/Bridge/Elasticsearch/DataProvider/CollectionDataProvider.php

@@ -108,7 +108,7 @@ public function supports(string $resourceClass, ?string $operationName = null, a
     /**
      * {@inheritdoc}
      */
-    public function getCollection(string $resourceClass, ?string $operationName = null, array $context = [])
+    public function getCollection(string $resourceClass, ?string $operationName = null, array $context = []): iterable
     {
         $documentMetadata = $this->documentMetadataFactory->create($resourceClass);
         $body = [];