New test: [iOS macOS] TestIPC.StreamConnectionTest.SendAsyncReplyMessage is timing out

[kkinnunen-apple]

e6b6765

New test: [iOS macOS] TestIPC.StreamConnectionTest.SendAsyncReplyMessage is timing out
https://bugs.webkit.org/show_bug.cgi?id=249780
rdar://103640558

Reviewed by Matt Woodrow.

The test would time out mainly because the communication semaphores were not
set up between client and server connection.
If the server would be slow enough, the initial processing wakeup due to
starting message listening would make the test pass.
If the server would be fast enough, the initial processing wakeup would
not process all messages that the test would send, and thus it would
time out. Fix by setting the semaphores, so new messages will wake up
the server work queue.

Secondarily make the test more consistent by running all the server
related code in the server work queue.

The first point needs IPCSemaphore to have copy operations, so implement
these. Add tests for IPCSemaphore, test also the new operations.
These semaphores are typically sent as part of the initialization message
exchange between client and server (CreateXXX, DidCreateXXX messages).
The unit tests run in single process, there is no message exchange
to setup the connection.

The second point needs a fix for StreamConnectionWorkQueue, where
the tasks that would be run during shutdown would crash if the
tasks would assert that the task is run on correct queue. Fix by
not removing the m_processingThread reference until the thread
has exited. Add a test for this.

* Source/WebKit/Platform/IPC/StreamConnectionWorkQueue.cpp:
(IPC::StreamConnectionWorkQueue::stopAndWaitForCompletion):
* Tools/TestWebKitAPI/TestWebKitAPI.xcodeproj/project.pbxproj:
* Tools/TestWebKitAPI/Tests/IPC/IPCTestUtilities.h:
(TestWebKitAPI::copyViaEncoder):
* Tools/TestWebKitAPI/Tests/IPC/StreamConnectionTests.cpp:
(TestWebKitAPI::StreamConnectionTest::localReferenceBarrier):
(TestWebKitAPI::StreamConnectionTest::serverQueue):
(TestWebKitAPI::TEST_F):
(TestWebKitAPI::StreamConnectionTest::StreamConnectionTest): Deleted.
* Tools/TestWebKitAPI/Tests/IPC/StreamConnectionWorkQueueTests.cpp: Added.
(TestWebKitAPI::TEST_F):

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

e436a82

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
✅ 🛠 🧪 merge	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash b1b7344)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	❌ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	❌ 🧪 gtk-wk2
	🧪 api-ios	✅ 🧪 mac-wk1	❌ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
	✅ 🛠 watch-sim

[zdobersek]

diff --git a/Source/WebKit/Platform/IPC/unix/IPCSemaphoreUnix.cpp b/Source/WebKit/Platform/IPC/unix/IPCSemaphoreUnix.cpp
index 1aaa88d8bba9..b7af4d381845 100644
--- a/Source/WebKit/Platform/IPC/unix/IPCSemaphoreUnix.cpp
+++ b/Source/WebKit/Platform/IPC/unix/IPCSemaphoreUnix.cpp
@@ -50,10 +50,19 @@ Semaphore::Semaphore(UnixFileDescriptor&& fd)
 { }
 
 Semaphore::Semaphore(Semaphore&&) = default;
-Semaphore::Semaphore(const Semaphore&) = default;
-Semaphore::~Semaphore() = default;
 Semaphore& Semaphore::operator=(Semaphore&&) = default;
-Semaphore& Semaphore::operator=(const Semaphore&) = default;
+
+Semaphore::Semaphore(const Semaphore& o)
+    : m_fd(o.m_fd.duplicate())
+{ }
+
+Semaphore& Semaphore::operator=(const Semaphore& o)
+{
+    m_fd = o.m_fd.duplicate();
+    return *this;
+}
+
+Semaphore::~Semaphore() = default;
 
 void Semaphore::signal()
 {

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 3f2dd0d)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
	✅ 🛠 watch-sim

[mattwoodrow]

Could you just use this to create same-process copies of the Semaphore for the test code, and then not need to add the copy constructor?

It seems fine either way though, to support both in-process copies as well as IPC ones, just adds a bit more code that's only used for testing.

[kkinnunen-apple]

Could you just use this to create same-process copies of the Semaphore for the test code, and then not need to add the copy constructor?

While contrary to the goal of bringing order to (my) world, I think your suggestion is unfortunately the better approach.

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 55bb99e)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	🛠 ios	⏳ 🛠 mac	✅ 🛠 wpe	🛠 🧪 win
✅ 🧪 bindings	🛠 ios-sim	🛠 mac-AS-debug	✅ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	🧪 ios-wk2	⏳ 🧪 api-mac	🧪 gtk-wk2
	🧪 api-ios	⏳ 🧪 mac-wk1	🧪 api-gtk
	❌ 🛠 tv	⏳ 🧪 mac-wk2
	❌ 🛠 tv-sim	🧪 mac-AS-debug-wk2
	🛠 watch	⏳ 🧪 mac-wk2-stress
	❌ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 174aca5)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
❌ 🛠 🧪 merge	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on current version of this PR (hash e436a82)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
✅ 🛠 🧪 merge	✅ 🛠 watch-sim

[webkit-commit-queue]

Committed 258913@main (e6b6765): https://commits.webkit.org/258913@main

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