@tsed/common 6.84.0 → 6.86.1

package/lib/builder/PlatformBuilder.d.ts

@@ -1,7 +1,9 @@
+/// <reference types="node" />
 import { Type } from "@tsed/core";
-import { Container, InjectorService, IProvider } from "@tsed/di";
+import { InjectorService, IProvider } from "@tsed/di";
 import { Platform } from "../services/Platform";
 import { PlatformApplication } from "../services/PlatformApplication";
+import { IncomingMessage, ServerResponse } from "http";
 /**
  * @ignore
  */
@@ -12,8 +14,15 @@ export interface PlatformType<T = any> extends Type<T> {
  * @ignore
  */
 export interface PlatformBootstrap {
+    create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder;
     bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder>;
 }
+export interface PlatformBuilderOptions {
+    name: string;
+    providers: IProvider[];
+    settings: any;
+    module: Type<any>;
+}
 /**
  * @platform
  */
@@ -22,11 +31,8 @@ export declare abstract class PlatformBuilder<App = TsED.Application, Router = T
     static currentPlatform: Type<PlatformBuilder<any, any>> & PlatformBootstrap;
     readonly name: string;
     protected startedAt: Date;
-    protected locals: Container;
-    constructor({ name, providers }: {
-        name: string;
-        providers: IProvider[];
-    });
+    protected current: Date;
+    constructor({ name, providers, settings, module }: PlatformBuilderOptions);
     get injector(): InjectorService;
     get rootModule(): any;
     get app(): PlatformApplication<App, Router>;
@@ -55,7 +61,9 @@ export declare abstract class PlatformBuilder<App = TsED.Application, Router = T
     get settings(): TsED.Configuration & import("@tsed/di").DIConfiguration;
     get logger(): import("@tsed/di").DILogger;
     get disableBootstrapLog(): boolean | undefined;
-    static build<T extends PlatformBuilder<any, any>>(platformBuildClass: PlatformType<T>): T;
+    static build<T extends PlatformBuilder<any, any>>(platformBuildClass: PlatformType<T>, module: Type<any>, settings?: Partial<TsED.Configuration>): T;
+    callback(): (req: IncomingMessage, res: ServerResponse) => void;
+    callback(req: IncomingMessage, res: ServerResponse): void;
     log(...data: any[]): any;
     /**
      * Add classes to the components list
@@ -83,7 +91,7 @@ export declare abstract class PlatformBuilder<App = TsED.Application, Router = T
      * @param {any[]} controllers
      */
     addControllers(endpoint: string, controllers: any | string | (any | string)[]): void;
-    runLifecycle(): Promise<void>;
+    runLifecycle(): Promise<this>;
     loadInjector(): Promise<void>;
     listen(): Promise<void>;
     stop(): Promise<void>;
@@ -91,6 +99,8 @@ export declare abstract class PlatformBuilder<App = TsED.Application, Router = T
     callHook(hook: string, ...args: any[]): Promise<void>;
     loadStatics(hook: string): Promise<void>;
     useProvider(token: Type<any>, settings?: Partial<IProvider>): this;
+    bootstrap(): Promise<this>;
+    protected diff(): string;
     protected importProviders(): Promise<void>;
     /**
      * Load middlewares from configuration for the given hook
@@ -100,9 +110,8 @@ export declare abstract class PlatformBuilder<App = TsED.Application, Router = T
     protected loadMiddlewaresFor(hook: string): void;
     protected useRouter(): this;
     protected useContext(): this;
-    protected bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<this>;
     protected listenServers(): Promise<void>;
     protected logRoutes(): Promise<void>;
     protected loadRoutes(): Promise<void>;
-    protected createInjector(module: Type<any>, settings: any): void;
+    protected createInjector(module: Type<any>, providers: IProvider[], settings: any): void;
 }

package/lib/config/interfaces/index.d.ts

@@ -47,6 +47,10 @@ declare global {
              * List of directories to scan [Services](/docs/services.md), [Middlewares](/docs/middlewares.md) or [Converters](/docs/converters.md).
              */
             componentsScan: (string | RegExp)[];
+            /**
+             * Disable the glob pattern. In v7 the componentsScan options will be removed in favor of external module loader.
+             */
+            disableComponentsScan: boolean;
             /**
              * List of glob patterns. Exclude all files which matching with this list when Server scan all components with the `mount` or `scanComponents` options.
              */

package/lib/index.js

@@ -11,7 +11,6 @@ var componentsScan = require('@tsed/components-scan');
 var platformLogMiddleware = require('@tsed/platform-log-middleware');
 var tslib = require('tslib');
 var core = require('@tsed/core');
-var perf = require('@tsed/perf');
 var exceptions = require('@tsed/exceptions');
 var schema = require('@tsed/schema');
 var util = require('util');
@@ -99,27 +98,7 @@ const rootDir = process.cwd();
 exports.PlatformConfiguration = PlatformConfiguration_1 = class PlatformConfiguration extends di.DIConfiguration {
   constructor() {
     super({
-      rootDir,
-      env: process.env.NODE_ENV || core.Env.DEV,
-      httpPort: 8080,
-      httpsPort: false,
-      scopes: {
-        [di.ProviderType.CONTROLLER]: di.ProviderScope.SINGLETON
-      },
-      logger: {
-        debug: false,
-        level: "info",
-        logRequest: true,
-        jsonIndentation: process.env.NODE_ENV === core.Env.PROD ? 0 : 2
-      },
-      errors: {
-        headerName: "errors"
-      },
-      mount: {
-        "/rest": "${rootDir}/controllers/**/*.ts"
-      },
-      exclude: ["**/*.spec.ts", "**/*.spec.js"],
-      componentsScan: ["${rootDir}/mvc/**/*.ts", "${rootDir}/services/**/*.ts", "${rootDir}/middlewares/**/*.ts"]
+      rootDir
     });
   }
 
@@ -2509,45 +2488,81 @@ function getStaticsOptions(statics) {
   }, []);
 }
 
