FEATURE: support for different output formats, with differing documentRenderers and custom enumerators

# Conflicts:
#	Classes/NodeEnumeration/Domain/Dto/EnumeratedNode.php
#	Classes/NodeEnumeration/NodeEnumerator.php
#	Classes/NodeRendering/NodeRenderer.php

Author: skurfuerst

Classes/NodeEnumeration/Domain/Dto/EnumeratedNode.php

@@ -41,17 +41,24 @@ final class EnumeratedNode implements \JsonSerializable
      */
     protected $nodeTypeName;
 
-    private function __construct(string $contextPath, string $nodeIdentifier, string $nodeTypeName, array $arguments)
+    /**
+     * The renderer implementation to use for this EnumeratedNode;
+     * a key from Settings at Flowpack.DecoupledContentStore.extensions.documentRenderers.[key]
+     */
+    public readonly string $rendererId;
+
+    private function __construct(string $contextPath, string $nodeIdentifier, string $nodeTypeName, array $arguments, string $rendererId = '')
     {
         $this->contextPath = $contextPath;
         $this->nodeIdentifier = $nodeIdentifier;
         $this->nodeTypeName = $nodeTypeName;
         $this->arguments = $arguments;
+        $this->rendererId = $rendererId;
     }
 
     static public function fromNode(NodeInterface $node, array $arguments = []): self
     {
-        return new self($node->getContextPath(), $node->getIdentifier(), $node->getNodeType()->getName(), $arguments);
+        return new self($node->getContextPath(), $node->getIdentifier(), $node->getNodeType()->getName(), $arguments, '');
     }
 
     static public function fromJsonString(string $enumeratedNodeString): self
@@ -60,7 +67,7 @@ static public function fromJsonString(string $enumeratedNodeString): self
         if (!is_array($tmp)) {
             throw new \Exception('EnumeratedNode cannot be constructed from: ' . $enumeratedNodeString);
         }
-        return new self($tmp['contextPath'], $tmp['nodeIdentifier'], $tmp['nodeTypeName'] ?? '', $tmp['arguments']);
+        return new self($tmp['contextPath'], $tmp['nodeIdentifier'], $tmp['nodeTypeName'] ?? '', $tmp['arguments'], $tmp['rendererId']);
     }
 
     public function jsonSerialize(): array
@@ -70,6 +77,7 @@ public function jsonSerialize(): array
             'nodeIdentifier' => $this->nodeIdentifier,
             'nodeTypeName' => $this->nodeTypeName,
             'arguments' => $this->arguments,
+            'rendererId' => $this->rendererId,
         ];
     }
 
@@ -111,6 +119,11 @@ public function getArguments(): array
 
     public function debugString(): string
     {
-        return sprintf('%s %s %s(%s)', $this->nodeTypeName, $this->nodeIdentifier, $this->arguments ? http_build_query($this->arguments) . ' ' : '', $this->contextPath);
+        return sprintf('%s %s %s(%s) - %s', $this->nodeTypeName, $this->nodeIdentifier, $this->arguments ? http_build_query($this->arguments) . ' ' : '', $this->contextPath, $this->rendererId);
+    }
+
+    public function withRendererId(string $rendererId): self
+    {
+        return new self($this->contextPath, $this->nodeIdentifier, $this->nodeTypeName, $this->arguments, $rendererId);
     }
 }

Classes/NodeEnumeration/NodeEnumerator.php

@@ -11,6 +11,7 @@
 use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Repository\RedisEnumerationRepository;
 use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Service\NodeContextCombinator;
 use Flowpack\DecoupledContentStore\NodeRendering\Dto\NodeRenderingCompletionStatus;
+use Flowpack\DecoupledContentStore\NodeRendering\Extensibility\NodeRenderingExtensionManager;
 use Flowpack\DecoupledContentStore\PrepareContentRelease\Infrastructure\RedisContentReleaseService;
 use Flowpack\DecoupledContentStore\Utility\GeneratorUtility;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
