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.

Sign up for GitHub

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

Update Venmo with FPTI Analytics Events #846

Merged
merged 9 commits into from
Dec 11, 2023
Merged

Update Venmo with FPTI Analytics Events #846

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1f37c59
Replace Venmo analytics with FPTI events
sarahkoop Dec 7, 2023
e13dc5d
Update unit tests
sarahkoop Dec 7, 2023
c722c9d
Add new unit tests
sarahkoop Dec 7, 2023
5bb6ce5
Fix unit tests
sarahkoop Dec 7, 2023
7a9fec8
Convert VenmoAnalytics to class
sarahkoop Dec 7, 2023
2d5cfe0
Remove companion object
sarahkoop Dec 7, 2023
ef8b821
Add helper analtyics methods
sarahkoop Dec 7, 2023
8de3d07
Update app switch failure analytics
sarahkoop Dec 11, 2023
de18ecd
Remove extra analytics event
sarahkoop Dec 11, 2023
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
14 changes: 7 additions & 7 deletions Venmo/src/main/java/com/braintreepayments/api/VenmoAnalytics.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
package com.braintreepayments.api

internal enum class VenmoAnalytics(@JvmField val event: String) {
internal object VenmoAnalytics {

// Conversion Events
TOKENIZE_STARTED("venmo:tokenize:started"),
TOKENIZE_FAILED("venmo:tokenize:failed"),
TOKENIZE_SUCCEEDED("venmo:tokenize:succeeded"),
APP_SWITCH_CANCELED("venmo:tokenize:app-switch:canceled"),
const val TOKENIZE_STARTED = "venmo:tokenize:started"
const val TOKENIZE_FAILED = "venmo:tokenize:failed"
const val TOKENIZE_SUCCEEDED = "venmo:tokenize:succeeded"
const val APP_SWITCH_CANCELED = "venmo:tokenize:app-switch:canceled"

// Additional Detail Events
APP_SWITCH_SUCCEEDED("venmo:tokenize:app-switch:succeeded"),
APP_SWITCH_FAILED("venmo:tokenize:app-switch:failed")
const val APP_SWITCH_SUCCEEDED = "venmo:tokenize:app-switch:succeeded"
const val APP_SWITCH_FAILED = "venmo:tokenize:app-switch:failed"
}
86 changes: 47 additions & 39 deletions Venmo/src/main/java/com/braintreepayments/api/VenmoClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,25 +80,21 @@ public void showVenmoInGooglePlayStore(@NonNull FragmentActivity activity) {
public void createPaymentAuthRequest(@NonNull final FragmentActivity activity,
@NonNull final VenmoRequest request,
@NonNull VenmoPaymentAuthRequestCallback callback) {
braintreeClient.sendAnalyticsEvent("pay-with-venmo.selected");
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.TOKENIZE_STARTED);
braintreeClient.getConfiguration((configuration, error) -> {
if (configuration == null && error != null) {
callback.onVenmoPaymentAuthRequest(new VenmoPaymentAuthRequest.Failure(error));
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.failed");
callbackPaymentAuthFailure(callback, new VenmoPaymentAuthRequest.Failure(error));
return;
}

String exceptionMessage = null;
if (!configuration.isVenmoEnabled()) {
exceptionMessage = "Venmo is not enabled";
} else if (!deviceInspector.isVenmoAppSwitchAvailable(activity)) {
exceptionMessage = "Venmo is not installed";
callbackPaymentAuthFailure(callback,
new VenmoPaymentAuthRequest.Failure(new AppSwitchNotAvailableException("Venmo is not enabled")));
return;
}

if (exceptionMessage != null) {
callback.onVenmoPaymentAuthRequest(
new VenmoPaymentAuthRequest.Failure(new AppSwitchNotAvailableException(exceptionMessage)));
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.failed");
if (!deviceInspector.isVenmoAppSwitchAvailable(activity)) {
callbackPaymentAuthAppSwitchFailure(callback,
new VenmoPaymentAuthRequest.Failure(new AppSwitchNotAvailableException("Venmo is not installed")));
return;
}

Expand All @@ -107,10 +103,9 @@ public void createPaymentAuthRequest(@NonNull final FragmentActivity activity,
if ((request.getCollectCustomerShippingAddress() ||
request.getCollectCustomerBillingAddress()) &&
!configuration.getVenmoEnrichedCustomerDataEnabled()) {
callback.onVenmoPaymentAuthRequest(new VenmoPaymentAuthRequest.Failure(new BraintreeException(
callbackPaymentAuthFailure(callback, new VenmoPaymentAuthRequest.Failure(new BraintreeException(
"Cannot collect customer data when ECD is disabled. Enable this feature " +
"in the Control Panel to collect this data.")));
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.failed");
return;
}

Expand All @@ -127,8 +122,7 @@ public void createPaymentAuthRequest(@NonNull final FragmentActivity activity,
braintreeClient.getAuthorization(), finalVenmoProfileId,
paymentContextId, callback);
} else {
callback.onVenmoPaymentAuthRequest(new VenmoPaymentAuthRequest.Failure(exception));
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.failed");
callbackPaymentAuthFailure(callback, new VenmoPaymentAuthRequest.Failure(exception));
}
});
});
Expand All @@ -150,7 +144,6 @@ private void createPaymentAuthRequest(
new VenmoPaymentAuthRequestParams(configuration, venmoProfileId, paymentContextId,
braintreeClient.getSessionId(), braintreeClient.getIntegrationType());
callback.onVenmoPaymentAuthRequest(new VenmoPaymentAuthRequest.ReadyToLaunch(params));
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.started");
}

/**
Expand All @@ -166,7 +159,7 @@ private void createPaymentAuthRequest(
public void tokenize(@NonNull final VenmoPaymentAuthResult venmoPaymentAuthResult,
@NonNull VenmoTokenizeCallback callback) {
if (venmoPaymentAuthResult.getError() == null) {
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.success");
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.APP_SWITCH_SUCCEEDED);

final boolean isClientTokenAuth = (braintreeClient.getAuthorization() instanceof ClientToken);

Expand All @@ -181,20 +174,16 @@ public void tokenize(@NonNull final VenmoPaymentAuthResult venmoPaymentAuthResul
vaultVenmoAccountNonce(nonce.getString(),
(venmoAccountNonce, vaultError) -> {
if (venmoAccountNonce != null) {
callback.onVenmoResult(new VenmoResult.Success(venmoAccountNonce));
callbackSuccess(callback, new VenmoResult.Success(venmoAccountNonce));
} else if (vaultError != null) {
callback.onVenmoResult(new VenmoResult.Failure(vaultError));
callbackTokenizeFailure(callback, new VenmoResult.Failure(vaultError));
}
});
} else {
braintreeClient.sendAnalyticsEvent(
"pay-with-venmo.app-switch.failure");
callback.onVenmoResult(new VenmoResult.Success(nonce));
callbackSuccess(callback, new VenmoResult.Success(nonce));
}
} else if (error != null) {
braintreeClient.sendAnalyticsEvent(
"pay-with-venmo.app-switch.failure");
callback.onVenmoResult(new VenmoResult.Failure(error));
callbackTokenizeFailure(callback, new VenmoResult.Failure(error));
}
});
} else {
Expand All @@ -205,36 +194,30 @@ public void tokenize(@NonNull final VenmoPaymentAuthResult venmoPaymentAuthResul
if (shouldVault && isClientTokenAuth) {
vaultVenmoAccountNonce(nonce, (venmoAccountNonce, error) -> {
if (venmoAccountNonce != null) {
callback.onVenmoResult(new VenmoResult.Success(venmoAccountNonce));
callbackSuccess(callback, new VenmoResult.Success(venmoAccountNonce));
} else if (error != null) {
callback.onVenmoResult(new VenmoResult.Failure(error));
callbackTokenizeFailure(callback, new VenmoResult.Failure(error));
}
});
} else {
String venmoUsername = venmoPaymentAuthResult.getVenmoUsername();
VenmoAccountNonce venmoAccountNonce =
new VenmoAccountNonce(nonce, venmoUsername, false);
callback.onVenmoResult(new VenmoResult.Success(venmoAccountNonce));
callbackSuccess(callback, new VenmoResult.Success(venmoAccountNonce));
}

}
} else if (venmoPaymentAuthResult.getError() != null) {
if (venmoPaymentAuthResult.getError() instanceof UserCanceledException) {
braintreeClient.sendAnalyticsEvent("pay-with-venmo.app-switch.canceled");
callbackTokenizeCancel(callback);
} else {
callbackTokenizeFailure(callback, new VenmoResult.Failure(venmoPaymentAuthResult.getError()));
}
callback.onVenmoResult(VenmoResult.Cancel.INSTANCE);
}
}

private void vaultVenmoAccountNonce(String nonce, final VenmoInternalCallback callback) {
venmoApi.vaultVenmoAccountNonce(nonce, (venmoAccountNonce, error) -> {
if (venmoAccountNonce != null) {
braintreeClient.sendAnalyticsEvent("pay-with-venmo.vault.success");
} else {
braintreeClient.sendAnalyticsEvent("pay-with-venmo.vault.failed");
}
callback.onResult(venmoAccountNonce, error);
});
venmoApi.vaultVenmoAccountNonce(nonce, (venmoAccountNonce, error) -> callback.onResult(venmoAccountNonce, error));
}

/**
Expand Down Expand Up @@ -270,4 +253,29 @@ public void isReadyToPay(final Context context, final VenmoIsReadyToPayCallback
}
});
}

private void callbackPaymentAuthAppSwitchFailure(VenmoPaymentAuthRequestCallback callback, VenmoPaymentAuthRequest request) {
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.APP_SWITCH_FAILED);
callback.onVenmoPaymentAuthRequest(request);
}

private void callbackPaymentAuthFailure(VenmoPaymentAuthRequestCallback callback, VenmoPaymentAuthRequest request) {
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.TOKENIZE_FAILED);
callback.onVenmoPaymentAuthRequest(request);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

If the app switch fails, I think we want that to count as a holistic "tokenize_failed", right? For that case on iOS we did this, and send both a "conversion" event (tokenize_failed) + the "extra details" event (app_switch_failed).

This way we can use the "conversion" event of tokenize_failed to capture all failures, to use to measure against the total # of "start" events.

Though we went back and forth a few times on this with iOS, so definitely down to talk through this and come up with a pattern that makes sense across both.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok agreed I think that makes sense - updated the app switch failure to send both the conversion analytic event and the app switch failure one. I agree with that approach for all the events 👍


private void callbackSuccess(VenmoTokenizeCallback callback, VenmoResult venmoResult) {
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.TOKENIZE_SUCCEEDED);
callback.onVenmoResult(venmoResult);
}

private void callbackTokenizeCancel(VenmoTokenizeCallback callback) {
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.APP_SWITCH_CANCELED);
callback.onVenmoResult(VenmoResult.Cancel.INSTANCE);
}

private void callbackTokenizeFailure(VenmoTokenizeCallback callback, VenmoResult venmoResult) {
braintreeClient.sendAnalyticsEvent(VenmoAnalytics.TOKENIZE_FAILED);
callback.onVenmoResult(venmoResult);
}
}
12 changes: 6 additions & 6 deletions Venmo/src/test/java/com/braintreepayments/api/VenmoAnalyticsUnitTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ class VenmoAnalyticsUnitTest {
fun testAnalyticsEvents_sendsExpectedEventNames() {
assertEquals(
"venmo:tokenize:app-switch:canceled",
VenmoAnalytics.APP_SWITCH_CANCELED.event
VenmoAnalytics.APP_SWITCH_CANCELED
)
assertEquals(
"venmo:tokenize:app-switch:failed",
VenmoAnalytics.APP_SWITCH_FAILED.event
VenmoAnalytics.APP_SWITCH_FAILED
)
assertEquals(
"venmo:tokenize:app-switch:succeeded",
VenmoAnalytics.APP_SWITCH_SUCCEEDED.event
VenmoAnalytics.APP_SWITCH_SUCCEEDED
)
assertEquals("venmo:tokenize:failed", VenmoAnalytics.TOKENIZE_FAILED.event)
assertEquals("venmo:tokenize:started", VenmoAnalytics.TOKENIZE_STARTED.event)
assertEquals("venmo:tokenize:succeeded", VenmoAnalytics.TOKENIZE_SUCCEEDED.event)
assertEquals("venmo:tokenize:failed", VenmoAnalytics.TOKENIZE_FAILED)
assertEquals("venmo:tokenize:started", VenmoAnalytics.TOKENIZE_STARTED)
assertEquals("venmo:tokenize:succeeded", VenmoAnalytics.TOKENIZE_SUCCEEDED)
}
}
Loading
Loading