MC-33275: Stale cache implementation

Author: vzabaznov

dev/tests/integration/testsuite/Magento/Framework/Lock/Backend/CacheTest.php

@@ -3,10 +3,15 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\Lock\Backend;
 
 use Magento\Framework\Lock\Backend\Cache;
 
+/**
+ * \Magento\Framework\Lock\Backend\Cache test case.
+ */
 class CacheTest extends \PHPUnit\Framework\TestCase
 {
     /**

dev/tests/integration/testsuite/Magento/Framework/Lock/Backend/DatabaseTest.php

@@ -11,7 +11,7 @@
 use Magento\Framework\App\DeploymentConfig;
 
 /**
- * \Magento\Framework\Lock\Backend\Database test case
+ * \Magento\Framework\Lock\Backend\Database test case.
  */
 class DatabaseTest extends \PHPUnit\Framework\TestCase
 {

lib/internal/Magento/Framework/Cache/Backend/RemoteSynchronizedCache.php

@@ -46,6 +46,11 @@ class RemoteSynchronizedCache extends \Zend_Cache_Backend implements \Zend_Cache
      */
     private const HASH_SUFFIX = ':hash';
 
+    /**
+     * Prefix for locks in case stale cache is used.
+     */
+    private const REMOTE_SYNC_LOCK_PREFIX = 'rsl::';
+
 
     /**
      * @inheritdoc
@@ -67,7 +72,7 @@ class RemoteSynchronizedCache extends \Zend_Cache_Backend implements \Zend_Cache
      *
      * @var array
      */
-    private $lockArray = [];
+    private $lockList = [];
 
     /**
      * Sign for locks, helps to avoid removing a lock that was created by another client
@@ -128,7 +133,6 @@ public function __construct(array $options = [])
         }
 
         $this->lockSign = $this->generateLockSign();
-        $this->notifier = ObjectManager::getInstance()->get(CompositeStaleCacheNotifier::class);
     }
 
     /**
@@ -204,7 +208,7 @@ public function load($id, $doNotTestCacheValidity = false)
                 return false;
             }
         } else {
-            if ($versionCheckFailed = $this->getDataVersion($localData) !== $this->loadRemoteDataVersion($id)) {
+            if ($versionCheckFailed = ($this->getDataVersion($localData) !== $this->loadRemoteDataVersion($id))) {
                 $remoteData = $this->remote->load($id);
 
                 if (!$this->_options['use_stale_cache']) {
@@ -220,6 +224,8 @@ public function load($id, $doNotTestCacheValidity = false)
             if ($this->lock($id)) {
                 return false;
             } else {
+                $this->notifier = $this->notifier ??
+                    ObjectManager::getInstance()->get(CompositeStaleCacheNotifier::class);
                 $this->notifier->cacheLoaderIsUsingStaleCache();
             }
         }
@@ -355,7 +361,7 @@ public function getCapabilities()
      */
     private function lock(string $id): bool
     {
-        $this->lockArray[$id] = microtime(true);
+        $this->lockList[$id] = microtime(true);
 
         $data = $this->remote->load($this->getLockName($id));
 
@@ -382,8 +388,8 @@ private function lock(string $id): bool
      */
     private function unlock(string $id): bool
     {
-        if (isset($this->lockArray[$id])) {
-            unset($this->lockArray[$id]);
+        if (isset($this->lockList[$id])) {
+            unset($this->lockList[$id]);
         }
 
         $data = $this->remote->load($this->getLockName($id));
@@ -408,7 +414,7 @@ private function unlock(string $id): bool
      */
     private function getLockName($id): string
     {
-        return 'REMOTE_SYNC_LOCK_' . $id;
+        return self::REMOTE_SYNC_LOCK_PREFIX . $id;
     }
 
     /**
@@ -418,7 +424,7 @@ private function getLockName($id): string
      */
     private function unlockAll()
     {
-        foreach ($this->lockArray as $id => $ttl) {
+        foreach ($this->lockList as $id => $ttl) {
             $this->unlock($id);
         }
     }
@@ -440,7 +446,7 @@ public function __destruct()
      */
     private function generateLockSign()
     {
-        $sign = implode(
+        $sign = \implode(
             '-',
             [
                 \getmypid(), \crc32(\gethostname())

lib/internal/Magento/Framework/Cache/LockGuardedCacheLoader.php

@@ -66,7 +66,7 @@ class LockGuardedCacheLoader
      *
      * @var string
      */
-    private const CONFIG_PATH_ALLOW_PARALLEL_CACHE_GENERATION = 'cache/allow_parallel_generation';
+    private const CONFIG_NAME_ALLOW_PARALLEL_CACHE_GENERATION = 'allow_parallel_generation';
 
     /**
      * Config value of parallel generation.
@@ -119,9 +119,11 @@ public function lockedLoadData(
         $deadline = microtime(true) + $this->loadTimeout / 100;
 
         if (empty($this->allowParallelGenerationConfigValue)) {
-            $this->allowParallelGenerationConfigValue = $this
+            $cacheConfig = $this
                 ->deploymentConfig
-                ->getConfigData(self::CONFIG_PATH_ALLOW_PARALLEL_CACHE_GENERATION);
+                ->getConfigData('cache');
+            $this->allowParallelGenerationConfigValue = $cacheConfig[self::CONFIG_NAME_ALLOW_PARALLEL_CACHE_GENERATION]
+                ?? false;
         }
 
         while ($cachedData === false) {

setup/src/Magento/Setup/Model/ConfigOptionsList/Cache.php

@@ -176,8 +176,6 @@ public function createConfig(array $options, DeploymentConfig $deploymentConfig)
             }
         }
 
-        $configData->set(self::CONFIG_PATH_ALLOW_PARALLEL_CACHE_GENERATION, false);
-
         foreach ($this->inputKeyToConfigPathMap as $inputKey => $configPath) {
             if (isset($options[$inputKey])) {
                 $configData->set($configPath, $options[$inputKey]);