Changeset 282483 in webkit

Timestamp:

Sep 15, 2021, 6:02:18 PM (5 years ago)

Author:

Chris Dumez

Message:

Implement network process crash recovery for BroadcastChannel
​https://bugs.webkit.org/show_bug.cgi?id=230236

Reviewed by Alex Christensen.

Source/WebKit:

Have the WebBroadcastChannelRegistry register its BroadcastChannels with the network
process after a network process crash. This is useful so that cross-WebProcess
communication can keep happening via existing BroadcastChannel after a network process
crash.

• WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.cpp:

(WebKit::WebBroadcastChannelRegistry::networkProcessCrashed):

• WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.h:
• WebProcess/WebProcess.cpp:

(WebKit::WebProcess::networkProcessConnectionClosed):

Tools:

Add API test coverage.

• TestWebKitAPI/Tests/WebKitCocoa/NetworkProcess.mm:

(-[BroadcastChannelMessageHandler userContentController:didReceiveScriptMessage:]):
(TEST):

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.cpp (modified) (1 diff)
• Source/WebKit/WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.h (modified) (1 diff)
• Source/WebKit/WebProcess/WebProcess.cpp (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/NetworkProcess.mm (modified) (2 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-09-15  Chris Dumez  <cdumez@apple.com>
+
+        Implement network process crash recovery for BroadcastChannel
+        https://bugs.webkit.org/show_bug.cgi?id=230236
+
+        Reviewed by Alex Christensen.
+
+        Have the WebBroadcastChannelRegistry register its BroadcastChannels with the network
+        process after a network process crash. This is useful so that cross-WebProcess
+        communication can keep happening via existing BroadcastChannel after a network process
+        crash.
+
+        * WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.cpp:
+        (WebKit::WebBroadcastChannelRegistry::networkProcessCrashed):
+        * WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.h:
+        * WebProcess/WebProcess.cpp:
+        (WebKit::WebProcess::networkProcessConnectionClosed):
+
 2021-09-15  Devin Rousso  <drousso@apple.com>
 

trunk/Source/WebKit/WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.cpp

@@ -107 +107 @@
 }
 
+void WebBroadcastChannelRegistry::networkProcessCrashed()
+{
+    for (auto& [origin, channelsForOrigin] : m_channelsPerOrigin) {
+        for (auto& name : channelsForOrigin.keys())
+            networkProcessConnection().send(Messages::NetworkBroadcastChannelRegistry::RegisterChannel { origin, name }, 0);
+    }
+}
+
 } // namespace WebKit

trunk/Source/WebKit/WebProcess/WebCoreSupport/WebBroadcastChannelRegistry.h

@@ -53 +53 @@
     void postMessage(const WebCore::ClientOrigin&, const String& name, WebCore::BroadcastChannelIdentifier source, Ref<WebCore::SerializedScriptValue>&&, CompletionHandler<void()>&&) final;
 
+    void networkProcessCrashed();
+
     void didReceiveMessage(IPC::Connection&, IPC::Decoder&);
 

trunk/Source/WebKit/WebProcess/WebProcess.cpp

@@ -1196 +1196 @@
     WebSocketStream::networkProcessCrashed();
     m_webSocketChannelManager.networkProcessCrashed();
+    m_broadcastChannelRegistry->networkProcessCrashed();
 
     if (m_libWebRTCNetwork)

trunk/Tools/ChangeLog

@@ +1 @@
+2021-09-15  Chris Dumez  <cdumez@apple.com>
+
+        Implement network process crash recovery for BroadcastChannel
+        https://bugs.webkit.org/show_bug.cgi?id=230236
+
+        Reviewed by Alex Christensen.
+
+        Add API test coverage.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/NetworkProcess.mm:
+        (-[BroadcastChannelMessageHandler userContentController:didReceiveScriptMessage:]):
+        (TEST):
+
 2021-09-15  Tim Horton  <timothy_horton@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/NetworkProcess.mm

@@ -27 +27 @@
 
 #import "HTTPServer.h"
+#import "PlatformUtilities.h"
 #import "TestWKWebView.h"
 #import "Utilities.h"
 #import <WebKit/WKProcessPoolPrivate.h>
+#import <WebKit/WKScriptMessageHandler.h>
 #import <WebKit/WKWebViewPrivate.h>
 #import <WebKit/WKWebsiteDataStorePrivate.h>
@@ -193 +195 @@
         TestWebKitAPI::Util::spinRunLoop();
 }
