feat(core): add support for partial graphs

integration/inspector/e2e/fixtures/post-init-graph.json

@@ -3166,5 +3166,6 @@
         "nodeId": "-2007711503"
       }
     ]
-  }
+  },
+  "status": "complete"
 }

integration/inspector/e2e/fixtures/pre-init-graph.json

@@ -2624,5 +2624,6 @@
         "nodeId": "-2007711503"
       }
     ]
-  }
+  },
+  "status": "complete"
 }

packages/core/errors/exceptions/unknown-dependencies.exception.ts

@@ -1,14 +1,15 @@
 import { InjectorDependencyContext } from '../../injector/injector';
+import { Module } from '../../injector/module';
 import { UNKNOWN_DEPENDENCIES_MESSAGE } from '../messages';
 import { RuntimeException } from './runtime.exception';
-import { Module } from '../../injector/module';
 
 export class UnknownDependenciesException extends RuntimeException {
   constructor(
-    type: string | symbol,
-    unknownDependencyContext: InjectorDependencyContext,
-    module?: Module,
+    public readonly type: string | symbol,
+    public readonly context: InjectorDependencyContext,
+    public readonly moduleRef?: Module,
+    public readonly metadata?: { id: string },
   ) {
-    super(UNKNOWN_DEPENDENCIES_MESSAGE(type, unknownDependencyContext, module));
+    super(UNKNOWN_DEPENDENCIES_MESSAGE(type, context, moduleRef));
   }
 }

packages/core/injector/injector.ts

@@ -507,6 +507,7 @@ export class Injector {
         wrapper.name,
         dependencyContext,
         moduleRef,
+        { id: wrapper.id },
       );
     }
     if (providers.has(name)) {
@@ -547,6 +548,7 @@ export class Injector {
         wrapper.name,
         dependencyContext,
         moduleRef,
+        { id: wrapper.id },
       );
     }
     return instanceWrapper;

packages/core/injector/instance-loader.ts

@@ -27,8 +27,13 @@ export class InstanceLoader<TInjector extends Injector = Injector> {
   ) {
     this.createPrototypes(modules);
 
-    await this.createInstances(modules);
-
+    try {
+      await this.createInstances(modules);
+    } catch (err) {
+      this.graphInspector.inspectModules(modules);
+      this.graphInspector.registerPartial(err);
+      throw err;
+    }
     this.graphInspector.inspectModules(modules);
   }
 

packages/core/inspector/graph-inspector.ts

@@ -1,3 +1,4 @@
+import { UnknownDependenciesException } from '../errors/exceptions/unknown-dependencies.exception';
 import { NestContainer } from '../injector/container';
 import { InstanceWrapper } from '../injector/instance-wrapper';
 import { Module } from '../injector/module';
@@ -6,6 +7,7 @@ import { EnhancerMetadataCacheEntry } from './interfaces/enhancer-metadata-cache
 import { Entrypoint } from './interfaces/entrypoint.interface';
 import { OrphanedEnhancerDefinition } from './interfaces/extras.interface';
 import { ClassNode, Node } from './interfaces/node.interface';
