Skip to content

[shared_preferences] Introduces SharedPreferencesWithCache.createWithoutWarmedUpCache #9776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

TarasMazepa
Copy link

@TarasMazepa TarasMazepa commented Aug 8, 2025

Introduces SharedPreferencesWithCache.createWithoutWarmedUpCache, which allows decoupling of the creation of an instance from cache loading. This might be useful when you want to delegate the creation of an instance of SharedPreferencesWithCache to Dependency injection framework and do not want to deal with Future return type of SharedPreferencesWithCache.create.

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

  1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. 2 3

@TarasMazepa TarasMazepa requested a review from tarrinneal as a code owner August 8, 2025 15:30
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

@TarasMazepa TarasMazepa changed the title Introduces SharedPreferencesWithCache.createWithoutWarmedUpCache [shared_preferences] Introduces SharedPreferencesWithCache.createWithoutWarmedUpCache Aug 8, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This PR introduces SharedPreferencesWithCache.createWithoutWarmedUpCache for synchronous instance creation, which is a useful addition for dependency injection scenarios. The implementation is sound. However, I have two points of feedback. First, the documentation for the new method should be more descriptive to clarify its purpose and how it differs from the existing create method. Second, and more critically, tests are missing for this new public API. Adding tests is essential to verify its behavior and prevent future regressions, as per the repository's contribution guidelines.

@stuartmorgan-g
Copy link
Contributor

Thanks for the contribution! You’ve checked boxes in the PR checklist above that are not reflected in this PR, so I’m assuming this is a work in progress and am marking it as a Draft. Please review the checklist, updating the PR as appropriate, and when the state of the PR as posted reflects the checklist please feel free to mark it as ready for review.

@stuartmorgan-g stuartmorgan-g marked this pull request as draft August 8, 2025 18:44
@TarasMazepa TarasMazepa marked this pull request as ready for review August 8, 2025 18:47
@stuartmorgan-g
Copy link
Contributor

@TarasMazepa Apologies if my comment wasn't clear; the pre-review checklist is the process PRs need to follow in order to be ready for us to review them. The next step is to actually complete the checklist, rather than to uncheck items, so that it's ready for review.

@stuartmorgan-g stuartmorgan-g marked this pull request as draft August 8, 2025 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants