openvidu-browser 2.21.0-beta1 → 2.21.0

package/lib/OpenVidu/Session.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * (C) Copyright 2017-2020 OpenVidu (https://openvidu.io)
+ * (C) Copyright 2017-2022 OpenVidu (https://openvidu.io)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,8 @@ var __extends = (this && this.__extends) || (function () {
         return extendStatics(d, b);
     };
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
         function __() { this.constructor = d; }
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
@@ -83,6 +85,14 @@ var OpenViduError_1 = require("../OpenViduInternal/Enums/OpenViduError");
 var VideoInsertMode_1 = require("../OpenViduInternal/Enums/VideoInsertMode");
 var OpenViduLogger_1 = require("../OpenViduInternal/Logger/OpenViduLogger");
 var Platform_1 = require("../OpenViduInternal/Utils/Platform");
+/**
+ * @hidden
+ */
+var semverMajor = require("semver/functions/major");
+/**
+ * @hidden
+ */
+var semverMinor = require("semver/functions/minor");
 /**
  * @hidden
  */
@@ -96,24 +106,7 @@ var platform;
  * Participants who publish their videos to a session can be seen by the rest of users connected to that specific session.
  * Initialized with [[OpenVidu.initSession]] method.
  *
- * ### Available event listeners (and events dispatched)
- *
- * - connectionCreated ([[ConnectionEvent]])
- * - connectionDestroyed ([[ConnectionEvent]])
- * - connectionPropertyChanged ([[ConnectionPropertyChangedEvent]]) <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
- * - sessionDisconnected ([[SessionDisconnectedEvent]])
- * - streamCreated ([[StreamEvent]])
- * - streamDestroyed ([[StreamEvent]])
- * - streamPropertyChanged ([[StreamPropertyChangedEvent]])
- * - publisherStartSpeaking ([[PublisherSpeakingEvent]])
- * - publisherStopSpeaking ([[PublisherSpeakingEvent]])
- * - signal ([[SignalEvent]])
- * - recordingStarted ([[RecordingEvent]])
- * - recordingStopped ([[RecordingEvent]])
- * - networkQualityLevelChanged ([[NetworkQualityLevelChangedEvent]])
- * - reconnecting
- * - reconnected
- * - exception ([[ExceptionEvent]])
+ * See available event listeners at [[SessionEventMap]].
  */
 var Session = /** @class */ (function (_super) {
     __extends(Session, _super);
@@ -177,14 +170,12 @@ var Session = /** @class */ (function (_super) {
                     participantId: token,
                     metadata: !!metadata ? _this.stringClientMetadata(metadata) : ''
                 };
-                _this.connectAux(token).then(function () {
-                    resolve();
-                }).catch(function (error) {
-                    reject(error);
-                });
+                _this.connectAux(token)
+                    .then(function () { return resolve(); })
+                    .catch(function (error) { return reject(error); });
             }
             else {
-                reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.BROWSER_NOT_SUPPORTED, 'Browser ' + platform.getName() + ' (version ' + platform.getVersion() + ') for ' + platform.getFamily() + ' is not supported in OpenVidu'));
+                return reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.BROWSER_NOT_SUPPORTED, 'Browser ' + platform.getName() + ' (version ' + platform.getVersion() + ') for ' + platform.getFamily() + ' is not supported in OpenVidu'));
             }
         });
     };
