OXDEV-7768 Remove Template cache service

CHANGELOG-8.0.md

@@ -15,3 +15,4 @@
 - Remove deprecated global function \makeReadable()
 - Redundant `TemplateFileResolverInterface` functionality
 - Smarty templates support
+- Remove deprecated `TemplateCacheService` implementation

source/Internal/Framework/Cache/Command/ClearCacheCommand.php

@@ -6,7 +6,7 @@
 
 use OxidEsales\EshopCommunity\Internal\Framework\DIContainer\Service\ContainerCacheInterface;
 use OxidEsales\EshopCommunity\Internal\Framework\Module\Cache\ModuleCacheServiceInterface;
-use OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\TemplateCacheServiceInterface;
+use OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\ShopTemplateCacheServiceInterface;
 use OxidEsales\EshopCommunity\Internal\Transition\Adapter\ShopAdapterInterface;
 use OxidEsales\EshopCommunity\Internal\Transition\Utility\ContextInterface;
 use Symfony\Component\Console\Command\Command;
@@ -16,11 +16,11 @@
 class ClearCacheCommand extends Command
 {
     public function __construct(
-        private ShopAdapterInterface $shopAdapter,
-        private TemplateCacheServiceInterface $templateCacheService,
-        private ContainerCacheInterface $containerCache,
-        private ModuleCacheServiceInterface $moduleCacheService,
-        private ContextInterface $context
+        private readonly ShopAdapterInterface $shopAdapter,
+        private readonly ShopTemplateCacheServiceInterface $shopTemplateCacheService,
+        private readonly ContainerCacheInterface $containerCache,
+        private readonly ModuleCacheServiceInterface $moduleCacheService,
+        private readonly ContextInterface $context
     ) {
         parent::__construct();
     }
@@ -32,7 +32,7 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->templateCacheService->invalidateTemplateCache();
+        $this->shopTemplateCacheService->invalidateAllShopsCache();
         $this->shopAdapter->invalidateModulesCache();
 
         foreach ($this->context->getAllShopIds() as $shopId) {

source/Internal/Framework/Templating/Cache/ShopTemplateCacheService.php

@@ -16,8 +16,8 @@
 class ShopTemplateCacheService implements ShopTemplateCacheServiceInterface
 {
     public function __construct(
-        private ContextInterface $context,
-        private Filesystem $filesystem
+        private readonly ContextInterface $context,
+        private readonly Filesystem $filesystem
     ) {
     }
 

source/Internal/Framework/Templating/services.yaml

@@ -47,12 +47,6 @@ services:
     arguments:
       Symfony\Component\Filesystem\Filesystem: '@oxid_esales.symfony.file_system'
 
-  OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\TemplateCacheServiceInterface:
-    class: OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\TemplateCacheService
-    arguments:
-      - '@OxidEsales\EshopCommunity\Internal\Transition\Utility\ContextInterface'
-      - '@OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\ShopTemplateCacheServiceInterface'
-
   OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\ShopTemplateCacheServiceInterface:
     class: OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\ShopTemplateCacheService
     arguments:

source/Internal/Framework/Theme/Command/ThemeActivateCommand.php

@@ -10,7 +10,7 @@
 namespace OxidEsales\EshopCommunity\Internal\Framework\Theme\Command;
 
 use OxidEsales\EshopCommunity\Internal\Framework\Module\Cache\ModuleCacheServiceInterface;
-use OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\TemplateCacheServiceInterface;
+use OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\ShopTemplateCacheServiceInterface;
 use OxidEsales\EshopCommunity\Internal\Transition\Adapter\ShopAdapterInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -25,7 +25,7 @@ class ThemeActivateCommand extends Command
 
     public function __construct(
         private readonly ShopAdapterInterface $shopAdapter,
-        private readonly TemplateCacheServiceInterface $templateCacheService,
+        private readonly ShopTemplateCacheServiceInterface $shopTemplateCacheService,
         private readonly ModuleCacheServiceInterface $moduleCacheService
     ) {
         parent::__construct();
@@ -58,7 +58,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $this->shopAdapter->activateTheme($themeId);
         $this->moduleCacheService->invalidateAll();
-        $this->templateCacheService->invalidateTemplateCache();
+        $this->shopTemplateCacheService->invalidateAllShopsCache();
         $output->writeLn('<info>' . sprintf(self::MESSAGE_THEME_ACTIVATED, $themeId) . '</info>');
 
         return Command::SUCCESS;

source/Internal/Transition/Utility/BasicContext.php

@@ -240,12 +240,4 @@ public function getFacts(): Facts
         }
         return $this->facts;
     }
-
-    public function getTemplateCacheDirectory(): string
-    {
-        return Path::join(
-            $this->getCacheDirectory(),
-            'template_cache'
-        );
-    }
 }

source/Internal/Transition/Utility/BasicContextInterface.php

@@ -137,9 +137,4 @@ public function getFacts(): Facts;
     public function getCacheDirectory(): string;
 
     public function getModuleCacheDirectory(): string;
-
-    /**
-     * @deprecated Use OxidEsales\Eshop\Internal\Framework\Templating\Cache\ShopTemplateCacheServiceInterface instead
-     */
-    public function getTemplateCacheDirectory(): string;
 }

