@rsdk/core 4.0.0-next.14 → 4.0.0-next.15

package/dist/types/transports.d.ts

@@ -1,3 +1,4 @@
+import type { ArgumentsHost } from '@nestjs/common';
 import type { Controller, INestApplication } from '@nestjs/common/interfaces';
 import type { AbstractHttpAdapter } from '@nestjs/core';
 import type { MicroserviceOptions } from '@nestjs/microservices';
@@ -13,6 +14,17 @@ export interface ITransport {
      * @returns protocol in text format
      */
     getProtocol(): string;
+    /**
+     * Detect is it context of this transport
+     * !!! Do NOT check on getType() === 'rpc', this type corresponds to all microservices
+     *
+     * @param {ArgumentsHost} ctx
+     * @returns {boolean}
+     * @example
+     * return ctx.getType() === 'http'
+     * return ctx.getArgByIndex(1) instanceof MyTransportContext
+     */
+    matchByContext(ctx: ArgumentsHost): boolean;
     /**
      * @returns error formatting algorithm
      */

package/dist/types/transports.js.map

@@ -1 +1 @@
-{"version":3,"file":"transports.js","sourceRoot":"","sources":["../../src/types/transports.ts"],"names":[],"mappings":";;;AA8GO,MAAM,kBAAkB,GAAG,CAAC,CAAa,EAA0B,EAAE,CAC1E,OAAQ,CAAuB,CAAC,mBAAmB,KAAK,UAAU;IAClE,OAAQ,CAAuB,CAAC,oBAAoB,KAAK,UAAU,CAAC;AAFzD,QAAA,kBAAkB,sBAEuC;AAE/D,MAAM,eAAe,GAAG,CAAC,CAAa,EAAuB,EAAE,CACpE,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;AADhB,QAAA,eAAe,mBACC;AAEtB,MAAM,uBAAuB,GAAG,CACrC,CAAa,EACgB,EAAE,CAC/B,OAAQ,CAA4B,CAAC,yBAAyB,KAAK,UAAU,CAAC;AAHnE,QAAA,uBAAuB,2BAG4C"}
+{"version":3,"file":"transports.js","sourceRoot":"","sources":["../../src/types/transports.ts"],"names":[],"mappings":";;;AA6HO,MAAM,kBAAkB,GAAG,CAAC,CAAa,EAA0B,EAAE,CAC1E,OAAQ,CAAuB,CAAC,mBAAmB,KAAK,UAAU;IAClE,OAAQ,CAAuB,CAAC,oBAAoB,KAAK,UAAU,CAAC;AAFzD,QAAA,kBAAkB,sBAEuC;AAE/D,MAAM,eAAe,GAAG,CAAC,CAAa,EAAuB,EAAE,CACpE,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;AADhB,QAAA,eAAe,mBACC;AAEtB,MAAM,uBAAuB,GAAG,CACrC,CAAa,EACgB,EAAE,CAC/B,OAAQ,CAA4B,CAAC,yBAAyB,KAAK,UAAU,CAAC;AAHnE,QAAA,uBAAuB,2BAG4C"}

package/dist/unhandled-rejection.handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"unhandled-rejection.handler.js","sourceRoot":"","sources":["../src/unhandled-rejection.handler.ts"],"names":[],"mappings":";;AAAA,yCAAoC;AACpC,2CAA8C;AAE9C,MAAM,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAEvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;IAC9B,MAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;CAC5D;AAED,2DAA2D;AAC3D,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,MAAW,EAAE,OAAO,EAAE,EAAE;IACxD,MAAM,CAAC,KAAK,CACV,IAAA,aAAI,EAAA;;;;OAID,EACH,EAAE,OAAO,EAAE,MAAM,EAAE,CACpB,CAAC;IAEF;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE;QACzC,OAAO;QACP,MAAM;KACP,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"unhandled-rejection.handler.js","sourceRoot":"","sources":["../src/unhandled-rejection.handler.ts"],"names":[],"mappings":";;AAAA,yCAAoC;AACpC,2CAA8C;AAE9C,MAAM,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAEvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;IAC/B,MAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;AAC7D,CAAC;AAED,2DAA2D;AAC3D,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,MAAW,EAAE,OAAO,EAAE,EAAE;IACxD,MAAM,CAAC,KAAK,CACV,IAAA,aAAI,EAAA;;;;OAID,EACH,EAAE,OAAO,EAAE,MAAM,EAAE,CACpB,CAAC;IAEF;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE;QACzC,OAAO;QACP,MAAM;KACP,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/core",
-  "version": "4.0.0-next.14",
+  "version": "4.0.0-next.15",
   "description": "Nestjs based microservice chassis",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -20,9 +20,9 @@
     "@opentelemetry/exporter-trace-otlp-http": "0.39.1",
     "@opentelemetry/propagator-b3": "1.13.0",
     "@opentelemetry/resources": "1.13.0",
-    "@opentelemetry/sdk-node": "^0.39.1",
+    "@opentelemetry/sdk-node": "0.39.1",
     "@opentelemetry/sdk-trace-base": "1.13.0",
-    "@opentelemetry/semantic-conventions": "1.13.0",
+    "@opentelemetry/semantic-conventions": "1.18.1",
     "dotenv": "^16.3.1",
     "lodash": "^4.17.21",
     "prom-client": "^14.2.0"
@@ -31,18 +31,18 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/microservices": "^10.0.0",
-    "@rsdk/autodoc.protocol": "^4.0.0-next.14",
-    "@rsdk/common": "^4.0.0-next.14",
-    "@rsdk/common.nestjs": "^4.0.0-next.14",
-    "@rsdk/common.node": "^4.0.0-next.14",
-    "@rsdk/decorators": "^4.0.0-next.14",
-    "@rsdk/logging": "^4.0.0-next.14",
-    "@rsdk/metadata": "^4.0.0-next.14",
-    "@rsdk/nest-tools": "^4.0.0-next.14",
+    "@rsdk/autodoc.protocol": "^4.0.0-next.15",
+    "@rsdk/common": "^4.0.0-next.15",
+    "@rsdk/common.nestjs": "^4.0.0-next.15",
+    "@rsdk/common.node": "^4.0.0-next.15",
+    "@rsdk/decorators": "^4.0.0-next.15",
+    "@rsdk/logging": "^4.0.0-next.15",
+    "@rsdk/metadata": "^4.0.0-next.15",
+    "@rsdk/nest-tools": "^4.0.0-next.15",
     "axios": "^1.1.3",
     "pino": "^8.16.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.0.0"
   },
