@rsdk/grpc.clients 5.0.0-next.2 → 5.0.0-next.3

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.0-next.3](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.2...v5.0.0-next.3) (2024-07-11)
+
+### ⚠ BREAKING CHANGES
+
+* generalize tracing headers (#247)
+
+### Features
+
+* generalize tracing headers ([#247](https://github.com/R-Vision/rsdk/issues/247)) ([cee2ea6](https://github.com/R-Vision/rsdk/commit/cee2ea65c964705faf133397e285c051672c7512)), closes [#2](https://github.com/R-Vision/rsdk/issues/2) [#3](https://github.com/R-Vision/rsdk/issues/3) [#4](https://github.com/R-Vision/rsdk/issues/4) [#5](https://github.com/R-Vision/rsdk/issues/5)
+
 ## [5.0.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.1...v5.0.0-next.2) (2024-07-10)
 
 **Note:** Version bump only for package @rsdk/grpc.clients

package/dist/middleware/{request-metadata.middleware.d.ts → tracing.middleware.d.ts}

@@ -2,4 +2,4 @@ import type { ClientMiddleware } from 'nice-grpc';
 /**
  * Мидл варя для клиента GRPC, для проброса **requestId** из текущего приложения в стороннее через Metadata
  */
-export declare const requestMetadataMiddleware: () => ClientMiddleware;
+export declare const tracingMiddleware: () => ClientMiddleware;

package/dist/middleware/{request-metadata.middleware.js → tracing.middleware.js}

@@ -1,29 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestMetadataMiddleware = void 0;
+exports.tracingMiddleware = void 0;
 const core_1 = require("@rsdk/core");
-const tracing_1 = require("@rsdk/tracing");
 const nice_grpc_1 = require("nice-grpc");
 /**
  * Мидл варя для клиента GRPC, для проброса **requestId** из текущего приложения в стороннее через Metadata
  */
-const requestMetadataMiddleware = () => 
+const tracingMiddleware = () => 
 // eslint-disable-next-line unicorn/consistent-function-scoping
 async function* (call, options) {
-    const requestId = tracing_1.RequestIdProvider.get();
-    if (requestId === undefined) {
+    const headers = core_1.TracingHeaders.get();
+    if (!headers) {
         return yield* call.next(call.request, {
             ...options,
         });
     }
     const metadata = options.metadata ?? new nice_grpc_1.Metadata();
-    if (requestId) {
-        metadata.append(core_1.X_REQUEST_ID, requestId);
+    for (const [key, value] of Object.entries(headers)) {
+        metadata.append(key, value);
     }
-    options.metadata = metadata;
     return yield* call.next(call.request, {
         ...options,
+        metadata,
     });
 };
-exports.requestMetadataMiddleware = requestMetadataMiddleware;
-//# sourceMappingURL=request-metadata.middleware.js.map
+exports.tracingMiddleware = tracingMiddleware;
+//# sourceMappingURL=tracing.middleware.js.map

package/dist/middleware/tracing.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.middleware.js","sourceRoot":"","sources":["../../src/middleware/tracing.middleware.ts"],"names":[],"mappings":";;;AAAA,qCAA4C;AAE5C,yCAAqC;AAErC;;GAEG;AACI,MAAM,iBAAiB,GAAG,GAAqB,EAAE;AACtD,+DAA+D;AAC/D,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO;IAC5B,MAAM,OAAO,GAAG,qBAAc,CAAC,GAAG,EAAE,CAAC;IACrC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACpC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,oBAAQ,EAAE,CAAC;IAEpD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACpC,GAAG,OAAO;QACV,QAAQ;KACT,CAAC,CAAC;AACL,CAAC,CAAC;AApBS,QAAA,iBAAiB,qBAoB1B"}

package/dist/repository/grpc-client.repository.js

@@ -16,8 +16,7 @@ exports.GrpcClientRepository = void 0;
 const common_1 = require("@nestjs/common");
 const nice_grpc_1 = require("nice-grpc");
 const exception_mapper_middleware_1 = require("../middleware/exception-mapper.middleware");
-const opentelemetry_middleware_1 = require("../middleware/opentelemetry.middleware");
-const request_metadata_middleware_1 = require("../middleware/request-metadata.middleware");
+const tracing_middleware_1 = require("../middleware/tracing.middleware");
 const di_1 = require("../options/di");
 /**
  * Простое кеш хранилище внутри DI для кеширования на замену статике
@@ -30,8 +29,7 @@ let GrpcClientRepository = class GrpcClientRepository {
     constructor(options) {
         this.factory = (0, nice_grpc_1.createClientFactory)()
             .use((0, exception_mapper_middleware_1.exceptionMapperMiddleware)())
-            .use((0, opentelemetry_middleware_1.opentelemetryMiddleware)())
-            .use((0, request_metadata_middleware_1.requestMetadataMiddleware)());
+            .use((0, tracing_middleware_1.tracingMiddleware)());
         const { middleware } = options || {};
         if (middleware) {
             for (const x of middleware)

package/dist/repository/grpc-client.repository.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc-client.repository.js","sourceRoot":"","sources":["../../src/repository/grpc-client.repository.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,2CAA8D;AAE9D,yCAImB;AAGnB,2FAAsF;AACtF,qFAAiF;AACjF,2FAAsF;AACtF,sCAAqD;AAGrD;;GAEG;AAGI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IACd,OAAO,CAAgB;IAExC,SAAS;IACQ,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IACtC,OAAO,GAAG,IAAI,GAAG,EAA2C,CAAC;IAE9E,YAC4C,OAA4B;QAEtE,IAAI,CAAC,OAAO,GAAG,IAAA,+BAAmB,GAAE;aACjC,GAAG,CAAC,IAAA,uDAAyB,GAAE,CAAC;aAChC,GAAG,CAAC,IAAA,kDAAuB,GAAE,CAAC;aAC9B,GAAG,CAAC,IAAA,uDAAyB,GAAE,CAAC,CAAC;QAEpC,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErC,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,MAAM,CAAC,IAAI,UAAU;gBAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,YAAoB;QAClD,uFAAuF;QACvF,sFAAsF;QACtF,kFAAkF;QAElF,MAAM,OAAO,GACX,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC;YAC/B,IAAA,yBAAa,EAAC,OAAO,EAAE,8BAAkB,CAAC,cAAc,EAAE,EAAE;gBAC1D,YAAY;gBACZ,iCAAiC,EAAE,CAAC,CAAC;aACtC,CAAC,CAAC;QAEL,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CACX,UAAmC,EACnC,OAA8B,EAC9B,WAAmB;QAEnB,MAAM,OAAO,GACX,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAE5E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAA;AAnDY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IASR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IAAE,WAAA,IAAA,eAAM,EAAC,yBAAoB,CAAC,CAAA;;GARhC,oBAAoB,CAmDhC"}
+{"version":3,"file":"grpc-client.repository.js","sourceRoot":"","sources":["../../src/repository/grpc-client.repository.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,2CAA8D;AAE9D,yCAImB;AAGnB,2FAAsF;AACtF,yEAAqE;AACrE,sCAAqD;AAGrD;;GAEG;AAGI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IACd,OAAO,CAAgB;IAExC,SAAS;IACQ,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IACtC,OAAO,GAAG,IAAI,GAAG,EAA2C,CAAC;IAE9E,YAC4C,OAA4B;QAEtE,IAAI,CAAC,OAAO,GAAG,IAAA,+BAAmB,GAAE;aACjC,GAAG,CAAC,IAAA,uDAAyB,GAAE,CAAC;aAChC,GAAG,CAAC,IAAA,sCAAiB,GAAE,CAAC,CAAC;QAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErC,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,MAAM,CAAC,IAAI,UAAU;gBAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,YAAoB;QAClD,uFAAuF;QACvF,sFAAsF;QACtF,kFAAkF;QAElF,MAAM,OAAO,GACX,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC;YAC/B,IAAA,yBAAa,EAAC,OAAO,EAAE,8BAAkB,CAAC,cAAc,EAAE,EAAE;gBAC1D,YAAY;gBACZ,iCAAiC,EAAE,CAAC,CAAC;aACtC,CAAC,CAAC;QAEL,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAEzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CACX,UAAmC,EACnC,OAA8B,EAC9B,WAAmB;QAEnB,MAAM,OAAO,GACX,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAE5E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAA;AAlDY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IASR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IAAE,WAAA,IAAA,eAAM,EAAC,yBAAoB,CAAC,CAAA;;GARhC,oBAAoB,CAkDhC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/grpc.clients",
-  "version": "5.0.0-next.2",
+  "version": "5.0.0-next.3",
   "description": "Grpc clients infrastructure",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -11,12 +11,10 @@
   },
   "main": "dist/index.js",
   "peerDependencies": {
-    "@grpc/grpc-js": "^1.8.7",
+    "@grpc/grpc-js": "^1.10.9",
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/microservices": "^10.0.0",
-    "@opentelemetry/propagator-b3": "1.18.1",
-    "@opentelemetry/sdk-node": "0.45.1",
     "@rsdk/autodoc.protocol": "*",
     "@rsdk/builtin-contract": "*",
     "@rsdk/common": "*",
@@ -24,10 +22,9 @@
     "@rsdk/grpc.common": "*",
     "@rsdk/logging": "*",
     "@rsdk/metadata": "*",
-    "@rsdk/tracing": "*",
-    "nice-grpc": "^2.1.4",
+    "nice-grpc": "^2.1.9",
     "reflect-metadata": "^0.1.12 || ^0.2.0",
     "rxjs": "^7.8.1"
   },
-  "gitHead": "b1e624d9bd7734c4346cb5747feea7d2199535d0"
+  "gitHead": "c75ce1d8983ba69a6f855ba19536d28be0a9c519"
 }

package/src/middleware/{request-metadata.middleware.ts → tracing.middleware.ts}

@@ -1,29 +1,28 @@
-import { X_REQUEST_ID } from '@rsdk/core';
-import { RequestIdProvider } from '@rsdk/tracing';
+import { TracingHeaders } from '@rsdk/core';
 import type { ClientMiddleware } from 'nice-grpc';
 import { Metadata } from 'nice-grpc';
 
 /**
  * Мидл варя для клиента GRPC, для проброса **requestId** из текущего приложения в стороннее через Metadata
  */
-export const requestMetadataMiddleware = (): ClientMiddleware =>
+export const tracingMiddleware = (): ClientMiddleware =>
   // eslint-disable-next-line unicorn/consistent-function-scoping
   async function* (call, options) {
-    const requestId = RequestIdProvider.get();
-    if (requestId === undefined) {
+    const headers = TracingHeaders.get();
+    if (!headers) {
       return yield* call.next(call.request, {
         ...options,
       });
     }
+
     const metadata = options.metadata ?? new Metadata();
 
-    if (requestId) {
-      metadata.append(X_REQUEST_ID, requestId);
+    for (const [key, value] of Object.entries(headers)) {
+      metadata.append(key, value);
     }
 
-    options.metadata = metadata;
-
     return yield* call.next(call.request, {
       ...options,
+      metadata,
     });
   };

package/src/repository/grpc-client.repository.ts

@@ -9,8 +9,7 @@ import {
 import type { CompatServiceDefinition } from 'nice-grpc/lib/service-definitions';
 
 import { exceptionMapperMiddleware } from '../middleware/exception-mapper.middleware';
-import { opentelemetryMiddleware } from '../middleware/opentelemetry.middleware';
-import { requestMetadataMiddleware } from '../middleware/request-metadata.middleware';
+import { tracingMiddleware } from '../middleware/tracing.middleware';
 import { GRPC_CLIENTS_OPTIONS } from '../options/di';
 import { GrpcClientsOptions } from '../options/types';
 
@@ -31,8 +30,7 @@ export class GrpcClientRepository {
   ) {
     this.factory = createClientFactory()
       .use(exceptionMapperMiddleware())
-      .use(opentelemetryMiddleware())
-      .use(requestMetadataMiddleware());
+      .use(tracingMiddleware());
 
     const { middleware } = options || {};
 

package/dist/middleware/opentelemetry.middleware.d.ts

@@ -1,5 +0,0 @@
-import type { ClientMiddleware } from 'nice-grpc';
-/**
- * Middleware для клиента GRPC, который пробрасывает **traceId** и **spanId** из текущего приложения в стороннее через Metadata
- */
-export declare const opentelemetryMiddleware: () => ClientMiddleware;

package/dist/middleware/opentelemetry.middleware.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.opentelemetryMiddleware = void 0;
-const propagator_b3_1 = require("@opentelemetry/propagator-b3");
-const sdk_node_1 = require("@opentelemetry/sdk-node");
-const nice_grpc_1 = require("nice-grpc");
-/**
- * Middleware для клиента GRPC, который пробрасывает **traceId** и **spanId** из текущего приложения в стороннее через Metadata
- */
-const opentelemetryMiddleware = () => 
-// eslint-disable-next-line unicorn/consistent-function-scoping
-async function* (call, options) {
-    const metadata = options.metadata ?? new nice_grpc_1.Metadata();
-    const traceId = sdk_node_1.api.trace?.getActiveSpan()?.spanContext().traceId;
-    if (traceId) {
-        metadata.append(propagator_b3_1.X_B3_TRACE_ID, traceId);
-    }
-    const spanId = sdk_node_1.api.trace?.getActiveSpan()?.spanContext().spanId;
-    if (spanId) {
-        metadata.append(propagator_b3_1.X_B3_PARENT_SPAN_ID, spanId);
-    }
-    options.metadata = metadata;
-    return yield* call.next(call.request, {
-        ...options,
-    });
-};
-exports.opentelemetryMiddleware = opentelemetryMiddleware;
-//# sourceMappingURL=opentelemetry.middleware.js.map

package/dist/middleware/opentelemetry.middleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"opentelemetry.middleware.js","sourceRoot":"","sources":["../../src/middleware/opentelemetry.middleware.ts"],"names":[],"mappings":";;;AAAA,gEAGsC;AACtC,sDAA8C;AAE9C,yCAAqC;AAErC;;GAEG;AACI,MAAM,uBAAuB,GAAG,GAAqB,EAAE;AAC5D,+DAA+D;AAC/D,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO;IAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,oBAAQ,EAAE,CAAC;IAEpD,MAAM,OAAO,GAAG,cAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,OAAO,CAAC;IAClE,IAAI,OAAO,EAAE,CAAC;QACZ,QAAQ,CAAC,MAAM,CAAC,6BAAa,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,MAAM,GAAG,cAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,MAAM,CAAC;IAChE,IAAI,MAAM,EAAE,CAAC;QACX,QAAQ,CAAC,MAAM,CAAC,mCAAmB,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE5B,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACpC,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC,CAAC;AApBS,QAAA,uBAAuB,2BAoBhC"}

package/dist/middleware/request-metadata.middleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"request-metadata.middleware.js","sourceRoot":"","sources":["../../src/middleware/request-metadata.middleware.ts"],"names":[],"mappings":";;;AAAA,qCAA0C;AAC1C,2CAAkD;AAElD,yCAAqC;AAErC;;GAEG;AACI,MAAM,yBAAyB,GAAG,GAAqB,EAAE;AAC9D,+DAA+D;AAC/D,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO;IAC5B,MAAM,SAAS,GAAG,2BAAiB,CAAC,GAAG,EAAE,CAAC;IAC1C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACpC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,oBAAQ,EAAE,CAAC;IAEpD,IAAI,SAAS,EAAE,CAAC;QACd,QAAQ,CAAC,MAAM,CAAC,mBAAY,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE5B,OAAO,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACpC,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC,CAAC;AApBS,QAAA,yBAAyB,6BAoBlC"}

package/src/middleware/opentelemetry.middleware.ts

@@ -1,32 +0,0 @@
-import {
-  X_B3_PARENT_SPAN_ID,
-  X_B3_TRACE_ID,
-} from '@opentelemetry/propagator-b3';
-import { api } from '@opentelemetry/sdk-node';
-import type { ClientMiddleware } from 'nice-grpc';
-import { Metadata } from 'nice-grpc';
-
-/**
- * Middleware для клиента GRPC, который пробрасывает **traceId** и **spanId** из текущего приложения в стороннее через Metadata
- */
-export const opentelemetryMiddleware = (): ClientMiddleware =>
-  // eslint-disable-next-line unicorn/consistent-function-scoping
-  async function* (call, options) {
-    const metadata = options.metadata ?? new Metadata();
-
-    const traceId = api.trace?.getActiveSpan()?.spanContext().traceId;
-    if (traceId) {
-      metadata.append(X_B3_TRACE_ID, traceId);
-    }
-
-    const spanId = api.trace?.getActiveSpan()?.spanContext().spanId;
-    if (spanId) {
-      metadata.append(X_B3_PARENT_SPAN_ID, spanId);
-    }
-
-    options.metadata = metadata;
-
-    return yield* call.next(call.request, {
-      ...options,
-    });
-  };