Refactor the Serializer context building process

Author: dunglas

features/content_negotiation.feature

@@ -12,13 +12,51 @@ Feature: Content Negotiation support
         <name>XML!</name>
     </root>
     """
-    Then the header "Content-Type" should be equal to "application/xml"
+    Then the response status code should be 201
+    And the header "Content-Type" should be equal to "application/xml"
     And the response should be equal to
     """
 <?xml version="1.0"?>
 <response><id>1</id><name>XML!</name><alias/><description/><dummyDate/><dummyPrice/><jsonData/><relatedDummy/><dummyBoolean/><dummy/><relatedDummies/><nameConverted/></response>
     """
 
+  Scenario:  Retrieve a collection in XML
+    When I add "Accept" header equal to "text/xml"
+    And I send a "GET" request to "/dummies"
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "text/xml; charset=UTF-8"
+    And the response should be equal to
+    """
+<?xml version="1.0"?>
+<response><item key="0"><id>1</id><name>XML!</name><alias/><description/><dummyDate/><dummyPrice/><jsonData/><relatedDummy/><dummyBoolean/><dummy/><relatedDummies/><nameConverted/></item></response>
+    """
+
+  Scenario:  Retrieve a collection in JSON
+    When I add "Accept" header equal to "application/json"
+    And I send a "GET" request to "/dummies"
+    Then the response status code should be 200
+    And the header "Content-Type" should be equal to "application/json"
+    And the response should be in JSON
+    And the JSON should be equal to:
+    """
+[
+  {
+    "id": 1,
+    "name": "XML!",
+    "alias": null,
+    "description": null,
+    "dummyDate": null,
+    "dummyPrice": null,
+    "jsonData": [],
+    "relatedDummy": null,
+    "dummyBoolean": null,
+    "dummy": null,
+    "relatedDummies": [],
+    "nameConverted": null
+  }
+]
+    """
+
   @dropSchema
   Scenario: Requesting an unknown format should return JSON-LD
     When I add "Accept" header equal to "text/plain"

src/Api/RequestAttributesExtractor.php

@@ -18,6 +18,8 @@
  * Extracts data used by the library form a Request instance.
  *
  * @author Kévin Dunglas <[email protected]>
+ *
+ * @internal
  */
 final class RequestAttributesExtractor
 {
@@ -29,19 +31,17 @@ final class RequestAttributesExtractor
      *
      * @throws RuntimeException
      *
-     * @return array
+     * @return array [$resourceClass, $collectionOperation, $itemOperation, $format]
      */
     public static function extractAttributes(Request $request)
     {
         $resourceClass = $request->attributes->get('_resource_class');
-
         if (!$resourceClass) {
             throw new RuntimeException('The request attribute "_resource_class" must be defined.');
         }
 
         $collectionOperation = $request->attributes->get('_collection_operation_name');
         $itemOperation = $request->attributes->get('_item_operation_name');
-
         if (!$itemOperation && !$collectionOperation) {
             throw new RuntimeException('One of the request attribute "_item_operation_name" or "_collection_operation_name" must be defined.');
         }

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

@@ -43,6 +43,12 @@
 
         <service id="api_platform.negotiator" class="Negotiation\Negotiator" public="false" />
 
+        <!-- Serializer -->
+
+        <service id="api_platform.serializer.context_builder" class="ApiPlatform\Core\Serializer\SerializerContextBuilder" public="false">
+            <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
+        </service>
+
         <!-- Resource path generators -->
 
         <service id="api_platform.routing.resource_path_generator.underscore" class="ApiPlatform\Core\Routing\UnderscoreResourcePathGenerator" public="false" />
@@ -60,14 +66,14 @@
 
         <service id="api_platform.listener.view.serializer" class="ApiPlatform\Core\EventListener\SerializerViewListener">
             <argument type="service" id="api_platform.serializer" />
-            <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
+            <argument type="service" id="api_platform.serializer.context_builder" />
 
             <tag name="kernel.event_listener" event="kernel.view" method="onKernelView" priority="10" />
         </service>
 
         <service id="api_platform.listener.view.deserializer" class="ApiPlatform\Core\EventListener\DeserializerViewListener">
             <argument type="service" id="api_platform.serializer" />
-            <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
+            <argument type="service" id="api_platform.serializer.context_builder" />
 
             <tag name="kernel.event_listener" event="kernel.view" method="onKernelView" priority="30" />
         </service>

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

@@ -44,7 +44,6 @@
         <!-- Serializer -->
 
         <service id="api_platform.hydra.normalizer.collection" class="ApiPlatform\Core\Hydra\Serializer\CollectionNormalizer" public="false">
-            <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="api_platform.jsonld.context_builder" />
             <argument type="service" id="api_platform.resource_class_resolver" />
             <argument type="service" id="api_platform.iri_converter" />

src/EventListener/DeserializerViewListener.php

@@ -13,7 +13,7 @@
 
 use ApiPlatform\Core\Api\RequestAttributesExtractor;
 use ApiPlatform\Core\Exception\RuntimeException;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
@@ -27,46 +27,41 @@
 final class DeserializerViewListener
 {
     private $serializer;
-    private $resourceMetadataFactory;
+    private $serializerContextBuilder;
 
-    public function __construct(SerializerInterface $serializer, ResourceMetadataFactoryInterface $resourceMetadataFactory)
+    public function __construct(SerializerInterface $serializer, SerializerContextBuilderInterface $serializerContextBuilder)
     {
         $this->serializer = $serializer;
-        $this->resourceMetadataFactory = $resourceMetadataFactory;
+        $this->serializerContextBuilder = $serializerContextBuilder;
     }
 
+    /**
+     * Deserializes the data sent in the requested format.
+     *
+     * @param GetResponseForControllerResultEvent $event
+     */
     public function onKernelView(GetResponseForControllerResultEvent $event)
     {
-        $data = $event->getControllerResult();
+        $controllerResult = $event->getControllerResult();
         $request = $event->getRequest();
 
-        if ($data instanceof Response || !in_array($request->getMethod(), [Request::METHOD_POST, Request::METHOD_PUT], true)) {
+        if ($controllerResult instanceof Response || !in_array($request->getMethod(), [Request::METHOD_POST, Request::METHOD_PUT], true)) {
             return;
         }
 
         try {
-            list($resourceClass, $collectionOperationName, $itemOperationName, $format) = RequestAttributesExtractor::extractAttributes($request);
+            $extractedAttributes = RequestAttributesExtractor::extractAttributes($request);
         } catch (RuntimeException $e) {
             return;
         }
 
-        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
-
-        if ($collectionOperationName) {
-            $context = $resourceMetadata->getCollectionOperationAttribute($collectionOperationName, 'denormalization_context', [], true);
-            $context['collection_operation_name'] = $collectionOperationName;
-        } else {
-            $context = $resourceMetadata->getItemOperationAttribute($itemOperationName, 'denormalization_context', [], true);
-            $context['item_operation_name'] = $itemOperationName;
-        }
-
-        $context['resource_class'] = $resourceClass;
-        $context['request_uri'] = $request->getRequestUri();
-
-        if (null !== $data) {
-            $context['object_to_populate'] = $data;
+        $context = $this->serializerContextBuilder->createFromRequest($request, false, $extractedAttributes);
+        if (null !== $controllerResult) {
+            $context['object_to_populate'] = $controllerResult;
         }
 
-        $event->setControllerResult($this->serializer->deserialize($request->getContent(), $resourceClass, $format, $context));
+        $event->setControllerResult(
+            $this->serializer->deserialize($request->getContent(), $extractedAttributes[0], $extractedAttributes[3], $context)
+        );
     }
 }

src/EventListener/SerializerViewListener.php

@@ -12,7 +12,8 @@
 namespace ApiPlatform\Core\EventListener;
 
 use ApiPlatform\Core\Api\RequestAttributesExtractor;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Exception\RuntimeException;
+use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
 use Symfony\Component\Serializer\SerializerInterface;
 
@@ -21,49 +22,38 @@
  *
  * @author Kévin Dunglas <[email protected]>
  */
-class SerializerViewListener
+final class SerializerViewListener
 {
     private $serializer;
-    private $resourceMetadataFactory;
+    private $serializerContextBuilder;
 
-    public function __construct(SerializerInterface $serializer, ResourceMetadataFactoryInterface $resourceMetadataFactory)
+    public function __construct(SerializerInterface $serializer, SerializerContextBuilderInterface $serializerContextBuilder)
     {
         $this->serializer = $serializer;
-        $this->resourceMetadataFactory = $resourceMetadataFactory;
+        $this->serializerContextBuilder = $serializerContextBuilder;
     }
 
     /**
      * Serializes the data to the requested format.
+     *
+     * @param GetResponseForControllerResultEvent $event
      */
     public function onKernelView(GetResponseForControllerResultEvent $event)
     {
         $controllerResult = $event->getControllerResult();
         $request = $event->getRequest();
-        $format = $request->attributes->get('_api_format');
 
-        if ($controllerResult instanceof Response || !$format) {
+        if ($controllerResult instanceof Response) {
             return;
         }
 
         try {
-            list($resourceClass, $collectionOperationName, $itemOperationName, $format) = RequestAttributesExtractor::extractAttributes($request);
+            $extractedAttributes = RequestAttributesExtractor::extractAttributes($request);
         } catch (RuntimeException $e) {
             return;
         }
 
-        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
-
-        if ($collectionOperationName) {
-            $context = $resourceMetadata->getCollectionOperationAttribute($collectionOperationName, 'normalization_context', [], true);
-            $context['collection_operation_name'] = $collectionOperationName;
-        } else {
-            $context = $resourceMetadata->getItemOperationAttribute($itemOperationName, 'normalization_context', [], true);
-            $context['item_operation_name'] = $itemOperationName;
-        }
-
-        $context['resource_class'] = $resourceClass;
-        $context['request_uri'] = $request->getRequestUri();
-
-        $event->setControllerResult($this->serializer->serialize($controllerResult, $format, $context));
+        $context = $this->serializerContextBuilder->createFromRequest($request, true, $extractedAttributes);
+        $event->setControllerResult($this->serializer->serialize($controllerResult, $extractedAttributes[3], $context));
     }
 }

src/Hydra/Serializer/CollectionFiltersNormalizer.php

@@ -64,7 +64,7 @@ public function normalize($object, $format = null, array $context = [])
             return $data;
         }
 
-        $resourceClass = $this->getResourceClass($this->resourceClassResolver, $object, $context);
+        $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class'] ?? null, true);
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
 
         $operationName = $context['collection_operation_name'] ?? null;

src/Hydra/Serializer/CollectionNormalizer.php

@@ -17,7 +17,6 @@
 use ApiPlatform\Core\Exception\RuntimeException;
 use ApiPlatform\Core\JsonLd\ContextBuilderInterface;
 use ApiPlatform\Core\JsonLd\Serializer\ContextTrait;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\SerializerAwareInterface;
 use Symfony\Component\Serializer\SerializerAwareTrait;
@@ -35,14 +34,12 @@ final class CollectionNormalizer implements NormalizerInterface, SerializerAware
 
     const FORMAT = 'jsonld';
 
-    private $resourceMetadataFactory;
     private $contextBuilder;
     private $resourceClassResolver;
     private $iriConverter;
 
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, IriConverterInterface $iriConverter)
+    public function __construct(ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, IriConverterInterface $iriConverter)
     {
-        $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->contextBuilder = $contextBuilder;
         $this->resourceClassResolver = $resourceClassResolver;
         $this->iriConverter = $iriConverter;
@@ -78,10 +75,9 @@ public function normalize($object, $format = null, array $context = [])
             return $data;
         }
 
-        $resourceClass = $this->getResourceClass($this->resourceClassResolver, $object, $context);
-        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
+        $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class'] ?? null, true);
         $data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
-        $context = $this->createContext($resourceClass, $resourceMetadata, $context, true);
+        $context = $this->createContext($resourceClass, $context);
 
         $data['@id'] = $this->iriConverter->getIriFromResourceClass($resourceClass);
         $data['@type'] = 'hydra:Collection';