Add non paid revenue reporting infra by tonidero · Pull Request #2728 · RevenueCat/purchases-android

tonidero · 2025-10-14T15:53:24Z

Description

Implements ad event tracking infrastructure for RevenueCat. This provides the client-side foundation needed to report ad impressions, clicks, and revenue alongside subscription data for comprehensive LTV tracking.

In follow-up PRs:

Add size limit to ad events file Add file size limit to events tracking files #2841
Flush multiple batches, instead of a single one (with a limit) Flush multiple event batches #2842

tonidero · 2025-10-14T15:54:42Z

    private val appSessionID: UUID = Companion.appSessionID,
    private val legacyEventsFileHelper: EventsFileHelper<PaywallStoredEvent>,
    private val fileHelper: EventsFileHelper<BackendStoredEvent>,
+    private val adFileHelper: EventsFileHelper<BackendStoredEvent.Ad>,


This PR is still WIP but this is the last approach I mentioned here. I believe it minimizes the code duplication quite a bit. Wdyt @polmiro @JayShortway ?

Lmk what you think about this approach (different track methods for different types of events). I think we could also pass the URL as a parameter to the events manager and create multiple event managers. However, I don't think the current approach is that error-prone since the types of events for ads and current are different.

I agree with having different storage files given they function as a queue that gets cleared independently.

When it comes to event managers I am a bit in the middle, let me share my thoughts see what you think:

Tracking:

From a caller perspective all the event tracking calls should be going through the same object. And how that gets delivered is an implementation detail. This hints to me that we should have a single events manager when it comes to tracking.

Flushing:

Paywall events flushing: There are a couple of trigger points that specific only to the paywall events. These in my opinion should only go to the event manager that handles paywall events and not the one handling ad events.

Ad events flushing: Given the amount of events, there may be added complexities to handle in the ad event manager (just throwing some rough potential ideas):

sending more one batch of events at a time.

having some sort of time-based flushing to avoid waiting too long

having some event count flushing to prevent accumulating too many events.

Maybe these apply to both event managers, maybe not, I am not sure.

These hint to me that we may want separate events manager when it comes to flushing.

Hmm well, regarding flushing behavior, if we want to have different behavior between ad and paywalls&customerCenter events, having it be 2 instances of the EventManger might be a bit trickier... Right now the EventManger, syncs only the oldest 50 events for paywalls/customer center events. But maybe we want to perform multiple requests for Ads, if there are more than 50 events, so they don't accumulate, which would require changes inside the EventManager...

Having said that, I think it would be better to try to keep the logic for flushing the same/similar, since the events seem relatively similar in importance. At this point, I think I could go either way. Will implement the 2 instances of the EventManager though, since it might be slightly cleaner 👍

I agree with the thoughts, this is why I wanted to separate this part in a different PR since it seems prone to require some more back and forth.

tonidero

Not finished, still need to verify property names, add tests etc, but would appreciate a look @polmiro @RevenueCat/coresdk

tonidero · 2025-10-15T16:24:57Z

    private val appSessionID: UUID = Companion.appSessionID,
    private val legacyEventsFileHelper: EventsFileHelper<PaywallStoredEvent>,
    private val fileHelper: EventsFileHelper<BackendStoredEvent>,
+    private val adFileHelper: EventsFileHelper<BackendStoredEvent.Ad>,


Lmk what you think about this approach (different track methods for different types of events). I think we could also pass the URL as a parameter to the events manager and create multiple event managers. However, I don't think the current approach is that error-prone since the types of events for ads and current are different.

tonidero · 2025-10-15T16:25:57Z

-    @get:Synchronized
-    @set:Synchronized
-    private var flushInProgress = false
+    private var flushInProgress = AtomicBoolean(false)


This felt safer 😅

codecov · 2025-10-16T14:08:14Z

Codecov Report

