FFWEB-2686: Cache field roles as they are searched for on every request

Author: grzegorz-jamroz

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## Unreleased
+- SSR
+  - Cache field roles
+
 ## [v4.2.2] - 2023.03.16
 ### Add
 - Proxy

src/Api/UpdateFieldRolesController.php

@@ -5,7 +5,7 @@
 namespace Omikron\FactFinder\Shopware6\Api;
 
 use Exception;
-use Omikron\FactFinder\Shopware6\Config\FieldRoles;
+use Omikron\FactFinder\Shopware6\Config\FieldRolesInterface;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
@@ -20,10 +20,10 @@
  */
 class UpdateFieldRolesController extends AbstractController
 {
-    private FieldRoles $fieldRoles;
+    private FieldRolesInterface $fieldRoles;
     private EntityRepositoryInterface $channelRepository;
 
-    public function __construct(FieldRoles $fieldRolesService, EntityRepositoryInterface $channelRepository)
+    public function __construct(FieldRolesInterface $fieldRolesService, EntityRepositoryInterface $channelRepository)
     {
         $this->fieldRoles        = $fieldRolesService;
         $this->channelRepository = $channelRepository;

src/Config/CachedFieldRoles.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\FactFinder\Shopware6\Config;
+
+use Symfony\Component\Cache\Adapter\AdapterInterface;
+
+class CachedFieldRoles implements FieldRolesInterface
+{
+    private FieldRolesInterface $decorated;
+    private AdapterInterface $cache;
+
+    public function __construct(FieldRolesInterface $decorated, AdapterInterface $cache)
+    {
+        $this->decorated = $decorated;
+        $this->cache     = $cache;
+    }
+
+    public function getRoles(?string $salesChannelId): array
+    {
+        $salesChannelId = $salesChannelId ?? '';
+        $cacheKey       = $this->getCacheKey($salesChannelId);
+        $item           = $this->cache->getItem($cacheKey);
+
+        if ($item->isHit()) {
+            return $item->get();
+        }
+
+        $fieldRoles = $this->decorated->getRoles($salesChannelId);
+        $item->set($fieldRoles);
+        $this->cache->save($item);
+
+        return $fieldRoles;
+    }
+
+    public function update(
+        array $fieldRoles,
+        ?string $salesChannelId
+    ): void {
+        $salesChannelId = $salesChannelId ?? '';
+        $this->decorated->update($fieldRoles, $salesChannelId);
+        $cacheKey = $this->getCacheKey($salesChannelId);
+
+        if ($this->cache->hasItem($cacheKey)) {
+            $this->cache->deleteItem($cacheKey);
+        }
+    }
+
+    private function getCacheKey(string $salesChannelId): string
+    {
+        return sprintf('factfinder-field-roles-%s', $salesChannelId);
+    }
+}

src/Config/FieldRoles.php

@@ -8,7 +8,7 @@
 use Shopware\Core\System\SystemConfig\SystemConfigService;
 use function Omikron\FactFinder\Shopware6\Internal\Utils\safeGetByName;
 
-class FieldRoles
+class FieldRoles implements FieldRolesInterface
 {
     private Search $search;
     private Communication $communicationConfig;

src/Config/FieldRolesInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\FactFinder\Shopware6\Config;
+
+interface FieldRolesInterface
+{
+    public function getRoles(?string $salesChannelId): array;
+
+    public function update(array $fieldRoles, ?string $salesChannelId): void;
+}

src/Resources/config/services.xml

@@ -75,6 +75,7 @@
             <bind key="$configurationAddParams">%factfinder.configuration.add_params%</bind>
             <bind key="$communicationParameters">%factfinder.communication.parameters.base%</bind>
             <bind key="$entryRepository" type="service" id="factfinder_feed_preprocessor.repository" />
+            <bind key="$cache" type="service" id="cache.object" />
         </defaults>
 
         <service id="Omikron\FactFinder\Shopware6\Communication\AdapterFactory" />
@@ -182,5 +183,7 @@
             <argument type="service" id="Omikron\FactFinder\Shopware6\Utilites\Ssr\Template\Filter"/>
         </service>
         <service id="Omikron\FactFinder\Shopware6\Utilites\Ssr\Template\Engine" />
+        <service id="Omikron\FactFinder\Shopware6\Config\FieldRolesInterface"
+                 alias="Omikron\FactFinder\Shopware6\Config\FieldRoles" />
     </services>
 </container>

src/Utilites/Ssr/PriceFormatter.php

@@ -4,7 +4,7 @@
 
 namespace Omikron\FactFinder\Shopware6\Utilites\Ssr;
 
-use Omikron\FactFinder\Shopware6\Config\FieldRoles;
+use Omikron\FactFinder\Shopware6\Config\CachedFieldRoles;
 use Omikron\FactFinder\Shopware6\Export\SalesChannelService;
 use Shopware\Core\System\Currency\CurrencyFormatter;
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
@@ -20,7 +20,7 @@ class PriceFormatter
     public function __construct(
         SalesChannelService $channelService,
         CurrencyFormatter $currencyFormatter,
-        FieldRoles $fieldRolesService,
+        CachedFieldRoles $fieldRolesService,
         array $fieldRoles
     ) {
         $this->channelService    = $channelService;

src/Utilites/Ssr/Template/Filter.php

@@ -4,7 +4,7 @@
 
 namespace Omikron\FactFinder\Shopware6\Utilites\Ssr\Template;
 
-use Omikron\FactFinder\Shopware6\Config\FieldRoles;
+use Omikron\FactFinder\Shopware6\Config\CachedFieldRoles;
 use Omikron\FactFinder\Shopware6\Export\Filter\FilterInterface;
 use Omikron\FactFinder\Shopware6\Export\SalesChannelService;
 
@@ -14,7 +14,7 @@ class Filter implements FilterInterface
 
     public function __construct(
         SalesChannelService $channelService,
-        FieldRoles $fieldRolesService
+        CachedFieldRoles $fieldRolesService
     ) {
         $context          = $channelService->getSalesChannelContext();
         $this->fieldRoles = $fieldRolesService->getRoles($context->getSalesChannelId());