Merge pull request #58 from yiisoft/stream-output

Stream output
yiisoft · Mar 3, 2024 · e635091 · e635091
2 parents d3ceae2 + 172f226
commit e635091
Show file tree

Hide file tree

Showing 13 changed files with 161 additions and 70 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -26,6 +26,7 @@ jobs:
     uses: yiisoft/actions/.github/workflows/phpunit.yml@master
     with:
       extensions: sockets
+      ini-values: disable_functions="flush,header,http_response_code,headers_sent,header_remove"
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-

diff --git a/.github/workflows/mutation.yml b/.github/workflows/mutation.yml
@@ -23,6 +23,7 @@ jobs:
   mutation:
     uses: yiisoft/actions/.github/workflows/roave-infection.yml@master
     with:
+      ini-values: disable_functions="flush,header,http_response_code,headers_sent,header_remove"
       os: >-
         ['ubuntu-latest']
       php: >-

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 2.2.1 under development
 
-- no changes in this release.
+- Enh #58: Support stream output headers (@xepozz)
 
 ## 2.2.0 December 25, 2023
 

diff --git a/composer.json b/composer.json
@@ -50,6 +50,7 @@
         "roave/infection-static-analysis-plugin": "^1.25",
         "spatie/phpunit-watcher": "^1.23",
         "vimeo/psalm": "^4.30|^5.2",
+        "xepozz/internal-mocker": "^1.4",
         "yiisoft/middleware-dispatcher": "^5.0",
         "yiisoft/test-support": "^3.0"
     },
@@ -77,7 +78,7 @@
         }
     },
     "scripts": {
-        "test": "phpunit --testdox --no-interaction",
+        "test": "php -ddisable_functions=flush,header,http_response_code,headers_sent,header_remove ./vendor/bin/phpunit",
         "test-watch": "phpunit-watcher watch"
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -28,4 +28,8 @@
             <directory>./src</directory>
         </include>
     </coverage>
+
+    <extensions>
+        <extension class="Yiisoft\Yii\Runner\Http\Tests\Support\MockerExtension"/>
+    </extensions>
 </phpunit>
diff --git a/src/SapiEmitter.php b/src/SapiEmitter.php
@@ -10,6 +10,7 @@
 use Yiisoft\Yii\Runner\Http\Exception\HeadersHaveBeenSentException;
 
 use function flush;
+use function headers_sent;
 use function in_array;
 use function sprintf;
 
@@ -98,6 +99,13 @@ public function emit(ResponseInterface $response, bool $withoutBody = false): vo
             }
         }
 
+        /**
+         * Sends headers before the body.
+         * Makes a client possible to recognize the type of the body content if it is sent with a delay,
+         * for instance, for a streamed response.
+         */
+        flush();
+
         $this->emitBody($response);
     }
 
@@ -113,6 +121,9 @@ private function emitBody(ResponseInterface $response): void
         while (!$body->eof()) {
             $output = $body->read($this->bufferSize);
             if ($output === '') {
+                while (ob_get_level() > $level) {
+                    ob_end_flush();
+                }
                 continue;
             }
             echo $output;

diff --git a/tests/RequestFactoryTest.php b/tests/RequestFactoryTest.php
@@ -84,7 +84,7 @@ public function testInvalidMethodException(): void
         $requestFactory->create();
     }
 
