Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Connect] Add message handling for closing and mobile inputs. #4563

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions StripeConnect/StripeConnect.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@
4161C2792C9DB1CE005BD67C /* StripeUICore.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4161C2782C9DB1CE005BD67C /* StripeUICore.framework */; };
4161C27E2C9DB566005BD67C /* AccountCollectionOptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4161C27D2C9DB566005BD67C /* AccountCollectionOptions.swift */; };
4161C28C2CA1B54E005BD67C /* OnSetterFunctionCalledMessageHandlerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4161C28B2CA1B54E005BD67C /* OnSetterFunctionCalledMessageHandlerTests.swift */; };
416D741D2D5D894E0058E030 /* CloseWebViewMessageHandlerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 416D741C2D5D894C0058E030 /* CloseWebViewMessageHandlerTests.swift */; };
416D741F2D5D8D120058E030 /* MobileInputReceivedSenderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 416D741E2D5D8D110058E030 /* MobileInputReceivedSenderTests.swift */; };
416E9E742C751A1A00A0B917 /* ConnectComponentWebViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 416E9E732C751A1A00A0B917 /* ConnectComponentWebViewController.swift */; };
416E9E762C751B0500A0B917 /* EmbeddedComponentManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 416E9E752C751B0500A0B917 /* EmbeddedComponentManager.swift */; };
416E9E782C753B7900A0B917 /* ConnectComponentWebViewControllerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 416E9E772C753B7900A0B917 /* ConnectComponentWebViewControllerTests.swift */; };
Expand All @@ -68,6 +70,8 @@
41A2A5642C5ABD6C0077FC74 /* StripeConnectTests.xctestplan in Resources */ = {isa = PBXBuildFile; fileRef = 41A2A5632C5ABD6C0077FC74 /* StripeConnectTests.xctestplan */; };
41A2A5682C5AC5120077FC74 /* StripeCore.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 41A2A5672C5AC5120077FC74 /* StripeCore.framework */; };
41B64AA82D5B8CF70026DD7A /* ComponentAccountSessionClaimed.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41B64AA72D5B8CEE0026DD7A /* ComponentAccountSessionClaimed.swift */; };
41B64AC72D5D48E60026DD7A /* MobileInputReceivedSender.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41B64AC62D5D48E00026DD7A /* MobileInputReceivedSender.swift */; };
41B64AC92D5D506D0026DD7A /* CloseWebView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41B64AC82D5D50690026DD7A /* CloseWebView.swift */; };
41BCCFEB2C8B348500797E01 /* AppearanceWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41BCCFEA2C8B348500797E01 /* AppearanceWrapper.swift */; };
41BCCFED2C8B34F600797E01 /* StringCodingKey.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41BCCFEC2C8B34F600797E01 /* StringCodingKey.swift */; };
41BCCFF02C8B3C8900797E01 /* AppearanceWrapper+Default.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41BCCFEF2C8B3C8900797E01 /* AppearanceWrapper+Default.swift */; };
Expand Down Expand Up @@ -197,6 +201,8 @@
4161C2782C9DB1CE005BD67C /* StripeUICore.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; path = StripeUICore.framework; sourceTree = BUILT_PRODUCTS_DIR; };
4161C27D2C9DB566005BD67C /* AccountCollectionOptions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AccountCollectionOptions.swift; sourceTree = "<group>"; };
4161C28B2CA1B54E005BD67C /* OnSetterFunctionCalledMessageHandlerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OnSetterFunctionCalledMessageHandlerTests.swift; sourceTree = "<group>"; };
416D741C2D5D894C0058E030 /* CloseWebViewMessageHandlerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CloseWebViewMessageHandlerTests.swift; sourceTree = "<group>"; };
416D741E2D5D8D110058E030 /* MobileInputReceivedSenderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MobileInputReceivedSenderTests.swift; sourceTree = "<group>"; };
416E9E732C751A1A00A0B917 /* ConnectComponentWebViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConnectComponentWebViewController.swift; sourceTree = "<group>"; };
416E9E752C751B0500A0B917 /* EmbeddedComponentManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EmbeddedComponentManager.swift; sourceTree = "<group>"; };
416E9E772C753B7900A0B917 /* ConnectComponentWebViewControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConnectComponentWebViewControllerTests.swift; sourceTree = "<group>"; };
Expand All @@ -223,6 +229,8 @@
41A2A5632C5ABD6C0077FC74 /* StripeConnectTests.xctestplan */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = StripeConnectTests.xctestplan; sourceTree = "<group>"; };
41A2A5672C5AC5120077FC74 /* StripeCore.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; path = StripeCore.framework; sourceTree = BUILT_PRODUCTS_DIR; };
41B64AA72D5B8CEE0026DD7A /* ComponentAccountSessionClaimed.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ComponentAccountSessionClaimed.swift; sourceTree = "<group>"; };
41B64AC62D5D48E00026DD7A /* MobileInputReceivedSender.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MobileInputReceivedSender.swift; sourceTree = "<group>"; };
41B64AC82D5D50690026DD7A /* CloseWebView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CloseWebView.swift; sourceTree = "<group>"; };
41BCCFEA2C8B348500797E01 /* AppearanceWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppearanceWrapper.swift; sourceTree = "<group>"; };
41BCCFEC2C8B34F600797E01 /* StringCodingKey.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StringCodingKey.swift; sourceTree = "<group>"; };
41BCCFEF2C8B3C8900797E01 /* AppearanceWrapper+Default.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "AppearanceWrapper+Default.swift"; sourceTree = "<group>"; };
Expand Down Expand Up @@ -337,6 +345,7 @@
410D0FD52C6D07B1009B0E26 /* MessageSenders */ = {
isa = PBXGroup;
children = (
416D741E2D5D8D110058E030 /* MobileInputReceivedSenderTests.swift */,
410D0FDA2C6D21B0009B0E26 /* CallSetterWithSerializableValueSenderTests.swift */,
410D0FDC2C6D23AD009B0E26 /* ReturnedFromAuthenticatedWebViewSenderTests.swift */,
E6660CFA2CC2F436002A7631 /* SetCollectMobileFinancialConnectionsResultTests.swift */,
Expand All @@ -348,6 +357,7 @@
413987BD2C63F34B001D375E /* MessageHandlers */ = {
isa = PBXGroup;
children = (
41B64AC82D5D50690026DD7A /* CloseWebView.swift */,
E688AE042CADE37C00951D97 /* NotificationBanner */,
4171B15C2C9B3AA300547F7D /* Onboarding */,
413987D92C64093C001D375E /* Helpers */,
Expand All @@ -368,6 +378,7 @@
413987C02C63F34B001D375E /* MessageSenders */ = {
isa = PBXGroup;
children = (
41B64AC62D5D48E00026DD7A /* MobileInputReceivedSender.swift */,
413987D32C640848001D375E /* CallSetterWithSerializableValueSender.swift */,
413987BE2C63F34B001D375E /* MessageSender.swift */,
413987D52C64088E001D375E /* ReturnedFromAuthenticatedWebViewSender.swift */,
Expand Down Expand Up @@ -511,6 +522,7 @@
41814EE92C6BCA970014EB5E /* MessageHandlers */ = {
isa = PBXGroup;
children = (
416D741C2D5D894C0058E030 /* CloseWebViewMessageHandlerTests.swift */,
E6660DC52CDE8F22002A7631 /* Helpers */,
E688AE012CADE35300951D97 /* NotificationBanner */,
4161C2692C9CD0B1005BD67C /* Onboarding */,
Expand Down Expand Up @@ -908,8 +920,10 @@
E6D3C8EE2CBE1404003CE967 /* HTTPStatusError.swift in Sources */,
413987CC2C63F34B001D375E /* VoidPayload.swift in Sources */,
E65691272CA533CD00E0DB00 /* OnNotificationsChangeHandler.swift in Sources */,
41B64AC72D5D48E60026DD7A /* MobileInputReceivedSender.swift in Sources */,
E640C9CF2CBF26DE009D0C6E /* AuthenticatedWebViewError.swift in Sources */,
413987DD2C640A29001D375E /* FetchInitParamsMessageHandler.swift in Sources */,
41B64AC92D5D506D0026DD7A /* CloseWebView.swift in Sources */,
E6695A1F2CC1CB99008049D1 /* SetCollectMobileFinancialConnectionsResultSender.swift in Sources */,
413987D42C640848001D375E /* CallSetterWithSerializableValueSender.swift in Sources */,
416E9E742C751A1A00A0B917 /* ConnectComponentWebViewController.swift in Sources */,
Expand Down Expand Up @@ -959,6 +973,7 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
416D741F2D5D8D120058E030 /* MobileInputReceivedSenderTests.swift in Sources */,
410D0FDD2C6D23AD009B0E26 /* ReturnedFromAuthenticatedWebViewSenderTests.swift in Sources */,
410D0FD92C6D1F25009B0E26 /* UpdateConnectInstanceSenderTests.swift in Sources */,
E6F486092C9E8A40000D914F /* ConnectJSURLParamsTests.swift in Sources */,
Expand Down Expand Up @@ -989,6 +1004,7 @@
410D0FE72C6D3BBC009B0E26 /* ConnectWebViewControllerTests.swift in Sources */,
410D0FD02C6D0319009B0E26 /* PageDidLoadMessageHandlerTests.swift in Sources */,
41814EED2C6BED8C0014EB5E /* FetchClientSecretMessageHandlerTests.swift in Sources */,
416D741D2D5D894E0058E030 /* CloseWebViewMessageHandlerTests.swift in Sources */,
E6165CC12CA7D09900B76DA5 /* FetchInitComponentPropsMessageHandlerTests.swift in Sources */,
41814EE82C6BC8800014EB5E /* ScriptWebTestBase.swift in Sources */,
E6660DBE2CDDCC3A002A7631 /* AnalyticsCommonFieldsTests.swift in Sources */,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import WebKit
@available(iOS 15, *)
class ConnectComponentWebViewController: ConnectWebViewController {

var onDismiss: (() -> Void)?

/// The embedded component manager that will be used for requests.
let componentManager: EmbeddedComponentManager

Expand Down Expand Up @@ -214,20 +216,45 @@ extension ConnectComponentWebViewController {
contentController.addScriptMessageHandler(messageHandler, contentWorld: contentWorld, name: messageHandler.name)
}

func sendMessageAsync(_ sender: any MessageSender) async throws {
return try await withCheckedThrowingContinuation { continuation in
do {
let message = try sender.javascriptMessage()
webView.evaluateJavaScript(message, completionHandler: { _, error in
if let error = error {
continuation.resume(throwing: error)
} else {
continuation.resume(returning: ())
}
})
} catch {
continuation.resume(throwing: error)
}
}
}

/// Convenience method to send messages to the webview.
func sendMessage(_ sender: any MessageSender) {
do {
let message = try sender.javascriptMessage()
webView.evaluateJavaScript(message)
} catch {
analyticsClient.logClientError(error)
Task { @MainActor in
do {
try await sendMessageAsync(sender)
} catch {
analyticsClient.logClientError(error)
}
}
}

func updateAppearance(appearance: Appearance) {
sendMessage(UpdateConnectInstanceSender.init(payload: .init(locale: webLocale.toLanguageTag(), appearance: .init(appearance: appearance, traitCollection: traitCollection))))
updateColors(appearance: appearance)
}

override func viewWillDisappear(_ animated: Bool) {
super.viewWillDisappear(animated)
if isBeingDismissed {
onDismiss?()
}
}
}

// MARK: - Private
Expand Down Expand Up @@ -274,6 +301,9 @@ private extension ConnectComponentWebViewController {
addMessageHandler(OpenFinancialConnectionsMessageHandler(analyticsClient: analyticsClient) { [weak self] payload in
self?.openFinancialConnections(payload)
})
addMessageHandler(CloseWebViewMessageHandler(analyticsClient: analyticsClient, didReceiveMessage: { [weak self] _ in
self?.dismiss(animated: true)
}))
}

/// Adds NotificationCenter observers
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
//
// CloseWebView.swift
// StripeConnect
//
// Created by Chris Mays on 2/12/25.
//

/// Indicates to close the webview
class CloseWebViewMessageHandler: ScriptMessageHandler<VoidPayload> {
init(analyticsClient: ComponentAnalyticsClient,
didReceiveMessage: @escaping (VoidPayload) -> Void) {
super.init(name: "closeWebView",
analyticsClient: analyticsClient,
didReceiveMessage: didReceiveMessage)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//
// MobileInputReceivedSender.swift
// StripeConnect
//
// Created by Chris Mays on 2/12/25.
//

enum Input: String, Equatable, Codable {
case close = "closeButtonPressed"
}

struct MobileInputReceivedSender: MessageSender {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be used in a follow up PR.

struct Payload: Codable, Equatable {
var input: Input
}
let name: String = "mobileInputReceived"
let payload: Payload = .init(input: .close)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
//
// CloseWebViewMessageHandlerTests.swift
// StripeConnect
//
// Created by Chris Mays on 2/12/25.
//

@_spi(PrivateBetaConnect) @testable import StripeConnect
import XCTest

class CloseWebViewMessageHandlerTests: ScriptWebTestBase {

@MainActor
func testMessageSend() async throws {
let expectation = self.expectation(description: "Message received")

let messageHandler = CloseWebViewMessageHandler(analyticsClient: MockComponentAnalyticsClient(commonFields: .mock), didReceiveMessage: { _ in
expectation.fulfill()
})

webView.addMessageHandler(messageHandler: messageHandler)

try await webView.evaluateMessage(name: "closeWebView",
json: """
{}
""")
await fulfillment(of: [expectation], timeout: TestHelpers.defaultTimeout)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
//
// MobileInputReceivedSenderTests.swift
// StripeConnect
//
// Created by Chris Mays on 2/12/25.
//

import Foundation
@testable import StripeConnect
import XCTest

class MobileInputReceivedSenderTests: ScriptWebTestBase {
func testSendMessage() throws {
try validateMessageSent(sender: MobileInputReceivedSender())
}

func testSenderSignature() {
XCTAssertEqual(
try MobileInputReceivedSender().javascriptMessage(),
"""
window.mobileInputReceived({"input":"closeButtonPressed"});
"""
)
}
}
Loading