Clean up Analytics Names #313

KunJeongPark · 2024-12-09T21:02:47Z

Summary of changes

Some card analytics events had "3ds" labels even when they may not have 3DS contingency
Use format <module>: <function>: <event>
- For vault function, we are opting for vo-purchse instead of just vault to distinguish it from vault with purchase flow
Remove confirm-payment-source success/fail events
Create separate end events for success/fail for 3ds and non-3ds flows in parity with Android

Changes:

Card ApproveOrder:

Removed:

remove card-payments:3ds:confirm-payment-source:succeeded (was sent for non-3ds flow along with general succeeded event)
remove card-payments:3ds:confirm-payment-source:failed (was sent for non-3ds flow along with general failed event)

Added:

Add card-payments:approve-order:auth-challenge:succeeded for card approval success with 3ds
Add card-payments:approve-order:auth-challenge:failed for card approval failure with 3ds

Renamed:

card-payments:3ds:started => card-payments:approve-order:started
card-payments:3ds:confirm-payment-source:challenge-required -> card-payments:approve-order:auth-challenge-required
card-payments:3ds:failed (this was previously used for both 3ds and non-3ds final result) -> card-payments:approve-order:failed
card-payments:3ds:succeeded(this was previously used for both 3ds and non-3ds final result) -> card-payments:approve-order:succeeded
card-payments:approve-order:challenge:user-canceled =>card-payments:approve-order:auth-challenge:canceled
card-payments:3ds:challenge-presentation:succeeded => card-payments:approve-order:auth-challenge-presentation:succeeded
card-payments:3ds:challenge-presentation:failed => card-payments:approve-order:auth-challenge-presentation:failed

Card Vault:

Remains same for non-3ds flows:

card-payments:vault-wo-purchase:succeeded
card-payments:vault-wo-purchase:failed
card-payments:vault-wo-purchase:started

Added:

card-payments:vault-wo-purchase:auth-challenge:succeeded for card vault success with 3ds
card-payments:vault-wo-purchase:auth-challenge:failed for card vault failure with 3ds

Renamed:

card-payments:3ds:challenge-presentation:challenge-required => card-payments:vault-wo-purchase:auth-challenge-required
card-payments:3ds:challenge-presentation:succeeded => card-payments:vault-wo-purchase:auth-challenge-presentation:succeeded
card-payments:3ds:challenge-presentation:failed => card-payments:vault-wo-purchase:auth-challenge-presentation:failed
card-payments:vault-wo-purchase:challenge:canceled => card-payments:vault-wo-purchase:auth-challenge:canceled

PayPal Checkout:

Renamed:

paypal-web-payments:started => paypal-web-payments:checkout:started
paypal-web-payments:browser-presentation:succeeded => paypal-web-payments:checkout:auth-challenge-presentation:succeeded
paypal-web-payments:browser-presentation:failed => paypal-web-payments:checkout:auth-challenge-presentation:failed
paypal-web-payments:succeeded => paypal-web-payments:checkout:succeeded
paypal-web-payments:failed => paypal-web-payments:checkout:failed
paypal-web-payments:browser-login:canceled => paypal-web-payments:checkout:canceled

PayPal Vault:

Remains same:

paypal-web-payments:vault-wo-purchase:started

Renamed:

paypal-vault:browser-presentation:succeeded => paypal-web-payments:vault-wo-purchase:auth-challenge-presentation:succeeded
paypal-web-payments:browser-presentation:failed => paypal-web-payments:vault-wo-purchase:auth-challenge-presentation:failed
paypal-web-payments:vault-wo-purchase:succeeded => paypal-web-payments:vault-wo-purchase:succeeded
paypal-web-payments:vault-wo-purchase:failed => paypal-web-payments:vault-wo-purchase:failed
paypal-web-payments:vault-wo-purchase:canceled => paypal-web-payments:vault-wo-purchase:canceled

Main changes are having consistent analytic names across iOS and Android and separate success/fail end events for 3ds and non-3ds flows.

This is a draft as result of discussion with @sshropshire on cleaning up and coordinating iOS and Android analytic events

Checklist

~~- [ ] Added a changelog entry~~

Authors

List GitHub usernames for everyone who contributed to this pull request.

@KunJeongPark

sshropshire · 2024-12-09T22:27:34Z

Sources/CardPayments/CardClient.swift

@@ -113,19 +113,19 @@ public class CardClient: NSObject {
                        return
                    }

-                    analyticsService?.sendEvent("card-payments:3ds:confirm-payment-source:challenge-required")
+                    analyticsService?.sendEvent("card-payments:confirm-payment-source:challenge-required")


On Android we do have every event related to approveOrder() named with approve-order. Here's an example in CardAnalytics.kt.

Yes, I had opened a PR yesterday to rename these events but closed it and wanted to just clean up things that were mislabeled as "3ds" in this PR. I wanted to hold off other changes until we have alignment in iOS/Android on analytic events.

