refactor: normalizes request headers

Author: JasonTheAdams

src/Providers/Http/DTO/Request.php

@@ -19,7 +19,7 @@
  * @phpstan-type RequestArrayShape array{
  *     method: string,
  *     uri: string,
- *     headers: array<string, string|list<string>>,
+ *     headers: array<string, list<string>>,
  *     body?: string|null
  * }
  *
@@ -43,7 +43,7 @@ class Request extends AbstractDataTransferObject
     protected string $uri;
 
     /**
-     * @var array<string, string|list<string>> The request headers.
+     * @var array<string, list<string>> The request headers.
      */
     protected array $headers;
 
@@ -79,7 +79,7 @@ public function __construct($method, string $uri, array $headers = [], ?string $
         }
 
         $this->uri = $uri;
-        $this->headers = $headers;
+        $this->headers = $this->normalizeHeaders($headers);
         $this->body = $body;
     }
 
@@ -124,7 +124,7 @@ public function getUri(): string
      *
      * @since n.e.x.t
      *
-     * @return array<string, string|list<string>> The headers.
+     * @return array<string, list<string>> The headers.
      */
     public function getHeaders(): array
     {
@@ -155,7 +155,7 @@ public function getBody(): ?string
     public function withHeader(string $name, $value): self
     {
         $headers = $this->headers;
-        $headers[$name] = $value;
+        $headers[$name] = is_array($value) ? array_values($value) : [$value];
 
         return new self($this->method, $this->uri, $headers, $this->body);
     }
@@ -173,6 +173,23 @@ public function withBody(string $body): self
         return new self($this->method, $this->uri, $this->headers, $body);
     }
 
+    /**
+     * Normalizes headers to ensure they are all arrays.
+     *
+     * @since n.e.x.t
+     *
+     * @param array<string, string|list<string>> $headers The headers to normalize.
+     * @return array<string, list<string>> The normalized headers.
+     */
+    private function normalizeHeaders(array $headers): array
+    {
+        $normalized = [];
+        foreach ($headers as $name => $value) {
+            $normalized[$name] = is_array($value) ? array_values($value) : [$value];
+        }
+        return $normalized;
+    }
+
     /**
      * Gets the request data as an array.
      *
@@ -220,13 +237,8 @@ public static function getJsonSchema(): array
                 self::KEY_HEADERS => [
                     'type' => 'object',
                     'additionalProperties' => [
-                        'oneOf' => [
-                            ['type' => 'string'],
-                            [
-                                'type' => 'array',
-                                'items' => ['type' => 'string'],
-                            ],
-                        ],
+                        'type' => 'array',
+                        'items' => ['type' => 'string'],
                     ],
                     'description' => 'The request headers.',
                 ],
@@ -273,7 +285,7 @@ public static function fromArray(array $array): self
         return new self(
             $array[self::KEY_METHOD],
             $array[self::KEY_URI],
-            $array[self::KEY_HEADERS],
+            $array[self::KEY_HEADERS] ?? [],
             $array[self::KEY_BODY] ?? null
         );
     }

src/Providers/Http/HttpTransporter.php

@@ -89,13 +89,9 @@ private function convertToPsr7Request(Request $request): RequestInterface
         );
 
         // Add headers
-        foreach ($request->getHeaders() as $name => $value) {
-            if (is_array($value)) {
-                foreach ($value as $v) {
-                    $psr7Request = $psr7Request->withAddedHeader($name, $v);
-                }
-            } else {
-                $psr7Request = $psr7Request->withHeader($name, $value);
+        foreach ($request->getHeaders() as $name => $values) {
+            foreach ($values as $value) {
+                $psr7Request = $psr7Request->withAddedHeader($name, $value);
             }
         }