[HttpClient] Implement ResetInterface for all http clients

Author: Rokas Mikalkėnas

CachingHttpClient.php

@@ -20,6 +20,7 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 use Symfony\Contracts\HttpClient\ResponseStreamInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * Adds caching on top of an HTTP client.
@@ -30,7 +31,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-class CachingHttpClient implements HttpClientInterface
+class CachingHttpClient implements HttpClientInterface, ResetInterface
 {
     use HttpClientTrait;
 
@@ -141,4 +142,11 @@ public function stream($responses, float $timeout = null): ResponseStreamInterfa
             yield $this->client->stream($clientResponses, $timeout);
         })());
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }

DecoratorTrait.php

@@ -14,6 +14,7 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 use Symfony\Contracts\HttpClient\ResponseStreamInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * Eases with writing decorators.
@@ -55,4 +56,11 @@ public function withOptions(array $options): self
 
         return $clone;
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }

EventSourceHttpClient.php

@@ -19,12 +19,13 @@
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * @author Antoine Bluchet <[email protected]>
  * @author Nicolas Grekas <[email protected]>
  */
-final class EventSourceHttpClient implements HttpClientInterface
+final class EventSourceHttpClient implements HttpClientInterface, ResetInterface
 {
     use AsyncDecoratorTrait, HttpClientTrait {
         AsyncDecoratorTrait::withOptions insteadof HttpClientTrait;

HttplugClient.php

@@ -39,6 +39,7 @@
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 if (!interface_exists(HttplugInterface::class)) {
     throw new \LogicException('You cannot use "Symfony\Component\HttpClient\HttplugClient" as the "php-http/httplug" package is not installed. Try running "composer require php-http/httplug".');
@@ -56,7 +57,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-final class HttplugClient implements HttplugInterface, HttpAsyncClient, RequestFactory, StreamFactory, UriFactory
+final class HttplugClient implements HttplugInterface, HttpAsyncClient, RequestFactory, StreamFactory, UriFactory, ResetInterface
 {
     private $client;
     private $responseFactory;
@@ -238,6 +239,13 @@ public function __destruct()
         $this->wait();
     }
 
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
+
     private function sendPsr7Request(RequestInterface $request, bool $buffer = null): ResponseInterface
     {
         try {

Internal/NativeClientState.php

@@ -37,4 +37,11 @@ public function __construct()
     {
         $this->id = random_int(\PHP_INT_MIN, \PHP_INT_MAX);
     }
+
+    public function reset()
+    {
+        $this->responseCount = 0;
+        $this->dnsCache = [];
+        $this->hosts = [];
+    }
 }

MockHttpClient.php

@@ -17,13 +17,14 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 use Symfony\Contracts\HttpClient\ResponseStreamInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * A test-friendly HttpClient that doesn't make actual HTTP requests.
  *
  * @author Nicolas Grekas <[email protected]>
  */
-class MockHttpClient implements HttpClientInterface
+class MockHttpClient implements HttpClientInterface, ResetInterface
 {
     use HttpClientTrait;
 
@@ -115,4 +116,9 @@ public function withOptions(array $options): self
 
         return $clone;
     }
+
+    public function reset()
+    {
+        $this->requestsCount = 0;
+    }
 }

NativeHttpClient.php

@@ -21,6 +21,7 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 use Symfony\Contracts\HttpClient\ResponseStreamInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * A portable implementation of the HttpClientInterface contracts based on PHP stream wrappers.
@@ -30,7 +31,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-final class NativeHttpClient implements HttpClientInterface, LoggerAwareInterface
+final class NativeHttpClient implements HttpClientInterface, LoggerAwareInterface, ResetInterface
 {
     use HttpClientTrait;
     use LoggerAwareTrait;
@@ -261,6 +262,11 @@ public function stream($responses, float $timeout = null): ResponseStreamInterfa
         return new ResponseStream(NativeResponse::stream($responses, $timeout));
     }
 
+    public function reset()
+    {
+        $this->multi->reset();
+    }
+
     private static function getBodyAsString($body): string
     {
         if (\is_resource($body)) {

NoPrivateNetworkHttpClient.php

@@ -19,13 +19,14 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 use Symfony\Contracts\HttpClient\ResponseStreamInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * Decorator that blocks requests to private networks by default.
  *
  * @author Hallison Boaventura <[email protected]>
  */
-final class NoPrivateNetworkHttpClient implements HttpClientInterface, LoggerAwareInterface
+final class NoPrivateNetworkHttpClient implements HttpClientInterface, LoggerAwareInterface, ResetInterface
 {
     use HttpClientTrait;
 
@@ -121,4 +122,11 @@ public function withOptions(array $options): self
 
         return $clone;
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }

Psr18Client.php

@@ -31,6 +31,7 @@
 use Symfony\Component\HttpClient\Response\StreamWrapper;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 if (!interface_exists(RequestFactoryInterface::class)) {
     throw new \LogicException('You cannot use the "Symfony\Component\HttpClient\Psr18Client" as the "psr/http-factory" package is not installed. Try running "composer require nyholm/psr7".');
@@ -49,7 +50,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-final class Psr18Client implements ClientInterface, RequestFactoryInterface, StreamFactoryInterface, UriFactoryInterface
+final class Psr18Client implements ClientInterface, RequestFactoryInterface, StreamFactoryInterface, UriFactoryInterface, ResetInterface
 {
     private $client;
     private $responseFactory;
@@ -190,6 +191,13 @@ public function createUri(string $uri = ''): UriInterface
 
         throw new \LogicException(sprintf('You cannot use "%s()" as the "nyholm/psr7" package is not installed. Try running "composer require nyholm/psr7".', __METHOD__));
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }
 
 /**

RetryableHttpClient.php

@@ -21,13 +21,14 @@
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * Automatically retries failing HTTP requests.
  *
  * @author Jérémy Derussé <[email protected]>
  */
-class RetryableHttpClient implements HttpClientInterface
+class RetryableHttpClient implements HttpClientInterface, ResetInterface
 {
     use AsyncDecoratorTrait;
 

Tests/MockHttpClientTest.php

@@ -418,4 +418,16 @@ public function __toString()
 
         $this->assertSame('foo=bar', $response->getRequestOptions()['body']);
     }
+
+    public function testResetsRequestCount()
+    {
+        $client = new MockHttpClient([new MockResponse()]);
+        $this->assertSame(0, $client->getRequestsCount());
+
+        $client->request('POST', '/url', ['body' => 'payload']);
+
+        $this->assertSame(1, $client->getRequestsCount());
+        $client->reset();
+        $this->assertSame(0, $client->getRequestsCount());
+    }
 }