test: refactor NativeHeadersStack to use simplified header simulation

Author: datamweb

system/Test/Utilities/NativeHeadersStack.php

@@ -14,134 +14,51 @@
 namespace CodeIgniter\Test\Utilities;
 
 /**
- * Class NativeHeadersStack
- *
  * A utility class for simulating native PHP header handling in unit tests.
- * It allows the inspection, manipulation, and mocking of HTTP headers without
- * affecting the actual HTTP output.
  *
  * @internal This class is for testing purposes only.
  */
 final class NativeHeadersStack
 {
-    private static bool $headersSent = false;
-
-    /**
-     * @var array<string, list<string>>
-     */
-    private static array $headers = [];
-
-    private static ?int $responseCode = null;
-
-    /**
-     * Resets the state of the class to its default values.
-     */
-    public static function reset(): void
-    {
-        self::$headersSent  = false;
-        self::$headers      = [];
-        self::$responseCode = null;
-    }
-
-    /**
-     * Sets the state of whether headers have been sent.
-     */
-    public static function setHeadersSent(bool $sent): void
-    {
-        self::$headersSent = $sent;
-    }
-
-    /**
-     * Simulates PHP's native `headers_sent()` function.
-     */
-    public static function headersSent(): bool
-    {
-        return self::$headersSent;
-    }
-
-    /**
-     * Sets a header by name, replacing or appending it.
-     * This is the main method for header manipulation.
-     *
-     * @param string   $header       The header string (e.g., 'Content-Type: application/json').
-     * @param bool     $replace      Whether to replace a previous similar header.
-     * @param int|null $responseCode Forces the HTTP response code to the specified value.
-     */
-    public static function set(string $header, bool $replace = true, ?int $responseCode = null): void
-    {
-        if (str_contains($header, ':')) {
-            [$name, $value] = explode(':', $header, 2);
-            $name           = trim($name);
-            $value          = trim($value);
-
-            if ($replace || ! isset(self::$headers[strtolower($name)])) {
-                self::$headers[strtolower($name)] = [];
-            }
-            self::$headers[strtolower($name)][] = "{$name}: {$value}";
-        } else {
-            // Handle non-key-value headers like "HTTP/1.1 404 Not Found"
-            self::$headers['status'][] = $header;
-        }
-
-        if ($responseCode !== null) {
-            self::$responseCode = $responseCode;
-        }
-    }
-
     /**
-     * Pushes a header to the stack without replacing existing ones.
+     * Simulates whether headers have been sent.
      */
-    public static function push(string $header): void
-    {
-        self::set($header, false);
-    }
+    public static bool $headersSent = false;
 
     /**
-     * A convenience method to push multiple headers at once.
+     * Stores the list of headers.
      *
-     * @param list<string> $headers An array of headers to push onto the stack.
+     * @var list<string>
      */
-    public static function pushMany(array $headers): void
-    {
-        foreach ($headers as $header) {
-            // Default to not replacing for multiple adds
-            self::set($header, false);
-        }
-    }
+    public static array $headers = [];
 
     /**
-     * Simulates PHP's `headers_list()` function.
-     *
-     * @return list<string> The list of simulated headers.
+     * Resets the header stack to defaults.
+     * Call this in setUp() to ensure clean state between tests.
      */
-    public static function listHeaders(): array
+    public static function reset(): void
     {
-        $list = [];
-
-        foreach (self::$headers as $values) {
-            $list = array_merge($list, $values);
-        }
-
-        return $list;
+        self::$headersSent = false;
+        self::$headers     = [];
     }
 
     /**
-     * Checks if a header with the given name exists in the stack (case-insensitive).
+     * Checks if a specific header exists in the stack.
      *
-     * @param string $name The header name to search for (e.g., 'Content-Type').
+     * @param string $header The exact header string (e.g., 'Content-Type: text/html')
      */
-    public static function hasHeader(string $name): bool
+    public static function has(string $header): bool
     {
-        return isset(self::$headers[strtolower($name)]);
+        return in_array($header, self::$headers, true);
     }
 
     /**
-     * Simulates PHP's `http_response_code()` function.
+     * Adds a header to the stack.
      *
-     * @return int|null The stored response code, or null if not set.
+     * @param string $header The header to add (e.g., 'Content-Type: text/html')
      */
-    public static function getResponseCode(): ?int
+    public static function push(string $header): void
     {
-        return self::$responseCode;
+        self::$headers[] = $header;
     }
 }

tests/_support/Mock/MockNativeHeaders.php

@@ -25,7 +25,7 @@
  */
 function headers_sent(): bool
 {
-    return NativeHeadersStack::headersSent();
+    return NativeHeadersStack::$headersSent;
 }
 
 /**
@@ -38,5 +38,5 @@ function headers_sent(): bool
  */
 function headers_list(): array
 {
-    return NativeHeadersStack::listHeaders();
+    return NativeHeadersStack::$headers;
 }

tests/system/Debug/ToolbarTest.php

@@ -113,7 +113,7 @@ public function testPrepareInjectsNormallyWithoutIgnoredHeader(): void
     public function testPrepareAbortsIfHeadersAlreadySent(): void
     {
         // Headers explicitly sent (e.g., echo before execution)
-        NativeHeadersStack::setHeadersSent(true);
+        NativeHeadersStack::$headersSent = true;
 
         $this->request  = service('incomingrequest', null, false);
         $this->response = service('response', null, false);
@@ -129,7 +129,7 @@ public function testPrepareAbortsIfHeadersAlreadySent(): void
     public function testPrepareAbortsIfNativeContentTypeIsNotHtml(): void
     {
         // A library (like Dompdf) set a PDF header directly
-        NativeHeadersStack::set('Content-Type: application/pdf');
+        NativeHeadersStack::push('Content-Type: application/pdf');
 
         $this->request  = service('incomingrequest', null, false);
         $this->response = service('response', null, false);
@@ -146,10 +146,10 @@ public function testPrepareAbortsIfNativeContentTypeIsNotHtml(): void
     public function testPrepareAbortsIfNativeContentDispositionIsAttachment(): void
     {
         // A file download (even if it is HTML)
-        NativeHeadersStack::pushMany([
+        NativeHeadersStack::$headers = [
             'Content-Type: text/html',
             'Content-Disposition: attachment; filename="report.html"',
-        ]);
+        ];
 
         $this->request  = service('incomingrequest', null, false);
         $this->response = service('response', null, false);
@@ -165,7 +165,7 @@ public function testPrepareAbortsIfNativeContentDispositionIsAttachment(): void
     public function testPrepareWorksWithNativeHtmlHeader(): void
     {
         // Standard scenario where PHP header is text/html
-        NativeHeadersStack::set('Content-Type: text/html; charset=UTF-8');
+        NativeHeadersStack::push('Content-Type: text/html; charset=UTF-8');
 
         $this->request  = service('incomingrequest', null, false);
         $this->response = service('response', null, false);