feature symfony#66 Add support for streamed Symfony request (Ekman)

This PR was squashed before being merged into the 1.2-dev branch.

Discussion
----------

Add support for streamed Symfony request

As a continuation of #3 and symfony#50 . Add support for converting a `ServerRequestInterface` with a large body to a Symfony request.

I'm not all too familiar with Symfony components, but I saw that a Symfony request supports `string|resource|null` as its body. Since calling `detach()` on a `StreamInterface` will make the stream unsuable I added a `$streamed` argument to the function in order to not make break any existing code, and to make it a conscious decision of the caller to stream the response.

I'm happy to make any necessary changes if needed.

Commits
-------

df26630 Add support for streamed Symfony request

Author: nicolas-grekas

Factory/DiactorosFactory.php

@@ -84,8 +84,6 @@ public function createRequest(Request $symfonyRequest)
     /**
      * Converts Symfony uploaded files array to the PSR one.
      *
-     * @param array $uploadedFiles
-     *
      * @return array
      */
     private function getFiles(array $uploadedFiles)
@@ -110,8 +108,6 @@ private function getFiles(array $uploadedFiles)
     /**
      * Creates a PSR-7 UploadedFile instance from a Symfony one.
      *
-     * @param UploadedFile $symfonyUploadedFile
-     *
      * @return UploadedFileInterface
      */
     private function createUploadedFile(UploadedFile $symfonyUploadedFile)

Factory/HttpFoundationFactory.php

@@ -43,7 +43,7 @@ public function __construct(int $responseBufferMaxLength = 16372)
     /**
      * {@inheritdoc}
      */
-    public function createRequest(ServerRequestInterface $psrRequest)
+    public function createRequest(ServerRequestInterface $psrRequest, bool $streamed = false)
     {
         $server = [];
         $uri = $psrRequest->getUri();
@@ -69,7 +69,7 @@ public function createRequest(ServerRequestInterface $psrRequest)
             $psrRequest->getCookieParams(),
             $this->getFiles($psrRequest->getUploadedFiles()),
             $server,
-            $psrRequest->getBody()->__toString()
+            $streamed ? $psrRequest->getBody()->detach() : $psrRequest->getBody()->__toString()
         );
         $request->headers->replace($psrRequest->getHeaders());
 
@@ -79,8 +79,6 @@ public function createRequest(ServerRequestInterface $psrRequest)
     /**
      * Converts to the input array to $_FILES structure.
      *
-     * @param array $uploadedFiles
-     *
      * @return array
      */
     private function getFiles(array $uploadedFiles)
@@ -101,8 +99,6 @@ private function getFiles(array $uploadedFiles)
     /**
      * Creates Symfony UploadedFile instance from PSR-7 ones.
      *
-     * @param UploadedFileInterface $psrUploadedFile
-     *
      * @return UploadedFile
      */
     private function createUploadedFile(UploadedFileInterface $psrUploadedFile)
@@ -183,13 +179,11 @@ public function createResponse(ResponseInterface $psrResponse, bool $streamed =
      *
      * Some snippets have been taken from the Guzzle project: https://github.com/guzzle/guzzle/blob/5.3/src/Cookie/SetCookie.php#L34
      *
-     * @param string $cookie
-     *
      * @return Cookie
      *
      * @throws \InvalidArgumentException
      */
-    private function createCookie($cookie)
+    private function createCookie(string $cookie)
     {
         foreach (explode(';', $cookie) as $part) {
             $part = trim($part);

Factory/PsrHttpFactory.php

@@ -78,8 +78,6 @@ public function createRequest(Request $symfonyRequest)
     /**
      * Converts Symfony uploaded files array to the PSR one.
      *
-     * @param array $uploadedFiles
-     *
      * @return array
      */
     private function getFiles(array $uploadedFiles)
@@ -104,8 +102,6 @@ private function getFiles(array $uploadedFiles)
     /**
      * Creates a PSR-7 UploadedFile instance from a Symfony one.
      *
-     * @param UploadedFile $symfonyUploadedFile
-     *
      * @return UploadedFileInterface
      */
     private function createUploadedFile(UploadedFile $symfonyUploadedFile)

HttpFoundationFactoryInterface.php

@@ -26,18 +26,14 @@ interface HttpFoundationFactoryInterface
     /**
      * Creates a Symfony Request instance from a PSR-7 one.
      *
-     * @param ServerRequestInterface $psrRequest
-     *
      * @return Request
      */
-    public function createRequest(ServerRequestInterface $psrRequest);
+    public function createRequest(ServerRequestInterface $psrRequest, bool $streamed = false);
 
     /**
      * Creates a Symfony Response instance from a PSR-7 one.
      *
-     * @param ResponseInterface $psrResponse
-     *
      * @return Response
      */
-    public function createResponse(ResponseInterface $psrResponse);
+    public function createResponse(ResponseInterface $psrResponse, bool $streamed = false);
 }

HttpMessageFactoryInterface.php

@@ -26,17 +26,13 @@ interface HttpMessageFactoryInterface
     /**
      * Creates a PSR-7 Request instance from a Symfony one.
      *
-     * @param Request $symfonyRequest
-     *
      * @return ServerRequestInterface
      */
     public function createRequest(Request $symfonyRequest);
 
     /**
      * Creates a PSR-7 Response instance from a Symfony one.
      *
-     * @param Response $symfonyResponse
-     *
      * @return ResponseInterface
      */
     public function createResponse(Response $symfonyResponse);

Tests/Factory/HttpFoundationFactoryTest.php

@@ -85,6 +85,27 @@ public function testCreateRequest()
         $this->assertEquals(['a', 'b'], $symfonyRequest->headers->all('X-data'));
     }
 
+    public function testCreateRequestWithStreamedBody()
+    {
+        $serverRequest = new ServerRequest(
+            '1.1',
+            [],
+            new Stream('The body'),
+            '/',
+            'GET',
+            null,
+            [],
+            [],
+            [],
+            [],
+            null,
+            []
+        );
+
+        $symfonyRequest = $this->factory->createRequest($serverRequest, true);
+        $this->assertEquals('The body', $symfonyRequest->getContent());
+    }
+
     public function testCreateRequestWithNullParsedBody()
     {
         $serverRequest = new ServerRequest(

Tests/Fixtures/Stream.php

@@ -37,6 +37,7 @@ public function close()
 
     public function detach()
     {
+        return fopen('data://text/plain,'.$this->stringContent, 'r');
     }
 
     public function getSize()