@nest-yalc-2/app 2.2.1 → 2.2.4

package/src/app-bootstrap-base.helper.ts

@@ -1,206 +1,206 @@
-import {
-  DynamicModule,
-  INestApplicationContext,
-  Logger,
-  LoggerService,
-  Type,
-} from '@nestjs/common';
-import { ConfigService } from '@nestjs/config';
-// import { GqlExceptionFilter } from '@nestjs/graphql';
-import { NestFastifyApplication } from '@nestjs/platform-fastify';
-import type { IServiceConf } from './conf.type.js';
-import { SYSTEM_LOGGER_SERVICE } from './def.const.js';
-import { YalcDefaultAppModule } from './base-app-module.helper.js';
-import { ICreateOptions, INestCreateOptions } from './app-bootstrap.helper.js';
-import { EventModule } from '@nest-yalc-2/event-manager/event.module.js';
-import { LoggerServiceFactory } from '@nest-yalc-2/logger/logger.service.js';
-import { FastifyInstance } from 'fastify';
-import { getEnvLoggerLevels } from '@node-yalc/logger/logger.helper.js';
-import { globalPromiseTracker } from '@node-yalc/utils/promise.helper.js';
-
-/**
- * Side effect to be executed as soon as the module is imported
- */
-Logger.overrideLogger(getEnvLoggerLevels());
-
-export interface IGlobalOptions {
-  extraImports?: NonNullable<DynamicModule['imports']>;
-  eventModuleClass?: typeof EventModule;
-  logger?: typeof LoggerServiceFactory;
-
-  /**
-   * This is used to avoid bootstrapping a multi-server app
-   */
-  skipMultiServerCheck?: boolean;
-}
-
-const bootstrappedApps: Set<any> = new Set();
-
-export const getBootstrappedApps = () => {
-  return bootstrappedApps;
-};
-
-export const getMainBootstrappedApp = <
-  TApp extends BaseAppBootstrap<
-    NestFastifyApplication | INestApplicationContext
-  >,
->(): TApp | null => {
-  if (getBootstrappedApps().size === 0) {
-    return null;
-  }
-
-  return getBootstrappedApps().values().next().value;
-};
-
-export abstract class BaseAppBootstrap<
-  TAppType extends NestFastifyApplication | INestApplicationContext,
-> {
-  protected app?: TAppType;
-  protected loggerService!: LoggerService;
-  protected module: Type<any> | DynamicModule;
-  protected isClosed = false;
-
-  constructor(
-    protected appAlias: string,
-    protected readonly appModule: Type<any>,
-    options?: { globalsOptions?: IGlobalOptions },
-  ) {
-    this.module = YalcDefaultAppModule.forRoot(
-      this.appAlias,
-      [appModule, ...(options?.globalsOptions?.extraImports ?? [])],
-      options?.globalsOptions,
-    );
-
-    const bootstrappedApp = getMainBootstrappedApp();
-
-    if (
-      bootstrappedApp &&
-      !options?.globalsOptions?.skipMultiServerCheck &&
-      process.env.APP_SKIP_MULTISERVER_CHECK !== 'true'
-    ) {
-      throw new Error(
-        `You are trying to bootstrap multiple servers (${bootstrappedApp.appAlias}) in the same process. This is not allowed. Use a different process for each server`,
-      );
-    }
-
-    getBootstrappedApps().add(this);
-  }
-
-  /* istanbul ignore next */
-  async initApp(options?: {
-    createOptions?: INestCreateOptions;
-    fastifyInstance?: FastifyInstance;
-  }): Promise<this> {
-    options; // extend this method in the child class
-    return this;
-  }
-
-  setApp(app: TAppType) {
-    this.app = app;
-
-    /**
-     * Monkey patch the close method to set the isClosed flag
-     */
-    const originalCloseFn = this.app.close.bind(this.app);
-    this.app.close = async () => {
-      const closeRes = await originalCloseFn();
-      this.closeCleanup();
-      return closeRes;
-    };
-
-    /**
-     * Monkey patch the init method to set the isClosed flag
-     */
-    const originalInitFn = this.app.init.bind(this.app);
-    this.app.init = async () => {
-      this.isClosed = false;
-      getBootstrappedApps().add(this);
-      let initRes;
-      try {
-        initRes = await originalInitFn();
-      } catch (error) {
-        /* istanbul ignore next */
-        this.closeCleanup();
-        /* istanbul ignore next */
-        throw error;
-      }
-      return initRes;
-    };
-
-    return this;
-  }
-
-  /**
-   * This method is used to cleanup the app and remove it from the global set of bootstrapped apps
-   */
-  closeCleanup() {
-    this.isClosed = true;
-    getBootstrappedApps().delete(this);
-  }
-
-  isAppClosed() {
-    return this.isClosed;
-  }
-
-  /* istanbul ignore next */
-  getAppAlias() {
-    return this.appAlias;
-  }
-
-  getConf() {
-    const configService = this.getApp().get<ConfigService>(ConfigService);
-    return configService.get<IServiceConf>(this.appAlias);
-  }
-
-  getApp() {
-    /* istanbul ignore next */
-    if (!this.app) {
-      /* istanbul ignore next */
-      throw new Error('This app is not initialized yet');
-    }
-
-    return this.app;
-  }
-
-  async closeApp() {
-    await this.cleanup();
-
-    await this.app?.close();
-
-    this.closeCleanup();
-  }
-
-  async cleanup() {
-    /**
-     * When running behind a lambda, we have to await for all the promises that have been added to the global promise tracker
-     * to avoid them being killed by the lambda
-     * @see - https://stackoverflow.com/questions/64688812/running-tasks-in-aws-lambda-background
-     */
-    await globalPromiseTracker.waitForAll();
-  }
-
-  /**
-   *
-   * @returns The main module of the business logic (the one that is passed in the constructor)
-   */
-  /* istanbul ignore next */
-  getAppModule() {
-    return this.appModule;
-  }
-
-  /**
-   *
-   * @returns The global module that is used to bootstrap the app (YalcDefaultAppModule)
-   */
-  getModule() {
-    return this.module;
-  }
-
-  async applyBootstrapGlobals(_options?: ICreateOptions) {
-    this.loggerService = this.getApp().get(SYSTEM_LOGGER_SERVICE);
-    this.loggerService.debug?.('Setting logger service...');
-    this.getApp().useLogger(this.loggerService);
-    Logger.overrideLogger(this.loggerService);
-    return this;
-  }
-}
+import {
+  DynamicModule,
+  INestApplicationContext,
+  Logger,
+  LoggerService,
+  Type,
+} from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+// import { GqlExceptionFilter } from '@nestjs/graphql';
+import { NestFastifyApplication } from '@nestjs/platform-fastify';
+import type { IServiceConf } from './conf.type.js';
+import { SYSTEM_LOGGER_SERVICE } from './def.const.js';
+import { YalcDefaultAppModule } from './base-app-module.helper.js';
+import { ICreateOptions, INestCreateOptions } from './app-bootstrap.helper.js';
+import { EventModule } from '@nest-yalc-2/event-manager/event.module.js';
+import { LoggerServiceFactory } from '@nest-yalc-2/logger/logger.service.js';
+import { FastifyInstance } from 'fastify';
+import { getEnvLoggerLevels } from '@node-yalc/logger/logger.helper.js';
+import { globalPromiseTracker } from '@node-yalc/utils/promise.helper.js';
+
+/**
+ * Side effect to be executed as soon as the module is imported
+ */
+Logger.overrideLogger(getEnvLoggerLevels());
+
+export interface IGlobalOptions {
+  extraImports?: NonNullable<DynamicModule['imports']>;
+  eventModuleClass?: typeof EventModule;
+  logger?: typeof LoggerServiceFactory;
+
+  /**
+   * This is used to avoid bootstrapping a multi-server app
+   */
+  skipMultiServerCheck?: boolean;
+}
+
+const bootstrappedApps: Set<any> = new Set();
+
+export const getBootstrappedApps = () => {
+  return bootstrappedApps;
+};
+
+export const getMainBootstrappedApp = <
+  TApp extends BaseAppBootstrap<
+    NestFastifyApplication | INestApplicationContext
+  >,
+>(): TApp | null => {
+  if (getBootstrappedApps().size === 0) {
+    return null;
+  }
+
+  return getBootstrappedApps().values().next().value;
+};
+
+export abstract class BaseAppBootstrap<
+  TAppType extends NestFastifyApplication | INestApplicationContext,
+> {
+  protected app?: TAppType;
+  protected loggerService!: LoggerService;
+  protected module: Type<any> | DynamicModule;
+  protected isClosed = false;
+
+  constructor(
+    protected appAlias: string,
+    protected readonly appModule: Type<any>,
+    options?: { globalsOptions?: IGlobalOptions },
+  ) {
+    this.module = YalcDefaultAppModule.forRoot(
+      this.appAlias,
+      [appModule, ...(options?.globalsOptions?.extraImports ?? [])],
+      options?.globalsOptions,
+    );
+
+    const bootstrappedApp = getMainBootstrappedApp();
+
+    if (
+      bootstrappedApp &&
+      !options?.globalsOptions?.skipMultiServerCheck &&
+      process.env.APP_SKIP_MULTISERVER_CHECK !== 'true'
+    ) {
+      throw new Error(
+        `You are trying to bootstrap multiple servers (${bootstrappedApp.appAlias}) in the same process. This is not allowed. Use a different process for each server`,
+      );
+    }
+
+    getBootstrappedApps().add(this);
+  }
+
+  /* istanbul ignore next */
+  async initApp(options?: {
+    createOptions?: INestCreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }): Promise<this> {
+    options; // extend this method in the child class
+    return this;
+  }
+
+  setApp(app: TAppType) {
+    this.app = app;
+
+    /**
+     * Monkey patch the close method to set the isClosed flag
+     */
+    const originalCloseFn = this.app.close.bind(this.app);
+    this.app.close = async () => {
+      const closeRes = await originalCloseFn();
+      this.closeCleanup();
+      return closeRes;
+    };
+
+    /**
+     * Monkey patch the init method to set the isClosed flag
+     */
+    const originalInitFn = this.app.init.bind(this.app);
+    this.app.init = async () => {
+      this.isClosed = false;
+      getBootstrappedApps().add(this);
+      let initRes;
+      try {
+        initRes = await originalInitFn();
+      } catch (error) {
+        /* istanbul ignore next */
+        this.closeCleanup();
+        /* istanbul ignore next */
+        throw error;
+      }
+      return initRes;
+    };
+
+    return this;
+  }
+
+  /**
+   * This method is used to cleanup the app and remove it from the global set of bootstrapped apps
+   */
+  closeCleanup() {
+    this.isClosed = true;
+    getBootstrappedApps().delete(this);
+  }
+
+  isAppClosed() {
+    return this.isClosed;
+  }
+
+  /* istanbul ignore next */
+  getAppAlias() {
+    return this.appAlias;
+  }
+
+  getConf() {
+    const configService = this.getApp().get<ConfigService>(ConfigService);
+    return configService.get<IServiceConf>(this.appAlias);
+  }
+
+  getApp() {
+    /* istanbul ignore next */
+    if (!this.app) {
+      /* istanbul ignore next */
+      throw new Error('This app is not initialized yet');
+    }
+
+    return this.app;
+  }
+
+  async closeApp() {
+    await this.cleanup();
+
+    await this.app?.close();
+
+    this.closeCleanup();
+  }
+
+  async cleanup() {
+    /**
+     * When running behind a lambda, we have to await for all the promises that have been added to the global promise tracker
+     * to avoid them being killed by the lambda
+     * @see - https://stackoverflow.com/questions/64688812/running-tasks-in-aws-lambda-background
+     */
+    await globalPromiseTracker.waitForAll();
+  }
+
+  /**
+   *
+   * @returns The main module of the business logic (the one that is passed in the constructor)
+   */
+  /* istanbul ignore next */
+  getAppModule() {
+    return this.appModule;
+  }
+
+  /**
+   *
+   * @returns The global module that is used to bootstrap the app (YalcDefaultAppModule)
+   */
+  getModule() {
+    return this.module;
+  }
+
+  async applyBootstrapGlobals(_options?: ICreateOptions) {
+    this.loggerService = this.getApp().get(SYSTEM_LOGGER_SERVICE);
+    this.loggerService.debug?.('Setting logger service...');
+    this.getApp().useLogger(this.loggerService);
+    Logger.overrideLogger(this.loggerService);
+    return this;
+  }
+}

