feature #32807 [HttpClient] add "max_duration" option (fancyweb)

nicolas-grekas · nicolas-grekas · commit c38ef60c9a47 · 2019-08-06T10:45:25.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpClient] add "max_duration" option | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#32765 | License | MIT | Doc PR | symfony/symfony-docs#12073 Commits ------- a4178f1369 [HttpClient] add "max_duration" option
diff --git a/CHANGELOG.md b/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/CurlHttpClient.php b/CurlHttpClient.php
@@ -284,6 +284,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 (0 < $options['max_duration']) {
+            $curlopts[CURLOPT_TIMEOUT_MS] = 1000 * $options['max_duration'];
+        }
+
         $ch = curl_init();
 
         foreach ($curlopts as $opt => $value) {
diff --git a/HttpClientTrait.php b/HttpClientTrait.php
@@ -113,6 +113,7 @@ private static function prepareRequest(?string $method, ?string $url, array $opt
         // Finalize normalization of options
         $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'] : 0;
 
         return [$url, $options];
     }
diff --git a/NativeHttpClient.php b/NativeHttpClient.php
@@ -113,7 +113,12 @@ public function request(string $method, string $url, array $options = []): Respo
         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) {
+            $maxDuration = 0 < $options['max_duration'] ? $options['max_duration'] : INF;
+            $onProgress = static function (...$progress) use ($onProgress, &$lastProgress, &$info, $maxDuration) {
+                if ($info['total_time'] >= $maxDuration) {
+                    throw new TransportException(sprintf('Max duration was reached for "%s".', implode('', $info['url'])));
+                }
+
                 $progressInfo = $info;
                 $progressInfo['url'] = implode('', $info['url']);
                 unset($progressInfo['size_body']);
@@ -127,6 +132,13 @@ public function request(string $method, string $url, array $options = []): Respo
 
                 $onProgress($lastProgress[0], $lastProgress[1], $progressInfo);
             };
+        } elseif (0 < $options['max_duration']) {
+            $maxDuration = $options['max_duration'];
+            $onProgress = static function () use (&$info, $maxDuration): void {
+                if ($info['total_time'] >= $maxDuration) {
+                    throw new TransportException(sprintf('Max duration was reached for "%s".', implode('', $info['url'])));
+                }
+            };
         }
 
         // Always register a notification callback to compute live stats about the response
@@ -166,6 +178,10 @@ public function request(string $method, string $url, array $options = []): Respo
             $options['headers'][] = 'User-Agent: Symfony HttpClient/Native';
         }
 
+        if (0 < $options['max_duration']) {
+            $options['timeout'] = min($options['max_duration'], $options['timeout']);
+        }
+
         $context = [
             'http' => [
                 'protocol_version' => $options['http_version'] ?: '1.1',
diff --git a/Tests/MockHttpClientTest.php b/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/composer.json b/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.6",
         "symfony/polyfill-php73": "^1.11"
     },
     "require-dev": {

Original file line number	Diff line number	Diff line change
`@@ -284,6 +284,10 @@ public function request(string $method, string $url, array $options = []): Respo`
`284`	`284`	`$curlopts[file_exists($options['bindto']) ? CURLOPT_UNIX_SOCKET_PATH : CURLOPT_INTERFACE] = $options['bindto'];`
`285`	`285`	`}`
`286`	`286`
	`287`	`+ if (0 < $options['max_duration']) {`
	`288`	`+ $curlopts[CURLOPT_TIMEOUT_MS] = 1000 * $options['max_duration'];`
	`289`	`+ }`
	`290`	`+`
`287`	`291`	`$ch = curl_init();`
`288`	`292`
`289`	`293`	`foreach ($curlopts as $opt => $value) {`
Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,7 @@ private static function prepareRequest(?string $method, ?string $url, array $opt`
`113`	`113`	`// Finalize normalization of options`
`114`	`114`	`$options['http_version'] = (string) ($options['http_version'] ?? '') ?: null;`
`115`	`115`	`$options['timeout'] = (float) ($options['timeout'] ?? ini_get('default_socket_timeout'));`
	`116`	`+ $options['max_duration'] = isset($options['max_duration']) ? (float) $options['max_duration'] : 0;`
`116`	`117`
`117`	`118`	`return [$url, $options];`
`118`	`119`	`}`