@@ -40,6 +41,12 @@ class NodeEnumerator
      */
     protected $concurrentBuildLockService;
 
+    /**
+     * @Flow\Inject
+     * @var NodeRenderingExtensionManager
+     */
+    protected $nodeRenderingExtensionManager;
+
     /**
      * @Flow\InjectConfiguration("nodeRendering.nodeTypeWhitelist")
      * @var string
@@ -74,9 +81,10 @@ public function enumerateAndStoreInRedis(
         ) {
             $this->concurrentBuildLockService->assertNoOtherContentReleaseWasStarted($releaseIdentifier);
             // $enumeration is an array of EnumeratedNode, with at most 100 elements in it.
-            // TODO: EXTENSION POINT HERE, TO ADD ADDITIONAL ENUMERATIONS (.metadata.json f.e.)
-            // TODO: not yet fully sure how to handle Enumeration
+
             $this->redisEnumerationRepository->addDocumentNodesToEnumeration($releaseIdentifier, ...$enumeration);
+
+            // DEPRECATED: use extensions.documentRenderers.[...].enumeratorClassName instead
             foreach ($enumeration as $enumeratedNode) {
                 $this->emitNodeEnumerated($enumeratedNode, $releaseIdentifier, $contentReleaseLogger);
             }
@@ -116,6 +124,7 @@ private function enumerateAll(
                 'name' => $site->getName(),
                 'domain' => $site->getFirstActiveDomain()
             ]);
+
             foreach ($combinator->siteNodeInContexts($site, $workspaceName) as $siteNode) {
                 $startTime = microtime(true);
                 $dimensionValues = $siteNode->getContext()->getDimensions();
@@ -178,6 +187,8 @@ private function enumerateAll(
      *
      * This signal can be used to add additional EnumeratedNode entries (e.g. with added arguments for pagination or filters) based on the given node.
      *
+     * DEPRECATED: use extensions.documentRenderers.[...].enumeratorClassName instead
+     *
      * @param EnumeratedNode $enumeratedNode
      * @param ContentReleaseIdentifier $releaseIdentifier
      * @param ContentReleaseLogger $contentReleaseLogger

Classes/NodeRendering/Extensibility/DocumentEnumeratorInterface.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\DecoupledContentStore\NodeRendering\Extensibility;
+
+use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Dto\EnumeratedNode;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+
+/**
+ * Adjust document enumeration.
+ *
+ * The Document Enumeration decides for every Document Node what variants should appear
+ * in the resulting Content Release.
+ *
+ * It should return an array of {@see EnumeratedNode} objects.
+ *
+ * This can be used to:
+ * - render document nodes in different variants, e.g. formats
+ * - use different renderers (configured via Flowpack.DecoupledContentStore.extensions.documentRenderers.[...])
+ * - decide at runtime which (document) nodes should be part of a content release and which not.
+ */
+interface DocumentEnumeratorInterface
+{
+    public function __construct(array $options = []);
+
+    /**
+     * @return iterable<EnumeratedNode>
+     */
+    public function enumerateDocumentNode(NodeInterface $documentNode): iterable;
+}

Classes/NodeRendering/Extensibility/DocumentEnumerators/DefaultEnumerator.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Flowpack\DecoupledContentStore\NodeRendering\Extensibility\DocumentEnumerators;
+
+use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Dto\EnumeratedNode;
+use Flowpack\DecoupledContentStore\NodeRendering\Extensibility\DocumentEnumeratorInterface;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+
+class DefaultEnumerator implements DocumentEnumeratorInterface
+{
+    public function __construct(array $options = [])
+    {
+    }
+
+    public function enumerateDocumentNode(NodeInterface $documentNode): iterable
+    {
+        return [
+            EnumeratedNode::fromNode($documentNode),
+        ];
+    }
+}

