Add payload controller value resolver

Author: julienfalque

CHANGELOG.md

@@ -9,6 +9,7 @@
 * MongoDB: `date_immutable` support (#3940)
 * DataProvider: Add `TraversablePaginator` (#3783)
 * Swagger UI: Add `swagger_ui_extra_configuration` to Swagger / OpenAPI configuration (#3731)
+* Allow controller argument with a name different from `$data` thanks to an argument resolver
 
 ## 2.6.3
 

src/Bridge/Symfony/Bundle/ArgumentResolver/PayloadArgumentResolver.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Bridge\Symfony\Bundle\ArgumentResolver;
+
+use ApiPlatform\Core\EventListener\ToggleableDeserializationTrait;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
+use ApiPlatform\Core\Util\RequestAttributesExtractor;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+
+final class PayloadArgumentResolver implements ArgumentValueResolverInterface
+{
+    use ToggleableDeserializationTrait;
+
+    private $serializationContextBuilder;
+
+    public function __construct(
+        ResourceMetadataFactoryInterface $resourceMetadataFactory,
+        SerializerContextBuilderInterface $serializationContextBuilder
+    ) {
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
+        $this->serializationContextBuilder = $serializationContextBuilder;
+    }
+
+    public function supports(Request $request, ArgumentMetadata $argument): bool
+    {
+        if ($argument->isVariadic()) {
+            return false;
+        }
+
+        $class = $argument->getType();
+
+        if (null === $class) {
+            return false;
+        }
+
+        if (null === $request->attributes->get('data')) {
+            return false;
+        }
+
+        $inputClass = $this->getExpectedInputClass($request);
+
+        if (null === $inputClass) {
+            return false;
+        }
+
+        return $inputClass === $class || is_subclass_of($inputClass, $class);
+    }
+
+    public function resolve(Request $request, ArgumentMetadata $argument): \Generator
+    {
+        if (!$this->supports($request, $argument)) {
+            throw new \InvalidArgumentException('Given request and argument not supported.');
+        }
+
+        yield $request->attributes->get('data');
+    }
+
+    private function getExpectedInputClass(Request $request): ?string
+    {
+        $attributes = RequestAttributesExtractor::extractAttributes($request);
+
+        if (!$this->isRequestToDeserialize($request, $attributes)) {
+            return null;
+        }
+
+        $context = $this->serializationContextBuilder->createFromRequest($request, false, $attributes);
+
+        return $context['input'] ?? $context['resource_class'];
+    }
+}

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -125,6 +125,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->registerElasticsearchConfiguration($container, $config, $loader);
         $this->registerDataTransformerConfiguration($container);
         $this->registerSecurityConfiguration($container, $loader);
+        $this->registerArgumentResolverConfiguration($container, $loader);
 
         $container->registerForAutoconfiguration(DataPersisterInterface::class)
             ->addTag('api_platform.data_persister');
@@ -717,6 +718,11 @@ private function registerOpenApiConfiguration(ContainerBuilder $container, array
         $container->setParameter('api_platform.openapi.license.url', $config['openapi']['license']['url']);
     }
 
+    private function registerArgumentResolverConfiguration(ContainerBuilder $container, XmlFileLoader $loader): void
+    {
+        $loader->load('argument_resolver.xml');
+    }
+
     private function buildDeprecationArgs(string $version, string $message): array
     {
         return method_exists(Definition::class, 'getDeprecation')

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

@@ -0,0 +1,16 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="api_platform.payload_argument_resolver" class="ApiPlatform\Core\Bridge\Symfony\Bundle\ArgumentResolver\PayloadArgumentResolver" public="false">
+            <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
+            <argument type="service" id="api_platform.serializer.context_builder" />
+
+            <tag name="controller.argument_value_resolver" />
+        </service>
+    </services>
+
+</container>

src/EventListener/DeserializeListener.php

@@ -16,7 +16,6 @@
 use ApiPlatform\Core\Api\FormatMatcher;
 use ApiPlatform\Core\Api\FormatsProviderInterface;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
-use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
 use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpFoundation\Request;
@@ -32,7 +31,7 @@
  */
 final class DeserializeListener
 {
-    use ToggleableOperationAttributeTrait;
+    use ToggleableDeserializationTrait;
 
     public const OPERATION_ATTRIBUTE_KEY = 'deserialize';
 
@@ -69,15 +68,9 @@ public function __construct(SerializerInterface $serializer, SerializerContextBu
     public function onKernelRequest(RequestEvent $event): void
     {
         $request = $event->getRequest();
-        $method = $request->getMethod();
-
-        if (
-            'DELETE' === $method
-            || $request->isMethodSafe()
-            || !($attributes = RequestAttributesExtractor::extractAttributes($request))
-            || !$attributes['receive']
-            || $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY)
-        ) {
+        $attributes = RequestAttributesExtractor::extractAttributes($request);
+
+        if (!$this->isRequestToDeserialize($request, $attributes)) {
             return;
         }
 

src/EventListener/ToggleableDeserializationTrait.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\EventListener;
+
+use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
+use Symfony\Component\HttpFoundation\Request;
+
+trait ToggleableDeserializationTrait
+{
+    use ToggleableOperationAttributeTrait;
+
+    private function isRequestToDeserialize(Request $request, array $attributes): bool
+    {
+        return
+            'DELETE' !== $request->getMethod()
+            && !$request->isMethodSafe()
+            && [] !== $attributes
+            && $attributes['receive']
+            && !$this->isOperationAttributeDisabled($attributes, DeserializeListener::OPERATION_ATTRIBUTE_KEY);
+    }
+}

tests/Bridge/Symfony/Bundle/ArgumentResolver/NotResource.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Bridge\Symfony\Bundle\ArgumentResolver;
+
+class NotResource
+{
+}