Fix #82: Add HeadersProvider

Author: xepozz

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 3.0.1 under development
 
-- no changes in this release.
+- Enh #82: Add `HeadersProvider` (@xepozz)
 
 ## 3.0.0 February 14, 2023
 

src/HeadersProvider.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler;
+
+use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
+
+/**
+ * `HeadersProvider` provides headers for error response.
+ * It is used by {@see ErrorCatcher} to add headers to response in case of error.
+ */
+final class HeadersProvider
+{
+    /**
+     * @param array<string, string[]> $headers Default headers list.
+     */
+    public function __construct(
+        private array $headers = [],
+    ) {
+    }
+
+    /**
+     * Adds a header to the list of headers.
+     *
+     * @param string $name The header name.
+     * @param string|string[] $values The header value.
+     */
+    public function add(string $name, string|array $values): void
+    {
+        $this->headers[$name] = (array)$values;
+    }
+
+    /**
+     * Returns all headers.
+     *
+     * @return array<string, string[]> The headers list.
+     */
+    public function getAll(): array
+    {
+        return $this->headers;
+    }
+}

src/Middleware/ErrorCatcher.php

@@ -13,6 +13,7 @@
 use Psr\Http\Server\RequestHandlerInterface;
 use Throwable;
 use Yiisoft\ErrorHandler\ErrorHandler;
+use Yiisoft\ErrorHandler\HeadersProvider;
 use Yiisoft\ErrorHandler\Renderer\HeaderRenderer;
 use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
 use Yiisoft\ErrorHandler\Renderer\JsonRenderer;
@@ -37,6 +38,8 @@
  */
 final class ErrorCatcher implements MiddlewareInterface
 {
+    private HeadersProvider $headersProvider;
+
     /**
      * @psalm-var array<string,class-string<ThrowableRendererInterface>>
      */
@@ -54,7 +57,9 @@ public function __construct(
         private ResponseFactoryInterface $responseFactory,
         private ErrorHandler $errorHandler,
         private ContainerInterface $container,
+        HeadersProvider $headersProvider = null,
     ) {
+        $this->headersProvider = $headersProvider ?? new HeadersProvider();
     }
 
     /**
@@ -137,7 +142,9 @@ private function generateErrorResponse(Throwable $t, ServerRequestInterface $req
 
         $data = $this->errorHandler->handle($t, $renderer, $request);
         $response = $this->responseFactory->createResponse(Status::INTERNAL_SERVER_ERROR);
-
+        foreach ($this->headersProvider->getAll() as $name => $value) {
+            $response = $response->withHeader($name, $value);
+        }
         return $data->addToResponse($response->withHeader(Header::CONTENT_TYPE, $contentType));
     }
 

tests/Middleware/ErrorCatcherTest.php

@@ -13,8 +13,9 @@
 use Psr\Http\Server\RequestHandlerInterface;
 use Psr\Log\LoggerInterface;
 use RuntimeException;
-use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
 use Yiisoft\ErrorHandler\ErrorHandler;
+use Yiisoft\ErrorHandler\HeadersProvider;
+use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
 use Yiisoft\ErrorHandler\Renderer\HeaderRenderer;
 use Yiisoft\ErrorHandler\Renderer\PlainTextRenderer;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
@@ -203,16 +204,50 @@ public function testForceContentTypeSetInvalidType(): void
             ->forceContentType('image/gif');
     }
 
-    private function createErrorHandler(): ErrorHandler
+    public function testAddedHeaders(): void
     {
-        $logger = $this->createMock(LoggerInterface::class);
-        return new ErrorHandler($logger, new PlainTextRenderer());
+        $provider = new HeadersProvider([
+            'X-Default' => 'default',
+            'Content-Type' => 'incorrect',
+        ]);
+        $provider->add('X-Test', 'test');
+        $provider->add('X-Test2', ['test2', 'test3']);
+        $catcher = $this
+            ->createErrorCatcher(provider: $provider)
+            ->withRenderer('*/*', PlainTextRenderer::class);
+        $response = $catcher->process(
+            $this->createServerRequest('GET', ['Accept' => ['test/test']]),
+            $this->createRequestHandlerWithThrowable(),
+        );
+        $headers = $response->getHeaders();
+
+        $this->assertArrayHasKey('Content-Type', $headers);
+        $this->assertNotEquals('incorrect', $headers['Content-Type']);
+
+        $this->assertArrayHasKey('X-Default', $headers);
+        $this->assertEquals(['default'], $headers['X-Default']);
+        $this->assertArrayHasKey('X-Test', $headers);
+        $this->assertEquals(['test'], $headers['X-Test']);
+        $this->assertArrayHasKey('X-Test2', $headers);
+        $this->assertEquals(['test2', 'test3'], $headers['X-Test2']);
     }
 
-    private function createErrorCatcher(): ErrorCatcher
-    {
+    private function createErrorCatcher(
+        HeadersProvider $provider = null,
+    ): ErrorCatcher {
         $container = new SimpleContainer([], fn (string $className): object => new $className());
-        return new ErrorCatcher(new ResponseFactory(), $this->createErrorHandler(), $container);
+        return new ErrorCatcher(
+            new ResponseFactory(),
+            $this->createErrorHandler(),
+            $container,
+            $provider ?? new HeadersProvider()
+        );
+    }
+
+    private function createErrorHandler(): ErrorHandler
+    {
+        $logger = $this->createMock(LoggerInterface::class);
+        return new ErrorHandler($logger, new PlainTextRenderer());
     }
 
     private function createServerRequest(string $method, array $headers = []): ServerRequestInterface