@reactoo/watchtogether-sdk-js 2.5.16 → 2.5.20

package/src/modules/wt-room.js

@@ -29,7 +29,7 @@ class Room {
 	}
 	
 	createSession(constructId = null, type = 'reactooroom', options = {}) {
-		return new RoomSession(constructId, type, this.debug, options);
+		return new RoomSession(constructId, type, {debug: this.debug, ...options});
 	}
 	
 	static testSafariVp8() {
@@ -88,19 +88,36 @@ class RoomSession {
 	//TODO: solve
 	// #eventList = ['error', 'kicked', 'addLocalParticipant', ,'addRemoteInstructor','addRemoteParticipant','addRemoteTalkback', 'addRemoteObserver', 'removeRemoteInstructor', 'removeLocalParticipant', 'removeRemoteParticipant', 'removeRemoteTalkback', 'removeRemoteObserver', 'localMuted', 'localHasVideo', 'localHasAudio', 'data', 'iceState', 'connectionState', 'joined', 'joining', 'dataChannel', 'disconnect', 'observerIds', 'talkbackIds', 'instructorId', 'published', 'publishing', 'remoteTrackMuted', 'streamingStatus', 'streaming', 'streamStarting'];
 	//
-	// #sessionTypes = {
-	//     'reactooroom': 'janus.plugin.reactooroom',
-	//     'streaming': 'janus.plugin.streaming'
-	// };
 	
-	static sessionTypes() {
-		return {
-			'reactooroom': 'janus.plugin.reactooroom',
-			'streaming': 'janus.plugin.streaming'
-		}
+	static sessionTypes =  {
+		'reactooroom': 'janus.plugin.reactooroom',
+		'streaming': 'janus.plugin.streaming'
+	}
+
+	static subscriptionRules = {
+		participant: {
+			watchTogether: ['participant', 'talkback'],
+			videoWall: ['instructor', 'observer', 'talkback']
+		},
+		monitor: {
+			watchTogether: ['participant'],
+			videoWall: ['instructor', 'participant'],
+		},
+		talkback: {
+			watchTogether: ['participant'],
+			videoWall: ['instructor', 'participant'],
+		},
+		observer: {
+			watchTogether: ['participant'],
+			videoWall: ['participant'],
+		},
+		instructor: {
+			watchTogether: [],
+			videoWall: [],
+		},
 	};
 	
-	constructor(constructId = null, type = 'reactooroom', debug, options = {}) {
+	constructor(constructId = null, type = 'reactooroom', options = {}) {
 
 		Object.assign(this, emitter());
 
@@ -113,18 +130,11 @@ class RoomSession {
 		this.userId = null;
 		this.sessiontype = type;
 		this.initialBitrate = 0;
+		//TODO: remove this
 		this.isMonitor = false; // currently used just for classroom context so monitor user only subscribes to participants and not trainer (for other monitor this flag is not necessary)
 		this.recordingFilename = null;
-		this.pluginName = RoomSession.sessionTypes()[type];
-		this.options = {
-			...{
-				debug: debug,
-				classroomObserverSubscribeToInstructor: false,
-				classroomInstructorSubscribeToParticipants: false,
-				safariBugHotfixEnabled: adapter.browserDetails.browser === 'safari' && adapter.browserDetails.version < 605
-			},
-			options
-		};
+		this.pluginName = RoomSession.sessionTypes[type];
+		this.options = options;
 		this.id = null;
 		this.privateId = null;
 		this.constructId = constructId || RoomSession.randomString(16);
@@ -155,10 +165,17 @@ class RoomSession {
 		this.isVideoEnabled = false;
 		this.isAudioEnabed = false;
 		this.isUnifiedPlan = RoomSession.checkUnifiedPlan();
+
+		this.subscriptionRules = {
+			...RoomSession.subscriptionRules,
+			...(this.options.subscriptionRules || {})
+		}
+
 		this._log = RoomSession.noop;
 		if (this.options.debug) {
 			this._enableDebug();
 		}
+
 	}
 	
 	// Check if this browser supports Unified Plan and transceivers
@@ -189,6 +206,88 @@ class RoomSession {
 		}
 		return unifiedPlan;
 	}
+
+	_participantShouldSubscribe(userId) {
+		let allowedObservers = this._observerIds || [];
+		let allowedTalkback = this._talkbackIds || [];
+		let allowedInstructor = this._instuctorId || null;
+		let localUserRole = 'participant';
+		if(this.isMonitor) {
+			localUserRole = 'monitor';
+		} else if(allowedObservers.indexOf(this.userId) > -1) {
+			localUserRole = 'observer';
+		} else if(allowedTalkback.indexOf(this.userId) > -1) {
+			localUserRole = 'talkback';
+		} else if(this.userId === allowedInstructor) {
+			localUserRole = 'instructor';
+		}
+		let remoteUserRole = 'participant';
+		if(allowedObservers.indexOf(userId) > -1) {
+			remoteUserRole = 'observer';
+		} else if(allowedTalkback.indexOf(userId) > -1) {
+			remoteUserRole = 'talkback';
+		} else if(userId === allowedInstructor) {
+			remoteUserRole = 'instructor';
+		}
+		let mode = allowedInstructor !== null ? 'videoWall' : 'watchTogether';
+		return this.subscriptionRules[localUserRole][mode].indexOf(remoteUserRole) > -1;
+	}
+
+	_getAddParticipantEventName(handleId) {
+
+		let handle = this._getHandle(handleId);
+		if (!handle) {
+			this.emit('error', {
+				type: 'warning',
+				id: 15,
+				message: 'id non-existent',
+				data: [handleId, 'getParticipantEventName']
+			});
+		}
+
+		let allowedTalkback = this._talkbackIds || [];
+		let allowedObservers = this._observerIds || [];
+		let allowedInstructor = this._instuctorId || null;
+		let eventName = 'addRemoteParticipant';
+		if(handle.userId === allowedInstructor) {
+			eventName = 'addRemoteInstructor';
+		}
+		if (allowedTalkback.indexOf(handle.userId) > -1) {
+			eventName = 'addRemoteTalkback';
+		}
+		if (allowedObservers.indexOf(handle.userId) > -1) {
+			eventName = 'addRemoteObserver';
+		}
+		return eventName
+	}
+
+	_getRemoveParticipantEventName(handleId) {
+
+		let handle = this._getHandle(handleId);
+		if (!handle) {
+			this.emit('error', {
+				type: 'warning',
+				id: 15,
+				message: 'id non-existent',
+				data: [handleId, 'getParticipantEventName']
+			});
+		}
+
+		let allowedTalkback = this._talkbackIds || [];
+		let allowedObservers = this._observerIds || [];
+		let allowedInstructor = this._instuctorId || null;
+		let eventName = 'removeRemoteParticipant';
+		if(handle.userId === allowedInstructor) {
+			eventName = 'removeRemoteInstructor';
+		}
+		if (allowedTalkback.indexOf(handle.userId) > -1) {
+			eventName = 'removeRemoteTalkback';
+		}
+		if (allowedObservers.indexOf(handle.userId) > -1) {
+			eventName = 'removeRemoteObserver';
+		}
+		return eventName
+	}
 	
 	sendMessage(handleId, message = {body: 'Example Body'}, dontWait = false, dontResolveOnAck = false) {
 		return this._send({
@@ -280,7 +379,7 @@ class RoomSession {
 				this.stopStream();
 			}
 			
-			this.emit('error', {type: 'error', id: 4, message: 'lost connection to WebSockets', data: null});
+			this.emit('error', {type: 'error', id: 4, message: 'Lost connection to WebSockets', data: null});
 		}
 	}
 	
@@ -316,7 +415,7 @@ class RoomSession {
 	_stopKeepAlive() {
 		clearTimeout(this._keepAliveId);
 	}
-	
+
 	_handleWsEvents(event) {
 		
 		let json = JSON.parse(event.data);
@@ -382,10 +481,6 @@ class RoomSession {
 				let unpublished = msg["unpublished"];
 				let error = msg["error"];
 				
-				let allowedObservers = this._observerIds || [];
-				let allowedTalkback = this._talkbackIds || [];
-				let allowedInstructor = this._instuctorId || null;
-				
 				if (event === "joined") {
 					this.id = msg["id"];
 					this.privateId = msg["private_id"];
@@ -401,68 +496,7 @@ class RoomSession {
 							streams[i]["display"] = userId;
 						}
 						this._log('Remote userId: ', userId);
-						
-						let isClassroom = allowedInstructor !== null;
-						let subscribeCondition;
-						let subCondition = false
-						
-						if(!isClassroom) {
-							subscribeCondition =   allowedObservers.indexOf(userId) === -1 && allowedTalkback.indexOf(this.userId) === -1;
-						} else {
-				
-							// instructor -> everyone but observer
-							if(this.options.classroomInstructorSubscribeToParticipants) {
-								subCondition = this.userId === allowedInstructor && allowedObservers.indexOf(userId) === -1;
-							}
-							
-							if(this.options.classroomObserverSubscribeToInstructor) {
-								
-								/*
-	
-									monitor/talkback -> all but talkback
-									observer -> all but talkback
-									instructor -> no one
-									participant -> only instructor, observer and talkback
-									
-									1st line -> Im not monitor/talkback and im not observer and im not instructor and user to subscribe is instructor or observer or talkback
-									2nd line -> Im monitor/talkback and im not instructor and user connecting is not talkback
-									3rd line -> Im observer and im not instructor and user connecting is not talkback
-									
-								*/
-								
-								subscribeCondition = subCondition ||
-									((!this.isMonitor && allowedObservers.indexOf(this.userId) === -1 && this.userId !== allowedInstructor) && (userId === allowedInstructor || allowedObservers.indexOf(userId) > -1 || allowedTalkback.indexOf(userId) > -1)) ||
-									(this.isMonitor && this.userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1) ||
-									(allowedObservers.indexOf(this.userId) > -1 && this.userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1)
-								
-								
-								
-							} else {
-								
-								/*
-				
-									monitor/talkback -> all but talkback
-									observer -> all but instructor and talkback
-									instructor -> no one
-									participant -> only instructor, observer and talkback
-									
-									1st line -> Im not monitor/talkback and im not observer and im not instructor and user to subscribe is instructor or observer or talkback
-									2nd line -> Im monitor/talkback and im not instructor and user connecting is not talkback
-									3rd line -> Im observer and im not instructor and user connecting is not instructor and its not talkback
-									
-								*/
-								
-								subscribeCondition = subCondition ||
-									((!this.isMonitor && allowedObservers.indexOf(this.userId) === -1 && this.userId !== allowedInstructor) && (userId === allowedInstructor || allowedObservers.indexOf(userId) > -1 || allowedTalkback.indexOf(userId) > -1)) ||
-									(this.isMonitor && this.userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1) ||
-									(allowedObservers.indexOf(this.userId) > -1 && this.userId !== allowedInstructor && userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1)
-								
-							}
-							
-							
-						}
-						
-						if (subscribeCondition) {
+						if (this._participantShouldSubscribe(userId)) {
 							this._log('Creating user: ', userId);
 							this._createParticipant(userId, id)
 								.then(handle => {
@@ -497,66 +531,7 @@ class RoomSession {
 							streams[i]["display"] = userId;
 						}
 						this._log('Remote userId: ', userId);
-						
-						let isClassroom = allowedInstructor !== null;
-						let subscribeCondition;
-						let subCondition = false
-						
-						if(!isClassroom) {
-							subscribeCondition =    allowedObservers.indexOf(userId) === -1 && allowedTalkback.indexOf(this.userId) === -1;
-						} else {
-							
-							// instructor -> everyone but observer
-							if(this.options.classroomInstructorSubscribeToParticipants) {
-								subCondition = this.userId === allowedInstructor && allowedObservers.indexOf(userId) === -1;
-							}
-							
-							if(this.options.classroomObserverSubscribeToInstructor) {
-								
-								/*
-	
-									monitor/talkback -> all but talkback
-									observer -> all but talkback
-									instructor -> no one
-									participant -> only instructor, observer and talkback
-									
-									1st line -> Im not monitor/talkback and im not observer and im not instructor and user to subscribe is instructor or observer or talkback
-									2nd line -> Im monitor/talkback and im not instructor and user connecting is not talkback
-									3rd line ->  Im observer and im not instructor and user connecting is not talkback
-									
-								*/
-								
-								subscribeCondition = subCondition ||
-									((!this.isMonitor && allowedObservers.indexOf(this.userId) === -1 && this.userId !== allowedInstructor) && (userId === allowedInstructor || allowedObservers.indexOf(userId) > -1 || allowedTalkback.indexOf(userId) > -1)) ||
-									(this.isMonitor && this.userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1) ||
-									(allowedObservers.indexOf(this.userId) > -1 && this.userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1)
-								
-								
-								
-							} else {
-								
-								/*
-				
-									monitor/talkback -> all but talkback
-									observer -> all but instructor and talkback
-									instructor -> no one
-									participant -> only instructor, observer and talkback
-									
-									1st line -> Im not monitor/talkback and im not observer and im not instructor and user to subscribe is instructor or observer or talkback
-									2nd line -> Im monitor/talkback and im not instructor and user connecting is not talkback
-									3rd line -> Im observer and im not instructor and user connecting is not instructor and its not talkback
-									
-								*/
-								
-								subscribeCondition = subCondition ||
-									((!this.isMonitor && allowedObservers.indexOf(this.userId) === -1 && this.userId !== allowedInstructor) && (userId === allowedInstructor || allowedObservers.indexOf(userId) > -1 || allowedTalkback.indexOf(userId) > -1)) ||
-									(this.isMonitor && this.userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1) ||
-									(allowedObservers.indexOf(this.userId) > -1 && this.userId !== allowedInstructor && userId !== allowedInstructor && allowedTalkback.indexOf(userId) === -1)
-								
-							}
-						}
-			
-						if (subscribeCondition) {
+						if (this._participantShouldSubscribe(userId)) {
 							this._log('Creating user: ', userId);
 							this._createParticipant(userId, id)
 								.then(handle => {
@@ -660,16 +635,7 @@ class RoomSession {
 			
 			if (event === "attached") {
 				this._log('Remote have successfully joined Room', msg);
-				let allowedTalkback = this._talkbackIds || [];
-				let allowedObservers = this._observerIds || [];
-				let eventName = 'addRemoteParticipant';
-				if (allowedTalkback.indexOf(handle.userId) > -1) {
-					eventName = 'addRemoteTalkback';
-				}
-				if (allowedObservers.indexOf(handle.userId) > -1) {
-					eventName = 'addRemoteObserver';
-				}
-				this.emit(eventName, {
+				this.emit(this._getAddParticipantEventName(handle.handleId), {
 					tid: generateUUID(),
 					id: handle.handleId,
 					userId: handle.userId,
@@ -807,20 +773,7 @@ class RoomSession {
 					this.emit('published', {status: false, hasStream: false});
 					this.emit('removeLocalParticipant', {id: handleId, userId: handle.userId});
 				} else {
-					let allowedTalkback = this._talkbackIds || [];
-					let allowedObservers = this._observerIds || [];
-					let allowedInstructor = this._instuctorId || null;
-					let eventName = 'removeRemoteParticipant';
-					if(handle.userId === allowedInstructor) {
-						eventName = 'removeRemoteInstructor';
-					}
-					if (allowedTalkback.indexOf(handle.userId) > -1) {
-						eventName = 'removeRemoteTalkback';
-					}
-					if (allowedObservers.indexOf(handle.userId) > -1) {
-						eventName = 'removeRemoteObserver';
-					}
-					this.emit(eventName, {id: handleId, userId: handle.userId});
+					this.emit(this._getRemoveParticipantEventName(handleId), {id: handleId, userId: handle.userId});
 				}
 
 				if (removeHandle) {
@@ -1134,7 +1087,7 @@ class RoomSession {
 	_enableDebug() {
 		this._log = console.log.bind(console);
 	}
-	
+
 	_getHandle(handleId, rfid = null) {
 		return this._participants.find(p => p.handleId === handleId || (rfid && p.rfid === rfid));
 	}
@@ -1198,12 +1151,40 @@ class RoomSession {
 					this._iceRestart(handleId);
 				}
 				this.emit('connectionState', [handleId, handleId === this.handleId, config.pc.connectionState]);
+				if(handleId !== this.handleId && config.pc.connectionState === 'connected') {
+					this.emit(this._getAddParticipantEventName(handle.handleId), {
+						tid: generateUUID(),
+						id: handle.handleId,
+						userId: handle.userId,
+						stream: config.stream,
+						optional: true,
+						constructId: this.constructId,
+						metaData: this.options.metaData,
+						adding: true,
+						hasAudioTrack: !!(config.stream && config.stream.getAudioTracks().length),
+						hasVideoTrack: !!(config.stream && config.stream.getVideoTracks().length)
+					})
+				}
 			};
 			config.pc.oniceconnectionstatechange = () => {
 				if (config.pc.iceConnectionState === 'failed') {
 					this._iceRestart(handleId);
 				}
 				this.emit('iceState', [handleId, handleId === this.handleId, config.pc.iceConnectionState]);
+				if(handleId !== this.handleId && (config.pc.iceConnectionState === 'completed' || config.pc.iceConnectionState === 'connected')) {
+					this.emit(this._getAddParticipantEventName(handle.handleId), {
+						tid: generateUUID(),
+						id: handle.handleId,
+						userId: handle.userId,
+						stream: config.stream,
+						optional: true,
+						constructId: this.constructId,
+						metaData: this.options.metaData,
+						adding: true,
+						hasAudioTrack: !!(config.stream && config.stream.getAudioTracks().length),
+						hasVideoTrack: !!(config.stream && config.stream.getVideoTracks().length)
+					})
+				}
 			};
 			config.pc.onicecandidate = (event) => {
 				if (event.candidate == null || (adapter.browserDetails.browser === 'edge' && event.candidate.candidate.indexOf('endOfCandidates') > 0)) {
@@ -1241,26 +1222,8 @@ class RoomSession {
 					}
 					
 					if (event.track) {
-						
 						config.stream.addTrack(event.track);
-						
-						let allowedTalkback = this._talkbackIds || [];
-						let allowedObservers = this._observerIds || [];
-						let allowedInstructor = this._instuctorId || null;
-						let eventName = 'addRemoteParticipant';
-						if(handle.userId === allowedInstructor) {
-							eventName = 'addRemoteInstructor';
-						}
-						if (allowedTalkback.indexOf(handle.userId) > -1) {
-							eventName = 'addRemoteTalkback';
-						}
-						if (allowedObservers.indexOf(handle.userId) > -1) {
-							eventName = 'addRemoteObserver';
-						}
-						
-						this._log(eventName, 'ontrack');
-						
-						this.emit(eventName, {
+						this.emit(this._getAddParticipantEventName(handle.handleId), {
 							tid: generateUUID(),
 							id: handle.handleId,
 							userId: handle.userId,
@@ -1277,25 +1240,9 @@ class RoomSession {
 							return;
 						
 						event.track.onended = (ev) => {
-							
-							let allowedTalkback = this._talkbackIds || [];
-							let allowedObservers = this._observerIds || [];
-							let allowedInstructor = this._instuctorId || null;
-							let eventName = 'addRemoteParticipant';
-							if(handle.userId === allowedInstructor) {
-								eventName = 'addRemoteInstructor';
-							}
-							if (allowedTalkback.indexOf(handle.userId) > -1) {
-								eventName = 'addRemoteTalkback';
-							}
-							if (allowedObservers.indexOf(handle.userId) > -1) {
-								eventName = 'addRemoteObserver';
-							}
-							
-							this._log(eventName, 'onended');
 							if (config.stream) {
 								config.stream && config.stream.removeTrack(ev.target);
-								this.emit(eventName, {
+								this.emit(this._getAddParticipantEventName(handle.handleId), {
 									tid: generateUUID(),
 									id: handle.handleId,
 									userId: handle.userId,
@@ -1371,7 +1318,7 @@ class RoomSession {
 		
 		let handle = this._getHandle(handleId);
 		if (!handle) {
-			return Promise.reject({type: 'warning', id: 16, message: 'id non-existent', data: [handleId, 'rtc peer']});
+			return Promise.reject({type: 'warning', id: 15, message: 'id non-existent', data: [handleId, 'rtc peer']});
 		}
 		
 		var config = handle.webrtcStuff;
@@ -1461,7 +1408,7 @@ class RoomSession {
 		if (!handle) {
 			return Promise.reject({
 				type: 'warning',
-				id: 17,
+				id: 15,
 				message: 'id non-existent',
 				data: [handleId, 'createAO', type]
 			});
@@ -1638,7 +1585,7 @@ class RoomSession {
 		if (!handle) {
 			return Promise.reject({
 				type: 'warning',
-				id: 18,
+				id: 15,
 				message: 'id non-existent',
 				data: [handleId, 'publish remote participant']
 			})
@@ -1936,10 +1883,7 @@ class RoomSession {
 		}
 		let config = handle.webrtcStuff;
 		
-		if(this.options.safariBugHotfixEnabled) {
-			this.isVideoMuted = !this.isVideoMuted;
-		}
-		else if (this.isUnifiedPlan) {
+		if (this.isUnifiedPlan) {
 			let transceiver = config.pc.getTransceivers()
 				.find(t => t.sender && t.sender.track && t.receiver.track.kind === "video" && t.stopped === false);
 			if (transceiver) {