❌ Patch coverage is 90.09901% with 20 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.15%. Comparing base (1831083) to head (3d41fbb).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...n/com/revenuecat/purchases/ads/events/AdTracker.kt	75.00%	6 Missing and 5 partials ⚠️
...purchases/ads/events/networking/AdEventsRequest.kt	0.00%	3 Missing ⚠️
...evenuecat/purchases/common/events/EventsManager.kt	87.50%	0 Missing and 3 partials ⚠️
...otlin/com/revenuecat/purchases/PurchasesFactory.kt	94.73%	1 Missing ⚠️
...revenuecat/purchases/common/events/BackendEvent.kt	95.23%	0 Missing and 1 partial ⚠️
...ecat/purchases/common/events/BackendStoredEvent.kt	97.77%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2728      +/-   ##
==========================================
+ Coverage   77.98%   78.15%   +0.17%     
==========================================
  Files         320      323       +3     
  Lines       12520    12706     +186     
  Branches     1727     1743      +16     
==========================================
+ Hits         9764     9931     +167     
- Misses       2028     2038      +10     
- Partials      728      737       +9

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

…c-ads-tracking

tonidero · 2025-11-14T15:16:44Z

+/**
+ * Tracks ad-related events such as ad displays, opens, and revenue.
+ */
+@InternalRevenueCatAPI


Note that I'm marking this as @InternalRevenueCatAPI, so developers would need to explicitedly opt-in to use it, but it can still theoretically be used in the wild (very unlikely), unlike in iOS, where it's behind a compiler flag. I can add a compiler flag to disable tracking at all until we're ready, but I was wondering what the plan is to ship this? @polmiro

What there be the risks of someone using this? From the stability of public APIs perspective, I think this is OK, even if we want to make changes to it while marked as @InternalRevenueCatAPI

It's behind a feature flag in the backend as well, so it would basically have events that would fail to send, and since it's with a 4xx, it would mark them as sent, so I think very low right now.

ajpallares

Great work on this!

ajpallares · 2025-11-20T11:22:42Z

+/**
+ * Tracks ad-related events such as ad displays, opens, and revenue.
+ */
+@InternalRevenueCatAPI


What there be the risks of someone using this? From the stability of public APIs perspective, I think this is OK, even if we want to make changes to it while marked as @InternalRevenueCatAPI

Removed WIP comment regarding event flushing frequency.

rickvdl

Nice work!

@facumenzella

**This is an automatic release.** > [!WARNING] > If you don't have any login system in your app, please make sure your one-time purchase products have been correctly configured in the RevenueCat dashboard as either consumable or non-consumable. If they're incorrectly configured as consumables, RevenueCat will consume these purchases. This means that users won't be able to restore them from version 9.0.0 onward. > Non-consumables are products that are meant to be bought only once, for example, lifetime subscriptions. ## RevenueCat SDK ### 🐞 Bugfixes * Restore Purchases config automatically in CustomerCenter (#2867) via Facundo Menzella (@facumenzella) * Handle error reading `errorStream` in some devices (#2865) via Toni Rico (@tonidero) * [MON-1122] Revert variable rounding logic to not round up (#2857) via Pol Piella Abadia (@polpielladev) ## RevenueCatUI SDK ### Paywallv2 #### 🐞 Bugfixes * Select default package on Sheet dismissal (#2861) via Cesar de la Vega (@vegaro) ### Customer Center #### ✨ New Features * CC-581 | Allow for support ticket creation (#2810) via Rosie Watson (@RosieWatson) ### 🔄 Other Changes * Bump fastlane-plugin-revenuecat_internal from `7328ea7` to `efca663` (#2864) via dependabot[bot] (@dependabot[bot]) * Bump fastlane from 2.228.0 to 2.229.0 (#2863) via dependabot[bot] (@dependabot[bot]) * Bump fastlane-plugin-revenuecat_internal from `083ced9` to `7328ea7` (#2862) via dependabot[bot] (@dependabot[bot]) * Runs plugin actions from correct directory (#2858) via JayShortway (@JayShortway) * Flush multiple event batches (#2842) via Toni Rico (@tonidero) * Add file size limit to events tracking files (#2841) via Toni Rico (@tonidero) * Make events manager be supported in Android < 24 (#2854) via Toni Rico (@tonidero) * Add non paid revenue reporting infra (#2728) via Toni Rico (@tonidero) * Fix backend integration tests (#2860) via Toni Rico (@tonidero) * Track `connection_error_reason` property in diagnostics (#2855) via Toni Rico (@tonidero) * Uses some git+GitHub lanes from Fastlane plugin (#2856) via JayShortway (@JayShortway) * Add client side timeout logic for endpoints that support fallback URLs (#2807) via Toni Rico (@tonidero) * [EXTERNAL] Fix deprecation warnings in examples module (#2852) contributed by @gojoel (#2853) via Toni Rico (@tonidero) * Bump fastlane-plugin-revenuecat_internal from `9f78bb9` to `083ced9` (#2848) via dependabot[bot] (@dependabot[bot]) Co-authored-by: revenuecat-ops <ops@revenuecat.com>

