#15: "Out of memory" sending large files

Author: mekras

src/Client.php

@@ -123,6 +123,7 @@ public function sendRequest(RequestInterface $request)
         } catch (\Exception $e) {
             throw new RequestException($e->getMessage(), $request, $e);
         }
+
         return $response;
     }
 
@@ -161,6 +162,7 @@ public function sendAsyncRequest(RequestInterface $request)
      * @param RequestInterface $request
      *
      * @throws \UnexpectedValueException if unsupported HTTP version requested
+     * @throws \RuntimeException if can not read body
      *
      * @return array
      */
@@ -177,9 +179,23 @@ private function createCurlOptions(RequestInterface $request)
 
         if (in_array($request->getMethod(), ['OPTIONS', 'POST', 'PUT'], true)) {
             // cURL allows request body only for these methods.
-            $body = (string) $request->getBody();
-            if ('' !== $body) {
-                $options[CURLOPT_POSTFIELDS] = $body;
+            $body = $request->getBody();
+            $bodySize = $body->getSize();
+            if ($bodySize !== 0) {
+                // Message has non empty body.
+                if (null === $bodySize || $bodySize > 1024 * 1024) {
+                    // Avoid full loading large or unknown size body into memory
+                    $options[CURLOPT_UPLOAD] = true;
+                    if (null !== $bodySize) {
+                        $options[CURLOPT_INFILESIZE] = $bodySize;
+                    }
+                    $options[CURLOPT_READFUNCTION] = function ($ch, $fd, $length) use ($body) {
+                        return $body->read($length);
+                    };
+                } else {
+                    // Small body can be loaded into memory
+                    $options[CURLOPT_POSTFIELDS] = (string) $body;
+                }
             }
         }
 
@@ -221,6 +237,7 @@ private function getProtocolVersion($requestVersion)
                 }
                 throw new \UnexpectedValueException('libcurl 7.33 needed for HTTP 2.0 support');
         }
+
         return CURL_HTTP_VERSION_NONE;
     }
 
@@ -249,6 +266,7 @@ private function createHeaders(RequestInterface $request, array $options)
                 $curlHeaders[] = $name . ': ' . $value;
             }
         }
+
         return $curlHeaders;
     }
 }

tests/HttpClientDiactorosTest.php

@@ -5,8 +5,10 @@
 use Http\Client\HttpClient;
 use Http\Message\MessageFactory\DiactorosMessageFactory;
 use Http\Message\StreamFactory\DiactorosStreamFactory;
+use Psr\Http\Message\StreamInterface;
 use Zend\Diactoros\Request;
 use Zend\Diactoros\Response;
+use Zend\Diactoros\Stream;
 
 /**
  * Tests for Http\Client\Curl\Client
@@ -20,4 +22,16 @@ protected function createHttpAdapter()
     {
         return new Client(new DiactorosMessageFactory(), new DiactorosStreamFactory());
     }
+
+    /**
+     * Create stream from file
+     *
+     * @param string $filename
+     *
+     * @return StreamInterface
+     */
+    protected function createFileStream($filename)
+    {
+        return new Stream($filename);
+    }
 }

tests/HttpClientGuzzleTest.php

@@ -1,10 +1,12 @@
 <?php
 namespace Http\Client\Curl\Tests;
 
+use GuzzleHttp\Psr7\Stream;
 use Http\Client\Curl\Client;
 use Http\Client\HttpClient;
 use Http\Message\MessageFactory\GuzzleMessageFactory;
 use Http\Message\StreamFactory\GuzzleStreamFactory;
+use Psr\Http\Message\StreamInterface;
 
 /**
  * Tests for Http\Client\Curl\Client
@@ -18,4 +20,16 @@ protected function createHttpAdapter()
     {
         return new Client(new GuzzleMessageFactory(), new GuzzleStreamFactory());
     }
+
+    /**
+     * Create stream from file
+     *
+     * @param string $filename
+     *
+     * @return StreamInterface
+     */
+    protected function createFileStream($filename)
+    {
+        return new Stream(fopen($filename, 'r'));
+    }
 }

tests/HttpClientTestCase.php

@@ -2,12 +2,21 @@
 namespace Http\Client\Curl\Tests;
 
 use Http\Client\Tests\HttpClientTest;
+use Http\Client\Tests\PHPUnitUtility;
+use Psr\Http\Message\StreamInterface;
 
 /**
  * Base class for client integration tests
  */
 abstract class HttpClientTestCase extends HttpClientTest
 {
+    /**
+     * Temporary file name created by test.
+     *
+     * @var string[]
+     */
+    protected $tmpFiles = [];
+
     /**
      * @dataProvider requestProvider
      * @group        integration
@@ -51,4 +60,68 @@ public function testSendRequestWithOutcome(
             $body
         );
     }
+
+    /**
+     * Test sending large files.
+     */
+    public function testSendLargeFile()
+    {
+        $filename = $this->createTempFile();
+        $fd = fopen($filename, 'a');
+        $buffer = str_repeat('x', 1024);
+        for ($i = 0; $i < 2048; $i++) {
+            fwrite($fd, $buffer);
+        }
+        fclose($fd);
+        $body = $this->createFileStream($filename);
+
+        $request = self::$messageFactory->createRequest(
+            'POST',
+            PHPUnitUtility::getUri(),
+            [],
+            $body
+        );
+
+        $response = $this->httpAdapter->sendRequest($request);
+        $this->assertResponse(
+            $response,
+            [
+                'body' => 'Ok',
+            ]
+        );
+    }
+
+    /**
+     * Create temp file.
+     *
+     * @return string Filename
+     */
+    protected function createTempFile()
+    {
+        $filename = tempnam(sys_get_temp_dir(), 'tests');
+        $this->tmpFiles[] = $filename;
+
+        return $filename;
+    }
+
+    /**
+     * Create stream from file
+     *
+     * @param string $filename
+     *
+     * @return StreamInterface
+     */
+    abstract protected function createFileStream($filename);
+
+    /**
+     * Tears down the fixture
+     */
+    protected function tearDown()
+    {
+        parent::tearDown();
+
+        foreach ($this->tmpFiles as $filename) {
+            @unlink($filename);
+        }
+    }
 }