Merge pull request #10 from Flowpack/add-config-epoch

FEATURE: add config epoch to settings and redis

Author: batabana

Classes/ContentReleaseManager.php

@@ -4,6 +4,7 @@
 
 namespace Flowpack\DecoupledContentStore;
 
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
 use Flowpack\DecoupledContentStore\Core\Infrastructure\RedisClientManager;
 use Neos\Flow\Annotations as Flow;
 use Flowpack\Prunner\PrunnerApiService;
@@ -33,6 +34,12 @@ class ContentReleaseManager
      */
     protected $redisClientManager;
 
+    /**
+     * @Flow\InjectConfiguration("configEpoch")
+     * @var array
+     */
+    protected $configEpochSettings;
+
     const REDIS_CURRENT_RELEASE_KEY = 'contentStore:current';
     const NO_PREVIOUS_RELEASE = 'NO_PREVIOUS_RELEASE';
 
@@ -63,4 +70,18 @@ public function cancelAllRunningContentReleases()
             $this->prunnerApiService->cancelJob($job);
         }
     }
+
+    public function toggleConfigEpoch(RedisInstanceIdentifier $redisInstanceIdentifier)
+    {
+        $currentConfigEpochConfig = $this->configEpochSettings['current'] ?? null;
+        $previousConfigEpochConfig = $this->configEpochSettings['previous'] ?? null;
+        $redis = $this->redisClientManager->getRedis($redisInstanceIdentifier);
+        $configEpochRedis = $redis->get('contentStore:configEpoch');
+
+        if ($configEpochRedis === $currentConfigEpochConfig) {
+            $redis->set('contentStore:configEpoch', $previousConfigEpochConfig);
+        } else {
+            $redis->set('contentStore:configEpoch', $currentConfigEpochConfig);
+        }
+    }
 }

Classes/Controller/BackendController.php

@@ -82,17 +82,31 @@ class BackendController extends \Neos\Flow\Mvc\Controller\ActionController
      */
     protected $redisContentStores;
 
+    /**
+     * @Flow\InjectConfiguration("configEpoch")
+     * @var array
+     */
+    protected $configEpochSettings;
+
     protected $defaultViewObjectName = FusionView::class;
 
     public function indexAction(?string $contentStore = null)
     {
         $contentStore = $contentStore ? RedisInstanceIdentifier::fromString($contentStore) : RedisInstanceIdentifier::primary();
-        $storeSize = $this->redisClientManager->getRedis($contentStore)->info('memory')['used_memory_human'];
+        $redis = $this->redisClientManager->getRedis($contentStore);
+        $storeSize = $redis->info('memory')['used_memory_human'];
+        $currentConfigEpoch = $this->configEpochSettings['current'] ?? null;
+        $previousConfigEpoch = $this->configEpochSettings['previous'] ?? null;
+        $configEpochRedis = $redis->get('contentStore:configEpoch');
+        $showToggleConfigEpochButton = $previousConfigEpoch !== null && !$contentStore->isPrimary();
 
         $this->view->assign('contentStore', $contentStore->getIdentifier());
         $this->view->assign('overviewData', $this->backendUiDataService->loadBackendOverviewData($contentStore));
         $this->view->assign('redisContentStores', array_keys($this->redisContentStores));
         $this->view->assign('storeSize', $storeSize);
+        $this->view->assign('toggleFromConfigEpoch', $configEpochRedis);
+        $this->view->assign('toggleToConfigEpoch', $configEpochRedis === $currentConfigEpoch ? $previousConfigEpoch : $currentConfigEpoch);
+        $this->view->assign('showToggleConfigEpochButton', $showToggleConfigEpochButton);
     }
 
     public function detailsAction(string $contentReleaseIdentifier, ?string $contentStore = null, ?string $detailTaskName = '', ?string $prunnerJobId = '')
@@ -183,4 +197,12 @@ public function cancelRunningReleaseAction(string $redisInstanceIdentifier)
 
         $this->redirect('index', null, null, ['contentStore' => $redisInstanceIdentifier->getIdentifier()]);
     }
+
+    public function toggleConfigEpochAction(string $redisInstanceIdentifier)
+    {
+        $redisInstanceIdentifier = RedisInstanceIdentifier::fromString($redisInstanceIdentifier);
+        $this->contentReleaseManager->toggleConfigEpoch($redisInstanceIdentifier);
+
+        $this->redirect('index', null, null, ['contentStore' => $redisInstanceIdentifier->getIdentifier()]);
+    }
 }

Classes/Transfer/ContentReleaseSynchronizer.php

@@ -28,6 +28,12 @@ class ContentReleaseSynchronizer
      */
     protected $redisKeyPostfixesForEachReleaseConfiguration;
 
