Merge pull request #5068 from mhsdesign/task/nodeAddressFlowPropertyM…

…apper

!!! TASK: Refactor `Node` property mapper to use new NodeAddress

Neos.Neos/Classes/Controller/Backend/ContentController.php

@@ -150,14 +150,15 @@ public function uploadAssetAction(Asset $asset, string $metadata, string $node,
         $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())
             ->contentRepositoryId;
         $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId);
-        $nodeAddress = NodeAddressFactory::create($contentRepository)->createFromUriString($nodeAddressString);
+        // todo legacy uri node address notation used. Should be refactored to use json encoded NodeAddress
+        $nodeAddress = NodeAddressFactory::create($contentRepository)->createCoreNodeAddressFromLegacyUriString($nodeAddressString);
 
         $node = $contentRepository->getContentGraph($nodeAddress->workspaceName)
             ->getSubgraph(
                 $nodeAddress->dimensionSpacePoint,
                 VisibilityConstraints::withoutRestrictions()
             )
-            ->findNodeById($nodeAddress->nodeAggregateId);
+            ->findNodeById($nodeAddress->aggregateId);
 
 
         $this->response->setContentType('application/json');

Neos.Neos/Classes/Controller/Service/NodesController.php

@@ -121,8 +121,9 @@ public function indexAction(
             : null;
         $nodeAddress = null;
         if (!$nodePath) {
+            // todo legacy uri node address notation used. Should be refactored to use json encoded NodeAddress
             $nodeAddress = $contextNode
-                ? NodeAddressFactory::create($contentRepository)->createFromUriString($contextNode)
+                ? NodeAddressFactory::create($contentRepository)->createCoreNodeAddressFromLegacyUriString($contextNode)
                 : null;
         }
 
@@ -141,7 +142,7 @@ public function indexAction(
 
         if ($nodeIds === [] && (!is_null($nodeAddress) || !is_null($nodePath))) {
             if (!is_null($nodeAddress)) {
-                $entryNode = $subgraph->findNodeById($nodeAddress->nodeAggregateId);
+                $entryNode = $subgraph->findNodeById($nodeAddress->aggregateId);
             } else {
                 /** @var AbsoluteNodePath $nodePath */
                 $entryNode = $subgraph->findNodeByAbsolutePath($nodePath);

Neos.Neos/Classes/FrontendRouting/NodeAddress.php

@@ -22,16 +22,6 @@
 use Neos\Flow\Annotations as Flow;
 
 /**
- * A persistent, external "address" of a node; used to link to it.
- *
- * Describes the intention of the user making the current request:
- * Show me
- *  node $nodeAggregateId
- *  in dimensions $dimensionSpacePoint
- *  in contentStreamId $contentStreamId
- *
- * It is used in Neos Routing to build a URI to a node.
- *
  * @deprecated will be removed before Final 9.0
  * The NodeAddress was added 6 years ago without the concept of multiple crs
  * Its usages will be replaced by the new node attached node address
@@ -42,8 +32,9 @@
     /**
      * @internal use NodeAddressFactory, if you want to create a NodeAddress
      */
+    /** @phpstan-ignore-next-line its all just temporary */
     public function __construct(
-        public ContentStreamId $contentStreamId,
+        ?ContentStreamId $_contentStreamId,
         public DimensionSpacePoint $dimensionSpacePoint,
         public NodeAggregateId $nodeAggregateId,
         public WorkspaceName $workspaceName
@@ -59,16 +50,10 @@ public function serializeForUri(): string
             . '__' . $this->nodeAggregateId->value;
     }
 
-    public function isInLiveWorkspace(): bool
-    {
-        return $this->workspaceName->isLive();
-    }
-
     public function __toString(): string
     {
         return sprintf(
-            'NodeAddress[contentStream=%s, dimensionSpacePoint=%s, nodeAggregateId=%s, workspaceName=%s]',
-            $this->contentStreamId->value,
+            'NodeAddress[dimensionSpacePoint=%s, nodeAggregateId=%s, workspaceName=%s]',
             $this->dimensionSpacePoint->toJson(),
             $this->nodeAggregateId->value,
             $this->workspaceName->value

Neos.Neos/Classes/FrontendRouting/NodeAddressFactory.php

@@ -20,7 +20,6 @@
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
 use Neos\ContentRepository\Core\SharedModel\Node\NodeAddress;
-use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName;
 
 /**
@@ -38,35 +37,13 @@ public static function create(ContentRepository $contentRepository): self
         return new self($contentRepository);
     }
 
-    public function createFromContentStreamIdAndDimensionSpacePointAndNodeAggregateId(
-        ContentStreamId $contentStreamId,
-        DimensionSpacePoint $dimensionSpacePoint,
-        NodeAggregateId $nodeAggregateId
-    ): LegacyNodeAddress {
-        $workspace = $this->contentRepository->getWorkspaceFinder()->findOneByCurrentContentStreamId(
-            $contentStreamId
-        );
-        if ($workspace === null) {
-            throw new \RuntimeException(
-                'Cannot build a NodeAddress for traversable node of aggregate ' . $nodeAggregateId->value
-                . ', because the content stream ' . $contentStreamId->value
-                . ' is not assigned to a workspace.'
-            );
-        }
-        return new LegacyNodeAddress(
-            $contentStreamId,
-            $dimensionSpacePoint,
-            $nodeAggregateId,
-            $workspace->workspaceName,
-        );
-    }
-
     public function createFromNode(Node $node): LegacyNodeAddress
     {
-        return $this->createFromContentStreamIdAndDimensionSpacePointAndNodeAggregateId(
-            $node->subgraphIdentity->contentStreamId,
+        return new LegacyNodeAddress(
+            null,
             $node->dimensionSpacePoint,
             $node->aggregateId,
+            $node->workspaceName,
         );
     }
 
@@ -93,17 +70,8 @@ public function createFromUriString(string $serializedNodeAddress): LegacyNodeAd
         $dimensionSpacePoint = DimensionSpacePoint::fromArray(json_decode(base64_decode($dimensionSpacePointSerialized), true));
         $nodeAggregateId = NodeAggregateId::fromString($nodeAggregateIdSerialized);
 
-        $contentStreamId = $this->contentRepository->getWorkspaceFinder()->findOneByName($workspaceName)
-            ?->currentContentStreamId;
-        if (is_null($contentStreamId)) {
-            throw new \InvalidArgumentException(
-                'Could not resolve content stream identifier for node address ' . $serializedNodeAddress,
-                1645363784
-            );
-        }
-
         return new LegacyNodeAddress(
-            $contentStreamId,
+            null,
             $dimensionSpacePoint,
             $nodeAggregateId,
             $workspaceName

Neos.Neos/Classes/Fusion/Helper/NodeHelper.php

@@ -21,13 +21,12 @@
 use Neos\ContentRepository\Core\Projection\ContentGraph\Filter\FindAncestorNodesFilter;
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\ContentRepository\Core\Projection\ContentGraph\NodePath;
-use Neos\ContentRepository\Core\Projection\NodeHiddenState\NodeHiddenStateFinder;
+use Neos\ContentRepository\Core\SharedModel\Node\NodeAddress;
 use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Eel\ProtectedContextAwareInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Neos\Domain\Exception;
 use Neos\Neos\Domain\Service\NodeTypeNameFactory;
-use Neos\Neos\FrontendRouting\NodeAddressFactory;
 use Neos\Neos\Presentation\VisualNodePath;
 use Neos\Neos\Utility\NodeTypeWithFallbackProvider;
 
@@ -155,11 +154,7 @@ public function isNodeTypeExistent(Node $node): bool
 
     public function serializedNodeAddress(Node $node): string
     {
-        $contentRepository = $this->contentRepositoryRegistry->get(
-            $node->contentRepositoryId
-        );
-        $nodeAddressFactory = NodeAddressFactory::create($contentRepository);
-        return $nodeAddressFactory->createFromNode($node)->serializeForUri();
+        return NodeAddress::fromNode($node)->toJson();
     }
 
     public function subgraphForNode(Node $node): ContentSubgraphInterface

Neos.Neos/Classes/Service/Controller/DataSourceController.php

@@ -15,9 +15,14 @@
 namespace Neos\Neos\Service\Controller;
 
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
+use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
+use Neos\ContentRepository\Core\SharedModel\Node\NodeAddress;
+use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Mvc\View\JsonView;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Neos\FrontendRouting\NodeAddressFactory;
+use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionResult;
 use Neos\Utility\ObjectAccess;
 use Neos\Flow\Reflection\ReflectionService;
 use Neos\Neos\Exception as NeosException;
@@ -30,6 +35,9 @@
  */
 class DataSourceController extends AbstractServiceController
 {
+    #[Flow\Inject]
+    protected ContentRepositoryRegistry $contentRepositoryRegistry;
+
     /**
      * @var array<string,class-string>
      */
@@ -39,10 +47,9 @@ class DataSourceController extends AbstractServiceController
 
     /**
      * @param string $dataSourceIdentifier
-     * @param Node $node
      * @throws NeosException
      */
-    public function indexAction($dataSourceIdentifier, Node $node = null): void
+    public function indexAction($dataSourceIdentifier, string $node = null): void
     {
         $dataSources = static::getDataSources($this->objectManager);
 
@@ -63,11 +70,29 @@ public function indexAction($dataSourceIdentifier, Node $node = null): void
         unset($arguments['dataSourceIdentifier']);
         unset($arguments['node']);
 
-        $values = $dataSource->getData($node, $arguments);
+        $values = $dataSource->getData($this->deserializeNodeFromLegacyAddress($node), $arguments);
 
         $this->view->assign('value', $values);
     }
 
+    private function deserializeNodeFromLegacyAddress(?string $stringFormattedNodeAddress): ?Node
+    {
+        if (!$stringFormattedNodeAddress) {
+            return null;
+        }
+
+        $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())
+            ->contentRepositoryId;
+        $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId);
+        // todo legacy uri node address notation used. Should be refactored to use json encoded NodeAddress
+        $nodeAddress = NodeAddressFactory::create($contentRepository)->createCoreNodeAddressFromLegacyUriString($stringFormattedNodeAddress);
+
+        return $contentRepository->getContentGraph($nodeAddress->workspaceName)->getSubgraph(
+            $nodeAddress->dimensionSpacePoint,
+            VisibilityConstraints::withoutRestrictions()
+        )->findNodeById($nodeAddress->aggregateId);
+    }
+
     /**
      * Get available data source implementations
      *

Neos.Neos/Classes/Service/LinkingService.php

@@ -36,7 +36,6 @@
 use Neos\Neos\Domain\Model\Site;
 use Neos\Neos\Domain\Repository\SiteRepository;
 use Neos\Neos\Exception as NeosException;
-use Neos\Neos\FrontendRouting\NodeAddressFactory;
 use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionResult;
 use Neos\Utility\Arrays;
 use Psr\Http\Message\UriInterface;
@@ -309,15 +308,15 @@ public function createNodeUri(
                     $controllerContext->getRequest()->getHttpRequest()
                 )->contentRepositoryId;
                 $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId);
-                $nodeAddress = NodeAddressFactory::create($contentRepository)->createFromUriString($node);
+                $nodeAddress = NodeAddress::fromJsonString($nodeString);
                 $workspace = $contentRepository->getWorkspaceFinder()->findOneByName($nodeAddress->workspaceName);
                 $subgraph = $contentRepository->getContentGraph($nodeAddress->workspaceName)->getSubgraph(
                     $nodeAddress->dimensionSpacePoint,
                     $workspace && !$workspace->isPublicWorkspace()
                         ? VisibilityConstraints::withoutRestrictions()
                         : VisibilityConstraints::frontend()
                 );
-                $node = $subgraph->findNodeById($nodeAddress->nodeAggregateId);
+                $node = $subgraph->findNodeById($nodeAddress->aggregateId);
             } catch (\Throwable $exception) {
                 if ($baseNode === null) {
                     throw new NeosException(

Neos.Neos/Classes/TypeConverter/HackyNodeAddressToNodeConverter.php → Neos.Neos/Classes/TypeConverter/NodeAddressToNodeConverter.php

@@ -16,25 +16,16 @@
 
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
 use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
-use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
+use Neos\ContentRepository\Core\SharedModel\Node\NodeAddress;
 use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Flow\Annotations as Flow;
-use Neos\Flow\Core\Bootstrap;
-use Neos\Flow\Http\RequestHandler;
 use Neos\Flow\Property\PropertyMappingConfigurationInterface;
 use Neos\Flow\Property\TypeConverter\AbstractTypeConverter;
-use Neos\Neos\FrontendRouting\NodeAddressFactory;
-use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionResult;
 
 /**
- * To be removed legacy fragment for property mapping nodes in controllers.
- * MUST not be used and MUST be removed before Neos 9 release.
- * See issue: https://github.com/neos/neos-development-collection/issues/4873
- *
  * @Flow\Scope("singleton")
- * @deprecated must be removed before Neos 9 release!!!
  */
-class HackyNodeAddressToNodeConverter extends AbstractTypeConverter
+class NodeAddressToNodeConverter extends AbstractTypeConverter
 {
     /**
      * @var array<int,string>
@@ -53,8 +44,6 @@ class HackyNodeAddressToNodeConverter extends AbstractTypeConverter
 
     #[Flow\Inject]
     protected ContentRepositoryRegistry $contentRepositoryRegistry;
-    #[Flow\Inject]
-    protected Bootstrap $bootstrap;
 
     /**
      * @param string $source
@@ -68,26 +57,16 @@ public function convertFrom(
         array $subProperties = [],
         PropertyMappingConfigurationInterface $configuration = null
     ) {
-        $activeRequestHandler = $this->bootstrap->getActiveRequestHandler();
-        $contentRepositoryId = ContentRepositoryId::fromString('default');
-        if ($activeRequestHandler instanceof RequestHandler) {
-            $httpRequest = $activeRequestHandler->getHttpRequest();
-            $siteDetectionResult = SiteDetectionResult::fromRequest($httpRequest);
-            $contentRepositoryId = $siteDetectionResult->contentRepositoryId;
-        }
-
-        $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId);
-        $nodeAddressFactory = NodeAddressFactory::create($contentRepository);
-        $nodeAddress = $nodeAddressFactory->createFromUriString($source);
-
+        $nodeAddress = NodeAddress::fromJsonString($source);
+        $contentRepository = $this->contentRepositoryRegistry->get($nodeAddress->contentRepositoryId);
         $subgraph = $contentRepository->getContentGraph($nodeAddress->workspaceName)
             ->getSubgraph(
                 $nodeAddress->dimensionSpacePoint,
-                $nodeAddress->isInLiveWorkspace()
+                $nodeAddress->workspaceName->isLive()
                     ? VisibilityConstraints::frontend()
                     : VisibilityConstraints::withoutRestrictions()
             );
 
-        return $subgraph->findNodeById($nodeAddress->nodeAggregateId);
+        return $subgraph->findNodeById($nodeAddress->aggregateId);
     }
 }

Neos.Neos/Classes/TypeConverter/NodeToNodeAddressStringConverter.php

@@ -15,27 +15,19 @@
 namespace Neos\Neos\TypeConverter;
 
 use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
+use Neos\ContentRepository\Core\SharedModel\Node\NodeAddress;
 use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Property\PropertyMappingConfigurationInterface;
 use Neos\Flow\Property\TypeConverter\AbstractTypeConverter;
-use Neos\Neos\FrontendRouting\NodeAddressFactory;
 
 /**
- * To be removed legacy fragment for property mapping nodes in controllers.
- * MUST not be used and MUST be removed before Neos 9 release.
- * See issue: https://github.com/neos/neos-development-collection/issues/4873
- *
  * @Flow\Scope("singleton")
- * @deprecated must be removed before Neos 9 release!!!
  */
 class NodeToNodeAddressStringConverter extends AbstractTypeConverter
 {
-    /**
-     * @Flow\Inject
-     * @var ContentRepositoryRegistry
-     */
-    protected $contentRepositoryRegistry;
+    #[Flow\Inject]
+    protected ContentRepositoryRegistry $contentRepositoryRegistry;
 
     /**
      * @var array<int,string>
@@ -64,9 +56,6 @@ public function convertFrom(
         array $subProperties = [],
         PropertyMappingConfigurationInterface $configuration = null
     ) {
-        $contentRepository = $this->contentRepositoryRegistry->get(
-            $source->contentRepositoryId
-        );
-        return NodeAddressFactory::create($contentRepository)->createFromNode($source)->serializeForUri();
+        return NodeAddress::fromNode($source)->toJson();
     }
 }