BUGFIX: Enable storing rendered documents in non public workspaces

Author: Sebobo

Classes/Aspects/CacheUrlMappingAspect.php

@@ -102,9 +102,6 @@ public function storeRootCacheIdentifier(JoinPointInterface $joinPoint)
 
         /** @var NodeInterface $node */
         $node = $this->currentEvaluateContext['cacheIdentifierValues']['node'];
-        if (!$node->getContext()->getWorkspace()->isPublicWorkspace()) {
-            return;
-        }
 
         $url = $this->getCurrentUrl();
 
@@ -144,6 +141,7 @@ public function storeRootCacheIdentifier(JoinPointInterface $joinPoint)
         $logger->debug('Mapping URL ' . $url . ' to ' . $rootIdentifier . ' with tags ' . implode(', ', $rootTags));
 
         $arguments = $this->getCurrentArguments($node);
+        // TODO: To make parallel rendering possible, we need to make sure that the cache key also includes the currently rendered workspace, as the node might originate from a base workspace (usually live). See `DocumentNodeCacheKey`.
         $rootKey = DocumentNodeCacheKey::fromNodeAndArguments($node, $arguments);
         $rootCacheValues = DocumentNodeCacheValues::create($rootIdentifier, $url);
         // allow other document metadata generators here

Classes/NodeEnumeration/Domain/Dto/EnumeratedNode.php

@@ -56,12 +56,14 @@ static public function fromJsonString(string $enumeratedNodeString): self
         return new self($tmp['contextPath'], $tmp['nodeIdentifier'], $tmp['arguments']);
     }
 
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return [
             'contextPath' => $this->contextPath,
             'nodeIdentifier' => $this->nodeIdentifier,
-            'arguments' => $this->arguments
+            'dimensions' => $this->getDimensionsFromContextPath(),
+            'workspaceName' => $this->getWorkspaceNameFromContextPath(),
+            'arguments' => $this->arguments,
         ];
     }
 
@@ -86,9 +88,6 @@ public function getWorkspaceNameFromContextPath(): string
         return $nodePathAndContext['workspaceName'];
     }
 
-    /**
-     * @return string
-     */
     public function getNodeIdentifier(): string
     {
         return $this->nodeIdentifier;

Classes/NodeRendering/Dto/DocumentNodeCacheKey.php

@@ -25,35 +25,42 @@ final class DocumentNodeCacheKey
      */
     protected $dimensions;
 
+    /**
+     * @var string
+     */
+    protected $workspaceName;
+
     /**
      * @var array
      */
     protected $arguments;
 
-    private function __construct(string $nodeIdentifier, array $dimensions, array $arguments)
+    private function __construct(string $nodeIdentifier, array $dimensions, string $workspaceName, array $arguments)
     {
         // we need to make this deterministic
         ksort($arguments);
         ksort($dimensions);
 
         $this->nodeIdentifier = $nodeIdentifier;
         $this->dimensions = $dimensions;
+        $this->workspaceName = $workspaceName;
         $this->arguments = $arguments;
     }
 
 
     public static function fromNodeAndArguments(NodeInterface $node, array $arguments): self
     {
-        return new self($node->getIdentifier(), $node->getContext()->getDimensions(), $arguments);
+        return new self($node->getIdentifier(), $node->getContext()->getDimensions(), $node->getWorkspace()->getName(), $arguments);
     }
 
     public static function fromEnumeratedNode(EnumeratedNode $enumeratedNode)
     {
-        return new self($enumeratedNode->getNodeIdentifier(), $enumeratedNode->getDimensionsFromContextPath(), $enumeratedNode->getArguments());
+        return new self($enumeratedNode->getNodeIdentifier(), $enumeratedNode->getDimensionsFromContextPath(), $enumeratedNode->getWorkspaceNameFromContextPath(), $enumeratedNode->getArguments());
     }
 
     public function redisKeyName(): string
     {
+        // TODO: Add workspace name to cache entry to allow parallel releases, but `CacheUrlMappingAspect` has to provide node in correct workspace during rendering
         return preg_replace('/[^a-zA-Z0-9-]/', '_', sprintf('doc--%s-%s-%s', $this->nodeIdentifier, json_encode($this->dimensions), json_encode($this->arguments)));
     }
 

Classes/NodeRendering/NodeRenderer.php

@@ -203,7 +203,9 @@ protected function renderDocumentNodeVariant(EnumeratedNode $enumeratedNode, Con
                 $contentReleaseLogger->debug('Rendering document node variant', [
                     'node' => $node->getContextPath(),
                     'nodeIdentifier' => $node->getIdentifier(),
-                    'arguments' => $enumeratedNode->getArguments()
+                    'workspaceName' => $enumeratedNode->getWorkspaceNameFromContextPath(),
+                    'dimensions' => $enumeratedNode->getDimensionsFromContextPath(),
+                    'arguments' => $enumeratedNode->getArguments(),
                 ]);
 
                 $this->documentRenderer->renderDocumentNodeVariant($node, $enumeratedNode->getArguments(), $contentReleaseLogger);