REGRESSION(266293@main): media/audioSession/audioSessionState.html is…

… a flaky failure

https://bugs.webkit.org/show_bug.cgi?id=259524
rdar://112914519

Reviewed by Jean-Yves Avenard.

The flakiness was due to the following steps:
1. With internals, we simulate beginning an interruption from WebProcess, which is sent to GPU process, which does the interuption business.
2. This triggers notification to the WebProcess that the AudioSession state changed. DOMAudioSession schedules a task to check this and fires an event if needed.
3. Very close to simulating the beginning of the interruption, the WebProcess also tries to activate its audio session. On GPUProcess side, this succeeeds, which triggers ending the interruption.
4. The WebProcess is then notified and DOMAudioSession quickly schedules a task to check this and fires an event as needed.
5. In case the WebProcess beginning and end of interruptions are very close, the first DOMAudioSession task will not see a change of the DOMAudioSession state and will quit early without firing an event.

To prevent the flakiness, we enforce RemoteAudioSession::tryToSetActiveInternal to fail when we are in a test interruption and active is true, like would happen in case of a phone call interruption.

* LayoutTests/platform/mac/TestExpectations:
* Source/WebCore/testing/Internals.cpp:
(WebCore::Internals::resetToConsistentState):
* Source/WebKit/WebProcess/GPU/media/RemoteAudioSession.cpp:
(WebKit::RemoteAudioSession::tryToSetActiveInternal):
(WebKit::RemoteAudioSession::endAudioSessionInterruption):
(WebKit::RemoteAudioSession::beginInterruptionForTesting):
(WebKit::RemoteAudioSession::endInterruptionForTesting):
* Source/WebKit/WebProcess/GPU/media/RemoteAudioSession.h:

Canonical link: https://commits.webkit.org/267683@main

LayoutTests/platform/mac/TestExpectations

@@ -2733,8 +2733,6 @@ webkit.org/b/259712 [ Monterey+ ] media/media-source/media-source-paint-after-di
 
 webkit.org/b/259489 [ Monterey+ ] http/tests/media/hls/track-in-band-multiple-cues.html [ Pass Failure ]
 
-webkit.org/b/259524 [ Monterey+ ] media/audioSession/audioSessionState.html [ Pass Failure ]
-
 # rdar://110876540 ASSERTION FAILED: firstChild(): [ macOS ] (258183)
 [ Debug ] media/modern-media-controls/tracks-support/text-track-selected-via-media-api.html [ Pass Crash ]
 

Source/WebCore/testing/Internals.cpp

@@ -672,6 +672,7 @@ void Internals::resetToConsistentState(Page& page)
 #if USE(AUDIO_SESSION)
     AudioSession::sharedSession().setCategoryOverride(AudioSessionCategory::None);
     AudioSession::sharedSession().tryToSetActive(false);
+    AudioSession::sharedSession().endInterruptionForTesting();
 #endif
 }
 

Source/WebKit/WebProcess/GPU/media/RemoteAudioSession.cpp

@@ -119,6 +119,9 @@ void RemoteAudioSession::setPreferredBufferSize(size_t size)
 
 bool RemoteAudioSession::tryToSetActiveInternal(bool active)
 {
+    if (active && m_isInterruptedForTesting)
+        return false;
+
     auto sendResult = ensureConnection().sendSync(Messages::RemoteAudioSessionProxy::TryToSetActive(active), { });
     auto [succeeded] = sendResult.takeReplyOr(false);
     if (succeeded)
@@ -201,11 +204,16 @@ void RemoteAudioSession::endAudioSessionInterruption(MayResume mayResume)
 
 void RemoteAudioSession::beginInterruptionForTesting()
 {
+    m_isInterruptedForTesting = true;
     ensureConnection().send(Messages::RemoteAudioSessionProxy::TriggerBeginInterruptionForTesting(), { });
 }
 
 void RemoteAudioSession::endInterruptionForTesting()
 {
+    if (!m_isInterruptedForTesting)
+        return;
+
+    m_isInterruptedForTesting = false;
     ensureConnection().send(Messages::RemoteAudioSessionProxy::TriggerEndInterruptionForTesting(), { });
 }
 

Source/WebKit/WebProcess/GPU/media/RemoteAudioSession.h

@@ -118,6 +118,7 @@ class RemoteAudioSession final
     bool m_isPlayingToBluetoothOverrideChanged { false };
     std::optional<RemoteAudioSessionConfiguration> m_configuration;
     ThreadSafeWeakPtr<GPUProcessConnection> m_gpuProcessConnection;
+    bool m_isInterruptedForTesting { false };
 };
 
 }