-const {
-  bind,
-  start,
-  end,
-  log
-} = perf.PerfLogger.get("bootstrap");
+function getConfiguration(configuration = {}, module = null) {
+  const store = module ? core.Store.from(module).get("configuration") || {} : {};
+  const env = configuration.env || store.mount || process.env.NODE_ENV || core.Env.DEV;
+
+  const config = _extends({
+    exclude: ["**/*.spec.ts", "**/*.spec.js"],
+    componentsScan: ["${rootDir}/mvc/**/*.ts", "${rootDir}/services/**/*.ts", "${rootDir}/middlewares/**/*.ts"],
+    env,
+    httpPort: 8080,
+    httpsPort: false
+  }, store, configuration, {
+    scopes: _extends({
+      [di.ProviderType.CONTROLLER]: di.ProviderScope.SINGLETON
+    }, store.scopes, configuration.scopes),
+    mount: store.mount || configuration.mount ? core.deepMerge(store.mount || {}, configuration.mount || {}) : {
+      "/rest": "${rootDir}/controllers/**/*.ts"
+    },
+    logger: _extends({
+      debug: false,
+      level: env === core.Env.TEST ? "off" : "info",
+      logRequest: true
+    }, store.logger, configuration.logger, {
+      jsonIndentation: process.env.NODE_ENV === core.Env.PROD ? 0 : 2
+    })
+  });
+
+  if (!configuration.disableComponentsScan && store.componentsScan && configuration.componentsScan) {
+    config.componentsScan = [...store.componentsScan, ...configuration.componentsScan];
+  }
+
+  return config;
+}
+
+const DEFAULT_PROVIDERS = [{
+  provide: exports.PlatformHandler
+}, {
+  provide: exports.PlatformResponse
+}, {
+  provide: exports.PlatformRequest
+}, {
+  provide: exports.PlatformRouter
+}, {
+  provide: exports.PlatformApplication
+}, {
+  provide: exports.Platform
+}];
 /**
  * @platform
  */
 
 var _injector = /*#__PURE__*/_classPrivateFieldLooseKey("injector");
 
