PayPal Native - Play Store Compliance Fix (#977)

* Bump MXO SDK to 1.3.2 and bump Magnes SDK to 5.5.1 * Add hasUserLocationConsent boolean to PayPal Native request classes and pass flag to the MXO SDK and Magnes * Add sections to CHANGELOG.md Co-authored-by: Sarah Koop <skoop@paypal.com> * Update hasUserLocationConsent doc to remove optional Co-authored-by: Sarah Koop <skoop@paypal.com> * Make PayPalNativeRequest constructor package private Co-authored-by: Sarah Koop <skoop@paypal.com> --------- Co-authored-by: Sarah Koop <skoop@paypal.com>
braintree · Apr 16, 2024 · 14e072f · 14e072f
1 parent 3e071c3
commit 14e072f
Show file tree

Hide file tree

Showing 14 changed files with 162 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,17 @@
 
 ## unreleased
 
-* Updated expiring pinned vendor SSL certificates
-* Add `GooglePayClient#tokenize(PaymentData, GooglePayOnActivityResultCallback)` to be invoked after direct Google Play Services integration
+* BraintreeCore
+  * Updated expiring pinned vendor SSL certificates
+* GooglePay
+  * Add `GooglePayClient#tokenize(PaymentData, GooglePayOnActivityResultCallback)` to be invoked after direct Google Play Services integration
+* PayPalNativeCheckout
+  * Bump native-checkout version to `1.3.2`
+  * Fixes Google Play Store Rejection
+    * Add `hasUserLocationConsent` property to `PayPalNativeCheckoutRequest`, `PayPalNativeCheckoutVaultRequest` and `PayPalNativeRequest`
+    * Deprecate existing constructors that do not pass in `hasUserLocationConsent`
+* PayPalDataCollector
+  * Bump Magnes version to `5.5.1`
 
 ## 4.44.0 (2024-04-05)
 

diff --git a/PayPalDataCollector/build.gradle b/PayPalDataCollector/build.gradle
@@ -36,7 +36,7 @@ android {
 }
 
 dependencies {
-    implementation files('libs/android-magnessdk-5.5.0.jar')
+    implementation files('libs/android-magnessdk-5.5.1.jar')
 
     implementation deps.annotation
     api project(':BraintreeCore')

diff --git a/PayPalDataCollector/libs/android-magnessdk-5.5.0.jar b/PayPalDataCollector/libs/android-magnessdk-5.5.0.jar
diff --git a/PayPalDataCollector/libs/android-magnessdk-5.5.1.jar b/PayPalDataCollector/libs/android-magnessdk-5.5.1.jar
diff --git a/PayPalNativeCheckout/build.gradle b/PayPalNativeCheckout/build.gradle
@@ -36,9 +36,7 @@ dependencies {
     implementation deps.appCompat
     implementation project(':PayPalDataCollector')
 
-    implementation('com.paypal.checkout:android-sdk:1.2.1') {
-        exclude group: 'com.paypal.android.sdk', module: 'data-collector'
-    }
+    implementation('com.paypal.checkout:android-sdk:1.3.2')
 
     testImplementation deps.robolectric
     testImplementation deps.jsonAssert

diff --git a/PayPalNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutClient.java b/PayPalNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutClient.java
@@ -218,7 +218,7 @@ private void sendPayPalRequest(
                         createOrderActions.setBillingAgreementId(payPalResponse.getPairingId());
                         braintreeClient.sendAnalyticsEvent("paypal-native.billing-agreement.succeeded", payPalContextId);
                     }
-                });
+                }, payPalRequest.hasUserLocationConsent());
             } else {
                 listener.onPayPalFailure(new Exception(error));
             }

