@lad-tech/nsc-toolkit 1.20.1 → 1.21.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-## [1.20.1](https://github.com/lad-tech/nsc-toolkit/compare/v1.20.0...v1.20.1) (2024-07-01)
+# [1.21.0](https://github.com/lad-tech/nsc-toolkit/compare/v1.20.1...v1.21.0) (2024-08-14)
 
 
-### Bug Fixes
+### Features
 
-* Fix param name ([#108](https://github.com/lad-tech/nsc-toolkit/issues/108)) ([3b93529](https://github.com/lad-tech/nsc-toolkit/commit/3b9352967adae3694d3db92e1335c7ec4bfebcde))
+* Add new requestId field into baggage ([#113](https://github.com/lad-tech/nsc-toolkit/issues/113)) ([02c222d](https://github.com/lad-tech/nsc-toolkit/commit/02c222d13b7325211edc6049cad8301440b64b47))

package/dist/Client.js

@@ -110,7 +110,7 @@ class Client extends Root_1.Root {
         }
     }
     async request(subject, data, { options, request, response }) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         const tracer = opentelemetry.trace.getTracer('');
         const span = tracer.startSpan(subject, undefined, this.getContext(this.baggage));
         try {
@@ -119,7 +119,8 @@ class Client extends Root_1.Root {
             }
             const { spanId, traceId, traceFlags } = span.spanContext();
             const expired = this.getExpired((_b = this.baggage) === null || _b === void 0 ? void 0 : _b.expired, options === null || options === void 0 ? void 0 : options.timeout);
-            const message = { payload: data, baggage: { expired, traceId, spanId, traceFlags } };
+            const requestId = (_c = this.baggage) === null || _c === void 0 ? void 0 : _c.requestId;
+            const message = { payload: data, baggage: { expired, traceId, spanId, traceFlags, requestId } };
             const timeout = expired - Date.now();
             if (timeout <= 0) {
                 throw new Error('Timeout request service ' + subject);
@@ -141,9 +142,9 @@ class Client extends Root_1.Root {
                 ? await this.makeHttpRequest(subject, message, options, timeout)
                 : await this.makeBrokerRequest(subject, message, timeout);
             if (result.error) {
-                throw new Error((_c = result.error.message) !== null && _c !== void 0 ? _c : result.error);
+                throw new Error((_d = result.error.message) !== null && _d !== void 0 ? _d : result.error);
             }
-            if (((_d = options === null || options === void 0 ? void 0 : options.runTimeValidation) === null || _d === void 0 ? void 0 : _d.response) && response) {
+            if (((_e = options === null || options === void 0 ? void 0 : options.runTimeValidation) === null || _e === void 0 ? void 0 : _e.response) && response) {
                 this.validate(result.payload, response);
             }
             if ((options === null || options === void 0 ? void 0 : options.cache) && !this.isStream(result.payload) && this.cache) {
@@ -236,12 +237,23 @@ class Client extends Root_1.Root {
         if (!baggage) {
             return {};
         }
-        return {
-            'nsc-expired': baggage.expired,
-            'nsc-trace-id': baggage.traceId,
-            'nsc-span-id': baggage.spanId,
-            'nsc-trace-flags': baggage.traceFlags,
-        };
+        const headers = {};
+        if (baggage.expired) {
+            headers['nsc-expired'] = baggage.expired;
+        }
+        if (baggage.requestId) {
+            headers['x-request-id'] = baggage.requestId;
+        }
+        if (baggage.traceId) {
+            headers['nsc-trace-id'] = baggage.traceId;
+        }
+        if (baggage.spanId) {
+            headers['nsc-span-id'] = baggage.spanId;
+        }
+        if (baggage.traceFlags) {
+            headers['nsc-trace-flags'] = baggage.traceFlags;
+        }
+        return headers;
     }
     isJsMessage(message) {
         return !!message.ack && !!message.nak;

package/dist/Service.js

@@ -192,7 +192,13 @@ class Service extends Root_1.Root {
      */
     getNextBaggage(span, baggage) {
         const { traceId, spanId, traceFlags } = span.spanContext();
-        return { traceId, spanId, traceFlags, expired: baggage === null || baggage === void 0 ? void 0 : baggage.expired };
+        return { traceId, spanId, traceFlags, expired: baggage === null || baggage === void 0 ? void 0 : baggage.expired, requestId: baggage === null || baggage === void 0 ? void 0 : baggage.requestId };
+    }
+    /**
+     * Guard for determine whether baggage contains trace information
+     */
+    isBaggageContainTrace(params) {
+        return !!params && !!(params.traceId && params.spanId && params.traceFlags);
     }
     /**
      * If there is no baggage. For example, in HTTP Gateway
@@ -200,7 +206,7 @@ class Service extends Root_1.Root {
     getRootBaggage(subject, headers, ownTimeout) {
         const baggage = headers ? this.getBaggageFromHTTPHeader(headers) : undefined;
         const tracer = api_1.trace.getTracer('');
-        const context = this.getContext(baggage);
+        const context = this.getContext(this.isBaggageContainTrace(baggage) ? baggage : undefined);
         const span = tracer.startSpan(subject, undefined, context);
         const newBaggage = this.getNextBaggage(span, baggage);
         this.rootSpans.set(newBaggage.traceId, span);
@@ -333,7 +339,7 @@ class Service extends Root_1.Root {
     async handled(payload, Method, baggage) {
         const subject = `${this.serviceName}.${Method.settings.action}`;
         const tracer = api_1.trace.getTracer('');
-        const context = this.getContext(baggage);
+        const context = this.getContext(this.isBaggageContainTrace(baggage) ? baggage : undefined);
         const span = tracer.startSpan(subject, undefined, context);
         const logger = new toolbelt_1.Logs.Logger({
             location: `${this.serviceName}.${Method.settings.action}`,
@@ -579,15 +585,17 @@ class Service extends Root_1.Root {
         const traceId = headers['nsc-trace-id'];
         const spanId = headers['nsc-span-id'];
         const traceFlags = headers['nsc-trace-flags'] ? +headers['nsc-trace-flags'] : undefined;
+        const requestId = headers['x-request-id'] ? String(headers['x-request-id']) : undefined;
         if (traceId && spanId && traceFlags) {
             return {
                 traceId,
                 spanId,
                 traceFlags,
                 expired,
+                requestId,
             };
         }
-        return undefined;
+        return { expired, requestId };
     }
 }
 exports.Service = Service;

package/dist/types/Service.d.ts

@@ -37,6 +37,10 @@ export declare class Service<E extends Emitter = Emitter> extends Root {
      * Create Baggage from span. Expired one-on-one business logic call
      */
     private getNextBaggage;
+    /**
+     * Guard for determine whether baggage contains trace information
+     */
+    private isBaggageContainTrace;
     /**
      * If there is no baggage. For example, in HTTP Gateway
      */
@@ -45,6 +49,7 @@ export declare class Service<E extends Emitter = Emitter> extends Root {
         traceId: string;
         spanId: string;
         traceFlags: number;
+        requestId: string | undefined;
     };
     /**
      * End root baggage

package/dist/types/interfaces.d.ts

@@ -30,6 +30,7 @@ export type Baggage = {
     traceId: string;
     spanId: string;
     traceFlags: number;
+    requestId?: string;
     expired?: number;
 };
 export type ExternalBaggage = {
@@ -37,6 +38,7 @@ export type ExternalBaggage = {
     'nsc-trace-id'?: string;
     'nsc-span-id'?: string;
     'nsc-trace-flags'?: number;
+    'x-request-id'?: string;
 };
 export interface Message<M = any> {
     payload: M;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lad-tech/nsc-toolkit",
-  "version": "1.20.1",
+  "version": "1.21.0",
   "description": "Toolkit for create microservices around NATS",
   "main": "dist/index.js",
   "types": "./dist/types/index.d.ts",