Changeset 286788 in webkit for trunk/Source/WebKit/Shared/PushMessageForTesting.h

Timestamp:

Dec 9, 2021, 10:58:34 AM (3 years ago)

Author:

beidson@apple.com

Message:

Add ability to inject messages into webpushd
​https://bugs.webkit.org/show_bug.cgi?id=233988

Reviewed by Alex Christensen.

Source/WebKit:

Covered by API tests.

This patch:

• Adds WKWebsiteDataStore SPI to fetch pending push messages for the embedding application
• Gives webpushd code to inject a push message for a given bundle identifier
• Gives webpushtool the ability to send one of these fake messages
• Gives webpushtool the ability to reconnect to the next daemon instance after the current connection is dropped
• Tests the injection and fetching of push messages via TestWebKitAPI

• Configurations/webpushtool.xcconfig:
• WebKit.xcodeproj/project.pbxproj:
• Resources/webpushtool.entitlements:

• NetworkProcess/NetworkProcess.cpp:

(WebKit::NetworkProcess::getPendingPushMessages):
(WebKit::NetworkProcess::processPushMessage):

• NetworkProcess/NetworkProcess.h:
• NetworkProcess/NetworkProcess.messages.in:

• NetworkProcess/Notifications/NetworkNotificationManager.cpp:

(WebKit::NetworkNotificationManager::getPendingPushMessages):
(WebKit::ReplyCaller<Vector<WebPushMessage>::callReply):

• NetworkProcess/Notifications/NetworkNotificationManager.h:

• Shared/Cocoa/WebPushMessageCocoa.mm: Copied from Source/WebKit/webpushd/webpushtool/WebPushToolConnection.h.

(WebKit::WebPushMessage::fromDictionary):
(WebKit::WebPushMessage::toDictionary const):

• Shared/PushMessageForTesting.h: Copied from Source/WebKit/Shared/WebPushDaemonConstants.h.

(WebKit::WebPushD::PushMessageForTesting::encode const):
(WebKit::WebPushD::PushMessageForTesting::decode):

• Shared/WebPushDaemonConstants.h:

(WebKit::WebPushD::messageTypeSendsReply):

• Shared/WebPushMessage.h: Copied from Source/WebKit/webpushd/webpushtool/WebPushToolConnection.h.

(WebKit::WebPushMessage::encode const):
(WebKit::WebPushMessage::decode):

• UIProcess/API/Cocoa/WKWebsiteDataStore.mm:

(-[WKWebsiteDataStore _getPendingPushMessages:]):
(-[WKWebsiteDataStore _processPushMessage:completionHandler:]):
(-[WKWebsiteDataStore _processPushMessage:registration:completionHandler:]): Deleted.

• UIProcess/API/Cocoa/WKWebsiteDataStorePrivate.h:

• UIProcess/Network/NetworkProcessProxy.cpp:

(WebKit::NetworkProcessProxy::getPendingPushMessages):
(WebKit::NetworkProcessProxy::processPushMessage):

• UIProcess/Network/NetworkProcessProxy.h:

• webpushd/PushClientConnection.h:
• webpushd/PushClientConnection.mm:

(WebPushD::ClientConnection::hostAppHasPushEntitlement):
(WebPushD::ClientConnection::hostAppHasPushInjectEntitlement):
(WebPushD::ClientConnection::hostHasEntitlement):
(WebPushD::ClientConnection::broadcastDebugMessage):

• webpushd/WebPushDaemon.h:
• webpushd/WebPushDaemon.mm:

(WebPushD::MessageInfo::injectPushMessageForTesting::encodeReply):
(WebPushD::MessageInfo::getPendingPushMessages::encodeReply):
(WebPushD::Daemon::decodeAndHandleMessage):
(WebPushD::Daemon::injectPushMessageForTesting):
(WebPushD::Daemon::getPendingPushMessages):

• webpushd/webpushtool/WebPushToolConnection.h:

(WebPushTool::Connection::setPushMessage):

• webpushd/webpushtool/WebPushToolConnection.mm:

