Use `Block store` to backup anonymous user ids across installations by tonidero · Pull Request #2595 · RevenueCat/purchases-android

tonidero · 2025-08-07T15:21:35Z

Description

Based on #2594

This uses Block store to store the anonymous user id in the cloud when we find it has any purchases. This user ID will be recovered and aliased together with any new anonymous user id when restoring or completing a purchase.

This will be useful to avoid issues when trying to restore purchases with consumed consumables that were meant to never be consumed.

…s users purchases

tonidero · 2025-08-07T15:23:26Z

    <application
            android:name="com.revenuecat.purchasetester.MainApplication"
-            android:allowBackup="true"
+            android:allowBackup="false"


This disables auto backup, which helps to test block store. Auto backup should also help minimize the spread of this issue in any case, and shouldn't conflict with these changes.

tonidero · 2025-08-07T15:25:09Z

+        const val BLOCKSTORE_MAX_ENTRIES = 16
+    }
+
+    fun storeUserIdIfNeeded(customerInfo: CustomerInfo) {


We are only storing if:

The user id is anonymous

Has purchases

No previous user id was stored

We haven't reached the maximum 16 entries of storage for Block store.

We try to store:

When obtaining CustomerInfo on app foreground

When making a purchase

tonidero · 2025-08-07T15:29:34Z

+        }
+    }
+
+    fun recoverAndAliasBlockstoreUserIfNeeded(callback: () -> Unit) {


We will try to recover the user Id from Block store and alias the users together if:

Current user is anonymous

There is a user Id cached in Block store

That user id is not the same as the current user id.

We try to do this:

When calling restorePurchases

When completing a purchase

tonidero · 2025-08-07T15:30:19Z

+        }
+    }
+
+    fun clearBlockstoreUserIdBackupIfNeeded(callback: () -> Unit) {


We clear the block store backup when a user logs in. In that case, we shouldn't rely on this system anymore and the developer should just rely on their user ids.

Should we not alias whatever ID we have in the block store with the new ID? We could have an ID in the Block store with consumed purchases?

But the moment the user calls logIn, those users already get aliased (as long as the new user id is not anonymous) so we don't need to alias them again. The developer can just rely in the user Id they passed us, which should already have the purchases of the user before logging in.

codecov · 2025-08-07T15:40:18Z

Codecov Report

❌ Patch coverage is 85.29412% with 20 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.38%. Comparing base (b31b0d8) to head (8f59f4f).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...evenuecat/purchases/blockstore/BlockstoreHelper.kt	85.00%	7 Missing and 5 partials ⚠️
.../com/revenuecat/purchases/PurchasesOrchestrator.kt	84.61%	4 Missing and 2 partials ⚠️
...m/revenuecat/purchases/identity/IdentityManager.kt	88.23%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2595      +/-   ##
==========================================
+ Coverage   78.32%   78.38%   +0.06%     
==========================================
  Files         300      301       +1     
  Lines       11126    11229     +103     
  Branches     1551     1561      +10     
==========================================
+ Hits         8714     8802      +88     
- Misses       1732     1741       +9     
- Partials      680      686       +6

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

JayShortway

Thanks for taking care of this!! 💪

JayShortway · 2025-08-08T08:12:03Z

-                    dispatch { callback?.onError(error) }
-                },
-            )
+            blockstoreHelper.clearBlockstoreUserIdBackupIfNeeded {


What if people do things very wrong and call logIn with an anonymous ID? Should we maybe check for that (to be absolutely sure), and alias in that case?

I would say they are seriously holding it wrong 😅 And in that case, this would clear the block store user id, and it would be cached again on the next app foreground/customer info refresh.

So I guess the case we would miss in this case is if you make a purchase before the logIn, then logIn, then uninstall before the new userId is cached. We would lose the userId that did the purchase.

All things said, I think it's quite an edge case... but then again, I think we should be able to handle it yeah... I will try to do this today!

Ah wait, logIn didn't create aliases, if the new user id is anonymous I forgot... So yeah, we might need to alias the users ourselves in this case. Still quite an edge case, but better to control it yeah

Actually, what I'm going to do is to avoid clearing the user id from block store if the new user id is anonymous. It won't give the new user any entitlements, but that's in line with what was happening now I think. If the new anonymous user restores, they should still be able to obtain those purchases.

I guess this could still cause some issues, if they logIn with a non-anonymous user AFTER logging in with an anonymous user... TBH, not sure how much we want to handle this edge case though... Wdyt?

avoid clearing the user id from block store if the new user id is anonymous

I think that makes sense!

I guess this could still cause some issues, if they logIn with a non-anonymous user AFTER logging in with an anonymous user...

A restore would recover from this I guess? If so, I'd say that's acceptable.

JayShortway · 2025-08-08T08:37:05Z

+        }
+    }
+
+    fun clearBlockstoreUserIdBackupIfNeeded(callback: () -> Unit) {


Should we not alias whatever ID we have in the block store with the new ID? We could have an ID in the Block store with consumed purchases?

JayShortway

Thanks for making the changes! 🙏 Just the configure vs onAppForegrounded thing, but not a blocker for me!

…dd-blockstore-anonymous-user-id-caching-and-recovery

…nd we try to clear the cached value before that happens

JayShortway

Thanks for this!!

JayShortway · 2025-08-19T15:10:04Z

+    applicationContext: Context,
+    private val identityManager: IdentityManager,
+    private val blockstoreClient: BlockstoreClient = Blockstore.getClient(applicationContext),
+    private val ioScope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.IO.limitedParallelism(1)),