-  "gitHead": "567e6d331c4caa6fdadbe0329f91c471b877f7a4"
+  "gitHead": "8abd89d7800375749b024410dc3465ff40389277"
 }

package/src/config/reload/config-reload.events.ts

@@ -11,23 +11,32 @@ export class ReloadEvents extends EventEmitter {}
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
 export declare interface ReloadEvents {
   on(e: 'reload', fn: (source: ConfigSource, values: RawValues) => void): this;
+
   on(
     e: 'reload_failure',
     fn: (source: ConfigSource, err: ConfigSourceException) => void,
   ): this;
+
   on(e: 'merge', fn: (source: ConfigSource, changes: Changes) => void): this;
+
   on(e: 'update', fn: (section: Config, keys: string[]) => void): this;
+
   on(
     e: 'update_failure',
     fn: (section: Config, err: PropertyException) => void,
   ): this;
+
   emit(e: 'reload', source: ConfigSource, values: RawValues): boolean;
+
   emit(
     e: 'reload_failure',
     source: ConfigSource,
     err: ConfigSourceException,
   ): boolean;
+
   emit(e: 'merge', source: ConfigSource, changes: Changes): boolean;
+
   emit(e: 'update', section: Config, keys: string[]): boolean;
+
   emit(e: 'update_failure', section: Config, err: PropertyException): boolean;
 }

package/src/config/sources/base/config-source.abstract.ts

@@ -85,6 +85,8 @@ export abstract class ConfigSource {
   }
 
   abstract name(): string;
+
   abstract type(): SourceType;
+
   abstract loadRaw(): Promise<unknown>;
 }

package/src/config/types.ts

