dingtalk-stream 2.1.4 → 2.1.6-beta.1

package/README.md

@@ -1,3 +1,14 @@
+<p align="left">
+  <a target="_blank" href="https://github.com/open-dingtalk/dingtalk-stream-sdk-nodejs/actions/workflows/publish.yml">
+    <img src="https://img.shields.io/github/actions/workflow/status/open-dingtalk/dingtalk-stream-sdk-nodejs/publish.yml" />
+  </a>
+
+  <a target="_blank" href="https://www.npmjs.com/package/dingtalk-stream">
+    <img alt="NPM Version" src="https://img.shields.io/npm/v/dingtalk-stream">
+  </a>
+
+</p>
+
 钉钉支持 Stream 模式接入事件推送、机器人收消息以及卡片回调，该 SDK 实现了 Stream 模式。相比 Webhook 模式，Stream 模式可以更简单的接入各类事件和回调。
 
 ## 开发教程

package/dist/client.cjs

@@ -27,9 +27,13 @@ class DWClient extends EventEmitter {
   registered = false;
   reconnecting = false;
   userDisconnect = false;
-  reconnectInterval = 1e3;
+  reconnectBaseInterval = 1e3;
+  reconnectMaxInterval = 6e4;
+  reconnectAttempts = 0;
   heartbeat_interval = 8e3;
   heartbeatIntervallId;
+  reconnectTimerId;
+  isConnecting = false;
   sslopts = { rejectUnauthorized: true };
   config;
   socket;
@@ -128,13 +132,52 @@ class DWClient extends EventEmitter {
       throw new Error("build: get endpoint failed");
     }
   }
