FEATURE: prune everything except reserved keys and currently registered release keys

Author: batabana

Classes/Command/ContentStorePruneCommandController.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flowpack\DecoupledContentStore\Command;
+
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
+use Flowpack\DecoupledContentStore\Core\RedisPruneService;
+use Neos\Flow\Cli\CommandController;
+use Neos\Flow\Annotations as Flow;
+
+
+class ContentStorePruneCommandController extends CommandController
+{
+    /**
+     * @Flow\Inject
+     * @var RedisPruneService
+     */
+    protected $redisPruneService;
+
+    public function pruneRedisInstanceCommand(string $redisInstanceIdentifier)
+    {
+        $redisInstanceIdentifier = RedisInstanceIdentifier::fromString($redisInstanceIdentifier);
+
+        $this->redisPruneService->pruneRedisInstance($redisInstanceIdentifier);
+    }
+
+}

Classes/Controller/BackendController.php

@@ -9,6 +9,7 @@
 use Flowpack\DecoupledContentStore\Core\Infrastructure\ContentReleaseLogger;
 use Flowpack\DecoupledContentStore\Core\Infrastructure\RedisClientManager;
 use Flowpack\DecoupledContentStore\Core\RedisKeyService;
+use Flowpack\DecoupledContentStore\Core\RedisPruneService;
 use Flowpack\DecoupledContentStore\PrepareContentRelease\Infrastructure\RedisContentReleaseService;
 use Flowpack\DecoupledContentStore\ReleaseSwitch\Infrastructure\RedisReleaseSwitchService;
 use Flowpack\DecoupledContentStore\Transfer\ContentReleaseCleaner;
@@ -69,6 +70,12 @@ class BackendController extends \Neos\Flow\Mvc\Controller\ActionController
      */
     protected $contentReleaseCleaner;
 
+    /**
+     * @Flow\Inject
+     * @var RedisPruneService
+     */
+    protected $redisPruneService;
+
     /**
      * @Flow\InjectConfiguration("redisContentStores")
      * @var array
@@ -155,4 +162,12 @@ public function switchContentReleaseOnOtherInstanceAction(string $targetRedisIns
 
         $this->redirect('index', null, null, ['contentStore' => $targetRedisInstanceIdentifier]);
     }
+
+    public function pruneContentStoreAction(string $redisInstanceIdentifier)
+    {
+        $redisInstanceIdentifier = RedisInstanceIdentifier::fromString($redisInstanceIdentifier);
+        $this->redisPruneService->pruneRedisInstance($redisInstanceIdentifier);
+
+        $this->redirect('index', null, null, ['contentStore' => $redisInstanceIdentifier->getIdentifier()]);
+    }
 }

Classes/Core/RedisPruneService.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Flowpack\DecoupledContentStore\Core;
+
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
+use Flowpack\DecoupledContentStore\Core\Infrastructure\RedisClientManager;
+use Neos\Flow\Annotations as Flow;
+
+/**
+ * @Flow\Scope("singleton")
+ */
+class RedisPruneService
+{
+    // go through all keys in the selected content store
+    // check wether they are reserved keys or currently active or contain one of the currently registered releases ids
+    // if not: delete
+    const PRUNE_LUA_SCRIPT = '
+        local contentStoreCurrent = redis.call("GET", "contentStore:current")
+        local contentStoreAllKeys = redis.call("KEYS", "*")
+        local contentStoreRegisteredReleases = redis.call("ZRANGE", "contentStore:registeredReleases", 0, -1)
+        local currentContentStoreStart = "contentStore:" .. contentStoreCurrent
+
+        local function table_contains_value(tab, val)
+            for index,value in ipairs(tab) do
+                if string.find(val, value) then
+                    return true
+                end
+            end
+            return false
+        end
+
+        for index,contentStoreKey in ipairs(contentStoreAllKeys) do
+            if contentStoreKey ~= "contentStore:current"
+            and contentStoreKey ~= "contentStore:registeredReleases"
+            and string.sub(contentStoreKey, 1, string.len(currentContentStoreStart)) ~= currentContentStoreStart
+            and not table_contains_value(contentStoreRegisteredReleases, contentStoreKey) then
+                redis.call("DEL", contentStoreKey)
+            end
+        end
+        ';
+
+    /**
+     * @Flow\Inject
+     * @var RedisClientManager
+     */
+    protected $redisClientManager;
+
+
+    public function pruneRedisInstance(RedisInstanceIdentifier $redisInstanceIdentifier)
+    {
+        $this->redisClientManager->getRedis($redisInstanceIdentifier)->eval(self::PRUNE_LUA_SCRIPT, []);
+    }
+
+}

Resources/Private/BackendFusion/Integration/Backend.Index.fusion

@@ -6,6 +6,12 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
     // - redisContentStores: array of all configured content store identifiers
 
     renderer = Neos.Fusion:Component {
+        _pruneContentStoreUri = Neos.Fusion:UriBuilder {
+            action = 'pruneContentStore'
+            arguments = Neos.Fusion:DataStructure {
+                redisInstanceIdentifier = ${contentStore}
+            }
+        }
 
         _renderedTableBody = Neos.Fusion:Loop {
             items = ${overviewData}
@@ -78,6 +84,10 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
                         </tbody>
                     </table>
 
+                    <button form="postHelper" formaction={props._pruneContentStoreUri} type="submit" class="neos-button neos-button-danger" style="margin-top: 300px;">
+                        Prune content store
+                    </button>
+
                     <Flowpack.DecoupledContentStore:ListFooter />
                 </div>
             </div>