fix(symfony): wrong purger clients type (#5373)

soyuka · web-flow · commit 186cd69d4461 · 2023-01-26T15:56:48.000+01:00
fixes #5365
diff --git a/src/HttpCache/SouinPurger.php b/src/HttpCache/SouinPurger.php
@@ -29,7 +29,7 @@ class SouinPurger extends SurrogateKeysPurger
     /**
      * @param HttpClientInterface[] $clients
      */
-    public function __construct(array $clients)
+    public function __construct(iterable $clients)
     {
         parent::__construct($clients, self::MAX_HEADER_SIZE_PER_BATCH, self::HEADER, self::SEPARATOR);
     }
diff --git a/src/HttpCache/SurrogateKeysPurger.php b/src/HttpCache/SurrogateKeysPurger.php
@@ -31,7 +31,7 @@ class SurrogateKeysPurger implements PurgerInterface
     /**
      * @param HttpClientInterface[] $clients
      */
-    public function __construct(protected readonly array $clients, protected readonly int $maxHeaderLength = self::MAX_HEADER_SIZE_PER_BATCH, protected readonly string $header = self::HEADER, protected readonly string $separator = self::SEPARATOR)
+    public function __construct(protected readonly iterable $clients, protected readonly int $maxHeaderLength = self::MAX_HEADER_SIZE_PER_BATCH, protected readonly string $header = self::HEADER, protected readonly string $separator = self::SEPARATOR)
     {
     }
 
diff --git a/src/HttpCache/VarnishPurger.php b/src/HttpCache/VarnishPurger.php
@@ -29,7 +29,7 @@ final class VarnishPurger implements PurgerInterface
     /**
      * @param HttpClientInterface[] $clients
      */
-    public function __construct(private readonly array $clients, int $maxHeaderLength = self::DEFAULT_VARNISH_MAX_HEADER_LENGTH)
+    public function __construct(private readonly iterable $clients, int $maxHeaderLength = self::DEFAULT_VARNISH_MAX_HEADER_LENGTH)
     {
         $this->maxHeaderLength = $maxHeaderLength - mb_strlen(self::REGEXP_PATTERN) + 2; // 2 for %s
     }
diff --git a/src/HttpCache/VarnishXKeyPurger.php b/src/HttpCache/VarnishXKeyPurger.php
@@ -28,7 +28,7 @@ final class VarnishXKeyPurger extends SurrogateKeysPurger
     /**
      * @param HttpClientInterface[] $clients
      */
-    public function __construct(array $clients, int $maxHeaderLength = self::VARNISH_MAX_HEADER_LENGTH, string $xkeyGlue = self::VARNISH_SEPARATOR)
+    public function __construct(iterable $clients, int $maxHeaderLength = self::VARNISH_MAX_HEADER_LENGTH, string $xkeyGlue = self::VARNISH_SEPARATOR)
     {
         parent::__construct($clients, $maxHeaderLength, 'xkey', $xkeyGlue);
     }
diff --git a/tests/HttpCache/VarnishPurgerTest.php b/tests/HttpCache/VarnishPurgerTest.php
@@ -21,6 +21,7 @@
 use Prophecy\PhpUnit\ProphecyTrait;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
@@ -175,4 +176,15 @@ public function provideChunkHeaderCases(): \Generator
             ],
         ];
     }
+
+    public function testConstructor(): void
+    {
+        $clientProphecy = $this->prophesize(HttpClientInterface::class);
+        $clientProphecy->request('BAN', '', ['headers' => ['ApiPlatform-Ban-Regex' => '(/foo)($|\,)']])->shouldBeCalled();
+        $purger = new VarnishPurger(new RewindableGenerator(static function () use ($clientProphecy) {
+            yield $clientProphecy->reveal();
+        }, 1));
+
+        $purger->purge(['/foo']);
+    }
 }
diff --git a/tests/HttpCache/VarnishXKeyPurgerTest.php b/tests/HttpCache/VarnishXKeyPurgerTest.php
@@ -21,6 +21,7 @@
 use Prophecy\PhpUnit\ProphecyTrait;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
@@ -205,4 +206,15 @@ public function provideChunkHeaderCases(): \Generator
             ],
         ];
     }
+
+    public function testConstructor(): void
+    {
+        $clientProphecy = $this->prophesize(ClientInterface::class);
+        $clientProphecy->request('PURGE', '', ['headers' => ['xkey' => '/foo']])->willReturn(new Response())->shouldBeCalled();
+        $purger = new VarnishXKeyPurger(new RewindableGenerator(static function () use ($clientProphecy) {
+            yield $clientProphecy->reveal();
+        }, 1));
+
+        $purger->purge(['/foo']);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class SouinPurger extends SurrogateKeysPurger`
`29`	`29`	`/**`
`30`	`30`	`* @param HttpClientInterface[] $clients`
`31`	`31`	`*/`
`32`		`- public function __construct(array $clients)`
	`32`	`+ public function __construct(iterable $clients)`
`33`	`33`	`{`
`34`	`34`	`parent::__construct($clients, self::MAX_HEADER_SIZE_PER_BATCH, self::HEADER, self::SEPARATOR);`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class SurrogateKeysPurger implements PurgerInterface`
`31`	`31`	`/**`
`32`	`32`	`* @param HttpClientInterface[] $clients`
`33`	`33`	`*/`
`34`		`- public function __construct(protected readonly array $clients, protected readonly int $maxHeaderLength = self::MAX_HEADER_SIZE_PER_BATCH, protected readonly string $header = self::HEADER, protected readonly string $separator = self::SEPARATOR)`
	`34`	`+ public function __construct(protected readonly iterable $clients, protected readonly int $maxHeaderLength = self::MAX_HEADER_SIZE_PER_BATCH, protected readonly string $header = self::HEADER, protected readonly string $separator = self::SEPARATOR)`
`35`	`35`	`{`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ final class VarnishPurger implements PurgerInterface`
`29`	`29`	`/**`
`30`	`30`	`* @param HttpClientInterface[] $clients`
`31`	`31`	`*/`
`32`		`- public function __construct(private readonly array $clients, int $maxHeaderLength = self::DEFAULT_VARNISH_MAX_HEADER_LENGTH)`
	`32`	`+ public function __construct(private readonly iterable $clients, int $maxHeaderLength = self::DEFAULT_VARNISH_MAX_HEADER_LENGTH)`
`33`	`33`	`{`
`34`	`34`	`$this->maxHeaderLength = $maxHeaderLength - mb_strlen(self::REGEXP_PATTERN) + 2; // 2 for %s`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ final class VarnishXKeyPurger extends SurrogateKeysPurger`
`28`	`28`	`/**`
`29`	`29`	`* @param HttpClientInterface[] $clients`
`30`	`30`	`*/`
`31`		`- public function __construct(array $clients, int $maxHeaderLength = self::VARNISH_MAX_HEADER_LENGTH, string $xkeyGlue = self::VARNISH_SEPARATOR)`
	`31`	`+ public function __construct(iterable $clients, int $maxHeaderLength = self::VARNISH_MAX_HEADER_LENGTH, string $xkeyGlue = self::VARNISH_SEPARATOR)`
`32`	`32`	`{`
`33`	`33`	`parent::__construct($clients, $maxHeaderLength, 'xkey', $xkeyGlue);`
`34`	`34`	`}`