From d61ba41f34e9122d20137d232642cd16f9b84322 Mon Sep 17 00:00:00 2001
From: Jan-Ivar Bruaroey <jib@mozilla.com>
Date: Tue, 29 Apr 2025 17:54:12 +0000
Subject: [PATCH] Bug 1958963 Expose all speaker devices, irrespective of
 groupId, upon microphone access. r=karlt

Relaxes exposure criteria for speakers in the navigator.mediaDevices.enumerateDevices() API,
to match the recent spec change in w3c/mediacapture-output#150 and other implementations for
web compatibility.

The old behavior was to only expose speakers whose groupId is the same as that of any microphone,
once the document is using a microphone.

The new behavior is to expose all speakers once the document is using a microphone.

The old behavior is retained for RFPTarget::MediaDevices, to avoid any new exposure there.

Also fixes an assumption in WPT test
MediaDevices-enumerateDevices-per-origin-ids.sub.https.html broken by this patch
about the total number of devices exposed after gUM in an iframe vs the top frame.

Differential Revision: https://phabricator.services.mozilla.com/D246001
---
 dom/media/MediaDevices.cpp                    |  9 ++--
 .../mochitests/testLegacyEnumerateDevices.js  |  1 +
 .../mochitests/test_enumerateDevices.html     |  1 +
 .../test_fingerprinting_resistance.html       | 32 +++++++-------
 .../webrtc/tests/mochitests/test_groupId.html |  1 -
 ...ocontext-sinkid-constructor.https.html.ini | 25 +++++++++++
 ...diocontext-sinkid-setsinkid.https.html.ini | 42 +++++++++++++++----
 ...context-sinkid-state-change.https.html.ini | 11 ++++-
 .../tests/audio-output/setSinkId.https.html   |  6 ---
 ...erateDevices-per-origin-ids.sub.https.html |  4 +-
 10 files changed, 96 insertions(+), 36 deletions(-)

diff --git a/dom/media/MediaDevices.cpp b/dom/media/MediaDevices.cpp
index 067094cb6b70..165fa69da767 100644
--- a/dom/media/MediaDevices.cpp
+++ b/dom/media/MediaDevices.cpp
@@ -264,7 +264,8 @@ RefPtr<MediaDeviceSetRefCnt> MediaDevices::FilterExposedDevices(
   bool dropSpeakers =
       !Preferences::GetBool("media.setsinkid.enabled") ||
       !FeaturePolicyUtils::IsFeatureAllowed(doc, u"speaker-selection"_ns);
-
+  bool shouldResistFingerprinting =
+      window->AsGlobal()->ShouldResistFingerprinting(RFPTarget::MediaDevices);
   bool legacy = IsLegacyMode(window);
   bool outputIsDefault = true;  // First output is the default.
   bool haveDefaultOutput = false;
@@ -293,8 +294,10 @@ RefPtr<MediaDeviceSetRefCnt> MediaDevices::FilterExposedDevices(
       case MediaDeviceKind::Audiooutput:
         if (dropSpeakers ||
             (!mExplicitlyGrantedAudioOutputRawIds.Contains(device->mRawID) &&
-             // Assumes aDevices order has microphones before speakers.
-             !exposedMicrophoneGroupIds.Contains(device->mRawGroupID))) {
+             (!mCanExposeMicrophoneInfo ||
+              (shouldResistFingerprinting &&
+               // Assumes aDevices order has microphones before speakers.
+               !exposedMicrophoneGroupIds.Contains(device->mRawGroupID))))) {
           outputIsDefault = false;
           continue;
         }
diff --git a/dom/media/webrtc/tests/mochitests/testLegacyEnumerateDevices.js b/dom/media/webrtc/tests/mochitests/testLegacyEnumerateDevices.js
index de51fdea6a74..3143921b8bc8 100644
--- a/dom/media/webrtc/tests/mochitests/testLegacyEnumerateDevices.js
+++ b/dom/media/webrtc/tests/mochitests/testLegacyEnumerateDevices.js
@@ -161,5 +161,6 @@ async function testLegacyEnumerateDevices() {
     ["media.video_loopback_dev", "none"]
   );
   devices = await navigator.mediaDevices.enumerateDevices();
+  devices = devices.filter(({ kind }) => kind != "audiooutput");
   is(devices.length, 0, "No devices");
 }
diff --git a/dom/media/webrtc/tests/mochitests/test_enumerateDevices.html b/dom/media/webrtc/tests/mochitests/test_enumerateDevices.html
index 48bec0006a48..617fd2c403f4 100644
--- a/dom/media/webrtc/tests/mochitests/test_enumerateDevices.html
+++ b/dom/media/webrtc/tests/mochitests/test_enumerateDevices.html
@@ -133,6 +133,7 @@ runTest(async () => {
                   ["media.audio_loopback_dev", "none"],
                   ["media.video_loopback_dev", "none"]);
   devices = await navigator.mediaDevices.enumerateDevices();
+  devices = devices.filter(({kind}) => kind != "audiooutput");
   is(devices.length, 0, "No devices");
 });
 </script>
