telemersive-bus 0.6.9 → 0.6.11

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

@@ -222,14 +222,28 @@ class BusManager {
             console.log(`            -> peer '${_message.peerName}' not joined anymore - reject from room`);
         }
 
+        let room_ID = -1;
+        let room_UUID = -1;
+
+        // we also check if the room is still existing..
+        if (this.rooms[_message.roomName] !== undefined){
+            // we only set the id and UUID if the room still exists.
+            room_ID = this.rooms[_message.roomName].roomId;
+            room_UUID = this.rooms[_message.roomName].roomUUID;
+        } else {
+            accessGrant = false;
+            reason = "room doesn't exist anymore";
+            console.log(`            -> peer '${_message.peerName}' reject from non existing room '${_message.roomName}'`);
+        }
+
         await this.publishRoomAccess(
             accessGrant,
             _message.peerId,
             _message.clientId,
             _message.peerName,
             _message.roomName,
-            this.rooms[_message.roomName].roomId,
-            this.rooms[_message.roomName].roomUUID,
+            room_ID,
+            room_UUID,
             _message.roomPwd,
             reason);
 
@@ -241,7 +255,12 @@ class BusManager {
     cleanOut = async () => {
         if(this.houseKeepingInProgress) {
             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());
@@ -260,12 +279,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`);
@@ -348,6 +377,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}'`);
@@ -485,7 +518,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}'`);
@@ -519,9 +553,6 @@ class BusManager {
         if (this.rooms.hasOwnProperty(_roomName)) {
             console.log(`       <- remove room '${_roomName}' with id '${this.rooms[_roomName].roomId}' `);
             try {
-                // stop the ports
-                await this.stopServerSidePortScripts(_roomName, this.rooms[_roomName].roomId);
-
                 // stop the and cleanup the room chat
                 if (this.chatManagers.hasOwnProperty(_roomName)) {
                     // stop the chatManager and delete it for this rom
@@ -547,7 +578,8 @@ class BusManager {
                 // and by now all retained messages in this room have been cleaned up
                 await this.communicator.unsubscribe(this.busTopics.baseRoomSubTopics(_roomName).build());
 
-                delete this.rooms[_roomName];
+                // stop the ports and delete room for good
+                await this.stopServerSidePortScripts(_roomName, this.rooms[_roomName].roomId);
             } catch (e) {
                 console.log(`      <! exception while removing room '${_roomName}': '${e.message}' `);
             }
@@ -661,6 +693,8 @@ class BusManager {
                 console.error(`      ...: ${err}. Interrupting process of stopping open stage control instance on port ${_roomId * 1000 + 900}.`);
             }
             console.log(`        <- stopped all ports for room ${_roomName}`);
+            delete this.rooms[_roomName];
+            console.log(`        <- removed room ${_roomName}`);
         }else {
             console.log(`        ...stopped no ports for room ${_roomName}: no switchboard url/port defined`);
         }

package/package.json

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