Option for ignoring the Content-Range header

When the response body has already been limited to the requested range, the emitter should ignore the Content-Range header and emit the full response body.

Signed-off-by: Stadly <magnar@myrtveit.com>

Author: Stadly

src/Emitter/SapiStreamEmitter.php

@@ -21,9 +21,13 @@ class SapiStreamEmitter implements EmitterInterface
     /** @var int Maximum output buffering size for each iteration. */
     private $maxBufferLength;
 
-    public function __construct(int $maxBufferLength = 8192)
+    /** @var bool Emit the full response body regardless of the Content-Range header. */
+    private $ignoreContentRange;
+
+    public function __construct(int $maxBufferLength = 8192, bool $ignoreContentRange = false)
     {
-        $this->maxBufferLength = $maxBufferLength;
+        $this->maxBufferLength    = $maxBufferLength;
+        $this->ignoreContentRange = $ignoreContentRange;
     }
 
     /**
@@ -40,7 +44,7 @@ public function emit(ResponseInterface $response): bool
 
         flush();
 
-        $range = $this->parseContentRange($response->getHeaderLine('Content-Range'));
+        $range = $this->ignoreContentRange ? null : $this->parseContentRange($response->getHeaderLine('Content-Range'));
 
         if (null === $range || 'bytes' !== $range[0]) {
             $this->emitBody($response);

test/Emitter/SapiStreamEmitterTest.php

@@ -35,10 +35,14 @@
  */
 class SapiStreamEmitterTest extends AbstractEmitterTest
 {
+    /** @var SapiStreamEmitter */
+    private $emitterIgnoreContentRange;
+
     public function setUp(): void
     {
         HeaderStack::reset();
-        $this->emitter = new SapiStreamEmitter();
+        $this->emitter                   = new SapiStreamEmitter();
+        $this->emitterIgnoreContentRange = new SapiStreamEmitter(8192, true);
     }
 
     public function testEmitCallbackStreamResponse(): void
@@ -593,6 +597,18 @@ public function contentRangeProvider(): array
         ];
     }
 
+    /**
+     * @psalm-return array<array-key, array{0: string, 1: string, 2: string}>
+     */
+    public function ignoreContentRangeProvider(): array
+    {
+        return [
+            ['bytes 0-2/*', 'Hel', 'Hel'],
+            ['bytes 3-6/*', 'lo w', 'lo w'],
+            ['items 0-0/1', 'Hello world', 'Hello world'],
+        ];
+    }
+
     /**
      * @dataProvider contentRangeProvider
      */
@@ -608,6 +624,21 @@ public function testContentRange(string $header, string $body, string $expected)
         self::assertSame($expected, ob_get_clean());
     }
 
+    /**
+     * @dataProvider ignoreContentRangeProvider
+     */
+    public function testIgnoreContentRange(string $header, string $body, string $expected): void
+    {
+        $response = (new Response())
+            ->withHeader('Content-Range', $header);
+
+        $response->getBody()->write($body);
+
+        ob_start();
+        $this->emitterIgnoreContentRange->emit($response);
+        self::assertSame($expected, ob_get_clean());
+    }
+
     public function testContentRangeUnseekableBody(): void
     {
         $body     = new CallbackStream(function () {