mm_mqtt_server 2.0.0 → 2.0.1

package/lib/mqtt_server.js

@@ -5,6 +5,12 @@ const { Aedes } = require('aedes');
 const { Mod } = require('mm_mod');
 const { eventAdmin } = require('mm_event');
 
+/**
+ * 代理自发布标记：打在发布报文上，用于在 broker 的 publish 事件中避免回环。
+ * 使用 Symbol 避免污染报文序列化，aedes 转投给订阅者时按字段复制也不会带上该标记。
+ */
+const SELF_PUBLISH = Symbol('mm_mqtt_server.self_publish');
+
 /**
  * MqttServer —— 最薄的 MQTT 代理传输层（入站适配器模块）。
  *
@@ -33,9 +39,10 @@ class MqttServer extends Mod {
     title: 'MQTT代理服务器模块',
     description: 'MQTT 传输层：消息直达事件管理器，不做路由与插件',
     version: '2.0.0',
+    allow_anonymous: true,
+    scope: 'mqtt',
     host: '0.0.0.0',
     port: 1883,
-    allow_anonymous: true,
     username: '',
     password: '',
     options: {},
@@ -80,22 +87,41 @@ class MqttServer extends Mod {
    */
   constructor(config, server) {
     super(config, server);
-    this.#events = eventAdmin('mqtt');
+    this.#events = eventAdmin(this.config.scope);
   }
 
   // ---------- 生命周期钩子 ----------
   /**
-   * 启动钩子：创建 broker 与 TCP 服务器并开始监听
+   * 启动钩子：创建 broker 与 TCP 服务器并开始监听，失败时回滚已创建的资源
    * @returns {Promise<void>} 无返回值
    */
   async onStart() {
-    const broker = await this._createBroker();
-    this.#broker = broker;
-    this._bindBrokerEvents(broker);
-    const server = net.createServer((stream) => broker.handle(stream));
-    this.#server = server;
-    await this._listen(server);
-    server.on('error', (err) => this._emitError(err));
+    try {
+      const broker = await this._createBroker();
+      this.#broker = broker;
+      this._bindBrokerEvents(broker);
+      const server = net.createServer((stream) => broker.handle(stream));
+      this.#server = server;
+      await this._listen(server);
+      server.on('error', (err) => this._emitError(err));
+    } catch (err) {
+      await this._rollbackStart();
+      throw err;
+    }
+  }
+
+  /**
+   * 启动失败时回滚已创建的资源（服务器与 broker 的内部定时器）
+   * @returns {Promise<void>} 无返回值
+   */
+  async _rollbackStart() {
+    try {
+      this._closeAllClients();
+      await this._closeServer();
+      await this._closeBroker();
+    } catch (err) {
+      this._emitError(err);
+    }
   }
 
   /**
@@ -197,14 +223,19 @@ class MqttServer extends Mod {
     const broker = this.#broker;
     if (!broker) return Promise.resolve(false);
     const packet = this._buildPacket(topic, payload, opts);
+    packet[SELF_PUBLISH] = true;
     return new Promise((resolve, reject) => {
-      broker.publish(packet, (err) => {
-        if (err) {
-          reject(err);
-          return;
-        }
-        resolve(true);
-      });
+      try {
+        broker.publish(packet, (err) => {
+          if (err) {
+            reject(err);
+            return;
+          }
+          resolve(true);
+        });
+      } catch (err) {
+        reject(err);
+      }
     });
   }
 
@@ -284,12 +315,10 @@ class MqttServer extends Mod {
    * @param {Object} broker aedes broker 实例
    */
   _bindBrokerEvents(broker) {
+    broker.on('error', (err) => this._emitError(err));
     broker.on('client', (client) => this._registerClient(client));
-    broker.on('clientDisconnect', (client) => this.#clients.delete(client.id));
-    broker.on('publish', (packet, client) => {
-      if (!client) return;
-      this._handlePublish(client, packet);
-    });
+    broker.on('clientDisconnect', (client) => this._unregisterClient(client));
+    broker.on('publish', (packet, client) => this._dispatchPublish(packet, client));
     broker.on('clientError', (client, err) => this._emitError(err));
     broker.on('connectionError', (client, err) => this._emitError(err));
   }
@@ -308,21 +337,92 @@ class MqttServer extends Mod {
   }
 
   /**
-   * 处理入站发布消息：交给事件管理器，返回发布描述时由代理重发
+   * 注销客户端：仅当连接表中记录的仍是该实例时才删除，避免误删同 ID 的新连接
    * @param {Object} client aedes client 实例
+   */
+  _unregisterClient(client) {
+    const entry = this.#clients.get(client.id);
+    if (entry && entry.client === client) this.#clients.delete(client.id);
+  }
+
+  /**
+   * 分发 broker 发布事件：过滤系统主题与代理自发布后转交事件管理器
+   * @param {Object} packet aedes 发布报文
+   * @param {Object|null} client 发布客户端，内部消息与代理自发布时为 null
+   */
+  _dispatchPublish(packet, client) {
+    if (this._isInternalTopic(packet.topic)) return;
+    if (!client && this._isSelfPublish(packet)) return;
+    this._handlePublish(client, packet);
+  }
+
+  /**
+   * 判断报文是否由代理自身发布（按报文上的自发布标记判断）
+   * @param {Object} packet aedes 发布报文
+   * @returns {boolean} 是否为代理自发布
+   */
+  _isSelfPublish(packet) {
+    return packet[SELF_PUBLISH] === true;
+  }
+
+  /**
+   * 判断是否为 broker 系统主题
+   * @param {string} topic 主题
+   * @returns {boolean} 是否为系统主题
+   */
+  _isInternalTopic(topic) {
+    return topic === '$SYS' || topic.startsWith('$SYS/');
+  }
+
+  /**
+   * 处理入站发布消息：交给事件管理器，返回发布描述时由代理重发
+   * @param {Object|null} client aedes client 实例，遗嘱等内部来源可能为 null
    * @param {Object} packet aedes 发布报文
    * @returns {Promise<void>} 无返回值
    */
   async _handlePublish(client, packet) {
-    const params = {
-      client_id: client.id,
+    const client_id = client ? client.id : null;
+    const params = this._buildParams(client_id, packet);
+    const ctx = this._buildContext(client_id, packet, client);
+    const options = client_id ? this._clientOptions(client_id) : {};
+    try {
+      const result = await this.#events.run(packet.topic, params, ctx, options);
+      const error = ctx.error || options.error;
+      if (error) this._emitError(error);
+      if (this._isRepublish(result)) {
+        await this.publish(result.topic, result.payload, result);
+      }
+    } catch (err) {
+      this._emitError(err);
+    }
+  }
+
+  /**
+   * 构建事件执行参数
+   * @param {string|null} client_id 客户端编号
+   * @param {Object} packet aedes 发布报文
+   * @returns {Object} 参数对象
+   */
+  _buildParams(client_id, packet) {
+    return {
+      client_id,
       topic: packet.topic,
       payload: packet.payload.toString('utf8'),
       qos: packet.qos,
       retain: packet.retain
     };
-    const ctx = {
-      client_id: client.id,
+  }
+
+  /**
+   * 构建事件执行上下文
+   * @param {string|null} client_id 客户端编号
+   * @param {Object} packet aedes 发布报文
+   * @param {Object|null} client aedes client 实例
+   * @returns {Object} 上下文对象
+   */
+  _buildContext(client_id, packet, client) {
+    return {
+      client_id,
       topic: packet.topic,
       qos: packet.qos,
       retain: packet.retain,
@@ -330,17 +430,6 @@ class MqttServer extends Mod {
       client,
       broker: this.#broker
     };
-    const options = this._clientOptions(client.id);
-    try {
-      const result = await this.#events.run(packet.topic, params, ctx, options);
-      const error = ctx.error || options.error;
-      if (error) this._emitError(error);
-      if (this._isRepublish(result)) {
-        await this.publish(result.topic, result.payload, result);
-      }
-    } catch (err) {
-      this._emitError(err);
-    }
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mm_mqtt_server",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "最薄的 MQTT 代理服务器入站适配器：消息直达 mm_event 事件管理器，不做路由与插件。",
   "keywords": [
     "超级美眉",