+  cleanup() {
+    if (this.heartbeatIntervallId !== void 0) {
+      clearInterval(this.heartbeatIntervallId);
+      this.heartbeatIntervallId = void 0;
+    }
+    if (this.socket) {
+      this.socket.removeAllListeners();
+      if (this.socket.readyState === WebSocket.OPEN || this.socket.readyState === WebSocket.CONNECTING) {
+        this.socket.terminate();
+      }
+      this.socket = void 0;
+    }
+  }
+  scheduleReconnect() {
+    if (!this.config.autoReconnect || this.userDisconnect || this.isConnecting) {
+      return;
+    }
+    const delay = Math.min(
+      this.reconnectBaseInterval * Math.pow(2, this.reconnectAttempts) + Math.random() * 1e3,
+      this.reconnectMaxInterval
+    );
+    this.reconnecting = true;
+    this.printDebug("Reconnecting in " + (delay / 1e3).toFixed(1) + " seconds... (attempt " + (this.reconnectAttempts + 1) + ")");
+    if (this.reconnectTimerId) {
+      clearTimeout(this.reconnectTimerId);
+    }
+    this.reconnectTimerId = setTimeout(() => {
+      this.reconnectTimerId = void 0;
+      this.connect();
+    }, delay);
+  }
   _connect() {
     return new Promise((resolve, reject) => {
-      this.userDisconnect = false;
       this.printDebug("Connecting to dingtalk websocket @ " + this.dw_url);
-      this.socket = new WebSocket(this.dw_url, this.sslopts);
+      try {
+        this.socket = new WebSocket(this.dw_url, this.sslopts);
+      } catch (err) {
+        this.printDebug("WebSocket constructor error");
+        console.warn("ERROR", err);
+        reject(err);
+        return;
+      }
+      let settled = false;
       this.socket.on("open", () => {
         this.connected = true;
+        this.reconnectAttempts = 0;
         console.info("[" + (/* @__PURE__ */ new Date()).toISOString() + "] connect success");
         if (this.config.keepAlive) {
           this.isAlive = true;
@@ -150,6 +193,8 @@ class DWClient extends EventEmitter {
             (_b = this.socket) == null ? void 0 : _b.ping("", true);
           }, this.heartbeat_interval);
         }
+        settled = true;
+        resolve();
       });
       this.socket.on("pong", () => {
         this.heartbeat();
@@ -157,37 +202,67 @@ class DWClient extends EventEmitter {
       this.socket.on("message", (data) => {
         this.onDownStream(data);
       });
-      this.socket.on("close", (err) => {
+      this.socket.on("close", () => {
         this.printDebug("Socket closed");
         this.connected = false;
         this.registered = false;
-        if (this.config.autoReconnect && !this.userDisconnect) {
-          this.reconnecting = true;
-          this.printDebug(
-            "Reconnecting in " + this.reconnectInterval / 1e3 + " seconds..."
-          );
-          setTimeout(this.connect.bind(this), this.reconnectInterval);
+        if (this.heartbeatIntervallId !== void 0) {
+          clearInterval(this.heartbeatIntervallId);
+          this.heartbeatIntervallId = void 0;
+        }
+        if (settled) {
+          this.scheduleReconnect();
         }
       });
       this.socket.on("error", (err) => {
+        var _a;
         this.printDebug("SOCKET ERROR");
         console.warn("ERROR", err);
+        (_a = this.socket) == null ? void 0 : _a.terminate();
+        if (!settled) {
+          settled = true;
+          reject(err);
+        }
       });
-      resolve();
     });
   }
   async connect() {
-    await this.getEndpoint();
-    await this._connect();
+    if (this.isConnecting) {
+      this.printDebug("connect() already in progress, skipping");
+      return;
+    }
+    this.userDisconnect = false;
+    this.isConnecting = true;
+    try {
+      this.cleanup();
+      await this.getEndpoint();
+      if (this.userDisconnect)
+        return;
+      await this._connect();
+    } catch (err) {
+      this.printDebug("Connect failed: " + (err instanceof Error ? err.message : String(err)));
+      if (!this.userDisconnect) {
+        this.reconnectAttempts++;
+        this.isConnecting = false;
+        this.scheduleReconnect();
+      }
+      return;
+    } finally {
+      this.isConnecting = false;
+    }
   }
   disconnect() {
-    var _a;
     console.info("Disconnecting.");
     this.userDisconnect = true;
-    if (this.config.keepAlive && this.heartbeatIntervallId !== void 0) {
-      clearInterval(this.heartbeatIntervallId);
+    if (this.reconnectTimerId) {
+      clearTimeout(this.reconnectTimerId);
+      this.reconnectTimerId = void 0;
     }
-    (_a = this.socket) == null ? void 0 : _a.close();
+    this.reconnecting = false;
+    this.reconnectAttempts = 0;
+    this.cleanup();
+    this.connected = false;
+    this.registered = false;
   }
   heartbeat() {
     this.isAlive = true;

package/dist/client.d.ts

@@ -50,9 +50,13 @@ declare class DWClient extends EventEmitter {
     registered: boolean;
     reconnecting: boolean;
     private userDisconnect;
-    private reconnectInterval;
+    private reconnectBaseInterval;
+    private reconnectMaxInterval;
+    private reconnectAttempts;
     private heartbeat_interval;
     private heartbeatIntervallId?;
+    private reconnectTimerId?;
+    private isConnecting;
     private sslopts;
     readonly config: DWClientConfig;
     private socket?;
@@ -85,6 +89,8 @@ declare class DWClient extends EventEmitter {
     registerCallbackListener(eventId: string, callback: (v: DWClientDownStream) => void): this;
     getAccessToken(): Promise<any>;
     getEndpoint(): Promise<this>;
+    private cleanup;
+    private scheduleReconnect;
     _connect(): Promise<void>;
     connect(): Promise<void>;
     disconnect(): void;

package/dist/client.mjs

@@ -25,9 +25,13 @@ class DWClient extends EventEmitter {
   registered = false;
   reconnecting = false;
   userDisconnect = false;
-  reconnectInterval = 1e3;
+  reconnectBaseInterval = 1e3;
+  reconnectMaxInterval = 6e4;
+  reconnectAttempts = 0;
   heartbeat_interval = 8e3;
   heartbeatIntervallId;
+  reconnectTimerId;
+  isConnecting = false;
   sslopts = { rejectUnauthorized: true };
   config;
   socket;
@@ -126,13 +130,52 @@ class DWClient extends EventEmitter {
       throw new Error("build: get endpoint failed");
     }
   }
+  cleanup() {
+    if (this.heartbeatIntervallId !== void 0) {
+      clearInterval(this.heartbeatIntervallId);
+      this.heartbeatIntervallId = void 0;
+    }
+    if (this.socket) {
+      this.socket.removeAllListeners();
+      if (this.socket.readyState === WebSocket.OPEN || this.socket.readyState === WebSocket.CONNECTING) {
+        this.socket.terminate();
+      }
+      this.socket = void 0;
+    }
+  }
+  scheduleReconnect() {
+    if (!this.config.autoReconnect || this.userDisconnect || this.isConnecting) {
+      return;
+    }
+    const delay = Math.min(
+      this.reconnectBaseInterval * Math.pow(2, this.reconnectAttempts) + Math.random() * 1e3,
+      this.reconnectMaxInterval
+    );
+    this.reconnecting = true;
+    this.printDebug("Reconnecting in " + (delay / 1e3).toFixed(1) + " seconds... (attempt " + (this.reconnectAttempts + 1) + ")");
+    if (this.reconnectTimerId) {
+      clearTimeout(this.reconnectTimerId);
+    }
+    this.reconnectTimerId = setTimeout(() => {
+      this.reconnectTimerId = void 0;
+      this.connect();
+    }, delay);
+  }
   _connect() {
     return new Promise((resolve, reject) => {
-      this.userDisconnect = false;
       this.printDebug("Connecting to dingtalk websocket @ " + this.dw_url);
-      this.socket = new WebSocket(this.dw_url, this.sslopts);
+      try {
+        this.socket = new WebSocket(this.dw_url, this.sslopts);
+      } catch (err) {
+        this.printDebug("WebSocket constructor error");
+        console.warn("ERROR", err);
+        reject(err);
+        return;
+      }
+      let settled = false;
       this.socket.on("open", () => {
         this.connected = true;
+        this.reconnectAttempts = 0;
         console.info("[" + (/* @__PURE__ */ new Date()).toISOString() + "] connect success");
         if (this.config.keepAlive) {
           this.isAlive = true;
@@ -148,6 +191,8 @@ class DWClient extends EventEmitter {
             (_b = this.socket) == null ? void 0 : _b.ping("", true);
           }, this.heartbeat_interval);
         }
+        settled = true;
+        resolve();
       });
       this.socket.on("pong", () => {
         this.heartbeat();
@@ -155,37 +200,67 @@ class DWClient extends EventEmitter {
       this.socket.on("message", (data) => {
         this.onDownStream(data);
       });
-      this.socket.on("close", (err) => {
+      this.socket.on("close", () => {
         this.printDebug("Socket closed");
         this.connected = false;
         this.registered = false;
-        if (this.config.autoReconnect && !this.userDisconnect) {
-          this.reconnecting = true;
-          this.printDebug(
-            "Reconnecting in " + this.reconnectInterval / 1e3 + " seconds..."
-          );
-          setTimeout(this.connect.bind(this), this.reconnectInterval);
+        if (this.heartbeatIntervallId !== void 0) {
+          clearInterval(this.heartbeatIntervallId);
+          this.heartbeatIntervallId = void 0;
+        }
+        if (settled) {
+          this.scheduleReconnect();
         }
       });
       this.socket.on("error", (err) => {
+        var _a;
         this.printDebug("SOCKET ERROR");
         console.warn("ERROR", err);
+        (_a = this.socket) == null ? void 0 : _a.terminate();
+        if (!settled) {
+          settled = true;
+          reject(err);
+        }
       });
-      resolve();
     });
   }
   async connect() {
-    await this.getEndpoint();
-    await this._connect();
+    if (this.isConnecting) {
+      this.printDebug("connect() already in progress, skipping");
+      return;
+    }
+    this.userDisconnect = false;
+    this.isConnecting = true;
+    try {
+      this.cleanup();
+      await this.getEndpoint();
+      if (this.userDisconnect)
+        return;
+      await this._connect();
+    } catch (err) {
+      this.printDebug("Connect failed: " + (err instanceof Error ? err.message : String(err)));
+      if (!this.userDisconnect) {
+        this.reconnectAttempts++;
+        this.isConnecting = false;
+        this.scheduleReconnect();
+      }
+      return;
+    } finally {
+      this.isConnecting = false;
+    }
   }
   disconnect() {
-    var _a;
     console.info("Disconnecting.");
     this.userDisconnect = true;
-    if (this.config.keepAlive && this.heartbeatIntervallId !== void 0) {
-      clearInterval(this.heartbeatIntervallId);
+    if (this.reconnectTimerId) {
+      clearTimeout(this.reconnectTimerId);
+      this.reconnectTimerId = void 0;
     }
-    (_a = this.socket) == null ? void 0 : _a.close();
+    this.reconnecting = false;
+    this.reconnectAttempts = 0;
+    this.cleanup();
+    this.connected = false;
+    this.registered = false;
   }
   heartbeat() {
     this.isAlive = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dingtalk-stream",
-  "version": "2.1.4",
+  "version": "v2.1.6-beta.1",
   "description": "Nodejs SDK for DingTalk Stream Mode API, Compared with the webhook mode, it is easier to access the DingTalk",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -37,7 +37,10 @@
     "build": "rimraf dist && rollup -c",
     "dev": "rollup -c --watch --watch.include 'src/**' -m inline",
     "prepublishOnly": "pnpm build",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "test": "pnpm build && node test/reconnect-mock.mjs",
+    "test:prod": "pnpm build && node test/reconnect-prod.mjs",
+    "test:demo": "node test/reconnect-storm-demo.mjs"
   },
   "repository": {
     "type": "git",
@@ -72,6 +75,7 @@
     "@types/debug": "^4.1.8",
     "@types/node": ">=16",
     "@types/ws": "^8.5.5",
+    "nock": "^14.0.11",
     "rimraf": "^5.0.1",
     "rollup": "^3.28.0",
     "rollup-plugin-dts": "^6.0.0",