diff --git a/dom/media/webrtc/tests/mochitests/test_fingerprinting_resistance.html b/dom/media/webrtc/tests/mochitests/test_fingerprinting_resistance.html
index 7e9cd5a21997..ebe27800697d 100644
--- a/dom/media/webrtc/tests/mochitests/test_fingerprinting_resistance.html
+++ b/dom/media/webrtc/tests/mochitests/test_fingerprinting_resistance.html
@@ -8,16 +8,20 @@
 <script>
 /* global SimpleTest SpecialPowers */
 
-async function testEnumerateDevices(expectDevices) {
-  let devices = await navigator.mediaDevices.enumerateDevices();
-  if (!expectDevices) {
-    SimpleTest.is(devices.length, 0, "testEnumerateDevices: No devices");
-    return;
+async function testEnumerateDevices(header,
+                                    expectedCameras,
+                                    expectedMicrophones,
+                                    expectedSpeakers) {
+  const devices = await navigator.mediaDevices.enumerateDevices();
+  const cams = devices.filter(({kind}) => kind == "videoinput");
+  const mics = devices.filter(({kind}) => kind == "audioinput");
+  const spkr = devices.filter(({kind}) => kind == "audiooutput");
+
+  SimpleTest.is(cams.length, expectedCameras, `${header}: cameras`);
+  SimpleTest.is(mics.length, expectedMicrophones, `${header}: microphones`);
+  if (expectedSpeakers !== undefined) {
+    SimpleTest.is(spkr.length, expectedSpeakers, `${header}: speakers`);
   }
-  let cams = devices.filter((device) => device.kind == "videoinput");
-  let mics = devices.filter((device) => device.kind == "audioinput");
-  SimpleTest.ok((cams.length == 1) && (mics.length == 1),
-                "testEnumerateDevices: a microphone and a camera");
 }
 
 async function testGetUserMedia(expectDevices) {
@@ -63,14 +67,14 @@ async function testGetUserMedia(expectDevices) {
   }
 }
 
-async function testDevices() {
+async function testPreGum() {
   await SpecialPowers.pushPrefEnv({
     set: [
       ["privacy.resistFingerprinting", true],
       ["media.navigator.streams.fake", true]
     ]
   });
-  await testEnumerateDevices(true); // should list a microphone and a camera
+  await testEnumerateDevices("testPreGum w/resist", 1, 1, 0);
   await testGetUserMedia(true); // should get audio and video streams
 }
 
@@ -84,13 +88,13 @@ async function testNoDevices() {
       ["media.video_loopback_dev", "bar"]
     ]
   });
-  await testEnumerateDevices(false); // should list nothing
+  await testEnumerateDevices("testNoDevices wo/resist", 0, 0);
   await SpecialPowers.pushPrefEnv({
     set: [
       ["privacy.resistFingerprinting", true]
     ]
   });
-  await testEnumerateDevices(true); // should list a microphone and a camera
+  await testEnumerateDevices("testNoDevices w/resist", 1, 1, 1);
   await testGetUserMedia(false); // should reject with NotAllowedError
 }
 
