@midwayjs/consul 4.0.0-beta.11 → 4.0.0-beta.13

package/dist/manager.d.ts

@@ -1,11 +1,16 @@
-import { ServiceFactory, ServiceFactoryConfigOption, ILogger } from '@midwayjs/core';
+import { ServiceFactory, ServiceFactoryConfigOption, ILogger, MidwayTraceService } from '@midwayjs/core';
 import Consul = require('consul');
 import { ConsulClient, ConsulOptions } from './interface';
 export declare class ConsulServiceFactory extends ServiceFactory<ConsulClient> {
     consulConfig: ServiceFactoryConfigOption<ConsulOptions>;
+    traceMetaResolver: any;
+    traceEnabled: any;
+    traceInjector: any;
     init(): Promise<void>;
     logger: ILogger;
+    traceService: MidwayTraceService;
     createClient(config: ConsulOptions, clientName: string): Promise<InstanceType<typeof Consul>>;
+    protected bindTraceContext(client: any, clientName: string): void;
     getName(): string;
     destroyClient(client: InstanceType<typeof Consul>, clientName: string): Promise<void>;
 }

package/dist/manager.js

@@ -14,15 +14,72 @@ const core_1 = require("@midwayjs/core");
 const Consul = require("consul");
 let ConsulServiceFactory = class ConsulServiceFactory extends core_1.ServiceFactory {
     consulConfig;
+    traceMetaResolver;
+    traceEnabled;
+    traceInjector;
     async init() {
         await this.initClients(this.consulConfig, {
             concurrent: true,
         });
     }
     logger;
+    traceService;
     async createClient(config, clientName) {
         this.logger.info('[midway:consul] init %s at %s:%s', clientName, config.host, config.port);
-        return new Consul(config);
+        const client = new Consul(config);
+        this.bindTraceContext(client, clientName);
+        return client;
+    }
+    bindTraceContext(client, clientName) {
+        if (!client || !this.traceService) {
+            return;
+        }
+        const rawRequest = client.request?.bind(client);
+        if (!rawRequest) {
+            return;
+        }
+        client.request = (...args) => {
+            const hasCallback = args.some(arg => typeof arg === 'function');
+            if (hasCallback) {
+                return rawRequest(...args);
+            }
+            const requestOptions = args?.[0] ?? {};
+            const isWatch = Boolean(requestOptions?.watch ??
+                requestOptions?.qs?.watch ??
+                requestOptions?.query?.watch);
+            if (isWatch) {
+                return rawRequest(...args);
+            }
+            const requestMethod = requestOptions?.method ?? 'request';
+            const rawCarrier = typeof this.traceInjector === 'function'
+                ? this.traceInjector({
+                    request: requestOptions,
+                    custom: {
+                        clientName,
+                        requestMethod: String(requestMethod),
+                    },
+                })
+                : {};
+            const carrier = rawCarrier && typeof rawCarrier === 'object' ? rawCarrier : {};
+            return this.traceService.runWithExitSpan(`consul.${String(requestMethod).toLowerCase()}`, {
+                enable: this.traceEnabled !== false,
+                carrier,
+                attributes: {
+                    'midway.protocol': 'consul',
+                    'midway.consul.client': clientName,
+                    'midway.consul.method': String(requestMethod),
+                },
+                meta: this.traceMetaResolver,
+                metaArgs: {
+                    carrier,
+                    request: requestOptions,
+                    custom: {
+                        clientName,
+                        requestMethod: String(requestMethod),
+                    },
+                },
+            }, async () => rawRequest(...args));
+        };
     }
     getName() {
         return 'consul';
@@ -37,6 +94,18 @@ __decorate([
     (0, core_1.Config)('consul'),
     __metadata("design:type", Object)
 ], ConsulServiceFactory.prototype, "consulConfig", void 0);
+__decorate([
+    (0, core_1.Config)('consul.tracing.meta'),
+    __metadata("design:type", Object)
+], ConsulServiceFactory.prototype, "traceMetaResolver", void 0);
+__decorate([
+    (0, core_1.Config)('consul.tracing.enable'),
+    __metadata("design:type", Object)
+], ConsulServiceFactory.prototype, "traceEnabled", void 0);
+__decorate([
+    (0, core_1.Config)('consul.tracing.injector'),
+    __metadata("design:type", Object)
+], ConsulServiceFactory.prototype, "traceInjector", void 0);
 __decorate([
     (0, core_1.Init)(),
     __metadata("design:type", Function),
@@ -47,6 +116,10 @@ __decorate([
     (0, core_1.Logger)('coreLogger'),
     __metadata("design:type", Object)
 ], ConsulServiceFactory.prototype, "logger", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayTraceService)
+], ConsulServiceFactory.prototype, "traceService", void 0);
 exports.ConsulServiceFactory = ConsulServiceFactory = __decorate([
     (0, core_1.Singleton)()
 ], ConsulServiceFactory);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/consul",
   "description": "midway consul",
-  "version": "4.0.0-beta.11",
+  "version": "4.0.0-beta.13",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,9 +10,9 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.11",
-    "@midwayjs/koa": "^4.0.0-beta.11",
-    "@midwayjs/mock": "^4.0.0-beta.11",
+    "@midwayjs/core": "^4.0.0-beta.13",
+    "@midwayjs/koa": "^4.0.0-beta.13",
+    "@midwayjs/mock": "^4.0.0-beta.13",
     "@types/sinon": "17.0.4",
     "nock": "13.5.6"
   },
@@ -39,5 +39,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "6ef05719ca6e900f1ec34aff7a5c5a9614358c50"
+  "gitHead": "9a38b66a84a6880370cac90d737f94f9c5f2f256"
 }