@@ -285,15 +276,15 @@ var Session = /** @class */ (function (_super) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             if (!_this.sessionConnected()) {
-                reject(_this.notConnectedError());
+                return reject(_this.notConnectedError());
             }
             var subscriber;
             var callback = function (error) {
                 if (!!error) {
-                    reject(error);
+                    return reject(error);
                 }
                 else {
-                    resolve(subscriber);
+                    return resolve(subscriber);
                 }
             };
             if (!!properties) {
@@ -318,7 +309,7 @@ var Session = /** @class */ (function (_super) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             if (!_this.sessionConnected()) {
-                reject(_this.notConnectedError());
+                return reject(_this.notConnectedError());
             }
             else {
                 var connectionId_1 = subscriber.stream.connection.connectionId;
@@ -326,14 +317,14 @@ var Session = /** @class */ (function (_super) {
                 _this.openvidu.sendRequest('unsubscribeFromVideo', { sender: subscriber.stream.connection.connectionId }, function (error, response) {
                     if (error) {
                         logger.error('Error unsubscribing from ' + connectionId_1);
-                        reject(error);
+                        return reject(error);
                     }
                     else {
                         logger.info('Unsubscribed correctly from ' + connectionId_1);
                         subscriber.stream.streamManager.removeAllVideos();
                         subscriber.stream.disposeWebRtcPeer();
                         subscriber.stream.disposeMediaStream();
-                        resolve();
+                        return resolve();
                     }
                 });
             }
@@ -356,7 +347,7 @@ var Session = /** @class */ (function (_super) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             if (!_this.sessionConnected()) {
-                reject(_this.notConnectedError());
+                return reject(_this.notConnectedError());
             }
             publisher.session = _this;
             publisher.stream.session = _this;
@@ -366,11 +357,9 @@ var Session = /** @class */ (function (_super) {
                 publisher.stream.publish()
                     .then(function () {
                     _this.sendVideoData(publisher, 8, true, 5);
-                    resolve();
+                    return resolve();
                 })
-                    .catch(function (error) {
-                    reject(error);
-                });
+                    .catch(function (error) { return reject(error); });
             }
             else {
                 // 'Session.unpublish(Publisher)' has been called. Must initialize again Publisher
@@ -381,14 +370,10 @@ var Session = /** @class */ (function (_super) {
                     publisher.stream.publish()
                         .then(function () {
                         _this.sendVideoData(publisher, 8, true, 5);
-                        resolve();
+                        return resolve();
                     })
-                        .catch(function (error) {
-                        reject(error);
-                    });
-                }).catch(function (error) {
-                    reject(error);
-                });
+                        .catch(function (error) { return reject(error); });
+                }).catch(function (error) { return reject(error); });
             }
         });
     };
@@ -419,17 +404,17 @@ var Session = /** @class */ (function (_super) {
             }
             var stream = publisher.stream;
             if (!stream.connection) {
-                reject(new Error('The associated Connection object of this Publisher is null'));
+                return reject(new Error('The associated Connection object of this Publisher is null'));
             }
             else if (stream.connection !== _this.connection) {
-                reject(new Error('The associated Connection object of this Publisher is not your local Connection.' +
+                return reject(new Error('The associated Connection object of this Publisher is not your local Connection.' +
                     "Only moderators can force unpublish on remote Streams via 'forceUnpublish' method"));
             }
             else {
                 logger.info('Unpublishing local media (' + stream.connection.connectionId + ')');
                 _this.openvidu.sendRequest('unpublishVideo', function (error, response) {
                     if (error) {
-                        reject(error);
+                        return reject(error);
                     }
                     else {
                         logger.info('Media unpublished correctly');
@@ -441,7 +426,7 @@ var Session = /** @class */ (function (_super) {
                         var streamEvent = new StreamEvent_1.StreamEvent(true, publisher, 'streamDestroyed', publisher.stream, 'unpublish');
                         publisher.emitEvent('streamDestroyed', [streamEvent]);
                         streamEvent.callDefaultBehavior();
-                        resolve();
+                        return resolve();
                     }
                 });
             }
@@ -468,22 +453,22 @@ var Session = /** @class */ (function (_super) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             if (!_this.sessionConnected()) {
-                reject(_this.notConnectedError());
+                return reject(_this.notConnectedError());
             }
             logger.info('Forcing disconnect for connection ' + connection.connectionId);
             _this.openvidu.sendRequest('forceDisconnect', { connectionId: connection.connectionId }, function (error, response) {
                 if (error) {
                     logger.error('Error forcing disconnect for Connection ' + connection.connectionId, error);
                     if (error.code === 401) {
-                        reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.OPENVIDU_PERMISSION_DENIED, "You don't have permissions to force a disconnection"));
+                        return reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.OPENVIDU_PERMISSION_DENIED, "You don't have permissions to force a disconnection"));
                     }
                     else {
-                        reject(error);
+                        return reject(error);
                     }
                 }
                 else {
                     logger.info('Forcing disconnect correctly for Connection ' + connection.connectionId);
-                    resolve();
+                    return resolve();
                 }
             });
         });
@@ -507,22 +492,22 @@ var Session = /** @class */ (function (_super) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             if (!_this.sessionConnected()) {
-                reject(_this.notConnectedError());
+                return reject(_this.notConnectedError());
             }
             logger.info('Forcing unpublish for stream ' + stream.streamId);
             _this.openvidu.sendRequest('forceUnpublish', { streamId: stream.streamId }, function (error, response) {
                 if (error) {
                     logger.error('Error forcing unpublish for Stream ' + stream.streamId, error);
                     if (error.code === 401) {
-                        reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.OPENVIDU_PERMISSION_DENIED, "You don't have permissions to force an unpublishing"));
+                        return reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.OPENVIDU_PERMISSION_DENIED, "You don't have permissions to force an unpublishing"));
                     }
                     else {
-                        reject(error);
+                        return reject(error);
                     }
                 }
                 else {
                     logger.info('Forcing unpublish correctly for Stream ' + stream.streamId);
-                    resolve();
+                    return resolve();
                 }
             });
         });
