Merge pull request #5 from Flowpack/feature/add-option-to-exclude-keys-from-specific-content-stores

FEATURE: add option to specify transfer of keys per content store

Author: batabana

Classes/Exception/InvalidTransferConfigException.php

@@ -0,0 +1,7 @@
+<?php
+namespace Flowpack\DecoupledContentStore\Exception;
+
+class InvalidTransferConfigException extends \Flowpack\DecoupledContentStore\Exception
+{
+
+}

Classes/ReleaseSwitch/Infrastructure/RedisReleaseSwitchService.php

@@ -56,7 +56,7 @@ public function switchContentRelease(RedisInstanceIdentifier $redisInstanceIdent
         $redisKeyPostfixesForEachRelease = RedisKeyPostfixesForEachRelease::fromArray($this->redisKeyPostfixesForEachReleaseConfiguration);
         $hasError = false;
         foreach ($redisKeyPostfixesForEachRelease->getRequiredKeys() as $requiredPostfix) {
-            if ($requiredPostfix->shouldTransfer()) {
+            if ($requiredPostfix->shouldTransfer($redisInstanceIdentifier)) {
                 $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.');

Classes/Transfer/ContentReleaseSynchronizer.php

@@ -48,7 +48,7 @@ public function syncToTarget(RedisInstanceIdentifier $targetRedisIdentifier, Con
 
         $redisKeyPostfixesForEachRelease = RedisKeyPostfixesForEachRelease::fromArray($this->redisKeyPostfixesForEachReleaseConfiguration);
 
-        foreach ($redisKeyPostfixesForEachRelease->getKeysToTransfer() as $redisKeyPostfix) {
+        foreach ($redisKeyPostfixesForEachRelease->getKeysToTransfer($targetRedisIdentifier) as $redisKeyPostfix) {
             $redisKey = $this->redisKeyService->getRedisKeyForPostfix($contentReleaseIdentifier, $redisKeyPostfix->getRedisKeyPostfix());
             $contentReleaseLogger->info($redisKey);
             if ($redisKeyPostfix->isRequired() && !$sourceRedis->exists($redisKey)) {

Classes/Transfer/Dto/RedisKeyPostfixForEachRelease.php

@@ -3,6 +3,8 @@
 
 namespace Flowpack\DecoupledContentStore\Transfer\Dto;
 
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
+use Flowpack\DecoupledContentStore\Exception\InvalidTransferConfigException;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -15,24 +17,31 @@ final class RedisKeyPostfixForEachRelease
     private const TRANSFER_MODE_DUMP = 'dump';
 
     protected string $redisKeyPostfix;
-    protected bool $transfer;
+    protected array $transfer;
     protected string $transferMode;
     protected bool $isRequired;
 
     /**
      * @param string $redisKeyPostfix
-     * @param bool $transfer
+     * @param bool|array $transfer
      * @param string $transferMode
      * @param bool $isRequired
      */
-    private function __construct(string $redisKeyPostfix, bool $transfer, string $transferMode, bool $isRequired)
+    private function __construct(string $redisKeyPostfix, $transfer, string $transferMode, bool $isRequired)
     {
         if (!in_array($transferMode, [self::TRANSFER_MODE_HASH_INCREMENTAL, self::TRANSFER_MODE_DUMP])) {
             throw new \RuntimeException('TransferMode ' . $transferMode . ' not supported.');
         }
 
+        if (is_bool($transfer)) {
+            $this->transfer = [
+                '*' => $transfer
+            ];
+        } else {
+            $this->transfer = $transfer;
+        }
+
         $this->redisKeyPostfix = $redisKeyPostfix;
-        $this->transfer = $transfer;
         $this->transferMode = $transferMode;
         $this->isRequired = $isRequired;
     }
@@ -51,9 +60,15 @@ public static function fromArray(array $in): self
     /**
      * @return bool
      */
-    public function shouldTransfer(): bool
+    public function shouldTransfer(RedisInstanceIdentifier $redisInstanceIdentifier): bool
     {
-        return $this->transfer;
+        if (array_key_exists($redisInstanceIdentifier->getIdentifier(), $this->transfer)) {
+            return $this->transfer[$redisInstanceIdentifier->getIdentifier()];
+        }
+        if (array_key_exists('*', $this->transfer)) {
+            return $this->transfer['*'];
+        }
+        throw new InvalidTransferConfigException('No valid transfer mode is configured.');
     }
 
     public function isRequired(): bool

Classes/Transfer/Dto/RedisKeyPostfixesForEachRelease.php

@@ -2,6 +2,8 @@
 declare(strict_types=1);
 
 namespace Flowpack\DecoupledContentStore\Transfer\Dto;
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
+
 class RedisKeyPostfixesForEachRelease
 {
 
@@ -36,10 +38,10 @@ public static function fromArray(array $in): self
     /**
      * @return iterable|RedisKeyPostfixForEachRelease[]
      */
-    public function getKeysToTransfer(): iterable
+    public function getKeysToTransfer(RedisInstanceIdentifier $redisInstanceIdentifier): iterable
     {
         foreach ($this->redisKeyPostfixes as $redisKeyPostfix) {
-            if ($redisKeyPostfix->shouldTransfer()) {
+            if ($redisKeyPostfix->shouldTransfer($redisInstanceIdentifier)) {
                 yield $redisKeyPostfix;
             }
         }

Configuration/Settings.yaml

@@ -64,6 +64,11 @@ Flowpack:
       # each content release starts with a fixed prefix "contentRelease:[releaseId]:", and afterwards
       # follows a part which needs to be registered here. This is needed for synchronization between different
       # content stores and cleanup of old releases.
+      # the transfer setting can either be a boolean value for all redis content stores or an object that specifies
+      # *per content store*, if the key should be transferred or not. example for the latter:
+      #        transfer:
+      #          target_live: false
+      #          '*': true
       data:
         redisKeyPostfix: 'data'
         transfer: true