[BC Break] Add requestTimeout option to be shared between REST/gRPC

src/BigQuery/Connection/Rest.php

@@ -254,8 +254,9 @@ private function resolveUploadOptions(array $args)
         unset($args['configuration']);
 
         $uploaderOptionKeys = [
-            'httpOptions',
+            'restOptions',
             'retries',
+            'requestTimeout',
             'metadata'
         ];
 

src/Core/GrpcRequestWrapper.php

@@ -98,6 +98,8 @@ public function __construct(array $config = [])
      * @param array $options [optional] {
      *     Request options.
      *
+     *     @type float $requestTimeout Seconds to wait before timing out the
+     *           request. **Defaults to** `60`.
      *     @type int $retries Number of retries for a failed request.
      *           **Defaults to** `3`.
      *     @type array $grpcOptions gRPC specific configuration options.
@@ -108,6 +110,7 @@ public function send(callable $request, array $args, array $options = [])
     {
         $retries = isset($options['retries']) ? $options['retries'] : $this->retries;
         $grpcOptions = isset($options['grpcOptions']) ? $options['grpcOptions'] : $this->grpcOptions;
+        $timeout = isset($options['requestTimeout']) ? $options['requestTimeout'] : $this->requestTimeout;
         $backoff = new ExponentialBackoff($retries, function (\Exception $ex) {
             $statusCode = $ex->getCode();
 
@@ -122,6 +125,10 @@ public function send(callable $request, array $args, array $options = [])
             $grpcOptions['retrySettings'] = new RetrySettings(null, null);
         }
 
+        if ($timeout && !array_key_exists('timeoutMs', $grpcOptions)) {
+            $grpcOptions['timeoutMs'] = $timeout * 1000;
+        }
+
         $optionalArgs = &$args[count($args) - 1];
         $optionalArgs += $grpcOptions;
 

src/Core/GrpcTrait.php

@@ -56,12 +56,13 @@ public function setRequestWrapper(GrpcRequestWrapper $requestWrapper)
      */
     public function send(callable $request, array $args)
     {
-        $requestOptions = $args[count($args) - 1];
+        $requestOptions = $this->pluckArray([
+            'grpcOptions',
+            'retries',
+            'requestTimeout'
+        ], $args[count($args) - 1]);
 
-        return $this->requestWrapper->send($request, $args, array_intersect_key($requestOptions, [
-            'grpcOptions' => null,
-            'retries' => null
-        ]));
+        return $this->requestWrapper->send($request, $args, $requestOptions);
     }
 
     /**

src/Core/RequestWrapper.php

@@ -58,7 +58,7 @@ class RequestWrapper
     /**
      * @var array HTTP client specific configuration options.
      */
-    private $httpOptions;
+    private $restOptions;
 
     /**
      * @var array
@@ -96,7 +96,7 @@ class RequestWrapper
      *     @type callable $authHttpHandler A handler used to deliver Psr7
      *           requests specifically for authentication.
      *     @type callable $httpHandler A handler used to deliver Psr7 requests.
-     *     @type array $httpOptions HTTP client specific configuration options.
+     *     @type array $restOptions HTTP client specific configuration options.
      *     @type bool $shouldSignRequest Whether to enable request signing.
      * }
      */
@@ -107,7 +107,7 @@ public function __construct(array $config = [])
             'accessToken' => null,
             'authHttpHandler' => null,
             'httpHandler' => null,
-            'httpOptions' => [],
+            'restOptions' => [],
             'shouldSignRequest' => true,
             'componentVersion' => null
         ];
@@ -116,7 +116,7 @@ public function __construct(array $config = [])
         $this->accessToken = $config['accessToken'];
         $this->httpHandler = $config['httpHandler'] ?: HttpHandlerFactory::build();
         $this->authHttpHandler = $config['authHttpHandler'] ?: $this->httpHandler;
-        $this->httpOptions = $config['httpOptions'];
+        $this->restOptions = $config['restOptions'];
         $this->shouldSignRequest = $config['shouldSignRequest'];
     }
 
@@ -127,20 +127,27 @@ public function __construct(array $config = [])
      * @param array $options [optional] {
      *     Request options.
      *
+     *     @type float $requestTimeout Seconds to wait before timing out the
+     *           request. **Defaults to** `0`.
      *     @type int $retries Number of retries for a failed request.
      *           **Defaults to** `3`.
-     *     @type array $httpOptions HTTP client specific configuration options.
+     *     @type array $restOptions HTTP client specific configuration options.
      * }
      * @return ResponseInterface
      */
     public function send(RequestInterface $request, array $options = [])
     {
         $retries = isset($options['retries']) ? $options['retries'] : $this->retries;
-        $httpOptions = isset($options['httpOptions']) ? $options['httpOptions'] : $this->httpOptions;
+        $restOptions = isset($options['restOptions']) ? $options['restOptions'] : $this->restOptions;
+        $timeout = isset($options['requestTimeout']) ? $options['requestTimeout'] : $this->requestTimeout;
         $backoff = new ExponentialBackoff($retries, $this->getRetryFunction());
 
+        if ($timeout && !array_key_exists('timeout', $restOptions)) {
+            $restOptions['timeout'] = $timeout;
+        }
+
         try {
-            return $backoff->execute($this->httpHandler, [$this->applyHeaders($request), $httpOptions]);
+            return $backoff->execute($this->httpHandler, [$this->applyHeaders($request), $restOptions]);
         } catch (\Exception $ex) {
             throw $this->convertToGoogleException($ex);
         }

src/Core/RequestWrapperTrait.php

@@ -50,6 +50,12 @@ trait RequestWrapperTrait
      */
     private $keyFile;
 
+    /**
+     * @var float Seconds to wait before timing out the request. **Defaults to**
+     *      `0` with REST and `60` with gRPC.
+     */
+    private $requestTimeout;
+
     /**
      * @var int Number of retries for a failed request. **Defaults to** `3`.
      */
@@ -74,6 +80,8 @@ trait RequestWrapperTrait
      *     @type array $keyFile The contents of the service account credentials
      *           .json file retrieved from the Google Developer's Console.
      *           Ex: `json_decode(file_get_contents($path), true)`.
+     *     @type float $requestTimeout Seconds to wait before timing out the
+     *           request. **Defaults to** `0` with REST and `60` with gRPC.
      *     @type int $retries Number of retries for a failed request.
      *           **Defaults to** `3`.
      *     @type array $scopes Scopes to be used for the request.
@@ -87,6 +95,7 @@ public function setCommonDefaults(array $config)
             'authCacheOptions' => [],
             'credentialsFetcher' => null,
             'keyFile' => null,
+            'requestTimeout' => null,
             'retries' => null,
             'scopes' => null
         ];

src/Core/RestTrait.php

@@ -22,6 +22,7 @@
  */
 trait RestTrait
 {
+    use ArrayTrait;
     use JsonTrait;
 
     /**
@@ -67,10 +68,11 @@ public function setRequestWrapper(RequestWrapper $requestWrapper)
      */
     public function send($resource, $method, array $options = [])
     {
-        $requestOptions = array_intersect_key($options, [
-            'httpOptions' => null,
-            'retries' => null
-        ]);
+        $requestOptions = $this->pluckArray([
+            'restOptions',
+            'retries',
+            'requestTimeout'
+        ], $options);
 
         return json_decode(
             $this->requestWrapper->send(

src/Core/Upload/AbstractUploader.php

@@ -78,7 +78,9 @@ abstract class AbstractUploader
      *     @type array $metadata Metadata on the resource.
      *     @type int $chunkSize Size of the chunks to send incrementally during
      *           a resumable upload. Must be in multiples of 262144 bytes.
-     *     @type array $httpOptions HTTP client specific configuration options.
+     *     @type array $restOptions HTTP client specific configuration options.
+     *     @type float $requestTimeout Seconds to wait before timing out the
+     *           request. **Defaults to** `0`.
      *     @type int $retries Number of retries for a failed request.
      *           **Defaults to** `3`.
      *     @type string $contentType Content type of the resource.
@@ -96,8 +98,9 @@ public function __construct(
         $this->metadata = isset($options['metadata']) ? $options['metadata'] : [];
         $this->chunkSize = isset($options['chunkSize']) ? $options['chunkSize'] : null;
         $this->requestOptions = array_intersect_key($options, [
-            'httpOptions' => null,
-            'retries' => null
+            'restOptions' => null,
+            'retries' => null,
+            'requestTimeout' => null
         ]);
 
         $this->contentType = isset($options['contentType'])

src/Storage/Connection/Rest.php

@@ -208,7 +208,7 @@ public function downloadObject(array $args = [])
         ];
 
         $requestOptions = array_intersect_key($args, [
-            'httpOptions' => null,
+            'restOptions' => null,
             'retries' => null
         ]);
 
@@ -297,8 +297,9 @@ private function resolveUploadOptions(array $args)
             : Psr7\mimetype_from_filename($args['metadata']['name']);
 
         $uploaderOptionKeys = [
-            'httpOptions',
+            'restOptions',
             'retries',
+            'requestTimeout',
             'chunkSize',
             'contentType',
             'metadata'

src/Storage/EncryptionTrait.php

@@ -70,10 +70,10 @@ public function formatEncryptionHeaders(array $options)
             + $this->buildHeaders($destinationKey, $destinationKeySHA256, false);
 
         if (!empty($encryptionHeaders)) {
-            if (isset($options['httpOptions']['headers'])) {
-                $options['httpOptions']['headers'] += $encryptionHeaders;
+            if (isset($options['restOptions']['headers'])) {
+                $options['restOptions']['headers'] += $encryptionHeaders;
             } else {
-                $options['httpOptions']['headers'] = $encryptionHeaders;
+                $options['restOptions']['headers'] = $encryptionHeaders;
             }
         }
 

src/Storage/StorageObject.php

@@ -513,7 +513,7 @@ public function rename($name, array $options = [])
 
         $this->delete(
             array_intersect_key($options, [
-                'httpOptions' => null,
+                'restOptions' => null,
                 'retries' => null
             ])
         );

src/Storage/StreamWrapper.php

@@ -166,7 +166,7 @@ public function stream_open($path, $mode, $flags, &$openedPath)
         } elseif ($mode == 'r') {
             try {
                 // Lazy read from the source
-                $options['httpOptions']['stream'] = true;
+                $options['restOptions']['stream'] = true;
                 $this->stream = new ReadStream(
                     $this->bucket->object($this->file)->downloadAsStream($options)
                 );

tests/unit/Core/GrpcRequestWrapperTest.php

@@ -45,12 +45,17 @@ public function setUp()
     public function testSuccessfullySendsRequest($response, $expectedMessage)
     {
         $requestWrapper = new GrpcRequestWrapper();
+        $requestOptions = [
+            'requestTimeout' => 3.5
+        ];
 
         $actualResponse = $requestWrapper->send(
-            function ($test) use ($response) {
+            function ($test, $options) use ($response, $requestOptions) {
+                $this->assertEquals($requestOptions['requestTimeout'] * 1000, $options['timeoutMs']);
                 return $response;
             },
-            ['test', []]
+            ['test', []],
+            $requestOptions
         );
 
         $this->assertEquals($expectedMessage, $actualResponse);

tests/unit/Core/GrpcTraitTest.php

@@ -62,6 +62,28 @@ public function testSendsRequest()
         $this->assertEquals($message, $actualResponse);
     }
 
+    public function testSendsRequestWithOptions()
+    {
+        $options = [
+            'requestTimeout' => 3.5,
+            'grpcOptions' => ['timeoutMs' => 100],
+            'retries' => 0
+        ];
+        $message = ['successful' => 'message'];
+        $this->requestWrapper->send(
+            Argument::type('callable'),
+            Argument::type('array'),
+            $options
+        )->willReturn($message);
+
+        $this->implementation->setRequestWrapper($this->requestWrapper->reveal());
+        $actualResponse = $this->implementation->send(function () {
+            return true;
+        }, [$options]);
+
+        $this->assertEquals($message, $actualResponse);
+    }
+
     public function testGetsGaxConfig()
     {
         $version = '1.0.0';

tests/unit/Core/RequestWrapperTest.php

@@ -37,16 +37,23 @@ public function testSuccessfullySendsRequest()
     {
         $expectedBody = 'responseBody';
         $response = new Response(200, [], $expectedBody);
+        $requestOptions = [
+            'restOptions' => ['debug' => true],
+            'requestTimeout' => 3.5
+        ];
 
         $requestWrapper = new RequestWrapper([
             'accessToken' => 'abc',
-            'httpHandler' => function ($request, $options = []) use ($response) {
+            'httpHandler' => function ($request, $options = []) use ($response, $requestOptions) {
+                $this->assertEquals($requestOptions['restOptions']['debug'], $options['debug']);
+                $this->assertEquals($requestOptions['requestTimeout'], $options['timeout']);
                 return $response;
             }
         ]);
 
         $actualResponse = $requestWrapper->send(
-            new Request('GET', 'http://www.test.com')
+            new Request('GET', 'http://www.test.com'),
+            $requestOptions
         );
 
         $this->assertEquals($expectedBody, (string) $actualResponse->getBody());

tests/unit/Core/RestTraitTest.php

@@ -57,17 +57,18 @@ public function testSendsRequest()
 
     public function testSendsRequestWithOptions()
     {
-        $httpOptions = [
-            'httpOptions' => ['debug' => true],
-            'retries' => 5
+        $restOptions = [
+            'restOptions' => ['debug' => true],
+            'retries' => 5,
+            'requestTimeout' => 3.5
         ];
         $responseBody = '{"whatAWonderful": "response"}';
-        $this->requestWrapper->send(Argument::any(), $httpOptions)
+        $this->requestWrapper->send(Argument::any(), $restOptions)
             ->willReturn(new Response(200, [], $responseBody));
 
         $this->implementation->setRequestBuilder($this->requestBuilder->reveal());
         $this->implementation->setRequestWrapper($this->requestWrapper->reveal());
-        $actualResponse = $this->implementation->send('resource', 'method', $httpOptions);
+        $actualResponse = $this->implementation->send('resource', 'method', $restOptions);
 
         $this->assertEquals(json_decode($responseBody, true), $actualResponse);
     }

tests/unit/Storage/Connection/RestTest.php

@@ -122,7 +122,7 @@ function ($args) use (&$actualRequest, $response) {
             'bucket' => 'bigbucket',
             'object' => 'myfile.txt',
             'generation' => 100,
-            'httpOptions' => ['debug' => true],
+            'restOptions' => ['debug' => true],
             'retries' => 0
         ]);