rol-websocket-channel 1.0.2 → 1.0.6

package/src/mqtt/connection-manager.ts

@@ -1,188 +1,262 @@
-// MQTT 连接管理器
-// 负责管理 MQTT 连接的建立和维护（使用 MQTT.js 自带的重连功能）
-
-import type { MqttConnection, MqttConfig, ConnectionCallbacks } from "./types.js";
-
-// 全局连接存储
-const connections = new Map<string, MqttConnection>();
-
-/**
- * 获取连接
- */
-export function getConnection(accountId: string): MqttConnection | undefined {
-  const conn = connections.get(accountId);
-  console.log(`[MQTT] getConnection(${accountId}): ${conn ? 'found' : 'not found'}`);
-  return conn;
-}
-
-/**
- * 检查连接是否存在且已连接
- */
-export function isConnected(accountId: string): boolean {
-  const conn = connections.get(accountId);
-  const connected = !!(conn && conn.ws && conn.ws.connected);
-  console.log(`[MQTT] isConnected(${accountId}): ${connected}`);
-  return connected;
-}
-
-/**
- * 删除连接
- */
-export function removeConnection(accountId: string): void {
-  console.log(`[MQTT] removeConnection(${accountId})`);
-  connections.delete(accountId);
-}
-
-/**
- * 创建 MQTT 连接
- * 使用 MQTT.js 自带的重连功能
- */
-export async function createMqttConnection(
-  config: MqttConfig,
-  callbacks: ConnectionCallbacks,
-): Promise<MqttConnection> {
-  const { mqttUrl, mqttTopic, accountId } = config;
-  console.log(`[MQTT] createMqttConnection(${accountId}): url=${mqttUrl}, topic=${mqttTopic}`);
-
-  // 如果已有活跃连接，直接返回（防止重复创建）
-  const existingConn = connections.get(accountId);
-  if (existingConn && existingConn.ws && existingConn.ws.connected) {
-    console.log(`[MQTT] createMqttConnection(${accountId}): connection already exists and connected, skipping`);
-    return existingConn;
-  }
-
-  // 如果有未连接的旧连接，先关闭
-  if (existingConn) {
-    console.log(`[MQTT] createMqttConnection(${accountId}): closing existing disconnected connection`);
-    existingConn.ws.end(true);
-    connections.delete(accountId);
-  }
-
-  // 动态导入 mqtt 库
-  console.log(`[MQTT] createMqttConnection(${accountId}): importing mqtt library...`);
-  const mqtt = await import("mqtt");
-  console.log(`[MQTT] createMqttConnection(${accountId}): mqtt library imported`);
-
-  // 创建 MQTT 客户端，启用自带的重连功能
-  console.log(`[MQTT] createMqttConnection(${accountId}): creating client with reconnect...`);
-  const client = mqtt.default.connect(mqttUrl, {
-    reconnectPeriod: 5000,  // 5秒后自动重连
-    connectTimeout: 30000,  // 连接超时 30秒
-    keepalive: 30,          // 心跳 30秒
-    clean: true,            // 清理会话
-  });
-  console.log(`[MQTT] createMqttConnection(${accountId}): client created`);
-
-  // 存储连接
-  const connection: MqttConnection = {
-    ws: client,
-    accountId,
-    mqttTopic,
-  };
-  connections.set(accountId, connection);
-  console.log(`[MQTT] createMqttConnection(${accountId}): connection stored, total connections=${connections.size}`);
-
-  // 设置事件处理器
-  setupEventHandlers(client, accountId, mqttTopic, callbacks);
-  console.log(`[MQTT] createMqttConnection(${accountId}): event handlers set up`);
-
-  return connection;
-}
-
-/**
- * 设置 MQTT 事件处理器
- */
-function setupEventHandlers(
-  client: any,
-  accountId: string,
-  mqttTopic: string,
-  callbacks: ConnectionCallbacks,
-): void {
-  const { onConnect, onDisconnect, onError, onClose, onMessage } = callbacks;
-
-  // 连接成功
-  client.on("connect", () => {
-    console.log(`[MQTT] ✅ Connected to broker for account: ${accountId}`);
-
-    // 订阅 topic
-    console.log(`[MQTT] subscribing to topic: ${mqttTopic} for account: ${accountId}`);
-    client.subscribe(mqttTopic, (err: Error | null) => {
-      if (err) {
-        console.error(`[MQTT] ❌ Failed to subscribe: ${err.message}`);
-      } else {
-        console.log(`[MQTT] ✅ Subscribed to: ${mqttTopic}`);
-      }
-    });
-
-    onConnect?.();
-  });
-
-  // 收到消息
-  client.on("message", (topic: string, payload: Buffer) => {
-    console.log(`[MQTT] 📨 message received on topic: ${topic}, size: ${payload.length} bytes`);
-    onMessage?.(topic, payload);
-  });
-
-  // 连接错误
-  client.on("error", (err: Error) => {
-    console.error(`[MQTT] ❌ Error for account ${accountId}: ${err.message}`);
-    onError?.(err);
-    // MQTT.js 会自动处理重连，不需要我们干预
-  });
-
-  // 连接断开
-  client.on("disconnect", () => {
-    console.log(`[MQTT] 🔴 Disconnected for account: ${accountId}`);
-    onDisconnect?.();
-  });
-
-  // 连接关闭
-  client.on("close", () => {
-    console.log(`[MQTT] 🔴 Connection closed for account: ${accountId}`);
-    // 注意：MQTT.js 会自动重连，不要在这里删除连接
-    // 只有在手动停止时才删除
-    onClose?.();
-  });
-
-  // 重连开始
-  client.on("reconnect", () => {
-    console.log(`[MQTT] 🔄 Reconnecting for account: ${accountId}...`);
-  });
-
-  // 离线
-  client.on("offline", () => {
-    console.log(`[MQTT] 😴 Client offline for account: ${accountId}`);
-  });
-}
-
-/**
- * 关闭连接（手动停止时使用）
- */
-export function closeConnection(accountId: string): void {
-  console.log(`[MQTT] closeConnection(${accountId}): closing connection...`);
-  const conn = connections.get(accountId);
-  if (conn) {
-    console.log(`[MQTT] closeConnection(${accountId}): ending mqtt client...`);
-    // force=true 立即关闭，不触发重连
-    conn.ws.end(true);
-    removeConnection(accountId);
-    console.log(`[MQTT] closeConnection(${accountId}): connection closed`);
-  } else {
-    console.log(`[MQTT] closeConnection(${accountId}): no connection found`);
-  }
-}
-
-/**
- * 发布消息
- */
-export function publishMessage(accountId: string, topic: string, message: string): boolean {
-  const conn = connections.get(accountId);
-  if (!conn || !conn.ws || !conn.ws.connected) {
-    console.error(`[MQTT] ❌ No connection available for account: ${accountId}`);
-    return false;
-  }
-
-  console.log(`[MQTT] publishMessage(${accountId}): publishing to ${topic}`);
-  conn.ws.publish(topic, message);
-  return true;
-}
+// MQTT 全局连接管理器
+// 全局共享单一连接（随机 clientId，从 topic 解析用户名，支持测试注入）
+
+import type {
+  MqttConnection,
+  ConnectionCallbacks,
+  MqttConnectFn,
+} from "./types.js";
+
+// ─────────────────────────────────────────────
+// 全局单例连接
+// ─────────────────────────────────────────────
+let globalConnection: MqttConnection | null = null;
+
+// ─────────────────────────────────────────────
+// 可注入的 mqtt connect 工厂（用于测试 mock）
+// ─────────────────────────────────────────────
+let _mqttConnectFn: MqttConnectFn | null = null;
+
+/**
+ * 注入自定义 mqtt connect 函数（测试用）
+ * 传入 null 恢复默认行为（使用真实 mqtt 库）
+ */
+export function _setMqttConnectFn(fn: MqttConnectFn | null): void {
+  _mqttConnectFn = fn;
+}
+
+async function getMqttConnect(): Promise<MqttConnectFn> {
+  if (_mqttConnectFn) {
+    return _mqttConnectFn;
+  }
+  const mqtt = await import("mqtt");
+  return mqtt.default.connect.bind(mqtt.default) as MqttConnectFn;
+}
+
+// ─────────────────────────────────────────────
+// 工具函数（纯函数，便于单元测试）
+// ─────────────────────────────────────────────
+
+/**
+ * 从 MQTT topic 中解析用户名
+ *
+ * 模式：announcement/{user_name}/{agent_id}/...
+ * 例如：announcement/0b9a784d-e044-4c6f-9024-ef8799c131d1/ce627d3d-9e22-47f7-b1c6-a6ab69570fef/bot
+ *  → user_name = "0b9a784d-e044-4c6f-9024-ef8799c131d1"
+ *
+ * 若无法解析则返回 "default_name"
+ */
+export function parseUsernameFromTopic(topic: string): string {
+  if (!topic || typeof topic !== "string") return "default_name";
+  const parts = topic.split("/");
+  if (parts[0] === "announcement" && parts[1] && parts[1].trim() !== "") {
+    return parts[1].trim();
+  }
+  return "default_name";
+}
+
+/**
+ * 根据 topic 生成通配符订阅路径
+ *
+ * 若能解析到 user_name：announcement/{user_name}/#（不区分 agent_id）
+ * 否则：原始 topic 末尾补 /# 若无通配符
+ */
+export function getSubscribeTopic(topic: string): string {
+  const username = parseUsernameFromTopic(topic);
+  if (username !== "default_name") {
+    return `announcement/${username}/#`;
+  }
+  if (topic.endsWith("#")) return topic;
+  if (topic.endsWith("/")) return `${topic}#`;
+  return `${topic}/#`;
+}
+
+/**
+ * 生成随机 MQTT 客户端 ID
+ * 格式：mqtt_client_{8位随机字符}{时间戳36进制}
+ */
+export function generateClientId(): string {
+  const rand = Math.random().toString(36).slice(2, 10).padEnd(8, "0");
+  const ts = Date.now().toString(36);
+  return `mqtt_client_${rand}${ts}`;
+}
+
+// ─────────────────────────────────────────────
+// 全局连接 API
+// ─────────────────────────────────────────────
+
+/**
+ * 获取当前全局连接（可能为 null）
+ */
+export function getGlobalConnection(): MqttConnection | null {
+  return globalConnection;
+}
+
+/**
+ * 检查全局连接是否处于已连接状态
+ */
+export function isGlobalConnected(): boolean {
+  return !!globalConnection?.ws?.connected;
+}
+
+/**
+ * 创建全局 MQTT 连接（若已连接则复用）
+ *
+ * @param mqttUrl    Broker 地址，如 ws://192.168.1.152:8083/mqtt
+ * @param mqttTopic  原始 topic，用于解析用户名和作为发布目标
+ * @param callbacks  连接事件回调
+ */
+export async function createGlobalMqttConnection(
+  mqttUrl: string,
+  mqttTopic: string,
+  callbacks: ConnectionCallbacks,
+): Promise<MqttConnection> {
+  const username = parseUsernameFromTopic(mqttTopic);
+  const subscribeTopic = getSubscribeTopic(mqttTopic);
+  const clientId = generateClientId();
+
+  console.log(`[MQTT] createGlobalMqttConnection: url=${mqttUrl}`);
+  console.log(
+    `[MQTT] createGlobalMqttConnection: username=${username}, clientId=${clientId}`,
+  );
+  console.log(
+    `[MQTT] createGlobalMqttConnection: subscribeTopic=${subscribeTopic}`,
+  );
+
+  // 已有活跃连接，直接复用
+  if (globalConnection?.ws?.connected) {
+    console.log(
+      "[MQTT] createGlobalMqttConnection: reusing existing active connection",
+    );
+    return globalConnection;
+  }
+
+  // 存在断开的旧连接，先清理
+  if (globalConnection) {
+    console.log("[MQTT] createGlobalMqttConnection: closing stale connection");
+    const stale = globalConnection;
+    globalConnection = null;
+    try {
+      stale.ws.end(true);
+    } catch {
+      // ignore
+    }
+  }
+
+  // 获取 connect 函数（真实或 mock）
+  const mqttConnect = await getMqttConnect();
+
+  console.log("[MQTT] createGlobalMqttConnection: calling mqtt.connect...");
+  const client = mqttConnect(mqttUrl, {
+    clientId,
+    username,
+    reconnectPeriod: 5000, // 5 秒自动重连
+    connectTimeout: 30000, // 30 秒连接超时
+    keepalive: 30, // 30 秒心跳
+    clean: true,
+  });
+
+  globalConnection = {
+    ws: client,
+    topic: mqttTopic,
+    subscribeTopic,
+    username,
+  };
+
+  setupEventHandlers(client, subscribeTopic, callbacks);
+
+  console.log(
+    "[MQTT] createGlobalMqttConnection: connection object created, waiting for broker...",
+  );
+  return globalConnection;
+}
+
+/**
+ * 关闭全局连接
+ * 先置空再调用 end()，防止 close 事件同步触发时重入
+ */
+export function closeGlobalConnection(): void {
+  if (globalConnection) {
+    console.log("[MQTT] closeGlobalConnection: force-closing...");
+    const conn = globalConnection;
+    globalConnection = null;
+    try {
+      conn.ws.end(true);
+    } catch {
+      // ignore
+    }
+    console.log("[MQTT] closeGlobalConnection: done");
+  } else {
+    console.log("[MQTT] closeGlobalConnection: no active connection");
+  }
+}
+
+/**
+ * 向指定 topic 发布消息（使用全局连接）
+ * @returns 发布成功返回 true，未连接返回 false
+ */
+export function publishGlobalMessage(topic: string, message: string): boolean {
+  if (!isGlobalConnected()) {
+    console.error(
+      "[MQTT] ❌ publishGlobalMessage: no connected global connection",
+    );
+    return false;
+  }
+  globalConnection!.ws.publish(topic, message);
+  console.log(`[MQTT] publishGlobalMessage: published to ${topic}`);
+  return true;
+}
+
+// ─────────────────────────────────────────────
+// 内部：事件处理
+// ─────────────────────────────────────────────
+
+function setupEventHandlers(
+  client: any,
+  subscribeTopic: string,
+  callbacks: ConnectionCallbacks,
+): void {
+  const { onConnect, onDisconnect, onError, onClose, onMessage } = callbacks;
+
+  client.on("connect", () => {
+    console.log("[MQTT] ✅ Global connection established");
+    client.subscribe(subscribeTopic, (err: Error | null) => {
+      if (err) {
+        console.error(`[MQTT] ❌ Subscribe failed: ${err.message}`);
+      } else {
+        console.log(`[MQTT] ✅ Subscribed to: ${subscribeTopic}`);
+      }
+    });
+    onConnect?.();
+  });
+
+  client.on("message", (topic: string, payload: Buffer) => {
+    console.log(
+      `[MQTT] 📨 Message received on: ${topic} (${payload.length} bytes)`,
+    );
+    onMessage?.(topic, payload);
+  });
+
+  client.on("error", (err: Error) => {
+    console.error(`[MQTT] ❌ Global connection error: ${err.message}`);
+    onError?.(err);
+  });
+
+  client.on("disconnect", () => {
+    console.log("[MQTT] 🔴 Global connection disconnected");
+    onDisconnect?.();
+  });
+
+  client.on("close", () => {
+    console.log("[MQTT] 🔴 Global connection closed");
+    onClose?.();
+  });
+
+  client.on("reconnect", () => {
+    console.log("[MQTT] 🔄 Global connection reconnecting...");
+  });
+
+  client.on("offline", () => {
+    console.log("[MQTT] 😴 Global connection offline");
+  });
+}

package/src/mqtt/index.ts

@@ -1,6 +1,6 @@
-// MQTT 模块入口
-// 导出所有 MQTT 相关的类型和功能
-
-export * from "./types.js";
-export * from "./connection-manager.js";
-export * from "./mqtt-client.js";
+// MQTT 模块入口
+// 导出所有 MQTT 相关的类型和功能
+
+export * from "./types.js";
+export * from "./connection-manager.js";
+export * from "./mqtt-client.js";