fix(ios): handle promoted iap cold start#144
Merged
Merged
Conversation
Register the Apple promoted purchase observer before JS init, replay pending promoted products to Expo listeners, and add the Expo example/docs release note for issue #143.
Contributor
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughThis PR implements end-to-end support for promoted in-app purchases on iOS cold start by registering an app delegate subscriber to initialize the native module early, moving payment queue observer registration to module init, updating the listener subscription contract to return pending product IDs, wrapping the listener with deduplication and replay logic, and exposing event tracking through a TypeScript system and demo screen. ChangesPromoted IAP Cold-Start Fix
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
hyochan
added
expo-iap
hyochan
changed the title
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request implements a fix for iOS Promoted IAP cold-start issues by moving the StoreKit payment queue observer registration to native module launch and decoupling it from the connection lifecycle. It introduces a new ExpoIapAppDelegateSubscriber for Expo projects and updates the library to replay pending promoted products to listeners. The example app has been updated with a dedicated Promoted IAP test screen and a refreshed home screen UI. Feedback highlights a type mismatch in promotedProductListenerIOS where the native SKU string is not correctly handled as a Product object, causing deduplication to fail. Additionally, a React key placement issue was identified in the example app's menu grid rendering.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
libraries/expo-iap/src/index.ts (1)
230-236: ⚡ Quick winReplace
.then().catch()with an async IIFE to comply with the coding guidelines.Both the general
**/*.{ts,tsx,js,jsx}andlibraries/expo-iap/**guidelines requireasync/awaitinstead of Promise chains.♻️ Proposed refactor
- void Promise.resolve(ExpoIapModule.getPromotedProductIOS()) - .then((product: Product | null) => { - if (product) { - deliver(product); - } - }) - .catch(() => {}); + void (async () => { + try { + const product = await ExpoIapModule.getPromotedProductIOS(); + if (product) { + deliver(product); + } + } catch { + // cold-start fetch is best-effort; errors are intentionally suppressed + } + })();As per coding guidelines: "Always use async/await for handling promises instead of .then() chains" (
**/*.{ts,tsx,js,jsx}) and "Use async/await instead of Promise chains for better readability" (libraries/expo-iap/**).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@libraries/expo-iap/src/index.ts` around lines 230 - 236, Replace the Promise chain calling ExpoIapModule.getPromotedProductIOS() with an async IIFE that awaits the call and uses try/catch; specifically, create an immediately-invoked async function that calls await ExpoIapModule.getPromotedProductIOS(), checks the returned Product (same null check as before) and calls deliver(product) if present, and move the empty .catch() logic into the catch block of the IIFE to handle errors consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@libraries/expo-iap/example/app/promoted-iap.tsx`:
- Around line 33-39: The functions copyUrl and openUrl currently await
Clipboard.setStringAsync and Linking.openURL without error handling; wrap each
function body in try/catch (for copyUrl and openUrl) and handle errors
explicitly (e.g., process with console.error or show an Alert/Toast to the user)
so promise rejections are not unhandled; ensure the catch logs the error and
provides a user-friendly fallback message, and keep the function signatures
(copyUrl, openUrl) intact so they can still be used as onPress handlers.
In `@packages/apple/Sources/Helpers/IapState.swift`:
- Around line 44-46: The current addPromotedProductListener((_ pair: (UUID,
PromotedProductListener))) returns promotedProductId which races with the async
emitPromotedProduct path and can double-deliver; change
addPromotedProductListener so it performs listener registration and
pending-event consumption atomically: when adding the listener
(promotedProductListeners.append), immediately capture and clear
promotedProductId (set it to nil) within the same actor-synchronized operation
and either (a) do NOT return the SKU (return nil) and let emitPromotedProduct
deliver it once, or (b) if you must deliver synchronously, invoke the listener
directly with the captured SKU before returning and ensure promotedProductId is
cleared so emitPromotedProduct won’t re-emit; reference
addPromotedProductListener, promotedProductListeners, promotedProductId,
emitPromotedProduct, and shouldAddStorePayment when making the change.
In `@packages/apple/Sources/OpenIapModule.swift`:
- Around line 1463-1509: The helpers currently set
didRegisterPromotedPurchaseObserver before the SKPaymentQueue add/remove
actually runs asynchronously; change them to perform the add/remove
synchronously on the main thread first, then update
didRegisterPromotedPurchaseObserver under promotedPurchaseObserverLock so the
flag reflects the real state. Concretely, in
registerPromotedPurchaseObserverIfNeeded and
unregisterPromotedPurchaseObserverIfNeeded: check the current flag under
promotedPurchaseObserverLock to decide work, then if work is needed perform the
SKPaymentQueue.default().add(self) or .remove(self) synchronously on the main
thread (use Thread.isMainThread ? call directly : DispatchQueue.main.sync),
avoid an async closure with a weak self for the registration/removal so the call
definitely executes before returning, and finally acquire the lock to set
didRegisterPromotedPurchaseObserver = true/false.
In `@packages/docs/src/pages/docs/updates/releases.tsx`:
- Around line 45-69: The release notes currently assert "Publishes openiap-apple
2.1.8" and use final-release wording/links, which will create dead links if
artifacts/tags aren't yet published; change the copy for "openiap-apple 2.1.8",
the surrounding paragraph that references promotedProductListenerIOS and
getPromotedProductIOS(), and any links pointing to the final release tag
(including the GitHub issue link if it targets a release tag) to planned-release
wording (e.g., "Planned: openiap-apple 2.1.8 — will publish..." or "This release
will...") or point links to the PR/draft notes instead, and apply the same
tense/link fixes to the other block referenced (lines around the 118-179
section).
---
Nitpick comments:
In `@libraries/expo-iap/src/index.ts`:
- Around line 230-236: Replace the Promise chain calling
ExpoIapModule.getPromotedProductIOS() with an async IIFE that awaits the call
and uses try/catch; specifically, create an immediately-invoked async function
that calls await ExpoIapModule.getPromotedProductIOS(), checks the returned
Product (same null check as before) and calls deliver(product) if present, and
move the empty .catch() logic into the catch block of the IIFE to handle errors
consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 77220443-97b9-493b-8fa6-04604413251b
📒 Files selected for processing (17)
libraries/expo-iap/example/__tests__/index.test.tsxlibraries/expo-iap/example/__tests__/layout.test.tsxlibraries/expo-iap/example/app.config.tslibraries/expo-iap/example/app/_layout.tsxlibraries/expo-iap/example/app/index.tsxlibraries/expo-iap/example/app/promoted-iap.tsxlibraries/expo-iap/example/src/promotedIapEvents.tslibraries/expo-iap/expo-module.config.jsonlibraries/expo-iap/ios/ExpoIapAppDelegateSubscriber.swiftlibraries/expo-iap/plugin/src/withIAP.tslibraries/expo-iap/src/__tests__/index.test.tslibraries/expo-iap/src/index.tspackages/apple/Sources/Helpers/IapState.swiftpackages/apple/Sources/Helpers/OpenIapConnectionLifecycle.swiftpackages/apple/Sources/OpenIapModule.swiftpackages/apple/Tests/OpenIapTests.swiftpackages/docs/src/pages/docs/updates/releases.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #143
Test plan
swift testinpackages/applebun run lint:tscinlibraries/expo-iapbun run build:plugininlibraries/expo-iapbunx tsc -p tsconfig.json --noEmit --skipLibCheckinlibraries/expo-iap/examplebun run test -- --runTestsByPath __tests__/index.test.tsx __tests__/layout.test.tsxinlibraries/expo-iap/examplebun run test:plugininlibraries/expo-iapbun run buildinpackages/docsitms-services://?action=purchaseIntent&bundleId=dev.hyo.martie&productIdentifier=dev.hyo.martie.premiumSummary by CodeRabbit
Release Notes
New Features
Bug Fixes