[HttpClient] Transfer timeout

fancyweb · fancyweb · commit c5bfb73e386b · 2019-07-30T18:10:18.000+02:00
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * added support for NTLM authentication
  * added `$response->toStream()` to cast responses to regular PHP streams
  * made `Psr18Client` implement relevant PSR-17 factories and have streaming responses
+ * added `max_duration` option
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/HttpClient/CurlHttpClient.php b/src/Symfony/Component/HttpClient/CurlHttpClient.php
@@ -282,6 +282,10 @@ public function request(string $method, string $url, array $options = []): Respo
             $curlopts[file_exists($options['bindto']) ? CURLOPT_UNIX_SOCKET_PATH : CURLOPT_INTERFACE] = $options['bindto'];
         }
 
+        if (null !== $options['max_duration']) {
+            $curlopts[CURLOPT_TIMEOUT_MS] = 1000 * $options['max_duration'];
+        }
+
         $ch = curl_init();
 
         foreach ($curlopts as $opt => $value) {
diff --git a/src/Symfony/Component/HttpClient/HttpClientTrait.php b/src/Symfony/Component/HttpClient/HttpClientTrait.php
@@ -125,6 +125,7 @@ private static function prepareRequest(?string $method, ?string $url, array $opt
         $options['headers'] = $headers;
         $options['http_version'] = (string) ($options['http_version'] ?? '') ?: null;
         $options['timeout'] = (float) ($options['timeout'] ?? ini_get('default_socket_timeout'));
+        $options['max_duration'] = isset($options['max_duration']) ? (float) $options['max_duration'] : null;
 
         return [$url, $options];
     }
diff --git a/src/Symfony/Component/HttpClient/NativeHttpClient.php b/src/Symfony/Component/HttpClient/NativeHttpClient.php
@@ -110,10 +110,25 @@ public function request(string $method, string $url, array $options = []): Respo
             'debug' => \extension_loaded('curl') ? '' : "* Enable the curl extension for better performance\n",
         ];
 