Classes/NodeRendering/Extensibility/DocumentEnumerators/LimitEnumerator.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Flowpack\DecoupledContentStore\NodeRendering\Extensibility\DocumentEnumerators;
+
+use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Dto\EnumeratedNode;
+use Flowpack\DecoupledContentStore\NodeRendering\Extensibility\DocumentEnumeratorInterface;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+
+/**
+ * An enumerator which only renders the first N pages. very useful for interactive testing.
+ * NOT useful for production.
+ */
+class LimitEnumerator implements DocumentEnumeratorInterface
+{
+    protected int $i = 0;
+    private int $limit;
+
+    public function __construct(
+        array $options = []
+    ) {
+        $this->limit = $options['limit'] ?? throw new \InvalidArgumentException('Missing limit option');
+    }
+    public function enumerateDocumentNode(NodeInterface $documentNode): iterable
+    {
+        if ($this->i++ >= $this->limit) {
+            return [];
+        }
+
+        return [
+            EnumeratedNode::fromNode($documentNode),
+        ];
+    }
+}

Classes/NodeRendering/Extensibility/DocumentRendererInterface.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\DecoupledContentStore\NodeRendering\Extensibility;
+
+use Flowpack\DecoupledContentStore\Core\Infrastructure\ContentReleaseLogger;
+use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Dto\EnumeratedNode;
+use Flowpack\DecoupledContentStore\NodeRendering\Dto\RenderedDocumentFromContentCache;
+use Flowpack\DecoupledContentStore\NodeRendering\NodeRenderer;
+use Flowpack\DecoupledContentStore\NodeRendering\NodeRenderOrchestrator;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+
+/**
+ * Decide how to render a document node. Used throughout {@see NodeRenderOrchestrator} and {@see NodeRenderer}
+ * for the specific rendering logic.
+ *
+ * If you want to create additional output formats (e.g. JSON), or you want rendering without
+ * Fusion, you'll need to create a custom DocumentRenderer.
+ */
+interface DocumentRendererInterface
+{
+    public function tryToExtractRenderingForEnumeratedNodeFromContentCache(EnumeratedNode $enumeratedNode): RenderedDocumentFromContentCache;
+
+    public function renderDocumentNodeVariant(NodeInterface $node, EnumeratedNode $enumeratedNode, ContentReleaseLogger $contentReleaseLogger);
+}

Classes/NodeRendering/Extensibility/DocumentRenderers/FusionHtmlRenderer.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Flowpack\DecoupledContentStore\NodeRendering\Extensibility\DocumentRenderers;
+
+use Neos\Flow\Annotations as Flow;
+use Flowpack\DecoupledContentStore\Core\Infrastructure\ContentReleaseLogger;
+use Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Dto\EnumeratedNode;
+use Flowpack\DecoupledContentStore\NodeRendering\Dto\DocumentNodeCacheKey;
+use Flowpack\DecoupledContentStore\NodeRendering\Dto\RenderedDocumentFromContentCache;
+use Flowpack\DecoupledContentStore\NodeRendering\Extensibility\DocumentRendererInterface;
+use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisContentCacheReader;
+use Flowpack\DecoupledContentStore\NodeRendering\Render\DocumentRenderer;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+
+class FusionHtmlRenderer implements DocumentRendererInterface
+{
+
+    /**
+     * @Flow\Inject
+     * @var RedisContentCacheReader
+     */
+    protected $redisContentCacheReader;
+
+    /**
+     * @Flow\Inject
+     * @var DocumentRenderer
+     */
+    protected $documentRenderer;
+
+
+    public function tryToExtractRenderingForEnumeratedNodeFromContentCache(EnumeratedNode $enumeratedNode): RenderedDocumentFromContentCache
+    {
+        return $this->redisContentCacheReader->tryToExtractRenderingForEnumeratedNodeFromContentCache(DocumentNodeCacheKey::fromEnumeratedNode($enumeratedNode));
+    }
+
+    public function renderDocumentNodeVariant(NodeInterface $node, EnumeratedNode $enumeratedNode, ContentReleaseLogger $contentReleaseLogger)
+    {
+        return $this->documentRenderer->renderDocumentNodeVariant($node, $enumeratedNode->getArguments(), $contentReleaseLogger);
+    }
+}