static typing tests and remove legacy things

Author: dbu

composer.json

@@ -40,7 +40,8 @@
         "phpunit/phpunit": "^9"
     },
     "conflict": {
-        "toflar/psr6-symfony-http-cache-store": "<2.2.1"
+        "toflar/psr6-symfony-http-cache-store": "<2.2.1",
+        "phpunit/phpunit": "<8"
     },
     "suggest": {
         "friendsofsymfony/http-cache-bundle": "For integration with the Symfony framework",

src/CacheInvalidator.php

@@ -95,7 +95,7 @@ public function __construct(ProxyClient $cache)
      *
      * @throws InvalidArgumentException
      */
-    public function supports($operation)
+    public function supports(string $operation)
     {
         switch ($operation) {
             case self::PATH:
@@ -123,7 +123,7 @@ public function supports($operation)
      *
      * @throws \Exception when trying to override the event dispatcher
      */
-    public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
+    public function setEventDispatcher(EventDispatcherInterface $eventDispatcher): void
     {
         if ($this->eventDispatcher) {
             // if you want to set a custom event dispatcher, do so right after instantiating
@@ -157,7 +157,7 @@ public function getEventDispatcher()
      *
      * @throws UnsupportedProxyOperationException
      */
-    public function invalidatePath($path, array $headers = [])
+    public function invalidatePath($path, array $headers = []): static
     {
         if (!$this->cache instanceof PurgeCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('PURGE');
@@ -180,7 +180,7 @@ public function invalidatePath($path, array $headers = [])
      *
      * @throws UnsupportedProxyOperationException
      */
-    public function refreshPath($path, array $headers = [])
+    public function refreshPath($path, array $headers = []): static
     {
         if (!$this->cache instanceof RefreshCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('REFRESH');
@@ -205,7 +205,7 @@ public function refreshPath($path, array $headers = [])
      *
      * @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
      */
-    public function invalidate(array $headers)
+    public function invalidate(array $headers): static
     {
         if (!$this->cache instanceof BanCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('BAN');
@@ -227,7 +227,7 @@ public function invalidate(array $headers)
      *
      * @throws UnsupportedProxyOperationException If HTTP cache does not support Tags invalidation
      */
-    public function invalidateTags(array $tags)
+    public function invalidateTags(array $tags): static
     {
         if (!$this->cache instanceof TagCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('Tags');
@@ -250,20 +250,20 @@ public function invalidateTags(array $tags)
      * ['example.com', 'other.net']. If the parameter is empty, all hosts
      * are matched.
      *
-     * @see BanCapable::banPath()
-     *
-     * @param string       $path        Regular expression pattern for URI to
-     *                                  invalidate
-     * @param string       $contentType Regular expression pattern for the content
-     *                                  type to limit banning, for instance 'text'
-     * @param array|string $hosts       Regular expression of a host name or list of
-     *                                  exact host names to limit banning
+     * @param string            $path        Regular expression pattern for URI to
+     *                                       invalidate
+     * @param string|null       $contentType Regular expression pattern for the content
+     *                                       type to limit banning, for instance 'text'
+     * @param array|string|null $hosts       Regular expression of a host name or list of
+     *                                       exact host names to limit banning
      *
      * @return $this
      *
      * @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
+     *
+     *@see BanCapable::banPath()
      */
-    public function invalidateRegex($path, $contentType = null, $hosts = null)
+    public function invalidateRegex(string $path, ?string $contentType = null, array|string|null $hosts = null): static
     {
         if (!$this->cache instanceof BanCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('BAN');
@@ -281,7 +281,7 @@ public function invalidateRegex($path, $contentType = null, $hosts = null)
      *
      * @throws UnsupportedProxyOperationException if HTTP cache does not support clearing the cache completely
      */
-    public function clearCache()
+    public function clearCache(): static
     {
         if (!$this->cache instanceof ClearCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('CLEAR');

src/Event.php

@@ -15,22 +15,14 @@
 
 class Event extends BaseEvent
 {
-    private $exception;
+    private \Throwable $exception;
 
-    /**
-     * Set exception.
-     */
-    public function setException(\Exception $exception)
+    public function setException(\Throwable $exception): void
     {
         $this->exception = $exception;
     }
 
-    /**
-     * Get exception.
-     *
-     * @return \Exception
-     */
-    public function getException()
+    public function getException(): \Throwable
     {
         return $this->exception;
     }

src/ResponseTagger.php

@@ -90,7 +90,7 @@ public function getTagsHeaderName()
      *
      * This concatenates all tags and ensures correct encoding.
      *
-     * @return string
+     * @erturn string
      */
     public function getTagsHeaderValue()
     {
@@ -104,7 +104,7 @@ public function getTagsHeaderValue()
      *
      * @return string[]
      */
-    protected function parseTagsHeaderValue($headers): array
+    protected function parseTagsHeaderValue(array|string $headers)
     {
         if ($this->headerFormatter instanceof TagHeaderParser) {
             return $this->headerFormatter->parseTagsHeaderValue($headers);
@@ -118,7 +118,7 @@ protected function parseTagsHeaderValue($headers): array
     /**
      * Check whether the tag handler has any tags to set on the response.
      *
-     * @return bool True if this handler will set at least one tag
+     * @return bool
      */
     public function hasTags()
     {
@@ -156,7 +156,7 @@ public function addTags(array $tags)
      * This is usually called after adding the tags header to a response. It is
      * automatically called by the tagResponse method.
      */
-    public function clear()
+    public function clear(): void
     {
         $this->tags = [];
     }
@@ -168,9 +168,9 @@ public function clear()
      * @param bool              $replace  Whether to replace the current tags
      *                                    on the response
      *
-     * @return ResponseInterface Tagged response
+     * @return ResponseInterface
      */
-    public function tagResponse(ResponseInterface $response, $replace = false)
+    public function tagResponse(ResponseInterface $response, bool $replace = false)
     {
         if (!$this->hasTags()) {
             return $response;

src/SymfonyCache/CacheInvalidation.php

@@ -11,36 +11,35 @@
 
 namespace FOS\HttpCache\SymfonyCache;
 
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\HttpCache\StoreInterface;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
-use Symfony\Component\HttpKernel\Kernel;
 
-if (interface_exists(CacheInvalidation::class)) {
-    return;
-}
-
-/*
- * Symfony 6 introduced a BC break in the signature of the protected method HttpKernelInterface::fetch.
- * Load the correct interface to match the signature.
+/**
+ * Interface for a HttpCache that supports active cache invalidation.
  */
-if (\class_exists(Kernel::class) && Kernel::MAJOR_VERSION >= 6) {
-    // Load class for Symfony >=6.0
-    \class_alias(
-        Compatibility\CacheInvalidationS6::class,
-        CacheInvalidation::class
-    );
-} else {
-    // Load class for any other cases
-    \class_alias(
-        Compatibility\CacheInvalidationLegacy::class,
-        CacheInvalidation::class
-    );
-}
+interface CacheInvalidation extends HttpKernelInterface
+{
+    /**
+     * Forwards the Request to the backend and determines whether the response should be stored.
+     *
+     * This methods is triggered when the cache missed or a reload is required.
+     *
+     * This method is present on HttpCache but must be public to allow event listeners to do
+     * refresh operations.
+     *
+     * @param Request $request A Request instance
+     * @param bool    $catch   Whether to process exceptions
+     *
+     * @return Response A Response instance
+     */
+    public function fetch(Request $request, bool $catch = false): Response;
 
-if (!interface_exists(CacheInvalidation::class)) {
     /**
-     * Provide an empty interface for code scanners.
+     * Gets the store for cached responses.
+     *
+     * @return StoreInterface $store The store used by the HttpCache
      */
-    interface CacheInvalidation extends HttpKernelInterface
-    {
-    }
+    public function getStore(): StoreInterface;
 }

src/SymfonyCache/Compatibility/CacheInvalidationLegacy.php

@@ -19,7 +19,7 @@
  */
 class CacheInvalidatorTest extends VarnishTestCase
 {
-    public function testInvalidateTags()
+    public function testInvalidateTags(): void
     {
         if (getenv('VARNISH_MODULES_VERSION')) {
             $uri = '/tags_xkey.php';

src/SymfonyCache/Compatibility/CacheInvalidationS6.php

@@ -25,7 +25,7 @@ trait BanAssertions
      * @param string     $header      The header that holds the URLs
      * @param array      $paths       The paths to get, defaults to [/cache.php, json.php]
      */
-    protected function assertBanAll(BanCapable $proxyClient, $header, array $paths = ['/cache.php', '/json.php'])
+    protected function assertBanAll(BanCapable $proxyClient, string $header, array $paths = ['/cache.php', '/json.php']): void
     {
         foreach ($paths as $path) {
             $this->assertMiss($this->getResponse($path));
@@ -47,7 +47,7 @@ protected function assertBanAll(BanCapable $proxyClient, $header, array $paths =
      * @param string     $hostname    Name of the host so we can invalidate that host
      * @param string     $path        The path to get, defaults to /cache.php
      */
-    protected function assertBanHost(BanCapable $proxyClient, $header, $hostname, $path = '/cache.php')
+    protected function assertBanHost(BanCapable $proxyClient, string $header, string $hostname, string $path = '/cache.php'): void
     {
         $this->assertMiss($this->getResponse($path));
         $this->assertHit($this->getResponse($path));
@@ -65,7 +65,7 @@ protected function assertBanHost(BanCapable $proxyClient, $header, $hostname, $p
      * @param BanCapable $proxyClient The client to send ban instructions to the cache
      * @param array      $paths       The paths to get, defaults to [/cache.php, json.php]
      */
-    protected function assertBanPath(BanCapable $proxyClient, array $paths = ['/cache.php', '/json.php'])
+    protected function assertBanPath(BanCapable $proxyClient, array $paths = ['/cache.php', '/json.php']): void
     {
         foreach ($paths as $path) {
             $this->assertMiss($this->getResponse($path));
@@ -86,7 +86,7 @@ protected function assertBanPath(BanCapable $proxyClient, array $paths = ['/cach
      * @param string     $htmlPath    Path to a HTML content, defaults to /cache.php
      * @param string     $otherPath   Path to a non-HTML content, defaults to json.php
      */
-    protected function assertBanPathContentType(BanCapable $proxyClient, $htmlPath = '/cache.php', $otherPath = '/json.php')
+    protected function assertBanPathContentType(BanCapable $proxyClient, string $htmlPath = '/cache.php', string $otherPath = '/json.php'): void
     {
         $this->assertMiss($this->getResponse($htmlPath));
         $this->assertHit($this->getResponse($htmlPath));

tests/Functional/CacheInvalidatorTest.php

@@ -20,7 +20,7 @@
 
 class HttpDispatcherTest extends TestCase
 {
-    public function testNetworkError()
+    public function testNetworkError(): void
     {
         $requestFactory = MessageFactoryDiscovery::find();
         $dispatcher = new HttpDispatcher(['localhost:1']);
@@ -34,7 +34,7 @@ public function testNetworkError()
         }
     }
 
-    public function testClientError()
+    public function testClientError(): void
     {
         $requestFactory = MessageFactoryDiscovery::find();
         $dispatcher = new HttpDispatcher(['http://foshttpcache.readthedocs.io']);