[Android] Rename CheckoutEventProcessor → CheckoutListener, drop stale callbacks by tiagocandido · Pull Request #132 · Shopify/checkout-kit

tiagocandido · 2026-05-15T14:39:23Z

What changes are you making?

Renames CheckoutEventProcessor → CheckoutListener on Android (with DefaultCheckoutEventProcessor → DefaultCheckoutListener) and drops two methods now owned by the protocol layer:

onCheckoutCompleted → use CheckoutProtocol.complete
onCheckoutLinkClicked → use CheckoutCommunicationClient.openExternalUrl(...)

Removes the legacy code paths that fed those callbacks: the COMPLETED case in CheckoutBridge and the legacy intent-launching defaults on DefaultCheckoutEventProcessor. CheckoutWebView's shouldOverrideUrlLoading override stays — it's still the only path that catches mailto:/tel: clicks, which checkout-web deliberately doesn't route through window.open (see checkoutProtocolLinkInterceptor.ts:18).

One behavior tweak to keep parity with the previous Android implementation: the ec.complete handler now invalidates the preload cache (was done by the old onCheckoutViewComplete path).

Internal field/class names follow the rename for consistency (CheckoutWebViewEventProcessor → CheckoutWebViewListener, eventProcessor → listener throughout). README and lib/api/lib.api are updated.

Note: The React Native Android wrapper extends DefaultCheckoutEventProcessor and overrides onCheckoutCompleted — it will need a follow-up PR to rename the extends clause and route completion through CheckoutProtocol.complete.

How to test

./gradlew :lib:test :lib:apiCheck :lib:detekt :lib:lintRelease
Build the MobileBuyIntegration sample and complete a checkout end-to-end; confirm the CheckoutProtocol.complete handler in CartViewModel fires (clears cart and pops back to the product screen)

Before you merge

Important

I've added tests to support my implementation
I have read and agree with the Contribution Guidelines
I have read and agree with the Code of Conduct
I've updated the relevant platform README (`platforms/swift/README.md` and/or `platforms/android/README.md`)

tiagocandido · 2026-05-15T14:39:45Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

josemiguel-alvarez · 2026-05-18T15:18:06Z

+    private fun syntheticCompleteMessage(orderId: String?): String {
+        val orderJson = orderId?.let { ""","order":{"id":"$it"}""" } ?: ""
+        return """
+            |{"jsonrpc":"2.0","method":"${EmbeddedCheckoutProtocol.METHOD_COMPLETE}",
+            |"params":{"id":"${orderId ?: ""}","currency":"","line_items":[],"links":[],
+            |"status":"completed","totals":[],
+            |"ucp":{"version":"${CheckoutProtocol.specVersion}","status":"success"}$orderJson}}
+        """.trimMargin().replace("\n", "")


Fallback completion never reaches CheckoutProtocol.complete. FallbackWebView.kt synthesizes ec.complete with checkout fields directly under params, but CheckoutProtocol.kt only decodes params.checkout.

Good catch. Moved the construction into CheckoutProtocol.encodeRecoveryCompleteNotification(orderId:) so it nests under params.checkout. Added a round-trip test so a future hand-rolled payload can't regress this — handler now fires in the recovery confirmation path.

Update: pulled this back out — Kieran flagged in his Swift review that we shouldn't be adding new recovery code in this PR. Synthesis call and the protocol helper are both gone now. Full recovery removal is the next PR.

josemiguel-alvarez · 2026-05-18T15:19:10Z

React Native Android still references the removed API. CustomCheckoutEventProcessor.java still extends DefaultCheckoutEventProcessor, and line 124 still overrides onCheckoutCompleted, both removed by this PR.

josemiguel-alvarez · 2026-05-18T15:20:53Z


 > [!Note]
-> The `DefaultCheckoutEventProcessor` provides default implementations for current and future callback functions (such as `onLinkClicked()`), which can be overridden by clients wanting to change default behavior.
+> The `DefaultCheckoutListener` provides default implementations for the OS-level prompt callbacks, which can be overridden by clients wanting to change default behavior. Checkout completion and external link clicks are delivered through the Embedded Checkout Protocol client instead — register a handler on `CheckoutProtocol.complete` and implement `CheckoutCommunicationClient.openExternalUrl(...)`, then pass the client as the 4th argument of `ShopifyCheckoutKit.present(...)`.


The README tells consumers to implement CheckoutCommunicationClient.openExternalUrl(...) at README.md, but CheckoutCommunicationClient.kt only exposes process(message), and ec.window.open_request is handled internally at EmbeddedCheckoutProtocol.kt.

Right, that was wrong — interface only exposes process(message). Dropped the line and clarified ec.window.open_request is kit-internal. Only CheckoutProtocol.complete registration stays on the consumer.

josemiguel-alvarez

There are some references to the removed code that should be updated.

westeezy · 2026-05-18T15:25:58Z

+    }