package/src/app-bootstrap-standalone.helper.ts

@@ -1,67 +1,67 @@
-import { INestApplicationContext } from '@nestjs/common';
-import { NestFactory } from '@nestjs/core';
-// import { GqlExceptionFilter } from '@nestjs/graphql';
-import { FastifyInstance } from 'fastify';
-import { envIsTrue } from '@node-yalc/utils/env.helper.js';
-import clc from 'cli-color';
-import {
-  BaseAppBootstrap,
-  IGlobalOptions,
-} from './app-bootstrap-base.helper.js';
-import { INestCreateOptions } from './app-bootstrap.helper.js';
-import { getEnvLoggerLevels } from '@node-yalc/logger/logger.helper.js';
-
-export class StandaloneAppBootstrap<
-  TGlobalOptions extends IGlobalOptions = IGlobalOptions,
-> extends BaseAppBootstrap<INestApplicationContext> {
-  constructor(appAlias: string, module: any, options?: TGlobalOptions) {
-    super(appAlias, module, { globalsOptions: options });
-  }
-
-  async initApp(options?: {
-    createOptions?: INestCreateOptions;
-    fastifyInstance?: FastifyInstance;
-  }) {
-    await this.createApp({
-      createOptions: options?.createOptions,
-    });
-
-    await this.applyBootstrapGlobals(options?.createOptions);
-
-    await this.getApp().init();
-
-    /* istanbul ignore next */
-    if (envIsTrue(process.env.APP_DRY_RUN) === true) {
-      /* istanbul ignore next */
-      this.loggerService?.log('Dry run, exiting...');
-      /* istanbul ignore next */
-      await this.getApp().close();
-      /* istanbul ignore next */
-      process.exit(0);
-    }
-
-    return this;
-  }
-
-  async createApp(_options?: {
-    createOptions?: INestCreateOptions;
-    fastifyInstance?: FastifyInstance;
-  }) {
-    let app: INestApplicationContext;
-    try {
-      app = await NestFactory.createApplicationContext(this.module, {
-        logger: getEnvLoggerLevels(),
-      });
-    } catch (err) {
-      /* istanbul ignore next */
-      this.closeCleanup();
-      // eslint-disable-next-line no-console
-      /* istanbul ignore next */
-      console.error(clc.red('Failed to create app'), clc.red(err));
-      /* istanbul ignore next */
-      throw new Error('Process aborted');
-    }
-
-    return this.setApp(app);
-  }
-}
+import { INestApplicationContext } from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+// import { GqlExceptionFilter } from '@nestjs/graphql';
+import { FastifyInstance } from 'fastify';
+import { envIsTrue } from '@node-yalc/utils/env.helper.js';
+import clc from 'cli-color';
+import {
+  BaseAppBootstrap,
+  IGlobalOptions,
+} from './app-bootstrap-base.helper.js';
+import { INestCreateOptions } from './app-bootstrap.helper.js';
+import { getEnvLoggerLevels } from '@node-yalc/logger/logger.helper.js';
+
+export class StandaloneAppBootstrap<
+  TGlobalOptions extends IGlobalOptions = IGlobalOptions,
+> extends BaseAppBootstrap<INestApplicationContext> {
+  constructor(appAlias: string, module: any, options?: TGlobalOptions) {
+    super(appAlias, module, { globalsOptions: options });
+  }
+
+  async initApp(options?: {
+    createOptions?: INestCreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }) {
+    await this.createApp({
+      createOptions: options?.createOptions,
+    });
+
+    await this.applyBootstrapGlobals(options?.createOptions);
+
+    await this.getApp().init();
+
+    /* istanbul ignore next */
+    if (envIsTrue(process.env.APP_DRY_RUN) === true) {
+      /* istanbul ignore next */
+      this.loggerService?.log('Dry run, exiting...');
+      /* istanbul ignore next */
+      await this.getApp().close();
+      /* istanbul ignore next */
+      process.exit(0);
+    }
+
+    return this;
+  }
+
+  async createApp(_options?: {
+    createOptions?: INestCreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }) {
+    let app: INestApplicationContext;
+    try {
+      app = await NestFactory.createApplicationContext(this.module, {
+        logger: getEnvLoggerLevels(),
+      });
+    } catch (err) {
+      /* istanbul ignore next */
+      this.closeCleanup();
+      // eslint-disable-next-line no-console
+      /* istanbul ignore next */
+      console.error(clc.red('Failed to create app'), clc.red(err));
+      /* istanbul ignore next */
+      throw new Error('Process aborted');
+    }
+
+    return this.setApp(app);
+  }
+}

