twilio-video 2.28.0 → 2.28.2

package/CHANGELOG.md

@@ -2,12 +2,29 @@ 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.28.2 (November 22, 2024)
+========================
+
+Bug Fixes
+---------
+
+- Fixed a bug in Desktop Safari 18 and all iOS browsers on iOS 18 where cloning a disabled `MediaStreamTrack` would incorrectly set the `enabled` property to `true` instead of preserving the original disabled state. This ensures track cloning behavior matches the MediaStreamTrack specification and works consistently across browsers. Bug report: https://bugs.webkit.org/show_bug.cgi?id=281758
+
+2.28.1 (October 3, 2023)
+========================
+
+Bug Fixes
+---------
+
+- Previously, a Chrome iOS 17 Participant's local audio (Krisp noise cancellation enabled) did not recover after foregrounding the browser following the playing of a YouTube video (or some other application which requires microphone permissions). We work around this by permanently disabling the Krisp noise cancellation upon foregrounding the browser. (VIDEO-13006)
+
 2.28.0 (September 14, 2023)
 ===========================
 
 Bug Fixes
 ---------
 
+- Fixed a bug where a Chrome iOS 17 Participant's local and remote media (Krisp Noise Cancellation enabled) failed to recover after interacting with a PSTN call in full-screen mode. (VIDEO-13011)
 - Fixed a bug where a Chrome iOS 17 Participant's audio with Krisp Noise Cancellation did not recover after interacting with a system popup. (VIDEO-13012)
 - Fixed a bug where a Chrome iOS 17 Participant's audio with Krisp Noise Cancellation did not recover after invoking Siri. (VIDEO-13013)
 

package/COMMON_ISSUES.md

@@ -33,6 +33,12 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 
 ### Chrome mobile
 <details>
