[HttpClient] allow option "buffer" to be a stream resource

Author: nicolas-grekas

HttpClientInterface.php

@@ -45,7 +45,9 @@ interface HttpClientInterface
                                 //   NOT follow except for the initial host name
         'http_version' => null, // string - defaults to the best supported version, typically 1.1 or 2.0
         'base_uri' => null,     // string - the URI to resolve relative URLs, following rules in RFC 3986, section 2
-        'buffer' => true,       // bool - whether the content of the response should be buffered or not
+        'buffer' => true,       // bool|resource|\Closure - whether the content of the response should be buffered or not,
+                                //   or a stream resource where the response body should be written,
+                                //   or a closure telling if/where the response should be buffered based on its headers
         'on_progress' => null,  // callable(int $dlNow, int $dlSize, array $info) - throwing any exceptions MUST abort
                                 //   the request; it MUST be called on DNS resolution, on arrival of headers and on
                                 //   completion; it SHOULD be called on upload/download of data and at least 1/s

Test/HttpClientTestCase.php

@@ -87,6 +87,70 @@ public function testNonBufferedGetRequest()
         $response->getContent();
     }
 
+    public function testBufferSink()
+    {
+        $sink = fopen('php://temp', 'w+');
+        $client = $this->getHttpClient(__FUNCTION__);
+        $response = $client->request('GET', 'http://localhost:8057', [
+            'buffer' => $sink,
+            'headers' => ['Foo' => 'baR'],
+        ]);
+
+        $body = $response->toArray();
+        $this->assertSame('baR', $body['HTTP_FOO']);
+
+        rewind($sink);
+        $sink = stream_get_contents($sink);
+        $this->assertSame($sink, $response->getContent());
+    }
+
+    public function testConditionalBuffering()
+    {
+        $client = $this->getHttpClient(__FUNCTION__);
+        $response = $client->request('GET', 'http://localhost:8057');
+        $firstContent = $response->getContent();
+        $secondContent = $response->getContent();
+
+        $this->assertSame($firstContent, $secondContent);
+
+        $response = $client->request('GET', 'http://localhost:8057', ['buffer' => function () { return false; }]);
+        $response->getContent();
+
+        $this->expectException(TransportExceptionInterface::class);
+        $response->getContent();
+    }
+
+    public function testReentrantBufferCallback()
+    {
+        $client = $this->getHttpClient(__FUNCTION__);
+
+        $response = $client->request('GET', 'http://localhost:8057', ['buffer' => function () use (&$response) {
+            $response->cancel();
+
+            return true;
+        }]);
+
+        $this->assertSame(200, $response->getStatusCode());
+
+        $this->expectException(TransportExceptionInterface::class);
+        $response->getContent();
+    }
+
+    public function testThrowingBufferCallback()
+    {
+        $client = $this->getHttpClient(__FUNCTION__);
+
+        $response = $client->request('GET', 'http://localhost:8057', ['buffer' => function () {
+            throw new \Exception('Boo');
+        }]);
+
+        $this->assertSame(200, $response->getStatusCode());
+
+        $this->expectException(TransportExceptionInterface::class);
+        $this->expectExceptionMessage('Boo');
+        $response->getContent();
+    }
+
     public function testUnsupportedOption()
     {
         $client = $this->getHttpClient(__FUNCTION__);