@midwayjs/kafka 4.0.0-beta.8 → 4.0.0

package/dist/framework.js

@@ -85,14 +85,42 @@ let MidwayKafkaFramework = class MidwayKafkaFramework extends core_1.BaseFramewo
                     ...resourceInitializeConfig.consumerRunConfig,
                 };
                 runConfig[runMethod] = async (payload) => {
-                    const ctx = this.app.createAnonymousContext();
-                    const fn = await this.applyMiddleware(async (ctx) => {
-                        ctx.payload = payload;
-                        ctx.consumer = consumer;
-                        const instance = await ctx.requestContext.getAsync(ClzProvider);
-                        return await instance[runMethod].call(instance, payload, ctx);
+                    const traceService = this.applicationContext.get(core_1.MidwayTraceService);
+                    const traceMetaResolver = this.configurationOptions?.tracing
+                        ?.meta;
+                    const traceEnabled = this.configurationOptions?.tracing?.enable !== false;
+                    const traceExtractor = this.configurationOptions?.tracing
+                        ?.extractor;
+                    const headersDefault = payload?.message?.headers ?? {};
+                    const headers = typeof traceExtractor === 'function'
+                        ? traceExtractor({ request: payload, custom: { runMethod } })
+                        : headersDefault;
+                    return await traceService.runWithEntrySpan(`kafka ${payload?.topic ?? 'consumer'}`, {
+                        enable: traceEnabled,
+                        carrier: headers ?? headersDefault,
+                        attributes: {
+                            'midway.protocol': 'kafka',
+                            'midway.kafka.topic': payload?.topic,
+                        },
+                        meta: traceMetaResolver,
+                        metaArgs: {
+                            carrier: headers ?? headersDefault,
+                            request: payload,
+                            custom: {
+                                topic: payload?.topic,
+                                runMethod,
+                            },
+                        },
+                    }, async () => {
+                        const ctx = this.app.createAnonymousContext();
+                        const fn = await this.applyMiddleware(async (ctx) => {
+                            ctx.payload = payload;
+                            ctx.consumer = consumer;
+                            const instance = await ctx.requestContext.getAsync(ClzProvider);
+                            return await instance[runMethod].call(instance, payload, ctx);
+                        });
+                        return await fn(ctx);
                     });
-                    return await fn(ctx);
                 };
                 return runConfig;
             },

package/dist/interface.d.ts

@@ -1,4 +1,4 @@
-import { IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction, ServiceFactoryConfigOption } from "@midwayjs/core";
+import { IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction, ServiceFactoryConfigOption } from '@midwayjs/core';
 import { AdminConfig, Consumer, ConsumerConfig, ConsumerRunConfig, ConsumerSubscribeTopic, ConsumerSubscribeTopics, EachBatchHandler, EachBatchPayload, EachMessageHandler, EachMessagePayload, Kafka, KafkaConfig, ProducerConfig } from 'kafkajs';
 export interface IKafkaApplication {
 }

package/dist/service.d.ts

@@ -1,12 +1,19 @@
-import { ILogger, ServiceFactory, ServiceFactoryConfigOption } from '@midwayjs/core';
+import { ILogger, ServiceFactory, ServiceFactoryConfigOption, MidwayTraceService } from '@midwayjs/core';
 import { Producer, Admin } from 'kafkajs';
 import { IMidwayKafkaAdminInitOptions, IMidwayKafkaProducerInitOptions } from './interface';
 export declare class KafkaProducerFactory extends ServiceFactory<Producer> {
     logger: ILogger;
     pubConfig: ServiceFactoryConfigOption<IMidwayKafkaProducerInitOptions>;
+    traceService: MidwayTraceService;
+    traceEnabled: boolean;
+    traceInjector: (args: {
+        request?: unknown;
+        custom?: Record<string, unknown>;
+    }) => any;
     getName(): string;
     init(): Promise<void>;
     protected createClient(config: IMidwayKafkaProducerInitOptions, clientName: any): Promise<Producer>;
+    private bindTraceContext;
     destroyClient(producer: Producer, name: string): Promise<void>;
     destroy(): Promise<void>;
 }

package/dist/service.js

@@ -16,6 +16,9 @@ const manager_1 = require("./manager");
 let KafkaProducerFactory = class KafkaProducerFactory extends core_1.ServiceFactory {
     logger;
     pubConfig;
+    traceService;
+    traceEnabled;
+    traceInjector;
     getName() {
         return 'kafka:producer';
     }
@@ -38,12 +41,59 @@ let KafkaProducerFactory = class KafkaProducerFactory extends core_1.ServiceFact
             manager_1.KafkaManager.getInstance().addKafkaInstance(kafkaInstanceRef, client);
         }
         const producer = client.producer(producerOptions);
+        this.bindTraceContext(producer);
         producer.on('producer.connect', () => {
             this.logger.info('[midway:kafka] producer: %s is connect', clientName);
         });
         await producer.connect();
         return producer;
     }
