Merge branch '2.5'

api-platform · Sep 25, 2019 · 59fa1e2 · 59fa1e2
2 parents 81d276c + 78478a7
commit 59fa1e2
Show file tree

Hide file tree

Showing 14 changed files with 338 additions and 29 deletions.
diff --git a/features/main/patch.feature b/features/main/patch.feature
@@ -0,0 +1,30 @@
+Feature: Sending PATCH requets
+  As a client software developer
+  I need to be able to send partial updates
+
+  @createSchema
+  Scenario: Detect accepted patch formats
+    Given I add "Content-Type" header equal to "application/ld+json"
+    And I send a "POST" request to "/patch_dummies" with body:
+    """
+    {"name": "Hello"}
+    """
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/patch_dummies/1"
+    Then the header "Accept-Patch" should be equal to "application/merge-patch+json, application/vnd.api+json"
+
+  Scenario: Patch an item
+    When I add "Content-Type" header equal to "application/merge-patch+json"
+    And I send a "PATCH" request to "/patch_dummies/1" with body:
+    """
+    {"name": "Patched"}
+    """
+    Then the JSON node "name" should contain "Patched"
+
+  Scenario: Remove a property according to RFC 7386
+    When I add "Content-Type" header equal to "application/merge-patch+json"
+    And I send a "PATCH" request to "/patch_dummies/1" with body:
+    """
+    {"name": null}
+    """
+    Then the JSON node "name" should not exist
diff --git a/src/Annotation/ApiResource.php b/src/Annotation/ApiResource.php
@@ -45,7 +45,6 @@
  *     @Attribute("input", type="mixed"),
  *     @Attribute("iri", type="string"),
  *     @Attribute("itemOperations", type="array"),
- *     @Attribute("maximumItemsPerPage", type="int"),
  *     @Attribute("mercure", type="mixed"),
  *     @Attribute("messenger", type="mixed"),
  *     @Attribute("normalizationContext", type="array"),
@@ -58,6 +57,8 @@
  *     @Attribute("paginationEnabled", type="bool"),
  *     @Attribute("paginationFetchJoinCollection", type="bool"),
  *     @Attribute("paginationItemsPerPage", type="int"),
+ *     @Attribute("maximumItemsPerPage", type="int"),
+ *     @Attribute("paginationMaximumItemsPerPage", type="int"),
  *     @Attribute("paginationPartial", type="bool"),
  *     @Attribute("paginationViaCursor", type="array"),
  *     @Attribute("routePrefix", type="string"),
@@ -198,13 +199,6 @@ final class ApiResource
      */
     private $hydraContext;
 
