Propagate default package across workflow steps by vegaro · Pull Request #3431 · RevenueCat/purchases-android

vegaro · 2026-05-04T17:59:46Z

Motivation

In a multipage workflow paywall, PackageComponents only live on the terminal step. Early "info" screens have no package components, so selectedPackageInfo is null on them. Price/period template variables like {{ price }} and {{ price_per_year }} can't resolve on those screens.

Description

Adds a default-package fallback. The terminal step is identified by singleStepFallbackId on the workflow (added in #3436). When any step state is built, the terminal step's selectedPackageInfo is applied as the default. Steps with their own PackageComponents ignore the default; steps without one resolve variables against it.

The default is set once per step and never overwritten, so back navigation always shows the same content as the initial render, even if the user changed the selection on the terminal step.

Changes:

PaywallState.Loaded.Components: add defaultPackageInfo and setDefaultPackage(info). setDefaultPackage is idempotent (set once, never overwritten). selectedPackageInfo is now ownSelection ?: defaultPackageInfo.
PaywallViewModel: in updateStateFromWorkflow, pre-compute the singleStepFallbackId step first so its default is in cache before any other step loads. On every step build, apply the fallback step's selectedPackageInfo (idempotency means it only takes effect on the first visit). Log a warning if singleStepFallbackId points to a missing step.
Tests: default-package application on packageless steps, back-navigation preserving the initial default, own selection winning over the default, graceful handling when singleStepFallbackId is missing. Plus extra WorkflowNavigator cases (deep backstack, non-linear navigation).

Note

Medium Risk
Touches workflow state construction/caching and selection precedence, which can subtly affect navigation/backstack behavior and displayed pricing context across steps.

Overview
Adds a default-package fallback to multi-step workflow paywalls: PaywallState.Loaded.Components now stores an idempotent defaultPackageInfo, and selectedPackageInfo resolves as own selection falling back to that default.

PaywallViewModel now precomputes the singleStepFallbackId step to seed the cache, applies the fallback step’s selectedPackageInfo as a default on every step build/prewarm (without overwriting on revisits), and logs when the fallback step ID is missing.

Expands tests to cover context propagation on packageless steps, back-navigation stability, selection precedence, missing-fallback safety, plus additional WorkflowNavigator backstack/loop scenarios.

^{Reviewed by Cursor Bugbot for commit a9a862d. Bugbot is set up for automated code reviews on this repo. Configure here.}

…gation

…tion cases

…avigatorTest

codecov · 2026-05-04T18:22:22Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.47%. Comparing base (67a763d) to head (a9a862d).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3431   +/-   ##
=======================================
  Coverage   79.47%   79.47%           
=======================================
  Files         362      362           
  Lines       14547    14547           
  Branches     1977     1977           
=======================================
  Hits        11561    11561           
  Misses       2190     2190           
  Partials      796      796

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

Introduce setContextPackage()/contextPackageInfo on Components so the ViewModel can supply a default package for steps that have no own package components; selectedPackageInfo falls back to contextPackageInfo when selectedPackageUniqueId is null. Remove selectPackageIfExists and its call site in PaywallViewModel as part of migrating to the new context-based propagation approach. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…rkflow steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…kage approach Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…ackage

…stead of per-step default_package_id Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…ckage idempotent - Restore deleted JSON parsing tests for single_step_fallback_id in WorkflowDetailResolverTest - Move idempotency guard into setContextPackage so the set-once contract is self-enforcing - Add Logger.w when singleStepFallbackId points to a missing step - Add test for graceful degradation when singleStepFallbackId references a non-existent step Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…m:RevenueCat/purchases-android into cesar/2026-05-03-workflow-package-context

…o all steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

facumenzella · 2026-05-06T15:52:45Z

I had a few comments that gh does not let me make 😢

facumenzella

rejecting till GitHub lets me put my comments 🙏

facumenzella · 2026-05-07T07:18:37Z

+        if (newState is PaywallState.Loaded.Components) {
+            val defaultPackage = workflow.singleStepFallbackId
+                ?.let { workflowStepStateCache[it]?.selectedPackageInfo }
+            if (defaultPackage != null) {
+                newState.setDefaultPackage(defaultPackage)
+            }
+        }


I wonder if we could do this at the prewarm stage instead? 🤔

Agreed, but it needs to be here as well for the first step. So the prewarm of the following steps have this (it's idempotent only happens once) so when they load it's ready. Basically:

Prewarmed steps don’t have their defaultPackageInfo set until the user navigates to them. If stepStates is observed by the UI between prewarm completing and actual navigation, those states would have defaultPackageInfo = null. The initial step is built synchronously before prewarm even starts, so the initial step would lose its setDefaultPackage call. So we need to add the setDefaultPackage call inside preWarmWorkflowStepCache but keep it in buildStateFromStep for the initial step.

facumenzella

I think it looks good. Just one nit open for debate 👍

@JZDesign

**This is an automatic release.** ## RevenueCat SDK ### 🐞 Bugfixes * fix: url encode query prameters (RevenueCat#3451) via Jacob Rakidzich (@JZDesign) ## RevenueCatUI SDK ### 🐞 Bugfixes * Fix: dismiss was called before onPurchaseComplete callback invocation (RevenueCat#3353) via Jacob Rakidzich (@JZDesign) * Propagate default package across workflow steps (RevenueCat#3431) via Cesar de la Vega (@vegaro) ### Paywallv2 #### ✨ New Features * feat: Allow disabling of automatic font scaling (RevenueCat#3438) via Jacob Rakidzich (@JZDesign) ### 🔄 Other Changes * Extract `PaywallComponentsImagePreDownloader` (RevenueCat#3448) via Cesar de la Vega (@vegaro) * Simplify `WorkflowTransitionState` with explicit from/to step fields (RevenueCat#3441) via Cesar de la Vega (@vegaro)  --- > [!NOTE] > **Low Risk** > Low risk release bookkeeping: primarily flips version strings from `10.5.0-SNAPSHOT` to `10.5.0` and updates docs/changelogs, with no functional code changes beyond the reported version constant. > > **Overview** > Cuts the `10.5.0` release by switching the project from `10.5.0-SNAPSHOT` to `10.5.0` across build metadata (`.version`, `gradle.properties`, sample/test app `libs.versions.toml`, and `Config.frameworkVersion`). > > Updates release artifacts and documentation pointers: CircleCI docs deploy now syncs the `10.5.0` docs folder to S3, `docs/index.html` redirects to `10.5.0`, and changelogs are rolled forward with the `10.5.0` entries in `CHANGELOG.md`/`CHANGELOG.latest.md`. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 48537d6. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup>

…at#3445) ## Summary Follow-up to RevenueCat#3431. During review of RevenueCat#3431 I noticed that when `singleStepFallbackId` points to the same step as `initialStepId`, the pre-computation guard (`stepWithPackages.id != initialStep.id`) correctly skips re-building the step, but there was no test covering this path. In this edge case `setDefaultPackage` is effectively called on the step with its own `selectedPackageInfo` as input (a self-referential read from the cache). The test verifies that: - No crash occurs - `ownSelection` takes precedence — MONTHLY (the default-by-config package) is still returned correctly ## Test plan - [x] New test passes locally: `singleStepFallbackId equal to initialStepId does not crash and own selection is used` - [x] Full `PaywallViewModelWorkflowTest` suite passes 🤖 Generated with [Claude Code](https://claude.com/claude-code)  --- > [!NOTE] > **Low Risk** > Low risk: adds a unit test only, with no production code changes; the main impact is tighter regression coverage around workflow default package selection. > > **Overview** > Adds a new `PaywallViewModelWorkflowTest` case covering the edge scenario where `workflow.singleStepFallbackId` equals `initialStepId`. > > The test asserts `updateStateFromWorkflow` doesn’t crash and that the initial step’s *own* default package selection still wins (e.g. MONTHLY) rather than being overridden by a self-referential fallback/default package lookup. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit fd9659d. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup>  Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

vegaro added 3 commits May 4, 2026 19:54

fix: propagate selected package across workflow steps on forward navi…

6b50389

…gation

test: expand PaywallViewModelWorkflowTest with propagation and naviga…

3c65b47

…tion cases

test: add deep-backstack and non-linear navigation cases to WorkflowN…

9853f55

…avigatorTest

vegaro added pr:fix A bug fix pr:RevenueCatUI labels May 4, 2026

vegaro changed the title ~~fix: propagate selected package across workflow steps and expand test coverage~~ Propagate selected package across workflow steps and expand test coverage May 4, 2026

vegaro and others added 9 commits May 4, 2026 21:21

feat: apply default_package_id as context package on workflow step load

b890346

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix: use safe JsonPrimitive cast for default_package_id param lookup

96aa6fb

feat: back-propagate terminal step selection as context to earlier wo…

9accccd

…rkflow steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix: guard backward context propagation to packageless steps only

fbdad23

refactor: remove forward package propagation in favour of context-pac…

c4939f5

…kage approach Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix: apply default_package_id context for pre-warmed packageless steps

7f42c94

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore: fix import ordering and remove stub test in workflow context p…

5f3c84e

…ackage

refactor: use single_step_fallback_id for workflow package context in…

4e33440

…stead of per-step default_package_id Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

vegaro changed the title ~~Propagate selected package across workflow steps and expand test coverage~~ Propagate selected package across workflow steps May 5, 2026

vegaro and others added 6 commits May 5, 2026 13:47

renames

5da5ec8

no back navigation

20c7566

Merge branch 'main' into cesar/2026-05-03-workflow-package-context

14c4cc8

Merge branch 'cesar/2026-05-03-workflow-package-context' of github.co…

7b753ba

…m:RevenueCat/purchases-android into cesar/2026-05-03-workflow-package-context

refactor: rename contextPackageInfo to defaultPackageInfo and apply t…

588cecf

…o all steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

vegaro marked this pull request as ready for review May 6, 2026 12:46

vegaro requested a review from a team as a code owner May 6, 2026 12:46

vegaro requested a review from facumenzella May 6, 2026 12:46

facumenzella reviewed May 6, 2026

View reviewed changes

Comment thread ...venuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/PaywallViewModel.kt

This comment was marked as resolved.

Sign in to view

facumenzella approved these changes May 6, 2026

View reviewed changes

facumenzella mentioned this pull request May 6, 2026

Propagate selected package forward across workflow steps RevenueCat/purchases-ios#6735

Closed

2 tasks

facumenzella requested changes May 6, 2026

View reviewed changes

This was referenced May 6, 2026

Resolve price/period variables on packageless workflow screens RevenueCat/purchases-ios#6737

Merged

test: cover singleStepFallbackId == initialStepId edge case #3445

Merged

facumenzella reviewed May 7, 2026

View reviewed changes

facumenzella approved these changes May 7, 2026

View reviewed changes

add to prewarm

a9a862d

vegaro enabled auto-merge May 7, 2026 10:16

vegaro added this pull request to the merge queue May 7, 2026

Merged via the queue into main with commit 175c252 May 7, 2026
38 checks passed

vegaro deleted the cesar/2026-05-03-workflow-package-context branch May 7, 2026 10:51

vegaro changed the title ~~Propagate selected package across workflow steps~~ Propagate default package across workflow steps May 7, 2026

RCGitBot mentioned this pull request May 7, 2026

[AUTOMATIC] Release/10.5.0 #3454

Merged

facumenzella mentioned this pull request May 14, 2026

Propagate default package across workflow steps RevenueCat/purchases-ios#6790

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Propagate default package across workflow steps#3431

Propagate default package across workflow steps#3431
vegaro merged 19 commits into
mainfrom
cesar/2026-05-03-workflow-package-context

vegaro commented May 4, 2026 •

edited by cursor Bot

Loading

Uh oh!

codecov Bot commented May 4, 2026 •

edited

Loading

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

facumenzella commented May 6, 2026

Uh oh!

facumenzella left a comment

Uh oh!

facumenzella May 7, 2026

Uh oh!

vegaro May 7, 2026 •

edited

Loading

Uh oh!

facumenzella left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

vegaro commented May 4, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Description

Uh oh!

codecov Bot commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

facumenzella commented May 6, 2026

Uh oh!

facumenzella left a comment

Choose a reason for hiding this comment

Uh oh!

facumenzella May 7, 2026

Choose a reason for hiding this comment

Uh oh!

vegaro May 7, 2026 • 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!

facumenzella left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vegaro commented May 4, 2026 •

edited by cursor Bot

Loading

codecov Bot commented May 4, 2026 •

edited

Loading

vegaro May 7, 2026 •

edited

Loading