@biorate/nestjs-tools 1.139.0 → 1.140.0

package/index.d.ts

@@ -50,6 +50,10 @@ declare module '@biorate/nestjs-tools' {
     public intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
   }
 
+  export class TracingInterceptor implements NestInterceptor {
+    public intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
+  }
+
   export class ProxyPrometheusMiddleware {
     public static create(options?: Options): RequestHandler;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biorate/nestjs-tools",
-  "version": "1.139.0",
+  "version": "1.140.0",
   "description": "NestJS tools",
   "main": "dist",
   "scripts": {
@@ -29,6 +29,7 @@
     "http-proxy": ">=1.18.1",
     "http-proxy-middleware": "=2.0.6",
     "lodash": ">=4.17.21",
+    "rxjs": ">=7.8.2",
     "ws": ">=8.18.0"
   },
   "dependencies": {
@@ -36,11 +37,12 @@
     "@biorate/config": "1.120.0",
     "@biorate/errors": "1.102.0",
     "@biorate/inversion": "1.120.0",
+    "@biorate/opentelemetry": "1.140.0",
     "@biorate/prometheus": "1.120.0",
     "@biorate/tools": "1.102.1",
     "http-proxy": "1.18.1",
     "http-proxy-middleware": "2.0.6",
     "on-headers": "1.0.2"
   },
-  "gitHead": "6fdb7c11900dac0e6f756b2fc3c6a1baf17f4342"
+  "gitHead": "b25d59cffea065310fdab24a5aba05b35b0e11ba"
 }

package/src/interceptors/index.ts

@@ -1 +1,2 @@
 export * from './routes-interceptor';
+export * from './tracing-interceptor';

package/src/interceptors/tracing-interceptor.ts

@@ -0,0 +1,66 @@
+import { tap } from 'rxjs';
+import { trace, Span } from '@biorate/opentelemetry';
+import {
+  Injectable,
+  NestInterceptor,
+  ExecutionContext,
+  CallHandler,
+} from '@nestjs/common';
+import { inject, Types } from '@biorate/inversion';
+import { IConfig } from '@biorate/config';
+
+@Injectable()
+export class TracingInterceptor implements NestInterceptor {
+  @inject(Types.Config) protected readonly config: IConfig;
+
+  protected stringify(data: unknown) {
+    return typeof data === 'object' ? JSON.stringify(data) : String(data);
+  }
+
+  protected excluded(url: string) {
+    const excluded = this.config.get<(string | RegExp)[]>(
+      'TracingInterceptor.excluded',
+      [],
+    );
+    for (const item of excluded) {
+      if (typeof item === 'string' && url.startsWith(item)) return true;
+      if (item instanceof RegExp && item.test(url)) return true;
+    }
+    return false;
+  }
+
+  protected http(span: Span, context: ExecutionContext, next: CallHandler) {
+    const host = context.switchToHttp();
+    const req = host.getRequest();
+    const res = host.getResponse();
+    if (this.excluded(req.url)) return next.handle();
+    return next.handle().pipe(
+      tap((data) => {
+        span.setAttribute('request.url', this.stringify(req.url));
+        span.setAttribute('request.body', this.stringify(req.body));
+        span.setAttribute('request.headers', this.stringify(req.headers));
+        span.setAttribute('request.method', this.stringify(req.method));
+        span.setAttribute('request.params', this.stringify(req.params));
+        span.setAttribute('request.query', this.stringify(req.query));
+        span.setAttribute('response.headers', this.stringify(res.headers));
+        span.setAttribute('response.statusCode', this.stringify(res.statusCode));
+        span.setAttribute('response.data', this.stringify(data));
+      }),
+    );
+  }
+
+  protected ws(span: Span, context: ExecutionContext, next: CallHandler) {
+    return next.handle();
+  }
+
+  protected rpc(span: Span, context: ExecutionContext, next: CallHandler) {
+    return next.handle();
+  }
+
+  public intercept(context: ExecutionContext, next: CallHandler) {
+    const span = trace.getActiveSpan();
+    if (!span) return next.handle();
+    const type = context.getType();
+    return this[type](span, context, next);
+  }
+}

package/src/middlewares/response-time-middleware.ts

@@ -5,8 +5,8 @@ import { inject, Types } from '@biorate/inversion';
 import { IConfig } from '@biorate/config';
 import { histogram, Histogram } from '@biorate/prometheus';
 import { Request, Response, NextFunction } from 'express';
-import { RoutesInterceptor } from '../interceptors';
 import { time } from '@biorate/tools';
+import { RoutesInterceptor } from '../interceptors';
 
 @Injectable()
 export class ResponseTimeMiddleware implements NestMiddleware {

package/tests/__snapshots__/index.spec.ts.snap

@@ -30,6 +30,8 @@ exports[`nestjs-tools RolesGuardProvider 1`] = `[Function]`;
 
 exports[`nestjs-tools RoutesInterceptor 1`] = `[Function]`;
 
+exports[`nestjs-tools TracingInterceptor 1`] = `[Function]`;
+
 exports[`nestjs-tools UnsupportedProtocolError 1`] = `[Function]`;
 
 exports[`nestjs-tools UserRoles 1`] = `

package/tests/index.spec.ts

@@ -17,6 +17,7 @@ import {
   PostLocalesDTO,
   GetLocalesDTO,
   UnsupportedProtocolError,
+  TracingInterceptor,
   ROLES_KEY,
 } from '../src';
 
@@ -57,5 +58,7 @@ describe('nestjs-tools', () => {
   it('UnsupportedProtocolError', () =>
     expect(UnsupportedProtocolError).toMatchSnapshot());
 
+  it('TracingInterceptor', () => expect(TracingInterceptor).toMatchSnapshot());
+
   it('ROLES_KEY', () => expect(ROLES_KEY).toMatchSnapshot());
 });