tests/Integration/Internal/Framework/Templating/Cache/ShopTemplateCacheServiceTest.php

@@ -21,7 +21,6 @@ final class ShopTemplateCacheServiceTest extends TestCase
     use ContainerTrait;
 
     private int $shopId;
-    private array $shopsIds;
     private string $shopTemplateCachePath;
     private Filesystem $filesystem;
     private ShopTemplateCacheServiceInterface $shopTemplateCacheService;
@@ -30,7 +29,6 @@ protected function setUp(): void
     {
         $this->filesystem = new Filesystem();
         $this->shopId = $this->get(ContextInterface::class)->getCurrentShopId();
-        $this->shopsIds = $this->get(ContextInterface::class)->getAllShopIds();
         $this->shopTemplateCachePath = $this->get(ShopTemplateCacheServiceInterface::class)
             ->getCacheDirectory($this->shopId);
 
@@ -49,55 +47,30 @@ public function testInvalidateCache(): void
         $this->assertEquals(0, $this->countShopCacheFiles($this->shopId));
     }
 
-    public function testInvalidateAllShopsCache(): void
-    {
-        $this->assertNotEquals(0, $this->countCacheFiles());
-
-        $this->get(ShopTemplateCacheServiceInterface::class)->invalidateAllShopsCache();
-
-        $this->assertEquals(0, $this->countCacheFiles());
-    }
-
     private function clearTemplateCache(): void
     {
-        foreach ($this->shopsIds as $shopId) {
-            $this->filesystem->remove(
-                $this->get(ShopTemplateCacheServiceInterface::class)
-                    ->getCacheDirectory($shopId)
-            );
-        }
+        $this->filesystem->remove(
+            $this->get(ShopTemplateCacheServiceInterface::class)->getCacheDirectory($this->shopId)
+        );
     }
 
     private function countShopCacheFiles($shopId): int
     {
-        return count(\glob($this->get(ShopTemplateCacheServiceInterface::class)
-            ->getCacheDirectory($shopId)));
-    }
-
-    private function countCacheFiles(): int
-    {
-        $files = 0;
-        foreach ($this->shopsIds as $shopId) {
-            $files += $this->countShopCacheFiles($shopId);
-        }
-        return $files;
+        return count(\glob($this->get(ShopTemplateCacheServiceInterface::class)->getCacheDirectory($shopId)));
     }
 
     private function populateTemplateCache(): void
     {
         $numberOfTestFiles = 3;
-        foreach ($this->shopsIds as $shopId) {
-            $templateCachePath = $this->get(ShopTemplateCacheServiceInterface::class)
-                ->getCacheDirectory($shopId);
-            $this->filesystem->mkdir($templateCachePath);
-            for ($i = 0; $i < $numberOfTestFiles; $i++) {
-                $this->filesystem->touch(
-                    Path::join(
-                        $templateCachePath,
-                        uniqid('template-file-' . $shopId, true)
-                    )
-                );
-            }
+        $templateCachePath = $this->get(ShopTemplateCacheServiceInterface::class)->getCacheDirectory($this->shopId);
+        $this->filesystem->mkdir($templateCachePath);
+        for ($i = 0; $i < $numberOfTestFiles; $i++) {
+            $this->filesystem->touch(
+                Path::join(
+                    $templateCachePath,
+                    uniqid('template-file-' . $this->shopId, true)
+                )
+            );
         }
     }
 }

