feature #37443 [HttpClient] add StreamableInterface to ease turning responses into PHP streams (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit d555112fbf1a · 2020-06-30T14:30:51.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [HttpClient] add StreamableInterface to ease turning responses into PHP streams | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | - | Tickets | - | License | MIT | Doc PR | - Commits ------- de103b3 [HttpClient] add StreamableInterface to ease turning responses into PHP streams
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added `AsyncDecoratorTrait` to ease processing responses without breaking async
  * added support for pausing responses with a new `pause_handler` callable exposed as an info item
+ * added `StreamableInterface` to ease turning responses into PHP streams
 
 5.1.0
 -----
diff --git a/src/Symfony/Component/HttpClient/Internal/HttplugWaitLoop.php b/src/Symfony/Component/HttpClient/Internal/HttplugWaitLoop.php
@@ -15,9 +15,8 @@
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
 use Psr\Http\Message\StreamFactoryInterface;
-use Symfony\Component\HttpClient\Response\CommonResponseTrait;
+use Symfony\Component\HttpClient\Response\StreamableInterface;
 use Symfony\Component\HttpClient\Response\StreamWrapper;
-use Symfony\Component\HttpClient\Response\TraceableResponse;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -120,7 +119,7 @@ public function createPsr7Response(ResponseInterface $response, bool $buffer = f
             }
         }
 
-        if ($response instanceof TraceableResponse || isset(class_uses($response)[CommonResponseTrait::class])) {
+        if ($response instanceof StreamableInterface) {
             $body = $this->streamFactory->createStreamFromResource($response->toStream(false));
         } elseif (!$buffer) {
             $body = $this->streamFactory->createStreamFromResource(StreamWrapper::createResource($response, $this->client));
diff --git a/src/Symfony/Component/HttpClient/Psr18Client.php b/src/Symfony/Component/HttpClient/Psr18Client.php
@@ -27,9 +27,8 @@
 use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriFactoryInterface;
 use Psr\Http\Message\UriInterface;
-use Symfony\Component\HttpClient\Response\CommonResponseTrait;
+use Symfony\Component\HttpClient\Response\StreamableInterface;
 use Symfony\Component\HttpClient\Response\StreamWrapper;
-use Symfony\Component\HttpClient\Response\TraceableResponse;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
@@ -105,7 +104,7 @@ public function sendRequest(RequestInterface $request): ResponseInterface
                 }
             }
 
