Vault Without Purchase Analytics #258
Conversation
| @@ -104,6 +104,10 @@ public class PayPalWebCheckoutClient: NSObject { | |||
| /// - Returns: PayPalVaultResult | |||
| /// - Throws: PayPalSDK error if vaulting could not complete successfully | |||
| public func vault(url: URL) { | |||
There was a problem hiding this comment.
Outside the scope of this PR - but why doesn't PayPalWebCheckoutClient.vault() accept a request object? The entry point to all of our other SDK features use the request object pattern (see CardClient.vault(), PayPalWebClient.start(), PayPalNativeCheckoutClient.start()).
The request object pattern helps us easily add request params as needed as features scale versus needing to add new overload methods.
cc: @KunJeongPark
There was a problem hiding this comment.
IMO a PayPalVaultRequest with a required setupTokenID & url would help future proof our analytics (in case the URL changes the approval_session_id param name), as well as align us better to the Card vaulting feature's public API.
There was a problem hiding this comment.
I agree we've never discussed this as a group. A PayPalVaultRequest object with a url property would be consistent with other methods. I'm personally 50 / 50 on adding a setupTokenID since it's an extra property, but if it's critical to analytics we should add it in.
There was a problem hiding this comment.
Captured in DTPPCPSDK-1985.
| @@ -104,6 +104,10 @@ public class PayPalWebCheckoutClient: NSObject { | |||
| /// - Returns: PayPalVaultResult | |||
| /// - Throws: PayPalSDK error if vaulting could not complete successfully | |||
| public func vault(url: URL) { | |||
| if let setupToken = getQueryStringParameter(url: url.absoluteString, param: "approval_session_id") { | |||
| analyticsService = AnalyticsService(coreConfig: config, setupToken: setupToken) | |||
| } | |||
There was a problem hiding this comment.
Also slightly unrelated to analytics (but revealed by analytics 😆) - should we boot a merchant from the flow if their URL doesn't contain this value? Currently merchants can pass us any URL and we'll open it in an ASWebSession.
There was a problem hiding this comment.
+1 for being precautious. The only risk here would be if the format of the URL we get from PPaaS changed one day to something we don't expect, it could break existing integrations.
There was a problem hiding this comment.
Agree, seems like a pretty big risk vector. You could pass in stealyourcreditcard.com and we'd be like "sounds good!" and open it right up.
There was a problem hiding this comment.
Y'all know what we would need to allowlist so we can patch this?
There was a problem hiding this comment.
Luckily this hasn't been released yet on iOS, so we should be able to resolve this. We also should figure out when we want to release since our unreleased section is real long and we probably should be doing smaller releases along the way.
There was a problem hiding this comment.
Yeah on second thought maybe restricting the TLD to paypal.com at least? That way we know for certain it's going to us over TLS.
There was a problem hiding this comment.
Captured in DTPPCPSDK-1986.
| @@ -44,6 +44,8 @@ public class CardClient: NSObject { | |||
| /// - Parameters: | |||
| /// - vaultRequest: The request containing setupTokenID and card | |||
| public func vault(_ vaultRequest: CardVaultRequest) { | |||
| analyticsService = AnalyticsService(coreConfig: config, setupToken: vaultRequest.setupTokenID) | |||
| analyticsService?.sendEvent("card-payments:vault-wo-purchase:started") | |||
There was a problem hiding this comment.
Should we extract analytics out into a constants file on PPCP: example from the BT SDK?
There was a problem hiding this comment.
This is a good call. Making DTPPCPSDK-1984 to address this project wide.
Reason for changes
We want to add analytics to the flow to track merchant’s usage of vault without purchase.
Summary of changes
Added analytics events for vault without purchase flows
PayPal Wallet Vault Events
paypal-web-payments:vault-wo-purchase:startedpaypal-web-payments:vault-wo-purchase:canceledpaypal-web-payments:vault-wo-purchase:succeededpaypal-web-payments:vault-wo-purchase:failedCard Vault Events
card-payments:vault-wo-purchase:startedcard-payments:vault-wo-purchase:challenge-requiredcard-payments:vault-wo-purchase:challenge:canceledcard-payments:vault-wo-purchase:succeededcard-payments:vault-wo-purchase:failedChecklist
Authors