Expose trackCustomPaywallImpression as experimental public API by rickvdl · Pull Request #6427 · RevenueCat/purchases-ios

rickvdl · 2026-03-09T16:03:45Z

Description

Exposes trackCustomPaywallImpression as an experimental public API, allowing hybrid SDKs and consumers to track impressions of custom (non-RevenueCat) paywalls.

Changes

New CustomPaywallImpressionParams class gated behind @_spi(Experimental), @objc-compatible
Public non-async trackCustomPaywallImpression method on Purchases (fire-and-forget, wraps in Task {})
Swift and ObjC API testers

Related PRs

purchases-android: Expose trackCustomPaywallImpression as experimental public API purchases-android#3199
purchases-hybrid-common: Expose trackCustomPaywallImpression bridge methods purchases-hybrid-common#1537
react-native-purchases: Add trackCustomPaywallImpression API react-native-purchases#1660

Note

Medium Risk
Introduces a new experimental public/ObjC API on Purchases, which changes the SDK’s public surface and event-tracking call pattern (fire-and-forget Task) and could affect analytics behavior if misused.

Overview
Exposes experimental custom paywall impression tracking to SDK consumers by adding CustomPaywallImpressionParams (ObjC-compatible) and making Purchases.trackCustomPaywallImpression a public @objc fire-and-forget API, plus a no-params convenience overload.

Removes the previously internal CustomPaywallEvent.Params type, updates unit tests accordingly, and adds Swift/ObjC API tester coverage to validate the new API surface. Project configuration is updated to include the new source/test files.

^{Written by Cursor Bugbot for commit 5fdd54f. This will update automatically on new commits. Configure here.}

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

✅ Fixed: Missing Sendable conformance on CustomPaywallImpressionParams
- Added explicit Sendable conformance to CustomPaywallImpressionParams so it can be safely captured in the Task used by trackCustomPaywallImpression.

Or push these changes by commenting:

@cursor push fdeb3da1f3

Preview (fdeb3da1f3)

diff --git a/Sources/Paywalls/Events/CustomPaywallEvent.swift b/Sources/Paywalls/Events/CustomPaywallEvent.swift
--- a/Sources/Paywalls/Events/CustomPaywallEvent.swift
+++ b/Sources/Paywalls/Events/CustomPaywallEvent.swift
@@ -78,7 +78,7 @@
 
 /// Parameters for tracking a custom paywall impression event.
 @_spi(Experimental) @objc(RCCustomPaywallImpressionParams)
