telemersive-bus 0.6.2 → 0.6.4

package/lib/BusClient.js

@@ -65,9 +65,9 @@ class BusClient {
             this.connectTimeout = setTimeout(this.connectionTimeout,1000);
             await this.communicator.connect();
             // if connection was successful, subscribe to room info topic
-            await this.communicator.subscribe(new BusMsgSub(this.busTopics.baseRoomInfo('+').build(), this.onRooms, RoomInfo, 0));
+            await this.communicator.subscribe(new BusMsgSub(this.busTopics.baseRoomInfo('+').build(), this.onRooms, RoomInfo, 2));
             // if connection was successful, subscribe to room delete topic
-            await this.communicator.subscribe(new BusMsgSub(this.busTopics.roomDelete().build(), this.onRoomDelete, RoomInfo, 0));
+            await this.communicator.subscribe(new BusMsgSub(this.busTopics.roomDelete().build(), this.onRoomDelete, RoomInfo, 2));
             //console.log(`...subscribe to. ${this.busTopics.basePeerRoomAccess(this.peerId).build()}`);
             this.bubbleUpCallback('bus', [ 'broker', 'connected', 1]);
             console.log("...successfully connected.");
@@ -135,7 +135,7 @@ class BusClient {
                 await this.communicator.reconnect(null);
 
                 // if connection was successful, subscribe to roomAccess topic
-                await this.communicator.subscribe(new BusMsgSub(this.busTopics.basePeerRoomAccess(this.peer.getClientId()).build(), this.onRoomJoined, RoomAccess, 0));
+                await this.communicator.subscribe(new BusMsgSub(this.busTopics.basePeerRoomAccess(this.peer.getClientId()).build(), this.onRoomJoined, RoomAccess, 2));
 
                 // now we start the timeout thread
                 this.joinTimeout = setTimeout(this.joinedTimeout,5000);

package/lib/BusManager.js

@@ -121,6 +121,7 @@ class BusManager {
     startHousekeeping = async () => {
         // we dont want to start another housekeeping process until the previous one has finished
         if(!this.houseKeepingInProgress){
+            this.houseKeepingInProgress = true;
             console.log(`  -> starting housekeeping -> gather all peers ...`);
             this.peerHousekeep = {};
             this.roomHousekeep = Object.assign({}, this.rooms); // clone the current room list
@@ -130,7 +131,6 @@ class BusManager {
 
             // now we have to wait a moment
             setTimeout(this.pingAllPeersAlive, houseKeepingTimeOut);
-            this.houseKeepingInProgress = true;
         } else {
             // if there is already a housekeeping going on,
             // we wait for some time to finish it and try again.
@@ -186,7 +186,10 @@ class BusManager {
      * return messages from peers on room ping requests
      */
     onRoomAlive = async (_topic, _message, _packet) => {
-        console.log(`        -> room '${_message.roomName}' alive with peer '${_message.peerName}'`);
+        let accessGrant;
+        let reason = "unknown";
+        console.log(`        -> room '${_message.roomName}' alive ping from peer '${_message.peerName}'`);
+
         // if we receive this message, it means this peer is alive and we can remove it
         // from our housekeeping lists
         if (_message.peerId in this.peerHousekeep) {
@@ -200,37 +203,36 @@ class BusManager {
                 // now we resend the access message
                 // we need to do this in case the manager has crashed and restarted...
                 // send access message
-                await this.publishRoomAccess(
-                    true,
-                    _message.peerId,
-                    _message.clientId,
-                    _message.peerName,
-                    _message.roomName,
-                    this.rooms[_message.roomName].roomId,
-                    this.rooms[_message.roomName].roomUUID,
-                    _message.roomPwd,
-                    "confirmation");
+                accessGrant = true;
+                reason = "confirmation";
+                delete this.peerHousekeep[_message.peerId];
+
+                // if even one joined peer replies to the room ping,
+                // the room can be removed from this list
+                if (this.roomHousekeep[_message.roomName] !== null) {
+                    delete this.roomHousekeep[_message.roomName];
+                }
             }
-            delete this.peerHousekeep[_message.peerId];
         } else {
             // this peer seems to be still alive and thinks it is joined.
-            // we need to releave it from its misery and allow it to leave
+            // we need to relieve it from its misery and allow it to leave
             // gracefully..
+            accessGrant = false;
+            reason = "not joined anymore";
             console.log(`            -> peer '${_message.peerName}' not joined anymore - reject from room`);
-            await this.publishRoomAccess(
-                false,
-                _message.peerId,
-                _message.clientId,
-                _message.peerName,
-                _message.roomName,
-                this.rooms[_message.roomName].roomId,
-                this.rooms[_message.roomName].roomUUID,
-                _message.roomPwd,
-                "not joined anymore");
-        }
-        if (this.roomHousekeep[_message.roomName] !== null) {
-            delete this.roomHousekeep[_message.roomName];
         }
+
+        await this.publishRoomAccess(
+            accessGrant,
+            _message.peerId,
+            _message.clientId,
+            _message.peerName,
+            _message.roomName,
+            this.rooms[_message.roomName].roomId,
+            this.rooms[_message.roomName].roomUUID,
+            _message.roomPwd,
+            reason);
+
     };
 
     /**
@@ -238,13 +240,14 @@ class BusManager {
      */
     cleanOut = async () => {
         if(this.houseKeepingInProgress) {
+            this.houseKeepingInProgress = false;
             console.log(`      -> housekeeping -> cleaning out ...`);
-            // first we send clear retain messages to
-            // all the peer joined addresses that have not replied:
-            const clearRetain = async (currentPeer) => {
+            const cleanupAndLeave = async (currentPeer) => {
                 console.log(`       <- remove peer '${currentPeer.peerName}' from room '${currentPeer.roomName}' `);
+                // first we send clear retain message to peer joined addresses that have not replied:
                 await this.communicator.clearRetain(this.busTopics.roomPeerJoin(currentPeer.roomName, currentPeer.peerId).build());
-                // send peer left to all remaining peers
+
+                // create the payload for the leave message
                 const infoPayload = {
                     timestamp: Math.round(new Date().getTime() / 1000),
                     peerId: currentPeer.peerId,
@@ -256,9 +259,9 @@ class BusManager {
                 await this.communicator.publish(
                     new BusMsgPub(
                         this.busTopics.roomPeerLeft(currentPeer.roomName, currentPeer.peerId).build(),
-                        PeerInfo, 2, false).encode(infoPayload));
+                        PeerInfo, 2, true).encode(infoPayload));
             }
-            await Object.values(this.peerHousekeep).every(clearRetain);
+            await Object.values(this.peerHousekeep).every(cleanupAndLeave);
 
             // and now we can delete the rooms
             const cleanupRooms = async (currentRoom) => await this.deleteRoom(currentRoom.roomName);
@@ -275,8 +278,6 @@ class BusManager {
         await this.communicator.unsubscribe(this.busTopics.baseRoomAlivePing("+").build());
         // cleanup the communicator
         this.communicator.clearAutoGeneratedSubscriptions();
-        // and just to be sure
-        this.houseKeepingInProgress = false;
     }
 
     /**
@@ -285,21 +286,18 @@ class BusManager {
     onPeerLeaving = async (_topic, _message, _packet) => {
         console.log(`  <- peer '${_message.peerName}' leaving`);
         let shaPassword = sha1(_message.roomPwd).substr(0, 10)
-        if (this.rooms.hasOwnProperty(_message.roomName)){
-            if (this.rooms[_message.roomName].roomPwd === shaPassword){
-                // the actual message of this peer leaving the room is generated by the
-                // housekeeping routine 'cleanOut':
-                // we wait a moment to start with housekeeping, though.
-                // it could be, that this message was called due to a short disconnect by the
-                // peer to the broker - issuing a lastWill message by the broker.
-                // by giving it some time the housekeeping process will verify if the peer
-                // is still online or if it is really gone..
-                setTimeout(this.startHousekeeping, houseKeepingTimeOut_onPeerLeft);
-            } else {
-                console.log(`!!! >BAD PLAYER<: somebody tried to remove peer without proper credentials!!!`);
-            }
+        if (this.rooms[_message.roomName].roomPwd === shaPassword){
+            // the actual message of this peer leaving the room is generated by the
+            // housekeeping routine 'cleanOut':
+            // we wait a moment to start with housekeeping, though.
+            // it could be, that this message was called due to a short disconnect by the
+            // peer to the broker - issuing a lastWill message by the broker.
+            // by giving it some time the housekeeping process will verify if the peer
+            // is still online or if it is really gone..
+            setTimeout(this.startHousekeeping, houseKeepingTimeOut_onPeerLeft);
+        } else {
+            console.log(`!!! >BAD PLAYER<: somebody tried to remove peer without proper credentials!!!`);
         }
-
     };
 
     /*********************************************************************
@@ -333,7 +331,10 @@ class BusManager {
                 console.log(`  -> peer '${_message.peerName}' creating new room '${_message.roomName}' for app version: '${_message.appVersion}'`);
                 reason = "no room of this name exists";
                 await this.publishNewRoom(_message.roomName, shaPassword, _message.appVersion);
+                // and we wait a moment to start with housekeeping again
+                setTimeout(this.startHousekeeping, houseKeepingTimeOut_onPeerJoined);
             } else {
+                //room exists: checked if the doubled hashed roomPwd is equal
                 if (this.rooms[_message.roomName].roomPwd !== shaPassword) {
                     console.log(`  -> peer '${_message.peerName}' declined access to room: ${_message.roomName} | invalid password`);
                     accessGrant = false;
@@ -343,7 +344,6 @@ class BusManager {
                     accessGrant = false;
                     reason = `app version incompatible: required version is '${this.rooms[_message.roomName].appVersion}', yours is '${_message.appVersion}'`;
                 } else {
-                    //room exists: checked if the doubled hashed roomPwd is equal
                     accessGrant = true;
                     console.log(`  -> peer '${_message.peerName}' joining room '${_message.roomName}'`);
                     // if there is a housekeeping process in progress,
@@ -363,8 +363,7 @@ class BusManager {
             reason = `incompatible protocol version '${_message.protocolVersion}': room manager is running on tBus version '${this.protocolVersion}'` ;
         }
 
-        //console.log(`send access to address: ${this.busTopics.basePeerRoomAccess(_message.peerId).build()}.`);
-        // send access message
+        // send access message to peer only
         await this.publishRoomAccess(
             accessGrant,
             _message.peerId,
@@ -377,7 +376,9 @@ class BusManager {
             reason)
 
         if(accessGrant){
-            //console.log(`publish info to address: ${this.busTopics.roomPeerJoin(_message.roomName, _message.peerId).build()}.`);
+            // This sends a message to all peers joined to the room
+            // first clear potentially retained leave message
+            await this.communicator.clearRetain(this.busTopics.roomPeerLeft(_message.roomName, _message.peerId).build());
             // send peer joined message to all the peers in the room
             await this.communicator.publish(
                 new BusMsgPub(
@@ -393,6 +394,7 @@ class BusManager {
         }
     };
 
+    // This generates a message to the requesting peer only
     publishRoomAccess = async (_accessGranted, _peerId, _clientId, _peerName, _roomName, _roomId, _roomUuid, _roomPwd, _reason) => {
         await this.communicator.publish(
             new BusMsgPub(this.busTopics.basePeerRoomAccess(_clientId).build(),

package/lib/utils/Peer.js

@@ -193,10 +193,10 @@ class Peer {
 
             // it is important to start the subscription after a successfull joining.
             // subscribe to all peer joined messages
-            await this.communicator.subscribe(new BusMsgSub(this.busTopics.roomPeerJoin(this.roomName, '+').build(), this.onPeerJoined, PeerInfo, 0));
+            await this.communicator.subscribe(new BusMsgSub(this.busTopics.roomPeerJoin(this.roomName, '+').build(), this.onPeerJoined, PeerInfo, 2));
 
             // subscribe to peer left messages
-            await this.communicator.subscribe(new BusMsgSub(this.busTopics.roomPeerLeft(this.roomName, '+').build(), this.onPeerLeft, PeerInfo, 0));
+            await this.communicator.subscribe(new BusMsgSub(this.busTopics.roomPeerLeft(this.roomName, '+').build(), this.onPeerLeft, PeerInfo, 2));
 
             // subscribe to my room ping messages
             await this.communicator.subscribe(new BusMsgSub(this.busTopics.baseRoomAlive(this.roomName).build(), this.onRoomPing, RoomInfo, 0));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "telemersive-bus",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "MQTT based data protocol to manage unlimited peers, connected by rooms, where all peers joined to a room can exchange private data. It provides a simple chat mechanism, latency pinging, publish-subscribe mechanism (based on mqtt) and a OSC-like data stream.  ",
   "main": "index.js",
   "directories": {