+
+
+static Vector<RetainPtr<WKScriptMessage>> receivedMessages;
+static bool receivedMessage = false;
+
+@interface BroadcastChannelMessageHandler : NSObject <WKScriptMessageHandler>
+@end
+
+@implementation BroadcastChannelMessageHandler
+- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message
+{
+    receivedMessages.append(message);
+    receivedMessage = true;
+}
+@end
+
+TEST(NetworkProcess, BroadcastChannelCrashRecovery)
+{
+    auto webViewConfiguration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    auto messageHandler = adoptNS([[BroadcastChannelMessageHandler alloc] init]);
+    [[webViewConfiguration userContentController] addScriptMessageHandler:messageHandler.get() name:@"test"];
+
+    auto webView1 = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:webViewConfiguration.get()]);
+    auto webView2 = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:webViewConfiguration.get()]);
+
+    receivedMessage = false;
+    receivedMessages.clear();
+
+    NSString *html = [NSString stringWithFormat:@"<script>let bc = new BroadcastChannel('test'); bc.onmessage = (msg) => { webkit.messageHandlers.test.postMessage(msg.data); };</script>"];
+    NSURL *baseURL = [NSURL URLWithString:@"http://example.com/"];
+
+    [webView1 synchronouslyLoadHTMLString:html baseURL:baseURL];
+    [webView2 synchronouslyLoadHTMLString:html baseURL:baseURL];
+
+    auto webPID1 = [webView1 _webProcessIdentifier];
+    auto webPID2 = [webView2 _webProcessIdentifier];
+    EXPECT_NE(webPID1, 0);
+    EXPECT_NE(webPID2, 0);
+    EXPECT_NE(webPID1, webPID2);
+
+    auto networkPID = [[WKWebsiteDataStore defaultDataStore] _networkProcessIdentifier];
+    EXPECT_NE(networkPID, 0);
+
+    EXPECT_FALSE(receivedMessage);
+    EXPECT_TRUE(receivedMessages.isEmpty());
+
+    // Test that initial communication from webView1 to webView2 works.
+    receivedMessage = false;
+    receivedMessages.clear();
+    bool finishedRunningScript = false;
+    [webView1 evaluateJavaScript:@"bc.postMessage('foo')" completionHandler: [&] (id result, NSError *error) {
+        EXPECT_TRUE(!error);
+        finishedRunningScript = true;
+    }];
+    TestWebKitAPI::Util::run(&finishedRunningScript);
+
+    TestWebKitAPI::Util::run(&receivedMessage);
+    TestWebKitAPI::Util::spinRunLoop(10);
+
+    EXPECT_EQ(receivedMessages.size(), 1U);
+    EXPECT_EQ([receivedMessages[0] webView], webView2);
+    EXPECT_WK_STREQ([receivedMessages[0] body], @"foo");
+
+    // Test that initial communication from webView2 to webView1 works.
+    receivedMessage = false;
+    receivedMessages.clear();
+    finishedRunningScript = false;
+    [webView2 evaluateJavaScript:@"bc.postMessage('bar')" completionHandler: [&] (id result, NSError *error) {
+        EXPECT_TRUE(!error);
+        finishedRunningScript = true;
+    }];
+    TestWebKitAPI::Util::run(&finishedRunningScript);
+
+    TestWebKitAPI::Util::run(&receivedMessage);
+    TestWebKitAPI::Util::spinRunLoop(10);
+
+    EXPECT_EQ(receivedMessages.size(), 1U);
+    EXPECT_EQ([receivedMessages[0] webView], webView1);
+    EXPECT_WK_STREQ([receivedMessages[0] body], @"bar");
+
+    // Kill the network process.
+    kill(networkPID, 9);
+    while ([[WKWebsiteDataStore defaultDataStore] _networkProcessIdentifier] == networkPID)
+        TestWebKitAPI::Util::spinRunLoop(10);
+
+    // Test that initial communication from webView1 to webView2 works.
+    receivedMessage = false;
+    receivedMessages.clear();
+    finishedRunningScript = false;
+    [webView1 evaluateJavaScript:@"bc.postMessage('foo2')" completionHandler: [&] (id result, NSError *error) {
+        EXPECT_TRUE(!error);
+        finishedRunningScript = true;
+    }];
+    TestWebKitAPI::Util::run(&finishedRunningScript);
+
+    TestWebKitAPI::Util::run(&receivedMessage);
+    TestWebKitAPI::Util::spinRunLoop(10);
+
+    EXPECT_EQ(receivedMessages.size(), 1U);
+    EXPECT_EQ([receivedMessages[0] webView], webView2);
+    EXPECT_WK_STREQ([receivedMessages[0] body], @"foo2");
+
+    // Test that initial communication from webView2 to webView1 works.
+    receivedMessage = false;
+    receivedMessages.clear();
+    finishedRunningScript = false;
+    [webView2 evaluateJavaScript:@"bc.postMessage('bar2')" completionHandler: [&] (id result, NSError *error) {
+        EXPECT_TRUE(!error);
+        finishedRunningScript = true;
+    }];
+    TestWebKitAPI::Util::run(&finishedRunningScript);
+
+    TestWebKitAPI::Util::run(&receivedMessage);
+    TestWebKitAPI::Util::spinRunLoop(10);
+
+    EXPECT_EQ(receivedMessages.size(), 1U);
+    EXPECT_EQ([receivedMessages[0] webView], webView1);
+    EXPECT_WK_STREQ([receivedMessages[0] body], @"bar2");
+
+    auto networkPID2 = [[WKWebsiteDataStore defaultDataStore] _networkProcessIdentifier];
+    EXPECT_NE(networkPID2, 0);
+    EXPECT_NE(networkPID, networkPID2);
+
+    EXPECT_EQ(webPID1, [webView1 _webProcessIdentifier]);
+    EXPECT_EQ(webPID2, [webView2 _webProcessIdentifier]);
+}