bug #38633 [HttpClient] Fix decorating progress info in AsyncResponse (jderusse)

fabpot · fabpot · commit 508ec9c33a4d · 2020-10-21T15:24:34.000+02:00
This PR was squashed before being merged into the 5.x branch. Discussion ---------- [HttpClient] Fix decorating progress info in AsyncResponse | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #38631 | License | MIT | Doc PR | / This PR reverts #38413, and send AsyncContext to onProgress callback. Commits ------- e325f51 [HttpClient] Fix decorating progress info in AsyncResponse
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -2098,7 +2098,7 @@ private function registerRetryableHttpClient(array $options, string $name, Conta
 
         $container
             ->register($name.'.retryable', RetryableHttpClient::class)
-            ->setDecoratedService($name, null, -10) // lower priority than TraceableHttpClient
+            ->setDecoratedService($name, null, 10) // higher priority than TraceableHttpClient
             ->setArguments([new Reference($name.'.retryable.inner'), $retryStrategy, $options['max_retries'], new Reference('logger')])
             ->addTag('monolog.logger', ['channel' => 'http_client']);
     }
diff --git a/src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php b/src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php
@@ -98,6 +98,7 @@ private function collectOnClient(TraceableHttpClient $client): array
         $errorCount = 0;
         $baseInfo = [
             'response_headers' => 1,
+            'retry_count' => 1,
             'redirect_count' => 1,
             'redirect_url' => 1,
             'user_data' => 1,
@@ -152,6 +153,11 @@ private function collectOnClient(TraceableHttpClient $client): array
                 $content = [];
             }
 
+            if (isset($info['retry_count'])) {
+                $content['retries'] = $info['previous_info'];
+                unset($info['previous_info']);
+            }
+
             $debugInfo = array_diff_key($info, $baseInfo);
             $info = ['info' => $debugInfo] + array_diff_key($info, $debugInfo) + $content;
             unset($traces[$i]['info']); // break PHP reference used by TraceableHttpClient
diff --git a/src/Symfony/Component/HttpClient/Response/AsyncContext.php b/src/Symfony/Component/HttpClient/Response/AsyncContext.php
@@ -151,6 +151,12 @@ public function getResponse(): ResponseInterface
     public function replaceRequest(string $method, string $url, array $options = []): ResponseInterface
     {
         $this->info['previous_info'][] = $this->response->getInfo();
+        if (null !== $onProgress = $options['on_progress'] ?? null) {
+            $thisInfo = &$this->info;
+            $options['on_progress'] = static function (int $dlNow, int $dlSize, array $info) use (&$thisInfo, $onProgress) {
+                $onProgress($dlNow, $dlSize, $thisInfo + $info);
+            };
+        }
 
         return $this->response = $this->client->request($method, $url, ['buffer' => false] + $options);
     }
diff --git a/src/Symfony/Component/HttpClient/Response/AsyncResponse.php b/src/Symfony/Component/HttpClient/Response/AsyncResponse.php
@@ -43,6 +43,13 @@ public function __construct(HttpClientInterface $client, string $method, string
     {
         $this->client = $client;
         $this->shouldBuffer = $options['buffer'] ?? true;
+
+        if (null !== $onProgress = $options['on_progress'] ?? null) {
+            $thisInfo = &$this->info;
+            $options['on_progress'] = static function (int $dlNow, int $dlSize, array $info) use (&$thisInfo, $onProgress) {
+                $onProgress($dlNow, $dlSize, $thisInfo + $info);
+            };
+        }
         $this->response = $client->request($method, $url, ['buffer' => false] + $options);
         $this->passthru = $passthru;
         $this->initializer = static function (self $response) {
diff --git a/src/Symfony/Component/HttpClient/RetryableHttpClient.php b/src/Symfony/Component/HttpClient/RetryableHttpClient.php
@@ -66,7 +66,6 @@ public function request(string $method, string $url, array $options = []): Respo
                 }
             } catch (TransportExceptionInterface $exception) {
                 // catch TransportExceptionInterface to send it to the strategy
-                $context->setInfo('retry_count', $retryCount);
             }
             if (null !== $exception) {
                 // always retry request that fail to resolve DNS
@@ -91,8 +90,6 @@ public function request(string $method, string $url, array $options = []): Respo
                     }
                 }
             } elseif ($chunk->isFirst()) {
-                $context->setInfo('retry_count', $retryCount);
-
                 if (false === $shouldRetry = $this->strategy->shouldRetry($context, null, null)) {
                     $context->passthru();
                     yield $chunk;
@@ -138,6 +135,7 @@ public function request(string $method, string $url, array $options = []): Respo
                 'delay' => $delay,
             ]);
 
