feat: listen for navigator permissions changes

twilio · Aug 1, 2024 · 437cad3 · 437cad3
1 parent bf1f508
commit 437cad3
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 1 deletion.
diff --git a/lib/twilio/audiohelper.ts b/lib/twilio/audiohelper.ts
@@ -275,6 +275,15 @@ class AudioHelper extends EventEmitter {
     if (isEnumerationSupported) {
       this._initializeEnumeration();
     }
+    navigator.permissions.query({ name: 'microphone' as PermissionName }).then((microphonePermissionStatus) => {
+      if (microphonePermissionStatus.state !== 'granted') {
+        const handleStateChange = () => {
+          this._updateAvailableDevices();
+          microphonePermissionStatus.removeEventListener('change', this._updateAvailableDevices);
+        }
+        microphonePermissionStatus.addEventListener('change', handleStateChange);
+      }
+    });  
   }
 
   /**

diff --git a/tests/audiohelper.js b/tests/audiohelper.js
@@ -7,6 +7,19 @@ function getUserMedia() {
   return Promise.resolve({ id: 'default', getTracks: () => [] });
 }
 
+const defaultNavigator = {
+  permissions: {
+    query: function() {
+      return Promise.resolve('prompt');
+    }
+  },
+  mediaDevices: {
+    enumerateDevices: function(){
+      return Promise.resolve([]);
+    }
+  }
+};
+
 describe('AudioHelper', () => {
   context('when enumerateDevices is not supported', () => {
     const noop = () => {};
@@ -34,7 +47,7 @@ describe('AudioHelper', () => {
         ? navigator
         : undefined;
       HTMLAudioElement = undefined;
-      navigator = { };
+      navigator = defaultNavigator;
     });
 
     after(() => {
@@ -68,6 +81,8 @@ describe('AudioHelper', () => {
     let availableDevices;
     let handlers;
     let mediaDevices;
+    let oldHTMLAudioElement;
+    let oldNavigator;
 
     beforeEach(() => {
       eventObserver = new AudioProcessorEventObserver();
@@ -100,6 +115,23 @@ describe('AudioHelper', () => {
       });
     });
 
+    before(() => {
+      oldHTMLAudioElement = typeof HTMLAudioElement !== 'undefined'
+        ? HTMLAudioElement
+        : undefined;
+      oldNavigator = typeof navigator !== 'undefined'
+        ? navigator
+        : undefined;
+      HTMLAudioElement = undefined;
+      navigator = defaultNavigator
+    });
+
+    after(() => {
+      HTMLAudioElement = oldHTMLAudioElement;
+      navigator = oldNavigator;
+    });
+
+
     describe('constructor', () => {
       it('should set .isOutputSelectionSupported to true', () => {
         assert.equal(audio.isOutputSelectionSupported, true);
@@ -124,6 +156,24 @@ describe('AudioHelper', () => {
       });
     });
 
+    describe('navigator.permissions', () => {
+      it('should listen for microphone state changes', () => {
+        let onChangeHandler = sinon.stub();
+        let microphonePermissionStatus = {
+          state: 'prompt',
+          addEventListener: (eventName, listener) => {
+            if (eventName === 'change') {
+              listener()
+            }
+          }
+        };
+        navigator.permissions.query = () => Promise.resolve(microphonePermissionStatus);
+        audio = new AudioHelper(onActiveOutputsChanged, onActiveInputChanged, {});
+        microphonePermissionStatus.addEventListener('change', onChangeHandler);
+        sinon.assert.calledOnce(onChangeHandler);
+      })
+    })
+
     describe('._destroy', () => {
       it('should properly dispose the audio instance', () => {
         audio._stopDefaultInputDeviceStream = sinon.stub();

diff --git a/tests/index.ts b/tests/index.ts
@@ -73,6 +73,11 @@ root.navigator = {
   },
   platform: 'platform',
   userAgent: 'userAgent',
+  permissions: {
+    query: function() {
+      return Promise.resolve('prompt');
+    }
+  }
 };
 
 root.RTCPeerConnection = root.window.RTCPeerConnection = function() { };