REGRESSION(291435@main...291445@main): [iOS Debug] TestWebKitAPI.IndexedDB.IndexedDBSuspendImminently is a failure/timeout (flaky in EWS)

[achristensen07]

a899e6f

REGRESSION(291435@main...291445@main): [iOS Debug] TestWebKitAPI.IndexedDB.IndexedDBSuspendImminently is a failure/timeout (flaky in EWS)
https://bugs.webkit.org/show_bug.cgi?id=290203
rdar://147599411

Reviewed by Sihui Liu.

TestWebKitAPI::Util::run doesn't necessarily stop everything when the condition becomes true.
There is a chance that more work can be done before it returns.
When multiple messages are awaited, sometimes we'll wait for the first one and the first
and second one are received before TestWebKitAPI::Util::run returns, then when we try to wait
for the second one, no more messages come.  I introduce TestScriptMessageHandler with a Deque
to make it more robust.  If it has already received a message, it just returns it immediately.
If it receives too many messages, it'll hang on to them until later.
A similar techinque is already used in TestWKWebView.waitForMessages

* Tools/TestWebKitAPI/SourcesCocoa.txt:
* Tools/TestWebKitAPI/TestScriptMessageHandler.mm: Added.
(-[TestScriptMessageHandler waitForMessage]):
(-[TestScriptMessageHandler userContentController:didReceiveScriptMessage:]):
* Tools/TestWebKitAPI/TestWebKitAPI.xcodeproj/project.pbxproj:
* Tools/TestWebKitAPI/Tests/WebKitCocoa/IndexedDBSuspendImminently.mm:
(TEST(IndexedDB, IndexedDBSuspendImminently)):
(TEST(IndexedDB, SuspendImminentlyForThirdPartyDatabases)):
(-[IndexedDBSuspendImminentlyMessageHandler userContentController:didReceiveScriptMessage:]): Deleted.
(runUntilMessageReceived): Deleted.
(keepNetworkProcessActive): Deleted.
(TEST(IndexedDB, DISABLED_IndexedDBSuspendImminently)): Deleted.
* Tools/TestWebKitAPI/cocoa/TestScriptMessageHandler.h: Added.
* Tools/TestWebKitAPI/cocoa/TestScriptMessageHandler.mm: Added.
(-[TestScriptMessageHandler waitForMessage]):
(-[TestScriptMessageHandler userContentController:didReceiveScriptMessage:]):

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

2c313a3

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 win-tests
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 wpe-cairo
	🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	❌ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
✅ 🛠 🧪 unsafe-merge	✅ 🛠 tv
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on current version of this PR (hash 2c313a3)

Details

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 win-tests
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 wpe-cairo
	🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	❌ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
✅ 🛠 🧪 unsafe-merge	✅ 🛠 tv
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

[szewai]

Can we just do here:

receivedScriptMessage = true;
scriptMessages.append(message);

And use [getNextMessage() body] below?
(There is a getNextMessage in DeprecatedGlobalValues.h)

[achristensen07]

We could, but this is a non-global replacement for DeprecatedGlobalValues. I think it would be better to replace all use of getNextMessage() with TestScriptMessageHandler

[webkit-commit-queue]

Committed 292658@main (a899e6f): https://commits.webkit.org/292658@main

Reviewed commits have been landed. Closing PR #42962 and removing active labels.