fix: RemoteFeatureFlagController client version change cache invalidation#7827
Open
Prithpal-Sooriya wants to merge 6 commits intomainfrom
Open
fix: RemoteFeatureFlagController client version change cache invalidation#7827Prithpal-Sooriya wants to merge 6 commits intomainfrom
Prithpal-Sooriya wants to merge 6 commits intomainfrom
Conversation
Co-authored-by: prithpal.sooriya <prithpal.sooriya@consensys.net>
|
Cursor Agent can help with this pull request. Just |
Co-authored-by: prithpal.sooriya <prithpal.sooriya@consensys.net>
Co-authored-by: prithpal.sooriya <prithpal.sooriya@consensys.net>
Prithpal-Sooriya
force-pushed
the
cursor/client-version-cache-invalidation-4c09
branch
from
c1f8201 to
016bbe9
Compare
Prithpal-Sooriya
changed the title
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
packages/remote-feature-flag-controller/src/remote-feature-flag-controller.ts
Outdated
Show resolved
Hide resolved
DDDDDanica
reviewed
Feb 4, 2026
packages/remote-feature-flag-controller/src/remote-feature-flag-controller.test.ts
Outdated
Show resolved
Hide resolved
DDDDDanica
reviewed
Feb 4, 2026
packages/remote-feature-flag-controller/src/remote-feature-flag-controller.test.ts
Show resolved
Hide resolved
- clean up jsdoc comments - add additional assertion that cache is set.
Gudahtt
reviewed
Feb 4, 2026
| localOverrides: {}, | ||
| rawRemoteFeatureFlags: {}, | ||
| cacheTimestamp: 0, | ||
| previousClientVersion: undefined, |
Member
There was a problem hiding this comment.
This should be causing a type error 🤔 undefined is strictly disallowed in controller state, we only allow JSON.
Contributor
Author
There was a problem hiding this comment.
Oh wow interesting! Thanks for tagging, will clean up!
Gudahtt
reviewed
Feb 4, 2026
| includeInDebugSnapshot: false, | ||
| usedInUi: false, | ||
| }, | ||
| previousClientVersion: { |
Member
There was a problem hiding this comment.
I'm not sure that we need an extra copy of this, we already have it in the AppMetadataController. Maybe we could get it from there instead?
Contributor
Author
There was a problem hiding this comment.
Hmm good callout!
Wondering if there is a controller race condition action issue?
- making
this.messenger.call()inside the constructor. - if the AppMetadataController version updates on initialisation before we can grab the previous version number
Will do some testing!
Member
There was a problem hiding this comment.
It wouldn't be a race condition, but it would mean we'd strictly need to construct the AppMetadataController before this one. We try to avoid using actions/events in the constructor for this exact reason, to avoid initialization order requirements.
Could we fetch the AppMetadataController state lazily instead, rather than in the constructor? That would avoid any init order issues.
Contributor
Author
There was a problem hiding this comment.
Nice, I've refactored to pass in the previous version as a constructor parameter - so we can avoid Action invocation ordering issues.
I will spin up some preview builds to validate, but we can initialise this controller with:
// Last persisted version of the app
const prevClientVersion =
persistedState.AppMetadataController?.currentAppVersion;
const controller = new RemoteFeatureFlagController({
...
prevClientVersion,
})
Prithpal-Sooriya
commented
Feb 4, 2026
| disabled = false, | ||
| getMetaMetricsId, | ||
| clientVersion, | ||
| prevClientVersion, |
Contributor
Author
There was a problem hiding this comment.
Now stateless. We can pass in a constructor parameter for the previous version.
Example on clients:
// the persisted current app ver is the new prevClientVersion we will pass into the `RemoteFeatureFlagController`.
const prevClientVersion =
persistedState.AppMetadataController?.currentAppVersion;
Contributor
Author
There was a problem hiding this comment.
I'll spin up preview builds on mobile and extension to validate.
…ersion - Introduced optional prevClientVersion to manage feature flag cache invalidation. - Updated JSDoc comments for clarity on new parameter usage.
Prithpal-Sooriya
force-pushed
the
cursor/client-version-cache-invalidation-4c09
branch
from
a4e549b to
6dfa4ae
Compare
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
This was referenced Feb 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
What is the current state of things and why does it need to change?
The
RemoteFeatureFlagControllerdid not invalidate its cache when the client application version changed. This could lead to users receiving stale feature flags after an application upgrade, as the controller would continue to use cached flags from the previous version. This is detailed in [Bug]: Explore feature is not available when upgrading from 7.62.2/7.63.0 to 7.64.0 metamask-mobile#25474.What is the solution your changes offer and how does it work?
This PR introduces a
prevClientVersionproperty to the controller's constructor parameters. On initialization, the controller compares the currentclientVersionandprevClientVersion(passed in the constructor). If these versions differ, the cache is invalidated, forcing a fresh fetch of feature flags.Are there any changes whose purpose might not obvious to those unfamiliar with the domain?
No.
Preview Builds:
References
Checklist
Note
Medium Risk
Changes cache-invalidation behavior in
RemoteFeatureFlagControllerbased on app version, which can increase fetches or alter which flags users receive immediately after upgrades. Risk is limited to this controller’s initialization path and is covered by new unit tests.Overview
Remote feature flag caching now invalidates on app upgrades.
RemoteFeatureFlagControlleraccepts an optionalprevClientVersionand resetscacheTimestampto0when it differs from the currentclientVersion, forcing a fresh fetch instead of using potentially stale cached flags.Adds unit coverage for the version-change scenario and documents the fix in
CHANGELOG.md.Written by Cursor Bugbot for commit 6dfa4ae. This will update automatically on new commits. Configure here.