Test Swoole response header value ownership

Exercise the full Hypervel response path over HTTP/1 and HTTP/2 with a dynamically built header value. Record the response after Swoole serializes it so the regression detects mutation of caller-owned string storage.

Skip the regressions on Swoole 6.3.0RC1 while retaining the exact expected value for releases containing the upstream fix.

Author: binaryfire

tests/Integration/HttpServer/Fixtures/server.php

@@ -13,6 +13,7 @@
 use Hypervel\HttpServer\Events\RequestHandled;
 use Hypervel\HttpServer\Events\RequestReceived;
 use Hypervel\HttpServer\Events\RequestTerminated;
+use Hypervel\HttpServer\Events\ResponseSent;
 use Hypervel\HttpServer\Server as HttpServer;
 use Hypervel\Routing\Router;
 use Hypervel\Server\Event;
@@ -125,6 +126,18 @@
             : null,
     ];
 });
+$events->listen(ResponseSent::class, function (ResponseSent $event) use ($state): void {
+    $token = $event->request?->query('token');
+
+    if ($event->request?->getPathInfo() !== '/response-header'
+        || ! is_string($token)
+        || $token === ''
+    ) {
+        return;
+    }
+
+    $state->responseHeaders[$token] = bin2hex($event->response->headers->get('X-Test'));
+});
 
 $filesystem = new Filesystem;
 $filesystem->ensureDirectoryExists(storage_path('app/private'));
@@ -181,6 +194,24 @@
 
     return $response;
 });
+$router->get('/response-header', function (): Response {
+    // Build the value at runtime so it has the same refcounted storage as application header values.
+    $value = implode('', ['value', "\t "]);
+
+    return new Response('response header', headers: ['X-Test' => $value]);
+});
+$router->get('/response-header-state', function (Request $request) use ($state): JsonResponse {
+    $token = $request->query('token');
+
+    if (! is_string($token) || $token === '') {
+        return new JsonResponse([]);
+    }
+
+    $value = $state->responseHeaders[$token] ?? null;
+    unset($state->responseHeaders[$token]);
+
+    return new JsonResponse(['value' => $value]);
+});
 $router->get('/callback-stream', fn (): Response => response()->stream(function (): void {
     echo 'callback-';
     echo 'stream';
@@ -268,6 +299,11 @@ class HttpServerIntegrationState
 
     public ?string $deletePath = null;
 
+    /**
+     * @var array<string, string>
+     */
+    public array $responseHeaders = [];
+
     /**
      * @var array<string, array<string, mixed>>
      */

tests/Integration/HttpServer/ResponseSerializationTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypervel\Tests\Integration\HttpServer;
+
+use Hypervel\Engine\Http\V2\Client as Http2Client;
+use Hypervel\Engine\Http\V2\Request as Http2Request;
+
+class ResponseSerializationTest extends HttpServerIntegrationTestCase
+{
+    public function testResponseSerializationDoesNotMutateHeaderValues(): void
+    {
+        // @TODO: Remove this skip once Swoole preserves response header values during serialization.
+        if (version_compare(SWOOLE_VERSION, '6.3.0RC1', '<=')) {
+            $this->markTestSkipped('Swoole mutates caller-owned response header values while serializing them.');
+        }
+
+        $token = bin2hex(random_bytes(8));
+        $this->request('GET', '/response-header?token=' . $token);
+        $state = $this->decode($this->request('GET', '/response-header-state?token=' . $token));
+
+        $this->assertSame(bin2hex("value\t "), $state['value']);
+    }
+
+    public function testHttpTwoResponseSerializationDoesNotMutateHeaderValues(): void
+    {
+        // @TODO: Remove this skip once Swoole preserves response header values during serialization.
+        if (version_compare(SWOOLE_VERSION, '6.3.0RC1', '<=')) {
+            $this->markTestSkipped('Swoole mutates caller-owned response header values while serializing them.');
+        }
+
+        $token = bin2hex(random_bytes(8));
+        $client = new Http2Client($this->getServerHost(), $this->getServerPort());
+
+        try {
+            $client->send(new Http2Request('/response-header?token=' . $token));
+            $response = $client->recv(5);
+        } finally {
+            $client->close();
+        }
+
+        $this->assertNotNull($response);
+        $state = $this->decode($this->request('GET', '/response-header-state?token=' . $token));
+        $this->assertSame(bin2hex("value\t "), $state['value']);
+    }
+}