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

Bug Fix: Handle Missing 3DS dfReferenceId #1255

Merged
merged 4 commits into from
Jan 14, 2025
+39 −43
Merged

Bug Fix: Handle Missing 3DS dfReferenceId #1255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0615075
update logic to handle missing dfReferenceId
jaxdesmarais Jan 14, 2025
6b37dda
add unit test for empty dfReferenceId; remove now inaccurate test
jaxdesmarais Jan 14, 2025
aaf84cd
add CHANGELOG entry
jaxdesmarais Jan 14, 2025
33b4898
Update ThreeDSecure/src/main/java/com/braintreepayments/api/threedsec…
jaxdesmarais Jan 14, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

* PayPal
* Fix bug to ensure that `PayPalVaultRequest.userAuthenticationEmail` is not sent as an empty string
* ThreeDSecure
* Return error if no `dfReferenceId` is returned in the 3D Secure flow

## 5.3.0 (2024-12-11)

Expand Down
14 changes: 10 additions & 4 deletions ThreeDSecure/src/main/java/com/braintreepayments/api/threedsecure/ThreeDSecureClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,17 @@ class ThreeDSecureClient internal constructor(
configuration,
request
) { consumerSessionId: String?, _ ->
if (consumerSessionId != null) {
try {
if (!consumerSessionId.isNullOrEmpty()) {
lookupJSON.put("dfReferenceId", consumerSessionId)
} catch (ignored: JSONException) {
}
} else {
callbackPrepareLookupFailure(
callback,
ThreeDSecurePrepareLookupResult.Failure(
BraintreeException("There was an error retrieving the dfReferenceId.")
)
)

return@initialize
}
braintreeClient.sendAnalyticsEvent(ThreeDSecureAnalytics.LOOKUP_SUCCEEDED)
callback.onPrepareLookupResult(
Expand Down
66 changes: 27 additions & 39 deletions ...cure/src/test/java/com/braintreepayments/api/threedsecure/ThreeDSecureClientUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,9 @@ public void prepareLookup_returnsValidLookupJSONString()
}

@Test
public void prepareLookup_returnsValidLookupJSONString_whenCardinalSetupFails()
throws JSONException, BraintreeException {
public void prepareLookup_initializesCardinal() throws BraintreeException {
CardinalClient cardinalClient = new MockCardinalClientBuilder()
.error(new Exception("cardinal error"))
.successReferenceId("fake-df")
.build();

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
Expand All @@ -148,32 +147,16 @@ public void prepareLookup_returnsValidLookupJSONString_whenCardinalSetupFails()
ThreeDSecurePrepareLookupCallback callback = mock(ThreeDSecurePrepareLookupCallback.class);
sut.prepareLookup(activity, basicRequest, callback);

ArgumentCaptor<ThreeDSecurePrepareLookupResult> captor = ArgumentCaptor.forClass(ThreeDSecurePrepareLookupResult.class);
verify(callback).onPrepareLookupResult(captor.capture());

ThreeDSecurePrepareLookupResult prepareLookupResult = captor.getValue();
assertTrue(prepareLookupResult instanceof ThreeDSecurePrepareLookupResult.Success);
assertSame(basicRequest, ((ThreeDSecurePrepareLookupResult.Success) prepareLookupResult).getRequest());

String clientData = ((ThreeDSecurePrepareLookupResult.Success) prepareLookupResult).getClientData();
JSONObject lookup = new JSONObject(clientData);
Assert.assertEquals("encoded_auth_fingerprint",
lookup.getString("authorizationFingerprint"));
Assert.assertEquals(lookup.getString("braintreeLibraryVersion"),
"Android-" + com.braintreepayments.api.core.BuildConfig.VERSION_NAME);
Assert.assertEquals(lookup.getString("nonce"), "a-nonce");
assertFalse(lookup.has("dfReferenceId"));

JSONObject clientMetaData = lookup.getJSONObject("clientMetadata");
Assert.assertEquals(clientMetaData.getString("requestedThreeDSecureVersion"), "2");
Assert.assertEquals(clientMetaData.getString("sdkVersion"),
"Android/" + com.braintreepayments.api.core.BuildConfig.VERSION_NAME);
verify(cardinalClient).initialize(same(activity), same(threeDSecureEnabledConfig),
same(basicRequest), any(CardinalInitializeCallback.class));
}

@Test
public void prepareLookup_initializesCardinal() throws BraintreeException {
public void prepareLookup_whenCardinalClientInitializeFails_forwardsError()
throws BraintreeException {
BraintreeException initializeRuntimeError = new BraintreeException("initialize error");
CardinalClient cardinalClient = new MockCardinalClientBuilder()
.successReferenceId("fake-df")
.initializeRuntimeError(initializeRuntimeError)
.build();

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
Expand All @@ -190,27 +173,28 @@ public void prepareLookup_initializesCardinal() throws BraintreeException {
ThreeDSecurePrepareLookupCallback callback = mock(ThreeDSecurePrepareLookupCallback.class);
sut.prepareLookup(activity, basicRequest, callback);

verify(cardinalClient).initialize(same(activity), same(threeDSecureEnabledConfig),
same(basicRequest), any(CardinalInitializeCallback.class));
ArgumentCaptor<ThreeDSecurePrepareLookupResult> captor = ArgumentCaptor.forClass(ThreeDSecurePrepareLookupResult.class);
verify(callback).onPrepareLookupResult(captor.capture());
ThreeDSecurePrepareLookupResult prepareLookupResult = captor.getValue();
assertTrue(prepareLookupResult instanceof ThreeDSecurePrepareLookupResult.Failure);
assertEquals(initializeRuntimeError, ((ThreeDSecurePrepareLookupResult.Failure) prepareLookupResult).getError());
}

@Test
public void prepareLookup_whenCardinalClientInitializeFails_forwardsError()
throws BraintreeException {
BraintreeException initializeRuntimeError = new BraintreeException("initialize error");
public void prepareLookup_whenDfReferenceIdMissing_forwardsError() throws BraintreeException {
CardinalClient cardinalClient = new MockCardinalClientBuilder()
.initializeRuntimeError(initializeRuntimeError)
.build();
.successReferenceId("")
.build();

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(threeDSecureEnabledConfig)
.build();
.configuration(threeDSecureEnabledConfig)
.build();

ThreeDSecureClient sut = new ThreeDSecureClient(
braintreeClient,
cardinalClient,
new ThreeDSecureAPI(braintreeClient),
merchantRepository
braintreeClient,
cardinalClient,
new ThreeDSecureAPI(braintreeClient),
merchantRepository
);

ThreeDSecurePrepareLookupCallback callback = mock(ThreeDSecurePrepareLookupCallback.class);
Expand All @@ -220,7 +204,11 @@ public void prepareLookup_whenCardinalClientInitializeFails_forwardsError()
verify(callback).onPrepareLookupResult(captor.capture());
ThreeDSecurePrepareLookupResult prepareLookupResult = captor.getValue();
assertTrue(prepareLookupResult instanceof ThreeDSecurePrepareLookupResult.Failure);
assertEquals(initializeRuntimeError, ((ThreeDSecurePrepareLookupResult.Failure) prepareLookupResult).getError());
Exception error = ((ThreeDSecurePrepareLookupResult.Failure) prepareLookupResult).getError();

TestCase.assertTrue(error instanceof BraintreeException);
Assert.assertEquals(error.getMessage(),
"There was an error retrieving the dfReferenceId.");
}

@Test
Expand Down
Loading