Merge pull request #51 from Flowpack/neos9

FEATURE: Neos 9.0 compatibility

Author: mhsdesign

.github/workflows/tests.yml

@@ -19,10 +19,24 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - php-version: 7.4
-            neos-version: 7.3
-          - php-version: 8.1
-            neos-version: 8.3
+          - php-version: "8.2"
+            neos-version: "9.0"
+          - php-version: "8.3"
+            neos-version: "9.0"
+
+    services:
+      mariadb:
+        # see https://mariadb.com/kb/en/mariadb-server-release-dates/
+        # this should be a current release, e.g. the LTS version
+        image: mariadb:10.8
+        env:
+          MYSQL_USER: neos
+          MYSQL_PASSWORD: neos
+          MYSQL_DATABASE: neos_functional_testing
+          MYSQL_ROOT_PASSWORD: neos
+        ports:
+          - "3306:3306"
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
 
     steps:
       - name: Checkout code
@@ -38,15 +52,15 @@ jobs:
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
         shell: bash
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Prepare Neos distribution
         run: |
-          git clone --depth 1 --branch ${{ matrix.neos-version }} https://github.com/neos/neos-base-distribution.git ${FLOW_PATH_ROOT}
+          git clone --depth 1 --branch ${{ matrix.neos-version }} https://github.com/neos/neos-development-distribution.git ${FLOW_PATH_ROOT}
           cd ${FLOW_PATH_ROOT}
           composer config --no-plugins allow-plugins.neos/composer-plugin true
           composer config repositories.package '{ "type": "path", "url": "../Flowpack.NodeTemplates", "options": { "symlink": false } }'
@@ -56,6 +70,7 @@ jobs:
       - name: Install dependencies
         run: |
           cd ${FLOW_PATH_ROOT}
+          rm -rf composer.lock
           composer install --no-interaction --no-progress --prefer-dist
 
       - name: Linting
@@ -66,9 +81,35 @@ jobs:
       - name: Run Unit tests
         run: |
           cd ${FLOW_PATH_ROOT}
-          bin/phpunit --colors -c Build/BuildEssentials/PhpUnit/UnitTests.xml Packages/Application/Flowpack.NodeTemplates/Tests/Unit
+          bin/phpunit -c Build/BuildEssentials/PhpUnit/UnitTests.xml Packages/Application/Flowpack.NodeTemplates/Tests/Unit
+
+      - name: Setup Flow configuration
+        run: |
+          cd ${FLOW_PATH_ROOT}
+          rm -f Configuration/Testing/Settings.yaml
+          cat <<EOF >> Configuration/Testing/Settings.yaml
+          Neos:
+            Flow:
+              persistence:
+                backendOptions:
+                  host: '127.0.0.1'
+                  driver: pdo_mysql
+                  user: 'neos'
+                  password: 'neos'
+                  dbname: 'neos_functional_testing'
+          EOF
 
       - name: Run Functional tests
         run: |
           cd ${FLOW_PATH_ROOT}
-          bin/phpunit --colors -c Build/BuildEssentials/PhpUnit/FunctionalTests.xml Packages/Application/Flowpack.NodeTemplates/Tests/Functional
+          bin/phpunit -c Build/BuildEssentials/PhpUnit/FunctionalTests.xml Packages/Application/Flowpack.NodeTemplates/Tests/Functional
+
+      - name: Show log on failure
+        if: ${{ failure()  }}
+        run: |
+          cd ${FLOW_PATH_ROOT}
+          cat Data/Logs/System_Testing.log
+          for file in Data/Logs/Exceptions/*; do
+            echo $file
+            cat $file
+          done

Classes/Application/Command/NodeTemplateCommandController.php

@@ -8,12 +8,18 @@
 use Flowpack\NodeTemplates\Domain\NodeCreation\NodeCreationService;
 use Flowpack\NodeTemplates\Domain\NodeTemplateDumper\NodeTemplateDumper;
 use Flowpack\NodeTemplates\Domain\TemplateConfiguration\TemplateConfigurationProcessor;
-use Neos\ContentRepository\Domain\Model\NodeInterface;
-use Neos\ContentRepository\Domain\Service\ContextFactoryInterface;
-use Neos\ContentRepository\Domain\Service\NodeTypeManager;
+use Neos\ContentRepository\Core\Feature\NodeCreation\Command\CreateNodeAggregateWithNode;
+use Neos\ContentRepository\Core\Projection\ContentGraph\AbsoluteNodePath;
+use Neos\ContentRepository\Core\Projection\ContentGraph\NodePath;
+use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
+use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
+use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName;
+use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cli\CommandController;
-use Neos\Neos\Domain\Service\ContentContext;
+use Neos\Neos\Domain\Repository\SiteRepository;
+use Neos\Neos\Domain\Service\NodeTypeNameFactory;
+use Neos\Neos\Ui\Domain\NodeCreation\NodeCreationCommands;
 
 class NodeTemplateCommandController extends CommandController
 {
@@ -23,12 +29,6 @@ class NodeTemplateCommandController extends CommandController
      */
     protected $nodeCreationService;
 
