Merge branch 'master' into master

Author: edamov

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.6.0
+
+* MongoDB: Possibility to add execute options (aggregate command fields) for a resource, like `allowDiskUse` (#3144)
+
 ## 2.5.0
 
 * Fix BC-break when using short-syntax notation for `access_control`

CHANGELOG.md

@@ -18,11 +18,6 @@ Then, if it appears that it's a real bug, you may report it using GitHub by foll
 
 > _NOTE:_ Don't hesitate giving as much information as you can (OS, PHP version extensions...)
 
-### Security Issues
-
-If you find a security issue, send a mail to Kévin Dunglas <dunglas@gmail.com>. **Please do not report security problems
-publicly**. We will disclose details of the issue and credit you after having released a new version including a fix.
-
 ## Pull Requests
 
 ### Writing a Pull Request

CONTRIBUTING.md

@@ -126,7 +126,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.5.x-dev"
+            "dev-master": "2.6.x-dev"
         }
     }
 }

composer.json

@@ -107,6 +107,26 @@ public function theJsonNodeShouldNotBeAnEmptyString($node)
         }
     }
 
+    /**
+     * @Then the JSON node :node should be sorted
+     * @Then the JSON should be sorted
+     */
+    public function theJsonNodeShouldBeSorted($node = '')
+    {
+        $actual = (array) $this->getValueOfNode($node);
+
+        if (!is_array($actual)) {
+            throw new \Exception(sprintf('The "%s" node value is not an array', $node));
+        }
+
+        $expected = $actual;
+        ksort($expected);
+
+        if ($actual !== $expected) {
+            throw new ExpectationFailedException(sprintf('The json node "%s" is not sorted by keys', $node));
+        }
+    }
+
     /**
      * @Given there is a RelatedDummy
      */

features/bootstrap/JsonApiContext.php

@@ -8,6 +8,7 @@ Feature: Entrypoint support
     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 sorted
     And the JSON node "@context" should be equal to "/contexts/Entrypoint"
     And the JSON node "@id" should be equal to "/"
     And the JSON node "@type" should be equal to "Entrypoint"

features/hydra/entrypoint.feature

@@ -123,8 +123,6 @@ final class ApiResource
     ];
 
     /**
-     * @see https://api-platform.com/docs/core/operations
-     *
      * @var array
      */
     public $collectionOperations;

src/Annotation/ApiResource.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
 use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
 use ApiPlatform\Core\Exception\RuntimeException;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
@@ -32,14 +33,16 @@
 final class CollectionDataProvider implements CollectionDataProviderInterface, RestrictedDataProviderInterface
 {
     private $managerRegistry;
+    private $resourceMetadataFactory;
     private $collectionExtensions;
 
     /**
      * @param AggregationCollectionExtensionInterface[] $collectionExtensions
      */
-    public function __construct(ManagerRegistry $managerRegistry, iterable $collectionExtensions = [])
+    public function __construct(ManagerRegistry $managerRegistry, ResourceMetadataFactoryInterface $resourceMetadataFactory, iterable $collectionExtensions = [])
     {
         $this->managerRegistry = $managerRegistry;
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->collectionExtensions = $collectionExtensions;
     }
 
@@ -72,6 +75,10 @@ public function getCollection(string $resourceClass, string $operationName = nul
             }
         }
 
-        return $aggregationBuilder->hydrate($resourceClass)->execute();
+        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
+        $attribute = $resourceMetadata->getCollectionOperationAttribute($operationName, 'doctrine_mongodb', [], true);
+        $executeOptions = $attribute['execute_options'] ?? [];
+
+        return $aggregationBuilder->hydrate($resourceClass)->execute($executeOptions);
     }
 }

src/Bridge/Doctrine/MongoDbOdm/CollectionDataProvider.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\Paginator;
 use ApiPlatform\Core\DataProvider\Pagination;
 use ApiPlatform\Core\Exception\RuntimeException;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Doctrine\ODM\MongoDB\DocumentManager;
@@ -33,11 +34,13 @@
 final class PaginationExtension implements AggregationResultCollectionExtensionInterface
 {
     private $managerRegistry;
+    private $resourceMetadataFactory;
     private $pagination;
 
-    public function __construct(ManagerRegistry $managerRegistry, Pagination $pagination)
+    public function __construct(ManagerRegistry $managerRegistry, ResourceMetadataFactoryInterface $resourceMetadataFactory, Pagination $pagination)
     {
         $this->managerRegistry = $managerRegistry;
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->pagination = $pagination;
     }
 
@@ -113,7 +116,11 @@ public function getResult(Builder $aggregationBuilder, string $resourceClass, st
             throw new RuntimeException(sprintf('The manager for "%s" must be an instance of "%s".', $resourceClass, DocumentManager::class));
         }
 
-        return new Paginator($aggregationBuilder->execute(), $manager->getUnitOfWork(), $resourceClass, $aggregationBuilder->getPipeline());
+        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
+        $attribute = $resourceMetadata->getCollectionOperationAttribute($operationName, 'doctrine_mongodb', [], true);
+        $executeOptions = $attribute['execute_options'] ?? [];
+
+        return new Paginator($aggregationBuilder->execute($executeOptions), $manager->getUnitOfWork(), $resourceClass, $aggregationBuilder->getPipeline());
     }
 
     private function addCountToContext(Builder $aggregationBuilder, array $context): array

src/Bridge/Doctrine/MongoDbOdm/Extension/PaginationExtension.php

@@ -22,6 +22,7 @@
 use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
@@ -38,14 +39,16 @@ final class ItemDataProvider implements DenormalizedIdentifiersAwareItemDataProv
     use IdentifierManagerTrait;
 
     private $managerRegistry;
+    private $resourceMetadataFactory;
     private $itemExtensions;
 
     /**
      * @param AggregationItemExtensionInterface[] $itemExtensions
      */
-    public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $itemExtensions = [])
+    public function __construct(ManagerRegistry $managerRegistry, ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $itemExtensions = [])
     {
         $this->managerRegistry = $managerRegistry;
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
         $this->propertyMetadataFactory = $propertyMetadataFactory;
         $this->itemExtensions = $itemExtensions;
@@ -95,6 +98,10 @@ public function getItem(string $resourceClass, $id, string $operationName = null
             }
         }
 
-        return $aggregationBuilder->hydrate($resourceClass)->execute()->current() ?: null;
+        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
+        $attribute = $resourceMetadata->getItemOperationAttribute($operationName, 'doctrine_mongodb', [], true);
+        $executeOptions = $attribute['execute_options'] ?? [];
+
+        return $aggregationBuilder->hydrate($resourceClass)->execute($executeOptions)->current() ?: null;
     }
 }