TASK: add more checks before removing/switching a release

Author: batabana

Classes/Controller/BackendController.php

@@ -75,12 +75,6 @@ class BackendController extends \Neos\Flow\Mvc\Controller\ActionController
      */
     protected $redisContentStores;
 
-    /**
-     * @Flow\InjectConfiguration("redisKeyPostfixesForEachRelease")
-     * @var array
-     */
-    protected $redisKeyPostfixesForEachReleaseConfiguration;
-
     protected $defaultViewObjectName = FusionView::class;
 
     public function indexAction(?string $contentStore = null)

Classes/ReleaseSwitch/Infrastructure/RedisReleaseSwitchService.php

@@ -5,7 +5,9 @@
 use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\ContentReleaseIdentifier;
 use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
 use Flowpack\DecoupledContentStore\Core\Infrastructure\ContentReleaseLogger;
+use Flowpack\DecoupledContentStore\Core\RedisKeyService;
 use Flowpack\DecoupledContentStore\PrepareContentRelease\Infrastructure\RedisContentReleaseService;
+use Flowpack\DecoupledContentStore\Transfer\Dto\RedisKeyPostfixesForEachRelease;
 use Neos\Flow\Annotations as Flow;
 use Flowpack\DecoupledContentStore\Core\Infrastructure\RedisClientManager;
 
@@ -27,10 +29,39 @@ class RedisReleaseSwitchService
      */
     protected $redisContentReleaseService;
 
+    /**
+     * @Flow\Inject
+     * @var RedisKeyService
+     */
+    protected $redisKeyService;
+
+    /**
+     * @Flow\InjectConfiguration("redisKeyPostfixesForEachRelease")
+     * @var array
+     */
+    protected $redisKeyPostfixesForEachReleaseConfiguration;
+
     public function switchContentRelease(RedisInstanceIdentifier $redisInstanceIdentifier, ContentReleaseIdentifier $contentReleaseIdentifier, ContentReleaseLogger $contentReleaseLogger)
     {
         $redis = $this->redisClient->getRedis($redisInstanceIdentifier);
         $current = $redis->get('contentStore:current');
+
+        // validation checks
+        // we don't check for errors here (again) as we do not reach this stage if there were errors before
+        if (!in_array($contentReleaseIdentifier->getIdentifier(), $redis->zRevRangeByLex('contentStore:registeredReleases', '+', '-'))) {
+            $contentReleaseLogger->error('Content release identifier ' . $contentReleaseIdentifier->getIdentifier() . ' is not listed in current releases thus we do not switch.');
+            return;
+        }
+
+        $redisKeyPostfixesForEachRelease = RedisKeyPostfixesForEachRelease::fromArray($this->redisKeyPostfixesForEachReleaseConfiguration);
+        foreach ($redisKeyPostfixesForEachRelease->getRequiredKeys() as $requiredPostfix) {
+            $key = $this->redisKeyService->getRedisKeyForPostfix($contentReleaseIdentifier, $requiredPostfix->getRedisKeyPostfix());
+            if (!$redis->exists($key)) {
+                $contentReleaseLogger->error('Required redis key ' . $key . ' does not exist for release thus we do not switch.');
+                return;
+            }
+        }
+
         $redis->set('contentStore:current', $contentReleaseIdentifier->getIdentifier());
         $releaseMetadata = $this->redisContentReleaseService->fetchMetadataForContentRelease($contentReleaseIdentifier);
         $this->redisContentReleaseService->setContentReleaseMetadata($contentReleaseIdentifier, $releaseMetadata->withSwitchTime(new \DateTimeImmutable()), $redisInstanceIdentifier);

Classes/Transfer/ContentReleaseCleaner.php

@@ -110,6 +110,11 @@ public function removeRelease(ContentReleaseIdentifier $contentReleaseIdentifier
             return;
         }
 
+        if ($currentRelease->equals($contentReleaseIdentifierToRemove)) {
+            $contentReleaseLogger->error('Release to be removed is currently active, thus we do not remove it.');
+            return;
+        }
+
         $redisKeyPostfixesForEachRelease = RedisKeyPostfixesForEachRelease::fromArray($this->redisKeyPostfixesForEachReleaseConfiguration);
 
         foreach ($redisKeyPostfixesForEachRelease->getRedisKeyPostfixes() as $redisKeyPostfix) {

Classes/Transfer/Dto/RedisKeyPostfixesForEachRelease.php

@@ -45,6 +45,18 @@ public function getKeysToTransfer(): iterable
         }
     }
 
+    /**
+     * @return iterable|RedisKeyPostfixForEachRelease[]
+     */
+    public function getRequiredKeys(): iterable
+    {
+        foreach ($this->redisKeyPostfixes as $redisKeyPostfix) {
+            if ($redisKeyPostfix->isRequired()) {
+                yield $redisKeyPostfix;
+            }
+        }
+    }
+
     /**
      * @return RedisKeyPostfixForEachRelease[]
      */

Configuration/Settings.yaml

@@ -75,7 +75,7 @@ Flowpack:
         redisKeyPostfix: 'inProgressRenderings'
         transfer: false
         transferMode: 'dump'
-        isRequired: true
+        isRequired: false
       metainfo:
         redisKeyPostfix: 'meta:info'
         transfer: true