telemersive-bus 0.6.8 → 0.6.10

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2021-2024 ZHdK.ch / immersive-arts.ch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/BusManager.js

@@ -12,7 +12,7 @@ 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 = 1500;
 const houseKeepingTimeOut_onRepeat = 1500;
 const houseKeepingTimeOut_onPeerLeft= 1000;
 const houseKeepingTimeOut_onPeerJoined = 5000;
@@ -164,7 +164,7 @@ class BusManager {
 
             for (const key of keys) {
                 // send ping message
-                console.log(`        -> room '${key}' with id '${this.rooms[key].roomId}'...`);
+                console.log(`        -> room '${key}' with id '${this.rooms[key].roomId}' pings joined peers ...`);
                 await this.communicator.publish(new BusMsgPub(this.busTopics.baseRoomAlive(key).build(), RoomInfo, 1, false).encode(
                     {
                         "timestamp": Math.round(new Date().getTime() / 1000),
@@ -240,9 +240,13 @@ class BusManager {
      */
     cleanOut = async () => {
         if(this.houseKeepingInProgress) {
-            this.houseKeepingInProgress = false;
             console.log(`      -> housekeeping -> cleaning out ...`);
-            const cleanupAndLeave = async (currentPeer) => {
+            // flag the room as being in the process to be removed
+            const flag4cleanupRooms = (currentRoom) => this.rooms[currentRoom.roomName].flagRoom4cleanup = true;
+            Object.values(this.roomHousekeep).forEach(flag4cleanupRooms);
+
+            // kick out the non-responding peers
+            const kickOutPeer = 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());
@@ -261,12 +265,22 @@ class BusManager {
                         this.busTopics.roomPeerLeft(currentPeer.roomName, currentPeer.peerId).build(),
                         PeerInfo, 2, true).encode(infoPayload));
             }
-            await Object.values(this.peerHousekeep).every(cleanupAndLeave);
-
-            // and now we can delete the rooms
+            const peerCleanup = async () => {
+                for (const peer of Object.values(this.peerHousekeep)) {
+                    await kickOutPeer(peer);
+                }
+            };
+            await peerCleanup();
+            
+            // And now remove the rooms
             const cleanupRooms = async (currentRoom) => await this.deleteRoom(currentRoom.roomName);
-            await Object.values(this.roomHousekeep).every(cleanupRooms);
-
+            const housekeeping = async () => {
+                for (const room of Object.values(this.roomHousekeep)) {
+                    await cleanupRooms(room);
+                }
+            };
+            await housekeeping();
+            
             console.log(`      -> housekeeping DONE`);
         } else {
             console.log(`      -> housekeeping was interrupted`);
@@ -278,6 +292,9 @@ class BusManager {
         await this.communicator.unsubscribe(this.busTopics.baseRoomAlivePing("+").build());
         // cleanup the communicator
         this.communicator.clearAutoGeneratedSubscriptions();
+        // set this flag to false at the end to make sure a new houskeeping cycle can only be started once
+        // all topics are unsubscribed - otherwise it won't gather the joined peers inside the room.
+        this.houseKeepingInProgress = false;
     }
 
     /**
@@ -346,6 +363,10 @@ class BusManager {
                     console.log(`  -> peer '${_message.peerName}' declined access to room: ${_message.roomName} | incompatible app version`);
                     accessGrant = false;
                     reason = `app version incompatible: required version is '${this.rooms[_message.roomName].appVersion}', yours is '${_message.appVersion}'`;
+                } else if (this.rooms[_message.roomName].flagRoom4cleanup) {
+                    console.log(`  -> peer '${_message.peerName}' declined access to room: ${_message.roomName} | room is in process of being removed`);
+                    accessGrant = false;
+                    reason = `room is in process of being removed. try again in a few seconds.`;
                 } else {
                     accessGrant = true;
                     console.log(`  -> peer '${_message.peerName}' joining room '${_message.roomName}'`);
@@ -483,7 +504,8 @@ class BusManager {
             roomId: roomID,
             roomUUID: roomUUID,
             roomPwd: _roomPwd,
-            appVersion: _appVersion
+            appVersion: _appVersion,
+            flagRoom4cleanup: false
         }
         console.log(`-> generate room: '${_roomName}' with id '${roomID}' and uuid: '${roomID}'`);
         console.log(`     with uuid: '${roomUUID}'`);
@@ -547,7 +569,7 @@ class BusManager {
 
                 delete this.rooms[_roomName];
             } catch (e) {
-                console.log("      <! exception while removing room '${_roomName}': ${e.message}");
+                console.log(`      <! exception while removing room '${_roomName}': '${e.message}' `);
             }
         }
     }

package/package.json

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