[WOOMOB-302][Mobile Payments] Update Stripe's SDK to 4.3.1 #13970

toupper · 2025-04-24T15:19:10Z

Description

With this PR we update the Stripe SDK to 4.3.1, handling the breaking changes it brings. The main changes we had to adapt are:

Renaming: LocalMobile and COTS have been renamed to Tap to Pay. I also followed this pattern in our code to align with the new Stripe nomenclature and make it clearer.
TerminalException.TerminalErrorCode is moved to a standalone enum TerminalErrorCode.
They consolidated the reader disconnect callbacks for all reader types by removing TerminalListener::onUnexpectedReaderDisconnect. We implement onDisconnect on MobileReaderListener, TapToPayReaderListener listeners to be informed of their corresponding reader disconnects.
The new TapToPayConnectionConfiguration now requires a listener, so I implemented it (TapToPayReaderListenerImpl). As we didn't have any related logic before, it only logs events.
ReaderListener is renamed to MobileReaderListener
Terminal::processPayment returns now a cancelable, so we handle it.

For an exhaustive list check the migration guide and changelog

Steps to reproduce

Try both IPP and TTP flows

Important: TTP with a card can be tested only on the real device in the release builds!

Testing information

See above.

The tests that have been performed

See above.

Images/gif

N/A

I have considered if this change warrants release notes and have added them to RELEASE-NOTES.txt if necessary. Use the "[Internal]" label for non-user-facing changes.

Reviewer (or Author, in the case of optional code reviews):

Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement:

The PR is small and has a clear, single focus, or a valid explanation is provided in the description. If needed, please request to split it into smaller PRs.
Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
Manual Testing: The author listed all the tests they ran, including smoke tests when needed (e.g., for refactorings). The reviewer confirmed that the PR works as expected on big (tablet) and small (phone) in case of UI changes, and no regressions are added.

…reader listeners

…rns a Cancelable.

wpmobilebot · 2025-04-24T15:24:12Z

Project manifest changes for WooCommerce

The following changes in the WooCommerce's merged AndroidManifest.xml file were detected (build variant: vanillaRelease):

--- ./build/reports/diff_manifest/WooCommerce/vanillaRelease/base_manifest.txt	2025-04-25 14:53:05.507914078 +0000
+++ ./build/reports/diff_manifest/WooCommerce/vanillaRelease/head_manifest.txt	2025-04-25 14:53:36.808015058 +0000
@@ -356,9 +356,14 @@
         </service>
 
         <activity
+            android:name="l7ae02aa90bfcbef3f181d5f7.l515457f9dd483c15b2b92380"
+            android:configChanges="orientation|keyboardHidden|screenSize"
+            android:process=":stripetaptopay"
+            android:theme="@style/NoDisplayCutout" />
+        <activity
             android:name="com.stripe.cots.activity.ContactlessPaymentActivity"
             android:exported="false"
-            android:process=":stripelocalmobile"
+            android:process=":stripetaptopay"
             android:theme="@style/Theme.CotsApp" >
             <intent-filter>
                 <action android:name="android.nfc.action.NDEF_DISCOVERED" />
@@ -369,18 +374,23 @@
         <activity
             android:name="com.stripe.cots.simulator.SimulatedContactlessPaymentActivity"
             android:exported="false"
+            android:process=":stripetaptopay"
             android:theme="@style/Theme.CotsApp" />
-        <activity
-            android:name="com.whitecryption.securepin.TuiActivity"
-            android:configChanges="orientation|keyboardHidden|screenSize"
-            android:process=":stripelocalmobile"
-            android:screenOrientation="portrait"
-            android:theme="@style/NoDisplayCutout" />
 
         <service
             android:name="com.stripe.cots.aidlservice.CotsService"
             android:exported="false"
