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

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
-------

e325f51fe2 [HttpClient] Fix decorating progress info in AsyncResponse

Author: fabpot

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

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);
     }

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) {

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);
 

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);
+    }
 }