diff --git a/...eCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutInternalClient.java b/...eCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutInternalClient.java
@@ -60,7 +60,7 @@ void sendRequest(final Context context, final PayPalNativeRequest payPalRequest,
                                         String pairingIdKey = isBillingAgreement ? "ba_token" : "token";
                                         String pairingId = parsedRedirectUri.getQueryParameter(pairingIdKey);
                                         String clientMetadataId = payPalRequest.getRiskCorrelationId() != null
-                                                ? payPalRequest.getRiskCorrelationId() : payPalDataCollector.getClientMetadataId(context, configuration, false);
+                                                ? payPalRequest.getRiskCorrelationId() : payPalDataCollector.getClientMetadataId(context, configuration, payPalRequest.hasUserLocationConsent());
 
                                         if (pairingId != null) {
                                             payPalResponse

diff --git a/...alNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutRequest.java b/...alNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutRequest.java
@@ -49,6 +49,8 @@ public class PayPalNativeCheckoutRequest extends PayPalNativeRequest implements
     private boolean shouldOfferPayLater;
 
     /**
+     * Deprecated. Use {@link PayPalNativeCheckoutRequest#PayPalNativeCheckoutRequest(String, boolean)} instead.
+     *
      * @param amount The transaction amount in currency units (as * determined by setCurrencyCode).
      *               For example, "1.20" corresponds to one dollar and twenty cents. Amount must be a non-negative
      *               number, may optionally contain exactly 2 decimal places separated by '.' and is
@@ -58,7 +60,30 @@ public class PayPalNativeCheckoutRequest extends PayPalNativeRequest implements
      *               for mismatches between this client-side amount and the final amount in the Transaction
      *               are determined by the gateway.
      **/
+    @Deprecated
     public PayPalNativeCheckoutRequest(@NonNull String amount) {
+        this(amount, false);
+    }
+
+    /**
+     * @param amount The transaction amount in currency units (as * determined by setCurrencyCode).
+     * For example, "1.20" corresponds to one dollar and twenty cents. Amount must be a non-negative
+     * number, may optionally contain exactly 2 decimal places separated by '.' and is
+     * limited to 7 digits before the decimal point.
+     * <p>
+     * This amount may differ slightly from the transaction amount. The exact decline rules
+     * for mismatches between this client-side amount and the final amount in the Transaction
+     * are determined by the gateway.
+     * @param hasUserLocationConsent is an optional parameter that informs the SDK
+     * if your application has obtained consent from the user to collect location data in compliance with
+     * <a href="https://support.google.com/googleplay/android-developer/answer/10144311#personal-sensitive">Google Play Developer Program policies</a>
+     * This flag enables PayPal to collect necessary information required for Fraud Detection and Risk Management.
+     *
+     * @see <a href="https://support.google.com/googleplay/android-developer/answer/10144311#personal-sensitive">User Data policies for the Google Play Developer Program </a>
+     * @see <a href="https://support.google.com/googleplay/android-developer/answer/9799150?hl=en#Prominent%20in-app%20disclosure">Examples of prominent in-app disclosures</a>
+     **/
+    public PayPalNativeCheckoutRequest(@NonNull String amount, boolean hasUserLocationConsent) {
+        super(hasUserLocationConsent);
         this.amount = amount;
     }
 

diff --git a/...iveCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutVaultRequest.java b/...iveCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutVaultRequest.java
@@ -14,7 +14,25 @@ public class PayPalNativeCheckoutVaultRequest extends PayPalNativeRequest implem
 
     private boolean shouldOfferCredit;
 
+    /**
+     * Deprecated. Use {@link PayPalNativeCheckoutVaultRequest#PayPalNativeCheckoutVaultRequest(boolean)} instead.
+     */
+    @Deprecated
     public PayPalNativeCheckoutVaultRequest() {
+        this(false);
+    }
+
+    /**
+     * @param hasUserLocationConsent informs the SDK
+     * if your application has obtained consent from the user to collect location data in compliance with
+     * <a href="https://support.google.com/googleplay/android-developer/answer/10144311#personal-sensitive">Google Play Developer Program policies</a>
+     * This flag enables PayPal to collect necessary information required for Fraud Detection and Risk Management.
+     *
+     * @see <a href="https://support.google.com/googleplay/android-developer/answer/10144311#personal-sensitive">User Data policies for the Google Play Developer Program </a>
+     * @see <a href="https://support.google.com/googleplay/android-developer/answer/9799150?hl=en#Prominent%20in-app%20disclosure">Examples of prominent in-app disclosures</a>
+     */
+    public PayPalNativeCheckoutVaultRequest(boolean hasUserLocationConsent) {
+        super(hasUserLocationConsent);
     }
 
     /**

diff --git a/PayPalNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeRequest.java b/PayPalNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeRequest.java
@@ -52,13 +52,22 @@ public abstract class PayPalNativeRequest implements Parcelable {
     private final ArrayList<PayPalNativeCheckoutLineItem> lineItems;
     private String returnUrl;
     private String userAuthenticationEmail;
+    private final boolean hasUserLocationConsent;
 
     /**
+     * Deprecated. Use {@link PayPalNativeRequest#PayPalNativeRequest(boolean)} instead.
+     *
      * Constructs a request for PayPal Checkout and Vault flows.
      */
+    @Deprecated
     public PayPalNativeRequest() {
+        this(false);
+    }
+
+    PayPalNativeRequest(boolean hasUserLocationConsent) {
         shippingAddressRequired = false;
         lineItems = new ArrayList<>();
+        this.hasUserLocationConsent = hasUserLocationConsent;
     }
 
     /**
@@ -256,6 +265,9 @@ public ArrayList<PayPalNativeCheckoutLineItem> getLineItems() {
         return lineItems;
     }
 
+    public boolean hasUserLocationConsent() {
+        return hasUserLocationConsent;
+    }
 
     abstract String createRequestBody(Configuration configuration, Authorization authorization, String successUrl, String cancelUrl) throws JSONException;
 
@@ -272,6 +284,7 @@ protected PayPalNativeRequest(Parcel in) {
         lineItems = in.createTypedArrayList(PayPalNativeCheckoutLineItem.CREATOR);
         returnUrl = in.readString();
         userAuthenticationEmail = in.readString();
+        hasUserLocationConsent = in.readByte() != 0;
     }
 
     @Override
@@ -293,5 +306,6 @@ public void writeToParcel(Parcel parcel, int i) {
         parcel.writeTypedList(lineItems);
         parcel.writeString(returnUrl);
         parcel.writeString(userAuthenticationEmail);
+        parcel.writeByte((byte) (hasUserLocationConsent ? 1 : 0));
     }
 }
diff --git a/...NativeCheckout/src/test/java/com/braintreepayments/api/PayPalCheckoutRequestUnitTest.java b/...NativeCheckout/src/test/java/com/braintreepayments/api/PayPalCheckoutRequestUnitTest.java
@@ -19,7 +19,7 @@ public class PayPalCheckoutRequestUnitTest {
 
     @Test
     public void newPayPalCheckoutRequest_setsDefaultValues() {
-        PayPalNativeCheckoutRequest request = new PayPalNativeCheckoutRequest("1.00");
+        PayPalNativeCheckoutRequest request = new PayPalNativeCheckoutRequest("1.00", false);
 
         assertNotNull(request.getAmount());
         assertNull(request.getCurrencyCode());
@@ -29,11 +29,18 @@ public void newPayPalCheckoutRequest_setsDefaultValues() {
         assertEquals(PayPalNativeCheckoutPaymentIntent.AUTHORIZE, request.getIntent());
         assertNull(request.getBillingAgreementDescription());
         assertFalse(request.getShouldOfferPayLater());
+        assertFalse(request.hasUserLocationConsent());
     }
 
     @Test
-    public void setsValuesCorrectly() {
+    public void newPayPalCheckoutRequest_without_hasUserLocationConsent_defaults_to_false() {
         PayPalNativeCheckoutRequest request = new PayPalNativeCheckoutRequest("1.00");
+        assertFalse(request.hasUserLocationConsent());
+    }
+
+    @Test
+    public void setsValuesCorrectly() {
+        PayPalNativeCheckoutRequest request = new PayPalNativeCheckoutRequest("1.00", true);
         request.setCurrencyCode("USD");
         request.setShouldOfferPayLater(true);
         request.setIntent(PayPalNativeCheckoutPaymentIntent.SALE);
@@ -74,11 +81,12 @@ public void setsValuesCorrectly() {
         assertEquals("CA", request.getShippingAddressOverride().getRegion());
         assertEquals("US", request.getShippingAddressOverride().getCountryCodeAlpha2());
         assertTrue(request.getShouldOfferPayLater());
+        assertTrue(request.hasUserLocationConsent());
     }
 
     @Test
     public void parcelsCorrectly() {
-        PayPalNativeCheckoutRequest request = new PayPalNativeCheckoutRequest("12.34");
+        PayPalNativeCheckoutRequest request = new PayPalNativeCheckoutRequest("12.34", true);
         request.setCurrencyCode("USD");
         request.setLocaleCode("en-US");
         request.setBillingAgreementDescription("Billing Agreement Description");
@@ -117,5 +125,6 @@ public void parcelsCorrectly() {
         assertEquals("merchant_account_id", result.getMerchantAccountId());
         assertEquals(1, result.getLineItems().size());
         assertEquals("An Item", result.getLineItems().get(0).getName());
+        assertTrue(result.hasUserLocationConsent());
     }
 }
diff --git a/...iveCheckout/src/test/java/com/braintreepayments/api/PayPalNativeCheckoutClientUnitTest.kt b/...iveCheckout/src/test/java/com/braintreepayments/api/PayPalNativeCheckoutClientUnitTest.kt
@@ -16,10 +16,17 @@ import com.paypal.checkout.error.ErrorInfo
 import com.paypal.checkout.error.OnError
 import com.paypal.checkout.shipping.OnShippingChange
 import com.paypal.pyplcheckout.instrumentation.constants.PEnums
+import com.paypal.pyplcheckout.instrumentation.constants.PEnums.EventCode
+import com.paypal.pyplcheckout.instrumentation.constants.PEnums.Outcome
+import com.paypal.pyplcheckout.instrumentation.constants.PEnums.StateName
+import com.paypal.pyplcheckout.instrumentation.constants.PEnums.TransitionName
 import com.paypal.pyplcheckout.instrumentation.di.PLog
+import com.paypal.pyplcheckout.instrumentation.di.PLog.transition
 import io.mockk.every
+import io.mockk.just
 import io.mockk.mockk
 import io.mockk.mockkStatic
+import io.mockk.runs
 import io.mockk.slot
 import io.mockk.verify
 import junit.framework.TestCase.assertEquals
@@ -45,6 +52,13 @@ class PayPalNativeCheckoutClientUnitTest {
     fun beforeEach() {
         mockkStatic(PayPalCheckout::class)
         mockkStatic(PLog::class)
+        mockkStatic(PayPalCheckout::class)
+
+        every { PayPalCheckout.setConfig(any()) } just runs
+        every { PayPalCheckout.startCheckout(any(), any()) } just runs
+        every {
+           PLog.transition(any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any())
+        } just runs
 
         activity = mockk(relaxed = true)
         listener = mockk(relaxed = true)
@@ -58,7 +72,7 @@ class PayPalNativeCheckoutClientUnitTest {
 
     @Test
     fun tokenizePayPalAccount_throwsWhenPayPalRequestIsBaseClass() {
-        val baseRequest: PayPalNativeRequest = object : PayPalNativeRequest() {
+        val baseRequest: PayPalNativeRequest = object : PayPalNativeRequest(true) {
             @Throws(JSONException::class)
             public override fun createRequestBody(
                 configuration: Configuration,
@@ -86,7 +100,7 @@ class PayPalNativeCheckoutClientUnitTest {
     @Test
     @Ignore("Refactor test to work with mockk")
     fun requestBillingAgreement_launchNativeCheckout_sendsAnalyticsEvents() {
-        val payPalVaultRequest = PayPalNativeCheckoutVaultRequest()
+        val payPalVaultRequest = PayPalNativeCheckoutVaultRequest(true)
         payPalVaultRequest.merchantAccountId = "sample-merchant-account-id"
         payPalVaultRequest.returnUrl = "returnUrl://paypalpay"
         val payPalResponse = PayPalNativeCheckoutResponse(payPalVaultRequest)
@@ -125,7 +139,7 @@ class PayPalNativeCheckoutClientUnitTest {
 
     @Test
     fun requestNativeCheckout_returnsErrorFromFailedResponse() {
-        val payPalVaultRequest = PayPalNativeCheckoutVaultRequest()
+        val payPalVaultRequest = PayPalNativeCheckoutVaultRequest(true)
         payPalVaultRequest.merchantAccountId = "sample-merchant-account-id"
         payPalVaultRequest.returnUrl = "returnUrl://paypalpay"
         val payPalInternalClient = MockkPayPalInternalClientBuilder()
@@ -144,7 +158,7 @@ class PayPalNativeCheckoutClientUnitTest {
     @Ignore("Refactor test to work with mockk")
     @Suppress("LongMethod")
     fun requestOneTimePayment_launchNativeCheckout_sendsAnalyticsEvents() {
-        val payPalCheckoutRequest = PayPalNativeCheckoutRequest("1.00")
+        val payPalCheckoutRequest = PayPalNativeCheckoutRequest("1.00", true)
         payPalCheckoutRequest.intent = "authorize"
         payPalCheckoutRequest.merchantAccountId = "sample-merchant-account-id"
         payPalCheckoutRequest.returnUrl = "returnUrl://paypalpay"
@@ -235,7 +249,7 @@ class PayPalNativeCheckoutClientUnitTest {
     fun paypalAccount_isSetupCorrectly() {
         val riskCorrelationId = "riskId"
         val sampleMerchantId = "sample-merchant-account-id"
-        val payPalCheckoutRequest = PayPalNativeCheckoutRequest("1.00")
+        val payPalCheckoutRequest = PayPalNativeCheckoutRequest("1.00", true)
         payPalCheckoutRequest.intent = "authorize"
         payPalCheckoutRequest.merchantAccountId = sampleMerchantId
         payPalCheckoutRequest.returnUrl = "returnUrl://paypalpay"
@@ -259,7 +273,7 @@ class PayPalNativeCheckoutClientUnitTest {
     @Throws(Exception::class)
     @Ignore("Refactor test to work with mockk")
     fun requestOneTimePayment_sendsBrowserSwitchStartAnalyticsEvent() {
-        val payPalCheckoutRequest = PayPalNativeCheckoutRequest("1.00")
+        val payPalCheckoutRequest = PayPalNativeCheckoutRequest("1.00", true)
         payPalCheckoutRequest.intent = "authorize"
         payPalCheckoutRequest.merchantAccountId = "sample-merchant-account-id"
         payPalCheckoutRequest.returnUrl = "returnUrl://paypalpay"
@@ -300,7 +314,7 @@ class PayPalNativeCheckoutClientUnitTest {
         val braintreeClient = MockkBraintreeClientBuilder().build()
         val payPalInternalClient = MockkPayPalInternalClientBuilder().build()
         val sut = PayPalNativeCheckoutClient(braintreeClient, payPalInternalClient)
-        val request = PayPalNativeCheckoutRequest("1.00")
+        val request = PayPalNativeCheckoutRequest("1.00", true)
         request.shouldOfferPayLater = true
         sut.tokenizePayPalAccount(activity, request)
         verify { braintreeClient.sendAnalyticsEvent("paypal-native.single-payment.paylater.offered") }
@@ -313,7 +327,7 @@ class PayPalNativeCheckoutClientUnitTest {
         val braintreeClient = MockkBraintreeClientBuilder()
             .configurationSuccess(payPalEnabledConfig)
             .build()
-        val payPalRequest = PayPalNativeCheckoutVaultRequest()
+        val payPalRequest = PayPalNativeCheckoutVaultRequest(true)
         val sut = PayPalNativeCheckoutClient(braintreeClient, payPalInternalClient)
         sut.tokenizePayPalAccount(activity, payPalRequest)
         verify { payPalInternalClient.sendRequest(activity, payPalRequest, any()) }
@@ -326,7 +340,7 @@ class PayPalNativeCheckoutClientUnitTest {
         val braintreeClient = MockkBraintreeClientBuilder()
             .configurationSuccess(payPalEnabledConfig)
             .build()
-        val payPalRequest = PayPalNativeCheckoutRequest("1.00")
+        val payPalRequest = PayPalNativeCheckoutRequest("1.00", true)
         val sut = PayPalNativeCheckoutClient(braintreeClient, payPalInternalClient)
         sut.tokenizePayPalAccount(activity, payPalRequest)
         verify { payPalInternalClient.sendRequest(activity, payPalRequest, any()) }
@@ -337,7 +351,7 @@ class PayPalNativeCheckoutClientUnitTest {
     fun tokenizePayPalAccount_sendsPayPalCreditOfferedAnalyticsEvent() {
         val payPalInternalClient = MockkPayPalInternalClientBuilder().build()
         val braintreeClient = MockkBraintreeClientBuilder().build()
-        val payPalRequest = PayPalNativeCheckoutVaultRequest()
+        val payPalRequest = PayPalNativeCheckoutVaultRequest(true)
         payPalRequest.shouldOfferCredit = true
         val sut = PayPalNativeCheckoutClient(braintreeClient, payPalInternalClient)
         sut.tokenizePayPalAccount(activity, payPalRequest)
@@ -346,7 +360,7 @@ class PayPalNativeCheckoutClientUnitTest {
 
     @Test
     fun launchNativeCheckout_notifiesErrorWhenPayPalRequestIsBaseClass_sendsAnalyticsEvents() {
-        val baseRequest: PayPalNativeRequest = object : PayPalNativeRequest() {
+        val baseRequest: PayPalNativeRequest = object : PayPalNativeRequest(true) {
             @Throws(JSONException::class)
             public override fun createRequestBody(
                 configuration: Configuration,
@@ -369,4 +383,24 @@ class PayPalNativeCheckoutClientUnitTest {
         verify { braintreeClient.sendAnalyticsEvent("paypal-native.tokenize.started") }
         verify { braintreeClient.sendAnalyticsEvent("paypal-native.tokenize.invalid-request.failed") }
     }
+
+    @Test
+    fun `when launchNativeCheckout is called, hasUserLocationConsent is sent to PayPalCheckout startCheckout`() {
+        val request = PayPalNativeCheckoutVaultRequest(true)
+        request.returnUrl = "returnUrl://paypalpay"
+
+        val braintreeClient = MockkBraintreeClientBuilder()
+            .configurationSuccess(payPalEnabledConfig)
+            .build()
+        val payPalResponse = PayPalNativeCheckoutResponse(request)
+            .clientMetadataId("sample-client-metadata-id")
+        val payPalInternalClient = MockkPayPalInternalClientBuilder()
+            .sendRequestSuccess(payPalResponse)
+            .build()
+        val sut = PayPalNativeCheckoutClient(braintreeClient, payPalInternalClient)
+
+        sut.launchNativeCheckout(activity, request)
+
+        verify { PayPalCheckout.startCheckout(any(), true) }
+    }
 }