-            android:process=":stripelocalmobile" />
+            android:process=":stripetaptopay" />
+        <service
+            android:name="com.stripe.cots.aidlservice.SimulatedCotsService"
+            android:exported="false"
+            android:process=":stripetaptopay" />
+
+        <provider
+            android:name="com.stripe.cots.content.CotsContentProvider"
+            android:authorities="com.woocommerce.android.stripetaptopay"
+            android:exported="false"
+            android:process=":stripetaptopay" />
 
         <receiver
             android:name="zendesk.support.DeepLinkingBroadcastReceiver"
@@ -570,22 +580,6 @@
         </provider>
 
         <activity
-            android:name="com.stripe.stripeterminal.internal.common.usb.UsbEventReceiverActivity"
-            android:excludeFromRecents="true"
-            android:exported="false"
-            android:label="@string/app_name"
-            android:noHistory="true"
-            android:taskAffinity="com.stripe.stripeterminal.taskAffinityUsbEventReceiver"
-            android:theme="@style/Theme.Transparent" >
-            <intent-filter>
-                <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
-            </intent-filter>
-
-            <meta-data
-                android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
-                android:resource="@xml/usb_device_filter" />
-        </activity>
-        <activity
             android:name="androidx.compose.ui.tooling.PreviewActivity"
             android:exported="true" />
 
@@ -705,6 +699,23 @@
             android:exported="false"
             android:initOrder="200" />
 
+        <activity
+            android:name="com.stripe.stripeterminal.internal.common.usb.UsbEventReceiverActivity"
+            android:excludeFromRecents="true"
+            android:exported="false"
+            android:label="@string/app_name"
+            android:noHistory="true"
+            android:taskAffinity="com.stripe.stripeterminal.taskAffinityUsbEventReceiver"
+            android:theme="@style/Theme.Transparent" >
+            <intent-filter>
+                <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
+            </intent-filter>
+
+            <meta-data
+                android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
+                android:resource="@xml/usb_device_filter" />
+        </activity>
+
         <service
             android:name="androidx.room.MultiInstanceInvalidationService"
             android:directBootAware="true"
@@ -736,14 +747,6 @@
             android:authorities="com.woocommerce.android.com.squareup.picasso"
             android:exported="false" />
 
-        <service
-            android:name="com.google.android.datatransport.runtime.backends.TransportBackendDiscovery"
-            android:exported="false" >
-            <meta-data
-                android:name="backend:com.google.android.datatransport.cct.CctBackendFactory"
-                android:value="cct" />
-        </service>
-
         <receiver
             android:name="androidx.profileinstaller.ProfileInstallReceiver"
             android:directBootAware="false"
@@ -765,6 +768,13 @@
         </receiver>
 
         <service
+            android:name="com.google.android.datatransport.runtime.backends.TransportBackendDiscovery"
+            android:exported="false" >
+            <meta-data
+                android:name="backend:com.google.android.datatransport.cct.CctBackendFactory"
+                android:value="cct" />
+        </service>
+        <service
             android:name="com.google.android.datatransport.runtime.scheduling.jobscheduling.JobInfoSchedulerService"
             android:exported="false"
             android:permission="android.permission.BIND_JOB_SERVICE" >

Go to https://buildkite.com/automattic/woocommerce-android/builds/28754/canvas?sid=01966d6b-e8fb-4049-a247-4bead7c79f3a, click on the Artifacts tab and audit the files.

wpmobilebot · 2025-04-24T15:25:03Z

Project dependencies changes

list

+ New Dependencies
com.stripe:stripeterminal-taptopay:4.3.1

- Removed Dependencies
com.google.android.gms:play-services-safetynet:18.0.1
com.jaredrummler:android-device-names:1.1.9
com.neovisionaries:nv-i18n:1.29
com.stripe:stripeterminal-internal-models:3.7.1
com.stripe:stripeterminal-localmobile:3.7.1