+        $checkMaxDuration = null;
+        if (null !== $maxDuration = $options['max_duration']) {
+            $checkMaxDuration = static function() use ($maxDuration, &$info): void {
+                if ($info['total_time'] >= $maxDuration) {
+                    throw new TransportException(sprintf('Max duration was reached for "%s".', implode('', $info['url'])));
+                }
+            };
+        }
+
         if ($onProgress = $options['on_progress']) {
             // Memoize the last progress to ease calling the callback periodically when no network transfer happens
             $lastProgress = [0, 0];
-            $onProgress = static function (...$progress) use ($onProgress, &$lastProgress, &$info) {
+            $onProgress = static function (...$progress) use ($onProgress, &$lastProgress, &$info, $checkMaxDuration) {
+                if ($checkMaxDuration) {
+                    $info['total_time'] = microtime(true) - $info['start_time'];
+
+                    $checkMaxDuration();
+                }
+
                 $progressInfo = $info;
                 $progressInfo['url'] = implode('', $info['url']);
                 unset($progressInfo['size_body']);
@@ -127,10 +142,12 @@ public function request(string $method, string $url, array $options = []): Respo
 
                 $onProgress($lastProgress[0], $lastProgress[1], $progressInfo);
             };
+        } elseif ($checkMaxDuration) {
+            $onProgress = $checkMaxDuration;
         }
 
         // Always register a notification callback to compute live stats about the response
-        $notification = static function (int $code, int $severity, ?string $msg, int $msgCode, int $dlNow, int $dlSize) use ($onProgress, &$info) {
+        $notification = static function (int $code, int $severity, ?string $msg, int $msgCode, int $dlNow, int $dlSize) use ($onProgress, &$info, $checkMaxDuration) {
             $info['total_time'] = microtime(true) - $info['start_time'];
 
             if (STREAM_NOTIFY_PROGRESS === $code) {
@@ -142,6 +159,10 @@ public function request(string $method, string $url, array $options = []): Respo
                 $info['debug'] .= $info['request_header'];
                 unset($info['request_header']);
             } else {
+                if ($checkMaxDuration) {
+                    $checkMaxDuration();
+                }
+
                 return;
             }
 
@@ -166,6 +187,10 @@ public function request(string $method, string $url, array $options = []): Respo
             $options['request_headers'][] = 'user-agent: Symfony HttpClient/Native';
         }
 
+        if (null !== $options['max_duration']) {
+            $options['timeout'] = min($options['max_duration'], $options['timeout']);
+        }
+
         $context = [
             'http' => [
                 'protocol_version' => $options['http_version'] ?: '1.1',
diff --git a/src/Symfony/Component/HttpClient/Tests/MockHttpClientTest.php b/src/Symfony/Component/HttpClient/Tests/MockHttpClientTest.php
@@ -123,6 +123,19 @@ protected function getHttpClient(string $testCase): HttpClientInterface
                 $body = ['<1>', '', '<2>'];
                 $responses[] = new MockResponse($body, ['response_headers' => $headers]);
                 break;
+
+            case 'testMaxDuration':
+                $mock = $this->getMockBuilder(ResponseInterface::class)->getMock();
+                $mock->expects($this->any())
+                    ->method('getContent')
+                    ->willReturnCallback(static function (): void {
+                        usleep(100000);
+
+                        throw new TransportException('Max duration was reached.');
+                    });
+
+                $responses[] = $mock;
+                break;
         }
 
         return new MockHttpClient($responses);
diff --git a/src/Symfony/Component/HttpClient/composer.json b/src/Symfony/Component/HttpClient/composer.json
@@ -22,7 +22,7 @@
     "require": {
         "php": "^7.1.3",
         "psr/log": "^1.0",
-        "symfony/http-client-contracts": "^1.1.4",
+        "symfony/http-client-contracts": "^1.1.5",
         "symfony/polyfill-php73": "^1.11"
     },
     "require-dev": {
diff --git a/src/Symfony/Contracts/HttpClient/HttpClientInterface.php b/src/Symfony/Contracts/HttpClient/HttpClientInterface.php
@@ -53,6 +53,7 @@ interface HttpClientInterface
         'proxy' => null,        // string - by default, the proxy-related env vars handled by curl SHOULD be honored
         'no_proxy' => null,     // string - a comma separated list of hosts that do not require a proxy to be reached
         'timeout' => null,      // float - the inactivity timeout - defaults to ini_get('default_socket_timeout')
+        'max_duration' => null, // float - the maximum execution time of the whole request (including the connection time)
         'bindto' => '0',        // string - the interface or the local socket to bind to
         'verify_peer' => true,  // see https://php.net/context.ssl for the following options
         'verify_host' => true,
diff --git a/src/Symfony/Contracts/HttpClient/Test/Fixtures/web/index.php b/src/Symfony/Contracts/HttpClient/Test/Fixtures/web/index.php
@@ -132,6 +132,16 @@
         header('Content-Encoding: gzip');
         echo str_repeat('-', 1000);
         exit;
+
+    case '/max-duration':
+        ignore_user_abort(false);
+        while (true) {
+            echo '<1>';
+            @ob_flush();
+            flush();
+            usleep(500);
+        }
+        exit;
 }
 
 header('Content-Type: application/json', true);
diff --git a/src/Symfony/Contracts/HttpClient/Test/HttpClientTestCase.php b/src/Symfony/Contracts/HttpClient/Test/HttpClientTestCase.php
@@ -778,4 +778,25 @@ public function testGzipBroken()
         $this->expectException(TransportExceptionInterface::class);
         $response->getContent();
     }
+
+    public function testMaxDuration()
+    {
+        $client = $this->getHttpClient(__FUNCTION__);
+        $response = $client->request('GET', 'http://localhost:8057/max-duration', [
+            'max_duration' => 0.1,
+        ]);
+
+        $start = microtime(true);
+
+        try {
+            $response->getContent();
+        } catch (TransportExceptionInterface $e) {
+            $this->addToAssertionCount(1);
+        }
+
+        $duration = microtime(true) - $start;
+
+        $this->assertGreaterThanOrEqual(0.1, $duration);
+        $this->assertLessThan(0.2, $duration);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -282,6 +282,10 @@ public function request(string $method, string $url, array $options = []): Respo`
`282`	`282`	`$curlopts[file_exists($options['bindto']) ? CURLOPT_UNIX_SOCKET_PATH : CURLOPT_INTERFACE] = $options['bindto'];`
`283`	`283`	`}`
`284`	`284`
	`285`	`+ if (null !== $options['max_duration']) {`
	`286`	`+ $curlopts[CURLOPT_TIMEOUT_MS] = 1000 * $options['max_duration'];`
	`287`	`+ }`
	`288`	`+`
`285`	`289`	`$ch = curl_init();`
`286`	`290`
`287`	`291`	`foreach ($curlopts as $opt => $value) {`
Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,7 @@ private static function prepareRequest(?string $method, ?string $url, array $opt`
`125`	`125`	`$options['headers'] = $headers;`
`126`	`126`	`$options['http_version'] = (string) ($options['http_version'] ?? '') ?: null;`
`127`	`127`	`$options['timeout'] = (float) ($options['timeout'] ?? ini_get('default_socket_timeout'));`
	`128`	`+ $options['max_duration'] = isset($options['max_duration']) ? (float) $options['max_duration'] : null;`
`128`	`129`
`129`	`130`	`return [$url, $options];`
`130`	`131`	`}`