Sources/CardPayments/CardClient.swift

KunJeongPark · 2024-12-13T15:00:49Z

I am going to go ahead and put draft of changes for iOS here and will confirm with analytics team and Steven before merging. I think it'd be better than having to communicate changes twice.

sshropshire · 2025-01-07T20:38:54Z

Sources/CardPayments/CardClient.swift

@@ -161,25 +157,25 @@ public class CardClient: NSObject {
            context: self,
            sessionDidDisplay: { [weak self] didDisplay in
                if didDisplay {
-                    self?.analyticsService?.sendEvent("card-payments:3ds:challenge-presentation:succeeded")
+                    self?.analyticsService?.sendEvent("card-payments:approve-order:auth-challenge-presentation:succeeded")


Hey I know we went over this in our meeting, but it seems like this event has a different format than <module>:<function>:<event>. Should we rename this to fit the schema?

auth-challenge-presentation-succeeded/failed?

speaking of which, what do you think of end events for 3ds flows being auth-challenge:succeeded/failed/canceled as opposed to auth-challenge-succeeded/failed/canceled.
That way we can grab :succeeded, :failed, :canceled as final events
Let me check our original discussion about this but I personally like idea of :succeeded and :failed :canceled reserved for final events.

I guess that does make looking for events under <module>:<function> for example, messier.

Yeah if we could stick to <module>:<function>:<event> i'd prefer it because it's clean. I prefer auth-challenge-succeeded/failed/canceled. It's verbose but it fits the schema, which makes it regex friendly.

So what do you think about auth-challenge-presentation-succeeded/failed for your first point?

Yeah I think that works well. 👍 for auth-challenge-presentation-succeeded/failed

I'll run it by NN also and make changes on Confluence page.

Hey qq: if we keep this the way it is are we good to merge?

nirvan543 · 2025-01-08T22:13:11Z

Sources/CardPayments/CardClient.swift

        completion(nil, error)
    }

-    private func notifyCheckoutCancelWithError(with error: CoreSDKError, completion: (CardResult?, CoreSDKError?) -> Void) {
-        analyticsService?.sendEvent("card-payments:3ds:challenge:user-canceled")
+    private func notify3dsCheckoutCancelWithError(with error: CoreSDKError, completion: (CardResult?, CoreSDKError?) -> Void) {


Should this method name be notify3dsCheckoutCancel(...) instead? Since the with error is part of the parameter name?

Yes I wanted to be clear that now we are returning cancellation as an error.
Before we just returned didCancel in a separate delegate function.

clean up analytics names

8c99fde

KunJeongPark requested a review from a team as a code owner December 9, 2024 21:02

GMALKHA approved these changes Dec 9, 2024

View reviewed changes

sshropshire reviewed Dec 9, 2024

View reviewed changes

Sources/CardPayments/CardClient.swift Outdated Show resolved Hide resolved

sshropshire approved these changes Dec 10, 2024

View reviewed changes

KunJeongPark added 6 commits December 13, 2024 07:54

card approve analytics changes

a6e9468

card vault analytics changes

fe2f27d

card vault challenge required rename

2695c83

PayPalWebCheckout analytics

98aade7

PayPal vault analytics

fa01848

simplify final success/fail events in PayPal checkout/vault

57d0c51

sshropshire reviewed Jan 7, 2025

View reviewed changes

make : before status

e44f048

sshropshire approved these changes Jan 8, 2025

View reviewed changes

nirvan543 reviewed Jan 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up Analytics Names #313

Clean up Analytics Names #313

KunJeongPark commented Dec 9, 2024 •

edited

Loading

sshropshire Dec 9, 2024

KunJeongPark Dec 9, 2024 •

edited

Loading

KunJeongPark commented Dec 13, 2024 •

edited

Loading

sshropshire Jan 7, 2025

KunJeongPark Jan 7, 2025

KunJeongPark Jan 7, 2025 •

edited

Loading

sshropshire Jan 7, 2025

KunJeongPark Jan 7, 2025

sshropshire Jan 7, 2025

KunJeongPark Jan 7, 2025

sshropshire Jan 8, 2025

nirvan543 Jan 8, 2025

KunJeongPark Jan 8, 2025

Clean up Analytics Names #313

Are you sure you want to change the base?

Clean up Analytics Names #313

Conversation

KunJeongPark commented Dec 9, 2024 • edited Loading

Summary of changes

Checklist

Authors

Choose a reason for hiding this comment

KunJeongPark Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

KunJeongPark commented Dec 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KunJeongPark Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KunJeongPark commented Dec 9, 2024 •

edited

Loading

KunJeongPark Dec 9, 2024 •

edited

Loading

KunJeongPark commented Dec 13, 2024 •

edited

Loading

KunJeongPark Jan 7, 2025 •

edited

Loading