Refactor starter kit (part 1)

.eslintrc.cjs

@@ -1,49 +1,4 @@
 module.exports = {
-  parser: '@typescript-eslint/parser',
-  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
-  parserOptions: {
-    project: 'tsconfig.dev.json',
-    sourceType: 'module',
-  },
-  plugins: ['@typescript-eslint/eslint-plugin'],
   root: true,
-  env: {
-    node: true,
-    jest: true,
-  },
-  rules: {
-    'prettier/prettier': ['error', { singleQuote: true, trailingComma: 'all' }],
-  },
-  ignorePatterns: [
-    '**/node_modules',
-    '**/*spec.ts',
-    '**/__tests__',
-    '**/__mocks__',
-    '**/jest.config.ts',
-    'var',
-  ],
-  overrides: [
-    {
-      files: ['**/*.cjs', '**/*.mjs', '**/*.js'],
-      extends: ['eslint:recommended', 'plugin:prettier/recommended'],
-    },
-    {
-      files: ['**/*.ts'],
-      extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/recommended',
-        'plugin:prettier/recommended',
-      ],
-      rules: {
-        '@typescript-eslint/interface-name-prefix': 'off',
-        '@typescript-eslint/explicit-function-return-type': 'off',
-        '@typescript-eslint/explicit-module-boundary-types': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/no-floating-promises': ['warn'],
-        'no-console': 'error',
-        '@typescript-eslint/no-unused-vars': 'off',
-        eqeqeq: 1,
-      },
-    },
-  ],
+  extends: ['eslint-config-yalc'],
 };

.eslintrc.vscode.cjs

@@ -1,23 +1,4 @@
 module.exports = {
-  extends: ['./.eslintrc.cjs'],
-  parserOptions: {
-    // by disabling the type-checking feature we exponentially increase the speed of the linting process
-    // while editing the code in the VSCode
-    // NOTE: this doesn't affect the lint command that is executed in the CI/CD pipeline
-    project: false,
-    EXPERIMENTAL_useProjectService: false,
-  },
-  overrides: [
-    {
-      files: ['**/*.ts'],
-      rules: {
-        /**
-         * The following rules do not work when the parserOptions.project is set to false.
-         * Because of missing type-checking feature
-         */
-        '@typescript-eslint/no-floating-promises': 'off',
-        '@typescript-eslint/naming-convention': 'off',
-      },
-    },
-  ],
+  root: true,
+  extends: ['eslint-config-yalc-vscode'],
 };

.github/actions/test/action.yml

@@ -32,3 +32,10 @@ runs:
       run: |
         export JEST_WORKERS=${{ inputs.jest-workers }}
         npm run test:cov
+
+    - name: Test platform-kit
+      shell: bash
+      working-directory: ${{ github.workspace }}/${{ inputs.working-directory }}/platform-kit
+      run: |
+        export JEST_WORKERS=${{ inputs.jest-workers }}
+        npm run ci:checks -- --only=test:apps:e2e

.vscode/settings.json

@@ -1,16 +1,17 @@
 {
   "editor.formatOnSave": true,
+  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
   "[typescript]": {
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   },
   "[jsonc]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+    "editor.defaultFormatter": "vscode.json-language-features"
   },
   "[yaml]": {
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   },
   "[json]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+    "editor.defaultFormatter": "vscode.json-language-features"
   },
   "[html]": {
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"
@@ -22,9 +23,15 @@
   "jest.runMode": "on-demand",
   "jest.jestCommandLine": "npm run test:vscode --",
   "jest.coverageFormatter": "DefaultFormatter",
+  "eslint.validate": [
+    "javascript",
+    "typescript"
+  ],
   "eslint.format.enable": true,
+  "eslint.codeActionsOnSave.mode": "problems",
+  "eslint.enable": true,
   "eslint.options": {
     "overrideConfigFile": ".eslintrc.vscode.cjs",
     "ignore": false
   },
-}
+}

api-strategy/package.json

@@ -4,6 +4,11 @@
   "type": "module",
   "description": "",
   "main": "src/index.ts",
+  "custom": {
+    "nest": {
+      "type": "library"
+    }
+  },
   "exports": {
     ".": "./src/index.ts",
     "./*.js": "./src/*.ts",

api-strategy/src/strategies/http-abstract-call.strategy.ts

@@ -22,11 +22,18 @@ export interface HttpOptions<
   parameters?: TParams;
 }
 