+            $context->setInfo('retry_count', $retryCount);
             $context->replaceRequest($method, $url, $options);
             $context->pause($delay / 1000);
 
diff --git a/src/Symfony/Component/HttpClient/Tests/AsyncDecoratorTraitTest.php b/src/Symfony/Component/HttpClient/Tests/AsyncDecoratorTraitTest.php
@@ -263,4 +263,23 @@ public function request(string $method, string $url, array $options = []): Respo
 
         $this->assertSame('{"documents":[{"id":"\/json\/1"},{"id":"\/json\/2"},{"id":"\/json\/3"}]}', $content);
     }
+
+    public function testInfoPassToDecorator()
+    {
+        $lastInfo = null;
+        $options = ['on_progress' => function (int $dlNow, int $dlSize, array $info) use (&$lastInfo) {
+            $lastInfo = $info;
+        }];
+        $client = $this->getHttpClient(__FUNCTION__, function (ChunkInterface $chunk, AsyncContext $context) use ($options) {
+            $context->setInfo('foo', 'test');
+            $context->getResponse()->cancel();
+            $context->replaceRequest('GET', 'http://localhost:8057/', $options);
+            $context->passthru();
+        });
+
+        $client->request('GET', 'http://localhost:8057')->getContent();
+        $this->assertArrayHasKey('foo', $lastInfo);
+        $this->assertSame('test', $lastInfo['foo']);
+        $this->assertArrayHasKey('previous_info', $lastInfo);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -2098,7 +2098,7 @@ private function registerRetryableHttpClient(array $options, string $name, Conta`
`2098`	`2098`
`2099`	`2099`	`$container`
`2100`	`2100`	`->register($name.'.retryable', RetryableHttpClient::class)`
`2101`		`- ->setDecoratedService($name, null, -10) // lower priority than TraceableHttpClient`
	`2101`	`+ ->setDecoratedService($name, null, 10) // higher priority than TraceableHttpClient`
`2102`	`2102`	`->setArguments([new Reference($name.'.retryable.inner'), $retryStrategy, $options['max_retries'], new Reference('logger')])`
`2103`	`2103`	`->addTag('monolog.logger', ['channel' => 'http_client']);`
`2104`	`2104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -151,6 +151,12 @@ public function getResponse(): ResponseInterface`
`151`	`151`	`public function replaceRequest(string $method, string $url, array $options = []): ResponseInterface`
`152`	`152`	`{`
`153`	`153`	`$this->info['previous_info'][] = $this->response->getInfo();`
	`154`	`+ if (null !== $onProgress = $options['on_progress'] ?? null) {`
	`155`	`+ $thisInfo = &$this->info;`
	`156`	`+ $options['on_progress'] = static function (int $dlNow, int $dlSize, array $info) use (&$thisInfo, $onProgress) {`
	`157`	`+ $onProgress($dlNow, $dlSize, $thisInfo + $info);`
	`158`	`+ };`
	`159`	`+ }`
`154`	`160`
`155`	`161`	`return $this->response = $this->client->request($method, $url, ['buffer' => false] + $options);`
`156`	`162`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,6 @@ public function request(string $method, string $url, array $options = []): Respo`
`66`	`66`	`}`
`67`	`67`	`} catch (TransportExceptionInterface $exception) {`
`68`	`68`	`// catch TransportExceptionInterface to send it to the strategy`
`69`		`- $context->setInfo('retry_count', $retryCount);`
`70`	`69`	`}`
`71`	`70`	`if (null !== $exception) {`
`72`	`71`	`// always retry request that fail to resolve DNS`
`@@ -91,8 +90,6 @@ public function request(string $method, string $url, array $options = []): Respo`
`91`	`90`	`}`
`92`	`91`	`}`
`93`	`92`	`} elseif ($chunk->isFirst()) {`
`94`		`- $context->setInfo('retry_count', $retryCount);`
`95`		`-`
`96`	`93`	`if (false === $shouldRetry = $this->strategy->shouldRetry($context, null, null)) {`
`97`	`94`	`$context->passthru();`
`98`	`95`	`yield $chunk;`
`@@ -138,6 +135,7 @@ public function request(string $method, string $url, array $options = []): Respo`
`138`	`135`	`'delay' => $delay,`
`139`	`136`	`]);`
`140`	`137`
	`138`	`+ $context->setInfo('retry_count', $retryCount);`
`141`	`139`	`$context->replaceRequest($method, $url, $options);`
`142`	`140`	`$context->pause($delay / 1000);`
`143`	`141`