Fix serialization and improve static analysis results

nezaniel · Aug 3, 2022 · 8149d14 · 8149d14
1 parent 9cf1ad8
commit 8149d14
Show file tree

Hide file tree

Showing 20 changed files with 9,304 additions and 178 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 /.ddev/
 /.idea/
+/Packages/
+/vendor/
diff --git a/Classes/Application/CacheTag.php b/Classes/Application/CacheTag.php
@@ -8,8 +8,8 @@
 
 namespace Nezaniel\ComponentView\Application;
 
+use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\NodeType\NodeTypeName;
-use Neos\ContentRepository\Domain\Projection\Content\NodeInterface;
 use Neos\Flow\Annotations as Flow;
 
 /**

diff --git a/Classes/Application/ContentRenderer.php b/Classes/Application/ContentRenderer.php
@@ -77,7 +77,7 @@ private function resolveCacheSegmentForContentCollection(
                 CacheTag::forNode($contentCollection, $workspaceName)
             );
             $content = new ComponentCollection(... array_map(
-                function (Node $childNode) use($subgraph, $inBackend, &$cacheTags): ComponentInterface {
+                function (Node $childNode) use ($subgraph, $inBackend, &$cacheTags): ComponentInterface {
                     return $this->delegate($childNode, $subgraph, $inBackend, $cacheTags);
                 },
                 $contentCollection->findChildNodes()->toArray()

diff --git a/Classes/Domain/ComponentCollection.php b/Classes/Domain/ComponentCollection.php
@@ -40,16 +40,4 @@ public function __toString(): string
     {
         return $this->render();
     }
-
-    /**
-     * @return array<int|QualifiedComponentSerialization>
-     */
-    public function jsonSerialize(): array
-    {
-        return array_map(
-            fn (ComponentInterface|string $component): QualifiedComponentSerialization
-                => QualifiedComponentSerialization::create($component),
-            $this->components
-        );
-    }
 }
diff --git a/Classes/Domain/ComponentInterface.php b/Classes/Domain/ComponentInterface.php
@@ -11,14 +11,7 @@
 /**
  * The interface for self-rendering components
  */
-interface ComponentInterface extends \Stringable, \JsonSerializable
+interface ComponentInterface extends \Stringable
 {
     public function render(): string;
-
-    /**
-     * Serializes the component to cache
-     *
-     * @return array<string,string|ComponentInterface|null>
-     */
-    public function jsonSerialize(): array;
 }
diff --git a/Classes/Domain/NodeMetadataFactory.php b/Classes/Domain/NodeMetadataFactory.php
@@ -26,6 +26,9 @@ final class NodeMetadataFactory extends ContentElementWrappingService
     #[Flow\Inject]
     protected UriService $uriService;
 
+    /**
+     * @return array<string,mixed>
+     */
     public function getAugmenterAttributesForContentNode(NodeInterface $contentNode, ?string $locator = null): ?array
     {
         if (!$this->needsMetadata($contentNode, false)) {
@@ -50,9 +53,12 @@ public function getScriptForContentNode(NodeInterface $contentNode): string
             $this->uriService->getControllerContext()
         ));
 
-        return "<script data-neos-nodedata>(function(){(this['@Neos.Neos.Ui:Nodes'] = this['@Neos.Neos.Ui:Nodes'] || {})['".  $contentNode->getContextPath() . "'] = {$metadata}})()</script>";
+        return "<script data-neos-nodedata>(function(){(this['@Neos.Neos.Ui:Nodes'] = this['@Neos.Neos.Ui:Nodes'] || {})['" .  $contentNode->getContextPath() . "'] = {$metadata}})()</script>";
     }
 