! Upgraded Dependencies
androidx.annotation:annotation:1.9.1, (changed from 1.8.1)
androidx.annotation:annotation-jvm:1.9.1, (changed from 1.8.1)
com.squareup.wire:wire-moshi-adapter:4.9.11, (changed from 4.9.9)
com.squareup.wire:wire-runtime:4.9.11, (changed from 4.9.9)
com.squareup.wire:wire-runtime-jvm:4.9.11, (changed from 4.9.9)
com.stripe:stripeterminal-core:4.3.1, (changed from 3.7.1)
com.stripe:stripeterminal-external:4.3.1, (changed from 3.7.1)
com.stripe:stripeterminal-internal-common:4.3.1, (changed from 3.7.1)
io.reactivex.rxjava3:rxjava:3.1.9, (changed from 3.1.8)
org.jetbrains.kotlin:kotlin-reflect:1.9.25, (changed from 1.9.24)
org.jetbrains.kotlinx:kotlinx-datetime:0.6.1, (changed from 0.6.0)
org.jetbrains.kotlinx:kotlinx-datetime-jvm:0.6.1, (changed from 0.6.0)
org.jetbrains.kotlinx:kotlinx-serialization-bom:1.6.3, (changed from 1.5.1)
org.jetbrains.kotlinx:kotlinx-serialization-core:1.6.3, (changed from 1.5.1)
org.jetbrains.kotlinx:kotlinx-serialization-core-jvm:1.6.3, (changed from 1.5.1)
org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3, (changed from 1.5.1)
org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:1.6.3, (changed from 1.5.1)

⚠️ Project dependencies tree is too large. View it in Buildkite artifacts

wpmobilebot · 2025-04-24T15:30:36Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`5f04514`
	Direct Download	`woocommerce-wear-prototype-build-pr13970-5f04514.apk`

wpmobilebot · 2025-04-24T15:39:00Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`5f04514`
	Direct Download	`woocommerce-prototype-build-pr13970-5f04514.apk`

codecov-commenter · 2025-04-25T15:17:03Z

Codecov Report

Attention: Patch coverage is 45.83333% with 26 lines in your changes missing coverage. Please review.

Project coverage is 38.31%. Comparing base (508c9c6) to head (5f04514).

Files with missing lines	Patch %	Lines
.../internal/connection/TapToPayReaderListenerImpl.kt	0.00%	10 Missing ⚠️
...ardreader/internal/connection/ConnectionManager.kt	44.44%	4 Missing and 1 partial ⚠️
.../internal/payments/actions/ProcessPaymentAction.kt	57.14%	2 Missing and 1 partial ⚠️
...rce/android/cardreader/CardReaderManagerFactory.kt	0.00%	2 Missing ⚠️
...internal/connection/BluetoothReaderListenerImpl.kt	0.00%	2 Missing ⚠️
...id/cardreader/internal/wrappers/TerminalWrapper.kt	0.00%	2 Missing ⚠️
...manuals/CardReaderManualsSupportedReadersMapper.kt	0.00%	0 Missing and 1 partial ⚠️
...reader/internal/connection/TerminalListenerImpl.kt	50.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #13970      +/-   ##
============================================
- Coverage     38.32%   38.31%   -0.01%     
+ Complexity     9474     9473       -1     
============================================
  Files          2113     2114       +1     
  Lines        116202   116223      +21     
  Branches      14869    14871       +2     
============================================
  Hits          44529    44529              
- Misses        67613    67632      +19     
- Partials       4060     4062       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

samiuelson

Thanks @toupper for tackling this task!

I tested the PR on physical devices, running jalapenoRelease build variant. My observations:

✅ Tap To Pay works fine

❓ Unexpected behavior in card reader flow in store management. In case reader is disconnected, when collecting payment with card reader, during reader connection flow the "We couldn't connect your reader" error dialog is displayed for a few seconds. If I let it wait, the reader connected successfully and payment was collected.

logs:

