@opentok/client 2.28.3 → 2.28.4-alpha.10

package/dist/js/opentok.d.ts

@@ -597,7 +597,7 @@ declare namespace OT {
     getAudioVolume(): number;
     getImgData(): string | null;
     getStats(callback: (error?: OTError, stats?: SubscriberStats) => void): void;
-    getRtcStatsReport(): Promise<RTCStatsReport>;
+    getRtcStatsReport(): Promise<Map<string, any>>;
     subscribeToCaptions(value: boolean): Promise<void>;
     isSubscribedToCaptions(): boolean;
     isAudioBlocked(): boolean;

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.28.3 2898b53
+ * @license OpenTok.js 2.28.4 24429b3
  *
  * Copyright (c) 2010-2024 TokBox, Inc.
  * Subject to the applicable Software Development Kit (SDK) License Agreement:
  * https://www.vonage.com/legal/communications-apis/terms-of-use/
  *
- * Date: Fri, 20 Sep 2024 18:57:18 GMT
+ * Date: Thu, 24 Oct 2024 14:39:58 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -5631,8 +5631,8 @@ SDPHelpers.getIceCredentials = sdpLines => {
  * Update ice credentials in one SDP with new credentials.
  * @param {Array<string>} currentSdpLines - An array of SDP lines that need to be updated with new credentials.
  * @param {Object} iceCredentials - The iceCredentials object.
- * @property {string} ufrag - A string representing the ufrag in the ICE credentials.
- * @property {string} pwd - A string representing the password in the ICE credentials.
+ * @property {string} ufrag - A string representing the ufrag line in the ICE credentials, e.g. 'a=ice-ufrag:myUFrag'
+ * @property {string} pwd - A string representing the password line in the ICE credentials, e.g. 'a=ice-pwd:myPwd'
  * @returns {Array<string>} - An array of updated SDP lines with the new credentials.
  */
 SDPHelpers.updateIceCredentials = (currentSdpLines, credentials) => currentSdpLines.map(line => {
@@ -5648,31 +5648,51 @@ SDPHelpers.updateIceCredentials = (currentSdpLines, credentials) => currentSdpLi
  * Add ice credentials in the media section.
  * @param {Array<string>} mediaSection - An array of SDP lines that need to be updated with credentials.
  * @param {Object} iceCredentials - The iceCredentials object.
- * @property {string} ufrag - A string representing the ufrag in the ICE credentials.
- * @property {string} pwd - A string representing the password in the ICE credentials.
+ * @property {string} ufrag - A string representing the ufrag line in the ICE credentials, e.g. 'a=ice-ufrag:myUFrag'
+ * @property {string} pwd - A string representing the password line in the ICE credentials, e.g. 'a=ice-pwd:myPwd'
  * @returns {Array<string>} - An array of updated SDP lines with the new credentials.
  */
 SDPHelpers.addIceCredentialsToSection = (mediaSection, _ref3) => {
   let ufrag = _ref3.ufrag,
     pwd = _ref3.pwd;
   const mediaSectionWithCredentials = [...mediaSection];
+  const midPrefix = 'a=mid:';
+  const midLineIndex = mediaSectionWithCredentials.findIndex(line => line.startsWith(midPrefix));
+  if (midLineIndex >= 0) {
+    mediaSectionWithCredentials.splice(midLineIndex, 0, ufrag, pwd);
+  }
+  return mediaSectionWithCredentials;
+};
+
+/**
+ * Add ice candidates in the media section.
+ * @param {Array<string>} mediaSection - An array of SDP lines that need to be updated with candidates.
+ * @param {Array<string>} headers - An array of SDP lines with the headers
+ * @returns {Array<string>} - An array of updated SDP lines with the new candidates.
+ */
+SDPHelpers.addIceCandidatesToSection = (mediaSection, headers) => {
+  const mediaSectionWithCredentials = [...mediaSection];
   const candidatePrefix = 'a=candidate:';
-  const candidateLineIndex = mediaSectionWithCredentials.findIndex(line => line.startsWith(candidatePrefix));
-  if (candidateLineIndex >= 0) {
-    mediaSectionWithCredentials.splice(candidateLineIndex, 0, ufrag, pwd);
+  const endCandidate = 'a=end-of-candidates';
+  const candidateLines = headers.filter(line => line.startsWith(candidatePrefix) || line === endCandidate);
+  const midPrefix = 'a=mid:';
+  const midLineIndex = mediaSectionWithCredentials.findIndex(line => line.startsWith(midPrefix));
+  if (midLineIndex >= 0 && candidateLines.length) {
+    mediaSectionWithCredentials.splice(midLineIndex, 0, ...candidateLines);
   }
   return mediaSectionWithCredentials;
 };
 
 /**
- * Add ice credentials in the first media section.
- * @param {Array<string>} mediaSections - An array of SDP lines that need to be updated with credentials.
+ * Add ice config (credentials and candidates) in the first media section.
+ * @param {Array<string>} mediaSections - An array of SDP lines that need to be updated with config.
+ * @param {Array<string>} headers - An array of SDP lines with the headers.
  * @param {Object} iceCredentials - The iceCredentials object.
- * @property {string} ufrag - A string representing the ufrag in the ICE credentials.
- * @property {string} pwd - A string representing the password in the ICECredentials.
- * @returns {Array<string>} - An array of updated SDP lines with the new credentials.
+ * @property {string} ufrag - A string representing the ufrag line in the ICE credentials, e.g. 'a=ice-ufrag:myUFrag'
+ * @property {string} pwd - A string representing the password line in the ICE credentials, e.g. 'a=ice-pwd:myPwd'
+ * @returns {Array<string>} - An array of updated SDP lines with the new config.
  */
-SDPHelpers.addIceCredentials = (mediaSections, iceCredentials) => {
+SDPHelpers.addIceConfig = (mediaSections, headers, iceCredentials) => {
   const mediaSectionsWithCredentials = [...mediaSections];
   const firstSection = mediaSections[0];
   const _SDPHelpers$getIceCre = SDPHelpers.getIceCredentials(firstSection),
@@ -5680,7 +5700,7 @@ SDPHelpers.addIceCredentials = (mediaSections, iceCredentials) => {
   // If there are no credentials in the first media section, we need to add them
   if (!ufrag) {
     const sectionWithIceCredentials = SDPHelpers.addIceCredentialsToSection(firstSection, iceCredentials);
-    mediaSectionsWithCredentials[0] = sectionWithIceCredentials;
+    mediaSectionsWithCredentials[0] = SDPHelpers.addIceCandidatesToSection(sectionWithIceCredentials, headers);
   }
   return mediaSectionsWithCredentials;
 };
@@ -5699,6 +5719,11 @@ SDPHelpers.addIceCredentials = (mediaSections, iceCredentials) => {
  * @returns {Array<string>} - An array of updated headers lines.
  */
 SDPHelpers.updateHeadersInPartialSdp = (currentSdp, partialSdp, tracks) => {
+  if (!currentSdp.headers.length) {
+    // If there is no currentSdp, we don't need to update the headers, we just make sure we don't
+    // have more tracks in the bundle than it should.
+    return SDPHelpers.updateBundleLine(partialSdp.headers, tracks);
+  }
   // Update headers with the new bundle line.
   let headers = SDPHelpers.updateBundleLine(currentSdp.headers, tracks);
   // Update headers with the new version.
@@ -8045,7 +8070,7 @@ const logging = (0, _log.default)('StaticConfig');
 */
 
 /** @type builtInConfig */
-const builtInConfig = (0, _cloneDeep.default)({"version":"v2.28.3","buildHash":"2898b53","minimumVersion":{"firefox":52,"chrome":49},"debug":false,"websiteURL":"http://www.tokbox.com","configURL":"https://config.opentok.com","ipWhitelistConfigURL":"","cdnURL":"","loggingURL":"https://hlg.tokbox.com/prod","apiURL":"https://anvil.opentok.com"});
+const builtInConfig = (0, _cloneDeep.default)({"version":"v2.28.4","buildHash":"24429b3","minimumVersion":{"firefox":52,"chrome":49},"debug":false,"websiteURL":"http://www.tokbox.com","configURL":"https://config.opentok.com","ipWhitelistConfigURL":"","cdnURL":"","loggingURL":"https://hlg.tokbox.com/prod","apiURL":"https://anvil.opentok.com"});
 const whitelistAllowedRuntimeProperties = (0, _pick.default)(['apiURL', 'assetURL', 'cdnURL', 'sessionInfoOverrides', 'loggingURL']);
 const liveConfigMap = {
   apiUrl: 'apiURL',
@@ -18569,6 +18594,9 @@ function PublisherFactory(_ref) {
             } else {
               logging.warn(`Track with invalid kind has ended: ${track.kind}`);
             }
+            logAnalyticsEvent('mediaStopped', 'Event', {
+              kind
+            });
             return;
           }
           if (this.session) {
@@ -32422,7 +32450,11 @@ function PublisherPeerConnectionFactory(deps) {
           if (_cancelWatchAudioAcquisition) {
             _cancelWatchAudioAcquisition();
           }
-          _cancelWatchAudioAcquisition = watchAudioAcquisition(callback => _peerConnection.getStats(null, callback), () => this.trigger('audioAcquisitionProblem'));
+          _cancelWatchAudioAcquisition = watchAudioAcquisition(callback => _peerConnection.getStats(null, callback), () => {
+            if (_peerConnection.iceConnectionStateIsConnected()) {
+              this.trigger('audioAcquisitionProblem');
+            }
+          });
         }
         this.trigger('connected');
       }
@@ -32985,6 +33017,7 @@ var _watchSubscriberAudio = _interopRequireDefault(__webpack_require__(683));
 // @todo enable the following disabled rules see OPENTOK-31136 for more info
 /* eslint-disable global-require, no-param-reassign, no-void, no-shadow */
 /* eslint-disable func-names */
+/* global RTCStatsReport */
 
 function SubscriberPeerConnectionFactory(deps) {
   if (deps === void 0) {
@@ -33180,7 +33213,14 @@ function SubscriberPeerConnectionFactory(deps) {
     };
     this.getRtcStatsReport = function (callback) {
       if (_peerConnection) {
-        _peerConnection.getRtcStatsReport(null, callback);
+        _peerConnection.getRtcStatsReport(null, (error, stats) => {
+          if (stats instanceof RTCStatsReport || Object.getPrototypeOf(stats).toString().includes('RTCStatsReport')) {
+            // Convert RTCStatsReport to Map for consistency with SPC
+            callback(error, new Map([...stats]));
+          } else {
+            callback(error, stats);
+          }
+        });
       } else {
         const errorCode = ExceptionCodes.PEER_CONNECTION_NOT_CONNECTED;
         callback(new OTHelpers.Error(OTErrorClass.getTitleByCode(errorCode), Errors.PEER_CONNECTION_NOT_CONNECTED, {
@@ -36506,6 +36546,9 @@ function SubscriberFactory(_ref2) {
       },
       get isSubscribingToVideo() {
         return _properties.subscribeToVideo;
+      },
+      getActiveSourceStreamId() {
+        return _activeSourceStreamId;
       }
     };
     this._onSenderStatsReceived = content => {
@@ -66088,6 +66131,9 @@ function SessionFactory(deps) {
       isE2ee() {
         return _session.sessionInfo.e2ee && _e2eeSecretSet && !!_session.capabilities.supportsE2ee;
       },
+      isSpc() {
+        return _useSinglePeerConnection;
+      },
       isSocketReconnecting() {
         return _isSocketReconnecting;
       },
@@ -92412,8 +92458,8 @@ exports.default = watchAudioAcquisition;
  * Installs a watcher that will calls the given callback if the audio acquisition seems to not
  * work porperly.
  *
- * It waits 3 seconds and poll getStats to find any sign of audio bytes sent. If it can't find any
- * it signals the anomaly by executing the given function.
+ * It runs every 3 seconds and poll getStats to find any sign of audio bytes sent. If it can't find
+ * any it signals the anomaly by executing the given function.
  *
  * @param {function(cb: function(DOMError, Array<RTCStats>))} getStats
  *    the function to call to get the stats
@@ -92421,24 +92467,45 @@ exports.default = watchAudioAcquisition;
  * @returns {function} cancel the watch
  */
 function watchAudioAcquisition(getStats, warningCb) {
-  // detection of Chrome failure to acquire audio
-  // inspired by https://medium.com/the-making-of-appear-in/working-around-webrtc-bugs-d4f6fdb763f
-  const to = setTimeout(() => {
-    getStats((error, stats) => {
-      if (error) {
-        return;
-      }
-      for (let idxStats = 0; idxStats < stats.length; idxStats += 1) {
-        const rtcStats = stats[idxStats];
-        if (rtcStats.id.indexOf('_send') !== -1 && rtcStats.type === 'ssrc' && (rtcStats.kind === 'audio' || rtcStats.mediaType === 'audio') && parseInt(rtcStats.bytesSent, 10) === 0) {
-          // abnormal condition detected
+  let previousBytesSent = 0;
+  let isCallbackNeeded = true;
+  const isAudioStat = rtcStats => rtcStats.type === 'outbound-rtp' && rtcStats.ssrc && (rtcStats.kind === 'audio' || rtcStats.mediaType === 'audio');
+  const isAnomalyDetected = currentBytesSent => currentBytesSent === previousBytesSent && isCallbackNeeded;
+  const isAnomalyResolved = currentBytesSent => currentBytesSent !== previousBytesSent;
+  const handleStats = (error, stats) => {
+    if (error) return;
+    stats.forEach(rtcStats => {
+      if (isAudioStat(rtcStats)) {
+        const statType = typeof rtcStats.bytesSent;
+        let currentBytesSent;
+        // Number.MAX_SAFE_INTEGER is a 16 digit number, but it is only 53 bits. We manually modulo
+        // 15 digits to avoid big number problems.
+        const maxDigit = 15;
+        if (statType === 'number') {
+          currentBytesSent = rtcStats.bytesSent % Math.pow(10, maxDigit);
+        } else if (statType === 'string') {
+          const safeIntegerBytesSent = rtcStats.bytesSent.slice(rtcStats.bytesSent.length - maxDigit);
+          currentBytesSent = parseInt(safeIntegerBytesSent, 10);
+        } else {
+          return;
+        }
+        if (isAnomalyDetected(currentBytesSent)) {
           warningCb();
+          // Execute the callback only once per audio loss
+          isCallbackNeeded = false;
+        } else if (isAnomalyResolved(currentBytesSent)) {
+          // Once resolved, we may need to use the callback in future audio loss
+          isCallbackNeeded = true;
         }
+        previousBytesSent = currentBytesSent;
       }
     });
+  };
+  const audioMonitor = setInterval(() => {
+    getStats(handleStats);
   }, 3000);
   return function cancel() {
-    clearTimeout(to);
+    clearInterval(audioMonitor);
   };
 }
 
@@ -92708,17 +92775,18 @@ const collectGetStatsHelper = (peerConnection, tracks, callback) => {
 };
 exports.collectGetStatsHelper = collectGetStatsHelper;
 const collectRtcStatsReportHelper = (peerConnection, tracks, callback) => {
-  // getRtcStatsReport uses an Object for the collected stats.
-  const merge = function merge(previous, stats) {
+  // getRtcStatsReport uses an RTCStatsReport object that cannot be merged
+  // so we convert it to a Map
+  const mapMerge = function mapMerge(previous, stats) {
     if (previous === void 0) {
-      previous = {};
+      previous = new Map();
     }
-    return Object.assign({}, previous, stats);
+    return new Map([...previous, ...stats]);
   };
   collectStatsHelper({
     tracks,
     getStats: (track, completion) => peerConnection.getRtcStatsReport(track, completion),
-    merge
+    merge: mapMerge
   }, callback);
 };
 exports.collectRtcStatsReportHelper = collectRtcStatsReportHelper;
@@ -104448,6 +104516,7 @@ const createGetFullRemoteSdp = function createGetFullRemoteSdp(deps) {
   const getMediaSectionsForOffer = deps.getMediaSectionsForOffer || _getMediaSectionsForOffer.default;
   const getFullSdpFromPartial = (type, partialSdp, currentSdp) => {
     const isAnswer = type === 'answer';
+    const version = Math.max(partialSdp.version, currentSdp.version || 0);
     const getMediaSections = isAnswer ? getMediaSectionsForAnswer : getMediaSectionsForOffer;
     const mediaSections = getMediaSections(partialSdp, currentSdp);
     const mids = mediaSections.map(_sdp_helpers.default.getSectionMid);
@@ -104462,7 +104531,7 @@ const createGetFullRemoteSdp = function createGetFullRemoteSdp(deps) {
     }
     return {
       headers,
-      version: partialSdp.version,
+      version,
       bundle: _sdp_helpers.default.createBundleLine(tracks),
       tracks,
       mediaSections,
@@ -104471,8 +104540,10 @@ const createGetFullRemoteSdp = function createGetFullRemoteSdp(deps) {
     };
   };
   const getFullRemoteSdp = (type, newRemoteSdp, currentRemoteSdp) => {
-    if (!isPartialSdp(newRemoteSdp)) {
-      // This is a full SDP
+    if (!isPartialSdp(newRemoteSdp) && !currentRemoteSdp.bundle) {
+      // This is a full SDP and it is the first received. When a full SDP comes after several SDP,
+      // we don't return it since we want to merge the cached SDP and this full one. This can
+      // happen, e.g., when SDPs come out of order.
       return newRemoteSdp;
     }
     logging.debug('partial remote sdp: ', newRemoteSdp);
@@ -104483,9 +104554,10 @@ const createGetFullRemoteSdp = function createGetFullRemoteSdp(deps) {
       // This is a partial SDP, however it is the first one we have received (none cached yet), we
       // may need to add ICE credentials to the first enabled section.
       const mediaSections = newRemoteSdp.mediaSections,
-        iceCredentials = newRemoteSdp.iceCredentials;
+        iceCredentials = newRemoteSdp.iceCredentials,
+        headers = newRemoteSdp.headers;
       partialSdp = Object.assign({}, newRemoteSdp, {
-        mediaSections: _sdp_helpers.default.addIceCredentials(mediaSections, iceCredentials)
+        mediaSections: _sdp_helpers.default.addIceConfig(mediaSections, headers, iceCredentials)
       });
     }
     return getFullSdpFromPartial(type, partialSdp, currentRemoteSdp);