@rsdk/core 1.0.12 → 2.0.0

package/src/metrics/metadata/types.ts

@@ -1,11 +1,8 @@
 import type { Constructor } from '@rsdk/common';
 
-import type { AnyMetric, MetricMetadata, OmitType } from '../types';
-
-import type { MetricType } from './decorators';
+import type { AnyMetric, MetricMetadata } from '../types';
 
 export type MetricRsdkMetadata = {
-  type: MetricType;
-  metadata: OmitType<MetricMetadata>;
+  metadata: MetricMetadata;
   metricController: Constructor<AnyMetric>;
 };

package/src/metrics/metric.storage.ts

@@ -0,0 +1,10 @@
+import type { Constructor } from '@rsdk/common';
+
+import type { AnyMetric } from './types';
+
+/**
+ * Класс для хранения уже проинициализрованных метрик
+ */
+export class MetricStorage {
+  metrics = new Map<Constructor<AnyMetric>, AnyMetric>();
+}

package/src/metrics/metrics.module.ts

@@ -4,15 +4,15 @@ import type {
   Provider,
 } from '@nestjs/common';
 import { Module } from '@nestjs/common';
-import { AutodocMetadata } from '@rsdk/autodoc-protocol';
 import type { Constructor } from '@rsdk/common';
 import { RsdkMetadata } from '@rsdk/metadata';
 import client from 'prom-client';
 
 import { PlatformConfigModule } from '../config';
 
+import { METRIC_RSDK_METADATA_SCOPE } from './metadata/constants';
 import type { MetricRsdkMetadata } from './metadata';
-import { MetricAutodocResolver, MetricsRegistry } from './metadata';
+import { MetricStorage } from './metric.storage';
 import { MetricsModuleConfig } from './metrics.config';
 import type { AnyMetric, MetricsModuleOptions } from './types';
 
