Allow to push relations to the client using HTTP/2 (#2450)

* Allow to push relations to the client using HTTP/2

* Simplify code

* Fix CS

* Minor fix

* Update features/push_relations/push.feature

Co-Authored-By: dunglas <[email protected]>

* Fix the deps=low build

Author: dunglas

composer.json

@@ -45,7 +45,7 @@
         "phpdocumentor/reflection-docblock": "^3.0 || ^4.0",
         "phpdocumentor/type-resolver": "^0.3 || ^0.4",
         "phpspec/prophecy": "^1.8",
-        "phpunit/phpunit": "^7.5.1",
+        "phpunit/phpunit": "^7.5.2",
         "psr/log": "^1.0",
         "ramsey/uuid": "^3.7",
         "ramsey/uuid-doctrine": "^1.4",

features/push_relations/push.feature

@@ -0,0 +1,17 @@
+@sqlite
+Feature: Push relations using HTTP/2
+  In order to have a fast API
+  As an API software developer
+  I need to push relations using HTTP/2
+
+  @createSchema
+  Scenario: Push the relations of a collection of items
+    Given there are 2 dummy objects with relatedDummy
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/dummies"
+    Then the header "Link" should be equal to '</related_dummies/1>; rel="preload",</related_dummies/2>; rel="preload",<http://example.com/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"'
+
+  Scenario: Push the relations of an item
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "GET" request to "/dummies/1"
+    Then the header "Link" should be equal to '</related_dummies/1>; rel="preload",<http://example.com/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"'

src/Annotation/ApiProperty.php

@@ -28,6 +28,7 @@
  *     @Attribute("fetchEager", type="bool"),
  *     @Attribute("openapiContext", type="array"),
  *     @Attribute("jsonldContext", type="array"),
+ *     @Attribute("push", type="bool"),
  *     @Attribute("swaggerContext", type="array")
  * )
  */
@@ -108,14 +109,21 @@ final class ApiProperty
      *
      * @var array
      */
-    private $swaggerContext;
+    private $openapiContext;
+
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var bool
+     */
+    private $push;
 
     /**
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
-    private $openapiContext;
+    private $swaggerContext;
 
     /**
      * @throws InvalidArgumentException

src/EventListener/DeserializeListener.php

@@ -64,8 +64,8 @@ public function onKernelRequest(GetResponseEvent $event)
         $request = $event->getRequest();
         $method = $request->getMethod();
         if (
-            $request->isMethodSafe(false)
-            || 'DELETE' === $method
+            'DELETE' === $method
+            || $request->isMethodSafe(false)
             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
             || false === ($attributes['input_class'] ?? null)
             || !$attributes['receive']

src/EventListener/SerializeListener.php

@@ -17,6 +17,8 @@
 use ApiPlatform\Core\Serializer\ResourceList;
 use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
+use Fig\Link\GenericLinkProvider;
+use Fig\Link\Link;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
@@ -77,11 +79,23 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
         $resources = new ResourceList();
         $context['resources'] = &$resources;
 
+        $resourcesToPush = new ResourceList();
+        $context['resources_to_push'] = &$resourcesToPush;
+
         $request->attributes->set('_api_normalization_context', $context);
 
         $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat(), $context));
 
         $request->attributes->set('_resources', $request->attributes->get('_resources', []) + (array) $resources);
+        if (!\count($resourcesToPush)) {
+            return;
+        }
+
+        $linkProvider = $request->attributes->get('_links', new GenericLinkProvider());
+        foreach ($resourcesToPush as $resourceToPush) {
+            $linkProvider = $linkProvider->withLink(new Link('preload', $resourceToPush));
+        }
+        $request->attributes->set('_links', $linkProvider);
     }
 
     /**

src/Serializer/AbstractItemNormalizer.php

@@ -531,7 +531,7 @@ protected function normalizeCollectionOfRelations(PropertyMetadata $propertyMeta
      */
     protected function normalizeRelation(PropertyMetadata $propertyMetadata, $relatedObject, string $resourceClass, string $format = null, array $context)
     {
-        if (null === $relatedObject || $propertyMetadata->isReadableLink() || !empty($context['attributes'])) {
+        if (null === $relatedObject || !empty($context['attributes']) || $propertyMetadata->isReadableLink()) {
             if (null === $relatedObject) {
                 unset($context['resource_class']);
             } else {
@@ -548,6 +548,9 @@ protected function normalizeRelation(PropertyMetadata $propertyMetadata, $relate
         if (isset($context['resources'])) {
             $context['resources'][$iri] = $iri;
         }
+        if (isset($context['resources_to_push']) && $propertyMetadata->getAttribute('push', false)) {
+            $context['resources_to_push'][$iri] = $iri;
+        }
 
         return $iri;
     }

tests/Annotation/ApiPropertyTest.php

@@ -54,6 +54,7 @@ public function testConstruct()
             'jsonldContext' => ['foo' => 'bar'],
             'swaggerContext' => ['foo' => 'baz'],
             'openapiContext' => ['foo' => 'baz'],
+            'push' => true,
             'attributes' => ['unknown' => 'unknown', 'fetchable' => false],
         ]);
         $this->assertEquals([
@@ -63,6 +64,7 @@ public function testConstruct()
             'jsonld_context' => ['foo' => 'bar'],
             'swagger_context' => ['foo' => 'baz'],
             'openapi_context' => ['foo' => 'baz'],
+            'push' => true,
             'unknown' => 'unknown',
         ], $property->attributes);
     }

tests/EventListener/SerializeListenerTest.php

@@ -113,7 +113,7 @@ public function testSerializeCollectionOperation()
                 'xml',
                 Argument::allOf(
                     Argument::that(function (array $context) {
-                        return $context['resources'] instanceof ResourceList;
+                        return $context['resources'] instanceof ResourceList && $context['resources_to_push'] instanceof ResourceList;
                     }),
                     Argument::withEntry('request_uri', ''),
                     Argument::withEntry('resource_class', 'Foo'),
@@ -168,7 +168,7 @@ public function testSerializeItemOperation()
                 'xml',
                 Argument::allOf(
                     Argument::that(function (array $context) {
-                        return $context['resources'] instanceof ResourceList;
+                        return $context['resources'] instanceof ResourceList && $context['resources_to_push'] instanceof ResourceList;
                     }),
                     Argument::withEntry('request_uri', ''),
                     Argument::withEntry('resource_class', 'Foo'),

tests/Fixtures/TestBundle/Entity/Dummy.php

@@ -120,6 +120,7 @@ class Dummy
      * @var RelatedDummy A related dummy
      *
      * @ORM\ManyToOne(targetEntity="RelatedDummy")
+     * @ApiProperty(push=true)
      */
     public $relatedDummy;