Merge pull request #52 from proto-kit/feature/tiered-di

Tiered DI

framework.iml

@@ -2,7 +2,9 @@
 <module type="WEB_MODULE" version="4">
   <component name="NewModuleRootManager" inherit-compiler-output="true">
     <exclude-output />
-    <content url="file://$MODULE_DIR$" />
+    <content url="file://$MODULE_DIR$">
+      <excludePattern pattern="dist" />
+    </content>
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
 </module>

packages/common/src/config/ChildContainerCreatable.ts

@@ -0,0 +1,5 @@
+import { ChildContainerProvider } from "./ChildContainerProvider";
+
+export interface ChildContainerCreatable {
+  create: (childContainerProvider: ChildContainerProvider) => void;
+}

packages/common/src/config/ChildContainerProvider.ts

@@ -0,0 +1,5 @@
+import { DependencyContainer } from "tsyringe";
+
+export interface ChildContainerProvider {
+  (): DependencyContainer;
+}

packages/common/src/config/ConfigurableModule.ts

@@ -1,3 +1,8 @@
+import { noop } from "../utils";
+
+import { ChildContainerProvider } from "./ChildContainerProvider";
+import type { BaseModuleInstanceType } from "./ModuleContainer";
+
 const errors = {
   configNotSet: (moduleName: string) =>
     new Error(
@@ -17,7 +22,9 @@ export interface Configurable<Config> {
 /**
  * Used by various module sub-types that may need to be configured
  */
-export class ConfigurableModule<Config> implements Configurable<Config> {
+export class ConfigurableModule<Config>
+  implements BaseModuleInstanceType
+{
   /**
    * Store the config separately, so that we can apply additional
    * checks when retrieving it via the getter
@@ -36,6 +43,11 @@ export class ConfigurableModule<Config> implements Configurable<Config> {
   public set config(config: Config) {
     this.currentConfig = config;
   }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public create(childContainerProvider: ChildContainerProvider): void {
+    noop();
+  }
 }
 
 // Helps ensure that the target class implements static presets

packages/common/src/config/ModuleContainer.ts

@@ -1,12 +1,20 @@
+/* eslint-disable max-lines */
 import "reflect-metadata";
 
-import { container, Frequency, InjectionToken, Lifecycle } from "tsyringe";
+import {
+  DependencyContainer,
+  Frequency,
+  InjectionToken,
+  Lifecycle,
+} from "tsyringe";
 import log from "loglevel";
 
 import { StringKeyOf, TypedClass } from "../types";
 import { DependencyFactory } from "../dependencyFactory/DependencyFactory";
 
 import { Configurable, ConfigurableModule } from "./ConfigurableModule";
+import { ChildContainerProvider } from "./ChildContainerProvider";
+import { ChildContainerCreatable } from "./ChildContainerCreatable";
 
 const errors = {
   configNotSetInContainer: (moduleName: string) =>
@@ -35,12 +43,26 @@ const errors = {
       attempting to inject a dependency that is not registered 
       as a runtime module for this chain: ${name}`
     ),
+
+  dependencyContainerNotSet: (className: string) =>
+    new Error(
+      `DependencyContainer not set. Be sure to only call DI-related function in create() and not inside the constructor. (${className})`
+    ),
+
+  validModuleInstance: (moduleName: string, moduleTypeName: string) =>
+    new Error(
+      `Incompatible module instance ("${moduleName}" not instanceof ${moduleTypeName})`
+    ),
 };
 
 export const ModuleContainerErrors = errors;
 
+export interface BaseModuleInstanceType
+  extends ChildContainerCreatable,
+    Configurable<unknown> {}
+
 // determines that a module should be configurable by default
-export type BaseModuleType = TypedClass<Configurable<unknown>>;
+export type BaseModuleType = TypedClass<BaseModuleInstanceType>;
 
 // allows to specify what kind of modules can be passed into a container
 export interface ModulesRecord<
@@ -83,12 +105,10 @@ export class ModuleContainer<
   private static readonly moduleDecorationFrequency: Frequency = "Once";
 
   // DI container holding all the registered modules
-  protected readonly container = container.createChildContainer();
+  private providedContainer?: DependencyContainer = undefined;
 
   public constructor(public definition: ModuleContainerDefinition<Modules>) {
     super();
-    // register all provided modules when the container is created
-    this.registerModules(definition.modules);
   }
 
   /**
@@ -127,6 +147,11 @@ export class ModuleContainer<
     });
   }
 
+  protected get container(): DependencyContainer {
+    this.assertContainerInitialized(this.providedContainer);
+    return this.providedContainer;
+  }
+
   /**
    * Assert that the iterated `moduleName` is of ModuleName type,
    * otherwise it may be just string e.g. when modules are iterated over
@@ -148,6 +173,14 @@ export class ModuleContainer<
     }
   }
 
+  public assertContainerInitialized(
+    container: DependencyContainer | undefined
+  ): asserts container is DependencyContainer {
+    if (container === undefined) {
+      throw errors.dependencyContainerNotSet(this.constructor.name);
+    }
+  }
+
   /**
    * Register modules into the current container, and registers
    * a respective resolution hook in order to decorate the module
@@ -162,9 +195,11 @@ export class ModuleContainer<
 
         log.debug(`Registering module: ${moduleName}`);
 
+        const definitionEntry = modules[moduleName];
+
         this.container.register(
           moduleName,
-          { useClass: modules[moduleName] },
+          { useClass: definitionEntry },
           { lifecycle: Lifecycle.ContainerScoped }
         );
         this.onAfterModuleResolution(moduleName);
@@ -196,6 +231,16 @@ export class ModuleContainer<
     });
   }
 
+  protected registerClasses(modules: Record<string, TypedClass<unknown>>) {
+    Object.entries(modules).forEach(([moduleName, useClass]) => {
+      this.container.register(
+        moduleName,
+        { useClass },
+        { lifecycle: Lifecycle.ContainerScoped }
+      );
+    });
+  }
+
   /**
    * Provide additional configuration after the ModuleContainer was created.
    *
@@ -234,7 +279,7 @@ export class ModuleContainer<
     const isValidModuleInstance = instance instanceof moduleType;
 
     if (!isValidModuleInstance) {
-      throw new Error("Incompatible module instance");
+      throw errors.validModuleInstance(moduleName, moduleType.name);
     }
 
     return instance;
@@ -271,8 +316,30 @@ export class ModuleContainer<
           throw errors.unableToDecorateModule(containedModuleName);
         }
         this.decorateModule(moduleName, containedModule);
+
+        containedModule.create(() => {
+          const container = this.container.createChildContainer();
+          container.reset();
+          return container;
+        });
       },
       { frequency: ModuleContainer.moduleDecorationFrequency }
     );
   }
+
+  /**
+   * This is a placeholder for individual modules to override.
+   * This method will be called whenever the underlying container fully
+   * initialized
+   */
+  public create(childContainerProvider: ChildContainerProvider): void {
+    this.providedContainer = childContainerProvider();
+
+    // register all provided modules when the container is created
+    this.registerModules(this.definition.modules);
+
+    this.registerValue({
+      ChildContainerProvider: () => this.container.createChildContainer(),
+    });
+  }
 }

packages/common/src/dependencyFactory/DependencyFactory.ts

@@ -1,6 +1,7 @@
 import { DependencyContainer, injectable, Lifecycle } from "tsyringe";
 
 import { TypedClass } from "../types";
+import { log } from "../log";
 
 const errors = {
   descriptorUndefined: () =>
@@ -56,6 +57,10 @@ export abstract class DependencyFactory {
         },
         { lifecycle: Lifecycle.ContainerScoped }
       );
+
+      log.debug(
+        `Registered dependency ${upperCaseKey} from factory ${this.constructor.name}`
+      );
     }
   }
 }

packages/common/src/index.ts

@@ -1,5 +1,7 @@
 export * from "./config/ModuleContainer";
 export * from "./config/ConfigurableModule";
+export * from "./config/ChildContainerProvider";
+export * from "./config/ChildContainerCreatable";
 export * from "./types";
 export * from "./zkProgrammable/ZkProgrammable";
 export * from "./zkProgrammable/ProvableMethodExecutionContext";

packages/common/src/utils.ts

@@ -35,6 +35,9 @@ export function dummyValue<Value>(
   return valueType.fromFields(fields) as Value;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+export function noop(): void {}
+
 export interface ToFieldable {
   toFields: () => Field[];
 }

packages/module/src/method/runtimeMethod.ts

@@ -88,8 +88,7 @@ export function toWrappedMethod(
     }
 
     // Assert that the given transaction has the correct methodId
-    const methodIdResolver =
-      runtime.dependencyContainer.resolve<MethodIdResolver>("MethodIdResolver");
+    const { methodIdResolver } = runtime;
     const thisMethodId = Field(methodIdResolver.getMethodId(name, methodName));
     if (!thisMethodId.isConstant()) {
       throw errors.fieldNotConstant("methodId");

packages/module/src/runtime/Runtime.ts

@@ -11,7 +11,7 @@ import {
   ZkProgrammable,
   PlainZkProgram,
   WithZkProgrammable,
-  AreProofsEnabled,
+  AreProofsEnabled, ChildContainerProvider
 } from "@proto-kit/common";
 import {
   MethodPublicOutput,
@@ -29,6 +29,7 @@ import { MethodIdFactory } from "../factories/MethodIdFactory";
 
 import { RuntimeModule } from "./RuntimeModule";
 import { MethodIdResolver } from "./MethodIdResolver";
+import { RuntimeEnvironment } from "./RuntimeEnvironment";
 
 /**
  * Record of modules accepted by the Runtime module container.
@@ -190,12 +191,16 @@ export class RuntimeZkProgrammable<
 @injectable()
 export class Runtime<Modules extends RuntimeModulesRecord>
   extends ModuleContainer<Modules>
-  implements WithZkProgrammable<undefined, MethodPublicOutput>
+  implements RuntimeEnvironment
 {
   public static from<Modules extends RuntimeModulesRecord>(
     definition: RuntimeDefinition<Modules>
-  ) {
-    return new Runtime(definition);
+  ): TypedClass<Runtime<Modules>> {
+    return class RuntimeScoped extends Runtime<Modules> {
+      public constructor() {
+        super(definition);
+      }
+    };
   }
 
   // runtime modules composed into a ZkProgram
@@ -223,15 +228,14 @@ export class Runtime<Modules extends RuntimeModulesRecord>
 
   // eslint-disable-next-line no-warning-comments
   // TODO Remove after changing DFs to type-based approach
-  public start() {
-    this.registerValue({
-      Runtime: this,
-    });
+  public create(childContainerProvider: ChildContainerProvider) {
+    super.create(childContainerProvider);
+
     this.registerDependencyFactories([MethodIdFactory]);
   }
 
   public get appChain(): AreProofsEnabled | undefined {
-    return this.container.resolve<AreProofsEnabled>("AppChain");
+    return this.container.resolve<AreProofsEnabled>("AreProofsEnabled");
   }
 
   public get stateService(): StateService {
@@ -242,6 +246,10 @@ export class Runtime<Modules extends RuntimeModulesRecord>
     return this.stateServiceProviderInstance;
   }
 
+  public get methodIdResolver(): MethodIdResolver {
+    return this.container.resolve<MethodIdResolver>("MethodIdResolver");
+  }
+
   /**
    * @returns The dependency injection container of this runtime
    */

packages/module/src/runtime/RuntimeEnvironment.ts

@@ -0,0 +1,19 @@
+import {
+  AreProofsEnabled,
+  WithZkProgrammable,
+  ZkProgrammable,
+} from "@proto-kit/common";
+import {
+  MethodPublicOutput,
+  StateService,
+  StateServiceProvider,
+} from "@proto-kit/protocol";
+import { MethodIdResolver } from "./MethodIdResolver";
+
+export interface RuntimeEnvironment
+  extends WithZkProgrammable<undefined, MethodPublicOutput> {
+  get appChain(): AreProofsEnabled | undefined;
+  get stateService(): StateService;
+  get stateServiceProvider(): StateServiceProvider;
+  get methodIdResolver(): MethodIdResolver;
+}