Merge pull request #7 from Flowpack/add-current-release-identifier-to-pipeline

Add current release identifier to pipeline, enable backend module extension

Author: batabana

Classes/BackendUi/FusionObjects/RetrieveFlashMessagesImplementation.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Flowpack\DecoupledContentStore\BackendUi\FusionObjects;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Mvc\FlashMessage\FlashMessageService;
+use Neos\Fusion\FusionObjects\AbstractFusionObject;
+
+class RetrieveFlashMessagesImplementation extends AbstractFusionObject
+{
+    /**
+     * @Flow\Inject
+     * @var FlashMessageService
+     */
+    protected $flashMessageService;
+
+    public function evaluate()
+    {
+        return $this->flashMessageService->getFlashMessageContainerForRequest($this->runtime->getControllerContext()->getRequest())->getMessagesAndFlush();
+    }
+}

Classes/ContentReleaseManager.php

@@ -4,6 +4,7 @@
 
 namespace Flowpack\DecoupledContentStore;
 
+use Flowpack\DecoupledContentStore\Core\Infrastructure\RedisClientManager;
 use Neos\Flow\Annotations as Flow;
 use Flowpack\Prunner\PrunnerApiService;
 use Flowpack\Prunner\ValueObject\PipelineName;
@@ -26,16 +27,29 @@ class ContentReleaseManager
      */
     protected $prunnerApiService;
 
+    /**
+     * @Flow\Inject
+     * @var RedisClientManager
+     */
+    protected $redisClientManager;
+
+    const REDIS_CURRENT_RELEASE_KEY = 'contentStore:current';
+    const NO_PREVIOUS_RELEASE = 'NO_PREVIOUS_RELEASE';
 
     public function startIncrementalContentRelease()
     {
-        $this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), ['contentReleaseId' => (string)time()]);
+        $redis = $this->redisClientManager->getPrimaryRedis();
+        $currentContentReleaseId = $redis->get(self::REDIS_CURRENT_RELEASE_KEY);
+
+        // the currentContentReleaseId is not used in any pipeline step in this package, but is a common need in other
+        // use cases in extensions, e.g. calculating the differences between current and new release
+        $this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), ['contentReleaseId' => (string)time(), 'currentContentReleaseId' => $currentContentReleaseId ?: self::NO_PREVIOUS_RELEASE]);
     }
 
     public function startFullContentRelease()
     {
         $this->contentCache->flush();
-        $this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), ['contentReleaseId' => (string)time()]);
+        $this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), ['contentReleaseId' => (string)time(), 'currentContentReleaseId' => self::NO_PREVIOUS_RELEASE]);
     }
 
     public function cancelAllRunningContentReleases()
@@ -46,4 +60,4 @@ public function cancelAllRunningContentReleases()
             $this->prunnerApiService->cancelJob($job);
         }
     }
-}
+}

Classes/Controller/BackendController.php

@@ -159,8 +159,11 @@ public function switchAction(string $contentReleaseIdentifier, string $redisInst
 
     public function switchContentReleaseOnOtherInstanceAction(string $targetRedisInstanceIdentifier, string $contentReleaseIdentifier)
     {
+        $redis = $this->redisClientManager->getPrimaryRedis();
+        $currentContentReleaseId = $redis->get('contentStore:current');
+
         $this->prunnerApiService->schedulePipeline(PipelineName::create('manually_transfer_content_release'),
-            ['contentReleaseId' => $contentReleaseIdentifier, 'redisInstanceId' => $targetRedisInstanceIdentifier]);
+            ['contentReleaseId' => $contentReleaseIdentifier, 'currentContentReleaseId' => $currentContentReleaseId ?: ContentReleaseManager::NO_PREVIOUS_RELEASE, 'redisInstanceId' => $targetRedisInstanceIdentifier]);
 
         $this->redirect('index', null, null, ['contentStore' => $targetRedisInstanceIdentifier]);
     }

Configuration/Views.yaml

@@ -1,5 +1,5 @@
 -
-  requestFilter: 'parentRequest.isPackage("Neos.Neos") && isFormat("html") && isPackage("Flowpack.DecoupledContentStore")'
+  requestFilter: 'isPackage("Flowpack.DecoupledContentStore")'
   options:
     fusionPathPatterns:
       - 'resource://Flowpack.DecoupledContentStore/Private/BackendFusion'

README.md

@@ -338,6 +338,34 @@ Flowpack:
 This is needed so that the system knows which keys should be synchronized between the different content stores,
 and what data to delete if a release is removed.
 
