Merge pull request #5 from mothership-gmbh/dev

Shopware 6.5 compatibility
mothership-gmbh · Nov 15, 2023 · 6bec8cb · 6bec8cb
2 parents f2a955b + f2847c9
commit 6bec8cb
Show file tree

Hide file tree

Showing 12 changed files with 65 additions and 126 deletions.
diff --git a/Adapter/Cache/CacheItemPool.php b/Adapter/Cache/CacheItemPool.php
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,4 @@
+# 2.0.0
+- Shopware 6.5 compatibility
+- removed custom cache pool and override of `CacheClearer` in favour of a new cache clearer using the tag `kernel.
+  cache_clearer`. This is no change in functionality, just refactoring.
diff --git a/Cache/GatewayInterface.php b/Cache/GatewayInterface.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Mothership\HeadlessShopwareVarnishCacheBundle\Cache;
 
 interface GatewayInterface {

diff --git a/Cache/VarnishCacheClearer.php b/Cache/VarnishCacheClearer.php
@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace Mothership\HeadlessShopwareVarnishCacheBundle\Cache;
+
+use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
+
+class VarnishCacheClearer implements CacheClearerInterface
+{
+    public function __construct(protected readonly GatewayInterface $gateway)
+    {
+    }
+
+    public function clear(string $cacheDir): void
+    {
+        $this->gateway->invalidate(['all']);
+    }
+}
diff --git a/Cache/VarnishGateway.php b/Cache/VarnishGateway.php
@@ -82,9 +82,8 @@ public function flushCollected(): void
     {
         $requests = [];
         /**
-         * Wenn Properties via API aktualisiert werden, werden alle Produkte gepurged. Um nicht mehrere
-         * tausend Purge Requests zu schicken, schicken wir einen Purge-All-Tag, wenn ein Limit erreicht ist.
-         *
+         * When properties are updated via API, all products are purged. To avoid sending several thousand purge
+         * requests, we send a purge all tag when a limit is reached.
          * @see \Shopware\Core\Framework\Adapter\Cache\CacheInvalidationSubscriber::getChangedPropertyFilterTags
          */
         if (count($this->invalidateTags) > $this->tagFlushThreshold) {

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mothership\HeadlessShopwareVarnishCacheBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -11,20 +13,20 @@ class Configuration implements ConfigurationInterface
     /**
      * @inheritDoc
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('headless_shopware_varnish_cache');
         $treeBuilder->getRootNode()
             ->children()
                 ->booleanNode('enabled')->defaultFalse()->end()
-                ->arrayNode('reverse_proxy')
+                ?->arrayNode('reverse_proxy')
                     ->children()
                         ->variableNode('hosts')->defaultNull()->end()
-                        ->scalarNode('max_parallel_invalidations')->end()
-                        ->scalarNode('ban_method')->end()
-                        ->scalarNode('tag_flush_threshold')->end()
-                        ->booleanNode('use_xkey')->defaultFalse()->end()
-                        ->scalarNode('xkey_chunksize')->defaultValue(50)->end();
+                        ?->scalarNode('max_parallel_invalidations')->end()
+                        ?->scalarNode('ban_method')->end()
+                        ?->scalarNode('tag_flush_threshold')->end()
+                        ?->booleanNode('use_xkey')->defaultFalse()->end()
+                        ?->scalarNode('xkey_chunksize')->defaultValue(50)->end();
         return $treeBuilder;
     }
 }
diff --git a/DependencyInjection/HeadlessShopwareVarnishCacheExtension.php b/DependencyInjection/HeadlessShopwareVarnishCacheExtension.php
@@ -1,22 +1,24 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mothership\HeadlessShopwareVarnishCacheBundle\DependencyInjection;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
-use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use function is_array;
 
 class HeadlessShopwareVarnishCacheExtension extends Extension
 {
 
     /**
      * @inheritDoc
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
-        $this->addConfig($container, "headless_shopware_varnish_cache", $config);
+        $this->addConfig($container, 'headless_shopware_varnish_cache', $config);
     }
 
     /**
@@ -30,7 +32,7 @@ private function addConfig(ContainerBuilder $container, string $alias, array $op
         foreach ($options as $key => $option) {
             $container->setParameter($alias . '.' . $key, $option);
 
-            if (\is_array($option)) {
+            if (is_array($option)) {
                 $this->addConfig($container, $alias . '.' . $key, $option);
             }
         }

diff --git a/Event/RequestSubscriber.php b/Event/RequestSubscriber.php
@@ -33,7 +33,8 @@ public static function getSubscribedEvents(): array
     }
 
     /**
-     * Der Worker beendet sich nach 60 sekunden. Siehe supervisor configuration.
+     * Worker stops after 60s. See worker/supervisor configuration
+     * Flush all collected tags in this case.
      *
      * @return void
      */
@@ -42,11 +43,19 @@ public function onWorkerStopped(): void
         $this->varnishGateway->flushCollected();
     }
 
+    /**
+     * When a request is finished, flush all collected invalidation tags, instead of flushing every tag on its own
+     * @return void
+     */
     public function onKernelFinish(): void
     {
         $this->varnishGateway->flushCollected();
     }
 
+    /**
+     * Same as for request finish, just for CLI commands.
+     * @return void
+     */
     public function onConsoleTerminate(): void
     {
         $this->varnishGateway->flushCollected();

diff --git a/Event/ReverseProxyCache.php b/Event/ReverseProxyCache.php
@@ -27,9 +27,10 @@ public function __invoke(InvalidateCacheEvent $event): void
     }
 
     /**
+     * @param Request $request
      * @return Response|null
      */
-    public function lookup(Request $request)
+    public function lookup(Request $request): ?Response
     {
         return null;
     }
@@ -86,7 +87,7 @@ public function purge(string $url): bool
     }
 
     /**
-     * We don't need an cleanup
+     * We don't need cleanup
      */
     public function cleanup(): void
     {

diff --git a/HeadlessShopwareVarnishCacheBundle.php b/HeadlessShopwareVarnishCacheBundle.php
@@ -4,10 +4,14 @@
 
 use Mothership\HeadlessShopwareVarnishCacheBundle\DependencyInjection\HeadlessShopwareVarnishCacheExtension;
 use Shopware\Core\Framework\Bundle;
+use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 
 class HeadlessShopwareVarnishCacheBundle extends Bundle
 {
-    public function getContainerExtension()
+    /**
+     * @return ExtensionInterface|null
+     */
+    public function getContainerExtension(): ?ExtensionInterface
     {
         return new HeadlessShopwareVarnishCacheExtension();
     }

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -34,21 +34,9 @@
             <argument type="service" id="Mothership\HeadlessShopwareVarnishCacheBundle\Cache\VarnishGateway"/>
         </service>
 
-        <service id="Mothership\HeadlessShopwareVarnishCacheBundle\Adapter\Cache\CacheItemPool">
+        <service id="Mothership\HeadlessShopwareVarnishCacheBundle\Cache\VarnishCacheClearer">
             <argument type="service" id="Mothership\HeadlessShopwareVarnishCacheBundle\Cache\VarnishGateway" />
-        </service>
-
-        <service id="Shopware\Core\Framework\Adapter\Cache\CacheClearer">
-            <argument type="collection">
-                <argument type="service" id="cache.object"/>
-                <argument type="service" id="cache.http"/>
-                <argument type="service" id="Mothership\HeadlessShopwareVarnishCacheBundle\Adapter\Cache\CacheItemPool"/>
-            </argument>
-            <argument type="service" id="cache_clearer"/>
-            <argument type="service" id="filesystem"/>
-            <argument>%kernel.cache_dir%</argument>
-            <argument>%kernel.environment%</argument>
-            <argument type="service" id="messenger.bus.shopware"/>
+            <tag name="kernel.cache_clearer"/>
         </service>
     </services>
 </container>
diff --git a/composer.json b/composer.json
@@ -14,12 +14,12 @@
         }
     ],
     "require": {
-        "php": ">=7.4",
-        "shopware/core": "^v6.4.18",
-        "shopware/storefront": "^v6.4.18"
+        "php": ">=8.1",
+        "shopware/core": "^v6.5",
+        "shopware/storefront": "^v6.5"
     },
     "require-dev": {
-        "symfony/dependency-injection": "^5 | ^6"
+        "symfony/dependency-injection": "^6"
     },
     "autoload": {
         "psr-4": {