-    /**
-     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
-     *
-     * @var int
-     */
-    private $maximumItemsPerPage;
-
     /**
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
@@ -275,6 +269,22 @@ final class ApiResource
      */
     private $paginationItemsPerPage;
 
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var int
+     *
+     * @deprecated - Use $paginationMaximumItemsPerPage instead
+     */
+    private $maximumItemsPerPage;
+
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var int
+     */
+    private $paginationMaximumItemsPerPage;
+
     /**
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *

diff --git a/src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php b/src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php
@@ -218,7 +218,14 @@ private function getPagination(QueryBuilder $queryBuilder, string $resourceClass
         }
 
         if ($resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_client_items_per_page', $this->clientItemsPerPage, true)) {
-            $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', $this->maximumItemPerPage, true);
+            $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', null, true);
+
+            if (null !== $maxItemsPerPage) {
+                @trigger_error('The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.', E_USER_DEPRECATED);
+            }
+
+            $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_maximum_items_per_page', $maxItemsPerPage ?? $this->maximumItemPerPage, true);
+
             $itemsPerPage = (int) $this->getPaginationParameter($request, $this->itemsPerPageParameterName, $itemsPerPage);
             $itemsPerPage = (null !== $maxItemsPerPage && $itemsPerPage >= $maxItemsPerPage ? $maxItemsPerPage : $itemsPerPage);
         }

diff --git a/src/Bridge/Symfony/Bundle/Resources/config/api.xml b/src/Bridge/Symfony/Bundle/Resources/config/api.xml
@@ -82,7 +82,6 @@
 
         <service id="api_platform.serializer.context_builder" class="ApiPlatform\Core\Serializer\SerializerContextBuilder" public="false">
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
-            <argument>%api_platform.patch_formats%</argument>
         </service>
         <service id="ApiPlatform\Core\Serializer\SerializerContextBuilderInterface" alias="api_platform.serializer.context_builder" />
 

diff --git a/src/DataProvider/Pagination.php b/src/DataProvider/Pagination.php
@@ -127,11 +127,15 @@ public function getLimit(string $resourceClass = null, string $operationName = n
 
         if ($clientLimit) {
             $limit = (int) $this->getParameterFromContext($context, $this->options['items_per_page_parameter_name'], $limit);
-            $maxItemsPerPage = $this->options['maximum_items_per_page'];
+            $maxItemsPerPage = null;
 
             if (null !== $resourceClass) {
                 $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
-                $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', $maxItemsPerPage, true);
+                $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', null, true);
+                if (null !== $maxItemsPerPage) {
+                    @trigger_error('The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.', E_USER_DEPRECATED);
+                }
+                $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_maximum_items_per_page', $maxItemsPerPage ?? $this->options['maximum_items_per_page'], true);
             }
 
             if (null !== $maxItemsPerPage && $limit > $maxItemsPerPage) {

diff --git a/src/EventListener/RespondListener.php b/src/EventListener/RespondListener.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\EventListener;
 
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
@@ -51,7 +52,7 @@ public function onKernelView(GetResponseForControllerResultEvent $event): void
 
             return;
         }
-        if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond', false))) {
+        if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond'))) {
             return;
         }
 
@@ -78,6 +79,7 @@ public function onKernelView(GetResponseForControllerResultEvent $event): void
                 $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTime::RFC1123);
             }
 
+            $headers = $this->addAcceptPatchHeader($headers, $attributes, $resourceMetadata);
             $status = $resourceMetadata->getOperationAttribute($attributes, 'status');
         }
 
@@ -87,4 +89,29 @@ public function onKernelView(GetResponseForControllerResultEvent $event): void
             $headers
         ));
     }
+
+    private function addAcceptPatchHeader(array $headers, array $attributes, ResourceMetadata $resourceMetadata): array
+    {
+        if (!isset($attributes['item_operation_name'])) {
+            return $headers;
+        }
+
+        $patchMimeTypes = [];
+        foreach ($resourceMetadata->getItemOperations() as $operation) {
+            if ('PATCH' !== ($operation['method'] ?? '') || !isset($operation['input_formats'])) {
+                continue;
+            }
+
+            foreach ($operation['input_formats'] as $mimeTypes) {
+                foreach ($mimeTypes as $mimeType) {
+                    $patchMimeTypes[] = $mimeType;
+                }
+            }
+            $headers['Accept-Patch'] = implode(', ', $patchMimeTypes);
+
+            return $headers;
+        }
+
+        return $headers;
+    }
 }
diff --git a/src/Serializer/SerializerContextBuilder.php b/src/Serializer/SerializerContextBuilder.php
@@ -28,12 +28,10 @@
 final class SerializerContextBuilder implements SerializerContextBuilderInterface
 {
     private $resourceMetadataFactory;
-    private $patchFormats;
 
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $patchFormats = [])
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
-        $this->patchFormats = $patchFormats;
     }
 
     /**
@@ -91,12 +89,16 @@ public function createFromRequest(Request $request, bool $normalization, array $
 
         unset($context[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);
 
-        if (
-            isset($this->patchFormats['json'])
-            && !isset($context['skip_null_values'])
-            && \in_array('application/merge-patch+json', $this->patchFormats['json'], true)
-        ) {
-            $context['skip_null_values'] = true;
+        if (isset($context['skip_null_values'])) {
+            return $context;
+        }
+
+        foreach ($resourceMetadata->getItemOperations() as $operation) {
+            if ('PATCH' === $operation['method'] && \in_array('application/merge-patch+json', $operation['input_formats']['json'] ?? [], true)) {
+                $context['skip_null_values'] = true;
+
+                break;
+            }
         }
 
         return $context;

diff --git a/src/Swagger/Serializer/DocumentationNormalizer.php b/src/Swagger/Serializer/DocumentationNormalizer.php
@@ -379,8 +379,14 @@ private function addPaginationParameters(bool $v3, ResourceMetadata $resourceMet
                         'minimum' => 0,
                     ];
 
-                    if ($maximumItemPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', false, true)) {
-                        $itemPerPageParameter['schema']['maximum'] = $maximumItemPerPage;
+                    $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', null, true);
+                    if (null !== $maxItemsPerPage) {
+                        @trigger_error('The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.', E_USER_DEPRECATED);
+                    }
+                    $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_maximum_items_per_page', $maxItemsPerPage, true);
+
+                    if (null !== $maxItemsPerPage) {
+                        $itemPerPageParameter['schema']['maximum'] = $maxItemsPerPage;
                     }
                 } else {
                     $itemPerPageParameter['type'] = 'integer';

diff --git a/tests/Annotation/ApiResourceTest.php b/tests/Annotation/ApiResourceTest.php
@@ -43,7 +43,6 @@ public function testConstruct()
             'input' => 'Foo',
             'iri' => 'http://example.com/res',
             'itemOperations' => ['foo' => ['bar']],
-            'maximumItemsPerPage' => 42,
             'mercure' => '[\'foo\', object.owner]',
             'messenger' => true,
             'normalizationContext' => ['groups' => ['bar']],
@@ -56,6 +55,8 @@ public function testConstruct()
             'paginationEnabled' => true,
             'paginationFetchJoinCollection' => true,
             'paginationItemsPerPage' => 42,
+            'maximumItemsPerPage' => 42, // deprecated, see paginationMaximumItemsPerPage
+            'paginationMaximumItemsPerPage' => 50,
             'paginationPartial' => true,
             'routePrefix' => '/foo',
             'shortName' => 'shortName',
@@ -84,7 +85,6 @@ public function testConstruct()
             'formats' => ['foo', 'bar' => ['application/bar']],
             'filters' => ['foo', 'bar'],
             'input' => 'Foo',
-            'maximum_items_per_page' => 42,
             'mercure' => '[\'foo\', object.owner]',
             'messenger' => true,
             'normalization_context' => ['groups' => ['bar']],
@@ -97,6 +97,8 @@ public function testConstruct()
             'pagination_enabled' => true,
             'pagination_fetch_join_collection' => true,
             'pagination_items_per_page' => 42,
+            'maximum_items_per_page' => 42,
+            'pagination_maximum_items_per_page' => 50,
             'pagination_partial' => true,
             'route_prefix' => '/foo',
             'swagger_context' => ['description' => 'bar'],

diff --git a/tests/Bridge/Doctrine/MongoDbOdm/Extension/PaginationExtensionTest.php b/tests/Bridge/Doctrine/MongoDbOdm/Extension/PaginationExtensionTest.php
@@ -318,15 +318,15 @@ public function testApplyToCollectionWithMaximumItemsPerPage()
         $attributes = [
             'pagination_enabled' => true,
             'pagination_client_enabled' => true,
-            'maximum_items_per_page' => 80,
+            'pagination_maximum_items_per_page' => 80,
         ];
         $resourceMetadataFactoryProphecy->create('Foo')->willReturn(new ResourceMetadata(null, null, null, [], [], $attributes));
         $resourceMetadataFactory = $resourceMetadataFactoryProphecy->reveal();
 
         $pagination = new Pagination($resourceMetadataFactory, [
             'client_enabled' => true,
             'client_items_per_page' => true,
-            'maximum_items_per_page' => 50,
+            'pagination_maximum_items_per_page' => 50,
         ]);
 
         $aggregationBuilderProphecy = $this->mockAggregationBuilder(0, 80);

diff --git a/tests/Bridge/Doctrine/Orm/Extension/PaginationExtensionTest.php b/tests/Bridge/Doctrine/Orm/Extension/PaginationExtensionTest.php
@@ -680,7 +680,7 @@ public function testApplyToCollectionWithMaximumItemsPerPage()
         $attributes = [
             'pagination_enabled' => true,
             'pagination_client_enabled' => true,
-            'maximum_items_per_page' => 80,
+            'pagination_maximum_items_per_page' => 80,
         ];
         $resourceMetadataFactoryProphecy->create('Foo')->willReturn(new ResourceMetadata(null, null, null, [], [], $attributes));
         $resourceMetadataFactory = $resourceMetadataFactoryProphecy->reveal();
@@ -709,6 +709,7 @@ public function testApplyToCollectionWithMaximumItemsPerPage()
      * @expectedDeprecation Passing an instance of "Symfony\Component\HttpFoundation\RequestStack" as second argument of "ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\PaginationExtension" is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface" instead.
      * @expectedDeprecation Passing an instance of "ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface" as third argument of "ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\PaginationExtension" is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "ApiPlatform\Core\DataProvider\Pagination" instead.
      * @expectedDeprecation Passing "$enabled", "$clientEnabled", "$clientItemsPerPage", "$itemsPerPage", "$pageParameterName", "$enabledParameterName", "$itemsPerPageParameterName", "$maximumItemPerPage", "$partial", "$clientPartial", "$partialParameterName" arguments is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "ApiPlatform\Core\Bridge\Doctrine\Orm\Paginator" as third argument instead.
+     * @expectedDeprecation The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.
      */
     public function testLegacyApplyToCollectionWithMaximumItemsPerPage()
     {

diff --git a/tests/Fixtures/TestBundle/Document/PatchDummy.php b/tests/Fixtures/TestBundle/Document/PatchDummy.php
@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Document;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+/**
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @ApiResource(
+ *     itemOperations={
+ *         "get",
+ *         "patch"={"input_formats"={"json"={"application/merge-patch+json"}, "jsonapi"}}
+ *     }
+ * )
+ * @ODM\Document
+ */
+class PatchDummy
+{
+    /**
+     * @ODM\Id(strategy="INCREMENT", type="integer")
+     */
+    public $id;
+
+    /**
+     * @ODM\Field(type="string")
+     */
+    public $name;
+}
diff --git a/tests/Fixtures/TestBundle/Entity/PatchDummy.php b/tests/Fixtures/TestBundle/Entity/PatchDummy.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @ApiResource(
+ *     itemOperations={
+ *         "get",
+ *         "patch"={"input_formats"={"json"={"application/merge-patch+json"}, "jsonapi"}}
+ *     }
+ * )
+ * @ORM\Entity
+ */
+class PatchDummy
+{
+    /**
+     * @ORM\Id
+     * @ORM\Column(type="integer")
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    public $id;
+
+    /**
+     * @ORM\Column(nullable=true)
+     */
+    public $name;
+}