[HttpFoundation] Add HeaderRequestMatcher

alexandre-daubois · alexandre-daubois · commit 9d7a3c2e39dc · 2023-10-03T11:02:43.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Make `HeaderBag::getDate()`, `Response::getDate()`, `getExpires()` and `getLastModified()` return a `DateTimeImmutable`
  * Support root-level `Generator` in `StreamedJsonResponse`
  * Add `UriSigner` from the HttpKernel component
+ * Add `HeaderRequestMatcher`
 
 6.3
 ---
diff --git a/src/Symfony/Component/HttpFoundation/RequestMatcher/HeaderRequestMatcher.php b/src/Symfony/Component/HttpFoundation/RequestMatcher/HeaderRequestMatcher.php
@@ -0,0 +1,52 @@
+<?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\HttpFoundation\RequestMatcher;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestMatcherInterface;
+
+/**
+ * Checks the presence of HTTP headers in a Request.
+ *
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ */
+class HeaderRequestMatcher implements RequestMatcherInterface
+{
+    /**
+     * @var string[]
+     */
+    private array $headers;
+
+    /**
+     * @param string[]|string $headers A header or a list of headers
+     *                                 Strings can contain a comma-delimited list of headers
+     */
+    public function __construct(array|string $headers)
+    {
+        $this->headers = array_reduce((array) $headers, static fn (array $headers, string $header) => array_merge($headers, preg_split('/\s*,\s*/', $header)), []);
+    }
+
+    public function matches(Request $request): bool
+    {
+        if (!$this->headers) {
+            return true;
+        }
+
+        foreach ($this->headers as $header) {
+            if (!$request->headers->has($header)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestMatcher/HeaderRequestMatcherTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestMatcher/HeaderRequestMatcherTest.php
@@ -0,0 +1,84 @@
+<?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\HttpFoundation\Tests\RequestMatcher;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestMatcher\HeaderRequestMatcher;
+
+class HeaderRequestMatcherTest extends TestCase
+{
+    /**
+     * @dataProvider getDataForArray
+     */
+    public function testArray(array $headers, bool $matches)
+    {
+        $matcher = new HeaderRequestMatcher(['x-foo', 'bar']);
+
+        $request = Request::create('https://example.com');
+        foreach ($headers as $k => $v) {
+            $request->headers->set($k, $v);
+        }
+
+        $this->assertSame($matches, $matcher->matches($request));
+    }
+
+    /**
+     * @dataProvider getDataForArray
+     */
+    public function testCommaSeparatedString(array $headers, bool $matches)
+    {
+        $matcher = new HeaderRequestMatcher('x-foo, bar');
+
+        $request = Request::create('https://example.com');
+        foreach ($headers as $k => $v) {
+            $request->headers->set($k, $v);
+        }
+
+        $this->assertSame($matches, $matcher->matches($request));
+    }
+
+    /**
+     * @dataProvider getDataForSingleString
+     */
+    public function testSingleString(array $headers, bool $matches)
+    {
+        $matcher = new HeaderRequestMatcher('x-foo');
+
+        $request = Request::create('https://example.com');
+        foreach ($headers as $k => $v) {
+            $request->headers->set($k, $v);
+        }
+
+        $this->assertSame($matches, $matcher->matches($request));
+    }
+
+    public static function getDataForArray(): \Generator
+    {
+        yield 'Superfluous header' => [['X-Foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], true];
+        yield 'Exact match' => [['X-Foo' => 'foo', 'bar' => 'bar'], true];
+        yield 'Case insensitivity' => [['x-foo' => 'foo', 'BAR' => 'bar'], true];
+        yield 'Only one header matching' => [['bar' => 'bar', 'baz' => 'baz'], false];
+        yield 'Only one header' => [['X-foo' => 'foo'], false];
+        yield 'Header name as a value' => [['X-foo'], false];
+        yield 'Empty headers' => [[], false];
+    }
+
+    public static function getDataForSingleString(): \Generator
+    {
+        yield 'Superfluous header' => [['X-Foo' => 'foo', 'bar' => 'bar'], true];
+        yield 'Exact match' => [['X-foo' => 'foo'], true];
+        yield 'Case insensitivity' => [['x-foo' => 'foo'], true];
+        yield 'Header name as a value' => [['X-foo'], false];
+        yield 'Empty headers' => [[], false];
+    }
+}