package/src/app-bootstrap.helper.js

@@ -127,17 +127,17 @@ export class AppBootstrap extends BaseAppBootstrap {
         apiPrefix = apiPrefix ? `/${apiPrefix}` : '';
         const domain = this.getConf()?.domain || 'localhost';
         await this.getApp().listen(port, host, async (_err, address) => {
-            console.debug(`Server ${this.appAlias} listening on
-        http://localhost:${port}${apiPrefix}/
-        http://127.0.0.1:${port}${apiPrefix}/
-        http://${domain}:${port}${apiPrefix}/
+            console.debug(`Server ${this.appAlias} listening on
+        http://localhost:${port}${apiPrefix}/
+        http://127.0.0.1:${port}${apiPrefix}/
+        http://${domain}:${port}${apiPrefix}/
         ${address}`);
             if (this.isSwaggerEnabled) {
-                console.debug(`Swagger ${this.appAlias} listening on
-        http://localhost:${port}${apiPrefix}/${this.swaggerPath}
-        http://127.0.0.1:${port}${apiPrefix}/${this.swaggerPath}
-        http://${domain}:${port}${apiPrefix}/${this.swaggerPath}
-        ${address}/${this.swaggerPath}
+                console.debug(`Swagger ${this.appAlias} listening on
+        http://localhost:${port}${apiPrefix}/${this.swaggerPath}
+        http://127.0.0.1:${port}${apiPrefix}/${this.swaggerPath}
+        http://${domain}:${port}${apiPrefix}/${this.swaggerPath}
+        ${address}/${this.swaggerPath}
         JSON: http://localhost:${port}${apiPrefix}/${this.swaggerPath}/json`);
             }
             callback?.(port, host, domain);