feature #50 Add support for streamed response (danizord)

nicolas-grekas · nicolas-grekas · commit c1cb51c717e5 · 2019-03-11T19:22:11.000+01:00
This PR was merged into the 1.2-dev branch. Discussion ---------- Add support for streamed response Here's a simple implementation of response streaming heavily inspired by Diactoros' response emitter, using HttpFoundation's `StreamedResponse`. It lacks support for `Content-Range`, but I can provide that in a future PR. Closes https://github.com/symfony/psr-http-message-bridge/issues/3 Commits ------- 7cc1605 Add support for streamed response
diff --git a/Factory/HttpFoundationFactory.php b/Factory/HttpFoundationFactory.php
@@ -13,13 +13,15 @@
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UploadedFileInterface;
 use Psr\Http\Message\UriInterface;
 use Symfony\Bridge\PsrHttpMessage\HttpFoundationFactoryInterface;
 use Symfony\Component\HttpFoundation\Cookie;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 
 /**
  * {@inheritdoc}
@@ -28,6 +30,16 @@
  */
 class HttpFoundationFactory implements HttpFoundationFactoryInterface
 {
+    /**
+     * @var int The maximum output buffering size for each iteration when sending the response
+     */
+    private $responseBufferMaxLength;
+
+    public function __construct(int $responseBufferMaxLength = 16372)
+    {
+        $this->responseBufferMaxLength = $responseBufferMaxLength;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -138,16 +150,25 @@ protected function getTemporaryPath()
     /**
      * {@inheritdoc}
      */
-    public function createResponse(ResponseInterface $psrResponse)
+    public function createResponse(ResponseInterface $psrResponse, bool $streamed = false)
     {
         $cookies = $psrResponse->getHeader('Set-Cookie');
         $psrResponse = $psrResponse->withoutHeader('Set-Cookie');
 
-        $response = new Response(
-            $psrResponse->getBody()->__toString(),
-            $psrResponse->getStatusCode(),
-            $psrResponse->getHeaders()
-        );
+        if ($streamed) {
+            $response = new StreamedResponse(
+                $this->createStreamedResponseCallback($psrResponse->getBody()),
+                $psrResponse->getStatusCode(),
+                $psrResponse->getHeaders()
+            );
+        } else {
+            $response = new Response(
+                $psrResponse->getBody()->__toString(),
+                $psrResponse->getStatusCode(),
+                $psrResponse->getHeaders()
+            );
+        }
+
         $response->setProtocolVersion($psrResponse->getProtocolVersion());
 
         foreach ($cookies as $cookie) {
@@ -237,4 +258,23 @@ private function createCookie($cookie)
             isset($samesite) ? $samesite : null
         );
     }
+
+    private function createStreamedResponseCallback(StreamInterface $body): callable
+    {
+        return function () use ($body) {
+            if ($body->isSeekable()) {
+                $body->rewind();
+            }
+
+            if (!$body->isReadable()) {
+                echo $body;
+
+                return;
+            }
+
+            while (!$body->eof()) {
+                echo $body->read($this->responseBufferMaxLength);
+            }
+        };
+    }
 }
diff --git a/Tests/Factory/HttpFoundationFactoryTest.php b/Tests/Factory/HttpFoundationFactoryTest.php
@@ -237,5 +237,14 @@ public function testCreateResponse()
 
         $this->assertEquals('The response body', $symfonyResponse->getContent());
         $this->assertEquals(200, $symfonyResponse->getStatusCode());
+
+        $symfonyResponse = $this->factory->createResponse($response, true);
+
+        ob_start();
+        $symfonyResponse->sendContent();
+        $sentContent = ob_get_clean();
+
+        $this->assertEquals('The response body', $sentContent);
+        $this->assertEquals(200, $symfonyResponse->getStatusCode());
     }
 }
diff --git a/Tests/Fixtures/Stream.php b/Tests/Fixtures/Stream.php
@@ -19,6 +19,7 @@
 class Stream implements StreamInterface
 {
     private $stringContent;
+    private $eof = true;
 
     public function __construct($stringContent = '')
     {
@@ -49,12 +50,12 @@ public function tell()
 
     public function eof()
     {
-        return true;
+        return $this->eof;
     }
 
     public function isSeekable()
     {
-        return false;
+        return true;
     }
 
     public function seek($offset, $whence = SEEK_SET)
@@ -63,6 +64,7 @@ public function seek($offset, $whence = SEEK_SET)
 
     public function rewind()
     {
+        $this->eof = false;
     }
 
     public function isWritable()
@@ -81,6 +83,8 @@ public function isReadable()
 
     public function read($length)
     {
+        $this->eof = true;
+
         return $this->stringContent;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -237,5 +237,14 @@ public function testCreateResponse()`
`237`	`237`
`238`	`238`	`$this->assertEquals('The response body', $symfonyResponse->getContent());`
`239`	`239`	`$this->assertEquals(200, $symfonyResponse->getStatusCode());`
	`240`	`+`
	`241`	`+ $symfonyResponse = $this->factory->createResponse($response, true);`
	`242`	`+`
	`243`	`+ ob_start();`
	`244`	`+ $symfonyResponse->sendContent();`
	`245`	`+ $sentContent = ob_get_clean();`
	`246`	`+`
	`247`	`+ $this->assertEquals('The response body', $sentContent);`
	`248`	`+ $this->assertEquals(200, $symfonyResponse->getStatusCode());`
`240`	`249`	`}`
`241`	`250`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`class Stream implements StreamInterface`
`20`	`20`	`{`
`21`	`21`	`private $stringContent;`
	`22`	`+ private $eof = true;`
`22`	`23`
`23`	`24`	`public function __construct($stringContent = '')`
`24`	`25`	`{`
`@@ -49,12 +50,12 @@ public function tell()`
`49`	`50`
`50`	`51`	`public function eof()`
`51`	`52`	`{`
`52`		`- return true;`
	`53`	`+ return $this->eof;`
`53`	`54`	`}`
`54`	`55`
`55`	`56`	`public function isSeekable()`
`56`	`57`	`{`
`57`		`- return false;`
	`58`	`+ return true;`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`public function seek($offset, $whence = SEEK_SET)`
`@@ -63,6 +64,7 @@ public function seek($offset, $whence = SEEK_SET)`
`63`	`64`
`64`	`65`	`public function rewind()`
`65`	`66`	`{`
	`67`	`+ $this->eof = false;`
`66`	`68`	`}`
`67`	`69`
`68`	`70`	`public function isWritable()`
`@@ -81,6 +83,8 @@ public function isReadable()`
`81`	`83`
`82`	`84`	`public function read($length)`
`83`	`85`	`{`
	`86`	`+ $this->eof = true;`
	`87`	`+`
`84`	`88`	`return $this->stringContent;`
`85`	`89`	`}`
`86`	`90`