telemersive-bus 0.6.0 → 0.6.2

package/lib/BusManager.js

@@ -13,6 +13,9 @@ const {RoomAccess, RoomInfo, PeerCredentials, PeerInfo} = require('./protos/BusM
 /* time the housekeeping thread waits until it continues with the next step
  */
 const houseKeepingTimeOut = 500;
+const houseKeepingTimeOut_onRepeat = 1500;
+const houseKeepingTimeOut_onPeerLeft= 1000;
+const houseKeepingTimeOut_onPeerJoined = 5000;
 const ROOM_ID_MIN = 11;
 const ROOM_ID_MAX = 50;
 
@@ -111,6 +114,9 @@ class BusManager {
 
     /**
      * start the housekeeping
+     *      on startup
+     *      when peer joins a room
+     *      when peer leaves a room
      */
     startHousekeeping = async () => {
         // we dont want to start another housekeeping process until the previous one has finished
@@ -125,6 +131,10 @@ 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.
+            setTimeout(this.startHousekeeping, houseKeepingTimeOut_onRepeat);
         }
     }
 
@@ -165,6 +175,10 @@ class BusManager {
             }
             // now we have to wait a moment
             setTimeout(this.cleanOut, houseKeepingTimeOut);
+        } else {
+            // this means the housekeeping got interrupted and
+            //  needs to finish as fast as possible to cleaning up all subscriptions.
+            setTimeout(this.cleanOut, 0);
         }
     }
 
@@ -238,6 +252,7 @@ class BusManager {
                     roomName: currentPeer.roomName
                 };
 
+                // sends the left message to all peers joined in the same room
                 await this.communicator.publish(
                     new BusMsgPub(
                         this.busTopics.roomPeerLeft(currentPeer.roomName, currentPeer.peerId).build(),
@@ -249,16 +264,18 @@ class BusManager {
             const cleanupRooms = async (currentRoom) => await this.deleteRoom(currentRoom.roomName);
             await Object.values(this.roomHousekeep).every(cleanupRooms);
 
-            // and we stop by unsubscribing to all peer info messages inside all rooms
-            await this.communicator.unsubscribe(this.busTopics.roomPeerJoin('+', '+').build());
-            // unsubscribing to all room ping alive topic
-            await this.communicator.unsubscribe(this.busTopics.baseRoomAlivePing("+").build());
-            // cleanup the communicator
-            this.communicator.clearAutoGeneratedSubscriptions();
             console.log(`      -> housekeeping DONE`);
         } else {
             console.log(`      -> housekeeping was interrupted`);
         }
+
+        // and we stop by unsubscribing to all peer info messages inside all rooms
+        await this.communicator.unsubscribe(this.busTopics.roomPeerJoin('+', '+').build());
+        // unsubscribing to all room ping alive topic
+        await this.communicator.unsubscribe(this.busTopics.baseRoomAlivePing("+").build());
+        // cleanup the communicator
+        this.communicator.clearAutoGeneratedSubscriptions();
+        // and just to be sure
         this.houseKeepingInProgress = false;
     }
 
@@ -270,13 +287,14 @@ class BusManager {
         let shaPassword = sha1(_message.roomPwd).substr(0, 10)
         if (this.rooms.hasOwnProperty(_message.roomName)){
             if (this.rooms[_message.roomName].roomPwd === shaPassword){
-
-                // we wait a moment to start with housekeeping.
+                // 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 gone..
-                setTimeout(this.startHousekeeping, houseKeepingTimeOut);
+                // 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!!!`);
             }
@@ -327,13 +345,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 stop it right here.
+                    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 houskeeping again
-                        setTimeout(this.startHousekeeping, houseKeepingTimeOut);
                     }
-                    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 {
@@ -357,7 +378,7 @@ class BusManager {
 
         if(accessGrant){
             //console.log(`publish info to address: ${this.busTopics.roomPeerJoin(_message.roomName, _message.peerId).build()}.`);
-            // send peer joined message
+            // send peer joined message to all the peers in the room
             await this.communicator.publish(
                 new BusMsgPub(
                     this.busTopics.roomPeerJoin(_message.roomName, _message.peerId).build(),

package/lib/utils/BusTopics.js

@@ -170,7 +170,7 @@ class BusTopics
 
     /**
      * setup topic for peer.
-     * iBus/rooms/'roomName'/peers/'peerId'/joined
+     * iBus/rooms/'roomName'/peers/'peerId'/left
      */
     roomPeerLeft(_roomName, _peerId){
         return this.roomPeer(_roomName, _peerId).appendTopic("left");

package/package.json

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