import { Framework, BaseFramework, DecoratorManager, MetadataManager, MidwayTraceService, } from '@midwayjs/core'; import { IMidwayMQTTApplication, IMidwayMQTTConfigurationOptions, IMidwayMQTTContext, IMqttSubscriber, MqttSubscriberOptions, } from './interface'; import { connect, IClientOptions, MqttClient } from 'mqtt'; import { MQTT_DECORATOR_KEY } from './decorator'; @Framework() export class MidwayMQTTFramework extends BaseFramework< IMidwayMQTTApplication, IMidwayMQTTContext, IMidwayMQTTConfigurationOptions > { protected subscriberMap: Map = new Map(); protected frameworkLoggerName = 'mqttLogger'; configure() { return this.configService.getConfiguration('mqtt'); } async applicationInitialize(options) { this.app = {} as any; } public async run(): Promise { const { sub } = this.configurationOptions; if (Object.keys(sub || {}).length === 0) { this.logger.info( '[midway-mqtt] Not found consumer config, skip init consumer' ); } // find subscriber const mqttSubscriberModules = DecoratorManager.listModule(MQTT_DECORATOR_KEY); const mqttSubscriberMap = {}; for (const subscriberModule of mqttSubscriberModules) { const subscriberName = MetadataManager.getOwnMetadata( MQTT_DECORATOR_KEY, subscriberModule ) as string; mqttSubscriberMap[subscriberName] = subscriberModule; } for (const customKey in sub) { await this.createSubscriber( sub[customKey].connectOptions, sub[customKey].subscribeOptions, mqttSubscriberMap[customKey], customKey ); } } protected async beforeStop(): Promise { for (const [name, consumer] of this.subscriberMap) { await consumer.endAsync(); this.logger.info(`[midway-mqtt] subscriber: ${name} is closed`); } } /** * dynamic create subscriber */ public async createSubscriber( /** * mqtt connection options */ connectionOptions: IClientOptions, /** * mqtt subscribe options */ subscribeOptions: MqttSubscriberOptions, /** * midway mqtt subscriber class */ ClzProvider: new () => IMqttSubscriber, /** * midway mqtt component instance name, if not set, will be manager by your self */ clientName?: string ) { const consumer = await new Promise(resolve => { const client = connect(connectionOptions); client.on('connect', () => { if (clientName) { this.logger.info( '[midway-mqtt] subscriber: %s is connect', clientName ); this.subscriberMap.set(clientName, client); } resolve(client); }); client.on('error', err => { this.logger.error(err); }); }); consumer.on('message', async (topic, message, packet) => { const ctx = this.app.createAnonymousContext(); ctx.topic = topic; ctx.packet = packet; ctx.message = message; const traceService = this.applicationContext.get(MidwayTraceService); const traceMetaResolver = (this.configurationOptions as any)?.tracing ?.meta; const traceEnabled = (this.configurationOptions as any)?.tracing?.enable !== false; const traceExtractor = (this.configurationOptions as any)?.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); } ); }); await consumer.subscribeAsync( subscribeOptions.topicObject, subscribeOptions.opts ); return consumer; } public getSubscriber(name: string) { return this.subscriberMap.get(name); } public getSubscribers(): MqttClient[] { return Object.values(this.subscriberMap); } public getFrameworkName() { return 'mqtt'; } }