feat: refactoring to support breaking @dandi/core changes

supports #39

Author: DanielSchaffer

.mocharc.json

@@ -0,0 +1,3 @@
+{
+
+}

.nvmrc

@@ -1 +1 @@
-v10.15.0
+v10.15.3

.nycrc

@@ -13,10 +13,10 @@
   ],
   "exclude": [
     "node_modules",
-    "**/*.spec.ts",
+    "**/*.*spec.ts",
     "mocha.config.js",
     "test",
-    "**/local.token.ts"
+    "**/local-token.ts"
   ],
-  "report-dir": ".coverage"
+  "reportDir": ".coverage"
 }

README.md

@@ -43,11 +43,11 @@ allow developers to use only the features they require.
 # Core Modules
 
 - **[@dandi/common](./packages/dandi/common)** 🕸 - Common types and utilities
+- **[@dandi/config](./packages/dandi/config)** 🕸 - Configuration services
 - **[@dandi/core](./packages/dandi/core)** 🕸 - Dependency Injection
 - **[@dandi/core/logging](./packages/dandi/core/logging)** 🕸 - Core logging and configuration
 - **[@dandi/core-node](./packages/dandi/core-node)** - Additional DI utilities specific to NodeJS
 - **[@dandi/data](./packages/dandi/data)** 🕸 - Base types and utilities for working with data services
-- **[@dandi/config](./packages/dandi/config)** 🕸 - Configuration services
 - **[@dandi/hal](./packages/dandi/hal)** - 🕸 - Model decorators, basic types and utilities for supporting HAL
 - **[@dandi/logging](./packages/dandi/logging)** - 🕸 - Additional logging utilities for logging and logging configuration
 - **[@dandi/model](./packages/dandi/model)** 🕸 - Model decorators

_examples/simple-console/src/app.ts

@@ -1,11 +1,11 @@
-import { Bootstrapper, Inject, Injectable, Logger } from '@dandi/core'
+import { EntryPoint, Inject, Injectable, Logger } from '@dandi/core'
 
