fix: static typing and final classes (#621)

* fix: static typing and final classes

* remove legacy code in Configuration class

src/DependencyInjection/Compiler/HashGeneratorPass.php

@@ -19,9 +19,9 @@
 /**
  * Add tagged provider to the hash generator for user context.
  */
-class HashGeneratorPass implements CompilerPassInterface
+final class HashGeneratorPass implements CompilerPassInterface
 {
-    const TAG_NAME = 'fos_http_cache.user_context_provider';
+    public const TAG_NAME = 'fos_http_cache.user_context_provider';
 
     /**
      * {@inheritdoc}

src/DependencyInjection/Compiler/LoggerPass.php

@@ -17,7 +17,7 @@
 /**
  * Announce the log listener to the symfony event system.
  */
-class LoggerPass implements CompilerPassInterface
+final class LoggerPass implements CompilerPassInterface
 {
     /**
      * {@inheritdoc}

src/DependencyInjection/Compiler/SessionListenerPass.php

@@ -20,7 +20,7 @@
  * AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER from being leaked to
  * the client.
  */
-class SessionListenerPass implements CompilerPassInterface
+final class SessionListenerPass implements CompilerPassInterface
 {
     /**
      * {@inheritdoc}

src/DependencyInjection/Configuration.php

@@ -18,7 +18,6 @@
 use JeanBeru\HttpCacheCloudFront\Proxy\CloudFront;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
-use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
@@ -34,7 +33,7 @@
  * @author David de Boer <david@driebit.nl>
  * @author David Buchmann <mail@davidbu.ch>
  */
-class Configuration implements ConfigurationInterface
+final class Configuration implements ConfigurationInterface
 {
     /**
      * @var bool
@@ -55,13 +54,7 @@ public function __construct($debug)
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('fos_http_cache');
-
-        // Keep compatibility with symfony/config < 4.2
-        if (!method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->root('fos_http_cache');
-        } else {
-            $rootNode = $treeBuilder->getRootNode();
-        }
+        $rootNode = $treeBuilder->getRootNode();
 
         $rootNode
             ->validate()
@@ -240,7 +233,7 @@ private function isFastly(array $v): bool
             && array_key_exists('fastly', $v['proxy_client']);
     }
 
-    private function addCacheableResponseSection(ArrayNodeDefinition $rootNode)
+    private function addCacheableResponseSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -278,7 +271,7 @@ private function addCacheableResponseSection(ArrayNodeDefinition $rootNode)
     /**
      * Cache header control main section.
      */
-    private function addCacheControlSection(ArrayNodeDefinition $rootNode)
+    private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
     {
         $rules = $rootNode
             ->children()
@@ -366,7 +359,7 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode)
      *
      * @param bool $matchResponse whether to also add fields to match response
      */
-    private function addMatch(NodeBuilder $rules, $matchResponse = false)
+    private function addMatch(NodeBuilder $rules, $matchResponse = false): void
     {
         $match = $rules
             ->arrayNode('match')
@@ -610,19 +603,11 @@ private function addProxyClientSection(ArrayNodeDefinition $rootNode): void
 
     /**
      * Get the configuration node for a HTTP dispatcher in a proxy client.
-     *
-     * @return NodeDefinition
      */
-    private function getHttpDispatcherNode()
+    private function getHttpDispatcherNode(): ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('http');
-
-        // Keep compatibility with symfony/config < 4.2
-        if (!method_exists($treeBuilder, 'getRootNode')) {
-            $node = $treeBuilder->root('http');
-        } else {
-            $node = $treeBuilder->getRootNode();
-        }
+        $node = $treeBuilder->getRootNode();
 
         $node
             ->fixXmlConfig('server')
@@ -650,16 +635,10 @@ private function getHttpDispatcherNode()
         return $node;
     }
 
-    private function getCloudflareHttpDispatcherNode()
+    private function getCloudflareHttpDispatcherNode(): ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('http');
-
-        // Keep compatibility with symfony/config < 4.2
-        if (!method_exists($treeBuilder, 'getRootNode')) {
-            $node = $treeBuilder->root('http');
-        } else {
-            $node = $treeBuilder->getRootNode();
-        }
+        $node = $treeBuilder->getRootNode();
 
         $node
             ->addDefaultsIfNotSet()
@@ -680,10 +659,9 @@ private function getCloudflareHttpDispatcherNode()
         return $node;
     }
 
-    private function getFastlyHttpDispatcherNode()
+    private function getFastlyHttpDispatcherNode(): ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('http');
-
         $node = $treeBuilder->getRootNode();
 
         $node
@@ -709,7 +687,7 @@ private function getFastlyHttpDispatcherNode()
         return $node;
     }
 
-    private function addTestSection(ArrayNodeDefinition $rootNode)
+    private function addTestSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -752,7 +730,7 @@ private function addTestSection(ArrayNodeDefinition $rootNode)
     /**
      * Cache manager main section.
      */
-    private function addCacheManagerSection(ArrayNodeDefinition $rootNode)
+    private function addCacheManagerSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -792,7 +770,7 @@ private function addCacheManagerSection(ArrayNodeDefinition $rootNode)
         ;
     }
 
-    private function addTagSection(ArrayNodeDefinition $rootNode)
+    private function addTagSection(ArrayNodeDefinition $rootNode): void
     {
         $rules = $rootNode
             ->children()
@@ -848,7 +826,7 @@ private function addTagSection(ArrayNodeDefinition $rootNode)
         ;
     }
 
-    private function addInvalidationSection(ArrayNodeDefinition $rootNode)
+    private function addInvalidationSection(ArrayNodeDefinition $rootNode): void
     {
         $rules = $rootNode
             ->children()
@@ -889,7 +867,7 @@ private function addInvalidationSection(ArrayNodeDefinition $rootNode)
     /**
      * User context main section.
      */
-    private function addUserContextListenerSection(ArrayNodeDefinition $rootNode)
+    private function addUserContextListenerSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -958,7 +936,7 @@ private function addUserContextListenerSection(ArrayNodeDefinition $rootNode)
         ;
     }
 
-    private function addFlashMessageSection(ArrayNodeDefinition $rootNode)
+    private function addFlashMessageSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -988,7 +966,7 @@ private function addFlashMessageSection(ArrayNodeDefinition $rootNode)
             ->end();
     }
 
-    private function addDebugSection(ArrayNodeDefinition $rootNode)
+    private function addDebugSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()

src/DependencyInjection/FOSHttpCacheExtension.php

@@ -31,7 +31,7 @@
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
-class FOSHttpCacheExtension extends Extension
+final class FOSHttpCacheExtension extends Extension
 {
     public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
     {
@@ -579,7 +579,7 @@ private function loadProxyServer(ContainerBuilder $container, XmlFileLoader $loa
         );
     }
 
-    private function loadVarnishProxyServer(ContainerBuilder $container, XmlFileLoader $loader, $config): void
+    private function loadVarnishProxyServer(ContainerBuilder $container, XmlFileLoader $loader, array $config): void
     {
         $loader->load('varnish_proxy.xml');
         foreach ($config as $key => $value) {
@@ -590,7 +590,7 @@ private function loadVarnishProxyServer(ContainerBuilder $container, XmlFileLoad
         }
     }
 
-    private function loadNginxProxyServer(ContainerBuilder $container, XmlFileLoader $loader, $config): void
+    private function loadNginxProxyServer(ContainerBuilder $container, XmlFileLoader $loader, array $config): void
     {
         $loader->load('nginx_proxy.xml');
         foreach ($config as $key => $value) {
@@ -627,7 +627,7 @@ private function loadInvalidatorRules(ContainerBuilder $container, array $config
         }
     }
 
-    private function validateUrl($url, $msg): void
+    private function validateUrl(string $url, string $msg): void
     {
         $prefixed = $this->prefixSchema($url);
 
@@ -636,7 +636,7 @@ private function validateUrl($url, $msg): void
         }
     }
 
-    private function prefixSchema($url)
+    private function prefixSchema(string $url): string
     {
         if (!str_contains($url, '://')) {
             $url = sprintf('%s://%s', 'http', $url);
@@ -645,7 +645,7 @@ private function prefixSchema($url)
         return $url;
     }
 
-    private function getDefaultProxyClient(array $config)
+    private function getDefaultProxyClient(array $config): string
     {
         if (isset($config['default'])) {
             return $config['default'];

src/EventListener/AbstractRuleListener.php

@@ -31,7 +31,7 @@ abstract class AbstractRuleListener
     public function addRule(
         RequestMatcherInterface $requestMatcher,
         array $settings = []
-    ) {
+    ): void {
         $this->rulesMap[] = [$requestMatcher, $settings];
     }
 
@@ -40,7 +40,7 @@ public function addRule(
      *
      * @return array|false Settings to apply or false if no rule matched
      */
-    protected function matchRule(Request $request)
+    protected function matchRule(Request $request): array|false
     {
         foreach ($this->rulesMap as $elements) {
             if ($elements[0]->matches($request)) {

src/EventListener/AttributesListener.php

@@ -15,7 +15,7 @@
  *
  * @author Yoann Chocteau <yoann@kezaweb.fr>
  */
-class AttributesListener implements EventSubscriberInterface
+final class AttributesListener implements EventSubscriberInterface
 {
     public function __construct(
         private ControllerResolverInterface $controllerResolver

src/EventListener/CacheControlListener.php

@@ -26,7 +26,7 @@
  * @author Lea Haensenberger <lea.haensenberger@gmail.com>
  * @author David Buchmann <mail@davidbu.ch>
  */
-class CacheControlListener implements EventSubscriberInterface
+final class CacheControlListener implements EventSubscriberInterface
 {
     /**
      * Whether to skip this response and not set any cache headers.
@@ -52,7 +52,7 @@ class CacheControlListener implements EventSubscriberInterface
      * If not empty, add a debug header with that name to all responses,
      * telling the cache proxy to add debug output.
      *
-     * @var string|bool Name of the header or false to add no header
+     * @var string|false Name of the header or false to add no header
      */
     private string|false $debugHeader;
 
@@ -96,7 +96,7 @@ public function onKernelResponse(ResponseEvent $event): void
         $response = $event->getResponse();
 
         if ($this->debugHeader) {
-            $response->headers->set($this->debugHeader, 1, false);
+            $response->headers->set($this->debugHeader, '1', false);
         }
 
         // do not change cache directives on non-cacheable requests.
@@ -125,7 +125,7 @@ public function onKernelResponse(ResponseEvent $event): void
             && null !== $options['reverse_proxy_ttl']
             && !$response->headers->has('X-Reverse-Proxy-TTL')
         ) {
-            $response->headers->set('X-Reverse-Proxy-TTL', (int) $options['reverse_proxy_ttl'], false);
+            $response->headers->set('X-Reverse-Proxy-TTL', $options['reverse_proxy_ttl'], false);
         }
 
         if (!empty($options['vary'])) {

src/EventListener/InvalidationListener.php

@@ -33,7 +33,7 @@
  *
  * @author David de Boer <david@driebit.nl>
  */
-class InvalidationListener extends AbstractRuleListener implements EventSubscriberInterface
+final class InvalidationListener extends AbstractRuleListener implements EventSubscriberInterface
 {
     private CacheManager $cacheManager;
     private UrlGeneratorInterface $urlGenerator;
@@ -136,7 +136,7 @@ private function handleInvalidation(Request $request, Response $response): void
         }
 
         // Check configured invalidators
-        if (!$invalidatorConfigs = $this->matchRule($request, $response)) {
+        if (!$invalidatorConfigs = $this->matchRule($request)) {
             return;
         }
 

src/EventListener/SwitchUserListener.php

@@ -16,7 +16,7 @@
 use Symfony\Component\Security\Http\Event\SwitchUserEvent;
 use Symfony\Component\Security\Http\SecurityEvents;
 
-class SwitchUserListener implements EventSubscriberInterface
+final class SwitchUserListener implements EventSubscriberInterface
 {
     private UserContextInvalidator $invalidator;
 

src/EventListener/TagListener.php

@@ -27,7 +27,7 @@
  *
  * @author David de Boer <david@driebit.nl>
  */
-class TagListener extends AbstractRuleListener implements EventSubscriberInterface
+final class TagListener extends AbstractRuleListener implements EventSubscriberInterface
 {
     private CacheManager $cacheManager;
     private SymfonyResponseTagger $symfonyResponseTagger;
@@ -108,7 +108,7 @@ public static function getSubscribedEvents(): array
      * Get the tags from the attributes on the controller that was used in the
      * request.
      *
-     * @return array List of tags affected by the request
+     * @return string[] List of tags affected by the request
      */
     private function getAttributeTags(Request $request): array
     {

src/EventListener/UserContextListener.php

@@ -34,7 +34,7 @@
  * @author Stefan Paschke <stefan.paschke@gmail.com>
  * @author Joel Wurtz <joel.wurtz@gmail.com>
  */
-class UserContextListener implements EventSubscriberInterface
+final class UserContextListener implements EventSubscriberInterface
 {
     private RequestMatcherInterface $requestMatcher;
     private HashGenerator $hashGenerator;
@@ -136,7 +136,7 @@ public function onKernelRequest(RequestEvent $event): void
             $response->setPublic();
             if ($this->hasSessionListener) {
                 // header to avoid Symfony SessionListener overwriting the response to private
-                $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, 1);
+                $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, '1');
             }
         } else {
             $response->setClientTtl(0);
@@ -201,7 +201,7 @@ public function onKernelResponse(ResponseEvent $event): void
             // user hash header was in vary or just added here by "add_vary_on_hash"
             if ($this->hasSessionListener && in_array($this->options['user_hash_header'], $vary, true)) {
                 // header to avoid Symfony SessionListener overwriting the response to private
-                $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, 1);
+                $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, '1');
             }
         } elseif ($this->options['add_vary_on_hash']) {
             /*