@@ -543,7 +528,7 @@ var Session = /** @class */ (function (_super) {
         var _this = this;
         return new Promise(function (resolve, reject) {
             if (!_this.sessionConnected()) {
-                reject(_this.notConnectedError());
+                return reject(_this.notConnectedError());
             }
             var signalMessage = {};
             if (signal.to && signal.to.length > 0) {
@@ -570,10 +555,10 @@ var Session = /** @class */ (function (_super) {
                 message: JSON.stringify(signalMessage)
             }, function (error, response) {
                 if (!!error) {
-                    reject(error);
+                    return reject(error);
                 }
                 else {
-                    resolve();
+                    return resolve();
                 }
             });
         });
@@ -653,7 +638,7 @@ var Session = /** @class */ (function (_super) {
     Session.prototype.off = function (type, handler) {
         var _this = this;
         var _a, _b, _c, _d;
-        _super.prototype.off.call(this, type, handler);
+        _super.prototype.offAux.call(this, type, handler);
         if (type === 'publisherStartSpeaking') {
             // Check if Session object still has some listener for the event
             if (!this.anySpeechEventListenerEnabled('publisherStartSpeaking', false)) {
@@ -937,28 +922,19 @@ var Session = /** @class */ (function (_super) {
      * @hidden
      */
     Session.prototype.recvIceCandidate = function (event) {
-        var candidate = {
+        // The event contains fields that can be used to obtain a proper candidate,
+        // using the RTCIceCandidate constructor:
+        // https://w3c.github.io/webrtc-pc/#dom-rtcicecandidate-constructor
+        var candidateInit = {
             candidate: event.candidate,
-            sdpMid: event.sdpMid,
             sdpMLineIndex: event.sdpMLineIndex,
-            component: null,
-            foundation: null,
-            port: null,
-            priority: null,
-            protocol: null,
-            relatedAddress: null,
-            relatedPort: null,
-            tcpType: null,
-            usernameFragment: null,
-            type: null,
-            toJSON: function () {
-                return { candidate: event.candidate };
-            }
+            sdpMid: event.sdpMid,
         };
-        this.getConnection(event.senderConnectionId, 'Connection not found for connectionId ' + event.senderConnectionId + ' owning endpoint ' + event.endpointName + '. Ice candidate will be ignored: ' + candidate)
+        var iceCandidate = new RTCIceCandidate(candidateInit);
+        this.getConnection(event.senderConnectionId, 'Connection not found for connectionId ' + event.senderConnectionId + ' owning endpoint ' + event.endpointName + '. Ice candidate will be ignored: ' + iceCandidate)
             .then(function (connection) {
             var stream = connection.stream;
-            stream.getWebRtcPeer().addIceCandidate(candidate).catch(function (error) {
+            stream.getWebRtcPeer().addIceCandidate(iceCandidate).catch(function (error) {
                 logger.error('Error adding candidate for ' + stream.streamId
                     + ' stream of endpoint ' + event.endpointName + ': ' + error);
             });
@@ -1058,7 +1034,7 @@ var Session = /** @class */ (function (_super) {
                             // of the subscriber was already taking place. Always use the last one to retry the re-subscription
                             // process, as that SDP offer will be the only one available at the server side. Ignore previous ones
                             stream_1.reconnectionEventEmitter['onForciblyReconnectSubscriberLastEvent'] = event;
-                            reject('Ongoing forced subscriber reconnection');
+                            return reject('Ongoing forced subscriber reconnection');
                         }
                         else {
                             // One onForciblyReconnectSubscriber even has been received while a reconnection process
@@ -1081,17 +1057,17 @@ var Session = /** @class */ (function (_super) {
                     }
                     stream_1.completeWebRtcPeerReceive(true, true, event.sdpOffer)
                         .then(function () { return stream_1.finalResolveForSubscription(true, resolve); })
-                        .catch(function (error) { return stream_1.finalRejectForSubscription(true, "Error while forcibly reconnecting remote stream " + event.streamId + ": " + error.toString(), reject); });
+                        .catch(function (error) { return stream_1.finalRejectForSubscription(true, "Error while forcibly reconnecting remote stream ".concat(event.streamId, ": ").concat(error.toString()), reject); });
                 }
                 else {
                     var errMsg = "No stream with streamId '" + event.streamId + "' found for connection '" + event.connectionId + "' on 'streamPropertyChanged' event";
                     logger.error(errMsg);
-                    reject(errMsg);
+                    return reject(errMsg);
                 }
             })
                 .catch(function (openViduError) {
                 logger.error(openViduError);
-                reject(openViduError);
+                return reject(openViduError);
             });
         });
     };
@@ -1137,7 +1113,7 @@ var Session = /** @class */ (function (_super) {
             if (!this.connection.disposed && !forced) {
                 this.openvidu.sendRequest('leaveRoom', function (error, response) {
                     if (error) {
-                        logger.error("leaveRoom error: " + JSON.stringify(error));
+                        logger.error("leaveRoom error: ".concat(JSON.stringify(error)));
                     }
                     _this.openvidu.closeWs();
                 });
@@ -1166,6 +1142,7 @@ var Session = /** @class */ (function (_super) {
             token: (!!token) ? token : '',
             session: this.sessionId,
             platform: !!platform.getDescription() ? platform.getDescription() : 'unknown',
+            sdkVersion: this.openvidu.libraryVersion,
             metadata: !!this.options.metadata ? this.options.metadata : '',
             secret: this.openvidu.getSecret(),
             recorder: this.openvidu.getRecorder()
@@ -1290,13 +1267,13 @@ var Session = /** @class */ (function (_super) {
         return new Promise(function (resolve, reject) {
             _this.openvidu.startWs(function (error) {
                 if (!!error) {
-                    reject(error);
+                    return reject(error);
                 }
                 else {
                     var joinParams = _this.initializeParams(token);
                     _this.openvidu.sendRequest('joinRoom', joinParams, function (error, response) {
                         if (!!error) {
-                            reject(error);
+                            return reject(error);
                         }
                         else {
                             // Process join room response
@@ -1330,7 +1307,7 @@ var Session = /** @class */ (function (_super) {
                             events_1.streams.forEach(function (stream) {
                                 _this.ee.emitEvent('streamCreated', [new StreamEvent_1.StreamEvent(false, _this, 'streamCreated', stream, '')]);
                             });
-                            resolve();
+                            return resolve();
                         }
                     });
                 }
@@ -1365,16 +1342,16 @@ var Session = /** @class */ (function (_super) {
             var connection = _this.remoteConnections.get(connectionId);
             if (!!connection) {
                 // Resolve remote connection
-                resolve(connection);
+                return resolve(connection);
             }
             else {
                 if (_this.connection.connectionId === connectionId) {
                     // Resolve local connection
-                    resolve(_this.connection);
+                    return resolve(_this.connection);
                 }
                 else {
                     // Connection not found. Reject with OpenViduError
-                    reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.GENERIC_ERROR, errorMessage));
+                    return reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.GENERIC_ERROR, errorMessage));
                 }
             }
         });
@@ -1385,13 +1362,13 @@ var Session = /** @class */ (function (_super) {
             var connection = _this.remoteConnections.get(connectionId);
             if (!!connection) {
                 // Resolve remote connection
-                resolve(connection);
+                return resolve(connection);
             }
             else {
                 // Remote connection not found. Reject with OpenViduError
                 var errorMessage = 'Remote connection ' + connectionId + " unknown when '" + operation + "'. " +
                     'Existing remote connections: ' + JSON.stringify(_this.remoteConnections.keys());
-                reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.GENERIC_ERROR, errorMessage));
+                return reject(new OpenViduError_1.OpenViduError(OpenViduError_1.OpenViduErrorName.GENERIC_ERROR, errorMessage));
             }
         });
     };
@@ -1443,7 +1420,23 @@ var Session = /** @class */ (function (_super) {
     };
     Session.prototype.processJoinRoomResponse = function (opts) {
         this.sessionId = opts.session;
-        if (opts.coturnIp != null && opts.coturnPort != null && opts.turnUsername != null && opts.turnCredential != null) {
+        if (opts.customIceServers != null && opts.customIceServers.length > 0) {
+            this.openvidu.iceServers = [];
+            for (var _i = 0, _a = opts.customIceServers; _i < _a.length; _i++) {
+                var iceServer = _a[_i];
+                var rtcIceServer = {
+                    urls: [iceServer.url]
+                };
+                logger.log("STUN/TURN server IP: " + iceServer.url);
+                if (iceServer.username != null && iceServer.credential != null) {
+                    rtcIceServer.username = iceServer.username;
+                    rtcIceServer.credential = iceServer.credential;
+                    logger.log('TURN credentials [' + iceServer.username + ':' + iceServer.credential + ']');
+                }
+                this.openvidu.iceServers.push(rtcIceServer);
+            }
+        }
+        else if (opts.coturnIp != null && opts.coturnPort != null && opts.turnUsername != null && opts.turnCredential != null) {
             var turnUrl1 = 'turn:' + opts.coturnIp + ':' + opts.coturnPort;
             this.openvidu.iceServers = [
                 { urls: [turnUrl1], username: opts.turnUsername, credential: opts.turnCredential }
@@ -1454,6 +1447,7 @@ var Session = /** @class */ (function (_super) {
         this.openvidu.role = opts.role;
         this.openvidu.finalUserId = opts.finalUserId;
         this.openvidu.mediaServer = opts.mediaServer;
+        this.openvidu.videoSimulcast = opts.videoSimulcast;
         this.capabilities = {
             subscribe: true,
             publish: this.openvidu.role !== 'SUBSCRIBER',
@@ -1464,10 +1458,15 @@ var Session = /** @class */ (function (_super) {
         if (opts.life != null) {
             this.openvidu.life = opts.life;
         }
-        if (opts.version !== this.openvidu.libraryVersion) {
-            logger.warn('OpenVidu Server (' + opts.version +
-                ') and OpenVidu Browser (' + this.openvidu.libraryVersion +
-                ') versions do NOT match. There may be incompatibilities');
+        var minorDifference = semverMinor(opts.version) - semverMinor(this.openvidu.libraryVersion);
+        if ((semverMajor(opts.version) !== semverMajor(this.openvidu.libraryVersion)) || !(minorDifference == 0 || minorDifference == 1)) {
+            logger.error("openvidu-browser (".concat(this.openvidu.libraryVersion, ") and openvidu-server (").concat(opts.version, ") versions are incompatible. ")
+                + 'Errors are likely to occur. openvidu-browser SDK is only compatible with the same version or the immediately following minor version of an OpenVidu deployment');
+        }
+        else if (minorDifference == 1) {
+            logger.warn("openvidu-browser version ".concat(this.openvidu.libraryVersion, " does not match openvidu-server version ").concat(opts.version, ". ")
+                + "These versions are still compatible with each other, but openvidu-browser version must be updated as soon as possible to ".concat(semverMajor(opts.version), ".").concat(semverMinor(opts.version), ".x. ")
+                + "This client using openvidu-browser ".concat(this.openvidu.libraryVersion, " will become incompatible with the next release of openvidu-server"));
         }
     };
     return Session;