Merge pull request #1839 from twilio/2.22.2_prep

2.22.2 prep

Author: charliesantos

CHANGELOG.md

@@ -2,6 +2,19 @@ The Twilio Programmable Video SDKs use [Semantic Versioning](http://www.semver.o
 
 **Version 1.x reached End of Life on September 8th, 2021.** See the changelog entry [here](https://www.twilio.com/changelog/end-of-life-complete-for-unsupported-versions-of-the-programmable-video-sdk). Support for the 1.x version ended on December 4th, 2020.
 
+2.22.2 (July 25, 2022)
+======================
+
+Changes
+-------
+
+- `isSupported` flag now returns `false` if the browser does not support the Unified Plan SDP format. (VIDEO-10307)
+  
+  The following is a list of browsers with Unified Plan as the default SDP format.
+  - Chrome 72+
+  - Safari 12.1+
+  - Firefox 38+
+
 2.22.1 (July 11, 2022)
 ======================
 
@@ -85,7 +98,7 @@ Bug Fixes
 Bug Fixes
 ---------
 
-- Fixed an issue where some extraneous errors were logged to console when a video track was stopped. (VIDEO-9511)
+- Fixed an issue where publishing a video track sometimes caused a failure with "Unhandled exception: Client is unable to create or apply a local media description". (VIDEO-9511)
 - Fixed an issue where the `dimensionsChanged` event was not firing when the track dimensions first became available. (VIDEO-3576)
 - Removed references to node dependencies that causes build errors on Angular and Vue. (VIDEO-9282)
 - Fixed an issue where incorrect device was detected when using iPad in Desktop Website mode. (VIDEO-8282)

README.md

@@ -74,7 +74,7 @@ Releases of twilio-video.js are hosted on a CDN, and you can include these
 directly in your web app using a <script> tag.
 
 ```html
-<script src="//sdk.twilio.com/js/video/releases/2.22.1/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.22.2/twilio-video.min.js"></script>
 
 ```
 

lib/util/support.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const { guessBrowser, support: isWebRTCSupported } = require('../webrtc/util');
+const { getSdpFormat } = require('../webrtc/util/sdp');
 const { isAndroid, isMobile, isNonChromiumEdge, rebrandedChromeBrowser, mobileWebKitBrowser } = require('./browserdetection');
 
 const SUPPORTED_CHROME_BASED_BROWSERS = [
@@ -41,6 +42,7 @@ function isSupported() {
 
   return !!browser
     && isWebRTCSupported()
+    && getSdpFormat() === 'unified'
     && (!rebrandedChrome || SUPPORTED_CHROME_BASED_BROWSERS.includes(rebrandedChrome))
     && !isNonChromiumEdge(browser)
     && (!mobileWebKit || SUPPORTED_MOBILE_WEBKIT_BASED_BROWSERS.includes(mobileWebKit))

lib/webrtc/util/sdp.js

@@ -35,6 +35,13 @@ function checkIfSdpSemanticsIsSupported() {
 // instantiation of more than one RTCPeerConnection.
 var chromeSdpFormat = null;
 
+/**
+ * Clear cached Chrome's SDP format
+ */
+function clearChromeCachedSdpFormat() {
+  chromeSdpFormat = null;
+}
+
 /**
  * Get Chrome's default SDP format.
  * @returns {'planb'|'unified'}
@@ -43,12 +50,14 @@ function getChromeDefaultSdpFormat() {
   if (!chromeSdpFormat) {
     if (typeof RTCPeerConnection !== 'undefined'
       && 'addTransceiver' in RTCPeerConnection.prototype) {
+      const pc = new RTCPeerConnection();
       try {
-        new RTCPeerConnection().addTransceiver('audio');
+        pc.addTransceiver('audio');
         chromeSdpFormat = 'unified';
       } catch (e) {
         chromeSdpFormat = 'planb';
       }
+      pc.close();
     } else {
       chromeSdpFormat = 'planb';
     }
@@ -299,6 +308,7 @@ function updateUnifiedPlanTrackIdsToSSRCs(trackIdsToSSRCs, sdp) {
   return updateTrackIdsToSSRCs(getUnifiedPlanTrackIdsToSSRCs, trackIdsToSSRCs, sdp);
 }
 
+exports.clearChromeCachedSdpFormat = clearChromeCachedSdpFormat;
 exports.getSdpFormat = getSdpFormat;
 exports.getMediaSections = getMediaSections;
 exports.getPlanBTrackIds = getPlanBTrackIds;

test/lib/mockwebrtc.js

@@ -105,6 +105,15 @@ class RTCSessionDescription {
   }
 }
 
+class RTCRtpTransceiver {
+  constructor() {
+
+  }
+  get currentDirection() {
+    return 'foo';
+  }
+}
+
 class RTCPeerConnection extends EventEmitter {
   constructor() {
     super();
@@ -116,6 +125,10 @@ class RTCPeerConnection extends EventEmitter {
     this.signalingState = 'stable';
   }
 
+  addTransceiver() {
+
+  }
+
   createOffer() {
     return Promise.resolve(new RTCSessionDescription({ type: 'offer', sdp: DUMMY_SDP }));
   }
@@ -232,6 +245,7 @@ function mockWebRTC(_global) {
   _global.webkitMediaStream = MediaStream;
   _global.MediaStream = MediaStream;
   _global.RTCDataChannel = RTCDataChannel;
+  _global.RTCRtpTransceiver = RTCRtpTransceiver;
   _global.RTCPeerConnection = RTCPeerConnection;
   _global.RTCSessionDescription = RTCSessionDescription;
   _global.attachMediaStream = attachMediaStream;
@@ -250,6 +264,7 @@ module.exports.webkitMediaStream = MediaStream;
 module.exports.getUserMedia = getUserMedia;
 module.exports.navigator = navigator;
 module.exports.RTCDataChannel = RTCDataChannel;
+module.exports.RTCRtpTransceiver = RTCRtpTransceiver;
 module.exports.DUMMY_SDP = DUMMY_SDP;
 module.exports.RTCPeerConnection = RTCPeerConnection;
 module.exports.RTCSessionDescription = RTCSessionDescription;

test/unit/spec/util/support.js

@@ -2,6 +2,7 @@
 
 const assert = require('assert');
 const isSupported = require('../../../../lib/util/support');
+const { clearChromeCachedSdpFormat } = require('../../../../lib/webrtc/util/sdp');
 
 describe('isSupported', () => {
   let oldAgent;
@@ -10,6 +11,7 @@ describe('isSupported', () => {
   });
 
   afterEach(() => {
+    clearChromeCachedSdpFormat();
     navigator.userAgent = oldAgent;
     if (global.chrome) {
       delete global.chrome;
@@ -210,4 +212,64 @@ describe('isSupported', () => {
       assert.equal(isSupported(), false);
     });
   });
+
+  describe('return false when sdp format is plan-b', () => {
+    describe('and browser is chrome', () => {
+      let oldRTCPeerConnection;
+      let oldUserAgent;
+
+      beforeEach(() => {
+        oldUserAgent = navigator.userAgent;
+        navigator.userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.90 Safari/537.36';
+        oldRTCPeerConnection = global.RTCPeerConnection;
+      });
+
+      afterEach(() => {
+        navigator.userAgent = oldUserAgent;
+        global.RTCPeerConnection = oldRTCPeerConnection;
+      });
+
+      it('and RTCPeerConnection.prototype.addTransceiver is not supported', () => {
+        global.RTCPeerConnection.prototype = {};
+        assert.equal(isSupported(), false);
+      });
+
+      it('and RTCPeerConnection.prototype.addTransceiver throws an exception', () => {
+        global.RTCPeerConnection = function() {
+          this.addTransceiver = function() {
+            throw new Error();
+          };
+          this.close = function() {};
+        };
+        global.RTCPeerConnection.prototype.addTransceiver = function() {};
+        assert.equal(isSupported(), false);
+      });
+    });
+
+    describe('and browser is safari', () => {
+      let oldUserAgent;
+      let oldRTCRtpTransceiver;
+
+      beforeEach(() => {
+        oldUserAgent = navigator.userAgent;
+        navigator.userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13 Safari/605.1.15';
+        oldRTCRtpTransceiver = global.RTCRtpTransceiver;
+      });
+
+      afterEach(() => {
+        navigator.userAgent = oldUserAgent;
+        global.RTCRtpTransceiver = oldRTCRtpTransceiver;
+      });
+
+      it('and RTCRtpTransceiver is not supported', () => {
+        delete global.RTCRtpTransceiver;
+        assert.equal(isSupported(), false);
+      });
+
+      it('and RTCRtpTransceiver is supported but currentDirection is missing', () => {
+        delete global.RTCRtpTransceiver.prototype.currentDirection;
+        assert.equal(isSupported(), false);
+      });
+    });
+  });
 });