-export interface IHttpCallStrategyResponse<T = any> {
+export interface IHttpCallStrategyResponse<T = any, THeaders = any> {
   data: T;
   status: number;
   statusText: string;
+  /**
+   * This are the headers transformed to be compatible with the standard OutgoingHttpHeaders
+   */
   headers: OutgoingHttpHeaders;
+  /**
+   * This are the headers as they are returned by the http library used
+   */
+  rawHeaders: THeaders;
   // config: AxiosRequestConfig<D>;
   request?: any;
 }

api-strategy/src/strategies/nest-http-call.strategy.ts

@@ -6,9 +6,10 @@
   HttpOptions,
   IHttpCallStrategyOptions,
 } from './http-abstract-call.strategy.js';
-import { AxiosRequestConfig } from 'axios';
+import { AxiosHeaders, AxiosRequestConfig, AxiosResponse } from 'axios';
 import { YalcGlobalClsService } from '@nestjs-yalc/app/cls.module.js';
 import { filterHeaders } from '../header-whitelist.helper.js';
+import { OutgoingHttpHeaders } from 'http';
 
 export class NestHttpCallStrategy extends HttpAbstractStrategy {
   constructor(
@@ -23,7 +24,7 @@
   async call<TOptData, TParams extends Record<string, any>, TResData>(
     path: string,
     options?: HttpOptions<TOptData, TParams>,
-  ): Promise<IHttpCallStrategyResponse<TResData>> {
+  ): Promise<IHttpCallStrategyResponse<TResData, AxiosResponse['headers']>> {
     const clsHeaders = filterHeaders(
       this.clsService.get('headers'),
       this.options.headersWhitelist,
@@ -51,18 +52,32 @@
       _options.params = new URLSearchParams(options.parameters);
     }
 
-    const { data, ...res } = await this.httpService.axiosRef.request({
-      headers: _options?.headers as any,
-      method: _options?.method,
-      signal: _options?.signal,
-      data: _options?.data,
-      params: _options?.params,
-      url: `${this.baseUrl}${path}`,
-    });
+    const { headers: axiosHeaders, ...res } =
+      await this.httpService.axiosRef.request({
+        headers: _options?.headers as any,
+        method: _options?.method,
+        signal: _options?.signal,
+        data: _options?.data,
+        params: _options?.params,
+        url: `${this.baseUrl}${path}`,
+      });
+
+    const outgoingHeaders = Object.entries(axiosHeaders).reduce(
+      (acc, [k, v]) => {
+        if (v instanceof AxiosHeaders) {
+          v = v.toJSON();
+        }
+
+        acc[k] = v;
+        return acc;
+      },
+      {} as OutgoingHttpHeaders,
+    );
 
     return {
       ...res,
-      data,
+      headers: outgoingHeaders,
+      rawHeaders: axiosHeaders,
     };
   }
 }

api-strategy/src/strategies/nest-local-call.strategy.ts

@@ -80,6 +80,7 @@ export class NestLocalCallStrategy extends HttpAbstractStrategy {
     return {
       data,
       headers: result.headers,
+      rawHeaders: result.headers,
       status: result.statusCode,
       statusText: result.statusMessage,
       request: result.payload, // TODO: double check if it's the correct value

app/package.json

@@ -4,6 +4,11 @@
   "type": "module",
   "description": "",
   "main": "src/index.ts",
+  "custom": {
+    "nest": {
+      "type": "library"
+    }
+  },
   "exports": {
     ".": "./src/index.ts",
     "./*.js": "./src/*.ts",

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

@@ -12,6 +12,7 @@ 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 { getAppConfigToken } from './app-config.service.js';
 import { EventModule } from '@nestjs-yalc/event-manager/event.module.js';
 import { LoggerServiceFactory } from '@nestjs-yalc/logger/logger.service.js';
 import { FastifyInstance } from 'fastify';
@@ -66,7 +67,9 @@ export abstract class BaseAppBootstrap<
   }
 
   getConf() {
-    const configService = this.getApp().get<ConfigService>(ConfigService);
+    const configService = this.getApp().get<ConfigService>(
+      getAppConfigToken(this.appAlias),
+    );
     return configService.get<IServiceConf>(this.appAlias);
   }
 

app/src/app-bootstrap.helper.ts

@@ -192,11 +192,12 @@ export class AppBootstrap<
   async listen(callback?: {
     (port: number, host: string, domain: string): void;
   }) {
-    const port = this.getConf()?.port || 0;
-    const host = this.getConf()?.host || '0.0.0.0';
-    let apiPrefix = this.getConf()?.apiPrefix;
+    const conf = this.getConf();
+    const port = conf?.port || 0;
+    const host = conf?.host || '0.0.0.0';
+    let apiPrefix = conf?.apiPrefix;
     apiPrefix = apiPrefix ? `/${apiPrefix}` : '';
-    const domain = this.getConf()?.domain || 'localhost';
+    const domain = conf?.domain || 'localhost';
     await this.getApp().listen(port, host, async (_err, address) => {
       // eslint-disable-next-line no-console
       console.debug(`Server ${this.appAlias} listening on
@@ -205,11 +206,12 @@ export class AppBootstrap<
         http://${domain}:${port}${apiPrefix}/
         ${address}`);
 
-      // // eslint-disable-next-line no-console
-      // console.debug(`GraphQL ${this.appAlias} listening on
-      //   http://localhost:${port}${apiPrefix}/graphql
-      //   http://127.0.0.1:${port}${apiPrefix}/graphql
-      //   http://${domain}:${port}${apiPrefix}/graphql`);
+      // eslint-disable-next-line no-console
+      console.debug(`GraphQL ${this.appAlias} listening on
+        http://localhost:${port}${apiPrefix}/graphql
+        http://127.0.0.1:${port}${apiPrefix}/graphql
+        http://${domain}:${port}${apiPrefix}/graphql
+        ${address}/graphql`);
 
       if (this.isSwaggerEnabled) {
         // eslint-disable-next-line no-console

app/src/app-imports.factory.ts

@@ -22,14 +22,12 @@
 import { JwtModule } from '@nestjs/jwt';
 import { EventEmitter2, EventEmitterModule } from '@nestjs/event-emitter';
 import { IServiceConf } from './conf.type.js';
-import { GraphQLError } from 'graphql/error';
 import { GraphQLFormattedError } from 'graphql/error';
 // import { AppLoggerModule } from '@nestjs-yalc/logger/app-logger.module.js';
 import { TypeORMLogger } from '@nestjs-yalc/logger/typeorm-logger.js';
 import { CURAPP_CONF_ALIAS } from './def.const.js';
 import { AppEvents } from './app.events.js';
 import { GqlComplexityPlugin } from '@nestjs-yalc/graphql/plugins/gql-complexity.plugin.js';
-import { ApolloServerPlugin } from 'apollo-server-plugin-base';
 import { ClassType } from '@nestjs-yalc/types/globals.d.js';
 import { isClass } from '@nestjs-yalc/utils/class.helper.js';
 import {
@@ -38,6 +36,7 @@
 } from '@nestjs/apollo';
 
 import * as dotenv from 'dotenv';
+import { ApolloServerPlugin } from '@apollo/server';
 dotenv.config(); // preload .env root file before all the others
 
 export interface IAppImportsFactory {
@@ -166,7 +165,7 @@
       GraphQLModule.forRootAsync<ApolloFederationDriverConfig>({
         driver: ApolloFederationDriver,
         imports: [ApolloPluginsModule.forRoot()],
         useFactory: async (
           configService: ConfigService,
           appContext: AppContextService,
           eventEmitter: EventEmitter2,
@@ -218,13 +217,14 @@
             useGlobalPrefix: true,
             // Makes sure not too much info. is revealed when reporting errors in non-dev stages
             // @url: https://github.com/nestjs/graphql/issues/1053#issuecomment-740739410
-            formatError: (error: GraphQLError) => {
-              const exception: any = error.extensions?.exception;
-              const message = exception?.response?.message || error.message;
+            formatError: (formattedError: GraphQLFormattedError, error) => {
+              const exception: any = formattedError.extensions?.exception;
+              const message =
+                exception?.response?.message || formattedError.message;
 
               if (conf && (conf.isDev || conf.isTest)) {
                 return {
-                  ...error,
+                  ...formattedError,
                   message, // override the message with meaningful info
                 };
               }
@@ -233,9 +233,9 @@
               const productionError: GraphQLFormattedError = {
                 message,
                 extensions: {
-                  path: error.path,
-                  code: error.extensions?.code,
-                  exception: error.originalError, // error without stacktrace
+                  path: formattedError.path,
+                  code: formattedError.extensions?.code,
+                  exception: error, // error without stacktrace
                 },
               };