feat(context): reports the resolution path for circular deps

loopbackio · Feb 6, 2018 · bc4ce20 · bc4ce20
1 parent 8fae758
commit bc4ce20
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 10 deletions.
diff --git a/packages/context/src/resolution-session.ts b/packages/context/src/resolution-session.ts
@@ -228,11 +228,11 @@ export class ResolutionSession {
       debugSession('Enter binding:', binding.toJSON());
     }
     if (this.stack.find(i => i.type === 'binding' && i.value === binding)) {
-      throw new Error(
-        `Circular dependency detected on path '${this.getBindingPath()} --> ${
-          binding.key
-        }'`,
-      );
+      const msg =
+        `Circular dependency detected: ` +
+        `${this.getResolutionPath()} --> ${binding.key}`;
+      debugSession(msg);
+      throw new Error(msg);
     }
     this.stack.push({type: 'binding', value: binding});
     /* istanbul ignore if */

diff --git a/packages/context/test/unit/resolver.test.ts b/packages/context/test/unit/resolver.test.ts
@@ -107,10 +107,12 @@ describe('constructor injection', () => {
     context.bind('x').toClass(XClass);
     context.bind('y').toClass(YClass);
     expect(() => context.getSync('x')).to.throw(
-      "Circular dependency detected on path 'x --> y --> x'",
+      'Circular dependency detected: x --> @XClass.prototype.y ' +
+        '--> y --> @YClass.prototype.x --> x',
     );
     expect(() => context.getSync('y')).to.throw(
-      "Circular dependency detected on path 'y --> x --> y'",
+      'Circular dependency detected: y --> @YClass.prototype.x ' +
+        '--> x --> @XClass.prototype.y --> y',
     );
   });
 
@@ -138,13 +140,16 @@ describe('constructor injection', () => {
     context.bind('y').toClass(YClass);
     context.bind('z').toClass(ZClass);
     expect(() => context.getSync('x')).to.throw(
-      "Circular dependency detected on path 'x --> y --> z --> x'",
+      'Circular dependency detected: x --> @XClass.constructor[0] --> y ' +
+        '--> @YClass.constructor[0] --> z --> @ZClass.constructor[0] --> x',
     );
     expect(() => context.getSync('y')).to.throw(
-      "Circular dependency detected on path 'y --> z --> x --> y'",
+      'Circular dependency detected: y --> @YClass.constructor[0] --> z ' +
+        '--> @ZClass.constructor[0] --> x --> @XClass.constructor[0] --> y',
     );
     expect(() => context.getSync('z')).to.throw(
-      "Circular dependency detected on path 'z --> x --> y --> z'",
+      'Circular dependency detected: z --> @ZClass.constructor[0] --> x ' +
+        '--> @XClass.constructor[0] --> y --> @YClass.constructor[0] --> z',
     );
   });