+    /**
+     * @return array<string,mixed>
+     */
     public function forDocumentNode(NodeInterface $documentNode, ?string $locator = null): ?array
     {
         if (!$this->needsMetadata($documentNode, true)) {

diff --git a/Classes/Domain/NodeMetadataWrapper.php b/Classes/Domain/NodeMetadataWrapper.php
@@ -15,7 +15,7 @@
  * A component for wrapping node metadata around a component
  */
 #[Flow\Proxy(false)]
-final class NodeMetadataWrapper implements ComponentInterface, ComponentContainerInterface
+final class NodeMetadataWrapper implements ComponentInterface
 {
     /**
      * @param array<string,mixed> $attributes
@@ -43,14 +43,6 @@ public function render(): string
         return $result;
     }
 
-    public function jsonSerialize(): array
-    {
-        return [
-            'attributes' => $this->attributes,
-            'content' => QualifiedComponentSerialization::create($this->content)
-        ];
-    }
-
     public function isEmpty(): bool
     {
         return $this->content instanceof ComponentContainerInterface

diff --git a/Classes/Domain/QualifiedComponentSerialization.php b/Classes/Domain/QualifiedComponentSerialization.php
diff --git a/Classes/Domain/UriService.php b/Classes/Domain/UriService.php
@@ -0,0 +1,105 @@
+<?php
+
+/*
+ * This file is part of the Nezaniel.ComponentView package
+ * and taken over from PackageFactory.AtomicFusion.PresentationObjects.
+ * @see https://github.com/PackageFactory/atomic-fusion-presentationobjects
+ */
+
+declare(strict_types=1);
+
+namespace PackageFactory\AtomicFusion\PresentationObjects\Infrastructure;
+
+use GuzzleHttp\Psr7\ServerRequest;
+use GuzzleHttp\Psr7\Uri;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\ContentRepository\Domain\Service\Context as ContentContext;
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Mvc\Controller\ControllerContext;
+use Neos\Flow\ResourceManagement\ResourceManager;
+use Neos\Flow\Http;
+use Neos\Media\Domain\Model\AssetInterface;
+use Neos\Media\Domain\Repository\AssetRepository;
+use Neos\Neos\Service\LinkingService;
+use Neos\Flow\Mvc;
+use Neos\Flow\Core\Bootstrap;
+
+/**
+ * The URI service
+ */
+final class UriService
+{
+    #[Flow\Inject]
+    protected ResourceManager $resourceManager;
+
+    #[Flow\Inject]
+    protected LinkingService $linkingService;
+
+    #[Flow\Inject]
+    protected AssetRepository $assetRepository;
+
+    #[Flow\Inject]
+    protected Bootstrap $bootstrap;
+
+    protected ?ControllerContext $controllerContext = null;
+
+    public function getNodeUri(NodeInterface $documentNode, bool $absolute = false, ?string $format = null): Uri
+    {
+        return new Uri($this->linkingService->createNodeUri($this->getControllerContext(), $documentNode, null, $format, $absolute));
+    }
+
+    public function getResourceUri(string $packageKey, string $resourcePath): Uri
+    {
+        return new Uri($this->resourceManager->getPublicPackageResourceUri($packageKey, $resourcePath));
+    }
+
+    public function getAssetUri(AssetInterface $asset): Uri
+    {
+        $uri = $this->resourceManager->getPublicPersistentResourceUri($asset->getResource());
+
+        return new Uri(is_string($uri) ? $uri : '#');
+    }
+
+    public function getControllerContext(): ControllerContext
+    {
+        if (is_null($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;
+    }
+
+    public function resolveLinkUri(string $rawLinkUri, ContentContext $subgraph): Uri
+    {
+        if (\mb_substr($rawLinkUri, 0, 7) === 'node://') {
+            $nodeIdentifier = \mb_substr($rawLinkUri, 7);
+            $node = $subgraph->getNodeByIdentifier($nodeIdentifier);
+            $linkUri = $node ? $this->getNodeUri($node) : new Uri('#');
+        } elseif (\mb_substr($rawLinkUri, 0, 8) === 'asset://') {
+            $assetIdentifier = \mb_substr($rawLinkUri, 8);
+            /** @var ?AssetInterface $asset */
+            $asset = $this->assetRepository->findByIdentifier($assetIdentifier);
+            $linkUri = $asset ? $this->getAssetUri($asset) : new Uri('#');
+        } elseif (\str_starts_with($rawLinkUri, 'https://') || \str_starts_with($rawLinkUri, 'http://')) {
+            $linkUri = new Uri($rawLinkUri);
+        } else {
+            $linkUri = new Uri('#');
+        }
+
+        return $linkUri;
+    }
+}
diff --git a/Classes/Infrastructure/ComponentCacheFlusher.php b/Classes/Infrastructure/ComponentCacheFlusher.php
@@ -46,8 +46,8 @@ class ComponentCacheFlusher
      */
     private array $workspaceGraph;
 
-    public function __construct(
-    ) {
+    public function __construct()
+    {
         $this->cacheTagsToFlush = new CacheTags();
         $this->workspaceGraph = [];
     }
@@ -107,6 +107,7 @@ public function whenSiteWasImported(): void
     private function handleAssetChange(AssetInterface $asset): void
     {
         $cacheTagsToFlush = [CacheTag::forEverything(null)];
+        /** @var string $assetIdentifier */
         $assetIdentifier = $this->persistenceManager->getIdentifierByObject($asset);
         $cacheTagsToFlush[] = CacheTag::forAsset($assetIdentifier, null);
         foreach ($this->workspaceRepository->findAll() as $workspace) {

diff --git a/Classes/Infrastructure/ComponentSerializer.php b/Classes/Infrastructure/ComponentSerializer.php
@@ -57,7 +57,7 @@ public static function serializeComponent(ComponentInterface $component): array
                     ];
                 } else {
                     $serializedPropertyValue = [
-                        '__type' => gettype($propertyValue),
+                        '__type' => get_debug_type($propertyValue),
                         'value' => $propertyValue
                     ];
                 }
@@ -76,12 +76,15 @@ private static function serializeComponentCollection(
         ComponentCollection $componentCollection,
         \ReflectionClass $reflectionClass
     ): array {
+        /** @var array<int,string|ComponentInterface> $components */
+        $components = $reflectionClass->getProperties()[0]->getValue($componentCollection);
+
         return [
             '__class' => get_class($componentCollection),
             'components' => array_map(
                 fn (ComponentInterface|string $childComponent): array|string
                     => is_string($childComponent) ? $childComponent : self::serializeComponent($childComponent),
-                $reflectionClass->getProperties()[0]->getValue($componentCollection)
+                $components
             )
         ];
     }
@@ -93,11 +96,14 @@ private static function serializeCollectionType(
         ComponentInterface $componentCollection,
         \ReflectionClass $reflectionClass
     ): array {
+        /** @var array<int,ComponentInterface> $components */
+        $components = $reflectionClass->getProperties()[0]->getValue($componentCollection);
+
         return [
             '__class' => get_class($componentCollection),
             $reflectionClass->getProperties()[0]->getName() => array_map(
                 fn(ComponentInterface $childComponent): array => self::serializeComponent($childComponent),
-                $reflectionClass->getProperties()[0]->getValue($componentCollection)
+                $components
             )
         ];
     }