Merge pull request PHP-DI#886 from bdsl/patch-1

Show circular list of depedencies on circular dependancy error message

Author: mnapoli

src/CompiledContainer.php

@@ -46,7 +46,8 @@ public function get(string $id) : mixed
  if ($method !== null) {
  // Check if we are already getting this entry -> circular dependency
  if (isset($this->entriesBeingResolved[$id])) {
- throw new DependencyException("Circular dependency detected while trying to resolve entry '$id'");
+ $idList = implode(" -> ", [...array_keys($this->entriesBeingResolved), $id]);
+ throw new DependencyException("Circular dependency detected while trying to resolve entry '$id': Dependencies: " . $idList);
  }
  $this->entriesBeingResolved[$id] = true;
 

src/Container.php

@@ -344,7 +344,8 @@ private function resolveDefinition(Definition $definition, array $parameters = [
 
  // Check if we are already getting this entry -> circular dependency
  if (isset($this->entriesBeingResolved[$entryName])) {
- throw new DependencyException("Circular dependency detected while trying to resolve entry '$entryName'");
+ $entryList = implode(" -> ", [...array_keys($this->entriesBeingResolved), $entryName]);
+ throw new DependencyException("Circular dependency detected while trying to resolve entry '$entryName': Dependencies: " . $entryList);
  }
  $this->entriesBeingResolved[$entryName] = true;
 

tests/IntegrationTest/CircularDependencyTest.php

@@ -52,7 +52,7 @@ public function circular_dependencies_throw_exceptions(ContainerBuilder $builder
  public function circular_dependencies_with_attributes_throw_exceptions(ContainerBuilder $builder)
  {
  $this->expectException(DependencyException::class);
- $this->expectExceptionMessage('Circular dependency detected while trying to resolve entry \'DI\Test\UnitTest\Fixtures\Class1CircularDependencies\'');
+ $this->expectExceptionMessage("Circular dependency detected while trying to resolve entry 'DI\Test\UnitTest\Fixtures\Class1CircularDependencies': Dependencies: DI\Test\UnitTest\Fixtures\Class1CircularDependencies -> DI\Test\UnitTest\Fixtures\Class2CircularDependencies -> DI\Test\UnitTest\Fixtures\Class1CircularDependencies");
  $builder->useAttributes(true);
  $builder->build()->get(Class1CircularDependencies::class);
  }
@@ -64,7 +64,7 @@ public function circular_dependencies_with_attributes_throw_exceptions(Container
  public function circular_dependencies_because_of_self_alias_throw_exceptions(ContainerBuilder $builder)
  {
  $this->expectException(DependencyException::class);
- $this->expectExceptionMessage('Circular dependency detected while trying to resolve entry \'foo\'');
+ $this->expectExceptionMessage("Circular dependency detected while trying to resolve entry 'foo': Dependencies: foo -> foo");
  $builder->addDefinitions([
  // Alias to itself -> infinite recursive loop
  'foo' => get('foo'),

tests/IntegrationTest/ContainerMakeTest.php

@@ -71,7 +71,7 @@ public function testCircularDependencies(ContainerBuilder $builder)
  public function testCircularDependencyException(ContainerBuilder $builder)
  {
  $this->expectException(DependencyException::class);
- $this->expectExceptionMessage('Circular dependency detected while trying to resolve entry \'DI\Test\UnitTest\Fixtures\Class1CircularDependencies\'');
+ $this->expectExceptionMessage('Circular dependency detected while trying to resolve entry \'DI\Test\UnitTest\Fixtures\Class1CircularDependencies\': Dependencies: DI\Test\UnitTest\Fixtures\Class1CircularDependencies -> DI\Test\UnitTest\Fixtures\Class2CircularDependencies -> DI\Test\UnitTest\Fixtures\Class1CircularDependencies');
  $builder->useAttributes(true);
  $container = $builder->build();
  $container->make(Class1CircularDependencies::class);
@@ -83,7 +83,7 @@ public function testCircularDependencyException(ContainerBuilder $builder)
  public function testCircularDependencyExceptionWithAlias(ContainerBuilder $builder)
  {
  $this->expectException(DependencyException::class);
- $this->expectExceptionMessage('Circular dependency detected while trying to resolve entry \'foo\'');
+ $this->expectExceptionMessage('Circular dependency detected while trying to resolve entry \'foo\': Dependencies: foo -> foo');
  $builder->addDefinitions([
  // Alias to itself -> infinite recursive loop
  'foo' => \DI\get('foo'),