@@ -102,7 +106,7 @@ createHTML({
 runTest(async () => {
   // Make sure enumerateDevices and getUserMedia work when
   // privacy.resistFingerprinting is true.
-  await testDevices();
+  await testPreGum();
 
   // Test that absence of devices can't be detected.
   await testNoDevices();
diff --git a/dom/media/webrtc/tests/mochitests/test_groupId.html b/dom/media/webrtc/tests/mochitests/test_groupId.html
index f2aefe5e80c9..5911cd6bff38 100644
--- a/dom/media/webrtc/tests/mochitests/test_groupId.html
+++ b/dom/media/webrtc/tests/mochitests/test_groupId.html
@@ -10,7 +10,6 @@ createHTML({ title: "Test group id of MediaDeviceInfo", bug: "1213453" });
 
 async function getDefaultDevices() {
   const devices = await navigator.mediaDevices.enumerateDevices();
-  is(devices.length, 2, "Two fake devices found.");
 
   devices.forEach(d => isnot(d.groupId, "", "GroupId is included in every device"));
 
diff --git a/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-constructor.https.html.ini b/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-constructor.https.html.ini
index fae0c4688e02..80e9b6903788 100644
--- a/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-constructor.https.html.ini
+++ b/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-constructor.https.html.ini
@@ -1,4 +1,29 @@
 [audiocontext-sinkid-constructor.https.html]
   expected:
     if (os == "android") and fission: [ERROR, TIMEOUT]
+    if (os == "mac"): [ERROR, OK]
     ERROR
+
+  [Setting sinkId to the empty string at construction should succeed.]
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected: FAIL
+
+  [Setting sinkId with a valid device identifier at construction should succeed.]
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected: FAIL
+
+  [Setting sinkId with an AudioSinkOptions at construction should succeed.]
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected: FAIL
+
+  [Invalid sinkId argument with a wrong type should throw an appropriate exception.]
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected: FAIL
+
+  [Invalid sinkId argument with a wrong ID should dispatch an onerror event.]
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected: FAIL
+
+  [Invalid sinkId argument with a wrong type should throw an appropriate exception.]
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected: FAIL
diff --git a/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-setsinkid.https.html.ini b/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-setsinkid.https.html.ini
index f5df4b8122dc..c6e0ee79aa5a 100644
--- a/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-setsinkid.https.html.ini
+++ b/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-setsinkid.https.html.ini
@@ -1,27 +1,53 @@
 [audiocontext-sinkid-setsinkid.https.html]
   expected:
     if (os == "android") and fission: [ERROR, TIMEOUT]
+    if (os == "mac"): [ERROR, OK]
     ERROR
+
   [setSinkId() with a valid device identifier should succeeded.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [setSinkId() with the same sink ID should resolve immediately.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [setSinkId() with the same AudioSinkOptions.type value should resolve immediately.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [setSinkId() should fail with TypeError on an invalid AudioSinkOptions.type value.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [setSinkId() should fail with NotFoundError on an invalid device identifier.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [setSinkId() should fail with InvalidStateError when calling from astopped AudioContext]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [setSinkId() should fail with InvalidStateError when calling from adetached document]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [pending setSinkId() should be rejected with InvalidStateError whenAudioContext is closed]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
diff --git a/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-state-change.https.html.ini b/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-state-change.https.html.ini
index 490eed8cf156..d094b133c992 100644
--- a/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-state-change.https.html.ini
+++ b/testing/web-platform/meta/webaudio/the-audio-api/the-audiocontext-interface/audiocontext-sinkid-state-change.https.html.ini
@@ -1,9 +1,16 @@
 [audiocontext-sinkid-state-change.https.html]
   expected:
     if (os == "android") and fission: [ERROR, TIMEOUT]
+    if (os == "mac"): [ERROR, OK]
     ERROR
   [Calling setSinkId() on a suspended AudioContext should fire only sink change events.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, FAIL]
+      NOTRUN
 
   [Calling setSinkId() on a running AudioContext should fire both state and sink change events.]
-    expected: NOTRUN
+    bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1942786
+    expected:
+      if (os == "mac"): [NOTRUN, TIMEOUT]
+      NOTRUN
diff --git a/testing/web-platform/tests/audio-output/setSinkId.https.html b/testing/web-platform/tests/audio-output/setSinkId.https.html
index be65f0ac81bc..662596910ee9 100644
--- a/testing/web-platform/tests/audio-output/setSinkId.https.html
+++ b/testing/web-platform/tests/audio-output/setSinkId.https.html
@@ -26,14 +26,8 @@ promise_test(async t => {
   const list = await navigator.mediaDevices.enumerateDevices();
   assert_greater_than(list.length, 0,
                       "media device list includes at least one device");
-  const audioInputList = list.filter(({kind}) => kind == "audioinput");
   const outputDevicesList = list.filter(({kind}) => kind == "audiooutput");
-  // List of exposed microphone groupIds
-  const exposedGroupIds = new Set(audioInputList.map(device => device.groupId));
-
   for (const { deviceId, groupId } of outputDevicesList) {
-    assert_true(exposedGroupIds.has(groupId),
-                "audiooutput device groupId must match an exposed microphone");
     assert_greater_than(deviceId.length, 0, "deviceId.length");
 
     const p1 = audio.setSinkId(deviceId);
diff --git a/testing/web-platform/tests/mediacapture-streams/MediaDevices-enumerateDevices-per-origin-ids.sub.https.html b/testing/web-platform/tests/mediacapture-streams/MediaDevices-enumerateDevices-per-origin-ids.sub.https.html
index 714355f5c1c0..467cf5d50c71 100644
--- a/testing/web-platform/tests/mediacapture-streams/MediaDevices-enumerateDevices-per-origin-ids.sub.https.html
+++ b/testing/web-platform/tests/mediacapture-streams/MediaDevices-enumerateDevices-per-origin-ids.sub.https.html
@@ -9,8 +9,8 @@
 <script src=permission-helper.js></script>
 </head>
 <body>
-  <iframe allow="camera 'src';microphone 'src'" id=same src="/mediacapture-streams/iframe-enumerate.html"></iframe>
-<iframe allow="camera 'src';microphone 'src'" id=cross src="https://{{hosts[][www1]}}:{{ports[https][0]}}/mediacapture-streams/iframe-enumerate.html"></iframe>
+  <iframe allow="camera 'src';microphone 'src';speaker-selection 'src'" id=same src="/mediacapture-streams/iframe-enumerate.html"></iframe>
+<iframe allow="camera 'src';microphone 'src';speaker-selection 'src'" id=cross src="https://{{hosts[][www1]}}:{{ports[https][0]}}/mediacapture-streams/iframe-enumerate.html"></iframe>
 <script>
 
   let deviceList;