+### Extending the backend module
+
+- You need a Views.yaml in your package, looking like this:
+```
+-
+  requestFilter: 'isPackage("Flowpack.DecoupledContentStore")'
+  viewObjectName: 'Neos\Fusion\View\FusionView'
+  options:
+    fusionPathPatterns:
+      - 'resource://Flowpack.DecoupledContentStore/Private/BackendFusion'
+      - 'resource://Vendor.Site/Private/DecoupledContentStoreFusion'
+```
+- Ensure that your package depends on `flowpack/decoupledcontentstore` in composer.json (so that your Views.yaml "wins" because the DecoupledContentStore-Package comes with its own Views.yaml)
+- Add a Root.fusion in `Vendor.Site/Resources/Private/DecoupledContentStoreFusion` which can contain your modifications
+- We currently support the following adjustments:
+  - Adding a button to the footer
+    ```
+    prototype(Flowpack.DecoupledContentStore:ListFooter) {
+        test = '<span class="align-middle inline-block text-sm pr-4 pl-16">TEST</span>'
+        test.@position = 'before reload'
+    }
+    ```
+  - Adding a flash message
+    ```
+    // ActionController
+    $this->addFlashMessage('sth important you have to say');
+    ```
+
 ## Development
 
 - You need [pnpm](https://github.com/pnpm/pnpm) as package panager installed: `curl -f https://get.pnpm.io/v6.js | node - add --global pnpm`

Resources/Private/BackendFusion/FlashMessages.fusion

@@ -0,0 +1,17 @@
+prototype(Flowpack.DecoupledContentStore:FlashMessages) < prototype(Neos.Fusion:Component) {
+    flashMessages = Flowpack.DecoupledContentStore:RetrieveFlashMessages
+
+    renderer = afx`
+        <ul id="neos-notifications-inline" @if.hasFlashMessages={props.flashMessages}>
+            <Neos.Fusion:Loop items={props.flashMessages}>
+                <li data-type={String.toLowerCase(item.severity)}>
+                    {item.message}
+                </li>
+            </Neos.Fusion:Loop>
+        </ul>
+    `
+}
+
+prototype(Flowpack.DecoupledContentStore:RetrieveFlashMessages) {
+    @class = 'Flowpack\\DecoupledContentStore\\BackendUi\\FusionObjects\\RetrieveFlashMessagesImplementation'
+}

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

@@ -393,14 +393,14 @@ prototype(Flowpack.DecoupledContentStore:DetailsFooter) < prototype(Neos.Fusion:
 
             renderer = afx`
                 <button form="postHelper" formaction={props._switchUri} type="submit" class="neos-button neos-button-warning neos-pull-right" @if.isNotPrimary={item != "primary"}>
-                    Transfer to {item}
+                    Transfer and switch on {item}
                 </button>
             `
         }
     }
 
     renderer = afx`
-        <div class="neos-footer">
+        <div class="neos-footer !h-full">
             <Neos.Fusion:Link.Action href.action="details" href.arguments={{contentReleaseIdentifier: detailsData.contentReleaseIdentifier.identifier}} class="neos-button">
                 <i class="fa fa-sync"></i> Reload
             </Neos.Fusion:Link.Action>

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

@@ -62,6 +62,7 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
             }
         }
         renderer = afx`
+            <Flowpack.DecoupledContentStore:FlashMessages id="neos-notifications-inline" class="flashmessages" />
             <form id="postHelper" method="post">
                 <input
                         type="hidden"
@@ -102,33 +103,37 @@ Flowpack.DecoupledContentStore.BackendController.index = Neos.Fusion:Component {
                         Cancel running release
                     </button>
 
-                    <Flowpack.DecoupledContentStore:ListFooter />
+                    <div class="neos-footer !h-full">
+                        <Flowpack.DecoupledContentStore:ListFooter />
+                    </div>
                 </div>
             </div>
         `
     }
 }
 
-prototype(Flowpack.DecoupledContentStore:ListFooter) < prototype(Neos.Fusion:Component) {
-    _publishAllUri = Neos.Fusion:UriBuilder {
-        action = 'publishAll'
-    }
-
-    renderer = afx`
-        <div class="neos-footer">
-            <Neos.Fusion:Link.Action href.action="index" class="neos-button">
-                <i class="fa fa-sync"></i> Reload
+prototype(Flowpack.DecoupledContentStore:ListFooter) < prototype(Neos.Fusion:Join) {
+    reload = afx`
+        <Neos.Fusion:Link.Action href.action="index" class="neos-button">
+            <i class="fa fa-sync"></i> Reload
+        </Neos.Fusion:Link.Action>
+    `
+    activeContentStoreLabel = '<span class="align-middle inline-block text-sm pr-4 pl-16">Active Content Store:</span>'
+    switchContentStore = afx`
+        <Neos.Fusion:Loop items={redisContentStores}>
+            <Neos.Fusion:Link.Action href.action="index" href.arguments={{contentStore: item}} class={AtomicFusion.classNames('neos-button', {'neos-button-primary': item == contentStore})}>
+                {item}
             </Neos.Fusion:Link.Action>
-            <span class="align-middle inline-block text-sm pr-4 pl-16">Active Content Store:</span>
-            <Neos.Fusion:Loop items={redisContentStores}>
-                <Neos.Fusion:Link.Action href.action="index" href.arguments={{contentStore: item}} class={AtomicFusion.classNames('neos-button', {'neos-button-primary': item == contentStore})}>
-                    {item}
-                </Neos.Fusion:Link.Action>
-            </Neos.Fusion:Loop>
-
+        </Neos.Fusion:Loop>
+    `
+    publishAll = Neos.Fusion:Component {
+        _publishAllUri = Neos.Fusion:UriBuilder {
+            action = 'publishAll'
+        }
+        renderer = afx`
             <button form="postHelper" formaction={props._publishAllUri} type="submit" class="neos-button neos-button-warning neos-pull-right">
                 Publish All
             </button>
-        </div>
-    `
+        `
+    }
 }