bug #48898 [HttpClient] Move Http clients data collecting at a late level (pforesi)

fabpot · fabpot · commit 3af7d1de662c · 2023-01-09T18:55:07.000+01:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [HttpClient] Move Http clients data collecting at a late level This allows to collect http clients data when sending them in a StreamedResponse callback method | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #48894 | License | MIT | Doc PR |  When a controller action is returning a StreamedResponse doing some HttpClient requests, http clients data are collected to early, so the Web profiler HttpClient panel is wrongly empty. To fix this we moved data collecting to the HttpClientDataCollector::lateCollect() method which is called on ther kernel.terminate event. Commits ------- 692a631 [HttpClient] Move Http clients data collecting at a late level
diff --git a/src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php b/src/Symfony/Component/HttpClient/DataCollector/HttpClientDataCollector.php
@@ -37,6 +37,10 @@ public function registerClient(string $name, TraceableHttpClient $client)
      * {@inheritdoc}
      */
     public function collect(Request $request, Response $response, \Throwable $exception = null)
+    {
+    }
+
+    public function lateCollect()
     {
         $this->reset();
 
@@ -50,12 +54,7 @@ public function collect(Request $request, Response $response, \Throwable $except
 
             $this->data['request_count'] += \count($traces);
             $this->data['error_count'] += $errorCount;
-        }
-    }
 
-    public function lateCollect()
-    {
-        foreach ($this->clients as $client) {
             $client->reset();
         }
     }
diff --git a/src/Symfony/Component/HttpClient/Tests/DataCollector/HttpClientDataCollectorTest.php b/src/Symfony/Component/HttpClient/Tests/DataCollector/HttpClientDataCollectorTest.php
@@ -15,8 +15,6 @@
 use Symfony\Component\HttpClient\DataCollector\HttpClientDataCollector;
 use Symfony\Component\HttpClient\NativeHttpClient;
 use Symfony\Component\HttpClient\TraceableHttpClient;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Contracts\HttpClient\Test\TestHttpServer;
 
 class HttpClientDataCollectorTest extends TestCase
@@ -50,7 +48,7 @@ public function testItCollectsRequestCount()
         $sut->registerClient('http_client2', $httpClient2);
         $sut->registerClient('http_client3', $httpClient3);
         $this->assertEquals(0, $sut->getRequestCount());
-        $sut->collect(new Request(), new Response());
+        $sut->lateCollect();
         $this->assertEquals(3, $sut->getRequestCount());
     }
 
@@ -79,7 +77,7 @@ public function testItCollectsErrorCount()
         $sut->registerClient('http_client2', $httpClient2);
         $sut->registerClient('http_client3', $httpClient3);
         $this->assertEquals(0, $sut->getErrorCount());
-        $sut->collect(new Request(), new Response());
+        $sut->lateCollect();
         $this->assertEquals(1, $sut->getErrorCount());
     }
 
@@ -108,7 +106,7 @@ public function testItCollectsErrorCountByClient()
         $sut->registerClient('http_client2', $httpClient2);
         $sut->registerClient('http_client3', $httpClient3);
         $this->assertEquals([], $sut->getClients());
-        $sut->collect(new Request(), new Response());
+        $sut->lateCollect();
         $collectedData = $sut->getClients();
         $this->assertEquals(0, $collectedData['http_client1']['error_count']);
         $this->assertEquals(1, $collectedData['http_client2']['error_count']);
@@ -140,7 +138,7 @@ public function testItCollectsTracesByClient()
         $sut->registerClient('http_client2', $httpClient2);
         $sut->registerClient('http_client3', $httpClient3);
         $this->assertEquals([], $sut->getClients());
-        $sut->collect(new Request(), new Response());
+        $sut->lateCollect();
         $collectedData = $sut->getClients();
         $this->assertCount(2, $collectedData['http_client1']['traces']);
         $this->assertCount(1, $collectedData['http_client2']['traces']);
@@ -157,7 +155,7 @@ public function testItIsEmptyAfterReset()
         ]);
         $sut = new HttpClientDataCollector();
         $sut->registerClient('http_client1', $httpClient1);
-        $sut->collect(new Request(), new Response());
+        $sut->lateCollect();
         $collectedData = $sut->getClients();
         $this->assertCount(1, $collectedData['http_client1']['traces']);
         $sut->reset();
