Initialize UriService::controllerContext from view if possible

Author: Bernhard Schmitt

Classes/Aspect/UriServiceInitializationAspect.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package.
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\AtomicFusion\PresentationObjects\Aspect;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Aop\JoinPointInterface;
+use Neos\Flow\Mvc\Controller\ControllerContext;
+use PackageFactory\AtomicFusion\PresentationObjects\Infrastructure\UriService;
+
+#[Flow\Aspect]
+#[Flow\Scope('singleton')]
+final class UriServiceInitializationAspect
+{
+    #[Flow\Inject]
+    protected UriService $uriService;
+
+    #[Flow\Before('method(Neos\Flow\Mvc\View\AbstractView->setControllerContext())')]
+    public function relayControllerContext(JoinPointInterface $joinPoint): void
+    {
+        /** @var ControllerContext $controllerContext */
+        $controllerContext = $joinPoint->getMethodArgument('controllerContext');
+        $this->uriService->useControllerContext($controllerContext);
+    }
+}

Classes/Fusion/UriServiceInterface.php

@@ -23,6 +23,8 @@ public function getNodeUri(
         ?string $format = null
     ): UriInterface;
 
+    public function useControllerContext(ControllerContext $controllerContext): void;
+
     public function getResourceUri(string $packageKey, string $resourcePath): UriInterface;
 
     public function getPersistentResourceUri(PersistentResource $resource): ?UriInterface;

Classes/Infrastructure/UriService.php

@@ -33,31 +33,21 @@
  * The URI service
  */
 #[Flow\Scope('singleton')]
-final readonly class UriService implements UriServiceInterface
+final class UriService implements UriServiceInterface
 {
-    public ControllerContext $controllerContext;
+    private ?ControllerContext $controllerContext = null;
 
     public function __construct(
-        private ContentRepositoryRegistry $contentRepositoryRegistry,
-        private ResourceManager $resourceManager,
-        private AssetRepository $assetRepository,
-        Bootstrap $bootstrap
+        private readonly ContentRepositoryRegistry $contentRepositoryRegistry,
+        private readonly ResourceManager $resourceManager,
+        private readonly AssetRepository $assetRepository,
+        private readonly Bootstrap $bootstrap
     ) {
-        $requestHandler = $bootstrap->getActiveRequestHandler();
-        if ($requestHandler instanceof Http\RequestHandler) {
-            $request = $requestHandler->getHttpRequest();
-        } else {
-            $request = ServerRequest::fromGlobals();
-        }
-        $actionRequest = Mvc\ActionRequest::fromHttpRequest($request);
-        $uriBuilder = new Mvc\Routing\UriBuilder();
-        $uriBuilder->setRequest($actionRequest);
-        $this->controllerContext = new Mvc\Controller\ControllerContext(
-            $actionRequest,
-            new Mvc\ActionResponse(),
-            new Mvc\Controller\Arguments(),
-            $uriBuilder
-        );
+    }
+
+    public function useControllerContext(ControllerContext $controllerContext): void
+    {
+        $this->controllerContext = $controllerContext;
     }
 
     public function getNodeUri(Node $documentNode, bool $absolute = false, ?string $format = null): UriInterface
@@ -67,13 +57,15 @@ public function getNodeUri(Node $documentNode, bool $absolute = false, ?string $
         );
         $nodeAddressFactory = NodeAddressFactory::create($contentRepository);
         $nodeAddress = $nodeAddressFactory->createFromNode($documentNode);
+
         $uriBuilder = new UriBuilder();
-        $uriBuilder->setRequest($this->controllerContext->getRequest());
+        $uriBuilder->setRequest($this->getControllerContext()->getRequest());
         $uriBuilder
             ->setCreateAbsoluteUri($absolute)
             ->setFormat($format ?: 'html');
 
-        return NodeUriBuilder::fromUriBuilder($uriBuilder)->uriFor($nodeAddress);
+        return NodeUriBuilder::fromUriBuilder($uriBuilder)
+            ->uriFor($nodeAddress);
     }
 
     public function getResourceUri(string $packageKey, string $resourcePath): UriInterface
@@ -99,7 +91,7 @@ public function getAssetUri(AssetInterface $asset): UriInterface
 
     public function getDummyImageBaseUri(): UriInterface
     {
-        $uriBuilder = $this->controllerContext->getUriBuilder();
+        $uriBuilder = $this->getControllerContext()->getUriBuilder();
 
         return new Uri($uriBuilder->uriFor(
             'image',
@@ -111,6 +103,23 @@ public function getDummyImageBaseUri(): UriInterface
 
     public function getControllerContext(): ControllerContext
     {
+        if (!$this->controllerContext) {
+            $requestHandler = $this->bootstrap->getActiveRequestHandler();
+            if ($requestHandler instanceof Http\RequestHandler) {
+                $request = $requestHandler->getHttpRequest();
+            } else {
+                $request = ServerRequest::fromGlobals();
+            }
+            $actionRequest = Mvc\ActionRequest::fromHttpRequest($request);
+            $uriBuilder = new Mvc\Routing\UriBuilder();
+            $uriBuilder->setRequest($actionRequest);
+            $this->controllerContext = new Mvc\Controller\ControllerContext(
+                $actionRequest,
+                new Mvc\ActionResponse(),
+                new Mvc\Controller\Arguments(),
+                $uriBuilder
+            );
+        }
         return $this->controllerContext;
     }
 

Tests/Unit/Infrastructure/UriServiceTest.php

@@ -146,10 +146,10 @@ public function testProvidesADummyImageUri(): void
     public function testProvidesAControllerContext(): void
     {
         $this->markTestSkipped('Cannot mock the content repository registry yet');
-        $controllerContext = $this->uriService->controllerContext;
+        $controllerContext = $this->uriService->getControllerContext();
 
         $this->assertTrue($controllerContext instanceof ControllerContext);
-        $this->assertSame($controllerContext, $this->uriService->controllerContext);
+        $this->assertSame($controllerContext, $this->uriService->getControllerContext());
     }
 
     public function testResolvesLinkUrisWithNodeProtocolToHashIfNodeCannotBeFound(): void