-var _providers = /*#__PURE__*/_classPrivateFieldLooseKey("providers");
-
 var _rootModule = /*#__PURE__*/_classPrivateFieldLooseKey("rootModule");
 
 class PlatformBuilder {
   constructor({
     name,
-    providers
+    providers,
+    settings,
+    module
   }) {
     Object.defineProperty(this, _injector, {
       writable: true,
       value: void 0
     });
-    Object.defineProperty(this, _providers, {
-      writable: true,
-      value: void 0
-    });
     Object.defineProperty(this, _rootModule, {
       writable: true,
       value: void 0
     });
     this.name = "";
     this.startedAt = new Date();
+    this.current = new Date();
     this.name = name;
-    _classPrivateFieldLooseBase(this, _providers)[_providers] = core.toMap(providers, "provide");
-    this.locals = new di.Container();
-    this.useProvider(exports.PlatformHandler, _classPrivateFieldLooseBase(this, _providers)[_providers].get(exports.PlatformHandler)).useProvider(exports.PlatformResponse, _classPrivateFieldLooseBase(this, _providers)[_providers].get(exports.PlatformResponse)).useProvider(exports.PlatformRequest, _classPrivateFieldLooseBase(this, _providers)[_providers].get(exports.PlatformRequest)).useProvider(exports.PlatformRouter, _classPrivateFieldLooseBase(this, _providers)[_providers].get(exports.PlatformRouter)).useProvider(exports.PlatformApplication, _classPrivateFieldLooseBase(this, _providers)[_providers].get(exports.PlatformApplication)).useProvider(exports.Platform, _classPrivateFieldLooseBase(this, _providers)[_providers].get(exports.Platform));
+    _classPrivateFieldLooseBase(this, _rootModule)[_rootModule] = module;
+    this.createInjector(module, providers, settings);
   }
 
   get injector() {
@@ -2602,15 +2617,25 @@ class PlatformBuilder {
     return (_this$settings$logger = this.settings.logger) == null ? void 0 : _this$settings$logger.disableBootstrapLog;
   }
 
-  static build(platformBuildClass) {
+  static build(platformBuildClass, module, settings = {}) {
     return new platformBuildClass({
       name: core.nameOf(platformBuildClass).replace("Platform", "").toLowerCase(),
+      module,
+      settings,
       providers: platformBuildClass.providers
     });
   }
 
+  callback(req, res) {
+    if (req && res) {
+      return this.app.callback()(req, res);
+    }
+
+    return this.app.callback();
+  }
+
   log(...data) {
-    return this.disableBootstrapLog && this.logger.info(...data);
+    return !this.disableBootstrapLog && this.logger.info(...data, this.diff());
   }
   /**
    * Add classes to the components list
@@ -2656,6 +2681,7 @@ class PlatformBuilder {
     this.useRouter();
     await this.loadRoutes();
     await this.logRoutes();
+    return this;
   }
 
   async loadInjector() {
@@ -2669,7 +2695,7 @@ class PlatformBuilder {
       scope: di.ProviderScope.SINGLETON
     });
     await injector.load(container);
-    this.log("Settings and injector loaded");
+    this.log("Settings and injector loaded...");
     await this.callHook("$afterInit");
   }
 
@@ -2678,7 +2704,6 @@ class PlatformBuilder {
     await this.listenServers();
     await this.callHook("$afterListen");
     await this.ready();
-    end();
   }
 
   async stop() {
@@ -2699,16 +2724,15 @@ class PlatformBuilder {
     const {
       injector
     } = this;
-    log(hook);
 
     if (!this.disableBootstrapLog) {
-      injector.logger.info(`\x1B[1mCall hook ${hook}\x1B[22m`);
+      injector.logger.debug(`\x1B[1mCall hook ${hook}\x1B[22m`);
     } // Load middlewares for the given hook
 
 
     this.loadMiddlewaresFor(hook); // call hooks added by providers
 
-    await injector.emit(hook);
+    await injector.emit(hook, ...args);
   }
 
   async loadStatics(hook) {
@@ -2724,10 +2748,20 @@ class PlatformBuilder {
   }
 
   useProvider(token, settings) {
-    this.locals.addProvider(token, settings);
+    this.injector.addProvider(token, settings);
     return this;
   }
 
+  async bootstrap() {
+    return this.runLifecycle();
+  }
+
+  diff() {
+    const ms = di.colors.yellow(`+${new Date().getTime() - this.current.getTime()}ms`);
+    this.current = new Date();
+    return ms;
+  }
+
   async importProviders() {
     this.injector.logger.debug("Scan components");
     const providers = await componentsScan.importProviders(this.injector.settings, ["imports", "mount", "componentsScan"]);
@@ -2739,6 +2773,7 @@ class PlatformBuilder {
       token
     }));
     this.settings.set("routes", routes);
+    this.log("Providers loaded...");
   }
   /**
    * Load middlewares from configuration for the given hook
@@ -2763,25 +2798,6 @@ class PlatformBuilder {
     return this;
   }
 
-  async bootstrap(module, settings = {}) {
-    var _settings$logger;
-
-    // istanbul ignore next
-    if ((_settings$logger = settings.logger) != null && _settings$logger.perf) {
-      start();
-      bind(this);
-      settings.logger = _extends({}, settings.logger, {
-        level: "off"
-      });
-    }
-
-    this.createInjector(module, _extends({}, settings, {
-      PLATFORM_NAME: this.name
-    }));
-    await this.runLifecycle();
-    return this;
-  }
-
   async listenServers() {
     await Promise.all([listenHttpServer(this.injector), listenHttpsServer(this.injector)]);
   }
@@ -2793,9 +2809,9 @@ class PlatformBuilder {
       logger,
       platform
     } = this;
+    this.log("Routes mounted...");
 
     if (!((_this$settings$logger2 = this.settings.logger) != null && _this$settings$logger2.disableRoutesSummary) && !this.disableBootstrapLog) {
-      logger.info("Routes mounted :");
       logger.info(printRoutes(await this.injector.alterAsync("$logRoutes", platform.getRoutes())));
     }
   }
@@ -2825,17 +2841,18 @@ class PlatformBuilder {
     await this.callHook("$afterRoutesInit");
   }
 
-  createInjector(module, settings) {
-    _classPrivateFieldLooseBase(this, _rootModule)[_rootModule] = module;
-    const configuration = di.getConfiguration(module, settings);
-    _classPrivateFieldLooseBase(this, _injector)[_injector] = createInjector(configuration); // configure locals providers
-
-    this.locals.forEach(provider => {
-      this.injector.addProvider(provider.token, provider);
+  createInjector(module, providers, settings) {
+    const configuration = getConfiguration(settings, module);
+    configuration.PLATFORM_NAME = this.name;
+    _classPrivateFieldLooseBase(this, _injector)[_injector] = createInjector(configuration);
+    providers = [...DEFAULT_PROVIDERS, ...providers];
+    core.toMap(providers, "provide").forEach((provider, token) => {
+      this.injector.addProvider(token, provider);
     });
     createPlatformApplication(this.injector);
     createHttpsServer(this.injector);
     createHttpServer(this.injector);
+    this.log("Injector created...");
   }
 
 }
@@ -3211,7 +3228,7 @@ function mapReturnedResponse(_ref) {
 
 class PlatformTest extends di.DITest {
   static async create(options = {}) {
-    di.DITest.injector = PlatformTest.createInjector(options);
+    di.DITest.injector = PlatformTest.createInjector(getConfiguration(options, null));
     const container = di.createContainer();
     await di.DITest.injector.load(container);
   }
@@ -3243,7 +3260,8 @@ class PlatformTest extends di.DITest {
       } // @ts-ignore
 
 
-      instance = await PlatformBuilder.build(platform).bootstrap(mod, di.DITest.configure(settings));
+      settings = di.DITest.configure(settings);
+      instance = await PlatformBuilder.build(platform, mod, settings).bootstrap();
 
       if (!settings.listen) {
         await instance.callHook("$beforeListen");