@arcblock/ws 1.16.16 → 1.17.1

package/lib/server/index.js

@@ -2,12 +2,16 @@ const EventEmitter = require('events');
 const cluster = require('cluster');
 
 const { nanoid } = require('nanoid');
+const get = require('lodash/get');
 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 sleep = (timeout) =>
+  new Promise((resolve) => {
+    setTimeout(resolve, timeout);
+  });
 
 const reply = (socket, topic, event, response, status = 'ok') => {
   if (socket.readyState === WebSocket.OPEN) {
@@ -18,6 +22,7 @@ const reply = (socket, topic, event, response, status = 'ok') => {
 
 const noop = () => {};
 const defaultHooks = {
+  authenticateJoinChannel: noop,
   preJoinChannel: noop,
   postJoinChannel: noop,
   preLeaveChannel: noop,
@@ -74,6 +79,7 @@ class WsServer extends EventEmitter {
     const { pathname } = new URL(request.url, `http://${request.headers.host || 'unknown'}`);
     this.logger.debug('connect attempt', { pathname });
     if (this.pathname && pathname !== this.pathname) {
+      socket.write('HTTP/1.1 404 Pathname mismatch\r\n\r\n');
       socket.destroy();
       return;
     }
@@ -128,6 +134,7 @@ class WsServer extends EventEmitter {
     }
 
     const enableLog = options.enableLog !== undefined ? !!options.enableLog : true;
+    const { socketFilters } = options;
     const replyId = nanoid();
 
     // Count of clients what will receive the message
@@ -139,7 +146,7 @@ class WsServer extends EventEmitter {
       }
     });
 
-    eventHub.broadcast(this.broadcastEventName, { topic, event, data, options, enableLog, replyId });
+    eventHub.broadcast(this.broadcastEventName, { topic, event, data, options, enableLog, replyId, socketFilters });
 
     // wait 600ms for message sending by each process
     await sleep(600);
@@ -154,11 +161,16 @@ class WsServer extends EventEmitter {
     }
   }
 
-  async _doBroadCast({ topic, event, data, enableLog, replyId } = {}) {
+  async _doBroadCast({ topic, event, data, enableLog, replyId, socketFilters } = {}) {
     try {
       let count = 0;
 
       if (this.topics[topic] && this.topics[topic].size) {
+        let conditions = null;
+        if (socketFilters && Object.keys(socketFilters).length) {
+          conditions = Object.entries(socketFilters);
+        }
+
         this.topics[topic].forEach((socket) => {
           const noHeartbeatTime = Date.now() - socket.heartbeatAt;
           if (noHeartbeatTime > this.heartbeatTimeout) {
@@ -170,6 +182,10 @@ class WsServer extends EventEmitter {
             return;
           }
 
+          if (conditions && !conditions.every(([key, value]) => get(socket, key) === value)) {
+            return;
+          }
+
           count++;
           if (enableLog) {
             this.logger.info('broadcast message to', { topic, event, id: socket.id });
@@ -240,6 +256,8 @@ class WsServer extends EventEmitter {
    */
   async onWssConnection(socket) {
     socket.id = nanoid();
+    socket.channel = {};
+
     refreshHeartbeat(socket);
     this.logger.debug('socket connected', { id: socket.id });
 
@@ -275,7 +293,11 @@ class WsServer extends EventEmitter {
       if (event === 'phx_join') {
         // pre hook
         try {
-          await this.hooks.preJoinChannel({ joinRef, ref, topic, event, payload });
+          const authInfo = await this.hooks.authenticateJoinChannel({ socket, joinRef, ref, topic, event, payload });
+          await this.hooks.preJoinChannel({ socket, joinRef, ref, topic, event, payload });
+
+          socket.channel[topic] = {};
+          socket.channel[topic].authInfo = authInfo;
         } catch (error) {
           this.logger.error('preJoinChannel error', { error });
           reply(socket, topic, `chan_reply_${ref}`, { message: error.message }, 'error');
@@ -293,7 +315,7 @@ class WsServer extends EventEmitter {
 
         // post hook
         try {
-          await this.hooks.postJoinChannel({ joinRef, ref, topic, event, payload });
+          await this.hooks.postJoinChannel({ socket, joinRef, ref, topic, event, payload });
         } catch (error) {
           this.logger.error('postJoinChannel error', { error });
         }
@@ -304,7 +326,7 @@ class WsServer extends EventEmitter {
       if (event === 'phx_leave') {
         // pre hook
         try {
-          await this.hooks.preLeaveChannel({ joinRef, ref, topic, event, payload });
+          await this.hooks.preLeaveChannel({ socket, joinRef, ref, topic, event, payload });
         } catch (error) {
           this.logger.error('preLeaveChannel error', { error });
           reply(socket, topic, `chan_reply_${ref}`, { message: error.message }, 'error');
@@ -317,7 +339,7 @@ class WsServer extends EventEmitter {
 
         // post hook
         try {
-          await this.hooks.postLeaveChannel({ joinRef, ref, topic, event, payload });
+          await this.hooks.postLeaveChannel({ socket, joinRef, ref, topic, event, payload });
         } catch (error) {
           this.logger.error('postLeaveChannel error', { error });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/ws",
-  "version": "1.16.16",
+  "version": "1.17.1",
   "description": "OCAP Chain websocket server and client",
   "keywords": [
     "websocket"
@@ -34,9 +34,10 @@
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
-    "@arcblock/event-hub": "1.16.16",
+    "@arcblock/event-hub": "1.17.1",
     "debug": "^4.3.3",
     "eventemitter3": "^4.0.4",
+    "lodash": "^4.17.21",
     "nanoid": "3.x",
     "phoenix": "1.5.12",
     "ws": "^8.2.2"
@@ -44,5 +45,5 @@
   "devDependencies": {
     "get-port": "^5.1.1"
   },
-  "gitHead": "051f9620995cf24407374cc4811b0fa6ed6dc7ca"
+  "gitHead": "ca2ac264d9d6358680d5be99fcdd4685d0c999fc"
 }