Merge branch 'main' into shipping-callback-feature

Author: jaxdesmarais

CHANGELOG.md

@@ -2,7 +2,10 @@
 
 ## unreleased
 * BraintreePayPal
+  * Fix bug to ensure that `BTPayPalVaultRequest.userAuthenticationEmail` is not sent as an empty string
   * Add `shippingCallbackURL` to `BTPayPalCheckoutRequest`
+* BraintreeThreeDSecure
+  * Return error if no `dfReferenceId` is returned in the 3D Secure flow
 
 ## 6.25.0 (2024-12-11)
 * BraintreePayPal

Demo/Demo.xcodeproj/xcshareddata/xcschemes/Demo.xcscheme

@@ -262,6 +262,16 @@
                ReferencedContainer = "container:../Braintree.xcodeproj">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "8046983D2B27C5530090878E"
+               BuildableName = "BraintreeShopperInsightsTests.xctest"
+               BlueprintName = "BraintreeShopperInsightsTests"
+               ReferencedContainer = "container:../Braintree.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

Sources/BraintreePayPal/BTPayPalVaultRequest.swift

@@ -68,7 +68,7 @@ import BraintreeCore
     ) -> [String: Any] {
         var baseParameters = super.parameters(with: configuration)
 
-        if let userAuthenticationEmail {
+        if let userAuthenticationEmail, !userAuthenticationEmail.isEmpty {
             baseParameters["payer_email"] = userAuthenticationEmail
         }
 

Sources/BraintreeThreeDSecure/BTThreeDSecureClient.swift

@@ -250,9 +250,16 @@ import BraintreeCore
                     request: request,
                     cardinalSession: cardinalSession
                 ) { lookupParameters in
-                    if let dfReferenceID = lookupParameters?["dfReferenceId"] {
-                        request.dfReferenceID = dfReferenceID
+                    guard let dfReferenceID = lookupParameters?["dfReferenceId"], !dfReferenceID.isEmpty else {
+                        completion(
+                            BTThreeDSecureError.failedLookup(
+                                [NSLocalizedDescriptionKey: "There was an error retrieving the dfReferenceId."]
+                            )
+                        )
+                        return
                     }
+
+                    request.dfReferenceID = dfReferenceID
                     completion(nil)
                 }
             } else {

UnitTests/BraintreeThreeDSecureTests/BTThreeDSecureClient_Tests.swift

@@ -10,7 +10,9 @@ class BTThreeDSecureClient_Tests: XCTestCase {
     var threeDSecureRequest = BTThreeDSecureRequest()
     var client: BTThreeDSecureClient!
     var mockThreeDSecureRequestDelegate : MockThreeDSecureRequestDelegate!
-    
+
+    let mockCardinalSession = MockCardinalSession()
+
     let mockConfiguration = BTJSON(value: [
         "threeDSecure": ["cardinalAuthenticationJWT": "FAKE_JWT"],
         "assetsUrl": "http://assets.example.com"
@@ -21,7 +23,7 @@ class BTThreeDSecureClient_Tests: XCTestCase {
         threeDSecureRequest.amount = 10.0
         threeDSecureRequest.nonce = "fake-card-nonce"
         client = BTThreeDSecureClient(apiClient: mockAPIClient)
-        client.cardinalSession = MockCardinalSession()
+        client.cardinalSession = mockCardinalSession
         mockThreeDSecureRequestDelegate = MockThreeDSecureRequestDelegate()
     }
 
@@ -689,4 +691,20 @@ class BTThreeDSecureClient_Tests: XCTestCase {
 
         waitForExpectations(timeout: 1)
     }
+
+    func testPrepareLookup_whenDfReferenceIDEmpty_throwsError() {
+        mockAPIClient.cannedConfigurationResponseBody = mockConfiguration
+        mockCardinalSession.dfReferenceID = ""
+
+        let expectation = expectation(description: "willCallCompletion")
+
+        threeDSecureRequest.nonce = "fake-card-nonce"
+
+        client.prepareLookup(threeDSecureRequest) { _, error in
+            XCTAssertEqual(error?.localizedDescription, "There was an error retrieving the dfReferenceId.")
+            expectation.fulfill()
+        }
+
+        waitForExpectations(timeout: 1)
+    }
 }

UnitTests/BraintreeThreeDSecureTests/MockCardinalSession.swift

@@ -3,7 +3,9 @@ import CardinalMobile
 @testable import BraintreeThreeDSecure
 
 class MockCardinalSession: CardinalSessionTestable {
-    
+
+    var dfReferenceID = "fake-df-reference-id"
+
     func configure(_ sessionConfig: CardinalSessionConfiguration) {
         // do nothing
     }
@@ -13,7 +15,7 @@ class MockCardinalSession: CardinalSessionTestable {
         completed didCompleteHandler: @escaping CardinalSessionSetupDidCompleteHandler,
         validated didValidateHandler: @escaping CardinalSessionSetupDidValidateHandler
     ) {
-        didCompleteHandler("fake-df-reference-id")
+        didCompleteHandler(dfReferenceID)
     }
 
     func continueWith(transactionId: String, payload: String, validationDelegate: CardinalValidationDelegate) {