Merge pull request #167 from php-http/feature/seekable-stream

Add always seekable body plugin

Author: dbu

spec/Plugin/RequestSeekableBodyPluginSpec.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace spec\Http\Client\Common\Plugin;
+
+use Http\Client\Common\Plugin;
+use Http\Client\Common\Plugin\RequestSeekableBodyPlugin;
+use Http\Message\Stream\BufferedStream;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\StreamInterface;
+
+class RequestSeekableBodyPluginSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(RequestSeekableBodyPlugin::class);
+    }
+
+    public function it_is_a_plugin()
+    {
+        $this->shouldImplement(Plugin::class);
+    }
+
+    public function it_decorate_request_body_if_not_seekable(RequestInterface $request, StreamInterface $requestStream)
+    {
+        $request->getBody()->shouldBeCalled()->willReturn($requestStream);
+        $requestStream->isSeekable()->shouldBeCalled()->willReturn(false);
+        $requestStream->getSize()->willReturn(null);
+
+        $request->withBody(Argument::type(BufferedStream::class))->shouldBeCalled()->willReturn($request);
+
+        $this->handleRequest($request, PluginStub::next(), function () {});
+    }
+
+    public function it_does_not_decorate_request_body_if_seekable(RequestInterface $request, StreamInterface $requestStream)
+    {
+        $request->getBody()->shouldBeCalled()->willReturn($requestStream);
+        $requestStream->isSeekable()->shouldBeCalled()->willReturn(true);
+        $requestStream->getSize()->willReturn(null);
+
+        $request->withBody(Argument::type(BufferedStream::class))->shouldNotBeCalled();
+
+        $this->handleRequest($request, PluginStub::next(), function () {});
+    }
+}

spec/Plugin/ResponseSeekableBodyPluginSpec.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace spec\Http\Client\Common\Plugin;
+
+use GuzzleHttp\Psr7\Request;
+use Http\Client\Common\Plugin;
+use Http\Client\Common\Plugin\ResponseSeekableBodyPlugin;
+use Http\Client\Promise\HttpFulfilledPromise;
+use Http\Message\Stream\BufferedStream;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+
+class ResponseSeekableBodyPluginSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(ResponseSeekableBodyPlugin::class);
+    }
+
+    public function it_is_a_plugin()
+    {
+        $this->shouldImplement(Plugin::class);
+    }
+
+    public function it_decorate_response_body_if_not_seekable(ResponseInterface $response, StreamInterface $responseStream)
+    {
+        $next = function () use ($response) {
+            return new HttpFulfilledPromise($response->getWrappedObject());
+        };
+
+        $response->getBody()->shouldBeCalled()->willReturn($responseStream);
+        $responseStream->isSeekable()->shouldBeCalled()->willReturn(false);
+        $responseStream->getSize()->willReturn(null);
+
+        $response->withBody(Argument::type(BufferedStream::class))->shouldBeCalled()->willReturn($response);
+
+        $this->handleRequest(new Request('GET', '/'), $next, function () {});
+    }
+
+    public function it_does_not_decorate_response_body_if_seekable(ResponseInterface $response, StreamInterface $responseStream)
+    {
+        $next = function () use ($response) {
+            return new HttpFulfilledPromise($response->getWrappedObject());
+        };
+
+        $response->getBody()->shouldBeCalled()->willReturn($responseStream);
+        $responseStream->isSeekable()->shouldBeCalled()->willReturn(true);
+        $responseStream->getSize()->willReturn(null);
+
+        $response->withBody(Argument::type(BufferedStream::class))->shouldNotBeCalled();
+
+        $this->handleRequest(new Request('GET', '/'), $next, function () {});
+    }
+}

src/Plugin/RequestSeekableBodyPlugin.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Http\Client\Common\Plugin;
+
+use Http\Message\Stream\BufferedStream;
+use Http\Promise\Promise;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Allow body used in request to be always seekable.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
+final class RequestSeekableBodyPlugin extends SeekableBodyPlugin
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
+    {
+        if (!$request->getBody()->isSeekable()) {
+            $request = $request->withBody(new BufferedStream($request->getBody(), $this->useFileBuffer, $this->memoryBufferSize));
+        }
+
+        return $next($request);
+    }
+}

src/Plugin/ResponseSeekableBodyPlugin.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Http\Client\Common\Plugin;
+
+use Http\Message\Stream\BufferedStream;
+use Http\Promise\Promise;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Allow body used in response to be always seekable.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
+final class ResponseSeekableBodyPlugin extends SeekableBodyPlugin
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
+    {
+        return $next($request)->then(function (ResponseInterface $response) {
+            if ($response->getBody()->isSeekable()) {
+                return $response;
+            }
+
+            return $response->withBody(new BufferedStream($response->getBody(), $this->useFileBuffer, $this->memoryBufferSize));
+        });
+    }
+}

src/Plugin/SeekableBodyPlugin.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Http\Client\Common\Plugin;
+
+use Http\Client\Common\Plugin;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @internal
+ */
+abstract class SeekableBodyPlugin implements Plugin
+{
+    protected $useFileBuffer;
+
+    protected $memoryBufferSize;
+
+    /**
+     * @param array $config {
+     *
+     *    @var bool $use_file_buffer    Whether this plugin should use a file as a buffer if the stream is too big, defaults to true
+     *    @var int  $memory_buffer_size Max memory size in bytes to use for the buffer before it use a file, defaults to 2097152 (2 mb)
+     * }
+     */
+    public function __construct(array $config = [])
+    {
+        $resolver = new OptionsResolver();
+        $resolver->setDefaults([
+            'use_file_buffer' => true,
+            'memory_buffer_size' => 2097152,
+        ]);
+        $resolver->setAllowedTypes('use_file_buffer', 'bool');
+        $resolver->setAllowedTypes('memory_buffer_size', 'int');
+
+        $options = $resolver->resolve($config);
+
+        $this->useFileBuffer = $options['use_file_buffer'];
+        $this->memoryBufferSize = $options['memory_buffer_size'];
+    }
+}