@tsed/platform-http 8.11.0 → 8.11.2-rc.1

package/src/common/builder/PlatformBuilder.ts

@@ -1,426 +0,0 @@
-import type {IncomingMessage, ServerResponse} from "node:http";
-import Http from "node:http";
-import type Https from "node:https";
-
-import {type Env, isClass, isFunction, isString, nameOf, Type} from "@tsed/core";
-import {
-  colors,
-  configuration,
-  constant,
-  createContainer,
-  destroyInjector,
-  injector,
-  InjectorService,
-  logger,
-  ProviderOpts,
-  ProviderScope,
-  setLoggerConfiguration,
-  TokenProvider
-} from "@tsed/di";
-import {$asyncAlter, $asyncEmit} from "@tsed/hooks";
-import {getMiddlewaresForHook, PlatformMiddlewareLoadingOptions} from "@tsed/platform-middlewares";
-import {PlatformLayer} from "@tsed/platform-router";
-import Http2 from "http2";
-
-import {PlatformStaticsSettings} from "../config/interfaces/PlatformStaticsSettings.js";
-import {PlatformRouteDetails} from "../domain/PlatformRouteDetails.js";
-import {application} from "../fn/application.js";
-import {Route} from "../interfaces/Route.js";
-import {Platform} from "../services/Platform.js";
-import {PlatformAdapter, PlatformBuilderSettings} from "../services/PlatformAdapter.js";
-import {PlatformApplication} from "../services/PlatformApplication.js";
-import {closeServer} from "../utils/closeServer.js";
-import {createInjector} from "../utils/createInjector.js";
-import {CreateServerReturn} from "../utils/createServer.js";
-import {getConfiguration} from "../utils/getConfiguration.js";
-import {getStaticsOptions} from "../utils/getStaticsOptions.js";
-import {printRoutes} from "../utils/printRoutes.js";
-import {resolveControllers} from "../utils/resolveControllers.js";
-
-/**
- * @platform
- */
-export class PlatformBuilder<App = TsED.Application> {
-  protected startedAt = new Date();
-  protected current = new Date();
-  readonly #rootModule: Type<any>;
-  #promise: Promise<this>;
-  #servers: CreateServerReturn[];
-  #listeners: (Http.Server | Https.Server | Http2.Http2Server)[] = [];
-
-  protected constructor(module: Type, settings: Partial<TsED.Configuration>) {
-    this.#rootModule = module;
-
-    const configuration = getConfiguration(settings, module);
-
-    createInjector(configuration);
-
-    this.log(`Loading ${this.name.toUpperCase()} platform adapter...`);
-
-    this.createHttpServers();
-
-    this.log("Injector created...");
-  }
-
-  get name() {
-    return this.adapter.NAME;
-  }
-
-  get rootModule(): any {
-    return injector().get(this.#rootModule);
-  }
-
-  get app(): PlatformApplication<App> {
-    return injector().get<PlatformApplication<App>>(PlatformApplication)!;
-  }
-
-  get platform() {
-    return injector().get<Platform>(Platform)!;
-  }
-
-  get adapter() {
-    return injector().get(PlatformAdapter);
-  }
-
-  /**
-   * Return the settings configured by the decorator @@Configuration@@.
-   *
-   * ```typescript
-   * @Configuration({
-   *    port: 8000,
-   *    httpsPort: 8080,
-   *    mount: {
-   *      "/rest": "${rootDir}/controllers/**\/*.js"
-   *    }
-   * })
-   * export class Server {
-   *     $onInit(){
-   *         console.log(this.settings); // {rootDir, port, httpsPort,...}
-   *     }
-   * }
-   * ```
-   *
-   * @returns {PlatformConfiguration}
-   */
-  get settings() {
-    return configuration();
-  }
-
-  get logger() {
-    return logger();
-  }
-
-  get disableBootstrapLog() {
-    return constant<boolean>("logger.disableBootstrapLog");
-  }
-
-  /**
-   * @deprecated use injector() instead of this method.
-   */
-  get injector(): InjectorService {
-    return injector();
-  }
-
-  static create<App = TsED.Application>(module: Type<any>, settings: PlatformBuilderSettings<App>) {
-    return this.build(module, {
-      httpsPort: false,
-      httpPort: false,
-      ...settings
-    });
-  }
-
-  static build<App = TsED.Application>(module: Type<any>, settings: PlatformBuilderSettings<App>) {
-    return new PlatformBuilder(module, settings);
-  }
-
-  /**
-   * Bootstrap a server application
-   * @param module
-   * @param settings
-   */
-  static bootstrap<App = TsED.Application>(module: Type<any>, settings: PlatformBuilderSettings<App>) {
-    return this.build<App>(module, settings).bootstrap();
-  }
-
-  callback(): (req: IncomingMessage, res: ServerResponse) => void;
-  callback(req: IncomingMessage, res: ServerResponse): void;
-  callback(...args: [IncomingMessage?, ServerResponse?]) {
-    return (this.adapter.app.callback as any)(...args);
-  }
-
-  log(...data: any[]) {
-    return !this.disableBootstrapLog && logger().info(...data, this.diff());
-  }
-
-  /**
-   * Add classes decorated by @@Controller@@ to components container.
-   *
-   * ### Example
-   *
-   * ```typescript
-   * @Controller('/ctrl')
-   * class MyController{
-   * }
-   *
-   * platform.addControllers('/rest', [MyController])
-   * ```
-   *
-   * ::: tip
-   * If the MyController class isn't decorated, the class will be ignored.
-   * :::
-   *
-   * @param {string} endpoint
-   * @param {any[]} controllers
-   */
-  public addControllers(endpoint: string, controllers: TokenProvider | TokenProvider[]) {
-    [].concat(controllers as never[]).forEach((token: TokenProvider) => {
-      configuration().routes.push({token, route: endpoint});
-    });
-  }
-
-  public async runLifecycle() {
-    // init adapter (Express, Koa, etc...)
-    await this.adapter.onInit();
-
-    setLoggerConfiguration();
-
-    // create the middleware mapping to be executed to the expected hook
-    await this.mapTokenMiddlewares();
-
-    await this.loadInjector();
-
-    // add the context middleware to the application
-    this.log("Mount app context");
-    await this.adapter.useContext();
-
-    // init routes (controllers, middlewares, etc...)
-    this.log("Load routes");
-    await this.adapter.beforeLoadRoutes();
-
-    if (this.rootModule.$beforeRoutesInit) {
-      await this.rootModule.$beforeRoutesInit();
-      // remove method to avoid multiple call and preserve hook order
-      this.rootModule.$beforeRoutesInit = () => {};
-    }
-
-    // Hooks execution (adding middlewares, controllers, services, etc...)
-    await this.loadStatics("$beforeRoutesInit");
-    await this.callHook("$beforeRoutesInit");
-
-    const routes = configuration().get<Route[]>("routes");
-
-    this.platform.addRoutes(routes);
-
-    await this.callHook("$onRoutesInit");
-
-    await this.loadStatics("$afterRoutesInit");
-    await this.callHook("$afterRoutesInit");
-
-    await this.adapter.afterLoadRoutes();
-
-    // map routers are loaded after all hooks because it contains all added middlewares/controllers in the virtual Ts.ED layers
-    // This step will convert all Ts.ED layers to the platform layer (Express or Koa)
-    await this.mapRouters();
-
-    // Server is bootstrapped and ready to listen
-
-    return this;
-  }
-
-  async loadInjector() {
-    this.log("Build providers");
-    const settings = configuration();
-
-    settings.set("routes", settings.get("routes").concat(resolveControllers(settings)));
-
-    const container = createContainer();
-    container.delete(this.#rootModule);
-    container.addProvider(this.#rootModule, {
-      type: "server:module",
-      scope: ProviderScope.SINGLETON
-    });
-
-    await injector().load(container);
-
-    this.log("Settings and injector loaded...");
-
-    await this.callHook("$afterInit");
-  }
-
-  async listen(network = true) {
-    if (!this.#promise) {
-      await this.bootstrap();
-    }
-
-    await this.callHook("$beforeListen");
-
-    if (network) {
-      await this.listenServers();
-    }
-
-    await this.callHook("$afterListen");
-
-    await this.ready();
-  }
-
-  async stop() {
-    await destroyInjector();
-
-    this.#listeners.map(closeServer);
-  }
-
-  public async ready() {
-    const {startedAt} = this;
-
-    await this.callHook("$onReady");
-
-    this.log(`Started in ${new Date().getTime() - startedAt.getTime()} ms`);
-  }
-
-  async callHook(hook: string, ...args: any[]) {
-    if (!this.disableBootstrapLog) {
-      logger().debug(`\x1B[1mCall hook ${hook}\x1B[22m`);
-    }
-
-    // Load middlewares for the given hook
-    this.loadMiddlewaresFor(hook);
-
-    // call hooks added by providers
-    await $asyncEmit(hook, args);
-  }
-
-  loadStatics(hook: string) {
-    const statics = constant<PlatformStaticsSettings>("statics");
-    const app = application();
-
-    getStaticsOptions(statics).forEach(({path, options}) => {
-      if (options.hook === hook) {
-        app.statics(path, options);
-      }
-    });
-  }
-
-  useProvider(token: Type<any>, settings?: Partial<ProviderOpts>) {
-    injector().addProvider(token, settings);
-
-    return this;
-  }
-
-  bootstrap(): Promise<this> {
-    this.#promise = this.#promise || this.runLifecycle();
-
-    return this.#promise;
-  }
-
-  protected mapRouters() {
-    const layers = this.platform.getLayers();
-
-    this.adapter.mapLayers(layers);
-
-    const rawBody =
-      constant("rawBody") ||
-      layers.some(({handlers}) => {
-        return handlers.some((handler) => handler.opts?.paramsTypes?.RAW_BODY);
-      });
-
-    this.settings.set("rawBody", rawBody);
-
-    return this.logRoutes(layers.filter((layer) => layer.isProvider()));
-  }
-
-  protected diff() {
-    const ms = colors.yellow(`+${new Date().getTime() - this.current.getTime()}ms`);
-    this.current = new Date();
-    return ms;
-  }
-
-  /**
-   * Load middlewares from configuration for the given hook
-   * @param hook
-   * @protected
-   */
-  protected loadMiddlewaresFor(hook: string): void {
-    return getMiddlewaresForHook(hook, this.settings, "$beforeRoutesInit").forEach(({use}) => {
-      this.app.use(use);
-    });
-  }
-
-  protected createHttpServers() {
-    this.#servers = this.adapter.getServers();
-  }
-
-  protected async listenServers(): Promise<void> {
-    this.#listeners = await Promise.all(this.#servers.map((cb) => cb && cb()));
-  }
-
-  protected async logRoutes(layers: PlatformLayer[]) {
-    this.log("Routes mounted...");
-
-    if (!this.settings.get("logger.disableRoutesSummary") && !this.disableBootstrapLog) {
-      const routes: PlatformRouteDetails[] = layers.map((layer) => {
-        return {
-          url: layer.path,
-          method: layer.method,
-          name: layer.opts.name || `${layer.provider.className}.constructor()`,
-          className: layer.opts.className || layer.provider.className,
-          methodClassName: layer.opts.methodClassName || ""
-        } as PlatformRouteDetails;
-      });
-
-      logger().info(printRoutes(await $asyncAlter("$logRoutes", routes)));
-    }
-  }
-
-  protected async mapTokenMiddlewares() {
-    let middlewares = constant<PlatformMiddlewareLoadingOptions[]>("middlewares", []);
-    const env = constant<Env>("env");
-    const defaultHook = "$beforeRoutesInit";
-
-    const promises = middlewares.map(async (middleware: PlatformMiddlewareLoadingOptions): Promise<PlatformMiddlewareLoadingOptions> => {
-      if (isFunction(middleware)) {
-        return {
-          env,
-          hook: defaultHook,
-          use: middleware
-        };
-      }
-
-      if (isString(middleware)) {
-        middleware = {env, use: middleware, hook: defaultHook};
-      }
-
-      let {use, options} = middleware;
-
-      if (isString(use)) {
-        if (["text-parser", "raw-parser", "json-parser", "urlencoded-parser"].includes(use)) {
-          use = this.adapter.bodyParser(use.replace("-parser", ""), options);
-        } else {
-          const mod = await import(use);
-          use = (mod.default || mod)(options);
-        }
-      }
-
-      if (isClass(use) && ["$beforeInit", "$onInit", "$afterInit"].includes(middleware.hook!)) {
-        throw new Error(
-          `Ts.ED Middleware "${nameOf(use)}" middleware cannot be added on ${
-            middleware.hook
-          } hook. Use one of this hooks instead: $beforeRoutesInit, $onRoutesInit, $afterRoutesInit, $beforeListen, $afterListen, $onReady`
-        );
-      }
-
-      return {
-        env,
-        hook: defaultHook,
-        ...middleware,
-        use
-      };
-    });
-
-    middlewares = await Promise.all(promises);
-
-    configuration().set(
-      "middlewares",
-      middlewares.filter((middleware) => middleware.use)
-    );
-  }
-}

package/src/common/builder/__fixtures__/PlatformCustom.ts

@@ -1,39 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {FakeAdapter} from "../../../testing/index.js";
-import {PlatformBuilder} from "../PlatformBuilder.js";
-
-export class PlatformCustom extends FakeAdapter {
-  readonly NAME = "custom";
-  readonly providers = [
-    {
-      token: class Test {}
-    }
-  ];
-
-  static create(module: Type<any>, settings: Partial<TsED.Configuration> = {}) {
-    return PlatformBuilder.create<any>(module, {
-      ...settings,
-      adapter: PlatformCustom
-    });
-  }
-
-  static bootstrap(module: Type<any>, settings: Partial<TsED.Configuration> = {}) {
-    return PlatformBuilder.build(module, {
-      ...settings,
-      adapter: PlatformCustom
-    }).bootstrap();
-  }
-
-  afterLoadRoutes(): Promise<any> {
-    return Promise.resolve(undefined);
-  }
-
-  beforeLoadRoutes(): Promise<any> {
-    return Promise.resolve(undefined);
-  }
-
-  useContext(): any {}
-
-  useRouter(): any {}
-}

package/src/common/config/interfaces/PlatformJsonMapperSettings.ts

@@ -1,11 +0,0 @@
-import {JsonMapperGlobalOptions} from "@tsed/json-mapper";
-
-export interface PlatformJsonMapperSettings extends JsonMapperGlobalOptions {}
-
-declare global {
-  namespace TsED {
-    interface Configuration extends Record<string, any> {
-      jsonMapper?: PlatformJsonMapperSettings;
-    }
-  }
-}

package/src/common/config/interfaces/PlatformMulterSettings.ts

@@ -1,22 +0,0 @@
-import {
-  PlatformMulter as M1,
-  PlatformMulterField as M4,
-  PlatformMulterFile as M3,
-  PlatformMulterSettings as M2
-} from "@tsed/platform-multer";
-/**
- * @deprecated Since v8.5. Use PlatformMulter from @tsed/platform-multer instead.
- */
-export type PlatformMulter = M1;
-/**
- * @deprecated Since v8.5. Use PlatformMulterSettings from @tsed/platform-multer instead.
- */
-export type PlatformMulterSettings = M2;
-/**
- * @deprecated Since v8.5. Use PlatformMulterFile from @tsed/platform-multer instead.
- */
-export type PlatformMulterFile = M3;
-/**
- * @deprecated Since v8.5. Use PlatformMulterField from @tsed/platform-multer instead.
- */
-export type PlatformMulterField = M4;

package/src/common/config/interfaces/PlatformRouterSettings.ts

@@ -1,11 +0,0 @@
-export interface PlatformRouterSettings {
-  appendChildrenRoutesFirst?: boolean;
-}
-
-declare global {
-  namespace TsED {
-    interface Configuration extends Record<string, any> {
-      router?: PlatformRouterSettings;
-    }
-  }
-}

package/src/common/config/interfaces/PlatformStaticsSettings.ts

@@ -1,23 +0,0 @@
-declare global {
-  namespace TsED {
-    // @ts-ignore
-    export interface StaticsOptions {
-      root: string;
-      hook?: "$beforeRoutesInit" | "$afterRoutesInit";
-      // @ts-ignore
-      [key: string]: any;
-    }
-  }
-}
-
-export interface PlatformStaticsOptions extends TsED.StaticsOptions {
-  root: string;
-
-  [key: string]: any;
-}
-
-export type PathOrStaticsOptions = string | PlatformStaticsOptions;
-
-export interface PlatformStaticsSettings {
-  [endpoint: string]: PathOrStaticsOptions | PathOrStaticsOptions[];
-}