[framework] Two level cache

packages/framework/src/Component/LocalCache/Exception/LocalCacheException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\LocalCache\Exception;
+
+use Exception;
+
+class LocalCacheException extends Exception
+{
+}

packages/framework/src/Component/LocalCache/Exception/NamespaceCacheKeyNotFoundException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\LocalCache\Exception;
+
+class NamespaceCacheKeyNotFoundException extends LocalCacheException
+{
+    /**
+     * @param string $namespace
+     */
+    public function __construct(string $namespace)
+    {
+        parent::__construct(sprintf('Namespace cache key "%s" not found', $namespace));
+    }
+}

packages/framework/src/Component/LocalCache/Exception/ValueCacheKeyNotFoundException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\LocalCache\Exception;
+
+class ValueCacheKeyNotFoundException extends LocalCacheException
+{
+    /**
+     * @param string $namespace
+     * @param string $valueKey
+     */
+    public function __construct(string $namespace, string $valueKey)
+    {
+        parent::__construct(sprintf('Value with keys "%s" and "%s" not found', $namespace, $valueKey));
+    }
+}

packages/framework/src/Component/LocalCache/LocalCacheFacade.php

@@ -0,0 +1,181 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\LocalCache;
+
+use Shopsys\FrameworkBundle\Component\LocalCache\Exception\NamespaceCacheKeyNotFoundException;
+use Shopsys\FrameworkBundle\Component\LocalCache\Exception\ValueCacheKeyNotFoundException;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use Symfony\Contracts\Service\ResetInterface;
+
+class LocalCacheFacade implements ResetInterface
+{
+    protected const NOT_ALLOWED_CHARS = '{}()/\@:".';
+
+    protected ArrayAdapter $namespacesCache;
+
+    public function __construct()
+    {
+        $this->namespacesCache = new ArrayAdapter(0, false);
+    }
+
+    /**
+     * @param string $namespace
+     * @param string $key
+     * @return mixed
+     */
+    public function getItem(string $namespace, string $key): mixed
+    {
+        if (!$this->hasNamespaceCache($namespace)) {
+            throw new NamespaceCacheKeyNotFoundException($namespace);
+        }
+
+        $this->fixKey($key);
+
+        if (!$this->hasItem($namespace, $key)) {
+            throw new ValueCacheKeyNotFoundException($namespace, $key);
+        }
+
+        return $this->getNamespaceCache($namespace)->getItem($key)->get();
+    }
+
+    /**
+     * @param string $namespace
+     * @return array
+     */
+    public function getValuesByNamespace(string $namespace): array
+    {
+        if (!$this->hasNamespaceCache($namespace)) {
+            throw new NamespaceCacheKeyNotFoundException($namespace);
+        }
+
+        return $this->getNamespaceCache($namespace)->getValues();
+    }
+
+    /**
+     * @param string $namespace
+     * @return \Symfony\Component\Cache\Adapter\ArrayAdapter
+     */
+    protected function getNamespaceCache(string $namespace): ArrayAdapter
+    {
+        return $this->namespacesCache->getItem($namespace)->get();
+    }
+
+    /**
+     * @param string $namespace
+     * @param string $key
+     * @return bool
+     */
+    public function hasItem(string $namespace, string $key): bool
+    {
+        if ($this->hasNamespaceCache($namespace)) {
+            $this->fixKey($key);
+
+            return $this->getNamespaceCache($namespace)->hasItem($key);
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $namespace
+     * @return bool
+     */
+    protected function hasNamespaceCache(string $namespace): bool
+    {
+        return $this->namespacesCache->hasItem($namespace);
+    }
+
+    public function reset(): void
+    {
+        $this->namespacesCache->reset();
+    }
+
+    /**
+     * @param string $namespace
+     * @param string $key
+     */
+    public function deleteItem(string $namespace, string $key): void
+    {
+        if (!$this->hasNamespaceCache($namespace)) {
+            return;
+        }
+
+        $this->fixKey($key);
+        $namespaceCache = $this->getNamespaceCache($namespace);
+        $namespaceCache->deleteItem($key);
+    }
+
+    /**
+     * @param string $namespace
+     * @param string $key
+     * @param mixed $value
+     */
+    public function save(string $namespace, string $key, mixed $value): void
+    {
+        $this->fixKey($key);
+        $namespaceCacheItem = $this->namespacesCache->getItem($namespace);
+
+        if (!$this->hasNamespaceCache($namespace)) {
+            $namespaceCacheItem->set(new ArrayAdapter(0, false));
+            $this->namespacesCache->save($namespaceCacheItem);
+        }
+
+        /** @var \Symfony\Component\Cache\Adapter\ArrayAdapter $namespaceCache */
+        $namespaceCache = $namespaceCacheItem->get();
+        $valueItem = $namespaceCache->getItem($key);
+        $valueItem->set($value);
+        $namespaceCache->save($valueItem);
+    }
+
+    /**
+     * @param string $key
+     */
+    protected function fixKey(string &$key): void
+    {
+        foreach (str_split(static::NOT_ALLOWED_CHARS) as $char) {
+            $key = str_replace($char, '~', $key);
+        }
+    }
+
+    /**
+     * @param string $namespace
+     * @param callable $getValueCallback
+     * @param string|int|float|bool ...$keyParts List of variables for building cache key
+     * @return mixed
+     */
+    public function getOrSaveValue(string $namespace, callable $getValueCallback, ...$keyParts): mixed
+    {
+        $key = $this->buildKey($keyParts);
+
+        if ($this->hasItem($namespace, $key)) {
+            return $this->getItem($namespace, $key);
+        }
+        $value = $getValueCallback();
+        $this->save($namespace, $key, $value);
+
+        return $value;
+    }
+
+    /**
+     * @param array $keyParts
+     * @return string
+     */
+    protected function buildKey(array $keyParts): string
+    {
+        $key = implode('~', $keyParts);
+        $this->fixKey($key);
+
+        return $key;
+    }
+
+    /**
+     * @param string|int|float|bool ...$keyParts List of variables for building cache key
+     * @return string
+     */
+    public function getKeyFromParts(...$keyParts): string
+    {
+        return $this->buildKey($keyParts);
+    }
+}

packages/framework/src/Component/LocalCache/LocalCacheResetListener.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\LocalCache;
+
+class LocalCacheResetListener
+{
+    /**
+     * @param \Shopsys\FrameworkBundle\Component\LocalCache\LocalCacheFacade $localCacheFacade
+     */
+    public function __construct(
+        protected readonly LocalCacheFacade $localCacheFacade,
+    ) {
+    }
+
+    public function onClear(): void
+    {
+        $this->localCacheFacade->reset();
+    }
+}

packages/framework/src/Model/Customer/User/CurrentCustomerUser.php

@@ -4,27 +4,26 @@
 
 namespace Shopsys\FrameworkBundle\Model\Customer\User;
 
+use Shopsys\FrameworkBundle\Component\LocalCache\LocalCacheFacade;
 use Shopsys\FrameworkBundle\Model\Pricing\Group\PricingGroupSettingFacade;
 use Shopsys\FrontendApiBundle\Model\User\FrontendApiUser;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
-use Symfony\Contracts\Service\ResetInterface;
 
-class CurrentCustomerUser implements ResetInterface
+class CurrentCustomerUser
 {
-    /**
-     * @var \Shopsys\FrameworkBundle\Model\Customer\User\CustomerUser[]
-     */
-    protected array $customerUserCache = [];
+    protected const CURRENT_CUSTOMER_USER_CACHE_NAMESPACE = 'currentCustomerUser';
 
     /**
      * @param \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokenStorage
      * @param \Shopsys\FrameworkBundle\Model\Pricing\Group\PricingGroupSettingFacade $pricingGroupSettingFacade
      * @param \Shopsys\FrameworkBundle\Model\Customer\User\CustomerUserFacade $customerUserFacade
+     * @param \Shopsys\FrameworkBundle\Component\LocalCache\LocalCacheFacade $localCacheFacade
      */
     public function __construct(
         protected readonly TokenStorageInterface $tokenStorage,
         protected readonly PricingGroupSettingFacade $pricingGroupSettingFacade,
         protected readonly CustomerUserFacade $customerUserFacade,
+        protected readonly LocalCacheFacade $localCacheFacade,
     ) {
     }
 
@@ -53,8 +52,8 @@ public function findCurrentCustomerUser()
             return null;
         }
 
-        if (array_key_exists($token->getUserIdentifier(), $this->customerUserCache) === true) {
-            return $this->customerUserCache[$token->getUserIdentifier()];
+        if ($this->localCacheFacade->hasItem(static::CURRENT_CUSTOMER_USER_CACHE_NAMESPACE, $token->getUserIdentifier())) {
+            return $this->localCacheFacade->getItem(static::CURRENT_CUSTOMER_USER_CACHE_NAMESPACE, $token->getUserIdentifier());
         }
 
         $user = $token->getUser();
@@ -64,22 +63,17 @@ class_exists('\Shopsys\FrontendApiBundle\Model\User\FrontendApiUser')
             && $user instanceof FrontendApiUser
         ) {
             $customerUser = $this->customerUserFacade->getByUuid($user->getUuid());
-            $this->customerUserCache[$token->getUserIdentifier()] = $customerUser;
+            $this->localCacheFacade->save(static::CURRENT_CUSTOMER_USER_CACHE_NAMESPACE, $token->getUserIdentifier(), $customerUser);
 
             return $customerUser;
         }
 
         if ($user instanceof CustomerUser) {
-            $this->customerUserCache[$token->getUserIdentifier()] = $user;
+            $this->localCacheFacade->save(static::CURRENT_CUSTOMER_USER_CACHE_NAMESPACE, $token->getUserIdentifier(), $user);
 
             return $user;
         }
 
         return null;
     }
-
-    public function reset(): void
-    {
-        $this->customerUserCache = [];
-    }
 }

packages/framework/src/Resources/config/services.yaml

@@ -1066,3 +1066,7 @@ services:
     Shopsys\FrameworkBundle\Model\GoPay\GoPayClientFactory:
         arguments:
             - '%gopay_config%'
+
+    Shopsys\FrameworkBundle\Component\LocalCache\LocalCacheResetListener:
+        tags:
+            - { name: doctrine.event_listener, event: onClear }