…2871) ### Description This is a follow-up from #2728 In iOS, we're passing an object to the track methods for non paid revenue tracking, but we were passing the individual parameters in Android. After thinking about it, passing an object allows for better extensibility, so modifying the API for android. This is technically a breaking change, but the API is still internal, so it should be ok.

WIP: Add non paid revenue reporting infra

d1bfcb5

tonidero added the pr:other label Oct 14, 2025

tonidero commented Oct 14, 2025

View reviewed changes

tonidero added 4 commits October 15, 2025 12:00

Make event type enum internal

7326d09

Add public API and final internal architecture

b9e67a2

Call flush ad events

52d2dd0

Change ad endpoint url

4afa156

tonidero commented Oct 15, 2025

View reviewed changes

tonidero requested review from a team and polmiro October 15, 2025 16:27

Fix tests

993015d

tonidero added 8 commits October 16, 2025 16:10

Move to have multiple EventManagers

d791900

Merge branch 'main' of github.com:RevenueCat/purchases-android into r…

3877c96

…c-ads-tracking

Add docs

07087e2

Merge branch 'main' of github.com:RevenueCat/purchases-android into r…

af5330b

…c-ads-tracking

Merge branch 'main' of github.com:RevenueCat/purchases-android into r…

2547e24

…c-ads-tracking

Remove extra public API

c6be67c

Fixes on expected types for ad events

b8e5dca

Improve typing of mediatorName and precision

4237221

tonidero changed the title ~~WIP: Add non paid revenue reporting infra~~ Add non paid revenue reporting infra Nov 14, 2025

Add tests

86b11c3

tonidero marked this pull request as ready for review November 14, 2025 12:12

tonidero commented Nov 14, 2025

View reviewed changes

tonidero requested a review from a team November 14, 2025 15:26

tonidero mentioned this pull request Nov 17, 2025

Add file size limit to events tracking files #2841

Merged

Merge branch 'main' into rc-ads-tracking

800bba2

JayShortway reviewed Nov 18, 2025

View reviewed changes

Comment thread purchases/src/main/kotlin/com/revenuecat/purchases/ads/events/AdTracker.kt

Comment thread purchases/src/main/kotlin/com/revenuecat/purchases/PurchasesFactory.kt Outdated

Small refactor to avoid duplication

1b6a130

tonidero requested a review from JayShortway November 18, 2025 14:05

Merge branch 'main' into rc-ads-tracking

0dcb7ec

ajpallares approved these changes Nov 20, 2025

View reviewed changes

tonidero added 2 commits November 20, 2025 13:04

Remove WIP comment from flushPaywallEvents

e24189a

Removed WIP comment regarding event flushing frequency.

Merge branch 'main' into rc-ads-tracking

3d41fbb

tonidero enabled auto-merge November 20, 2025 12:24

rickvdl approved these changes Nov 20, 2025

View reviewed changes

tonidero added this pull request to the merge queue Nov 20, 2025

Merged via the queue into main with commit 679a2cb Nov 20, 2025
23 checks passed

tonidero deleted the rc-ads-tracking branch November 20, 2025 12:52

RCGitBot mentioned this pull request Nov 25, 2025

[AUTOMATIC] Release/9.15.0 #2868

Merged

tonidero mentioned this pull request Nov 25, 2025

Extract parameters for non paid revenue tracking API to use objects #2871

Merged

Uh oh!

Conversation

tonidero commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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!

tonidero left a comment

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!

codecov Bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

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!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rickvdl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tonidero commented Oct 14, 2025 •

edited

Loading

codecov Bot commented Oct 16, 2025 •

edited

Loading