-public final class CustomPaywallImpressionParams: NSObject {
+public final class CustomPaywallImpressionParams: NSObject, Sendable {
 
     /// An optional identifier for the custom paywall being shown.
     @objc public let paywallId: String?

_{This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.}

ajpallares

Looks good! I have some initial comments

ajpallares

Amazing job! I have some comments, the most important one being a file commited that I believe is not related. But looks great otherwise!

ajpallares · 2026-03-11T16:25:07Z

-            .init(paywallId: params.paywallId)
-        )
-        await self.eventsManager?.track(featureEvent: event)
+    @objc public func trackCustomPaywallImpression(_ params: CustomPaywallImpressionParams) {


Since this is a public API that consumers will likely call from SwiftUI's onAppear (which can fire multiple times during tab switches, sheet re-presentations, etc.), each invocation creates a brand new impression event with a fresh UUID and triggers a priority flush. There's nothing preventing duplicate impressions for the same paywall display.

Should we add doc comment guidance about when to call this (e.g., "Call once per paywall presentation, not in onAppear")?

I'm not sure, but I'm afraid we could be getting duplicate impressions.

Yep that's indeed true. I've added a comment about this. LMK what you think :)

I like the callout. It should help a bit avoid multiple impressions. Thank you!

cursor

Cursor Bugbot has reviewed your changes and found 3 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

ajpallares

Thank you again! Looks great! 🚀

ajpallares · 2026-03-12T07:08:19Z

-            .init(paywallId: params.paywallId)
-        )
-        await self.eventsManager?.track(featureEvent: event)
+    @objc public func trackCustomPaywallImpression(_ params: CustomPaywallImpressionParams) {


I like the callout. It should help a bit avoid multiple impressions. Thank you!

ajpallares · 2026-03-12T07:08:39Z

+        expect(data.paywallId).to(beNil())
+    }
+
+    func testTrackMultipleImpressionsInQuickSuccession() async throws {


Thank you for adding this!

## Description Exposes `trackCustomPaywallImpression` as an experimental public API, allowing hybrid SDKs and consumers to track impressions of custom (non-RevenueCat) paywalls. ### Changes - New `CustomPaywallEventParams` class gated behind `@ExperimentalPreviewRevenueCatPurchasesAPI` - Public `trackCustomPaywallImpression` method on `Purchases` - API tester and Metalava API surface updates ### Related PRs - purchases-ios: RevenueCat/purchases-ios#6427 - purchases-hybrid-common: RevenueCat/purchases-hybrid-common#1537 - react-native-purchases: RevenueCat/react-native-purchases#1660  --- > [!NOTE] > **Medium Risk** > Introduces new public (experimental) API surface on `Purchases`, which can affect binary compatibility and downstream integrations if the signature or opt-in semantics change. > > **Overview** > Exposes `Purchases.trackCustomPaywallImpression` as an *experimental public API* (with overloads) to let apps track impressions for custom/non-RevenueCat paywalls, accepting optional `paywallId` via the new `CustomPaywallImpressionParams` type. > > Replaces the prior internal params type, updates API tester coverage (Java/Kotlin) to exercise the new calls, and refreshes Metalava API surface files and unit tests accordingly. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 3896706. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>

## Description Adds bridge methods for `trackCustomPaywallImpression` on both iOS and Android, enabling hybrid SDKs to call the new experimental native API. ### Changes - iOS: `trackCustomPaywallImpression(_ data:)` in `CommonFunctionality.swift` - Android: `trackCustomPaywallImpression(data)` in `common.kt` Both methods accept a dictionary with an optional `paywallId` key and delegate to the native SDK. ### Related PRs - purchases-ios: RevenueCat/purchases-ios#6427 - purchases-android: RevenueCat/purchases-android#3199 - react-native-purchases: RevenueCat/react-native-purchases#1660

## Summary - Add `trackCustomPaywallImpression` API to the Unity SDK, wiring through the existing hybrid-common bridge on both iOS and Android - Introduce `CustomPaywallImpressionParams` class with an optional `PaywallId` - Pass `CustomPaywallImpressionParams` through the wrapper interface, splitting into separate arguments only at the native bridge boundary - Add a testing UI in the Subtester app's Paywall screen with an optional paywall ID field ## Changes - **New file:** `CustomPaywallImpressionParams.cs` — params class with optional `PaywallId` - **Interface:** `IPurchasesWrapper` — added `TrackCustomPaywallImpression(CustomPaywallImpressionParams)` - **Public API:** `Purchases.cs` — two overloads (with params, parameterless) - **iOS bridge:** `PurchasesWrapperiOS.cs` + `PurchasesUnityHelper.m` — DllImport and ObjC bridge calling `[RCCommonFunctionality trackCustomPaywallImpression:]` - **Android bridge:** `PurchasesWrapperAndroid.cs` + `PurchasesWrapper.java` — CallPurchases and static method calling `CommonKt.trackCustomPaywallImpression()` - **No-op:** `PurchasesWrapperNoop.cs` — empty stub - **API tests:** `PurchasesAPITests.cs` — compile-time verification of both overloads - **Subtester:** `PaywallScreen.cs` — "Custom Paywall Events" section with paywall ID field and button ### Related PRs - purchases-ios: RevenueCat/purchases-ios#6427 - purchases-android: RevenueCat/purchases-android#3199 - purchases-hybrid-common: RevenueCat/purchases-hybrid-common#1537 - react-native-purchases: RevenueCat/react-native-purchases#1660 - purchases-flutter: RevenueCat/purchases-flutter#1679 - purchases-capacitor: RevenueCat/purchases-capacitor#725 --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Rick van der Linden <rick.vanderlinden@revenuecat.com>

## Summary - Add `trackCustomPaywallImpression` API to React Native, enabling developers to track impressions of custom (non-RevenueCat) paywalls for analytics - Add purchase tester demo screen for testing custom paywall impressions ## Changes - **iOS bridge:** `RCT_EXPORT_METHOD(trackCustomPaywallImpression:)` in `RNPurchases.m` - **Android bridge:** `@ReactMethod trackCustomPaywallImpression` in `RNPurchasesModule.java` - **TypeScript:** `Purchases.trackCustomPaywallImpression()` in `purchases.ts` with optional `paywallId` parameter - **Purchase tester:** Added a demo Custom Paywall screen for testing impressions ### Related PRs - purchases-ios: RevenueCat/purchases-ios#6427 - purchases-android: RevenueCat/purchases-android#3199 - purchases-hybrid-common: RevenueCat/purchases-hybrid-common#1537 - purchases-flutter: RevenueCat/purchases-flutter#1679 - purchases-capacitor: RevenueCat/purchases-capacitor#725

…PI (#1565) ## Summary - Read `offeringId` from the data dictionary in `trackCustomPaywallImpression` on both iOS and Android bridge layers - Pass it through to the native `CustomPaywallImpressionParams`, allowing hybrid SDKs to override the default offering identifier ## Related PRs - purchases-ios: RevenueCat/purchases-ios#6427 - purchases-android: RevenueCat/purchases-android#3199 - react-native-purchases: RevenueCat/react-native-purchases#1660 - purchases-unity: RevenueCat/purchases-unity#863

rickvdl added the pr:other label Mar 9, 2026

rickvdl force-pushed the rickvdl/track-custom-paywall-impression-experimental-api branch 2 times, most recently from b7449f6 to caf32cb Compare March 10, 2026 09:06

rickvdl marked this pull request as ready for review March 10, 2026 13:17

rickvdl requested a review from a team as a code owner March 10, 2026 13:17

cursor Bot reviewed Mar 10, 2026

View reviewed changes

Comment thread Sources/Paywalls/Events/CustomPaywallEvent.swift Outdated

ajpallares reviewed Mar 10, 2026

View reviewed changes

rickvdl force-pushed the rickvdl/track-custom-paywall-impression-experimental-api branch from caf32cb to 65b09d4 Compare March 11, 2026 11:34

rickvdl added pr:feat A new feature and removed pr:other labels Mar 11, 2026

cursor Bot reviewed Mar 11, 2026

View reviewed changes

Comment thread Tests/TestingApps/PaywallsTester/PaywallsTester/UI/Views/CustomPurchaseLogicPaywall.swift Outdated

rickvdl force-pushed the rickvdl/track-custom-paywall-impression-experimental-api branch from daa0fb6 to 6c6c10a Compare March 11, 2026 15:39

rickvdl requested a review from ajpallares March 11, 2026 16:12

ajpallares approved these changes Mar 11, 2026

View reviewed changes

cursor Bot reviewed Mar 12, 2026

View reviewed changes

Comment thread Tests/APITesters/AllAPITests/ObjcAPITester/RCCustomPaywallImpressionAPI.m

Comment thread Tests/APITesters/AllAPITests/SwiftAPITester/CustomPaywallImpressionAPI.swift

Comment thread Tests/UnitTests/Paywalls/Events/PurchasesCustomPaywallEventsTests.swift

rickvdl force-pushed the rickvdl/track-custom-paywall-impression-experimental-api branch from e3877c9 to c6adc8c Compare March 12, 2026 06:19

ajpallares approved these changes Mar 12, 2026

View reviewed changes

rickvdl added 10 commits March 12, 2026 10:34

Expose trackCustomPaywallImpression as experimental public API

7630059

Addressed PR feedback

6c6b43d

Add missing file to Xcode project

41bf5e2

Fix swiftlint vertical whitespace violation

c4aba7e

Add missing Foundation import

5963292

Remove zero-arg ObjC API test for trackCustomPaywallImpression

acfe8ea

Add back zero-arg ObjC API test for trackCustomPaywallImpression

4747ef8

Remove unrelated file accidentally committed

4ff780d

Add test for multiple impressions in quick succession

bd7858f

Add doc comment guidance about calling once per presentation

dcf8f15

rickvdl added 3 commits March 12, 2026 10:34

Use set comparison for multi-impression test to avoid order dependency

76849fa

Add RCCustomPaywallImpressionAPI to ObjC API tester main.m

a51359f

Fix ObjC API tester: use initWithPaywallId:nil and add import to main.m

5fdd54f

rickvdl force-pushed the rickvdl/track-custom-paywall-impression-experimental-api branch from 7e1746d to 5fdd54f Compare March 12, 2026 09:35

rickvdl merged commit e4d10a0 into main Mar 12, 2026
36 checks passed

rickvdl deleted the rickvdl/track-custom-paywall-impression-experimental-api branch March 12, 2026 10:29

RCGitBot mentioned this pull request Mar 12, 2026

[AUTOMATIC] Release/5.63.0 #6447

Merged

Uh oh!

Conversation

rickvdl commented Mar 9, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Related PRs

Uh oh!

cursor Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ajpallares Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

rickvdl Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

ajpallares Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

ajpallares Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

ajpallares Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rickvdl commented Mar 9, 2026 •

edited by cursor Bot

Loading

cursor Bot left a comment •

edited

Loading