+<summary>iOS 17: Media issues</summary>
+<p>
+  Please refer to this [GitHub Issue](https://github.com/twilio/twilio-video.js/issues/2023) for details.
+</p>
+</details>
+<details>
 <summary>Android 11: Participants are unable to connect to a room due to ICE gathering failures on certain devices</summary>
 <p>
 
@@ -93,6 +99,12 @@ transform: scaleX(-1)
 
 ### Safari mobile
 <details>
+<summary>iOS 17: Media issues</summary>
+<p>
+  Please refer to this [GitHub Issue](https://github.com/twilio/twilio-video.js/issues/2023) for details.
+</p>
+</details>
+<details>
 <summary>iOS 15: Echo issues on iOS 15 devices after attaching video tracks</summary>
 <p>
 

package/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.28.0/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.28.2/twilio-video.min.js"></script>
 ```
 
 Using this method, twilio-video.js will set a browser global:

package/dist/twilio-video.js

@@ -1,4 +1,4 @@
-/*! twilio-video.js 2.28.0
+/*! twilio-video.js 2.28.2
 
 The following license applies to all parts of this software except as
 documented below.
@@ -3044,6 +3044,8 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 var isIOS = require('../../util/browserdetection').isIOS;
+var detectSilentAudio = require('../../util/detectsilentaudio');
+var isIOSChrome = require('../../webrtc/util').isIOSChrome;
 var AudioTrack = require('./audiotrack');
 var mixinLocalMediaTrack = require('./localmediatrack');
 var LocalMediaAudioTrack = mixinLocalMediaTrack(AudioTrack);
@@ -3226,6 +3228,28 @@ var LocalAudioTrack = /** @class */ (function (_super) {
             _this._maybeRestartOnDefaultDeviceChange();
         });
     };
+    /**
+     * NOTE(mmalavalli): On iOS 17 Chrome, a LocalAudioTrack with Krisp Noise Cancellation
+     * enabled that is restarted due to foregrounding the browser is silent for as-of-yet
+     * unknown reason. We work around this by discarding the Krisp MediaStreamTrack and using
+     * the source MediaStreamTrack. (VIDEO-13006)
+     * @private
+     */
+    LocalAudioTrack.prototype._setMediaStreamTrack = function (mediaStreamTrack) {
+        var _this = this;
+        var _a = this, log = _a._log, noiseCancellation = _a.noiseCancellation;
+        var promise = _super.prototype._setMediaStreamTrack.call(this, mediaStreamTrack);
+        if (isIOSChrome() && !!noiseCancellation) {
+            log.debug('iOS Chrome detected, checking if the restarted Krisp audio is silent');
+            promise = promise.then(function () { return detectSilentAudio(_this._dummyEl); }).then(function (isSilent) {
+                log.debug("Krisp audio is " + (isSilent ? 'silent, using source audio' : 'not silent'));
+                return isSilent && noiseCancellation.disablePermanently().then(function () {
+                    return _super.prototype._setMediaStreamTrack.call(_this, noiseCancellation.sourceTrack);
+                });
+            });
+        }
+        return promise;
+    };
     /**
      * Disable the {@link LocalAudioTrack}. This is equivalent to muting the audio source.
      * @returns {this}
@@ -3345,7 +3369,7 @@ var LocalAudioTrack = /** @class */ (function (_super) {
  */
 module.exports = LocalAudioTrack;
 
-},{"../../util/browserdetection":123,"./audiotrack":14,"./localmediatrack":24}],21:[function(require,module,exports){
+},{"../../util/browserdetection":123,"../../util/detectsilentaudio":126,"../../webrtc/util":170,"./audiotrack":14,"./localmediatrack":24}],21:[function(require,module,exports){
 'use strict';
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
@@ -10934,7 +10958,14 @@ var LocalTrackPublicationSignaling = /** @class */ (function (_super) {
      */
     function LocalTrackPublicationSignaling(trackSender, name, priority) {
         var _this = this;
-        trackSender = trackSender.clone();
+        // NOTE(lrivas): Safely clone a media stream track while preserving the original
+        // enabled state. This is needed because Safari 18 incorrectly enables tracks
+        // during cloning. Bug report: https://bugs.webkit.org/show_bug.cgi?id=281758
+        var clonedTrackSender = trackSender.clone();
+        if (trackSender.kind !== 'data') {
+            clonedTrackSender.track.enabled = trackSender.track.enabled;
+        }
+        trackSender = clonedTrackSender;
         var enabled = trackSender.kind === 'data' ? true : trackSender.track.enabled;
         _this = _super.call(this, name, trackSender.kind, enabled, priority) || this;
         _this.setTrackTransceiver(trackSender);
@@ -30151,7 +30182,7 @@ module.exports={
   "name": "twilio-video",
   "title": "Twilio Video",
   "description": "Twilio Video JavaScript Library",
-  "version": "2.28.0",
+  "version": "2.28.2",
   "homepage": "https://twilio.com",
   "author": "Mark Andrus Roberts <mroberts@twilio.com>",
   "contributors": [
@@ -30223,6 +30254,7 @@ module.exports={
     "node-http-server": "^8.1.2",
     "npm-run-all": "^4.0.2",
     "nyc": "^15.1.0",
+    "regex-replace": "^2.3.1",
     "requirejs": "^2.3.3",
     "rimraf": "^2.6.1",
     "simple-git": "^1.126.0",
@@ -30248,6 +30280,7 @@ module.exports={
     "lint:js": "eslint ./lib ./test/*.js ./docker/**/*.js ./test/framework/*.js ./test/lib/*.js ./test/integration/** ./test/unit/** ",
     "lint:ts": "eslint ./tsdef/*.ts ./lib/**/*.ts",
     "lint": "npm-run-all lint:js lint:ts",
+    "patch-linkifyit-111": "regex-replace \"readonly linkify: LinkifyIt.LinkifyIt;\" \"readonly linkify: typeof LinkifyIt;\" \"node_modules/@types/markdown-it/lib/index.d.ts\" --filecontents",
     "printVersion": "node --version && npm --version",
     "test:unit": "npm-run-all printVersion build:es5 && nyc --report-dir=./coverage --include=lib/**/* --reporter=html --reporter=lcov --reporter=text mocha -r ts-node/register ./test/unit/*",
     "test:unit:quick": "nyc --report-dir=./coverage --include=lib/**/* --reporter=html --reporter=lcov mocha -r ts-node/register",
@@ -30286,7 +30319,7 @@ module.exports={
     "test:framework:install": "npm install chromedriver && npm install selenium-webdriver && npm install geckodriver && npm install puppeteer",
     "test:framework": "npm-run-all test:framework:install test:framework:no-framework test:framework:react",
     "test": "npm-run-all test:unit test:integration",
-    "build:es5": "rimraf ./es5 && mkdir -p es5 && tsc tsdef/twilio-video-tests.ts --noEmit --lib es2018,dom && tsc",
+    "build:es5": "rimraf ./es5 && mkdir -p es5 && npm run patch-linkifyit-111 && tsc tsdef/twilio-video-tests.ts --noEmit --lib es2018,dom && tsc",
     "build:js": "node ./scripts/build.js ./src/twilio-video.js ./LICENSE.md ./dist/twilio-video.js",
     "build:min.js": "uglifyjs ./dist/twilio-video.js -o ./dist/twilio-video.min.js --comments \"/^! twilio-video.js/\" -b beautify=false,ascii_only=true",
     "build": "npm-run-all clean lint docs test:unit test:integration build:es5 build:js build:min.js test:umd",