Adding a new Attribute MapRequestHeader class and resolver

StevenRenaux · StevenRenaux · commit e85136d91028 · 2023-08-14T13:06:13.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php
@@ -18,6 +18,7 @@
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\QueryParameterValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
+use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestHeaderValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestPayloadValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver;
@@ -97,6 +98,9 @@
         ->set('argument_resolver.query_parameter_value_resolver', QueryParameterValueResolver::class)
             ->tag('controller.targeted_value_resolver', ['name' => QueryParameterValueResolver::class])
 
+        ->set('argument_resolver.header_value_resolver', RequestHeaderValueResolver::class)
+            ->tag('controller.targeted_value_resolver', ['name' => RequestHeaderValueResolver::class])
+
         ->set('response_listener', ResponseListener::class)
             ->args([
                 param('kernel.charset'),
diff --git a/src/Symfony/Component/HttpKernel/Attribute/MapRequestHeader.php b/src/Symfony/Component/HttpKernel/Attribute/MapRequestHeader.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Attribute;
+
+use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestHeaderValueResolver;
+
+#[\Attribute(\Attribute::TARGET_PARAMETER)]
+class MapRequestHeader extends ValueResolver
+{
+    public function __construct(
+        public ?string $name = null,
+        string $resolver = RequestHeaderValueResolver::class,
+    ) {
+        parent::__construct($resolver);
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -11,6 +11,7 @@ CHANGELOG
  * Add argument `$validationFailedStatusCode` to `#[MapQueryString]` and `#[MapRequestPayload]`
  * Add argument `$debug` to `Logger`
  * Add class `DebugLoggerConfigurator`
+ * Add `#[MapRequestHeader]` to map and validate request header from `Request::$headers` to typed objects
 
 6.3
 ---
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestHeaderValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestHeaderValueResolver.php
@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Controller\ArgumentResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Attribute\MapRequestHeader;
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+final class RequestHeaderValueResolver implements ValueResolverInterface
+{
+    public function resolve(Request $request, ArgumentMetadata $argument): iterable
+    {
+        $header = $request->headers;
+
+        if (!$attribute = $argument->getAttributesOfType(MapRequestHeader::class)[0] ?? null) {
+            return [];
+        }
+
+        $name = $attribute->name ?? $argument->getName();
+
+        if (!$header->has($name)) {
+            if ($argument->isNullable() || $argument->hasDefaultValue()) {
+                return [];
+            }
+
+            throw new NotFoundHttpException(sprintf('Missing header parameter "%s".', $name));
+        }
+
+        return [$header->get($name)];
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestHeaderValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestHeaderValueResolverTest.php
@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Attribute\MapRequestHeader;
+use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestHeaderValueResolver;
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+class RequestHeaderValueResolverTest extends TestCase
+{
+    private ValueResolverInterface $resolver;
+
+    protected function setUp(): void
+    {
+        $this->resolver = new RequestHeaderValueResolver();
+    }
+
+    public function testHeaderParameter()
+    {
+        $allParameters = [
+            'Accept' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
+            'Accept-Language' => 'en-us,en;q=0.5',
+            'Host' => 'localhost',
+            'User-Agent' => 'Symfony',
+        ];
+
+        foreach ($allParameters  as $parameter => $value) {
+            $metadata = new ArgumentMetadata('variableName', 'string', false, false, null, false, [
+                MapRequestHeader::class => new MapRequestHeader($parameter),
+            ]);
+
+            $arguments = $this->resolver->resolve(Request::create('/'), $metadata);
+
+            self::assertEquals([$value], $arguments);
+        }
+    }
+
+    public function testHeaderParameterIsMissing()
+    {
+        $metadata = new ArgumentMetadata('variableName', 'string', false, false, null, false, [
+            MapRequestHeader::class => new MapRequestHeader(),
+        ]);
+
+        try {
+            $this->resolver->resolve(Request::create('/'), $metadata);
+        } catch (NotFoundHttpException $exception) {
+            self::assertEquals('Missing header parameter "variableName".', $exception->getMessage());
+        }
+    }
+}