-@Injectable(Bootstrapper)
-export class App implements Bootstrapper {
+@Injectable(EntryPoint)
+export class SimpleConsoleApp implements EntryPoint {
 
   constructor(@Inject(Logger) private logger: Logger) {}
 
-  public async start(): Promise<void> {
+  public async run(): Promise<void> {
     this.logger.debug('Just starting up here')
 
     await this.fakeWork(5)

_examples/simple-console/src/main.ts

@@ -1,22 +1,21 @@
-import { AmbientInjectableScanner, Container } from '@dandi/core'
+import { AmbientInjectableScanner, DandiApplication } from '@dandi/core'
 import { ConsoleLogListener, LoggingModule } from '@dandi/core/logging'
 import { PrettyColorsLogging } from '@dandi/logging'
 
-import { App } from './app'
+import { SimpleConsoleApp } from './app'
 import { appConfigProvider } from './app-options'
 
 export function run(startTs: number, options: any): Promise<void> {
-  const container = new Container({
+  const app = new DandiApplication({
     providers: [
       AmbientInjectableScanner,
       LoggingModule.use(ConsoleLogListener, PrettyColorsLogging),
 
       appConfigProvider(options),
 
-      App,
+      SimpleConsoleApp,
     ],
   })
 
-  return container.start(startTs)
-
+  return app.run(startTs)
 }

_examples/simple-express-rest-api/README.md

@@ -31,7 +31,7 @@ From a command line in the
 This file is used as the entry point for the application. It loads and
 starts the container.
 
-### src/server.container.ts
+### src/server.dandi-application.ts
 
 This file is used to construct the `@dandi` DI container used to run
 the application. It pulls in the MVC service implementations from

_examples/simple-express-rest-api/src/server.container.ts

@@ -1,5 +1,5 @@
 import { CascadingCache, MemoryCache, ServiceContextCacheKeyGenerator } from '@dandi/cache'
-import { AmbientInjectableScanner, Container } from '@dandi/core'
+import { AmbientInjectableScanner, DandiApplication } from '@dandi/core'
 import { ConsoleLogListener, LoggingModule } from '@dandi/core/logging'
 import { ModelBuilderModule } from '@dandi/model-builder'
 import { MvcHalModule } from '@dandi/mvc-hal'
@@ -16,7 +16,7 @@ import { ViewController } from './view/view.controller'
 
 const DEFAULT_SERVER_PORT = 7080
 
-export const server = new Container({
+export const server = new DandiApplication({
   providers: [
     // DI
     AmbientInjectableScanner,

builder/src/command-runner.ts

@@ -1,13 +1,13 @@
-import { Bootstrapper, Inject, Injectable, Logger } from '@dandi/core'
+import { EntryPoint, Inject, Injectable, Logger } from '@dandi/core'
 
 import { Action, ActionHost, Actions, CommandAction, CommandInfo } from './command-action'
 
 function isActionName<T>(ctr: Function, obj: any): obj is Actions<T> {
   return typeof obj === 'string' && typeof ctr.prototype[obj] === 'function'
 }
 
-@Injectable(Bootstrapper)
-export class CommandRunner<THost extends any> implements Bootstrapper {
+@Injectable(EntryPoint)
+export class CommandRunner<THost extends any> implements EntryPoint {
 
   constructor(
     @Inject(CommandAction) private actionName: CommandAction<THost>,
@@ -16,21 +16,21 @@ export class CommandRunner<THost extends any> implements Bootstrapper {
     @Inject(Logger) private logger: Logger,
   ) {}
 
-  public start(): void {
-    this.doRun()
+  public run(): void {
+    this.safeRun()
   }
 
-  private async doRun(): Promise<void> {
+  private async safeRun(): Promise<void> {
     try {
-      await this.run()
+      await this.runAction()
       this.logger.info(`${this.actionName} complete.`)
     } catch (err) {
       this.logger.error(err.message, err.stack)
       process.exit(-1)
     }
   }
 
-  private async run(): Promise<void> {
+  private async runAction(): Promise<void> {
     if (isActionName<THost>(this.host.constructor, this.actionName)) {
       return await (<Action>this.host[this.actionName])(this.info.args)
     }

builder/src/command-util.ts

@@ -1,7 +1,7 @@
 import { dirname, resolve } from 'path'
 
 import { Constructor } from '@dandi/common'
-import { AmbientInjectableScanner, Container, LogLevel } from '@dandi/core'
+import { AmbientInjectableScanner, DandiApplication, LogLevel } from '@dandi/core'
 import { ConsoleLogListener, LoggingModule } from '@dandi/core/logging'
 import { PrettyColorsLogging } from '@dandi/logging'
 
@@ -10,23 +10,23 @@ import { Command } from 'commander'
 import { Builder } from './builder'
 import { BuilderProject } from './builder-project'
 import { BuilderProjectOptions } from './builder-project-options'
-import { ActionHost, Actions, CommandAction, CommandInfo } from './command-action'
+import { ActionHost, CommandAction, CommandInfo } from './command-action'
 import { CommandRunner } from './command-runner'
 import { Publisher } from './publisher'
 
 export type CommanderArgs = (string | Command)[]
 
 export class CommandUtil {
 
-  public static projectAction(actionName: keyof Actions<BuilderProject>, start: number): (...args: CommanderArgs) => Promise<void> {
+  public static projectAction(actionName: CommandAction<BuilderProject>, start: number): (...args: CommanderArgs) => Promise<void> {
     return this.action(BuilderProject, actionName, start)
   }
 
-  public static builderAction(actionName: keyof Actions<Builder>, start: number): (...args: CommanderArgs) => Promise<void> {
+  public static builderAction(actionName: CommandAction<Builder>, start: number): (...args: CommanderArgs) => Promise<void> {
     return this.action(Builder, actionName, start)
   }
 
-  public static publisherAction(actionName: keyof Actions<Publisher>, start: number): (...args: CommanderArgs) => Promise<void> {
+  public static publisherAction(actionName: CommandAction<Publisher>, start: number): (...args: CommanderArgs) => Promise<void> {
     return this.action(Publisher, actionName, start)
   }
 
@@ -42,7 +42,7 @@ export class CommandUtil {
         args: cmdArgs,
       }
 
-      const container = new Container({
+      const container = new DandiApplication({
         providers: [
           AmbientInjectableScanner,
           CommandRunner,