+import { PartialGraphHost } from './partial-graph.host';
 import { SerializedGraph } from './serialized-graph';
 
 export class GraphInspector {
@@ -33,6 +35,29 @@ export class GraphInspector {
     DeterministicUuidRegistry.clear();
   }
 
+  public registerPartial(error: unknown) {
+    this.graph.status = 'partial';
+
+    if (error instanceof UnknownDependenciesException) {
+      this.graph.metadata = {
+        cause: {
+          type: 'unknown-dependencies',
+          context: error.context,
+          moduleId: error.moduleRef?.id,
+          nodeId: error.metadata?.id,
+        },
+      };
+    } else {
+      this.graph.metadata = {
+        cause: {
+          type: 'unknown',
+          error,
+        },
+      };
+    }
+    PartialGraphHost.register(this.graph);
+  }
+
   public inspectInstanceWrapper<T = any>(
     source: InstanceWrapper<T>,
     moduleRef: Module,

packages/core/inspector/index.ts

@@ -1,2 +1,4 @@
 export * from './graph-inspector';
 export * from './initialize-on-preview.allowlist';
+export * from './partial-graph.host';
+export * from './serialized-graph';

packages/core/inspector/interfaces/serialized-graph-json.interface.ts

@@ -0,0 +1,15 @@
+import { SerializedGraphStatus } from '../serialized-graph';
+import { Edge } from './edge.interface';
+import { Entrypoint } from './entrypoint.interface';
+import { Extras } from './extras.interface';
+import { Node } from './node.interface';
+import { SerializedGraphMetadata } from './serialized-graph-metadata.interface';
+
+export interface SerializedGraphJson {
+  nodes: Record<string, Node>;
+  edges: Record<string, Edge>;
+  entrypoints: Record<string, Entrypoint<unknown>[]>;
+  extras: Extras;
+  status?: SerializedGraphStatus;
+  metadata?: SerializedGraphMetadata;
+}

packages/core/inspector/interfaces/serialized-graph-metadata.interface.ts

@@ -0,0 +1,11 @@
+import { InjectorDependencyContext } from '../../injector/injector';
+
+export interface SerializedGraphMetadata {
+  cause: {
+    type: 'unknown-dependencies' | 'unknown';
+    context?: InjectorDependencyContext;
+    moduleId?: string;
+    nodeId?: string;
+    error?: any;
+  };
+}

packages/core/inspector/partial-graph.host.ts

@@ -0,0 +1,17 @@
+import { SerializedGraph } from './serialized-graph';
+
+export class PartialGraphHost {
+  private static partialGraph: SerializedGraph;
+
+  static toJSON() {
+    return this.partialGraph?.toJSON();
+  }
+
+  static toString() {
+    return this.partialGraph?.toString();
+  }
+
+  static register(partialGraph: SerializedGraph) {
+    this.partialGraph = partialGraph;
+  }
+}

packages/core/inspector/serialized-graph.ts

@@ -16,7 +16,10 @@ import {
   OrphanedEnhancerDefinition,
 } from './interfaces/extras.interface';
 import { Node } from './interfaces/node.interface';
+import { SerializedGraphJson } from './interfaces/serialized-graph-json.interface';
+import { SerializedGraphMetadata } from './interfaces/serialized-graph-metadata.interface';
 
+export type SerializedGraphStatus = 'partial' | 'complete';
 type WithOptionalId<T extends Record<'id', string>> = Omit<T, 'id'> &
   Partial<Pick<T, 'id'>>;
 
@@ -28,6 +31,8 @@ export class SerializedGraph {
     orphanedEnhancers: [],
     attachedEnhancers: [],
   };
+  private _status: SerializedGraphStatus = 'complete';
+  private _metadata?: SerializedGraphMetadata;
 
   private static readonly INTERNAL_PROVIDERS: Array<InjectionToken> = [
     ApplicationConfig,
@@ -44,6 +49,14 @@ export class SerializedGraph {
     INQUIRER,
   ];
 
+  set status(status: SerializedGraphStatus) {
+    this._status = status;
+  }
+
+  set metadata(metadata: SerializedGraphMetadata) {
+    this._metadata = metadata;
+  }
+
   public insertNode(nodeDefinition: Node) {
     if (
       nodeDefinition.metadata.type === 'provider' &&
@@ -109,13 +122,21 @@ export class SerializedGraph {
     return this.nodes.get(id);
   }
 
-  public toJSON() {
-    return {
+  public toJSON(): SerializedGraphJson {
+    const json: SerializedGraphJson = {
       nodes: Object.fromEntries(this.nodes),
       edges: Object.fromEntries(this.edges),
       entrypoints: Object.fromEntries(this.entrypoints),
       extras: this.extras,
     };
+
+    if (this._status) {
+      json['status'] = this._status;
+    }
+    if (this._metadata) {
+      json['metadata'] = this._metadata;
+    }
+    return json;
   }
 
   public toString() {