+    bindTraceContext(producer) {
+        const injectHeaders = (headers, custom) => {
+            const configuredCarrier = typeof this.traceInjector === 'function'
+                ? this.traceInjector({
+                    request: headers,
+                    custom,
+                })
+                : undefined;
+            const carrier = configuredCarrier ?? headers ?? {};
+            if (this.traceEnabled !== false) {
+                this.traceService.injectContext(carrier);
+            }
+            return carrier;
+        };
+        const rawSend = producer.send.bind(producer);
+        producer.send = payload => {
+            const nextPayload = {
+                ...payload,
+                messages: (payload?.messages || []).map(message => ({
+                    ...message,
+                    headers: injectHeaders(message?.headers, {
+                        sendMethod: 'send',
+                        topic: payload?.topic,
+                    }),
+                })),
+            };
+            return rawSend(nextPayload);
+        };
+        const rawSendBatch = producer.sendBatch.bind(producer);
+        producer.sendBatch = payload => {
+            const nextPayload = {
+                ...payload,
+                topicMessages: (payload?.topicMessages || []).map(topicMessage => ({
+                    ...topicMessage,
+                    messages: (topicMessage?.messages || []).map(message => ({
+                        ...message,
+                        headers: injectHeaders(message?.headers, {
+                            sendMethod: 'sendBatch',
+                            topic: topicMessage?.topic,
+                        }),
+                    })),
+                })),
+            };
+            return rawSendBatch(nextPayload);
+        };
+    }
     async destroyClient(producer, name) {
         await producer.disconnect();
         this.logger.info('[midway:kafka] producer: %s is close', name);
@@ -61,6 +111,18 @@ __decorate([
     (0, core_1.Config)('kafka.producer'),
     __metadata("design:type", Object)
 ], KafkaProducerFactory.prototype, "pubConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayTraceService)
+], KafkaProducerFactory.prototype, "traceService", void 0);
+__decorate([
+    (0, core_1.Config)('kafka.tracing.enable'),
+    __metadata("design:type", Boolean)
+], KafkaProducerFactory.prototype, "traceEnabled", void 0);
+__decorate([
+    (0, core_1.Config)('kafka.tracing.injector'),
+    __metadata("design:type", Function)
+], KafkaProducerFactory.prototype, "traceInjector", void 0);
 __decorate([
     (0, core_1.Init)(),
     __metadata("design:type", Function),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/kafka",
-  "version": "4.0.0-beta.8",
+  "version": "4.0.0",
   "description": "Midway Framework for kafka",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -33,8 +33,8 @@
   },
   "homepage": "https://github.com/midwayjs/midway#readme",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.8",
-    "@midwayjs/mock": "^4.0.0-beta.8"
+    "@midwayjs/core": "^4.0.0",
+    "@midwayjs/mock": "^4.0.0"
   },
   "dependencies": {
     "kafkajs": "2.2.4"
@@ -42,5 +42,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "355e55949fdd132b0bdcb4830222a0a027e92ded"
+  "gitHead": "014f32c23ebc1d5ac21777c76be2fd373ce992d8"
 }