Propagate default package across workflow steps by facumenzella · Pull Request #6790 · RevenueCat/purchases-ios

facumenzella · 2026-05-14T12:01:47Z

Supersedes and closes #6735.

Checklist

Unit tests
Follow-up issues for purchases-android and hybrids

Motivation

Multi-step workflow paywalls had no way to carry the user's package selection forward. If a user picked Annual on step 1 and navigated to step 2, that step would fall back to the workflow's singleStepFallbackId default or its own page default. The same issue applied on back navigation — returning to a previous step and going forward again re-applied a stale default.

Android counterpart: RevenueCat/purchases-android#3431

Description

Per-step PackageContext cache

WorkflowPaywallView now maintains a [String: PackageContext] dictionary keyed by step ID. The first time a step is rendered its PackageContext is built and stored; subsequent renders (e.g. back + forward) reuse the cached instance, so any in-flight user selection is preserved across navigation.

Step-scoped workflowPackageContext environment

Each page now injects its own effectiveWorkflowPackageContext (the per-step WorkflowPackageContext) into the environment rather than broadcasting the global singleStepFallbackId context for every step. This means TabsComponentView and any other package-initialisation code reads the correct step-local default, not the workflow fallback.

WorkflowContext.effectivePackageContext(for:) — new helper that returns the step's own package context when the step has packages, falling back to the global workflowPackageContext for packageless steps.

selectedPackageContextOverride on PaywallsV2View

An optional override allows WorkflowPaywallView to inject the pre-built (and potentially already-mutated by the user) PackageContext directly instead of having PaywallsV2View construct a fresh one on every render.

Analytics defaultPackage fix

planSelectionDefaultPackage now derives from the stable, configured default rather than the mutable current selection. The code in LoadedPaywallsV2View.body is unchanged — it still reads self.workflowPackageContext?.selectedPackage — but the value it sees is now the step-local effectiveWorkflowPackageContext injected per-step rather than the global workflow context broadcast to every step. Since WorkflowPackageContext.selectedPackage is immutable, this is always the step's configured default, not the user's in-flight selection.

Sheet dismissal fix

RootView snapshots the package before a selection sheet opens; when the sheet is dismissed without a new choice in a workflow context, it restores the snapshot rather than falling back to the global workflow default.

Testing

WorkflowContextTests — packageContext(for:) and effectivePackageContext(for:): selected-by-default, first-package fallback, packageless step (nil), missing step (nil), step-local beats global fallback, packageless step falls back to global, no packages anywhere (nil).

WorkflowPaywallViewTests — packageContext(for:) via WorkflowContext for a step with own packages, a packageless step, and a missing step.

Note

Medium Risk
Updates workflow navigation and package-selection state in Paywalls V2, so regressions could affect which package is preselected/purchased across steps, tabs, and sheets.

Overview
Enables package selection carry-forward across multi-step Paywalls V2 workflows by caching a per-step PackageContext in WorkflowPaywallView, injecting a step-scoped workflowPackageContext, and letting PaywallsV2View accept a selectedPackageContextOverride so cached selections are reused rather than rebuilt.

WorkflowContext now exposes packageContext(for:) and effectivePackageContext(for:preferring:) to resolve step-local packages with fallback to the workflow’s singleStepFallbackId package context, and TabsComponentView/RootView were adjusted to avoid overwriting cached selections (tab initialization prefers the parent’s cached package; sheet dismissal restores the pre-sheet snapshot in workflow contexts).

Adds focused unit tests for the new workflow back-navigation destination API, package-context resolution/carry-forward behavior, tab revisit inheritance, and sheet dismissal restoration.

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

Each workflow step now gets its own cached PackageContext. Package-bearing steps use their own package selection; packageless steps fall back to the workflow's singleStepFallbackId context. Sheet dismissal restores the step-local selection rather than resetting to the workflow-global fallback. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Add WorkflowContext.effectivePackageContext(for:) which returns the step's own package context when it has package components, falling back to the global workflowPackageContext otherwise. WorkflowPaywallView now stores this per-page and sets it as the workflowPackageContext env value, so TabsComponentView and any other consumer automatically gets the step-scoped default rather than the global workflow fallback. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@published

After the P1 fix, workflowPackageContext in the env is the step-local stable WorkflowPackageContext struct. selectedPackageContextOverride.package is a @published var that mutates on user selection, so using it as defaultPackage caused planSelectionDefaultPackage to track the user's current selection rather than the page's configured default. Removing the override prefix restores correct, stable defaultPackage derivation. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

effectivePackageContext already falls back to workflowPackageContext internally, so the trailing ?? workflowPackageContext was unreachable. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

When navigating forward from step N to step N+1, step N+1 now opens with step N's current selection if that package is available there. Falls back to the workflow-global default (singleStepFallbackId), then the step's own authored default as last resort. Backward navigation is unchanged: the cached PackageContext for the previous step is returned as-is, so selection does not propagate back. Revisiting a step via forward navigation always re-derives from the current step's live selection (not a stale first-visit cache). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Once a step's PackageContext has been initialized (first visit), subsequent forward navigations to that step return the cached context unchanged. This matches Android's setDefaultPackage idempotency: a step that has already been visited keeps its selection — whether that came from a prior carry-forward or from the user tapping a package on that step. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…ontext carry-forward - Make `buildPackageContext` internal so tests can call it directly - `testPackageContextMutationsPropagateThroughStepCacheReference`: catches any future refactoring of PackageContext from class to struct, which would silently break back-navigation selection preservation - `testBuildPackageContextCarriesForwardPreferredPackageWhenAvailableInStep`: end-to-end forward carry-forward at the WorkflowPaywallView layer - `testBuildPackageContextReturnsEmptyContextForPackagelessStepWithNoFallback`: guards the nil-effectiveContext → empty PackageContext path Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Documents that `WorkflowPaywallView.renderedPageForStep` uses the cache-hit path (ignoring `carryForwardPackage`) when a step already has a `PackageContext` in `stepPackageContexts`, preserving the user's own prior selection over a new carry-forward from the previous step. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…xt(for:preferring:) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