tests/Unit/Internal/BasicContextStub.php

@@ -38,7 +38,6 @@ class BasicContextStub implements BasicContextInterface
     private string $composerVendorName;
     private string $cacheDirectory;
     private string $moduleCacheDirectory;
-    private string $templateCacheDirectory;
     private int $currentShopId;
     private string $activeModuleServicesFilePath;
 
@@ -64,7 +63,6 @@ public function __construct()
         $this->composerVendorName = $basicContext->getComposerVendorName();
         $this->cacheDirectory = $basicContext->getCacheDirectory();
         $this->moduleCacheDirectory = $basicContext->getModuleCacheDirectory();
-        $this->templateCacheDirectory = $basicContext->getTemplateCacheDirectory();
         $this->currentShopId = $basicContext->getCurrentShopId();
         $this->activeModuleServicesFilePath = $basicContext->getActiveModuleServicesFilePath($this->getCurrentShopId());
         $this->shopConfigurableServicesFilePath = $basicContext->getShopConfigurableServicesFilePath(
@@ -237,11 +235,6 @@ public function getShopConfigurationDirectory(int $shopId): string
         return Path::join($this->getProjectConfigurationDirectory(), 'shops', (string)$shopId);
     }
 
-    public function getTemplateCacheDirectory(): string
-    {
-        return $this->templateCacheDirectory;
-    }
-
     public function setTemplateCacheDirectory(string $templateCacheDirectory): void
     {
         $this->templateCacheDirectory = $templateCacheDirectory;

tests/Unit/Internal/Framework/Cache/Command/ClearCacheCommandTest.php

@@ -12,7 +12,7 @@
 use OxidEsales\EshopCommunity\Internal\Framework\Cache\Command\ClearCacheCommand;
 use OxidEsales\EshopCommunity\Internal\Framework\DIContainer\Service\ContainerCacheInterface;
 use OxidEsales\EshopCommunity\Internal\Framework\Module\Cache\ModuleCacheServiceInterface;
-use OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\TemplateCacheService;
+use OxidEsales\EshopCommunity\Internal\Framework\Templating\Cache\ShopTemplateCacheServiceInterface;
 use OxidEsales\EshopCommunity\Internal\Transition\Adapter\ShopAdapterInterface;
 use OxidEsales\EshopCommunity\Internal\Transition\Utility\ContextInterface;
 use PHPUnit\Framework\TestCase;
@@ -26,8 +26,8 @@ public function testClearCacheTriggersRegularAndTemplatesCleaners(): void
         $shopAdapterMock = $this->createMock(ShopAdapterInterface::class);
         $shopAdapterMock->expects($this->once())->method('invalidateModulesCache');
 
-        $templateCacheServiceMock = $this->createMock(TemplateCacheService::class);
-        $templateCacheServiceMock->expects($this->once())->method('invalidateTemplateCache');
+        $shopTemplateCacheServiceMock = $this->createMock(ShopTemplateCacheServiceInterface::class);
+        $shopTemplateCacheServiceMock->expects($this->once())->method('invalidateAllShopsCache');
 
         $containerCacheMock = $this->createMock(ContainerCacheInterface::class);
         $containerCacheMock->expects($this->once())->method('invalidate');
@@ -40,7 +40,7 @@ public function testClearCacheTriggersRegularAndTemplatesCleaners(): void
 
         $command = new ClearCacheCommand(
             $shopAdapterMock,
-            $templateCacheServiceMock,
+            $shopTemplateCacheServiceMock,
             $containerCacheMock,
             $moduleCacheServiceMock,
             $contextMock