@flashphoner/sfusdk 1.0.41 → 1.0.43

package/src/sdk/room.js

@@ -5,6 +5,8 @@
 
 const { v4: uuidv4 } = require("uuid");
 const constants = require("./constants");
+const promises = require("./promise");
+const logger = require("./logger");
 
 const room = function(options) {
     if (!options) {
@@ -25,16 +27,16 @@ const room = function(options) {
     //data channel
     const dChannel = options.pc.createDataChannel("control");
     dChannel.onopen = function() {
-        console.log("DataChannel opened");
+        logger.log("DataChannel opened");
     };
     dChannel.onclose = function() {
-        console.log("DataChannel closed");
+        logger.log("DataChannel closed");
     };
     dChannel.onerror = function(e) {
         //console.error("Got error in data channel ", e);
     };
     dChannel.onmessage = function(msg) {
-        console.log("received message: " + msg.data);
+        logger.log("dchannel ", "<==", msg);
         const message = JSON.parse(msg.data);
         if (message.type === constants.SFU_ROOM_EVENT.MESSAGE && message.message.message.indexOf("\"payload\":") !== -1) {
             try {
@@ -56,35 +58,67 @@ const room = function(options) {
                 window.log.info("Failed to process inner message: " + message.message);
                 notify(message.type, message.message);
             }
+        } else if (message.type === constants.SFU_EVENT.ACK && promises.promised(message.internalMessageId)) {
+                promises.resolve(message.internalMessageId);
         } else {
             notify(message.type, message.message);
         }
     };
 
+    const dChannelSend = (msg) => {
+        logger.log("dchannel ", "==>", msg);
+        dChannel.send(msg);
+    };
+
     const processEvent = function(e) {
+        logger.log("<==", e);
         if (e.type === constants.SFU_ROOM_EVENT.REMOTE_SDP) {
-            switch (e.info.type) {
-                case "offer":
-                    pc.setRemoteDescription(e.info).then(() => pc.createAnswer())
-                        .then(answer => pc.setLocalDescription(answer))
-                        .then(() => {
-                            connection.send(constants.SFU_INTERNAL_API.UPDATE_ROOM_STATE, {
-                                name: name,
-                                pin: pin,
-                                sdp: pc.localDescription.sdp
+            if (state !== constants.SFU_ROOM_STATE.FAILED && state !== constants.SFU_ROOM_STATE.DISPOSED) {
+                switch (e.info.type) {
+                    case "offer":
+                        pc.setRemoteDescription(e.info).then(() => pc.createAnswer())
+                            .then(answer => pc.setLocalDescription(answer))
+                            .then(() => {
+                                connection.send(constants.SFU_INTERNAL_API.UPDATE_ROOM_STATE, {
+                                    name: name,
+                                    pin: pin,
+                                    sdp: pc.localDescription.sdp
+                                });
                             });
-                        });
-                    break;
-                case "answer":
-                    pc.setRemoteDescription(e.info);
-                    break;
+                        break;
+                    case "answer":
+                        pc.setRemoteDescription(e.info);
+                        break;
+                }
             }
         } else if (e.type === constants.SFU_ROOM_EVENT.ROLE_ASSIGNED) {
             role = e.role;
             notify(e.type, e);
         } else if (e.type === constants.SFU_ROOM_EVENT.CREATED) {
             inviteId = e.inviteId;
-            notify(e.type, e);
+            if (!promises.resolve(e.internalMessageId, e)) {
+                notify(e.type, e);
+            }
+        } else if (e.type === constants.SFU_ROOM_EVENT.OPERATION_FAILED && promises.promised(e.internalMessageId)) {
+            promises.reject(e.internalMessageId, e);
+        } else if (e.type === constants.SFU_ROOM_EVENT.JOINED) {
+            if (!promises.resolve(e.internalMessageId, e)) {
+                notify(e.type, e);
+            }
+        } else if (e.type === constants.SFU_ROOM_EVENT.LEFT) {
+            if (!promises.resolve(e.internalMessageId, e)) {
+                notify(e.type, e);
+            }
+        } else if (e.type === constants.SFU_ROOM_EVENT.ADD_TRACKS) {
+            if (!promises.resolve(e.internalMessageId, e.info)) {
+                notify(e.type, e);
+            }
+        } else if (e.type === constants.SFU_ROOM_EVENT.REMOVE_TRACKS) {
+            if (!promises.resolve(e.internalMessageId, e)) {
+                notify(e.type, e);
+            }
+        } else if (e.type === constants.SFU_EVENT.ACK && promises.promised(e.internalMessageId)) {
+            promises.resolve(e.internalMessageId);
         } else {
             notify(e.type, e);
         }
@@ -94,9 +128,14 @@ const room = function(options) {
      * Create room at server side.
      */
     const createRoom = function() {
-        connection.send(constants.SFU_INTERNAL_API.CREATE_ROOM, {
-            name: name,
-            pin: pin
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.CREATE_ROOM, {
+                name: name,
+                pin: pin,
+                internalMessageId: id
+            });
         });
     };
 
@@ -107,21 +146,28 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const join = function(config) {
-        if (state === constants.SFU_ROOM_STATE.NEW) {
-            state = constants.SFU_ROOM_STATE.JOINED;
-            pc.createOffer().then(function(offer) {
-                if (config) {
-                    offer.sdp = applyContentTypeConfig(offer.sdp, config);
-                }
-                pc.setLocalDescription(offer).then(function() {
-                    connection.send(constants.SFU_INTERNAL_API.JOIN_ROOM, {
-                        name: name,
-                        pin: pin,
-                        sdp: offer.sdp
-                    });
-                });
-            });
-        }
+        return new Promise((resolve, reject) => {
+            if (state === constants.SFU_ROOM_STATE.NEW) {
+                state = constants.SFU_ROOM_STATE.JOINED;
+                pc.createOffer().then(function (offer) {
+                    if (config) {
+                        offer.sdp = applyContentTypeConfig(offer.sdp, config);
+                    }
+                    pc.setLocalDescription(offer).then(function () {
+                        const id = uuidv4();
+                        promises.add(id, resolve, reject);
+                        connection.send(constants.SFU_INTERNAL_API.JOIN_ROOM, {
+                            name: name,
+                            pin: pin,
+                            sdp: offer.sdp,
+                            internalMessageId: id
+                        });
+                    }, reject);
+                }, reject);
+            } else {
+                reject("Can't joined room with state " + state);
+            }
+        });
     };
 
     /**
@@ -133,21 +179,27 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const updateState = function(config) {
-        if (pc.signalingState !== "stable") {
-            throw new Error("Peer connection signaling state is " + pc.signalingState + ". Can't update room while negotiation is in progress");
-        }
-        pc.createOffer().then(function(offer) {
-            pc.setLocalDescription(offer).then(function() {
-                if (config) {
-                    offer.sdp = applyContentTypeConfig(offer.sdp, config);
-                }
-                connection.send(constants.SFU_INTERNAL_API.UPDATE_ROOM_STATE, {
-                    name: name,
-                    pin: pin,
-                    sdp: offer.sdp
-                });
-            });
-        });
+        return new Promise((resolve, reject) => {
+            if (pc.signalingState !== "stable") {
+                reject("Peer connection signaling state is " + pc.signalingState + ". Can't update room while negotiation is in progress");
+            }
+            pc.createOffer().then(function(offer) {
+                pc.setLocalDescription(offer).then(function() {
+                    if (config) {
+                        offer.sdp = applyContentTypeConfig(offer.sdp, config);
+                    }
+                    const id = uuidv4();
+                    promises.add(id, resolve, reject);
+                    connection.send(constants.SFU_INTERNAL_API.UPDATE_ROOM_STATE, {
+                        name: name,
+                        pin: pin,
+                        sdp: offer.sdp,
+                        internalMessageId: id
+                    });
+                }, reject);
+            }, reject);
+        })
+
     };
 
     const applyContentTypeConfig = function(sdp, config) {
@@ -171,9 +223,15 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const destroyRoom = function() {
-        connection.send(constants.SFU_INTERNAL_API.DESTROY_ROOM, {
-            name: name,
-            pin: pin
+        return new Promise((resolve, reject) => {
+            state = constants.SFU_ROOM_STATE.DISPOSED;
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.DESTROY_ROOM, {
+                name: name,
+                pin: pin,
+                internalMessageId: id
+            });
         });
     };
 
@@ -182,12 +240,19 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const leaveRoom = function() {
-        connection.send(constants.SFU_INTERNAL_API.LEAVE_ROOM, {
-            name: name,
-            pin: pin
-        });
-        pc.close();
-        pc.dispatchEvent(new Event("connectionstatechange"));
+        return new Promise((resolve, reject) => {
+            state = constants.SFU_ROOM_STATE.DISPOSED;
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.LEAVE_ROOM, {
+                name: name,
+                pin: pin,
+                internalMessageId: id
+            });
+            pc.close();
+            pc.dispatchEvent(new Event("connectionstatechange"));
+        })
+
     };
 
     /**
@@ -197,21 +262,31 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const sendMessage = function(msg) {
-        //throttle messages
-        const chuckSize = 16384;
-        if (msg.length > chuckSize) {
+        return new Promise((resolve, reject) => {
+            //throttle messages
             const id = uuidv4();
-            const chunks = msg.match(new RegExp("(.|[\r\n]){1,"+chuckSize+"}", "g"));
-            for (let i = 0; i < chunks.length; i++) {
-                dChannel.send(JSON.stringify({
+            /**
+             * Note that in case of chunked message promise will be resolved only after sending last message (last: true)
+             */
+            promises.add(id, resolve, reject);
+            const chunkSize = 16384;
+            if (msg.length > chunkSize) {
+                const chunks = msg.match(new RegExp("(.|[\r\n]){1,"+chunkSize+"}", "g"));
+                for (let i = 0; i < chunks.length; i++) {
+                    dChannelSend(JSON.stringify({
+                        id: id,
+                        last: i === chunks.length - 1,
+                        payload: chunks[i]
+                    }));
+                }
+            } else {
+                dChannelSend(JSON.stringify({
                     id: id,
-                    last: i === chunks.length - 1,
-                    payload: chunks[i]
+                    payload: msg
                 }));
             }
-        } else {
-            dChannel.send(msg);
-        }
+        })
+
     };
 
     /**
@@ -222,12 +297,17 @@ const room = function(options) {
      * @param {Boolean} broadcast ignore 'to' and broadcast the message (send it to all participants)
      */
     const sendControlMessage = function(to, msg, broadcast) {
-        connection.send(constants.SFU_INTERNAL_API.SEND_CONTROL_MESSAGE, {
-            broadcast: broadcast,
-            from: "",
-            to: to,
-            body: msg
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.SEND_CONTROL_MESSAGE, {
+                broadcast: broadcast,
+                from: "",
+                to: to,
+                body: msg,
+                internalMessageId: id
+            });
+        })
     };
 
     /**
@@ -239,12 +319,17 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const changeQuality = function(trackId, quality, tid) {
-        connection.send("changeQuality", {
-            roomName: name,
-            id: trackId,
-            quality: quality,
-            tid: tid
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send("changeQuality", {
+                roomName: name,
+                id: trackId,
+                quality: quality,
+                tid: tid,
+                internalMessageId: id
+            });
+        })
     };
 
     /**
@@ -254,11 +339,17 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const authorizeWaitingList = function(userId, authorized) {
-        connection.send(constants.SFU_INTERNAL_API.AUTHORIZE_WAITING_LIST, {
-            name: name,
-            userId: userId,
-            authorized: authorized
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.AUTHORIZE_WAITING_LIST, {
+                name: name,
+                userId: userId,
+                authorized: authorized,
+                internalMessageId: id
+            });
+        })
+
     };
 
     /**
@@ -267,9 +358,14 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const moveToWaitingRoom = function(nickname) {
-        connection.send(constants.SFU_INTERNAL_API.MOVE_TO_WAITING_ROOM, {
-            roomName: name,
-            nickname: nickname
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.MOVE_TO_WAITING_ROOM, {
+                roomName: name,
+                nickname: nickname,
+                internalMessageId: id
+            });
         });
     };
 
@@ -279,9 +375,14 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const configureWaitingRoom = function(enabled) {
-        connection.send(constants.SFU_INTERNAL_API.CONFIGURE_WAITING_ROOM, {
-            name: name,
-            enabled: enabled
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.CONFIGURE_WAITING_ROOM, {
+                name: name,
+                enabled: enabled,
+                internalMessageId: id
+            });
         });
     };
 
@@ -292,11 +393,15 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const muteTrack = function(trackId, mute) {
-        connection.send(constants.SFU_INTERNAL_API.MUTE_TRACK, {
-            roomName: name,
-            id: trackId,
-            mute: mute
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.MUTE_TRACK, {
+                roomName: name,
+                id: trackId,
+                mute: mute
+            });
+        })
     };
 
     /**
@@ -306,11 +411,16 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const assignRole = function(nickname, role) {
-        connection.send(constants.SFU_INTERNAL_API.ASSIGN_ROLE, {
-            roomName: name,
-            nickname: nickname,
-            role: role
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.ASSIGN_ROLE, {
+                roomName: name,
+                nickname: nickname,
+                role: role,
+                internalMessageId: id
+            });
+        })
     };
 
     /**
@@ -321,10 +431,15 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const subscribeToWaitingParticipant = function(nickname) {
-        connection.send(constants.SFU_INTERNAL_API.SUBSCRIBE_TO_WAITING_PARTICIPANT, {
-            roomName: name,
-            nickname: nickname
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.SUBSCRIBE_TO_WAITING_PARTICIPANT, {
+                roomName: name,
+                nickname: nickname,
+                internalMessageId: id
+            });
+        })
     };
 
     /**
@@ -334,10 +449,16 @@ const room = function(options) {
      * @memberOf FlashphonerSFU.Room
      */
     const unsubscribeFromWaitingParticipant = function(nickname) {
-        connection.send(constants.SFU_INTERNAL_API.UNSUBSCRIBE_FROM_WAITING_PARTICIPANT, {
-            roomName: name,
-            nickname: nickname
-        });
+        return new Promise((resolve, reject) => {
+            const id = uuidv4();
+            promises.add(id, resolve, reject);
+            connection.send(constants.SFU_INTERNAL_API.UNSUBSCRIBE_FROM_WAITING_PARTICIPANT, {
+                roomName: name,
+                nickname: nickname,
+                internalMessageId: id
+            });
+        })
+
     };
 
     /**
@@ -348,7 +469,7 @@ const room = function(options) {
      */
 
     /**
-     * Add session event callback.
+     * Add room event callback.
      *
      * @param {String} event One of {@link FlashphonerSFU.SFU_ROOM_EVENT} events
      * @param {FlashphonerSFU.Room~eventCallback} callback Callback function
@@ -371,6 +492,34 @@ const room = function(options) {
         return room;
     };
 
+    /**
+     * Remove room event callback.
+     *
+     * @param {String} event One of {@link FlashphonerSFU.SFU_ROOM_EVENT} events
+     * @param {FlashphonerSFU.Room~eventCallback} callback Callback function
+     * @returns {FlashphonerSFU.Room} SDK instance callback was removed from
+     * @throws {TypeError} Error if event is not specified
+     * @throws {Error} Error if callback is not a valid function
+     * @memberOf FlashphonerSFU.Room
+     */
+    const off = function (event, callback) {
+        if (!event) {
+            throw new TypeError("Event can't be null");
+        }
+        if (!callback || typeof callback !== "function") {
+            throw new Error("Callback needs to be a valid function");
+        }
+        if (!callbacks[event]) {
+            callbacks[event] = [];
+        }
+        let index = callbacks[event].findIndex(element => element === callback);
+        if (index !== -1) {
+            console.log("off ", event);
+            callbacks[event] = callbacks[event].slice(index, 1);
+        }
+        return room;
+    };
+
     const notify = function(event, msg) {
         if (callbacks[event]) {
             for (const callback of callbacks[event]) {
@@ -380,21 +529,21 @@ const room = function(options) {
     };
 
     room.processEvent = processEvent;
-    room.createRoom = createRoom;
-    room.join = join;
-    room.updateState = updateState;
-    room.destroyRoom = destroyRoom;
-    room.leaveRoom = leaveRoom;
-    room.sendMessage = sendMessage;
-    room.sendControlMessage = sendControlMessage;
-    room.changeQuality = changeQuality;
-    room.authorizeWaitingList = authorizeWaitingList;
-    room.muteTrack = muteTrack;
-    room.assignRole = assignRole;
-    room.subscribeToWaitingParticipant = subscribeToWaitingParticipant;
-    room.unsubscribeFromWaitingParticipant = unsubscribeFromWaitingParticipant;
-    room.moveToWaitingRoom = moveToWaitingRoom;
-    room.configureWaitingRoom = configureWaitingRoom;
+    room.createRoom = createRoom;//done
+    room.join = join;//done
+    room.updateState = updateState;//done
+    room.destroyRoom = destroyRoom;//done
+    room.leaveRoom = leaveRoom;//done
+    room.sendMessage = sendMessage;//done
+    room.sendControlMessage = sendControlMessage;//done
+    room.changeQuality = changeQuality;//done
+    room.authorizeWaitingList = authorizeWaitingList;//done
+    room.muteTrack = muteTrack;//done
+    room.assignRole = assignRole;//done
+    room.subscribeToWaitingParticipant = subscribeToWaitingParticipant;//done
+    room.unsubscribeFromWaitingParticipant = unsubscribeFromWaitingParticipant;//done
+    room.moveToWaitingRoom = moveToWaitingRoom;//done
+    room.configureWaitingRoom = configureWaitingRoom;//done
     /**
      * Room name
      * @returns {String} room name
@@ -432,6 +581,7 @@ const room = function(options) {
         return inviteId;
     };
     room.on = on;
+    room.off = off;
 
     return room;
 };