2025-04-28 14:12:44.868  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onConnectionStatusChange: DISCOVERING
2025-04-28 14:12:45.451  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onConnectionStatusChange: NOT_CONNECTED
2025-04-28 14:12:45.452  4018-4018  WooCommerce-CARD_READER com.woocommerce.android.prealpha     E  Connecting to reader failed.
2025-04-28 14:12:45.452  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onConnectionStatusChange: CONNECTING
2025-04-28 14:12:49.157  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onConnectionStatusChange: CONNECTED
2025-04-28 14:12:49.158  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onPaymentStatusChange: READY
2025-04-28 14:12:49.165  4018-4018  WooCommerce-CARD_READER com.woocommerce.android.prealpha     E  Connecting to reader succeeded.
2025-04-28 14:12:49.307  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onBatteryLevelUpdate: batteryStatus: NOMINAL, batteryLevel: 0.99, isCharging: true
2025-04-28 14:12:50.374  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: Creating payment intent succeeded
2025-04-28 14:12:50.389  4018-4953  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onPaymentStatusChange: WAITING_FOR_INPUT
2025-04-28 14:12:50.412  4018-5136  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onRequestReaderInput: Swipe / Insert / Tap
2025-04-28 14:12:50.793  4018-5136  WooCommerce-CARD_READER com.woocommerce.android.prealpha     D  CardReader: onRequestReaderInput: Swipe / Insert / Tap

☝️ Notice the onConnectionStatusChange: NOT_CONNECTED state is emmited for some reason. I'm not sure why 🤔

screen recording of the payment flow from this PR:

Screen_recording_20250428_133347.mp4

I verified that this is not happening on trunk:

Screen_recording_20250428_140640.mp4

Could you check if you experience the same on your devices, @malinajirka, @kidinov and @toupper?

malinajirka · 2025-04-28T12:43:14Z

I checked on my phone and I can confirm the behavior - might be a bug in the SDK, so I'd definitely start by checking their change and back logs.

kidinov · 2025-04-29T05:58:47Z

...n/java/com/woocommerce/android/cardreader/internal/connection/BluetoothReaderListenerImpl.kt

@@ -104,6 +105,10 @@ internal class BluetoothReaderListenerImpl(
        _displayMessagesEvents.value = BluetoothCardReaderMessages.CardReaderInputMessage(options.toString())
    }

