Merge branch '5.4' into 6.0

nicolas-grekas · nicolas-grekas · commit 2304f50331a0 · 2021-11-12T12:44:21.000+01:00
* 5.4:
  Fix tests on PHP 8.1
  [Cache] Fix memory leak
  [Config] Add missing use statement in generated config builder classes
  [DependencyInjection] fix inlining when non-shared services are involved
  [FrameworkBundle] fix deprecation message
  [DoctrineBridge] add support for the JSON type
  [PHPUnitBridge] Fix Uncaught ValueError
  [HttpClient] Implement ResetInterface for all http clients
  [HttpKernel] allow ignoring kernel.reset methods that don't exist
  [FrameworkBundle] fix registering late resettable services
  [Validator] Missing translations for Greek (el)
  translate for japanese 101,102,103
  Use symfony-*-bridge instead of symfony-bridge for component bridges
  Fix Loco Provider
  [HttpClient] Curl http client has to reinit curl multi handle on reset
  [SecurityBundle] Fix compat with symfony/security-core:^6 (ter)
  [Validator] Add Swedish translation for issue #43737
diff --git a/CachingHttpClient.php b/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 <p@tchwork.com>
  */
-class CachingHttpClient implements HttpClientInterface
+class CachingHttpClient implements HttpClientInterface, ResetInterface
 {
     use HttpClientTrait;
 
@@ -139,4 +140,11 @@ public function stream(ResponseInterface|iterable $responses, float $timeout = n
             yield $this->client->stream($clientResponses, $timeout);
         })());
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }
diff --git a/DecoratorTrait.php b/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): static
 
         return $clone;
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }
diff --git a/EventSourceHttpClient.php b/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 <soyuka@gmail.com>
  * @author Nicolas Grekas <p@tchwork.com>
  */
-final class EventSourceHttpClient implements HttpClientInterface
+final class EventSourceHttpClient implements HttpClientInterface, ResetInterface
 {
     use AsyncDecoratorTrait, HttpClientTrait {
         AsyncDecoratorTrait::withOptions insteadof HttpClientTrait;
diff --git a/HttplugClient.php b/HttplugClient.php
@@ -38,6 +38,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".');
@@ -55,7 +56,7 @@
  *
  * @author Nicolas Grekas <p@tchwork.com>
  */
-final class HttplugClient implements HttplugInterface, HttpAsyncClient, RequestFactory, StreamFactory, UriFactory
+final class HttplugClient implements HttplugInterface, HttpAsyncClient, RequestFactory, StreamFactory, UriFactory, ResetInterface
 {
     private HttpClientInterface $client;
     private ResponseFactoryInterface $responseFactory;
@@ -236,6 +237,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 {
diff --git a/Internal/CurlClientState.php b/Internal/CurlClientState.php
@@ -63,6 +63,9 @@ public function reset()
                 curl_setopt($ch, \CURLOPT_VERBOSE, false);
             }
         }
+
+        curl_multi_close($this->handle);
+        $this->handle = curl_multi_init();
     }
 
     public function __sleep(): array
diff --git a/Internal/NativeClientState.php b/Internal/NativeClientState.php
@@ -33,4 +33,11 @@ public function __construct()
     {
         $this->id = random_int(\PHP_INT_MIN, \PHP_INT_MAX);
     }
+
+    public function reset()
+    {
+        $this->responseCount = 0;
+        $this->dnsCache = [];
+        $this->hosts = [];
+    }
 }
diff --git a/MockHttpClient.php b/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 <p@tchwork.com>
  */
-class MockHttpClient implements HttpClientInterface
+class MockHttpClient implements HttpClientInterface, ResetInterface
 {
     use HttpClientTrait;
 
@@ -113,4 +114,9 @@ public function withOptions(array $options): static
 
         return $clone;
     }
+
+    public function reset()
+    {
+        $this->requestsCount = 0;
+    }
 }
diff --git a/NativeHttpClient.php b/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 <p@tchwork.com>
  */
-final class NativeHttpClient implements HttpClientInterface, LoggerAwareInterface
+final class NativeHttpClient implements HttpClientInterface, LoggerAwareInterface, ResetInterface
 {
     use HttpClientTrait;
     use LoggerAwareTrait;
@@ -252,6 +253,11 @@ public function stream(ResponseInterface|iterable $responses, float $timeout = n
         return new ResponseStream(NativeResponse::stream($responses, $timeout));
     }
 
+    public function reset()
+    {
+        $this->multi->reset();
+    }
+
     private static function getBodyAsString($body): string
     {
         if (\is_resource($body)) {
diff --git a/NoPrivateNetworkHttpClient.php b/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 <hallisonboaventura@gmail.com>
  */
-final class NoPrivateNetworkHttpClient implements HttpClientInterface, LoggerAwareInterface
+final class NoPrivateNetworkHttpClient implements HttpClientInterface, LoggerAwareInterface, ResetInterface
 {
     use HttpClientTrait;
 
@@ -117,4 +118,11 @@ public function withOptions(array $options): static
 
         return $clone;
     }
+
+    public function reset()
+    {
+        if ($this->client instanceof ResetInterface) {
+            $this->client->reset();
+        }
+    }
 }
diff --git a/Psr18Client.php b/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 <p@tchwork.com>
  */
-final class Psr18Client implements ClientInterface, RequestFactoryInterface, StreamFactoryInterface, UriFactoryInterface
+final class Psr18Client implements ClientInterface, RequestFactoryInterface, StreamFactoryInterface, UriFactoryInterface, ResetInterface
 {
     private HttpClientInterface $client;
     private ResponseFactoryInterface $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();
+        }
+    }
 }
 
 /**
diff --git a/RetryableHttpClient.php b/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é <jeremy@derusse.com>
  */