Is the limited parallelism to avoid concurrency issues? If so, I guess we could still technically have 2 instances of BlockStoreHelper. Not a huge problem probably.

I think we should only be able to have one right? Since it's built once and attached to the purchases orchestrator if I'm correct.

And yeah, this is to solve a possible race condition of a user logging in after we start storing the user id in blockstore, and it executing the clearing of blockstore before actually storing the user id, ending up with a user ID stored that has a non-anonymous alias. It's very unlikely but I thought if we execute these operations sequentially, this shouldn't be an issue.

Yea true! But there's nothing enforcing this to be a singleton (we could make the mistake of constructing BlockStoreHelper() in some other place), but I think that's totally fine.

@tonidero

**This is an automatic release.** ## RevenueCat SDK ### 🐞 Bugfixes * Use `Block store` to backup anonymous user ids across installations (#2595) via Toni Rico (@tonidero) ## RevenueCatUI SDK ### Paywallv2 #### 🐞 Bugfixes * Fixes price formatting discrepancies on Paywalls for `{{ product.price_per_[day|week|month|year] }}` (#2604) via JayShortway (@JayShortway) ### 🔄 Other Changes * Revert dokka 2 and gradle 9 update (#2618) via Toni Rico (@tonidero) * Introduce runtime annotations library and add stability annotations for increasing UI performances (#2608) via Jaewoong Eum (@skydoves) * Override presented offering context paywalls without offering (#2612) via Toni Rico (@tonidero) * Add APIs for hybrid SDKs to set presentedOfferingContext (#2610) via Toni Rico (@tonidero) * Bump Baseline Profiles to 1.4.0 and update profiles (#2611) via Jaewoong Eum (@skydoves) * Migrate deprecated kotlinOptions to compilerOptions (#2607) via Jaewoong Eum (@skydoves) * [AUTOMATIC][Paywalls V2] Updates paywall-preview-resources submodule (#2613) via RevenueCat Git Bot (@RCGitBot) * Migrate amazon & debugview modules to KTS (#2327) via Jaewoong Eum (@skydoves) * Update to Dokka 2.0.0 (#2609) via Toni Rico (@tonidero) * Add log when restoring purchases finds no purchases with some troubleshooting (#2599) via Toni Rico (@tonidero) Co-authored-by: revenuecat-ops <ops@revenuecat.com>

…2595) ### Description Based on #2594 This uses [Block store](https://developer.android.com/identity/block-store) to store the anonymous user id in the cloud when we find it has any purchases. This user ID will be recovered and aliased together with any new anonymous user id when restoring or completing a purchase. This will be useful to avoid issues when trying to restore purchases with consumed consumables that were meant to never be consumed.

tonidero added 6 commits August 7, 2025 15:03

Add aliasUsers backend call

5fa71d9

Add Block store to backup anonymous IDs and restore consumed anonymou…

a190d03

…s users purchases

Change to use alias user endpoint

d660ccd

Disable auto backup in purchase tester for easier testing of block store

fbd30b2

Store anonymous user id upon logout if needed

8daca7d

Change to only store if anonymous user has any purchases

b400ba7

tonidero added the pr:fix A bug fix label Aug 7, 2025

tonidero commented Aug 7, 2025

View reviewed changes

tonidero added 2 commits August 7, 2025 18:22

Add BlockstoreHelperTests

4d35354

Add IdentityManager tests

c7c3e56

JayShortway reviewed Aug 8, 2025

View reviewed changes

Changes from review

418f2fa

tonidero marked this pull request as ready for review August 8, 2025 16:45

tonidero requested a review from a team August 8, 2025 16:45

JayShortway approved these changes Aug 8, 2025

View reviewed changes

Comment thread purchases/src/main/kotlin/com/revenuecat/purchases/PurchasesOrchestrator.kt

Base automatically changed from add-alias-users-endpoint to main August 8, 2025 17:03

tonidero mentioned this pull request Aug 19, 2025

Restore Purchase not working after updating to 9.1.1 in Android #2566

Open

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

6787f50

…dd-blockstore-anonymous-user-id-caching-and-recovery

vegaro reviewed Aug 19, 2025

View reviewed changes

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

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

Fix possible race condition, and some cleanup

1a98c10

tonidero requested review from JayShortway and vegaro August 19, 2025 12:47

Fix possible race condition if login happens after trying to store, a…

2222e08

…nd we try to clear the cached value before that happens

JayShortway approved these changes Aug 19, 2025

View reviewed changes

vegaro approved these changes Aug 19, 2025

View reviewed changes

Comment thread purchases/src/main/kotlin/com/revenuecat/purchases/blockstore/BlockstoreHelper.kt

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

Remove outdated comment

8f59f4f

tonidero enabled auto-merge August 19, 2025 15:54

tonidero added this pull request to the merge queue Aug 19, 2025

Merged via the queue into main with commit e701fd8 Aug 19, 2025
20 checks passed

tonidero deleted the add-blockstore-anonymous-user-id-caching-and-recovery branch August 19, 2025 16:36

This was referenced Aug 20, 2025

[AUTOMATIC] Release/9.3.1 #2616

Closed

[AUTOMATIC] Release/9.3.1 #2619

Merged

tonidero mentioned this pull request Aug 25, 2025

Release/8.23.0 #2631

Closed

Uh oh!

Conversation

tonidero commented Aug 7, 2025

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!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

JayShortway 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JayShortway 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!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Aug 7, 2025 •

edited

Loading