-    /**
-     * @Flow\Inject
-     * @var ContextFactoryInterface
-     */
-    protected $contextFactory;
-
     /**
      * @Flow\Inject
      * @var NodeTemplateDumper
@@ -42,30 +42,52 @@ class NodeTemplateCommandController extends CommandController
     protected $templateConfigurationProcessor;
 
     /**
+     * @var SiteRepository
      * @Flow\Inject
-     * @var NodeTypeManager
      */
-    protected $nodeTypeManager;
+    protected $siteRepository;
+
+    /**
+     * @var ContentRepositoryRegistry
+     * @Flow\Inject
+     */
+    protected $contentRepositoryRegistry;
 
     /**
      * Dump the node tree structure into a NodeTemplate YAML structure.
      * References to Nodes and non-primitive property values are commented out in the YAML.
      *
      * @param string $startingNodeId specified root node of the node tree.
+     * @param string|null $site the Neos site, which determines the content repository. Defaults to the first available one.
      * @param string $workspaceName custom workspace to dump from. Defaults to 'live'.
      * @return void
      */
-    public function createFromNodeSubtreeCommand(string $startingNodeId, string $workspaceName = 'live'): void
+    public function createFromNodeSubtreeCommand(string $startingNodeId, ?string $site = null, string $workspaceName = 'live'): void
     {
-        $subgraph = $this->contextFactory->create([
-            'workspaceName' => $workspaceName
-        ]);
-        /** @var ?NodeInterface $node */
-        $node = $subgraph->getNodeByIdentifier($startingNodeId);
+        $siteInstance = $site
+            ? $this->siteRepository->findOneByNodeName($site)
+            : $this->siteRepository->findDefault();
+
+        if (!$siteInstance) {
+            $this->outputLine(sprintf('<error>Site "%s" does not exist.</error>', $site));
+            $this->quit(2);
+        }
+
+        $siteConfiguration = $siteInstance->getConfiguration();
+
+        $contentRepository = $this->contentRepositoryRegistry->get($siteConfiguration->contentRepositoryId);
+
+        // default context? https://github.com/neos/neos-development-collection/issues/5113
+        $subgraph = $contentRepository->getContentGraph(WorkspaceName::fromString($workspaceName))->getSubgraph(
+            $siteConfiguration->defaultDimensionSpacePoint,
+            VisibilityConstraints::default()
+        );
+
+        $node = $subgraph->findNodeById(NodeAggregateId::fromString($startingNodeId));
         if (!$node) {
             throw new \InvalidArgumentException("Node $startingNodeId doesnt exist in workspace $workspaceName.");
         }
-        echo $this->nodeTemplateDumper->createNodeTemplateYamlDumpFromSubtree($node);
+        echo $this->nodeTemplateDumper->createNodeTemplateYamlDumpFromSubtree($node, $contentRepository);
     }
 
     /**
@@ -74,25 +96,54 @@ public function createFromNodeSubtreeCommand(string $startingNodeId, string $wor
      *
      * We process and build all configured NodeType templates. No nodes will be created in the Content Repository.
      *
+     * @param string|null $site the Neos site, which determines the content repository. Defaults to the first available one.
      */