(WebPushTool::Connection::startAction):
(WebPushTool::Connection::sendPushMessage):

• webpushd/webpushtool/WebPushToolMain.mm:

(printUsageAndTerminate):
(pushMessageFromArguments):
(main):

Tools:

• TestWebKitAPI/Configurations/TestWebKitAPI-iOS.entitlements:
• TestWebKitAPI/Configurations/TestWebKitAPI-macOS-internal.entitlements:
• TestWebKitAPI/Configurations/TestWebKitAPI-macOS.entitlements:

• TestWebKitAPI/Tests/WebKitCocoa/PushAPI.mm:

(messageDictionary):

• TestWebKitAPI/Tests/WebKitCocoa/WebPushDaemon.mm:

(TestWebKitAPI::createMessageDictionary):
(TestWebKitAPI::sendMessageToDaemon):
(TestWebKitAPI::sendMessageToDaemonWaitingForReply):
(TestWebKitAPI::sendConfigurationWithAuditToken):
(TestWebKitAPI::createAndConfigureConnectionToService):
(TestWebKitAPI::encodeString):
(TestWebKitAPI::TEST):
(TestWebKitAPI::function):

• TestWebKitAPI/cocoa/TestWKWebView.h:

File:

• trunk/Source/WebKit/Shared/PushMessageForTesting.h (copied) (copied from trunk/Source/WebKit/Shared/WebPushDaemonConstants.h ) (1 diff)

trunk/Source/WebKit/Shared/PushMessageForTesting.h

@@ -26 +26 @@
 #pragma once
 
+
+
+
 namespace WebKit::WebPushD {
 
-constexpr const char* protocolVersionKey = "protocol version";
-constexpr uint64_t protocolVersionValue = 1;
-constexpr const char* protocolEncodedMessageKey = "encoded message";
+struct PushMessageForTesting {
+;
+;
 
-constexpr const char* protocolDebugMessageKey { "debug message" };
-constexpr const char* protocolDebugMessageLevelKey { "debug message level" };
-
-constexpr const char* protocolMessageTypeKey { "message type" };
-enum class MessageType : uint8_t {
-    EchoTwice = 1,
-    RequestSystemNotificationPermission,
-    DeletePushAndNotificationRegistration,
-    GetOriginsWithPushAndNotificationPermissions,
-    SetDebugModeIsEnabled,
-    UpdateConnectionConfiguration,
+    String targetAppCodeSigningIdentifier;
+    URL registrationURL;
+    String message;
 };
 
-inline bool messageTypeSendsReply(MessageType messageType)
+template<class Encoder>
+void PushMessageForTesting::encode(Encoder& encoder) const
 {
-    switch (messageType) {
-    case MessageType::EchoTwice:
-    case MessageType::GetOriginsWithPushAndNotificationPermissions:
-    case MessageType::DeletePushAndNotificationRegistration:
-    case MessageType::RequestSystemNotificationPermission:
-        return true;
-    case MessageType::SetDebugModeIsEnabled:
-    case MessageType::UpdateConnectionConfiguration:
-        return false;
-    }
-    ASSERT_NOT_REACHED();
-    return false;
+    encoder << targetAppCodeSigningIdentifier << registrationURL << message;
+}
+
+template<class Decoder>
+std::optional<PushMessageForTesting> PushMessageForTesting::decode(Decoder& decoder)
+{
+    std::optional<String> targetAppCodeSigningIdentifier;
+    decoder >> targetAppCodeSigningIdentifier;
+    if (!targetAppCodeSigningIdentifier)
+        return std::nullopt;
+
+    std::optional<URL> registrationURL;
+    decoder >> registrationURL;
+    if (!registrationURL)
+        return std::nullopt;
+
+    std::optional<String> message;
+    decoder >> message;
+    if (!message)
+        return std::nullopt;
+
+    return { {
+        WTFMove(*targetAppCodeSigningIdentifier),
+        WTFMove(*registrationURL),
+        WTFMove(*message),
+    } };
 }