@arcblock/ws 1.18.45 → 1.18.47

package/README.md

@@ -40,8 +40,9 @@ const wsServer = new WsServer({
 wsSerer.attach();
 
 // push message
-wsServer.push('blocklet.installed', data);
-wsServer.push('notification.create', data);
+wsServer.broadcast('blocklet.installed', data);
+wsServer.broadcast('notification.create', data);
+wsServer.broadcast('topic', 'event', data);
 ```
 
 2. WsClient
@@ -74,6 +75,12 @@ socket.on('notification.create', callback2);
 socket.off('blocklet.installed', callback1);
 socket.off('notification.create', callback2);
 
+// More flexible subscription
+const subscription = socket.subscribe('topic', {});
+subscription.on('event', ({ response }) => {
+  // Do something with the event data
+});
+
 // disconnect
 socket.disconnect(() => {
   // after disconnected...

package/lib/client/base.js

@@ -18,12 +18,12 @@ module.exports = (Socket, EventEmitter, transport) => {
         this._logger.error('socket error', err.error);
       });
       this.onMessage((message) => {
-        this._logger.debug('socket message', { message });
+        this._logger.debug('socket message', message);
       });
     }
 
-    on(event, handler) {
-      this.ensureJoinChannel(event);
+    on(event, handler, params = {}) {
+      this.ensureJoinChannel(event, params);
       this.emitter.on(event, handler);
     }
 
@@ -47,30 +47,29 @@ module.exports = (Socket, EventEmitter, transport) => {
     /**
      * private
      */
-    ensureJoinChannel(event) {
-      const count = this.emitter.listenerCount(event);
+    ensureJoinChannel(topic, params = {}) {
+      const count = this.emitter.listenerCount(topic);
       if (count > 0) {
         return;
       }
 
-      const topic = event;
-      const channel = this.channel(topic);
+      const channel = this.channel(topic, params);
       channel
         .join()
         .receive('ok', (message) => {
-          this._logger.debug('join success', { event, message });
+          this._logger.debug('join success', { topic, message });
         })
         .receive('error', (error) => {
-          this._logger.error('join error', { event, error });
+          this._logger.error('join error', { topic, error });
         })
         .receive('timeout', () => {
-          this._logger.debug('join timeout', { event });
+          this._logger.debug('join timeout', { topic });
         });
-      channel.on(event, ({ status, response: data }) => {
+      channel.on(topic, ({ status, response: data }) => {
         if (status === 'ok') {
-          this.emitter.emit(event, data);
+          this.emitter.emit(topic, data);
         } else {
-          this._logger.debug('response error', { event, status, data });
+          this._logger.debug('response error', { topic, status, data });
         }
       });
     }
@@ -78,13 +77,12 @@ module.exports = (Socket, EventEmitter, transport) => {
     /**
      * private
      */
-    ensureLeaveChannel(event) {
-      const count = this.emitter.listenerCount(event);
+    ensureLeaveChannel(topic) {
+      const count = this.emitter.listenerCount(topic);
       if (count > 0) {
         return;
       }
 
-      const topic = event;
       const channel = this.channels.find((c) => c.topic === topic);
       if (!channel) {
         return;
@@ -94,15 +92,43 @@ module.exports = (Socket, EventEmitter, transport) => {
       channel
         .leave()
         .receive('ok', (message) => {
-          this._logger.debug('leave success', { event, message });
+          this._logger.debug('leave success', { topic, message });
         })
         .receive('error', (err) => {
-          this._logger.error('leave error', { event, err });
+          this._logger.error('leave error', { topic, err });
         })
         .receive('timeout', () => {
-          this._logger.debug('leave timeout', { event });
+          this._logger.debug('leave timeout', { topic });
         });
-      channel.off(event);
+      channel.off(topic);
+    }
+
+    // More flexible subscribe
+    // Allow user to join a channel and listen to any POI events
+    subscribe(topic, params = {}) {
+      let channel = this.channels.find((c) => c.topic === topic);
+      if (channel) {
+        return channel;
+      }
+
+      channel = this.channel(topic, params);
+      channel
+        .join()
+        .receive('ok', (message) => {
+          this._logger.debug('join success', { topic, message });
+        })
+        .receive('error', (error) => {
+          this._logger.error('join error', { topic, error });
+        })
+        .receive('timeout', () => {
+          this._logger.debug('join timeout', { topic });
+        });
+
+      return channel;
+    }
+
+    unsubscribe(topic) {
+      this.ensureLeaveChannel(topic);
     }
   };
 };

package/lib/server/index.js

@@ -106,7 +106,7 @@ class WsServer extends EventEmitter {
 
   /**
    * Broadcast message to all subscribers of a topic, can be used as
-   * - broadcast(event, data)
+   * - broadcast(event, data) ==> broadcast(event, event, data)
    * - broadcast(topic, event, data)
    * - broadcast(topic, event, data, options)
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/ws",
-  "version": "1.18.45",
+  "version": "1.18.47",
   "description": "OCAP Chain websocket server and client",
   "keywords": [
     "websocket"
@@ -34,7 +34,7 @@
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
   "dependencies": {
-    "@arcblock/event-hub": "1.18.45",
+    "@arcblock/event-hub": "1.18.47",
     "debug": "^4.3.4",
     "eventemitter3": "^4.0.7",
     "lodash": "^4.17.21",
@@ -45,5 +45,5 @@
   "devDependencies": {
     "get-port": "^5.1.1"
   },
-  "gitHead": "17a59291355d044599f211bd226af2756de91df0"
+  "gitHead": "84da7fb437e89f5c6a8e339aa01ab2e0378b8067"
 }