@@ -70,7 +70,9 @@ export interface ParserMetadata {
  */
 export interface PropertyParser<T = any> {
   type(): string;
+
   description(): string;
+
   parse(value: unknown): T;
 }
 
@@ -83,5 +85,6 @@ export enum AppNameStrategyType {
 
 export interface AppNameStrategy {
   type: AppNameStrategyType;
+
   transform(appName: string): string;
 }

package/src/exceptions.handling/global-exceptions.filter.ts

@@ -7,6 +7,7 @@ import { throwError } from 'rxjs';
 
 import { InternalException, PipelineException } from '../exceptions';
 import { InjectLogger } from '../logging';
+import { ProtocolDetector } from '../transport/protocol.detector';
 
 import { FORMATTERS, SENDERS, TRANSFORMERS } from './constants';
 import { GlobalExceptionsConfig } from './global-exceptions.config';
@@ -25,6 +26,7 @@ export class GlobalExceptionsFilter implements ExceptionFilter {
     @InjectLogger(GlobalExceptionsFilter)
     private readonly logger: ILogger,
     private readonly config: GlobalExceptionsConfig,
+    private detector: ProtocolDetector,
   ) {}
 
   catch(ex: any, host: ArgumentsHost): Observable<any> {
@@ -53,7 +55,8 @@ export class GlobalExceptionsFilter implements ExceptionFilter {
   }
 
   private format(host: ArgumentsHost, ex: unknown): unknown {
-    const formatter = this.formatters.find((x) => x.match(host, ex));
+    const protocol = this.detector.getProtocol(host);
+    const formatter = this.formatters.find((x) => x.protocol === protocol);
     if (formatter) {
       this.logger.trace(`Found formatter: ${formatter.constructor.name}`);
 
@@ -74,7 +77,8 @@ export class GlobalExceptionsFilter implements ExceptionFilter {
   }
 
   private send(host: ArgumentsHost, ex: any): Observable<unknown> {
-    const sender = this.senders.find((x) => x.match(host));
+    const protocol = this.detector.getProtocol(host);
+    const sender = this.senders.find((x) => x.protocol === protocol);
 
     return sender?.send(host, ex) ?? throwError(() => ex);
   }

package/src/exceptions.handling/types.ts

@@ -13,13 +13,9 @@ import type { PipelineException } from '../exceptions/base';
  */
 export interface IErrorsFormatter {
   /**
-   * Matcher returns true if exception should be processed with
-   * this formatter. Most common use is match by context type.
-   *
-   * @param host ArgumentsHost - nest.js wrapper over request context
-   * @param exception Exception itself
+   * Platform Transport protocol from `getProtocol`
    */
-  match(host: ArgumentsHost, exception?: unknown): boolean;
+  protocol: string;
 
   /**
    * Formatting algorithm that should match received exception with
@@ -40,12 +36,9 @@ export interface IErrorsFormatter {
  */
 export interface IErrorsSender {
   /**
-   * Matcher returns true if exception should be processed with
-   * this formatter. Most common use is match by context type.
-   *
-   * @param host ArgumentsHost - nest.js wrapper over request context
+   * Platform Transport protocol from `getProtocol`
    */
-  match(host: ArgumentsHost): boolean;
+  protocol: string;
 
   /**
    * Implementation of sending error back to the client

package/src/index.ts

@@ -1,5 +1,7 @@
 import './unhandled-rejection.handler';
 
+export { ProtocolDetector } from './transport/protocol.detector';
+
 export { X_REQUEST_ID } from './tracing/constants';
 
 export {
@@ -62,6 +64,7 @@ export * from './types';
 export * from './app-metadata/decorators';
 
 export * from './app-metadata/app-metadata.const';
+export { getTransportId } from './transport/get-transport-id';
 
 export {
   X_B3_PARENT_SPAN_ID,

package/src/platform.module.ts

@@ -1,5 +1,5 @@
 import type { DynamicModule, NestModule } from '@nestjs/common';
-import { Inject, Module } from '@nestjs/common';
+import { Inject } from '@nestjs/common';
 import type { MiddlewareConsumer } from '@nestjs/common/interfaces';
 import type { Constructor } from '@rsdk/common';
 
@@ -12,7 +12,6 @@ import { LoggingModule } from './logging';
 import { TracingModule } from './tracing';
 import { PlatformExtendedOptions } from './types';
 
-@Module({})
 export class PlatformModule implements NestModule {
   constructor(
     @Inject('PlatformExtendedOptions') private options: PlatformExtendedOptions,

package/src/tracing/utils/save-async-hooks-context.ts

@@ -33,30 +33,29 @@ export function saveAsyncHooksContext<T>(
     if (activeSpan) {
       Object.assign(activeSpan.spanContext(), span?.spanContext());
       return fn(...args);
-    } else {
-      if (!span) {
-        return fn(...args);
-      }
-      const spanContext = api.trace.setSpan(api.context.active(), span);
-
-      return api.context.with(spanContext, async () =>
-        fn(...args)
-          .then(async (result) => {
-            span.setAttribute('response', TraceInjector.toAttribute(result));
-            span.setStatus({ code: SpanStatusCode.OK });
-            span.end();
-            return result;
-          })
-          .catch(async (error) => {
-            span.recordException(error as ErrorLike);
-            span.setStatus({
-              code: SpanStatusCode.ERROR,
-              message: (error as ErrorLike).message,
-            });
-            span.end();
-            throw error;
-          }),
-      );
     }
+    if (!span) {
+      return fn(...args);
+    }
+    const spanContext = api.trace.setSpan(api.context.active(), span);
+
+    return api.context.with(spanContext, async () =>
+      fn(...args)
+        .then(async (result) => {
+          span.setAttribute('response', TraceInjector.toAttribute(result));
+          span.setStatus({ code: SpanStatusCode.OK });
+          span.end();
+          return result;
+        })
+        .catch(async (error) => {
+          span.recordException(error as ErrorLike);
+          span.setStatus({
+            code: SpanStatusCode.ERROR,
+            message: (error as ErrorLike).message,
+          });
+          span.end();
+          throw error;
+        }),
+    );
   };
 }

package/src/transport/get-transport-id.ts

@@ -0,0 +1,20 @@
+import type { ExecutionContext } from '@nestjs/common';
+import { createParamDecorator } from '@nestjs/common';
+import type { ExecutionContextHost } from '@nestjs/core/helpers/execution-context-host';
+import type { Transport } from '@nestjs/microservices';
+import { TRANSPORT_METADATA } from '@nestjs/microservices/constants';
+
+export const TransportId = createParamDecorator(
+  (_data: unknown, ctx: ExecutionContext | ExecutionContextHost) => {
+    return getTransportId(ctx);
+  },
+);
+
+export function getTransportId(
+  context: ExecutionContext | ExecutionContextHost,
+): Transport {
+  return (
+    Reflect.getMetadata(TRANSPORT_METADATA, context.getHandler()) ??
+    Reflect.getMetadata(TRANSPORT_METADATA, context.getClass())
+  );
+}

package/src/transport/protocol.detector.ts

@@ -0,0 +1,38 @@
+import type { ArgumentsHost } from '@nestjs/common';
+
+import { InternalException } from '../exceptions';
+import type { ITransport } from '../types';
+
+export class ProtocolDetector {
+  constructor(private transports: ITransport[]) {}
+
+  getProtocol(context: ArgumentsHost): string | undefined {
+    if (this.transports.length === 0) {
+      return;
+    }
+    const matchers = this.transports.map((tr) => ({
+      matched: tr.matchByContext(context),
+      tr,
+    }));
+    const matched = matchers.filter((matched) => matched.matched);
+    if (matched.length > 1) {
+      throw new InternalException('So many matchers for transports', {
+        cause: {
+          matchers,
+          matched,
+          context,
+        },
+      });
+    }
+    if (matched.length === 0) {
+      throw new InternalException('No matchers found', {
+        cause: {
+          matchers,
+          matched,
+          context,
+        },
+      });
+    }
+    return matched[0].tr.getProtocol();
+  }
+}

package/src/transport/transport.module.ts

@@ -9,6 +9,8 @@ import { MetricsModule } from '../metrics';
 import type { PlatformExtendedOptions } from '../types';
 import { isPrimaryTransport } from '../types';
 
+import { ProtocolDetector } from './protocol.detector';
+
 export class PlatformTransportModule {
   static forOptions(options: PlatformExtendedOptions): DynamicModule {
     return {
@@ -19,6 +21,14 @@ export class PlatformTransportModule {
         ...PlatformTransportModule.getTransportModules(options),
       ],
       module: PlatformTransportModule,
+      providers: [
+        {
+          provide: ProtocolDetector,
+          useFactory: () => new ProtocolDetector(options.transports ?? []),
+        },
+      ],
+      global: true,
+      exports: [ProtocolDetector],
     };
   }
 

package/src/types/index.ts

@@ -1,3 +1,5 @@
+export { getTransportId, TransportId } from '../transport/get-transport-id';
+
 export * from './metadata';
 export * from './options';
 export * from './transports';

package/src/types/transports.ts

@@ -1,3 +1,4 @@
+import type { ArgumentsHost } from '@nestjs/common';
 import type { Controller, INestApplication } from '@nestjs/common/interfaces';
 import type { AbstractHttpAdapter } from '@nestjs/core';
 import type { MicroserviceOptions } from '@nestjs/microservices';
@@ -21,6 +22,18 @@ export interface ITransport {
    */
   getProtocol(): string;
 
+  /**
+   * Detect is it context of this transport
+   * !!! Do NOT check on getType() === 'rpc', this type corresponds to all microservices
+   *
+   * @param {ArgumentsHost} ctx
+   * @returns {boolean}
+   * @example
+   * return ctx.getType() === 'http'
+   * return ctx.getArgByIndex(1) instanceof MyTransportContext
+   */
+  matchByContext(ctx: ArgumentsHost): boolean;
+
   /**
    * @returns error formatting algorithm
    */
@@ -50,6 +63,7 @@ export interface ITransport {
  */
 export interface IPrimaryTransport extends ITransport {
   getHealthController(): Constructor<Controller>;
+
   getMetricsController(): Constructor<Controller>;
 }
 
@@ -105,6 +119,7 @@ export interface IHttpTransport extends IPrimaryTransport {
     app: INestApplication,
     configContext: ConfigContext,
   ): Promise<void> | void;
+
   createHttpOptions(configContext: ConfigContext): HttpOptions;
 }
 

package/tsconfig.json

@@ -4,6 +4,16 @@
     "declaration": true,
     "outDir": "dist"
   },
-  "include": ["src/**/*"],
- "exclude": ["node_modules", "dist", "test", "**/*.spec.ts", "**/*.test.ts", "**/*.spec.e2e.ts", "**/*.test.e2e.ts"]
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.spec.e2e.ts",
+    "**/*.test.e2e.ts"
+  ]
 }