-            $body = $response instanceof TraceableResponse || isset(class_uses($response)[CommonResponseTrait::class]) ? $response->toStream(false) : StreamWrapper::createResource($response, $this->client);
+            $body = $response instanceof StreamableInterface ? $response->toStream(false) : StreamWrapper::createResource($response, $this->client);
             $body = $this->streamFactory->createStreamFromResource($body);
 
             if ($body->isSeekable()) {
diff --git a/src/Symfony/Component/HttpClient/Response/AmpResponse.php b/src/Symfony/Component/HttpClient/Response/AmpResponse.php
@@ -33,7 +33,7 @@
  *
  * @internal
  */
-final class AmpResponse implements ResponseInterface
+final class AmpResponse implements ResponseInterface, StreamableInterface
 {
     use CommonResponseTrait;
     use TransportResponseTrait;
diff --git a/src/Symfony/Component/HttpClient/Response/AsyncResponse.php b/src/Symfony/Component/HttpClient/Response/AsyncResponse.php
@@ -25,7 +25,7 @@
  *
  * @author Nicolas Grekas <p@tchwork.com>
  */
-final class AsyncResponse implements ResponseInterface
+final class AsyncResponse implements ResponseInterface, StreamableInterface
 {
     use CommonResponseTrait;
 
@@ -95,7 +95,7 @@ public function toStream(bool $throw = true)
         }
 
         $handle = function () {
-            $stream = StreamWrapper::createResource($this->response);
+            $stream = $this->response instanceof StreamableInterface ? $this->response->toStream(false) : StreamWrapper::createResource($this->response);
 
             return stream_get_meta_data($stream)['wrapper_data']->stream_cast(STREAM_CAST_FOR_SELECT);
         };
diff --git a/src/Symfony/Component/HttpClient/Response/CommonResponseTrait.php b/src/Symfony/Component/HttpClient/Response/CommonResponseTrait.php
@@ -16,10 +16,6 @@
 use Symfony\Component\HttpClient\Exception\RedirectionException;
 use Symfony\Component\HttpClient\Exception\ServerException;
 use Symfony\Component\HttpClient\Exception\TransportException;
-use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
-use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
-use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
-use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 
 /**
  * Implements common logic for response classes.
@@ -123,14 +119,7 @@ public function toArray(bool $throw = true): array
     }
 
     /**
-     * Casts the response to a PHP stream resource.
-     *
-     * @return resource
-     *
-     * @throws TransportExceptionInterface   When a network error occurs
-     * @throws RedirectionExceptionInterface On a 3xx when $throw is true and the "max_redirects" option has been reached
-     * @throws ClientExceptionInterface      On a 4xx when $throw is true
-     * @throws ServerExceptionInterface      On a 5xx when $throw is true
+     * {@inheritdoc}
      */
     public function toStream(bool $throw = true)
     {
diff --git a/src/Symfony/Component/HttpClient/Response/CurlResponse.php b/src/Symfony/Component/HttpClient/Response/CurlResponse.php
@@ -25,7 +25,7 @@
  *
  * @internal
  */
-final class CurlResponse implements ResponseInterface
+final class CurlResponse implements ResponseInterface, StreamableInterface
 {
     use CommonResponseTrait {
         getContent as private doGetContent;
diff --git a/src/Symfony/Component/HttpClient/Response/MockResponse.php b/src/Symfony/Component/HttpClient/Response/MockResponse.php
@@ -23,7 +23,7 @@
  *
  * @author Nicolas Grekas <p@tchwork.com>
  */
-class MockResponse implements ResponseInterface
+class MockResponse implements ResponseInterface, StreamableInterface
 {
     use CommonResponseTrait;
     use TransportResponseTrait {
diff --git a/src/Symfony/Component/HttpClient/Response/NativeResponse.php b/src/Symfony/Component/HttpClient/Response/NativeResponse.php
@@ -24,7 +24,7 @@
  *
  * @internal
  */
-final class NativeResponse implements ResponseInterface
+final class NativeResponse implements ResponseInterface, StreamableInterface
 {
     use CommonResponseTrait;
     use TransportResponseTrait;
diff --git a/src/Symfony/Component/HttpClient/Response/StreamWrapper.php b/src/Symfony/Component/HttpClient/Response/StreamWrapper.php
@@ -49,7 +49,7 @@ class StreamWrapper
      */
     public static function createResource(ResponseInterface $response, HttpClientInterface $client = null)
     {
-        if ($response instanceof TraceableResponse || (\is_callable([$response, 'toStream']) && isset(class_uses($response)[CommonResponseTrait::class]))) {
+        if ($response instanceof StreamableInterface) {
             $stack = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT | DEBUG_BACKTRACE_IGNORE_ARGS, 2);
 
             if ($response !== ($stack[1]['object'] ?? null)) {
diff --git a/src/Symfony/Component/HttpClient/Response/StreamableInterface.php b/src/Symfony/Component/HttpClient/Response/StreamableInterface.php
@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpClient\Response;
+
+use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+
+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+interface StreamableInterface
+{
+    /**
+     * Casts the response to a PHP stream resource.
+     *
+     * @return resource
+     *
+     * @throws TransportExceptionInterface   When a network error occurs
+     * @throws RedirectionExceptionInterface On a 3xx when $throw is true and the "max_redirects" option has been reached
+     * @throws ClientExceptionInterface      On a 4xx when $throw is true
+     * @throws ServerExceptionInterface      On a 5xx when $throw is true
+     */
+    public function toStream(bool $throw = true);
+}
diff --git a/src/Symfony/Component/HttpClient/Response/TraceableResponse.php b/src/Symfony/Component/HttpClient/Response/TraceableResponse.php
@@ -27,7 +27,7 @@
  *
  * @internal
  */
-class TraceableResponse implements ResponseInterface
+class TraceableResponse implements ResponseInterface, StreamableInterface
 {
     private $client;
     private $response;
@@ -99,7 +99,7 @@ public function toStream(bool $throw = true)
             $this->response->getHeaders(true);
         }
 
-        if (\is_callable([$this->response, 'toStream'])) {
+        if ($this->response instanceof StreamableInterface) {
             return $this->response->toStream(false);
         }
 

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`*`
`34`	`34`	`* @internal`
`35`	`35`	`*/`
`36`		`-final class AmpResponse implements ResponseInterface`
	`36`	`+final class AmpResponse implements ResponseInterface, StreamableInterface`
`37`	`37`	`{`
`38`	`38`	`use CommonResponseTrait;`
`39`	`39`	`use TransportResponseTrait;`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`*`
`26`	`26`	`* @author Nicolas Grekas <p@tchwork.com>`
`27`	`27`	`*/`
`28`		`-final class AsyncResponse implements ResponseInterface`
	`28`	`+final class AsyncResponse implements ResponseInterface, StreamableInterface`
`29`	`29`	`{`
`30`	`30`	`use CommonResponseTrait;`
`31`	`31`
`@@ -95,7 +95,7 @@ public function toStream(bool $throw = true)`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`$handle = function () {`
`98`		`- $stream = StreamWrapper::createResource($this->response);`
	`98`	`+ $stream = $this->response instanceof StreamableInterface ? $this->response->toStream(false) : StreamWrapper::createResource($this->response);`
`99`	`99`
`100`	`100`	`return stream_get_meta_data($stream)['wrapper_data']->stream_cast(STREAM_CAST_FOR_SELECT);`
`101`	`101`	`};`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @author Nicolas Grekas <p@tchwork.com>`
`25`	`25`	`*/`
`26`		`-class MockResponse implements ResponseInterface`
	`26`	`+class MockResponse implements ResponseInterface, StreamableInterface`
`27`	`27`	`{`
`28`	`28`	`use CommonResponseTrait;`
`29`	`29`	`use TransportResponseTrait {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`*`
`25`	`25`	`* @internal`
`26`	`26`	`*/`
`27`		`-final class NativeResponse implements ResponseInterface`
	`27`	`+final class NativeResponse implements ResponseInterface, StreamableInterface`
`28`	`28`	`{`
`29`	`29`	`use CommonResponseTrait;`
`30`	`30`	`use TransportResponseTrait;`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class StreamWrapper`
`49`	`49`	`*/`
`50`	`50`	`public static function createResource(ResponseInterface $response, HttpClientInterface $client = null)`
`51`	`51`	`{`
`52`		`- if ($response instanceof TraceableResponse \|\| (\is_callable([$response, 'toStream']) && isset(class_uses($response)[CommonResponseTrait::class]))) {`
	`52`	`+ if ($response instanceof StreamableInterface) {`
`53`	`53`	`$stack = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT \| DEBUG_BACKTRACE_IGNORE_ARGS, 2);`
`54`	`54`
`55`	`55`	`if ($response !== ($stack[1]['object'] ?? null)) {`