TASK: prevent setProperty from running multiple times on one update

Classes/NodeSignalInterceptor.php

@@ -9,30 +9,39 @@
  */
 
 use Neos\ContentRepository\Domain\Model\NodeInterface;
-use Neos\ContentRepository\Exception\NodeException;
+use Neos\Flow\Annotations as Flow;
 use PunktDe\NodeReplicator\Replicator\NodeReplicator;
 
+/**
+ * @Flow\Scope("singleton")
+ */
 class NodeSignalInterceptor
 {
+    /**
+     * @Flow\Inject
+     * @var NodeReplicator
+     */
+    protected $nodeReplicator;
+
     /**
      * @param NodeInterface $node
      */
-    public static function nodeAdded(NodeInterface $node): void
+    public function nodeAdded(NodeInterface $node): void
     {
         if (self::hasReplicationConfiguration($node) && (self::nodeCreateReplicationEnabled($node) || self::nodeCreateHiddenEnabled($node))) {
-            // The nodedAdded signal is called twice. When it is called the first time, 
+            // The nodeAdded signal is called twice. When it is called the first time,
             // the node is not created completely (the child nodes are not created yet), so we skip that call.
             if (count($node->getNodeType()->getAutoCreatedChildNodes()) > 0 && count($node->findChildNodes()) === 0) {
                 return;
             }
-            self::getNodeReplicator()->createNodeVariants($node, self::nodeCreateHiddenEnabled($node));
+            $this->nodeReplicator->createNodeVariants($node, self::nodeCreateHiddenEnabled($node));
         }
     }
 
     public function nodeRemoved(NodeInterface $node): void
     {
         if (self::hasReplicationConfiguration($node) && self::nodeRemoveReplicationEnabled($node)) {
-            self::getNodeReplicator()->removeNodeVariants($node);
+            $this->nodeReplicator->removeNodeVariants($node);
         }
     }
 
@@ -43,12 +52,12 @@ public function nodePropertyChanged(NodeInterface $node, string $propertyName, $
         }
 
         if ($node->getNodeType()->getConfiguration('properties.' . $propertyName . '.options.replication.updateEmptyOnly')) {
-            self::getNodeReplicator()->updateContent($node, $propertyName, $newValue, true);
+            $this->nodeReplicator->updateContent($node, $propertyName, $newValue, true);
             return;
         }
 
         if ($node->getNodeType()->getConfiguration('properties.' . $propertyName . '.options.replication.update')) {
-            self::getNodeReplicator()->updateContent($node, $propertyName, $newValue, false);
+            $this->nodeReplicator->updateContent($node, $propertyName, $newValue, false);
         }
     }
 
@@ -71,21 +80,4 @@ protected static function nodeCreateHiddenEnabled(NodeInterface $node): bool
     {
         return $node->getNodeType()->hasConfiguration('options.replication.structure.createHidden') && $node->getNodeType()->getConfiguration('options.replication.structure.createHidden');
     }
-
-    /**
-     * @return Replicator\NodeReplicator
-     */
-    protected static function getNodeReplicator(): NodeReplicator
-    {
-        return new Replicator\NodeReplicator();
-    }
-
-    /**
-     * @param NodeInterface $node
-     * @return array|null
-     */
-    protected static function getExcludedProperties(NodeInterface $node): ?array
-    {
-        return $node->getNodeType()->getConfiguration('options.replication.excludeProperties');
-    }
 }

Classes/Package.php

@@ -25,8 +25,8 @@ class Package extends BasePackage
     public function boot(Bootstrap $bootstrap)
     {
         $dispatcher = $bootstrap->getSignalSlotDispatcher();
-        $dispatcher->connect(Node::class, 'nodeAdded', NodeSignalInterceptor::class, '::nodeAdded');
-        $dispatcher->connect(Node::class, 'nodePropertyChanged', NodeSignalInterceptor::class, '::nodePropertyChanged');
-        $dispatcher->connect(Node::class, 'nodeRemoved', NodeSignalInterceptor::class, '::nodeRemoved');
+        $dispatcher->connect(Node::class, 'nodeAdded', NodeSignalInterceptor::class, 'nodeAdded');
+        $dispatcher->connect(Node::class, 'nodePropertyChanged', NodeSignalInterceptor::class, 'nodePropertyChanged');
+        $dispatcher->connect(Node::class, 'nodeRemoved', NodeSignalInterceptor::class, 'nodeRemoved');
     }
 }

Classes/Replicator/NodeReplicator.php

@@ -9,12 +9,10 @@
  */
 
 use Neos\ContentRepository\Domain\Model\NodeInterface;
-use Neos\ContentRepository\Exception\NodeException;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Log\Utility\LogEnvironment;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
-use Neos\Flow\Persistence\PersistenceManagerInterface;
 
 /**
  * @Flow\Scope("singleton")
@@ -27,6 +25,11 @@ class NodeReplicator
      */
     protected $logger;
 
+    /**
+     * @var boolean
+     */
+    protected $isReplicating = false;
+
     public function createNodeVariants(NodeInterface $node, bool $createHidden = false): void
     {
         foreach ($this->getParentVariants($node) as $parentVariant) {
@@ -61,6 +64,13 @@ public function removeNodeVariants(NodeInterface $node): void
 
     public function updateContent(NodeInterface $node, string $propertyName, $newValue, bool $updateEmptyOnly)
     {
+        // Setting properties on nodes trigger the nodePropertyChanged signal so we need to prevent this function to keep
+        // running in a loop (or at least more often as it would need). The solution here introduces state but it is
+        // most likely okay because there is no concurrency.
+        if ($this->isReplicating === true) {
+            return;
+        }
+
         foreach ($this->getParentVariants($node) as $parentVariant) {
             $variantNode = $parentVariant->getContext()->getNodeByIdentifier($node->getIdentifier());
 
@@ -73,8 +83,14 @@ public function updateContent(NodeInterface $node, string $propertyName, $newVal
                 continue;
             }
 
-            $variantNode->setProperty($propertyName, $newValue);
-            $this->logReplicationAction($node, sprintf('Property %s of the node was updated', $propertyName), __METHOD__);
+            $this->isReplicating = true;
+            try {
+                $variantNode->setProperty($propertyName, $newValue);
+            } finally {
+                $this->isReplicating = false;
+            }
+
+            $this->logReplicationAction($variantNode, sprintf('Property %s of the node was updated', $propertyName), __METHOD__);
         }
     }
 
@@ -91,7 +107,7 @@ protected function getParentVariants(NodeInterface $node): array
         if ($node->getParent() === null) {
             return [];
         }
-        
+
         return $node->getParent()->getOtherNodeVariants();
     }