+    /**
+     * @Flow\InjectConfiguration("configEpoch")
+     * @var array
+     */
+    protected $configEpochSettings;
+
     /**
      * @Flow\Inject
      * @var RedisKeyService
@@ -64,6 +70,7 @@ public function syncToTarget(RedisInstanceIdentifier $targetRedisIdentifier, Con
         }
 
         $targetRedis->zAdd('contentStore:registeredReleases', 0, $contentReleaseIdentifier->getIdentifier());
+        $targetRedis->set('contentStore:configEpoch', $this->configEpochSettings['current']);
     }
 
     /**

Configuration/Settings.yaml

@@ -120,6 +120,10 @@ Flowpack:
         transferMode: 'dump'
         isRequired: true
 
+    # can be used on the consuming site to ensure non-breaking deployments for changes in the config
+    configEpoch:
+      current: v1
+      previous: ~
 
 
     resourceSync:

README.md

@@ -365,6 +365,39 @@ and what data to delete if a release is removed.
     // ActionController
     $this->addFlashMessage('sth important you have to say');
     ```
+  
+### Using different sets of config
+
+In some cases it might be necessary to make fundamental adjustments to some configuration properties that would be
+really hard to handle (safely, non-breaking) on the consuming site of the content store. Therefore we added the config
+property `configEpoch` that can contain a current and previous config version. The `current` value (that should be used
+on the consuming site) gets published to the content store.
+
+We decided to save the configEpoch on content store level instead of content release level for simplicity reasons on the
+consuming site. If you need to switch back to an older release that was rendered with the previous config epoch version
+and would not match the currently published one, you may manually toggle between current and previous config epoch.
+There is a button for this in the backend module for each target content store. Obviously this button should be used
+with extra care as the config epoch needs to fit the current release at all times.
+
+Example:
+
+- We need to make a bigger change to the contentDimensions config, let's say we need to add uriPrefixes that weren't
+  there before. We adjust the config accordingly and in the same deployment we configure the config epoch as follows:
+
+    ```yml
+    Flowpack:
+      DecoupledContentStore:
+        configEpoch:
+          current: v2
+          previous: v1
+    ```
+
+- Now on the consuming site we can take action to handle both the old and new config and decide based on the value in
+  redis which case is executed.
+
+    ```php
+    'contentStoreUrl' => 'https://www.vendor.de/' . ($configEpoch === 'v2' ? 'de-de/' : '')
+    ```
 
 ## Development
 

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

@@ -5,6 +5,9 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
     // - contentStore: contains string content store identifier
     // - redisContentStores: array of all configured content store identifiers
     // - storeSize: string of content store size
+    // - toggleFromConfigEpoch: string, e.g. "v2"
+    // - toggleToConfigEpoch: string, e.g. "v1"
+    // - showToggleConfigEpochButton: boolean
 
     renderer = Neos.Fusion:Component {
         _pruneContentStoreUri = Neos.Fusion:UriBuilder {
@@ -20,6 +23,13 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
             }
         }
 
+        _toggleConfigEpoch = Neos.Fusion:UriBuilder {
+            action = 'toggleConfigEpoch'
+            arguments = Neos.Fusion:DataStructure {
+                redisInstanceIdentifier = ${contentStore}
+            }
+        }
+
         _renderedTableBody = Neos.Fusion:Loop {
             items = ${overviewData}
             itemRenderer = Neos.Fusion:Component {
@@ -95,13 +105,17 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
                     <span>Store size: </span>
                     <span class="neos-badge neos-badge-info">{storeSize}</span>
                     <br />
-                    <button form="postHelper" formaction={props._pruneContentStoreUri} type="submit" class="neos-button neos-button-danger" style="margin-top: 300px;">
+                    <button form="postHelper" formaction={props._pruneContentStoreUri} type="submit" class="neos-button neos-button-warning" style="margin-top: 300px;">
                         Prune content store
                     </button>
                     <span> </span>
-                    <button form="postHelper" formaction={props._cancelRunningReleaseUri} type="submit" class="neos-button neos-button-danger" style="margin-top: 300px;">
+                    <button form="postHelper" formaction={props._cancelRunningReleaseUri} type="submit" class="neos-button neos-button-warning" style="margin-top: 300px;">
                         Cancel running release
                     </button>
+                    <span> </span>
+                    <button @if.showToggleConfigEpochButton={showToggleConfigEpochButton} form="postHelper" formaction={props._toggleConfigEpoch} type="submit" class="neos-button neos-button-danger" style="margin-top: 300px;">
+                        {'Toggle config epoch: ' + toggleFromConfigEpoch + ' to ' + toggleToConfigEpoch}
+                    </button>
 
                     <div class="neos-footer !h-full">
                         <Flowpack.DecoupledContentStore:ListFooter />