… test `testPackageContextMutationsPropagateThroughStepCacheReference` only tested Swift reference semantics in isolation. The same invariant is already exercised meaningfully in `testCachedStepContextTakesPrecedenceOverCarryForwardOnRevisit`, which now carries a note pointing to the exact mutation line. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…rce step's In multi-offering workflows where two steps expose the same package identifier from different offerings, effectivePackageContext(for:preferring:) was returning the source step's Package instance directly. Switch both the preferredPackage path and the wfDefault path from contains+direct-return to first(where:) so the selectedPackage always comes from base.packages (the destination step's list). Tests: two new WorkflowContextTests cases covering each path with distinct offerings. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Extract sheet-dismissal package restoration into `RootView.restoredPackageAfterSheetDismissal` (static, testable) and add `RootViewSheetDismissalTests` covering workflow-context restore, nil-snapshot fallback, non-workflow-context always-default, and nil-default edge case. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

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

The property was set in init but never read — the init body at line 149 already uses the parameter directly (still in scope), so self.selectedPackageContextOverride was unreachable dead weight holding an unnecessary strong reference. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

cursor

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

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

^{Reviewed by Cursor Bugbot for commit 94b61ac. Configure here.}

vegaro

one question on behavior

vegaro

It would be good to test it still works on sheets and tabs but I think this is good to go

facumenzella added pr:feat A new feature pr:RevenueCatUI paywalls_v2 labels May 14, 2026

facumenzella mentioned this pull request May 14, 2026

Propagate selected package forward across workflow steps #6735

Closed

2 tasks

facumenzella and others added 11 commits May 14, 2026 07:42

Remove redundant fallback in buildPackageContext

6cf1b9a

effectivePackageContext already falls back to workflowPackageContext internally, so the trailing ?? workflowPackageContext was unreachable. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Avoid redundant workflowPackageContext scans in effectivePackageConte…

eaf0c51

…xt(for:preferring:) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

facumenzella force-pushed the worktree-majestic-mapping-dijkstra branch from 42637bc to 2f81a5c Compare May 14, 2026 13:44

facumenzella marked this pull request as ready for review May 14, 2026 13:51

facumenzella requested review from a team as code owners May 14, 2026 13:51

vegaro reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/Components/Root/RootView.swift Outdated

vegaro reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift Outdated

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift

Comment thread RevenueCatUI/Purchasing/WorkflowContext.swift

facumenzella and others added 2 commits May 14, 2026 10:17

Inline wfPackageContext assignment

d25de91

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

Fix workflow package context per page

a0db1b4

cursor Bot reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift

Clarify package sheet snapshot naming

aa34cca

facumenzella added 4 commits May 14, 2026 10:31

Precompute workflow package context

abe5e19

Add RootView sheet dismissal tests to Xcode project

634130c

Guard workflow package context cache invariants

a08e524

Clarify workflow package context cache inputs

8147ed9

cursor Bot reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/Components/Tabs/TabsComponentView.swift

Guard back navigation cache invariant

cd6f942

cursor Bot reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift

Split back-navigation rendering path

9eb213d

cursor Bot reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift Outdated

Avoid crashing on missing back-navigation cache

5945577

cursor Bot reviewed May 14, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/PaywallsV2View.swift Outdated

vegaro reviewed May 18, 2026

View reviewed changes

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift Outdated

Comment thread RevenueCatUI/Templates/V2/WorkflowPaywallView.swift Outdated

facumenzella and others added 2 commits May 18, 2026 11:21

Address workflow navigation review comments

4224350

Merge branch 'main' into worktree-majestic-mapping-dijkstra

f3647d6

facumenzella requested a review from vegaro May 18, 2026 17:45

Merge branch 'main' into worktree-majestic-mapping-dijkstra

94b61ac

cursor Bot reviewed May 18, 2026

View reviewed changes

Comment thread RevenueCatUI/Purchasing/WorkflowContext.swift Outdated

Remove unused workflow package context overload

0d39f25

vegaro reviewed May 18, 2026

View reviewed changes

vegaro approved these changes May 21, 2026

View reviewed changes

facumenzella merged commit af6b9cf into main May 25, 2026
18 of 20 checks passed

facumenzella deleted the worktree-majestic-mapping-dijkstra branch May 25, 2026 00:47

RCGitBot mentioned this pull request May 27, 2026

[AUTOMATIC] Release/5.75.0 #6856

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Propagate default package across workflow steps#6790

Propagate default package across workflow steps#6790
facumenzella merged 27 commits into
mainfrom
worktree-majestic-mapping-dijkstra

facumenzella commented May 14, 2026 •

edited by cursor Bot

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Uh oh!

Uh oh!

vegaro left a comment

Uh oh!

vegaro left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

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

Uh oh!

Checklist

Motivation

Description

Testing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vegaro left a comment

Choose a reason for hiding this comment

Uh oh!

vegaro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

facumenzella commented May 14, 2026 •

edited by cursor Bot

Loading