@havue/solutions 1.1.1 → 1.2.0

package/bc-connect/__tests__/bc-connect.spec.ts

@@ -0,0 +1,73 @@
+import { describe, expect, it } from 'vitest'
+import { BroadcastChannelManager, BcConnectNodeTypeEnum } from '@havue/bc-connect'
+
+async function sleep(time) {
+  return new Promise((res) => {
+    setTimeout(res, time)
+  })
+}
+
+const DEBUG = false
+
+describe.sequential('BroadcastChannelManager', () => {
+  it('should create a new instance', () => {
+    const manager = new BroadcastChannelManager('test-channel', DEBUG)
+    expect(manager).toBeInstanceOf(BroadcastChannelManager)
+    manager.destroy()
+  })
+
+  it('should be Main', async () => {
+    const manager = new BroadcastChannelManager('test-channel', DEBUG)
+    manager.connect()
+    expect(manager.nodeType).toBeUndefined()
+    await sleep(400)
+    expect(manager.nodeType).toBe(BcConnectNodeTypeEnum.Main)
+    manager.close()
+    manager.destroy()
+  })
+
+  it('when channel closed', async () => {
+    const manager = new BroadcastChannelManager('test-channel', DEBUG)
+    manager.connect()
+    manager.close()
+    await sleep(400)
+    expect(manager.nodeType).toBeUndefined()
+    manager.destroy()
+  })
+
+  it('should handle messages', async () => {
+    const manager1 = new BroadcastChannelManager('test-channel', DEBUG)
+    // 确保第二个id生成在第一个之后
+    await sleep(10)
+    const manager2 = new BroadcastChannelManager('test-channel', DEBUG)
+    manager1.connect()
+    manager2.connect()
+    await sleep(1200)
+
+    const message1 = { type: 'test', data: 'Hello, manger2!' }
+    const message2 = { type: 'test', data: 'Hello, manger1!' }
+
+    manager1.on('test', (message) => {
+      expect(message.data).toBe(message2.data)
+    })
+    manager2.on('test', (message) => {
+      expect(message.data).toBe(message1.data)
+    })
+
+    manager1.send(message1.type, message1.data)
+    manager2.send(message2.type, message2.data)
+    expect(manager1.nodeType).toBe(BcConnectNodeTypeEnum.Main)
+    expect(manager2.nodeType).toBe(BcConnectNodeTypeEnum.Normal)
+
+    expect(manager1.friendList).toContain(manager2.id)
+    expect(manager2.friendList).toContain(manager1.id)
+
+    // wait for the message to be received
+    await sleep(1000)
+    manager1.close()
+    manager2.close()
+
+    manager1.destroy()
+    manager2.destroy()
+  })
+})

package/bc-connect/dist/bc-connect.mjs