-    public function validateCommand(): void
+    public function validateCommand(?string $site = null): void
     {
+        $siteInstance = $site
+            ? $this->siteRepository->findOneByNodeName($site)
+            : $this->siteRepository->findDefault();
+
+        if (!$siteInstance) {
+            $this->outputLine(sprintf('<error>Site "%s" does not exist.</error>', $site));
+            $this->quit(2);
+        }
+
+        $siteConfiguration = $siteInstance->getConfiguration();
+
+        $contentRepository = $this->contentRepositoryRegistry->get($siteConfiguration->contentRepositoryId);
+
         $templatesChecked = 0;
         /**
          * nodeTypeNames as index
          * @var array<string, array{processingErrors: ProcessingErrors, dataWasAccessed: bool}> $faultyNodeTypeTemplates
          */
         $faultyNodeTypeTemplates = [];
 
-        foreach ($this->nodeTypeManager->getNodeTypes(false) as $nodeType) {
+        // default context? https://github.com/neos/neos-development-collection/issues/5113
+        $subgraph = $contentRepository->getContentGraph(WorkspaceName::forLive())->getSubgraph(
+            $siteConfiguration->defaultDimensionSpacePoint,
+            VisibilityConstraints::default()
+        );
+
+        $sitesNode = $subgraph->findRootNodeByType(NodeTypeNameFactory::forSites());
+        $siteNode = $sitesNode ? $subgraph->findNodeByPath(
+            $siteInstance->getNodeName()->toNodeName(),
+            $sitesNode->aggregateId
+        ) : null;
+
+        if (!$siteNode) {
+            $this->outputLine(sprintf('<error>Could not resolve site node for site "%s".</error>', $siteInstance->getNodeName()->value));
+            $this->quit(3);
+        }
+
+        foreach ($contentRepository->getNodeTypeManager()->getNodeTypes(false) as $nodeType) {
             $templateConfiguration = $nodeType->getOptions()['template'] ?? null;
             if (!$templateConfiguration) {
                 continue;
             }
             $processingErrors = ProcessingErrors::create();
 
-            /** @var ContentContext $subgraph */
-            $subgraph = $this->contextFactory->create();
 
             $observableEmptyData = new class ([]) extends \ArrayObject
             {
@@ -104,27 +155,37 @@ public function offsetExists($key): bool
                 }
             };
 
-            $siteNode = $subgraph->getCurrentSiteNode();
-
             $template = $this->templateConfigurationProcessor->processTemplateConfiguration(
                 $templateConfiguration,
                 [
                     'data' => $observableEmptyData,
-                    'triggeringNode' => $siteNode, // @deprecated
                     'site' => $siteNode,
                     'parentNode' => $siteNode,
                 ],
                 $processingErrors
             );
 
-            $this->nodeCreationService->createMutatorsForRootTemplate($template, $nodeType, $this->nodeTypeManager, $subgraph, $processingErrors);
+            $fakeNodeCreationCommands = NodeCreationCommands::fromFirstCommand(
+                CreateNodeAggregateWithNode::create(
+                    $siteNode->workspaceName,
+                    NodeAggregateId::create(),
+                    $nodeType->name,
+                    $siteNode->originDimensionSpacePoint,
+                    $siteNode->aggregateId
+                ),
+                $contentRepository->getNodeTypeManager()
+            );
+
+            $this->nodeCreationService->apply($template, $fakeNodeCreationCommands, $contentRepository->getNodeTypeManager(), $subgraph, $nodeType, $processingErrors);
 
             if ($processingErrors->hasError()) {
-                $faultyNodeTypeTemplates[$nodeType->getName()] = ['processingErrors' => $processingErrors, 'dataWasAccessed' => $observableEmptyData->dataWasAccessed];
+                $faultyNodeTypeTemplates[$nodeType->name->value] = ['processingErrors' => $processingErrors, 'dataWasAccessed' => $observableEmptyData->dataWasAccessed];
             }
             $templatesChecked++;
         }
 
+        $this->output(sprintf('<comment>Content repository "%s": </comment>', $contentRepository->id->value));
+
         if ($templatesChecked === 0) {
             $this->outputLine('<comment>No NodeType templates found.</comment>');
             return;

Classes/Domain/ErrorHandling/ErrorHandlingConfiguration.php

@@ -8,6 +8,7 @@ class ErrorHandlingConfiguration
 {
     /**
      * @Flow\InjectConfiguration(package="Flowpack.NodeTemplates", path="errorHandling")
+     * @var array<mixed>
      */
     protected array $configuration;
 

Classes/Domain/ErrorHandling/ProcessingErrorHandler.php

@@ -2,11 +2,13 @@
 
 namespace Flowpack\NodeTemplates\Domain\ErrorHandling;
 
-use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\ContentRepository\Core\NodeType\NodeType;
+use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Log\ThrowableStorageInterface;
 use Neos\Flow\Log\Utility\LogEnvironment;
 use Neos\Neos\Ui\Domain\Model\Feedback\Messages\Error;
+use Neos\Neos\Ui\Domain\Model\Feedback\Messages\Warning;
 use Neos\Neos\Ui\Domain\Model\FeedbackCollection;
 use Psr\Log\LoggerInterface;
 
@@ -39,7 +41,7 @@ class ProcessingErrorHandler
     /**
      * @return bool if to continue or abort
      */
-    public function handleAfterTemplateConfigurationProcessing(ProcessingErrors $processingErrors, NodeInterface $node): bool
+    public function handleAfterTemplateConfigurationProcessing(ProcessingErrors $processingErrors, NodeType $nodeType, NodeAggregateId $nodeAggregateId): bool
     {
         if (!$processingErrors->hasError()) {
             return true;
@@ -49,9 +51,8 @@ public function handleAfterTemplateConfigurationProcessing(ProcessingErrors $pro
             return true;
         }
 
-        assert(method_exists($node, '__toString'));
         $templateNotCreatedException = new TemplateNotCreatedException(
-            sprintf('Template for "%s" was not applied. Only %s was created.', $node->getNodeType()->getLabel(), (string)$node),
+            sprintf('Template for "%s" was not applied. Only %s was created.', $nodeType->getLabel(), $nodeAggregateId->value),
             1686135532992,
             $processingErrors->first()->getException(),
         );
@@ -64,15 +65,14 @@ public function handleAfterTemplateConfigurationProcessing(ProcessingErrors $pro
     /**
      * @return bool if to continue or abort
      */
-    public function handleAfterNodeCreation(ProcessingErrors $processingErrors, NodeInterface $node): bool
+    public function handleAfterNodeCreation(ProcessingErrors $processingErrors, NodeType $nodeType, NodeAggregateId $nodeAggregateId): bool
     {
         if (!$processingErrors->hasError()) {
             return true;
         }
 
-        assert(method_exists($node, '__toString'));
         $templatePartiallyCreatedException = new TemplatePartiallyCreatedException(
-            sprintf('Template for "%s" only partially applied. Please check the newly created nodes beneath %s.', $node->getNodeType()->getLabel(), (string)$node),
+            sprintf('Template for "%s" only partially applied. Please check the newly created nodes beneath %s.', $nodeType->getLabel(), $nodeAggregateId->value),
             1686135564160,
             $processingErrors->first()->getException(),
         );
@@ -106,10 +106,10 @@ private function logProcessingErrors(ProcessingErrors $processingErrors, \Domain
         );
 
         foreach ($messages as $message) {
-            $error = new Error();
-            $error->setMessage($message);
+            $warning = new Warning();
+            $warning->setMessage($message);
             $this->feedbackCollection->add(
-                $error
+                $warning
             );
         }
     }

Classes/Domain/ErrorHandling/ProcessingErrors.php

@@ -2,9 +2,7 @@
 
 namespace Flowpack\NodeTemplates\Domain\ErrorHandling;
 
-use Neos\Flow\Annotations as Flow;
-
-/** @Flow\Proxy(false) */
+/** @implements \IteratorAggregate<int, ProcessingError> */
 class ProcessingErrors implements \IteratorAggregate
 {
     /** @var array<int, ProcessingError> */
@@ -19,6 +17,7 @@ public static function create(): self
         return new self();
     }
 
+    /** @phpstan-assert-if-true !null $this->first() */
     public function hasError(): bool
     {
         return $this->errors !== [];