+    override fun onDisconnect(reason: DisconnectReason) {
+        logWrapper.d(LOG_TAG, "onDisconnect")


I believe we shouldn't just log it. We may need to handle it properly and share it with the user

kidinov · 2025-04-29T05:59:47Z

...in/java/com/woocommerce/android/cardreader/internal/connection/TapToPayReaderListenerImpl.kt

+import com.woocommerce.android.cardreader.LogWrapper
+import com.woocommerce.android.cardreader.internal.LOG_TAG
+
+class TapToPayReaderListenerImpl(


I don't think we can just log status changes. Probably we need to propagate this to the user and offer a correct explanation with further steps

kidinov · 2025-04-29T06:07:10Z

@toupper Thank you for taking this on!

I can confirm what @samiuelson noticed as well.

Good news that the bugs we had with 3.10.2 with TTP on my Galaxy Ultra 24 is fixed here. Having said that we may want to setup our brand colors for TTP as it's been done here

Reading the migration guide, we may need to address, if not yet:

We added a new enum value, DISCOVERING, to ConnectionStatus to represent when reader discovery is running. Make sure your integration can handle this new state and provide relevant information to your customers.

We recommend displaying notifications in your app to inform the users about the reader status throughout the reconnection process. To handle reader reconnection methods, the ReaderReconnectionListener has been inherited by the respective ReaderListeners. Use MobileReaderListener for mobile readers, and TapToPayReaderListener for Tap to Pay readers to handle reconnection events.

For Tap to Pay on Android, Terminal::collectPaymentMethod and Terminal::collectSetupIntentPaymentMethod now time out after 60 seconds for Tap to Pay on Android transactions. A TerminalException is raised with the error code TerminalErrorCode.CARD_READ_TIMED_OUT.

For Tap to Pay on Android, when PIN collection is requested for a payment, a TerminalException is raised with the error code FEATURE_NOT_ENABLED_ON_ACCOUNT instead of DECLINED_BY_STRIPE_API with an ONLINE_OR_OFFLINE_PIN_REQUIRED ApiError.

The last one I don't remember what we do when PIN is required 🤔

toupper added 9 commits April 24, 2025 14:47

Point to Stripe 4

00ee94e

Update errors after breaking changes

ed46d95

Adapt to new connection API

0cb2988

Adapt after renaming breaking changes

9ccb8d3

Adapt after moving function away from TerminalListener to individual …

f635d44

…reader listeners

Handle the fact that now the processPayment from Stripe Terminal retu…

1f0b7c5

…rns a Cancelable.

Rename Cots to TapToPay to follow Stripe nomenclature

08e9dcc

Adapt Unit tests

d85302a

Run detekt

abe45c8

toupper marked this pull request as draft April 24, 2025 15:19

toupper added this to the 22.3 milestone Apr 25, 2025

toupper added 7 commits April 25, 2025 11:37

Fix missing tests

4701f39

Keep renaming cots to tap to pay to align with Stripe

677907e

Adjust process handling with new naming

d6c714b

Adjust log to function naming

94c0390

Fix tests

d1039c4

Rename also in Mock

52fe95f

Merge branch 'trunk' into issue/WOOMOB-302-update-to-Stripe-4

d43087b

toupper marked this pull request as ready for review April 25, 2025 14:48

Merge branch 'trunk' into issue/WOOMOB-302-update-to-Stripe-4

5f04514

toupper requested review from kidinov, malinajirka and samiuelson April 25, 2025 14:48

toupper added feature: mobile payments Related to mobile payments / card present payments / Woo Payments. type: task An internally driven task. labels Apr 25, 2025

samiuelson self-assigned this Apr 28, 2025

samiuelson reviewed Apr 28, 2025

View reviewed changes

samiuelson removed their assignment Apr 28, 2025

kidinov reviewed Apr 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WOOMOB-302][Mobile Payments] Update Stripe's SDK to 4.3.1 #13970

[WOOMOB-302][Mobile Payments] Update Stripe's SDK to 4.3.1 #13970

toupper commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

codecov-commenter commented Apr 25, 2025

samiuelson left a comment

malinajirka commented Apr 28, 2025

kidinov Apr 29, 2025

kidinov Apr 29, 2025 •

edited

Loading

kidinov commented Apr 29, 2025

[WOOMOB-302][Mobile Payments] Update Stripe's SDK to 4.3.1 #13970

Are you sure you want to change the base?

[WOOMOB-302][Mobile Payments] Update Stripe's SDK to 4.3.1 #13970

Conversation

toupper commented Apr 24, 2025 • edited Loading

Description

Steps to reproduce

Testing information

The tests that have been performed

Images/gif

Reviewer (or Author, in the case of optional code reviews):

wpmobilebot commented Apr 24, 2025 • edited Loading

Project manifest changes for WooCommerce

wpmobilebot commented Apr 24, 2025 • edited Loading

Project dependencies changes

wpmobilebot commented Apr 24, 2025 • edited Loading

wpmobilebot commented Apr 24, 2025 • edited Loading

codecov-commenter commented Apr 25, 2025

Codecov Report

samiuelson left a comment

Choose a reason for hiding this comment

malinajirka commented Apr 28, 2025

kidinov Apr 29, 2025

Choose a reason for hiding this comment

kidinov Apr 29, 2025 • edited Loading

Choose a reason for hiding this comment

kidinov commented Apr 29, 2025

toupper commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

wpmobilebot commented Apr 24, 2025 •

edited

Loading

kidinov Apr 29, 2025 •

edited

Loading