-class RetryableHttpClient implements HttpClientInterface
+class RetryableHttpClient implements HttpClientInterface, ResetInterface
 {
     use AsyncDecoratorTrait;
 
diff --git a/Tests/CurlHttpClientTest.php b/Tests/CurlHttpClientTest.php
@@ -55,6 +55,18 @@ public function testTimeoutIsNotAFatalError()
         parent::testTimeoutIsNotAFatalError();
     }
 
+    public function testHandleIsReinitOnReset()
+    {
+        $httpClient = $this->getHttpClient(__FUNCTION__);
+
+        $r = new \ReflectionProperty($httpClient, 'multi');
+        $r->setAccessible(true);
+        $clientState = $r->getValue($httpClient);
+        $initialHandleId = (int) $clientState->handle;
+        $httpClient->reset();
+        self::assertNotSame($initialHandleId, (int) $clientState->handle);
+    }
+
     public function testOverridingRefererUsingCurlOptions()
     {
         $httpClient = $this->getHttpClient(__FUNCTION__);
diff --git a/Tests/MockHttpClientTest.php b/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());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,9 @@ public function reset()`
`63`	`63`	`curl_setopt($ch, \CURLOPT_VERBOSE, false);`
`64`	`64`	`}`
`65`	`65`	`}`
	`66`	`+`
	`67`	`+ curl_multi_close($this->handle);`
	`68`	`+ $this->handle = curl_multi_init();`
`66`	`69`	`}`
`67`	`70`
`68`	`71`	`public function __sleep(): array`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,11 @@ public function __construct()`
`33`	`33`	`{`
`34`	`34`	`$this->id = random_int(\PHP_INT_MIN, \PHP_INT_MAX);`
`35`	`35`	`}`
	`36`	`+`
	`37`	`+ public function reset()`
	`38`	`+ {`
	`39`	`+ $this->responseCount = 0;`
	`40`	`+ $this->dnsCache = [];`
	`41`	`+ $this->hosts = [];`
	`42`	`+ }`
`36`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,14 @@`
`17`	`17`	`use Symfony\Contracts\HttpClient\HttpClientInterface;`
`18`	`18`	`use Symfony\Contracts\HttpClient\ResponseInterface;`
`19`	`19`	`use Symfony\Contracts\HttpClient\ResponseStreamInterface;`
	`20`	`+use Symfony\Contracts\Service\ResetInterface;`
`20`	`21`
`21`	`22`	`/**`
`22`	`23`	`* A test-friendly HttpClient that doesn't make actual HTTP requests.`
`23`	`24`	`*`
`24`	`25`	`* @author Nicolas Grekas <[email protected]>`
`25`	`26`	`*/`
`26`		`-class MockHttpClient implements HttpClientInterface`
	`27`	`+class MockHttpClient implements HttpClientInterface, ResetInterface`
`27`	`28`	`{`
`28`	`29`	`use HttpClientTrait;`
`29`	`30`
`@@ -113,4 +114,9 @@ public function withOptions(array $options): static`
`113`	`114`
`114`	`115`	`return $clone;`
`115`	`116`	`}`
	`117`	`+`
	`118`	`+ public function reset()`
	`119`	`+ {`
	`120`	`+ $this->requestsCount = 0;`
	`121`	`+ }`
`116`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,14 @@`
`19`	`19`	`use Symfony\Contracts\HttpClient\HttpClientInterface;`
`20`	`20`	`use Symfony\Contracts\HttpClient\ResponseInterface;`
`21`	`21`	`use Symfony\Contracts\HttpClient\ResponseStreamInterface;`
	`22`	`+use Symfony\Contracts\Service\ResetInterface;`
`22`	`23`
`23`	`24`	`/**`
`24`	`25`	`* Decorator that blocks requests to private networks by default.`
`25`	`26`	`*`
`26`	`27`	`* @author Hallison Boaventura <[email protected]>`
`27`	`28`	`*/`
`28`		`-final class NoPrivateNetworkHttpClient implements HttpClientInterface, LoggerAwareInterface`
	`29`	`+final class NoPrivateNetworkHttpClient implements HttpClientInterface, LoggerAwareInterface, ResetInterface`
`29`	`30`	`{`
`30`	`31`	`use HttpClientTrait;`
`31`	`32`
`@@ -117,4 +118,11 @@ public function withOptions(array $options): static`
`117`	`118`
`118`	`119`	`return $clone;`
`119`	`120`	`}`
	`121`	`+`
	`122`	`+ public function reset()`
	`123`	`+ {`
	`124`	`+ if ($this->client instanceof ResetInterface) {`
	`125`	`+ $this->client->reset();`
	`126`	`+ }`
	`127`	`+ }`
`120`	`128`	`}`