Adding detecting circular dependecies

phpactor · Oct 7, 2024 · 9299a3b · 9299a3b
1 parent 406add6
commit 9299a3b
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/lib/PhpactorContainer.php b/lib/PhpactorContainer.php
@@ -30,6 +30,11 @@ class PhpactorContainer implements Container, ContainerBuilder
      */
     private $services = [];
 
+    /**
+     * @var array<string>
+     */
+    private array $servicesToResolve = [];
+
     /**
      * @param array<string,mixed> $parameters
      */
@@ -80,8 +85,19 @@ public function get($id)
             ));
         }
 
+        if (in_array($id, $this->servicesToResolve)) {
+            throw new RuntimeException(sprintf(
+                'Circular dependency detected: %s->%s',
+                implode('->', $this->servicesToResolve),
+                $id
+            ));
+        }
+        $this->servicesToResolve[] = $id;
+
         $this->services[$id] = $this->factories[$id]($this);
 
+        $this->servicesToResolve = [];
+
         return $this->services[$id];
     }
 

diff --git a/tests/Unit/PhpactorContainerTest.php b/tests/Unit/PhpactorContainerTest.php
@@ -62,6 +62,18 @@ public function testThrowsExceptionForUnknownService(): void
         $this->container->get('foobar');
     }
 
+    public function testThrowsExceptionForCircularDependency(): void
+    {
+        $this->container->register('foobar', function (Container $container) {
+            $container->get('foobar');
+        });
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Circular dependency detected: foobar->foobar');
+
+        $this->container->get('foobar');
+    }
+
     public function testRetrievesService(): void
     {
         $this->container->register('foobar', function (Container $container) {