multiparty-meeting/server/lib/Room.js

1220 lines
24 KiB
JavaScript

const EventEmitter = require('events').EventEmitter;
const Logger = require('./Logger');
const Lobby = require('./Lobby');
const config = require('../config/config');
const logger = new Logger('Room');
class Room extends EventEmitter
{
/**
* Factory function that creates and returns Room instance.
*
* @async
*
* @param {mediasoup.Worker} mediasoupWorker - The mediasoup Worker in which a new
* mediasoup Router must be created.
* @param {String} roomId - Id of the Room instance.
*/
static async create({ mediasoupWorker, roomId })
{
logger.info('create() [roomId:"%s"]', roomId);
// Router media codecs.
const mediaCodecs = config.mediasoup.router.mediaCodecs;
// Create a mediasoup Router.
const mediasoupRouter = await mediasoupWorker.createRouter({ mediaCodecs });
// Create a mediasoup AudioLevelObserver.
const audioLevelObserver = await mediasoupRouter.createAudioLevelObserver(
{
maxEntries : 1,
threshold : -80,
interval : 800
});
return new Room({ roomId, mediasoupRouter, audioLevelObserver });
}
constructor({ roomId, mediasoupRouter, audioLevelObserver })
{
logger.info('constructor() [roomId:"%s"]', roomId);
super();
this.setMaxListeners(Infinity);
// Room ID.
this._roomId = roomId;
// Closed flag.
this._closed = false;
// Locked flag.
this._locked = false;
// if true: accessCode is a possibility to open the room
this._joinByAccesCode = true;
// access code to the room,
// applicable if ( _locked == true and _joinByAccessCode == true )
this._accessCode = '';
this._lobby = new Lobby();
this._chatHistory = [];
this._fileHistory = [];
this._lastN = [];
this._peers = new Map();
// mediasoup Router instance.
this._mediasoupRouter = mediasoupRouter;
// mediasoup AudioLevelObserver.
this._audioLevelObserver = audioLevelObserver;
// Current active speaker.
this._currentActiveSpeaker = null;
this._handleLobby();
this._handleAudioLevelObserver();
}
isLocked()
{
return this._locked;
}
close()
{
logger.debug('close()');
this._closed = true;
this._lobby.close();
this._peers.forEach((peer) =>
{
if (!peer.closed)
peer.close();
});
this._peers.clear();
// Close the mediasoup Router.
this._mediasoupRouter.close();
// Emit 'close' event.
this.emit('close');
}
handlePeer(peer)
{
logger.info('handlePeer() [peer:"%s"]', peer.id);
// This will allow reconnects to join despite lock
if (this._peers.has(peer.id))
{
logger.warn(
'handleConnection() | there is already a peer with same peerId [peer:"%s"]',
peer.id);
peer.close();
return;
}
else if (this._locked)
{
this._parkPeer(peer);
}
else
{
peer.authenticated ?
this._peerJoining(peer) :
this._handleGuest(peer);
}
}
_handleGuest(peer)
{
if (config.requireSignInToAccess)
{
if (config.activateOnHostJoin && !this.checkEmpty())
{
this._peerJoining(peer);
}
else
{
this._parkPeer(peer);
this._notification(peer.socket, 'signInRequired');
}
}
else
{
this._peerJoining(peer);
}
}
_handleLobby()
{
this._lobby.on('promotePeer', (promotedPeer) =>
{
logger.info('promotePeer() [promotedPeer:"%s"]', promotedPeer.id);
const { id } = promotedPeer;
this._peerJoining(promotedPeer);
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'lobby:promotedPeer', { peerId: id });
});
});
this._lobby.on('peerAuthenticated', (peer) =>
{
!this._locked && this._lobby.promotePeer(peer.id);
});
this._lobby.on('changeDisplayName', (changedPeer) =>
{
const { id, displayName } = changedPeer;
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'lobby:changeDisplayName', { peerId: id, displayName });
});
});
this._lobby.on('changePicture', (changedPeer) =>
{
const { id, picture } = changedPeer;
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'lobby:changePicture', { peerId: id, picture });
});
});
this._lobby.on('peerClosed', (closedPeer) =>
{
logger.info('peerClosed() [closedPeer:"%s"]', closedPeer.id);
const { id } = closedPeer;
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'lobby:peerClosed', { peerId: id });
});
});
// If nobody left in lobby we should check if room is empty too and initiating
// rooms selfdestruction sequence
this._lobby.on('lobbyEmpty', () =>
{
if (this.checkEmpty())
{
this.selfDestructCountdown();
}
});
}
_handleAudioLevelObserver()
{
// Set audioLevelObserver events.
this._audioLevelObserver.on('volumes', (volumes) =>
{
const { producer, volume } = volumes[0];
// Notify all Peers.
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'activeSpeaker', {
peerId : producer.appData.peerId,
volume : volume
});
});
});
this._audioLevelObserver.on('silence', () =>
{
// Notify all Peers.
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'activeSpeaker', { peerId: null });
});
});
}
logStatus()
{
logger.info(
'logStatus() [room id:"%s", peers:"%s"]',
this._roomId,
this._peers.size
);
}
get id()
{
return this._roomId;
}
selfDestructCountdown()
{
logger.debug('selfDestructCountdown() started');
setTimeout(() =>
{
if (this._closed)
return;
if (this.checkEmpty() && this._lobby.checkEmpty())
{
logger.info(
'Room deserted for some time, closing the room [roomId:"%s"]',
this._roomId);
this.close();
}
else
logger.debug('selfDestructCountdown() aborted; room is not empty!');
}, 10000);
}
// checks both room and lobby
checkEmpty()
{
return this._peers.size === 0;
}
_parkPeer(parkPeer)
{
this._lobby.parkPeer(parkPeer);
this._peers.forEach((peer) =>
{
this._notification(peer.socket, 'parkedPeer', { peerId: parkPeer.id });
});
}
_peerJoining(peer)
{
peer.socket.join(this._roomId);
const index = this._lastN.indexOf(peer.id);
if (index === -1) // We don't have this peer, add to end
{
this._lastN.push(peer.id);
}
this._peers.set(peer.id, peer);
this._handlePeer(peer);
this._notification(peer.socket, 'roomReady');
}
_handlePeer(peer)
{
logger.debug('_handlePeer() [peer:"%s"]', peer.id);
peer.socket.on('request', (request, cb) =>
{
logger.debug(
'Peer "request" event [method:"%s", peerId:"%s"]',
request.method, peer.id);
this._handleSocketRequest(peer, request, cb)
.catch((error) =>
{
logger.error('"request" failed [error:"%o"]', error);
cb(error);
});
});
peer.on('close', () =>
{
if (this._closed)
return;
// If the Peer was joined, notify all Peers.
if (peer.joined)
{
this._notification(peer.socket, 'peerClosed', { peerId: peer.id }, true);
}
const index = this._lastN.indexOf(peer.id);
if (index > -1) // We have this peer in the list, remove
{
this._lastN.splice(index, 1);
}
this._peers.delete(peer.id);
// If this is the last Peer in the room and
// lobby is empty, close the room after a while.
if (this.checkEmpty() && this._lobby.checkEmpty())
{
this.selfDestructCountdown();
}
});
peer.on('displayNameChanged', ({ oldDisplayName }) =>
{
// Ensure the Peer is joined.
if (!peer.joined)
return;
// Spread to others
this._notification(peer.socket, 'changeDisplayName', {
peerId : peer.id,
displayName : peer.displayName,
oldDisplayName : oldDisplayName
}, true);
});
peer.on('pictureChanged', () =>
{
// Ensure the Peer is joined.
if (!peer.joined)
return;
// Spread to others
this._notification(peer.socket, 'changePicture', {
peerId : peer.id,
picture : peer.picture
}, true);
});
}
async _handleSocketRequest(peer, request, cb)
{
switch (request.method)
{
case 'getRouterRtpCapabilities':
{
cb(null, this._mediasoupRouter.rtpCapabilities);
break;
}
case 'join':
{
// Ensure the Peer is not already joined.
if (peer.joined)
throw new Error('Peer already joined');
const {
displayName,
picture,
device,
rtpCapabilities
} = request.data;
// Store client data into the Peer data object.
peer.displayName = displayName;
peer.picture = picture;
peer.device = device;
peer.rtpCapabilities = rtpCapabilities;
// Tell the new Peer about already joined Peers.
// And also create Consumers for existing Producers.
const peerInfos = [];
this._peers.forEach((joinedPeer) =>
{
if (joinedPeer.joined)
{
peerInfos.push(joinedPeer.peerInfo);
joinedPeer.producers.forEach((producer) =>
{
this._createConsumer(
{
consumerPeer : peer,
producerPeer : joinedPeer,
producer
});
});
}
});
cb(null, { peers: peerInfos });
// Mark the new Peer as joined.
peer.joined = true;
this._notification(
peer.socket,
'newPeer',
{
id : peer.id,
displayName : displayName,
picture : picture,
device : device
},
true
);
logger.debug(
'peer joined [peer: "%s", displayName: "%s", picture: "%s"]',
peer.id, displayName, picture);
break;
}
case 'createWebRtcTransport':
{
// NOTE: Don't require that the Peer is joined here, so the client can
// initiate mediasoup Transports and be ready when he later joins.
const { forceTcp, producing, consuming } = request.data;
const {
maxIncomingBitrate,
initialAvailableOutgoingBitrate
} = config.mediasoup.webRtcTransport;
const transport = await this._mediasoupRouter.createWebRtcTransport(
{
listenIps : config.mediasoup.webRtcTransport.listenIps,
enableUdp : !forceTcp,
enableTcp : true,
preferUdp : true,
initialAvailableOutgoingBitrate,
appData : { producing, consuming }
});
// Store the WebRtcTransport into the Peer data Object.
peer.addTransport(transport.id, transport);
cb(
null,
{
id : transport.id,
iceParameters : transport.iceParameters,
iceCandidates : transport.iceCandidates,
dtlsParameters : transport.dtlsParameters
});
// If set, apply max incoming bitrate limit.
if (maxIncomingBitrate)
{
try { await transport.setMaxIncomingBitrate(maxIncomingBitrate); }
catch (error) {}
}
break;
}
case 'connectWebRtcTransport':
{
const { transportId, dtlsParameters } = request.data;
const transport = peer.getTransport(transportId);
if (!transport)
throw new Error(`transport with id "${transportId}" not found`);
await transport.connect({ dtlsParameters });
cb();
break;
}
case 'restartIce':
{
const { transportId } = request.data;
const transport = peer.getTransport(transportId);
if (!transport)
throw new Error(`transport with id "${transportId}" not found`);
const iceParameters = await transport.restartIce();
cb(null, iceParameters);
break;
}
case 'produce':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { transportId, kind, rtpParameters } = request.data;
let { appData } = request.data;
const transport = peer.getTransport(transportId);
if (!transport)
throw new Error(`transport with id "${transportId}" not found`);
// Add peerId into appData to later get the associated Peer during
// the 'loudest' event of the audioLevelObserver.
appData = { ...appData, peerId: peer.id };
const producer =
await transport.produce({ kind, rtpParameters, appData });
// Store the Producer into the Peer data Object.
peer.addProducer(producer.id, producer);
// Set Producer events.
producer.on('score', (score) =>
{
this._notification(peer.socket, 'producerScore', { producerId: producer.id, score });
});
producer.on('videoorientationchange', (videoOrientation) =>
{
logger.debug(
'producer "videoorientationchange" event [producerId:"%s", videoOrientation:"%o"]',
producer.id, videoOrientation);
});
cb(null, { id: producer.id });
this._peers.forEach((otherPeer) =>
{
if (otherPeer.joined && otherPeer !== peer)
{
this._createConsumer(
{
consumerPeer : otherPeer,
producerPeer : peer,
producer
});
}
});
// Add into the audioLevelObserver.
if (kind === 'audio')
{
this._audioLevelObserver.addProducer({ producerId: producer.id })
.catch(() => {});
}
break;
}
case 'closeProducer':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { producerId } = request.data;
const producer = peer.getProducer(producerId);
if (!producer)
throw new Error(`producer with id "${producerId}" not found`);
producer.close();
// Remove from its map.
peer.removeProducer(producer.id);
cb();
break;
}
case 'pauseProducer':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { producerId } = request.data;
const producer = peer.getProducer(producerId);
if (!producer)
throw new Error(`producer with id "${producerId}" not found`);
await producer.pause();
cb();
break;
}
case 'resumeProducer':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { producerId } = request.data;
const producer = peer.getProducer(producerId);
if (!producer)
throw new Error(`producer with id "${producerId}" not found`);
await producer.resume();
cb();
break;
}
case 'pauseConsumer':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { consumerId } = request.data;
const consumer = peer.getConsumer(consumerId);
if (!consumer)
throw new Error(`consumer with id "${consumerId}" not found`);
await consumer.pause();
cb();
break;
}
case 'resumeConsumer':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { consumerId } = request.data;
const consumer = peer.getConsumer(consumerId);
if (!consumer)
throw new Error(`consumer with id "${consumerId}" not found`);
await consumer.resume();
cb();
break;
}
case 'setConsumerPreferedLayers':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { consumerId, spatialLayer, temporalLayer } = request.data;
const consumer = peer.getConsumer(consumerId);
if (!consumer)
throw new Error(`consumer with id "${consumerId}" not found`);
await consumer.setPreferredLayers({ spatialLayer, temporalLayer });
cb();
break;
}
case 'requestConsumerKeyFrame':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { consumerId } = request.data;
const consumer = peer.getConsumer(consumerId);
if (!consumer)
throw new Error(`consumer with id "${consumerId}" not found`);
await consumer.requestKeyFrame();
cb();
break;
}
case 'getTransportStats':
{
const { transportId } = request.data;
const transport = peer.getTransport(transportId);
if (!transport)
throw new Error(`transport with id "${transportId}" not found`);
const stats = await transport.getStats();
cb(null, stats);
break;
}
case 'getProducerStats':
{
const { producerId } = request.data;
const producer = peer.getProducer(producerId);
if (!producer)
throw new Error(`producer with id "${producerId}" not found`);
const stats = await producer.getStats();
cb(null, stats);
break;
}
case 'getConsumerStats':
{
const { consumerId } = request.data;
const consumer = peer.getConsumer(consumerId);
if (!consumer)
throw new Error(`consumer with id "${consumerId}" not found`);
const stats = await consumer.getStats();
cb(null, stats);
break;
}
case 'changeDisplayName':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { displayName } = request.data;
const oldDisplayName = peer.displayName;
peer.displayName = displayName;
// Spread to others
this._notification(peer.socket, 'changeDisplayName', {
peerId : peer.id,
displayName : displayName,
oldDisplayName : oldDisplayName
}, true);
// Return no error
cb();
break;
}
case 'changePicture':
{
// Ensure the Peer is joined.
if (!peer.joined)
throw new Error('Peer not yet joined');
const { picture } = request.data;
peer.picture = picture;
// Spread to others
this._notification(peer.socket, 'changePicture', {
peerId : peer.id,
picture : picture
}, true);
// Return no error
cb();
break;
}
case 'chatMessage':
{
const { chatMessage } = request.data;
this._chatHistory.push(chatMessage);
// Spread to others
this._notification(peer.socket, 'chatMessage', {
peerId : peer.id,
chatMessage : chatMessage
}, true);
// Return no error
cb();
break;
}
case 'serverHistory':
{
// Return to sender
const lobbyPeers = this._lobby.peerList();
cb(
null,
{
chatHistory : this._chatHistory,
fileHistory : this._fileHistory,
lastNHistory : this._lastN,
locked : this._locked,
lobbyPeers : lobbyPeers,
accessCode : this._accessCode
}
);
break;
}
case 'lockRoom':
{
this._locked = true;
// Spread to others
this._notification(peer.socket, 'lockRoom', {
peerId : peer.id
}, true);
// Return no error
cb();
break;
}
case 'unlockRoom':
{
this._locked = false;
// Spread to others
this._notification(peer.socket, 'unlockRoom', {
peerId : peer.id
}, true);
this._lobby.promoteAllPeers();
// Return no error
cb();
break;
}
case 'setAccessCode':
{
const { accessCode } = request.data;
this._accessCode = accessCode;
// Spread to others
// if (request.public) {
this._notification(peer.socket, 'setAccessCode', {
peerId : peer.id,
accessCode : accessCode
}, true);
// }
// Return no error
cb();
break;
}
case 'setJoinByAccessCode':
{
const { joinByAccessCode } = request.data;
this._joinByAccessCode = joinByAccessCode;
// Spread to others
this._notification(peer.socket, 'setJoinByAccessCode', {
peerId : peer.id,
joinByAccessCode : joinByAccessCode
}, true);
// Return no error
cb();
break;
}
case 'promotePeer':
{
const { peerId } = request.data;
this._lobby.promotePeer(peerId);
// Return no error
cb();
break;
}
case 'promoteAllPeers':
{
this._lobby.promoteAllPeers();
// Return no error
cb();
break;
}
case 'sendFile':
{
const { magnetUri } = request.data;
this._fileHistory.push({ peerId: peer.id, magnetUri: magnetUri });
// Spread to others
this._notification(peer.socket, 'sendFile', {
peerId : peer.id,
magnetUri : magnetUri
}, true);
// Return no error
cb();
break;
}
case 'raiseHand':
{
const { raisedHand } = request.data;
peer.raisedHand = raisedHand;
// Spread to others
this._notification(peer.socket, 'raiseHand', {
peerId : peer.id,
raisedHand : raisedHand
}, true);
// Return no error
cb();
break;
}
default:
{
logger.error('unknown request.method "%s"', request.method);
cb(500, `unknown request.method "${request.method}"`);
}
}
}
/**
* Creates a mediasoup Consumer for the given mediasoup Producer.
*
* @async
*/
async _createConsumer({ consumerPeer, producerPeer, producer })
{
logger.debug(
'_createConsumer() [consumerPeer:"%s", producerPeer:"%s", producer:"%s"]',
consumerPeer.id,
producerPeer.id,
producer.id
);
// Optimization:
// - Create the server-side Consumer. If video, do it paused.
// - Tell its Peer about it and wait for its response.
// - Upon receipt of the response, resume the server-side Consumer.
// - If video, this will mean a single key frame requested by the
// server-side Consumer (when resuming it).
// NOTE: Don't create the Consumer if the remote Peer cannot consume it.
if (
!consumerPeer.rtpCapabilities ||
!this._mediasoupRouter.canConsume(
{
producerId : producer.id,
rtpCapabilities : consumerPeer.rtpCapabilities
})
)
{
return;
}
// Must take the Transport the remote Peer is using for consuming.
const transport = consumerPeer.getConsumerTransport();
// This should not happen.
if (!transport)
{
logger.warn('_createConsumer() | Transport for consuming not found');
return;
}
// Create the Consumer in paused mode.
let consumer;
try
{
consumer = await transport.consume(
{
producerId : producer.id,
rtpCapabilities : consumerPeer.rtpCapabilities,
paused : producer.kind === 'video'
});
}
catch (error)
{
logger.warn('_createConsumer() | [error:"%o"]', error);
return;
}
// Store the Consumer into the consumerPeer data Object.
consumerPeer.addConsumer(consumer.id, consumer);
// Set Consumer events.
consumer.on('transportclose', () =>
{
// Remove from its map.
consumerPeer.removeConsumer(consumer.id);
});
consumer.on('producerclose', () =>
{
// Remove from its map.
consumerPeer.removeConsumer(consumer.id);
this._notification(consumerPeer.socket, 'consumerClosed', { consumerId: consumer.id });
});
consumer.on('producerpause', () =>
{
this._notification(consumerPeer.socket, 'consumerPaused', { consumerId: consumer.id });
});
consumer.on('producerresume', () =>
{
this._notification(consumerPeer.socket, 'consumerResumed', { consumerId: consumer.id });
});
consumer.on('score', (score) =>
{
this._notification(consumerPeer.socket, 'consumerScore', { consumerId: consumer.id, score });
});
consumer.on('layerschange', (layers) =>
{
this._notification(
consumerPeer.socket,
'consumerLayersChanged',
{
consumerId : consumer.id,
spatialLayer : layers ? layers.spatialLayer : null,
temporalLayer : layers ? layers.temporalLayer : null
}
);
});
// Send a request to the remote Peer with Consumer parameters.
try
{
await this._request(
consumerPeer.socket,
'newConsumer',
{
peerId : producerPeer.id,
kind : producer.kind,
producerId : producer.id,
id : consumer.id,
rtpParameters : consumer.rtpParameters,
type : consumer.type,
appData : producer.appData,
producerPaused : consumer.producerPaused
}
);
// Now that we got the positive response from the remote Peer and, if
// video, resume the Consumer to ask for an efficient key frame.
if (producer.kind === 'video')
await consumer.resume();
this._notification(
consumerPeer.socket,
'consumerScore',
{
consumerId : consumer.id,
score : consumer.score
}
);
}
catch (error)
{
logger.warn('_createConsumer() | [error:"%o"]', error);
}
}
_timeoutCallback(callback)
{
let called = false;
const interval = setTimeout(
() =>
{
if (called)
return;
called = true;
callback(new Error('Request timeout.'));
},
10000
);
return (...args) =>
{
if (called)
return;
called = true;
clearTimeout(interval);
callback(...args);
};
}
_request(socket, method, data = {})
{
return new Promise((resolve, reject) =>
{
socket.emit(
'request',
{ method, data },
this._timeoutCallback((err, response) =>
{
if (err)
{
reject(err);
}
else
{
resolve(response);
}
})
);
});
}
_notification(socket, method, data = {}, broadcast = false)
{
if (broadcast)
{
socket.broadcast.to(this._roomId).emit(
'notification', { method, data }
);
}
else
{
socket.emit('notification', { method, data });
}
}
}
module.exports = Room;