@@ -2,14 +2,14 @@ var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var BcConnectEventTypeEnum = /* @__PURE__ */ ((BcConnectEventTypeEnum2) => {
-  BcConnectEventTypeEnum2["Broadcast"] = "Hello world";
-  BcConnectEventTypeEnum2["Broadcast_Reply"] = "I can hear you";
-  BcConnectEventTypeEnum2["Main_Node_Hearbeat"] = "苍天还在，别立黄天";
-  BcConnectEventTypeEnum2["Res_Main_Node_Hearbeat"] = "苍天在上，受我一拜";
-  BcConnectEventTypeEnum2["Req_Be_Main_Node"] = "苍天已死，黄天当立";
-  BcConnectEventTypeEnum2["Res_Be_Main_Node"] = "我是黄天，尔等退下";
-  BcConnectEventTypeEnum2["Node_Type_Change"] = "node type change";
-  BcConnectEventTypeEnum2["Friend_List_Update"] = "friend list update";
+  BcConnectEventTypeEnum2["Broadcast"] = "__BCM_INIT__";
+  BcConnectEventTypeEnum2["Broadcast_Reply"] = "__BCM_INIT_REPLY__";
+  BcConnectEventTypeEnum2["Main_Node_Hearbeat"] = "__BCM_MAIN_NODE_HEARBEAT__";
+  BcConnectEventTypeEnum2["Res_Main_Node_Hearbeat"] = "__BCM_MAIN_NODE_HEARBEAT_REPLY__";
+  BcConnectEventTypeEnum2["Req_Be_Main_Node"] = "__BCM_REQ_BE_MAIN_NODE__";
+  BcConnectEventTypeEnum2["Res_Be_Main_Node"] = "__BCM_REQ_BE_MAIN_NODE_REJECT__";
+  BcConnectEventTypeEnum2["Node_Type_Change"] = "__BCM_NODE_TYPE_CHANGE__";
+  BcConnectEventTypeEnum2["Friend_List_Update"] = "__BCM_FRIEND_LIST_UPDATE__";
   return BcConnectEventTypeEnum2;
 })(BcConnectEventTypeEnum || {});
 var BcConnectNodeTypeEnum = /* @__PURE__ */ ((BcConnectNodeTypeEnum2) => {
@@ -20,25 +20,30 @@ var BcConnectNodeTypeEnum = /* @__PURE__ */ ((BcConnectNodeTypeEnum2) => {
 const MessageTimeout = 300;
 class BroadcastChannelManager {
   constructor(name, debug = false) {
-    /** 通道名称 */
+    /** 通道名称 | Channel name */
     __publicField(this, "_bcName");
-    /** BroadcastChannel实例 */
+    /** BroadcastChannel instance */
     __publicField(this, "_broadcastChannel");
-    /** 事件map */
+    /** Event map */
     __publicField(this, "_eventMap");
-    /** 主节点发送心跳的interval */
+    /** 主节点发送心跳的interval | The interval at which the master node sends the heartbeat */
     __publicField(this, "_mainNodeMsgInterval", null);
-    /** 认为主节点掉线的timeout */
-    __publicField(this, "_mainNoceMsgTimeoutTimer", null);
-    /** 当前实例id */
+    /** 认为主节点掉线的timeout | timeout to consider the primary node to be offline */
+    __publicField(this, "_mainNodeMsgTimeoutTimer", null);
+    /** 更新友方列表的timeout | Update the timeout of the friend list */
+    __publicField(this, "_updateFriendListTimer", null);
+    /** 当前实例id | Current instance id */
     __publicField(this, "id", Date.now() + Math.random());
-    /** 记录的友方id数组 */
+    /** 其他广播通道id列表 | List of other broadcast channel ids */
     __publicField(this, "_oldFrendChannelIdList", []);
-    /** 正在更新的右方id数组 */
+    /** 正在更新的id数组 | The id array being updated */
     __publicField(this, "_friendChannelIdSet", /* @__PURE__ */ new Set());
-    /** 当前节点类型 */
+    /** 当前节点类型 | Current node type */
     __publicField(this, "_nodeType");
-    /** 是否开启调试模式，会在控制台打印相关信息 */
+    /**
+     * 是否开启调试模式，会在控制台打印相关信息
+     * If debug mode is enabled, it will print information to the console
+     */
     __publicField(this, "_debug", false);
     this._debug = debug;
     this._bcName = name;
@@ -61,9 +66,19 @@ class BroadcastChannelManager {
   close() {
     this._debug && console.log("BC:bc close");
     this._broadcastChannel && this._broadcastChannel.close();
+    this._broadcastChannel = void 0;
+    this._updateFriendListTimer && clearTimeout(this._updateFriendListTimer);
+    this._updateFriendListTimer = null;
+    this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
+    this._mainNodeMsgInterval = null;
+    this._mainNodeMsgTimeoutTimer && clearTimeout(this._mainNodeMsgTimeoutTimer);
+    this._mainNodeMsgTimeoutTimer = null;
+    this._oldFrendChannelIdList = [];
+    this._friendChannelIdSet.clear();
+    this._nodeType = void 0;
   }
   /**
-   * 切换节点类型
+   * 切换节点类型 | Switching node type
    * @param {BcConnectNodeTypeEnum} type
    * @returns
    */
@@ -72,30 +87,31 @@ class BroadcastChannelManager {
       return;
     }
     this._nodeType = type;
-    this.emit("node type change", {
-      type: "node type change",
+    this.emit("__BCM_NODE_TYPE_CHANGE__", {
+      type: "__BCM_NODE_TYPE_CHANGE__",
       data: type,
       id: this.id
     });
   }
-  /** 更新友方列表 */
+  /** 更新广播id列表 | Update the list of broadcast ids */
   _updateFriendList() {
     this.send(
-      "Hello world"
+      "__BCM_INIT__"
       /* Broadcast */
     );
-    setTimeout(() => {
+    this._updateFriendListTimer && clearTimeout(this._updateFriendListTimer);
+    this._updateFriendListTimer = setTimeout(() => {
       this._oldFrendChannelIdList = this._getNewFriendList();
       this._debug && console.log("BC:connect:updateFriendChannelIdList:", this._oldFrendChannelIdList);
-      this.emit("friend list update", {
-        type: "friend list update",
+      this.emit("__BCM_FRIEND_LIST_UPDATE__", {
+        type: "__BCM_FRIEND_LIST_UPDATE__",
         data: [...this._oldFrendChannelIdList],
         id: this.id
       });
       this._updataNodeType();
     }, MessageTimeout);
   }
-  /** 绑定事件 */
+  /** 绑定事件 | Bind event */
   _bindBroadcastChannelEvent() {
     this._broadcastChannel && (this._broadcastChannel.onmessage = (event) => {
       const { type, targetId } = event.data;
@@ -104,63 +120,63 @@ class BroadcastChannelManager {
       }
       this.emit(type, event.data);
     });
-    this.on("Hello world", (data) => {
+    this.on("__BCM_INIT__", (data) => {
       const { id } = data;
       if (!this._friendChannelIdSet.has(id)) {
         this._friendChannelIdSet.add(id);
       }
-      this.sendToTarget("I can hear you", id);
+      this.sendToTarget("__BCM_INIT_REPLY__", id);
     });
-    this.on("I can hear you", (data) => {
+    this.on("__BCM_INIT_REPLY__", (data) => {
       const { id } = data;
       this._addFriend(id);
     });
-    this.on("苍天已死，黄天当立", (data) => {
+    this.on("__BCM_REQ_BE_MAIN_NODE__", (data) => {
       const { id } = data;
       if (id > this.id) {
-        this.sendToTarget("我是黄天，尔等退下", id);
+        this.sendToTarget("__BCM_REQ_BE_MAIN_NODE_REJECT__", id);
       }
     });
-    this.on("苍天在上，受我一拜", (data) => {
+    this.on("__BCM_MAIN_NODE_HEARBEAT_REPLY__", (data) => {
       this._addFriend(data.id);
     });
     this._bindNodeEvent();
   }
-  /** 监听节点类型切换事件 */
+  /** 监听节点类型切换事件 |  */
   _bindNodeEvent() {
     const onMainNodeHearbeat = (data) => {
       this._timeoutToBeMainNode();
       this._catchOldFriend();
       this._addFriend(data.id);
       this.send(
-        "苍天在上，受我一拜"
+        "__BCM_MAIN_NODE_HEARBEAT_REPLY__"
         /* Res_Main_Node_Hearbeat */
       );
     };
-    this.on("node type change", (info) => {
+    this.on("__BCM_NODE_TYPE_CHANGE__", (info) => {
       const { data } = info;
       this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
-      this._debug && console.log("BC:代理类型切换：", info.data);
+      this._debug && console.log("BC:NODE_TYPE_CHANGE：", info.data);
       if (data === "main") {
         this._mainNodeMsgInterval = setInterval(() => {
           this._catchOldFriend();
           this.send(
-            "苍天还在，别立黄天"
+            "__BCM_MAIN_NODE_HEARBEAT__"
             /* Main_Node_Hearbeat */
           );
         }, MessageTimeout);
       } else if (data === "normal") {
         this._timeoutToBeMainNode();
       }
-      this.on("苍天还在，别立黄天", onMainNodeHearbeat);
+      this.on("__BCM_MAIN_NODE_HEARBEAT__", onMainNodeHearbeat);
     });
   }
-  /** 获取最新的友方列表 */
+  /** 获取最新的节点列表 | Get the latest node list */
   _getNewFriendList() {
     return [...this._friendChannelIdSet].sort((a, b) => a - b);
   }
   /**
-   * 更新当前节点类型
+   * 更新当前节点类型 | Update the current node type
    */
   _updataNodeType() {
     this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
@@ -183,21 +199,21 @@ class BroadcastChannelManager {
     }
   }
   _timeoutToBeMainNode() {
-    this._mainNoceMsgTimeoutTimer && clearTimeout(this._mainNoceMsgTimeoutTimer);
-    this._mainNoceMsgTimeoutTimer = setTimeout(() => {
+    this._mainNodeMsgTimeoutTimer && clearTimeout(this._mainNodeMsgTimeoutTimer);
+    this._mainNodeMsgTimeoutTimer = setTimeout(() => {
       this._req_beMainNode();
     }, MessageTimeout * 3);
   }
   /**
-   * 保持记录的活跃的友方id列表
-   * 清空正在记录的友方id列表
+   * 保存最新的节点列表到_oldFrendChannelIdList，清空_friendChannelIdSet
+   * Save the latest node list to _oldFrendChannelIdList and clear _friendChannelIdSet
    */
   _catchOldFriend() {
     const newFriendList = this._getNewFriendList();
     if (this._oldFrendChannelIdList.join() !== newFriendList.join()) {
       this._debug && console.log("BC:updateFriendChannelIdList:", newFriendList);
-      this.emit("friend list update", {
-        type: "friend list update",
+      this.emit("__BCM_FRIEND_LIST_UPDATE__", {
+        type: "__BCM_FRIEND_LIST_UPDATE__",
         data: [...newFriendList],
         id: this.id
       });
@@ -212,12 +228,12 @@ class BroadcastChannelManager {
     this._friendChannelIdSet.clear();
   }
   /**
-   * 申请成为主节点
+   * 申请成为主节点 | Apply to be a master node
    */
   _req_beMainNode() {
     this._debug && console.log("BC:req_beMainNode");
     this.send(
-      "苍天已死，黄天当立"
+      "__BCM_REQ_BE_MAIN_NODE__"
       /* Req_Be_Main_Node */
     );
     const timer = setTimeout(() => {
@@ -228,13 +244,13 @@ class BroadcastChannelManager {
     }, MessageTimeout);
     const handleRes_beMainNode = () => {
       clearTimeout(timer);
-      this.off("我是黄天，尔等退下", handleRes_beMainNode);
+      this.off("__BCM_REQ_BE_MAIN_NODE_REJECT__", handleRes_beMainNode);
     };
-    this.on("我是黄天，尔等退下", handleRes_beMainNode);
+    this.on("__BCM_REQ_BE_MAIN_NODE_REJECT__", handleRes_beMainNode);
   }
   /**
-   * 添加友方
-   * @param id 节点id
+   * add node
+   * @param id id
    */
   _addFriend(id) {
     if (!this._friendChannelIdSet.has(id)) {
@@ -242,9 +258,9 @@ class BroadcastChannelManager {
     }
   }
   /**
-   * 广播消息
-   * @param type 消息类型
-   * @param data 数据
+   * 广播消息 | Send Broadcast message
+   * @param type 消息类型 | Message type
+   * @param data 数据 | data
    */
   send(type, data) {
     var _a;
@@ -255,10 +271,10 @@ class BroadcastChannelManager {
     });
   }
   /**
-   * 给特定id的节点发送消息
-   * @param type 消息类型
-   * @param targetId 目标节点id
-   * @param data 数据
+   * 给特定id的节点发送消息 | Send a message to a node with a specific id
+   * @param type 消息类型 | Message type
+   * @param targetId 目标节点id | Target Node id
+   * @param data 数据 | data
    */
   sendToTarget(type, targetId, data) {
     var _a;
@@ -270,9 +286,9 @@ class BroadcastChannelManager {
     });
   }
   /**
-   * 注册事件
-   * @param { string } event 事件类型
-   * @param callback 回调
+   * 注册事件 | Registering events
+   * @param { string } event 事件类型 | Event type
+   * @param callback 回调 | callback
    * @returns void
    */
   on(event, callback) {
@@ -287,9 +303,9 @@ class BroadcastChannelManager {
     callbacks.push(callback);
   }
   /**
-   * 注销事件
-   * @param { string } event 事件类型
-   * @param callback 事件回调
+   * 注销事件 | Remove events
+   * @param { string } event 事件类型 | Event type
+   * @param callback 事件回调 | callback
    * @returns
    */
   off(event, callback) {
@@ -305,9 +321,9 @@ class BroadcastChannelManager {
     callbacks.splice(index, 1);
   }
   /**
-   * 触发事件
-   * @param { string } event 事件类型
-   * @param data 数据
+   * 触发事件 | Triggering events
+   * @param { string } event 事件类型 | Event type
+   * @param data 数据 | data
    */
   emit(event, data) {
     const callbacks = this._eventMap.get(event) || [];
@@ -316,7 +332,7 @@ class BroadcastChannelManager {
     });
   }
   /**
-   * 销毁
+   * 销毁 | destroy
    */
   destroy() {
     var _a;
@@ -330,8 +346,8 @@ class BroadcastChannelManager {
     this._nodeType = void 0;
     this._mainNodeMsgInterval && clearInterval(this._mainNodeMsgInterval);
     this._mainNodeMsgInterval = null;
-    this._mainNoceMsgTimeoutTimer && clearInterval(this._mainNoceMsgTimeoutTimer);
-    this._mainNoceMsgTimeoutTimer = null;
+    this._mainNodeMsgTimeoutTimer && clearInterval(this._mainNodeMsgTimeoutTimer);
+    this._mainNodeMsgTimeoutTimer = null;
     this._debug && console.log("BC:destroy");
   }
 }