fix: circular parent reference detection (#34)

sitepark · Sep 2, 2024 · ca6c4f7 · ca6c4f7
1 parent c40eb7f
commit ca6c4f7
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 2 deletions.
diff --git a/src/Loader/SiteKitResourceHierarchyLoader.php b/src/Loader/SiteKitResourceHierarchyLoader.php
@@ -44,8 +44,18 @@ public function cleanup(): void
     public function loadRoot(ResourceLocation $location): Resource
     {
         $resource = $this->resourceLoader->load($location);
+        $loaded = [$resource->location];
         while (!$this->isRoot($resource)) {
-            $resource = $this->loadPrimaryParentResource($resource);
+            $parent = $this->loadPrimaryParentResource($resource);
+            if (in_array($parent->location, $loaded, true)) {
+                $loaded[] = $parent->location;
+                throw new InvalidResourceException(
+                    $resource->toLocation(),
+                    'circular parent reference detected: ' . implode(' -> ', $loaded),
+                );
+            }
+            $resource = $parent;
+            $loaded[] = $resource->location;
         }
 
         return $resource;

diff --git a/test/Loader/SiteKitResourceHierarchyLoaderTest.php b/test/Loader/SiteKitResourceHierarchyLoaderTest.php
@@ -120,6 +120,22 @@ public function testLoadRoot(): void
         );
     }
 
+    public function testLoadRootWithSelfRecursion(): void
+    {
+        $this->expectException(InvalidResourceException::class);
+        $this->hierarchyLoader->loadRoot(
+            ResourceLocation::of('/withSelfRecursion.php'),
+        );
+    }
+
+    public function testLoadRootWithRecursion(): void
+    {
+        $this->expectException(InvalidResourceException::class);
+        $this->hierarchyLoader->loadRoot(
+            ResourceLocation::of('/withRecursionA.php'),
+        );
+    }
+
     public function testIsRoot(): void
     {
         $root = TestResourceFactory::create([]);

diff --git a/test/resources/Loader/SiteKitNavigationHierarchyLoader/withDefaultRoot/dir/b.php b/test/resources/Loader/SiteKitNavigationHierarchyLoader/withDefaultRoot/dir/b.php
@@ -5,7 +5,7 @@
 use Atoolo\Resource\Test\TestResourceFactory;
 
 return TestResourceFactory::create([
-    'url' => '/dir/a.php',
+    'url' => '/dir/b.php',
     'id' => 'a',
     'name' => 'a',
     'locale' => 'en_US',