@@ -29,7 +29,13 @@ import type { AnyMetric, MetricsModuleOptions } from './types';
 })
 export class MetricsModule implements OnApplicationBootstrap {
   private static isBootstrapped = false;
-  private static metrics = new Map<Constructor<AnyMetric>, Provider>();
+  // TODO По идее от этого нужно избавиться, но тут нужно будет делать @InjectMetric(SomeMetric) там где сейчас используется someMetric: SomeMetric
+  // Но стоит понимать что смысла в этом нет от слова совсем
+  // Так как даже если там окажутся чужие метрики, но приложение не будет их использовать, то для приложения ничего не произойдёт
+  // Но даже если представить что существует коллизия с использованием одного и того же инстанса, то во-первых
+  // Это дыра в архитектуре потому что мы ссылаемся на один и тот же класс, то рассчитываем получить один и тот же инстанс, а так как это метрика то она должна быть общая на процесс, иначе не имеет смысла
+  // Во-вторых если запускаем n > 1 приложения в одном и том же процессе, то снимать метрики с этих приложений как минимум... странно?
+  // private static metrics = new Map<Constructor<AnyMetric>, Provider>();
 
   constructor(private readonly config: MetricsModuleConfig) {}
 
@@ -40,14 +46,23 @@ export class MetricsModule implements OnApplicationBootstrap {
    */
   static forRoot(options: MetricsModuleOptions): DynamicModule {
     return {
+      global: true,
       controllers: [...options.controllers],
       module: MetricsModule,
+      providers: [
+        {
+          provide: MetricStorage,
+          useValue: new MetricStorage(),
+        },
+      ],
+      exports: [MetricStorage],
     };
   }
 
   /**
    * Use this to inject specified metric into target module
    *
+   * @param first metric classe
    * @param other Not empty List of metric classes
    * @returns dynamic module
    */
@@ -58,43 +73,29 @@ export class MetricsModule implements OnApplicationBootstrap {
     const providers: Provider[] = [];
 
     for (const ctor of [first, ...other]) {
-      const existing = this.metrics.get(ctor);
+      const [resource] =
+        RsdkMetadata.get<MetricRsdkMetadata>(
+          ctor,
+          METRIC_RSDK_METADATA_SCOPE,
+        ) ?? [];
 
-      if (existing) {
-        providers.push(existing);
+      const metadata = resource.value.metadata;
 
-        continue;
-      }
-
-      const metadata = MetricsRegistry.getOne(ctor);
-
-      const provider = {
+      providers.push({
+        inject: [MetricStorage],
         provide: ctor,
-        useValue: new ctor(metadata),
-      };
+        useFactory: (metricStorage: MetricStorage) => {
+          const existing =
+            metricStorage.metrics.get(ctor) ?? new ctor(metadata);
 
-      const rsdkMetadata = new RsdkMetadata<MetricRsdkMetadata>(
-        provider,
-        'metrics',
-      );
-
-      rsdkMetadata.add({
-        type: metadata.type,
-        metricController: ctor,
-        metadata,
+          metricStorage.metrics.set(ctor, existing);
+          return existing;
+        },
       });
-
-      const autodocMetadata = new AutodocMetadata(rsdkMetadata);
-
-      const metricsDocumentResolver = new MetricAutodocResolver(rsdkMetadata);
-
-      autodocMetadata.defineResolver(metricsDocumentResolver);
-      providers.push(provider);
     }
 
     return {
       module: MetricsModule,
-
       exports: providers,
       providers,
     };

package/src/platform.context.ts

@@ -4,18 +4,19 @@ import type { NestApplicationOptions } from '@nestjs/common/interfaces/nest-appl
 import type { AbstractHttpAdapter } from '@nestjs/core';
 import type { Constructor } from '@rsdk/common';
 import { LoggerFactory } from '@rsdk/logging';
+import type { RsdkMetadataProvider } from '@rsdk/metadata';
 import { groupBy, intersection } from 'lodash';
 
+import { ConfigMetadataProvider } from './config/metadata/config-metadata.provider';
 import { Manifest } from './manifest/manifest';
 import type { Config, SectionMetadata } from './config';
-import { ConfigMetadataRegistry, PlatformConfigModule } from './config';
+import { ContextAggregator } from './context.aggregator';
 import {
   DuplicateProtocolException,
   NoMatchingTransportException,
 } from './exceptions';
 import { NestLoggerAdapter } from './logging';
 import { NoopHttpAdapter } from './noop.http-adapter';
-import { PlatformModule } from './platform.module';
 import type {
   IHttpTransport,
   IMicroserviceTransport,
@@ -39,8 +40,8 @@ export class PlatformContext {
   private microservices: Map<INestMicroservice, IMicroserviceTransport>;
   private readonly httpTransport: IHttpTransport | undefined;
   private readonly httpAdapter: AbstractHttpAdapter;
+  private aggregator: ContextAggregator;
   private _extendedOptions: PlatformExtendedOptions;
-  private _root: DynamicModule;
 
   /**
    * Создаёт контекст проводя базовые проверки
@@ -57,18 +58,7 @@ export class PlatformContext {
     this.httpTransport = options.transports?.find?.(isHttpTransport);
     this.httpAdapter =
       this.httpTransport?.getAdapter() ?? new NoopHttpAdapter();
-  }
-
-  get root(): DynamicModule {
-    if (this._root) {
-      return this._root;
-    }
-    PlatformConfigModule.bootstrap({
-      ...(this.extendedOptions.config ?? {}),
-      appName: this.extendedOptions.name,
-    });
-    this._root = PlatformModule.forRoot(this.extendedOptions);
-    return this._root;
+    this.aggregator = new ContextAggregator(this);
   }
 
   get extendedOptions(): PlatformExtendedOptions {
@@ -116,12 +106,29 @@ export class PlatformContext {
     }
   }
 
+  async getRsdkMetadataProvider(): Promise<RsdkMetadataProvider> {
+    const aggregated = await this.aggregator.getAggregated();
+
+    return aggregated.rsdkMetadataProvider;
+  }
+
+  async getRoot(): Promise<DynamicModule> {
+    const { root } = await this.aggregator.getAggregated();
+
+    return root;
+  }
+
   /**
    * Get all important information about PlatformApp instance
    * @returns Readonly metadata
    */
-  getMetadata(): Readonly<PlatformAppMetadata> {
-    const confMetadata = ConfigMetadataRegistry.getMetadata();
+  async getMetadata(): Promise<Readonly<PlatformAppMetadata>> {
+    const rsdkMetadataProvider = await this.getRsdkMetadataProvider();
+
+    const confMetadata = new ConfigMetadataProvider(
+      rsdkMetadataProvider,
+    ).getMetadata();
+
     const options = this.extendedOptions;
     const protocols = (options?.transports ?? []).map((x) => x.getProtocol());
 
@@ -157,7 +164,9 @@ export class PlatformContext {
    * Производит все необходимые проверки и инициализации транспортов, не запускает приложение
    */
   async configureApp(app: INestApplication): Promise<void> {
-    const awaiter = this.httpTransport?.configure(app);
+    const configContext = await this.aggregator.getConfigContext();
+
+    const awaiter = this.httpTransport?.configure(app, configContext);
     if (awaiter instanceof Promise) {
       await awaiter;
     }
@@ -169,7 +178,7 @@ export class PlatformContext {
     const transports = this.options.transports ?? ([] as any[]);
 
     for (const transport of transports.filter(isMicroserviceTransport)) {
-      transport.init();
+      transport.init(configContext);
 
       const options = transport.createMicroserviceOptions();
       const microservice = app.connectMicroservice(options, {
@@ -186,9 +195,12 @@ export class PlatformContext {
    */
   async runConfiguredApplication(app: INestApplication): Promise<void> {
     try {
+      const configContext = await this.aggregator.getConfigContext();
+
       this.logger.info('Mapping controllers...');
       if (this.httpTransport) {
-        const { host, port } = this.httpTransport.createHttpOptions();
+        const { host, port } =
+          this.httpTransport.createHttpOptions(configContext);
 
         await app.listen(port, host, () =>
           this.logger.info(`Http server started on ${host}:${port}`),

package/src/platform.module.ts

@@ -1,6 +1,6 @@
-import type { DynamicModule } from '@nestjs/common';
-import { Module } from '@nestjs/common';
-import type { MiddlewareConsumer, NestModule } from '@nestjs/common/interfaces';
+import type { DynamicModule, NestModule } from '@nestjs/common';
+import { Inject, Module } from '@nestjs/common';
+import type { MiddlewareConsumer } from '@nestjs/common/interfaces';
 import type { Constructor } from '@rsdk/common';
 
 import { PlatformPluginModule } from './plugin/plugin.module';
@@ -10,29 +10,25 @@ import { PlatformConfigModule } from './config';
 import { SequenceException } from './exceptions';
 import { LoggingModule } from './logging';
 import { TracingModule } from './tracing';
-import type { PlatformExtendedOptions } from './types';
+import { PlatformExtendedOptions } from './types';
 
 @Module({})
 export class PlatformModule implements NestModule {
-  private static options: PlatformExtendedOptions;
+  constructor(
+    @Inject('PlatformExtendedOptions') private options: PlatformExtendedOptions,
+  ) {}
 
   static forRoot(options: PlatformExtendedOptions): DynamicModule {
-    if (this.options) {
-      throw new SequenceException(
-        "Can't call PlatformModule.setup() method twice",
-      );
-    }
-    this.options = options;
-
     const imports: (DynamicModule | Constructor)[] = [
       // Plugins
       PlatformPluginModule.forOptions(options),
 
       // Infrastructure
       AppMetadataModule.forRoot(options),
-      LoggingModule.forRoot(),
       PlatformConfigModule.forRoot(options),
       TracingModule.forRoot({ appName: options.name, processing: 'simple' }),
+      LoggingModule.pureRoot(),
+      ...(options.modules ?? []),
     ];
 
     // Adding transport module if needed
@@ -40,25 +36,27 @@ export class PlatformModule implements NestModule {
       imports.push(PlatformTransportModule.forOptions(options));
     }
 
-    // Adding application level modules
-    if (options.modules) {
-      imports.push(...options.modules);
-    }
-
     return {
       module: PlatformModule,
       imports,
+      providers: [
+        {
+          provide: 'PlatformExtendedOptions',
+          useValue: options,
+        },
+      ],
+      exports: ['PlatformExtendedOptions'],
     };
   }
 
   configure(consumer: MiddlewareConsumer): void {
-    if (!PlatformModule.options) {
+    if (!this.options) {
       throw new SequenceException(
         'Should call PlatformModule.setup() before configuring middleware!',
       );
     }
 
-    for (const plugin of PlatformModule.options.plugins || []) {
+    for (const plugin of this.options.plugins || []) {
       plugin?.configureMiddleware?.(consumer);
     }
   }

package/src/rsdk-metadata/constants.ts

@@ -0,0 +1,5 @@
+import type { NestModuleDefinition } from '@rsdk/common';
+
+export const PLATFORM_RAW_GLOBAL_METADATA_SCOPE =
+  'PLATFORM_RAW_GLOBAL_RSDK_METADATA_SCOPE';
+export type PlatformRawGlobalMetadata = NestModuleDefinition;

package/src/rsdk-metadata/rsdk-metadata.global-module.ts

@@ -0,0 +1,34 @@
+import type { DynamicModule } from '@nestjs/common';
+import { LoggerFactory } from '@rsdk/logging';
+import { RsdkMetadataProvider } from '@rsdk/metadata';
+import type { NestModuleDefinition } from '@rsdk/nest-tools/dist/nest-definition';
+
+import type { PlatformRawGlobalMetadata } from './constants';
+import { PLATFORM_RAW_GLOBAL_METADATA_SCOPE } from './constants';
+
+export class RsdkMetadataGlobalModule {
+  static logger = LoggerFactory.create(RsdkMetadataGlobalModule);
+  static async raw(rootModule: NestModuleDefinition): Promise<DynamicModule> {
+    const rsdkMetadataProvider = await RsdkMetadataProvider.create(rootModule);
+    const resources = rsdkMetadataProvider.get<PlatformRawGlobalMetadata>(
+      PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+    );
+    const imports = resources.map(({ value }) => value);
+
+    RsdkMetadataGlobalModule.logger.debug('extracted imports: ', {
+      imports,
+    });
+    return {
+      global: true,
+      imports,
+      module: RsdkMetadataGlobalModule,
+      providers: [
+        {
+          provide: RsdkMetadataProvider,
+          useValue: rsdkMetadataProvider,
+        },
+      ],
+      exports: [...imports, RsdkMetadataProvider],
+    };
+  }
+}

package/src/transport/transport.module.ts

@@ -1,9 +1,10 @@
 import type { DynamicModule } from '@nestjs/common';
+import type { NestModuleDefinition } from '@rsdk/common';
 import { flatten } from 'lodash';
 
 import type { IErrorsFormatter, IErrorsSender } from '../exceptions.handling';
 import { GlobalExceptionsModule } from '../exceptions.handling';
-import { HealthModule } from '../health';
+import { HealthModule } from '../health/health.module';
 import { MetricsModule } from '../metrics';
 import type { PlatformExtendedOptions } from '../types';
 import { isPrimaryTransport } from '../types';
@@ -15,11 +16,22 @@ export class PlatformTransportModule {
         PlatformTransportModule.initHealthchecks(options),
         PlatformTransportModule.initMetrics(options),
         PlatformTransportModule.initExceptionsHandling(options),
+        ...PlatformTransportModule.getTransportModules(options),
       ],
       module: PlatformTransportModule,
     };
   }
 
+  private static getTransportModules(
+    options: PlatformExtendedOptions,
+  ): NestModuleDefinition[] {
+    return (
+      options?.transports?.flatMap?.((transport) => {
+        return transport.modules?.() ?? [];
+      }) ?? []
+    );
+  }
+
   private static initMetrics(options: PlatformExtendedOptions): DynamicModule {
     const transports = options.transports ?? ([] as any[]);
 

package/src/types/context-aggregated.ts

@@ -0,0 +1,10 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { RsdkMetadataProvider } from '@rsdk/metadata';
+
+import type { ConfigContext } from '../config';
+
+export type ContextAggregated = {
+  rsdkMetadataProvider: RsdkMetadataProvider;
+  root: DynamicModule;
+  configContext: ConfigContext;
+};

package/src/types/options.ts

@@ -1,5 +1,4 @@
-import type { DynamicModule } from '@nestjs/common';
-import type { Constructor, RequiredFields } from '@rsdk/common';
+import type { NestModuleDefinition, RequiredFields } from '@rsdk/common';
 
 import type { ConfigModuleOptions } from '../config';
 
@@ -9,8 +8,10 @@ import type { IPrimaryTransport, ITransport } from './transports';
 /**
  * Not empty collection of modules
  */
-type Module = DynamicModule | Constructor;
-type Modules = [Module, ...Module[]];
+export type NestModuleDefinitions = [
+  NestModuleDefinition,
+  ...NestModuleDefinition[],
+];
 
 export interface ManifestData {
   /**
@@ -54,7 +55,7 @@ export interface PlatformOptions extends PlatformManifestPathOptions {
    * via APP_GUARD or APP_INTERCEPTOR in one of your modules, they
    * will be applied **inside** of internal global middleware.
    */
-  modules?: Modules;
+  modules?: NestModuleDefinitions;
 
   /**
    * Configuration options

package/src/types/transports.ts

@@ -3,12 +3,15 @@ import type { AbstractHttpAdapter } from '@nestjs/core';
 import type { MicroserviceOptions } from '@nestjs/microservices';
 import type { Constructor } from '@rsdk/common';
 
+import type { ConfigContext } from '../config';
 import type {
   IErrorsFormatter,
   IErrorsSender,
   IErrorsTransformer,
 } from '../exceptions.handling';
 
+import type { NestModuleDefinitions } from './options';
+
 /**
  * Base functionality of HTTP or microservice transport
  */
@@ -32,6 +35,11 @@ export interface ITransport {
    * @returns sending error algorithm
    */
   getErrorsSender?(): IErrorsSender;
+
+  /**
+   * Modules for register metrics, healthchecks, configs and supporting tools, such as clients
+   */
+  modules?(): NestModuleDefinitions;
 }
 
 /**
@@ -60,7 +68,7 @@ export interface IMicroserviceTransport extends ITransport {
    * Should be called before passing options
    * to app.connectMicroservice()
    */
-  init(): void;
+  init(configContext: ConfigContext): void;
 
   /**
    * Additional logic that will be ran after
@@ -92,9 +100,13 @@ export interface IHttpTransport extends IPrimaryTransport {
    * Applies any configuration to Nest application instance:
    * middleware, body parsers and other.
    * @param app INestApplication
+   * @param configContext
    */
-  configure(app: INestApplication): Promise<void> | void;
-  createHttpOptions(): HttpOptions;
+  configure(
+    app: INestApplication,
+    configContext: ConfigContext,
+  ): Promise<void> | void;
+  createHttpOptions(configContext: ConfigContext): HttpOptions;
 }
 
 export const isPrimaryTransport = (t: ITransport): t is IPrimaryTransport =>

package/src/unhandled-rejection.handler.ts

@@ -0,0 +1,29 @@
+import { text } from '@rsdk/common';
+import { LoggerFactory } from '@rsdk/logging';
+
+const logger = LoggerFactory.create('PlatformContext');
+
+logger.info('Registering unhandled rejections handler...');
+
+// This code enriches output if unhandled exceptions happen
+process.on('unhandledRejection', (reason: any, promise) => {
+  logger.error(
+    text`
+        Unhandled promise rejection happened! Process is shutting down
+        with exit code 1. See: https://github.com/nodejs/node/issues/20392
+        and https://nodejs.org/api/process.html#event-unhandledrejection
+      `,
+    { promise, reason },
+  );
+
+  /**
+   * Additionally writes to standard console, because both <promise> and <reason>
+   * can be not serializable
+   */
+  console.error('Found unhandled rejection', {
+    promise,
+    reason,
+  });
+
+  process.exit(1);
+});

package/dist/health/index.d.ts

@@ -1,7 +0,0 @@
-export * from './health.module';
-export * from './health.service';
-export * from './indicators.abstract';
-export * from './metadata/indicator.decorator';
-export * from './types';
-export * from './helpers';
-export { IndicatorAutodoc as IndicatorAutodocResolver } from './autodoc/heath.autodoc-resolver';

package/dist/health/index.js

@@ -1,26 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndicatorAutodocResolver = void 0;
-__exportStar(require("./health.module"), exports);
-__exportStar(require("./health.service"), exports);
-__exportStar(require("./indicators.abstract"), exports);
-__exportStar(require("./metadata/indicator.decorator"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./helpers"), exports);
-var heath_autodoc_resolver_1 = require("./autodoc/heath.autodoc-resolver");
-Object.defineProperty(exports, "IndicatorAutodocResolver", { enumerable: true, get: function () { return heath_autodoc_resolver_1.IndicatorAutodoc; } });
-//# sourceMappingURL=index.js.map

package/dist/health/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/health/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,wDAAsC;AACtC,iEAA+C;AAC/C,0CAAwB;AACxB,4CAA0B;AAC1B,2EAAgG;AAAvF,kIAAA,gBAAgB,OAA4B"}

package/dist/health/metadata/index.d.ts

@@ -1,2 +0,0 @@
-export * from './indicator.decorator';
-export * from './indicators.registry';

package/dist/health/metadata/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./indicator.decorator"), exports);
-__exportStar(require("./indicators.registry"), exports);
-//# sourceMappingURL=index.js.map

package/dist/health/metadata/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/health/metadata/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC"}

package/src/health/index.ts

@@ -1,7 +0,0 @@
-export * from './health.module';
-export * from './health.service';
-export * from './indicators.abstract';
-export * from './metadata/indicator.decorator';
-export * from './types';
-export * from './helpers';
-export { IndicatorAutodoc as IndicatorAutodocResolver } from './autodoc/heath.autodoc-resolver';

package/src/health/metadata/index.ts

@@ -1,2 +0,0 @@
-export * from './indicator.decorator';
-export * from './indicators.registry';