@arcblock/ws 1.13.34 → 1.13.38

package/lib/server/index.js

@@ -1,9 +1,14 @@
 const EventEmitter = require('events');
+const cluster = require('cluster');
+
 const uuid = require('uuid');
 const WebSocket = require('ws');
+const eventHub = cluster.isMaster ? require('@arcblock/event-hub/single') : require('@arcblock/event-hub');
 
 const createLogger = require('../logger');
 
+const sleep = (timeout) => new Promise((resolve) => setTimeout(resolve, timeout));
+
 const reply = (socket, topic, event, response, status = 'ok') => {
   if (socket.readyState === WebSocket.OPEN) {
     const res = JSON.stringify([socket.joinRef, socket.ref, topic, event, { status, response }]);
@@ -30,6 +35,7 @@ const defaultHooks = {
  * @param {Object} opts.authenticate - authentication function to be called on connection
  * @param {Object} opts.hooks - hooks to be called on events
  * @param {Object} opts.logger - logger used to log messages
+ * @param {Object} opts.broadcastEventName - used in cluster mode, default is '@arcblock/ws:broadcast'
  * @class WsServer
  * @extends {EventEmitter}
  */
@@ -47,6 +53,9 @@ class WsServer extends EventEmitter {
     this.wss.on('error', this.onWssError.bind(this));
 
     this.topics = {}; // <topic>: Set<socket>
+
+    this.broadcastEventName = opts.broadcastEventName || '@arcblock/ws:broadcast';
+    eventHub.on(this.broadcastEventName, (data) => this._doBroadCast(data));
   }
 
   attach(server) {
@@ -92,6 +101,11 @@ class WsServer extends EventEmitter {
     let event;
     let data;
     let options = {};
+    let cb = () => {};
+
+    if (typeof args[args.length - 1] === 'function') {
+      cb = args.pop();
+    }
 
     if (args.length < 2) {
       throw new Error('Broadcasting requires at least 2 arguments');
@@ -105,29 +119,57 @@ class WsServer extends EventEmitter {
       [topic, event, data, options] = args;
     }
 
-    const opts = { enableLog: true, ...options };
+    const enableLog = options.enableLog !== undefined ? !!options.enableLog : true;
+    const replyId = uuid.v4();
 
+    // Count of clients what will receive the message
+    // The count is NOT reliable
     let count = 0;
+    eventHub.on(replyId, ({ count: c } = {}) => {
+      if (c) {
+        count += c;
+      }
+    });
 
-    if (this.topics[topic] && this.topics[topic].size) {
-      this.topics[topic].forEach((socket) => {
-        count++;
-        if (opts.enableLog) {
-          this.logger.info('broadcast message to', { topic, event, id: socket.id });
-        }
-        reply(socket, topic, event, data);
-      });
-    } else if (opts.enableLog) {
-      this.logger.info('no connections when broadcast message', { topic, event });
-    }
+    eventHub.broadcast(this.broadcastEventName, { topic, event, data, options, enableLog, replyId });
+
+    // wait 600ms for message sending by each process
+    await sleep(600);
+    eventHub.off(replyId);
 
+    const opts = { count, topic, event, data, options };
+    cb(opts);
     try {
-      await this.hooks.postBroadcast({ count, topic, event, data, options });
+      await this.hooks.postBroadcast(opts);
     } catch (error) {
       this.logger.error('postBroadcast error', { error });
     }
   }
 
+  async _doBroadCast({ topic, event, data, enableLog, replyId } = {}) {
+    try {
+      let count = 0;
+
+      if (this.topics[topic] && this.topics[topic].size) {
+        this.topics[topic].forEach((socket) => {
+          count++;
+          if (enableLog) {
+            this.logger.info('broadcast message to', { topic, event, id: socket.id });
+          }
+          reply(socket, topic, event, data);
+        });
+      } else if (enableLog) {
+        this.logger.info('no connections when broadcast message', { topic, event });
+      }
+
+      if (count > 0 && replyId) {
+        eventHub.broadcast(replyId, { count });
+      }
+    } catch (error) {
+      this.logger.error('_doBroadcast error', { error });
+    }
+  }
+
   /**
    * Send message to 1 subscriber of a topic, can be used as
    * - send(socket, event, data)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/ws",
-  "version": "1.13.34",
+  "version": "1.13.38",
   "description": "OCAP Chain websocket server and client",
   "keywords": [
     "websocket"
@@ -34,6 +34,7 @@
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
+    "@arcblock/event-hub": "1.13.38",
     "debug": "^4.3.2",
     "eventemitter3": "^4.0.4",
     "phoenix": "1.5.12",
@@ -43,5 +44,5 @@
   "devDependencies": {
     "get-port": "^5.1.1"
   },
-  "gitHead": "050827452638b848cb791f2d4c63d834eaa96e5b"
+  "gitHead": "1a63d4006790a3a995317552e6f332be8d523e67"
 }