telemersive-bus 0.6.1 → 0.6.3

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.
@@ -214,7 +214,7 @@ class BusManager {
             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..
             console.log(`            -> peer '${_message.peerName}' not joined anymore - reject from room`);
             await this.publishRoomAccess(
@@ -228,6 +228,8 @@ class BusManager {
                 _message.roomPwd,
                 "not joined anymore");
         }
+        // if even one 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];
         }
@@ -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;
     }
 
     /**
@@ -345,15 +346,16 @@ class BusManager {
                 } else {
                     //room exists: checked if the doubled hashed roomPwd is equal
                     accessGrant = true;
-                    if(this.houseKeepingInProgress){
-                        // if there is a housekeeping process in progress,
-                        // we need it to stop it right here, otherwise the newly joined peer could be
-                        // kicked out right away.
+                    console.log(`  -> peer '${_message.peerName}' joining room '${_message.roomName}'`);
+                    // if there is a housekeeping process in progress,
+                    // we need it to stop it right here, otherwise the newly joined peer could be
+                    // kicked out right away.
+                    if (this.houseKeepingInProgress) {
+                        console.log(`    -> peer '${_message.peerName}' joining interrupts housekeeping.. `);
                         this.houseKeepingInProgress = false;
-                        // and we wait a moment to start with housekeeping again
-                        setTimeout(this.startHousekeeping, houseKeepingTimeOut_onPeerJoined);
                     }
-                    console.log(`  -> peer '${_message.peerName}' joining room '${_message.roomName}'`);
+                    // and we wait a moment to start with housekeeping again
+                    setTimeout(this.startHousekeeping, houseKeepingTimeOut_onPeerJoined);
                 }
             }
         } else {
@@ -362,8 +364,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,
@@ -376,7 +377,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(
@@ -392,6 +395,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "telemersive-bus",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "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": {