-    public function bodyDataProvider(): array
+    public static function bodyDataProvider(): array
     {
         return [
             'string' => ['content', 'content'],
@@ -105,7 +105,7 @@ public function testBody(string $expected, ?string $body): void
         $this->assertSame($expected, (string) $request->getBody());
     }
 
-    public function hostParsingDataProvider(): array
+    public static function hostParsingDataProvider(): array
     {
         return [
             'host' => [
@@ -387,7 +387,7 @@ public function testHostParsingFromGlobals(array $serverParams, array $expectPar
         $this->assertSame($expectParams['query'], $request->getUri()->getQuery());
     }
 
-    public function dataPostInParsedBody(): array
+    public static function dataPostInParsedBody(): array
     {
         return [
             [

diff --git a/tests/SapiEmitterTest.php b/tests/SapiEmitterTest.php
@@ -4,8 +4,6 @@
 
 namespace Yiisoft\Yii\Runner\Http\Tests;
 
-include 'Support/Emitter/httpFunctionMocks.php';
-
 use HttpSoft\Message\Response;
 use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
@@ -32,7 +30,7 @@ public static function tearDownAfterClass(): void
         HTTPFunctions::reset();
     }
 
-    public function bufferSizeProvider(): array
+    public static function bufferSizeProvider(): array
     {
         return [[null], [1], [100], [1000]];
     }
@@ -56,7 +54,7 @@ public function testEmit(?int $bufferSize): void
         $this->expectOutputString($body);
     }
 
-    public function noBodyResponseCodeProvider(): array
+    public static function noBodyResponseCodeProvider(): array
     {
         return [[100], [101], [102], [204], [205], [304]];
     }
@@ -261,15 +259,30 @@ public function testObLevel(): void
         $this->assertSame($expectedLevel, $actualLevel);
     }
 
-    public function testExtraObLevel(): void
+    public static function dataExtraObLevel(): iterable
+    {
+        yield 'empty response' => [
+            '',
+            1,
+        ];
+        yield 'some response' => [
+            'Example body',
+            2,
+        ];
+    }
+
+    /**
+     * @dataProvider dataExtraObLevel
+     */
+    public function testExtraObLevel(string $responseBody, int $expectedFlushes): void
     {
         $expectedLevel = ob_get_level();
         $stream = $this->createMock(StreamInterface::class);
-        $stream->method('read')->willReturnCallback(static function () {
+        $stream->method('read')->willReturnCallback(static function () use ($responseBody) {
             ob_start();
             ob_start();
             ob_start();
-            return '-';
+            return $responseBody;
         });
         $stream->method('isReadable')->willReturn(true);
         $stream->method('eof')->willReturnOnConsecutiveCalls(false, true);
@@ -283,6 +296,41 @@ public function testExtraObLevel(): void
 
         $actualLevel = ob_get_level();
         $this->assertSame($expectedLevel, $actualLevel);
+        $this->assertSame($expectedFlushes, HTTPFunctions::getFlushTimes());
+    }
+
+    public function testFlushWithBody(): void
+    {
+        $stream = $this->createMock(StreamInterface::class);
+        $stream->method('read')->willReturnCallback(static fn() => '-');
+        $stream->method('isReadable')->willReturn(true);
+        $stream->method('eof')->willReturnOnConsecutiveCalls(false, true);
+        $response = $this->createResponse(Status::OK, ['X-Test' => 1])
+            ->withBody($stream);
+
+        $this
+            ->createEmitter()
+            ->emit($response);
+
+        $this->assertSame(['X-Test: 1'], HTTPFunctions::getHeader('X-Test'));
+        $this->assertSame(2, HTTPFunctions::getFlushTimes());
+    }
+
+    public function testFlushWithoutBody(): void
+    {
+        $stream = $this->createMock(StreamInterface::class);
+        $stream->method('isReadable')->willReturn(true);
+        $stream->method('eof')->willReturnOnConsecutiveCalls(true);
+        $response = $this->createResponse(Status::OK, ['X-Test' => 1])
+            ->withBody($stream)
+        ;
+
+        $this
+            ->createEmitter()
+            ->emit($response);
+
+        $this->assertSame(['X-Test: 1'], HTTPFunctions::getHeader('X-Test'));
+        $this->assertSame(1, HTTPFunctions::getFlushTimes());
     }
 
     private function createEmitter(?int $bufferSize = null): SapiEmitter

diff --git a/tests/ServerRequestFactoryTest.php b/tests/ServerRequestFactoryTest.php
@@ -91,7 +91,7 @@ public function testInvalidMethodException(): void
             ->createFromParameters([]);
     }
 
-    public function bodyDataProvider(): array
+    public static function bodyDataProvider(): array
     {
         $content = 'content';
         $resource = fopen('php://memory', 'wb+');
@@ -119,7 +119,7 @@ public function testBody(mixed $body, string $expected): void
         $this->assertSame($expected, (string) $request->getBody());
     }
 
-    public function invalidBodyDataProvider(): array
+    public static function invalidBodyDataProvider(): array
     {
         return [
             'int' => [1],
@@ -150,7 +150,7 @@ public function testInvalidBodyException(mixed $body): void
             ->createFromParameters($server, [], [], [], [], [], $body);
     }
 
-    public function hostParsingDataProvider(): array
+    public static function hostParsingDataProvider(): array
     {
         return [
             'host' => [

diff --git a/tests/Support/Emitter/HTTPFunctions.php b/tests/Support/Emitter/HTTPFunctions.php
@@ -23,6 +23,7 @@ final class HTTPFunctions
     private static string $headersSentFile = '';
     private static int $headersSentLine = 0;
     private static string $rawHttpHeader = '';
+    private static int $flushedTimes = 0;
 
     /**
      * Reset state
@@ -35,6 +36,7 @@ public static function reset(): void
         self::$headersSentFile = '';
         self::$headersSentLine = 0;
         self::$rawHttpHeader = '';
+        self::$flushedTimes = 0;
     }
 
     /**
@@ -60,7 +62,7 @@ public static function headers_sent(&$file = null, &$line = null): bool
     /**
      * Send a raw HTTP header
      */
-    public static function header(string $string, bool $replace = true, ?int $http_response_code = null): void
+    public static function header(string $string, bool $replace = true, ?int $http_response_code = 0): void
     {
         if (!str_starts_with($string, 'HTTP/')) {
             $header = strtolower(explode(':', $string, 2)[0]);
@@ -71,7 +73,7 @@ public static function header(string $string, bool $replace = true, ?int $http_r
         } else {
             self::$rawHttpHeader = $string;
         }
-        if ($http_response_code !== null) {
+        if ($http_response_code !== 0) {
             self::$responseCode = $http_response_code;
         }
     }
@@ -107,9 +109,9 @@ public static function headers_list(): array
     /**
      * Get or Set the HTTP response code
      */
-    public static function http_response_code(?int $response_code = null): int
+    public static function http_response_code(?int $response_code = 0): int
     {
-        if ($response_code !== null) {
+        if ($response_code !== 0) {
             self::$responseCode = $response_code;
         }
         return self::$responseCode;
@@ -127,4 +129,19 @@ public static function rawHttpHeader(): string
     {
         return self::$rawHttpHeader;
     }
+
+    public static function getHeader(string $header): array
+    {
+        return self::$headers[strtolower($header)] ?? [];
+    }
+
+    public static function flush(): void
+    {
+        self::$flushedTimes++;
+    }
+
+    public static function getFlushTimes(): int
+    {
+        return self::$flushedTimes;
+    }
 }
diff --git a/tests/Support/Emitter/HTTPFunctionsTest.php b/tests/Support/Emitter/HTTPFunctionsTest.php
@@ -4,8 +4,6 @@
 
 namespace Yiisoft\Yii\Runner\Http\Tests\Support\Emitter;
 
-include 'httpFunctionMocks.php';
-
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Http\Status;
 

diff --git a/tests/Support/Emitter/httpFunctionMocks.php b/tests/Support/Emitter/httpFunctionMocks.php