-        private fun getOrderIdFromQueryString(uri: Uri): String? = uri.getQueryParameter("order_id")
+    private fun syntheticCompleteMessage(orderId: String?): String {


Similar question from swift side too, I was thinking these are handled by the protocol stuff @kieran-osgood-shopify setup so hopefully dont need to be manually constructed, but let me know if complete has something unique about it

Yeah, you're right. Pushed it down — Android has CheckoutProtocol.encodeRecoveryCompleteNotification(orderId:), Swift has the same in CheckoutProtocol+Recovery.swift. Fallback paths just call into it, no hand-rolled JSON on either side. Nothing unique about complete, the manual one was just buggy.

Reverted — see Jose's thread above. Helper and synthesis call are both out now, full recovery removal lands next.

kiftio · 2026-05-19T09:36:25Z

 */
-public abstract class DefaultCheckoutEventProcessor : CheckoutEventProcessor {
+public abstract class DefaultCheckoutListener @JvmOverloads constructor(
+    @Suppress("UnusedPrivateProperty") private val context: Context,


maybe I'm mixing things up, but I think we said we could just remove these params rather than suppress?

Yep, dropped both. Context and LogWrapper are gone from the constructor — subclasses pass through if they need them. apiDump regenerated to match.

kiftio · 2026-05-19T09:37:18Z

-                log.d(LOG_TAG, "Finished page has confirmationUrl. Emitting minimal checkout completed event.")
-                getEventProcessor().onCheckoutViewComplete(
-                    emptyCompletedEvent(id = getOrderIdFromQueryString(uri))
+                log.d(LOG_TAG, "Confirmation page reached in fallback; synthesizing ec.complete with partial data.")


Are we supporting recovery in V1?

Good question — Kieran flagged the same thing on the Swift PR. We're not shipping recovery in v1. For this PR I pulled the new synthesis additions back out so we're not growing the surface we're about to delete. Full recovery removal lands as the next PR on the stack.

tiagocandido · 2026-05-19T11:17:28Z

Tracked for the RN follow-up PR — needs the rename plus the zero-arg DefaultCheckoutListener() super call. Not in tree here.

josemiguel-alvarez · 2026-05-19T14:00:10Z

 	public final fun onGeolocationPermissionsShowPrompt (Lkotlin/jvm/functions/Function2;)V
 	public final fun onPermissionRequest (Lkotlin/jvm/functions/Function1;)V
 	public final fun onShowFileChooser (Lkotlin/jvm/functions/Function3;)V
+=======
+public abstract interface class com/shopify/checkoutkit/CheckoutListener {
+	public abstract fun onCheckoutCanceled ()V
+	public abstract fun onCheckoutFailed (Lcom/shopify/checkoutkit/CheckoutException;)V
+	public abstract fun onGeolocationPermissionsHidePrompt ()V
+	public abstract fun onGeolocationPermissionsShowPrompt (Ljava/lang/String;Landroid/webkit/GeolocationPermissions$Callback;)V
+	public abstract fun onPermissionRequest (Landroid/webkit/PermissionRequest;)V
+	public abstract fun onShowFileChooser (Landroid/webkit/WebView;Landroid/webkit/ValueCallback;Landroid/webkit/WebChromeClient$FileChooserParams;)Z
+>>>>>>> ba15a01 ([Android] Rename CheckoutEventProcessor → CheckoutListener, drop stale callbacks)


[Re: lines +749 to +766]

There are still conflict markers here.

See this comment inline on Graphite.

yes, pushed too soon, fixing them

josemiguel-alvarez

React Native Android still references the removed Android API. CustomCheckoutEventProcessor.java still extends DefaultCheckoutEventProcessor, and it still overrides onCheckoutCompleted.

josemiguel-alvarez

Just saw that there's a follow-up for the React Native stale code.

There are some conflicts markers that should be removed. Everything else looks good to me!

…e callbacks

) ### What changes are you making? react native android CI was failing after #132 merged because it didn't run CI for react-native This PR renames the android portion to match the new naming of the event processor <img width="847" height="556" alt="image" src="https://github.com/user-attachments/assets/b3366989-2b9d-4bf6-a67d-496fea4561a0" /> ### How to test  --- ### Before you merge > [!IMPORTANT] > > - [ ] I've added tests to support my implementation > - [ ] I have read and agree with the [Contribution Guidelines](./CONTRIBUTING.md) > - [ ] I have read and agree with the [Code of Conduct](./CODE_OF_CONDUCT.md) > - [ ] I've updated the relevant platform README (`platforms/swift/README.md` and/or `platforms/android/README.md`) --- <details> <summary>Releasing a new Swift version?</summary> - [ ] I have bumped the version in `ShopifyCheckoutKit.podspec` - [ ] I have bumped the version in `platforms/swift/Sources/ShopifyCheckoutKit/ShopifyCheckoutKit.swift` - [ ] I have updated `platforms/swift/CHANGELOG.md` - [ ] I have updated the SwiftPM/CocoaPods version snippets in `platforms/swift/README.md` (major version only) </details> <details> <summary>Releasing a new Android version?</summary> - [ ] I have bumped the `versionName` in `platforms/android/lib/build.gradle` - [ ] I have updated `platforms/android/CHANGELOG.md` - [ ] I have updated the Gradle/Maven version snippets in `platforms/android/README.md` </details> > [!TIP] > See the [Contributing documentation](./CONTRIBUTING.md) for the full release process per platform.

tiagocandido mentioned this pull request May 15, 2026

[Swift] Restore CheckoutDelegate with trimmed lifecycle API #131

Merged

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 89c10c1 to d4da055 Compare May 15, 2026 14:50

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from d27977c to 7dceb15 Compare May 15, 2026 14:50

tiagocandido added the #gsd:50662 Rebase Checkout Kit on UCP label May 15, 2026 — with Graphite App

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch 2 times, most recently from 8b0659f to 8afa420 Compare May 15, 2026 16:07

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from 7dceb15 to 86ecd8b Compare May 15, 2026 16:07

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 8afa420 to 14a4aac Compare May 15, 2026 16:10

tiagocandido marked this pull request as ready for review May 15, 2026 16:15

tiagocandido requested a review from a team as a code owner May 15, 2026 16:15

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 14a4aac to 57bb1fe Compare May 15, 2026 16:46

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from 86ecd8b to 9aa6c02 Compare May 15, 2026 16:46

kieran-osgood-shopify mentioned this pull request May 15, 2026

feat: remove checkout lifecycle from react-native #116

Closed

11 tasks

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 57bb1fe to ffb59f3 Compare May 18, 2026 09:42

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from 9aa6c02 to b4e5670 Compare May 18, 2026 09:42

josemiguel-alvarez reviewed May 18, 2026

View reviewed changes

josemiguel-alvarez requested changes May 18, 2026

View reviewed changes

westeezy reviewed May 18, 2026

View reviewed changes

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from b4e5670 to b578111 Compare May 18, 2026 15:51

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch 2 times, most recently from 114f122 to bcf828a Compare May 18, 2026 17:06

kiftio reviewed May 19, 2026

View reviewed changes

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch 3 times, most recently from b93b925 to ba15a01 Compare May 19, 2026 11:09

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from b578111 to dfa64f0 Compare May 19, 2026 11:09

tiagocandido requested review from josemiguel-alvarez, kiftio and westeezy May 19, 2026 11:18

tiagocandido changed the base branch from 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api to graphite-base/132 May 19, 2026 12:47

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from ba15a01 to 3d6f9c6 Compare May 19, 2026 12:51

tiagocandido force-pushed the graphite-base/132 branch from dfa64f0 to 4037fe6 Compare May 19, 2026 12:51

tiagocandido changed the base branch from graphite-base/132 to 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api May 19, 2026 12:51

kieran-osgood-shopify approved these changes May 19, 2026

View reviewed changes

josemiguel-alvarez reviewed May 19, 2026

View reviewed changes

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from 4037fe6 to 623b169 Compare May 19, 2026 14:02

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 3d6f9c6 to 035d5a7 Compare May 19, 2026 14:02

josemiguel-alvarez reviewed May 19, 2026

View reviewed changes

josemiguel-alvarez approved these changes May 19, 2026

View reviewed changes

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 035d5a7 to 1951caf Compare May 19, 2026 14:14

tiagocandido added 2 commits May 19, 2026 16:29

Restore CheckoutDelegate with trimmed lifecycle API

70531ba

[Android] Rename CheckoutEventProcessor → CheckoutListener, drop stal…

c24c019

…e callbacks

tiagocandido force-pushed the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch from 1951caf to c24c019 Compare May 19, 2026 14:29

tiagocandido force-pushed the 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api branch from 623b169 to 70531ba Compare May 19, 2026 14:29

Base automatically changed from 05-15-restore_checkoutdelegate_with_trimmed_lifecycle_api to main May 19, 2026 14:38

tiagocandido merged commit 4a2c909 into main May 19, 2026
33 of 35 checks passed

tiagocandido deleted the 05-15-_android_rename_checkouteventprocessor_checkoutlistener_drop_stale_callbacks branch May 19, 2026 14:40

kieran-osgood-shopify mentioned this pull request May 19, 2026

fix(react-native): adapt Android bridge to CheckoutListener rename #155

Merged

11 tasks

Conversation

tiagocandido commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes are you making?

How to test

Before you merge

Uh oh!

tiagocandido commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josemiguel-alvarez commented May 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josemiguel-alvarez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tiagocandido commented May 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josemiguel-alvarez left a comment

Choose a reason for hiding this comment

Uh oh!

josemiguel-alvarez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tiagocandido commented May 15, 2026 •

edited

Loading

tiagocandido commented May 15, 2026 •

edited

Loading