@midwayjs/mqtt 4.0.0-beta.9 → 4.0.0

package/dist/framework.js

@@ -79,12 +79,39 @@ let MidwayMQTTFramework = class MidwayMQTTFramework extends core_1.BaseFramework
             ctx.topic = topic;
             ctx.packet = packet;
             ctx.message = message;
-            const fn = await this.applyMiddleware(async (ctx) => {
-                const instance = await ctx.requestContext.getAsync(ClzProvider);
-                // eslint-disable-next-line prefer-spread
-                return await instance['subscribe'].call(instance, 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 packetPropertiesDefault = packet?.properties?.userProperties || {};
+            const packetProperties = typeof traceExtractor === 'function'
+                ? traceExtractor({ ctx, request: packet, custom: { topic } })
+                : packetPropertiesDefault;
+            return await traceService.runWithEntrySpan(`mqtt ${topic}`, {
+                enable: traceEnabled,
+                carrier: packetProperties ?? packetPropertiesDefault,
+                attributes: {
+                    'midway.protocol': 'mqtt',
+                    'midway.mqtt.topic': topic,
+                },
+                meta: traceMetaResolver,
+                metaArgs: {
+                    ctx,
+                    carrier: packetProperties ?? packetPropertiesDefault,
+                    request: packet,
+                    custom: {
+                        topic,
+                    },
+                },
+            }, async () => {
+                const fn = await this.applyMiddleware(async (ctx) => {
+                    const instance = await ctx.requestContext.getAsync(ClzProvider);
+                    return await instance['subscribe'].call(instance, ctx);
+                });
+                return await fn(ctx);
             });
-            return await fn(ctx);
         });
         await consumer.subscribeAsync(subscribeOptions.topicObject, subscribeOptions.opts);
         return consumer;

package/dist/service.d.ts

@@ -1,11 +1,18 @@
-import { ILogger, ServiceFactory, ServiceFactoryConfigOption } from '@midwayjs/core';
+import { ILogger, ServiceFactory, ServiceFactoryConfigOption, MidwayTraceService } from '@midwayjs/core';
 import { type IClientOptions, MqttClient } from 'mqtt';
 export declare class MqttProducerFactory extends ServiceFactory<MqttClient> {
     logger: ILogger;
     pubConfig: ServiceFactoryConfigOption<IClientOptions>;
+    traceService: MidwayTraceService;
+    traceEnabled: boolean;
+    traceInjector: (args: {
+        request?: unknown;
+        custom?: Record<string, unknown>;
+    }) => any;
     getName(): string;
     init(): Promise<void>;
     protected createClient(config: any, clientName: any): Promise<MqttClient>;
+    private bindTraceContext;
     destroyClient(producer: MqttClient, name: string): Promise<void>;
 }
 export declare class DefaultMqttProducer implements MqttClient {

package/dist/service.js

@@ -15,6 +15,9 @@ const mqtt_1 = require("mqtt");
 let MqttProducerFactory = class MqttProducerFactory extends core_1.ServiceFactory {
     logger;
     pubConfig;
+    traceService;
+    traceEnabled;
+    traceInjector;
     getName() {
         return 'mqtt';
     }
@@ -27,6 +30,7 @@ let MqttProducerFactory = class MqttProducerFactory extends core_1.ServiceFactor
         return new Promise(resolve => {
             const client = (0, mqtt_1.connect)(config);
             client.on('connect', () => {
+                this.bindTraceContext(client);
                 this.logger.info('[midway-mqtt] producer: %s is connect', clientName);
                 resolve(client);
             });
@@ -35,6 +39,38 @@ let MqttProducerFactory = class MqttProducerFactory extends core_1.ServiceFactor
             });
         });
     }
+    bindTraceContext(client) {
+        const injectCarrier = (topic, options) => {
+            const publishOptions = options ?? {};
+            if (!publishOptions.properties) {
+                publishOptions.properties = {};
+            }
+            const configuredCarrier = typeof this.traceInjector === 'function'
+                ? this.traceInjector({
+                    request: publishOptions,
+                    custom: {
+                        topic,
+                    },
+                })
+                : undefined;
+            publishOptions.properties.userProperties =
+                configuredCarrier ?? publishOptions.properties.userProperties ?? {};
+            if (this.traceEnabled !== false) {
+                this.traceService.injectContext(publishOptions.properties.userProperties);
+            }
+            return publishOptions;
+        };
+        const rawPublish = client.publish.bind(client);
+        client.publish = (topic, message, options, callback) => {
+            return rawPublish(topic, message, injectCarrier(topic, options), callback);
+        };
+        if (typeof client.publishAsync === 'function') {
+            const rawPublishAsync = client.publishAsync.bind(client);
+            client.publishAsync = (topic, message, options) => {
+                return rawPublishAsync(topic, message, injectCarrier(topic, options));
+            };
+        }
+    }
     async destroyClient(producer, name) {
         await producer.endAsync();
         this.logger.info('[midway-mqtt] producer: %s is close', name);
@@ -49,6 +85,18 @@ __decorate([
     (0, core_1.Config)('mqtt.pub'),
     __metadata("design:type", Object)
 ], MqttProducerFactory.prototype, "pubConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayTraceService)
+], MqttProducerFactory.prototype, "traceService", void 0);
+__decorate([
+    (0, core_1.Config)('mqtt.tracing.enable'),
+    __metadata("design:type", Boolean)
+], MqttProducerFactory.prototype, "traceEnabled", void 0);
+__decorate([
+    (0, core_1.Config)('mqtt.tracing.injector'),
+    __metadata("design:type", Function)
+], MqttProducerFactory.prototype, "traceInjector", void 0);
 __decorate([
     (0, core_1.Init)(),
     __metadata("design:type", Function),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/mqtt",
-  "version": "4.0.0-beta.9",
+  "version": "4.0.0",
   "description": "Midway Framework for mqtt",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -23,11 +23,11 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.9",
-    "@midwayjs/mock": "^4.0.0-beta.9"
+    "@midwayjs/core": "^4.0.0",
+    "@midwayjs/mock": "^4.0.0"
   },
   "dependencies": {
-    "mqtt": "5.14.1"
+    "mqtt": "5.15.0"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -37,5 +37,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "771e83974ef9f3d78c296e4ee0c8c68db44f6b31"
+  "gitHead": "014f32c23ebc1d5ac21777c76be2fd373ce992d8"
 }