-
Notifications
You must be signed in to change notification settings - Fork 3.4k
[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
base: main
Are you sure you want to change the base?
Conversation
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. |
There was a problem hiding this 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.
packages/shared_preferences/shared_preferences/lib/src/shared_preferences_async.dart
Outdated
Show resolved
Hide resolved
packages/shared_preferences/shared_preferences/lib/src/shared_preferences_async.dart
Outdated
Show resolved
Hide resolved
…preferences_async.dart
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. |
@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. |
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 ofSharedPreferencesWithCache
to Dependency injection framework and do not want to deal withFuture
return type ofSharedPreferencesWithCache.create
.Pre-Review Checklist
[shared_preferences]
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under1.CHANGELOG.md
to add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under1.///
).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
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