Prototype development/inline android component #383

kieran-osgood-shopify · 2025-11-13T12:38:43Z

What changes are you making?

This PR integrates the CheckoutWebview thats being exposed in this PR Shopify/checkout-sheet-kit-android#397 so that it can be rendered in an "inline" mode - you'll need to have this branch checked out also to run it

How to test

Run the React Native Android sample app and go to the buy now screen, you should be able to do the same address change flow that occurs in the ios react native app

PR Checklist

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 README.

Releasing a new version of the kit?

I have bumped the version number in the package.json file.

Tip

See the Contributing documentation for instructions on how to publish a new version of the library.

...oid/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java

kieran-osgood-shopify · 2025-11-17T13:50:11Z

Remaining task to be completed here is to update the gradle config to ensure that we are able to build against local android package without modifying lib (JVM_1_8 -> JVM_17)

sample/android/settings.gradle

github-actions · 2025-11-26T18:17:39Z

Coverage Report

Lines	Statements	Branches	Functions
	81.95% (218/266)	84% (105/125)	80.26% (61/76)

westeezy · 2025-11-27T04:16:48Z

...oid/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java


  @Override
-  public void onComplete(@NonNull CheckoutCompleteEvent event) {
+  public void onCheckoutCompleted(@NonNull CheckoutCompleteEvent event) {


maybe cart before the horse but these should be onComplete present tense for platform consistency.

Yeah not to worry I'm resolving these locally, had to rebase (this is an old branch)

...oid/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java

westeezy

left a few nits but given the holiday and the fact this overall links really solid im approving :)

…als()

kieran-osgood-shopify · 2025-11-27T17:29:35Z

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java

+        eventDispatcher.dispatchEvent(new CheckoutEvent(surfaceId, viewId, eventName, params));
+    }
+
+    private class InlineCheckoutEventProcessor extends DefaultCheckoutEventProcessor {


@kiftio moved back to RCTCheckoutWebView having its own processor so i could remove all the changes to CustomCheckoutEventProcessor (but I renamed it to SheetCheckoutEventProcessor to distinguish them)

...roid/src/main/java/com/shopify/reactnative/checkoutsheetkit/SheetCheckoutEventProcessor.java

kiftio · 2025-11-27T21:36:16Z

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java

+        ///  resulting in an empty view being rendered. Cannot move setup to constructor as
+        ///  checkoutUrl is undefined until setCheckoutUrl is called by RCTCheckoutWebViewManager
+        ///  requestLayout / invalidate were unsuccessful in remedying this
+        checkoutWebView.layout(0, 0, getWidth(), getHeight());


Do we need to override onLayout ot deal with size changes?

@Override protected void onLayout(boolean changed, int left, int top, int right, int bottom) { super.onLayout(changed, left, top, right, bottom); if (checkoutWebView != null) { checkoutWebView.layout(0, 0, right - left, bottom - top); } }

That was my initial approach which had the race condition

I've got a comment above that hopefully explains it but the onLayout was executing before setupCheckoutWebView (because the FrameLayout is constructed before react props are passed in) meaning we dont have a view to construct yet

Before:
onLayout (dimensions zero) -> setupCheckoutWebView -> view is zero sized

After:
onLayout (dimensions zero) -> setupCheckoutWebView -> re-measure layout after adding view -> view displays

I tried using requestLayout/invalidate to get android to re-run onLayout but didn't see a subsequent execution

Ah ok, yeah I was thinking in case the layout changes in some way (orientation?) and we don't resize

Good point - probably worth keeping it still just incase

kiftio · 2025-11-27T21:51:00Z

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java

+    private CheckoutConfiguration lastConfiguration = null;
+    private final Handler mainHandler = new Handler(Looper.getMainLooper());
+
+    private record CheckoutConfiguration(String url, String authToken) {}


So just thinking about this, I think support for records might have come after what we've defined for

sourceCompatibility
targetCompatibility

Unless the android gradle plugin supports desugaring

kiftio · 2025-11-27T21:51:47Z

...roid/src/main/java/com/shopify/reactnative/checkoutsheetkit/SheetCheckoutEventProcessor.java

-    errorMap.put("recoverable", checkoutError.isRecoverable());
-    errorMap.put("code", checkoutError.getErrorCode());
+  private Map<String, Object> populateErrorDetails(CheckoutException error) {
+    Map<String, Object> errorMap = new HashMap<>(Map.of(


may want to check when Map.of support was introduced too.

Since 9 - should be fine?

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java

kiftio

🚀

kieran-osgood-shopify marked this pull request as ready for review November 13, 2025 15:21

kieran-osgood-shopify requested a review from a team as a code owner November 13, 2025 15:21

kieran-osgood-shopify mentioned this pull request Nov 13, 2025

Prototype development/android inline component Shopify/checkout-sheet-kit-android#397

Merged

6 tasks

kieran-osgood-shopify commented Nov 13, 2025

View reviewed changes

...oid/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java Outdated Show resolved Hide resolved

kieran-osgood-shopify commented Nov 13, 2025

View reviewed changes

...oid/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java Outdated Show resolved Hide resolved

westeezy reviewed Nov 14, 2025

View reviewed changes

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java Outdated Show resolved Hide resolved

kieran-osgood-shopify commented Nov 25, 2025

View reviewed changes

sample/android/settings.gradle Outdated Show resolved Hide resolved

kieran-osgood-shopify force-pushed the prototype-development/inline-android-component branch from 2e352cc to 37f95c9 Compare November 26, 2025 18:17

westeezy reviewed Nov 27, 2025

View reviewed changes

...oid/src/main/java/com/shopify/reactnative/checkoutsheetkit/CustomCheckoutEventProcessor.java Outdated Show resolved Hide resolved

westeezy reviewed Nov 27, 2025

View reviewed changes

...t-kit/android/src/main/java/com/shopify/reactnative/checkoutsheetkit/RCTCheckoutWebView.java Outdated Show resolved Hide resolved

westeezy approved these changes Nov 27, 2025

View reviewed changes

kieran-osgood-shopify force-pushed the prototype-development/inline-android-component branch 2 times, most recently from 83e818f to 565c443 Compare November 27, 2025 11:57

kieran-osgood-shopify added 14 commits November 27, 2025 11:58

feat: setup android inline component

40914ab

fix: ensure we can respond to address change events

91ab2c3

chore: remove redundant address change map

6eb56fa

remove unused imports

b55ea61

fix: rename CheckoutCompletedEvent -> CheckoutCompleteEvent

4319800

refactor: remove deprecated method overrides

e585ce7

chore: cleaning up token and networking debugging

c38175e

fix: remove android debugging code - readd timeout

f0e5ced

fix: add event handlers for CheckoutScreen

c2730a0

refactor: remove unnecessary view in buynowbutton

278620a

fix: yarn module build errors

1323004

refactor(RCTCheckoutWebView): replace complicated if checks with .equ…

704cfb1

…als()

refactor: remove lint warnings on type coersion

4926b04

refactor: use shorter kotlin unit instance

2684297

kieran-osgood-shopify added 2 commits November 27, 2025 12:01

refactor: remove unnecesasry logging and overrides

1bd7aa0

remove classPaths from build.gradle

3b9ad9d

kieran-osgood-shopify force-pushed the prototype-development/inline-android-component branch from 565c443 to 3b9ad9d Compare November 27, 2025 12:14

kieran-osgood-shopify added 11 commits November 27, 2025 12:58

feat: add event handling to inline webview android

fe15ad7

refactor: simplifying map construction

f80904b

refactor: remove deprecated event emitting

d33096f

refactor: extract CheckoutEvent for instance based events

ffbb322

fix: webview not loading

73fb035

cleanup events that arent ready - rename onClickLink

0664faf

add nonnull annotation for getEventName

0d3b83a

fix: remove onLoad from swift

857fa72

rename customeventprocessor -> Sheeteventprocessor

fa56ba3

refactor: undo changes to reuse custom event processor for inline

3c82c9a

fix: intermitent flakiness of layout for checkout webview inline

0d0d0f3

kieran-osgood-shopify commented Nov 27, 2025

View reviewed changes

remove unused variable

51c1ff4

kiftio reviewed Nov 27, 2025

View reviewed changes

kieran-osgood-shopify added 7 commits November 27, 2025 22:54

fix: flatten onerror - implement onlinkclick

43464ab

format files

9999547

fix: type in TAG - remove unused comments

2e7b283

fix: remove record (java16 feature)

95b387d

fix: ensure layout params are applied to webview

d22b70f

test: RctCheckoutWebViewTests

6d88aa0

refactor: improve tests with side effects of setup checks

3a7c499

kieran-osgood-shopify force-pushed the prototype-development/inline-android-component branch from 9d5e829 to 3a7c499 Compare November 28, 2025 12:01

kiftio approved these changes Nov 28, 2025

View reviewed changes

kieran-osgood-shopify added 2 commits November 28, 2025 12:39

fix: ts error from unused prop

34599b1

feat: update snapshot with new classes for components

235ff69

kieran-osgood-shopify merged commit b332283 into prototype/development Nov 28, 2025
7 checks passed

kieran-osgood-shopify deleted the prototype-development/inline-android-component branch November 28, 2025 13:12

Prototype development/inline android component #383

Prototype development/inline android component #383

Uh oh!

Conversation

kieran-osgood-shopify commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes are you making?

How to test

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kieran-osgood-shopify commented Nov 17, 2025

Uh oh!

Uh oh!

github-actions bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

westeezy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kiftio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kieran-osgood-shopify commented Nov 13, 2025 •

edited

Loading

github-actions bot commented Nov 26, 2025 •

edited

Loading