[shared_preferences] full api redesign with DataStore and cache-less interface #5210

tarrinneal · 2023-10-24T11:39:06Z

Full rework for shared_preferences, allows user to decide whether to use cache or be fully async and pull direct from the platform.

fixes flutter/flutter#123078
fixes flutter/flutter#133098
fixes flutter/flutter#65145
fixes flutter/flutter#64739
fixes flutter/flutter#151036

packages/shared_preferences/shared_preferences/lib/better_shared_preference.dart

packages/shared_preferences/shared_preferences/test/better_shared_preferences_test.dart

reidbaker · 2023-11-27T15:36:10Z

packages/shared_preferences/shared_preferences_android/android/build.gradle

@@ -41,6 +44,15 @@ android {
        targetCompatibility JavaVersion.VERSION_1_8
    }

+    kotlinOptions {
+        jvmTarget = '1.8'


Consider making the java target higher in this rewrite (11 or 17)

What's the current state of flutter tool enforcement on Java versions? Does the tooling require 11 now, or could someone be using 8?

If the tooling allows 8, I think having shared_preferences require something higher would be extremely disruptive, and we'd want to raise that floor tool-first rather than critical-package-first.

From offline discussion: It's still 8 at the tooling level for now. Given that, we should hold off, and update to 11/17 after the tool (on stable) has done so.

...ces_android/android/src/main/kotlin/com/flutter/plugins/shared_preferences/BetterMessages.kt

hellohuanlin · 2023-11-27T19:45:41Z

@tarrinneal do you have a design doc that I can take a look before reviewing it?

tarrinneal · 2023-11-29T03:27:41Z

@tarrinneal do you have a design doc that I can take a look before reviewing it?

https://docs.google.com/document/d/1DNhUYIJaDA10g2cOqipKyPuPkgL_FYPfgkF9Coqcc6k/edit

Might have changed the design a bit since I wrote it.

...preferences/shared_preferences_foundation/darwin/Classes/BetterSharedPreferencesPlugin.swift

packages/shared_preferences/shared_preferences/lib/better_shared_preference.dart

...roid/src/main/kotlin/com/flutter/plugins/shared_preferences/BetterSharedPreferencesPlugin.kt

...ges/shared_preferences/shared_preferences_android/lib/better_shared_preferences_android.dart

...preferences/shared_preferences_foundation/darwin/Classes/BetterSharedPreferencesPlugin.swift

packages/shared_preferences/shared_preferences_linux/lib/better_shared_preferences_linux.dart

.../shared_preferences_platform_interface/lib/better_shared_preferences_platform_interface.dart

tarrinneal · 2023-12-12T00:05:45Z

We should probably start brainstorming actual names in parallel with the rest of the review. Maybe AsyncSharedPreferences and CachedSharedPreferences?

CachedSharedPreferences seems incorrect. SharedPreferencesWithCache? I'm fine with either.

part 2 of #5210

tarrinneal · 2024-07-30T19:06:01Z

@stuartmorgan last chance if you want to do another pass on this now that it's just the front end.

packages/shared_preferences/shared_preferences/README.md

packages/shared_preferences/shared_preferences/lib/src/shared_preferences_async.dart

packages/shared_preferences/shared_preferences/pubspec.yaml

packages/shared_preferences/shared_preferences_platform_interface/README.md

tarrinneal · 2024-07-30T20:15:52Z

Looks like tests are passing (besides mac flake), going to mark as auto merge!

auto-submit · 2024-07-30T20:22:17Z

auto label is removed for flutter/packages/5210, due to - The status or check suite Mac_arm64 ios_platform_tests_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

…he-less interface (flutter/packages#5210)

flutter/packages@99e8606...46a712f 2024-07-31 [email protected] [interactive_media_ads] Adds initial iOS implementation (flutter/packages#7063) 2024-07-31 49699333+dependabot[bot]@users.noreply.github.com [webview]: Bump androidx.annotation:annotation from 1.7.1 to 1.8.1 in /packages/webview_flutter/webview_flutter_android/android (flutter/packages#6770) 2024-07-31 49699333+dependabot[bot]@users.noreply.github.com [interactive_media_ads]: Bump androidx.annotation:annotation from 1.8.0 to 1.8.1 in /packages/interactive_media_ads/android (flutter/packages#7238) 2024-07-30 [email protected] [shared_preferences] full api redesign with DataStore and cache-less interface (flutter/packages#5210) 2024-07-30 49699333+dependabot[bot]@users.noreply.github.com [url_launcher]: Bump androidx.browser:browser from 1.5.0 to 1.8.0 in /packages/url_launcher/url_launcher_android/android (flutter/packages#6811) 2024-07-30 49699333+dependabot[bot]@users.noreply.github.com [in_app_pur]: Bump com.android.billingclient:billing from 6.1.0 to 6.2.0 in /packages/in_app_purchase/in_app_purchase_android/android (flutter/packages#6413) 2024-07-30 [email protected] [path_provider] fix 151823: update minimum required path_provider_android to 2.2.0 (flutter/packages#7181) 2024-07-30 [email protected] [shared_preferences] Platform implementations of async api (flutter/packages#6965) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

xVemu · 2024-08-01T08:57:43Z

setMockInitialValues is missing for SharedPreferencesWithCache

tarrinneal · 2024-08-01T18:09:33Z

setMockInitialValues is missing for SharedPreferencesWithCache

You can set the cache manually when instantiating SharedPreferencesWithCache so there is no need for that method.

flutter/packages@99e8606...46a712f 2024-07-31 [email protected] [interactive_media_ads] Adds initial iOS implementation (flutter/packages#7063) 2024-07-31 49699333+dependabot[bot]@users.noreply.github.com [webview]: Bump androidx.annotation:annotation from 1.7.1 to 1.8.1 in /packages/webview_flutter/webview_flutter_android/android (flutter/packages#6770) 2024-07-31 49699333+dependabot[bot]@users.noreply.github.com [interactive_media_ads]: Bump androidx.annotation:annotation from 1.8.0 to 1.8.1 in /packages/interactive_media_ads/android (flutter/packages#7238) 2024-07-30 [email protected] [shared_preferences] full api redesign with DataStore and cache-less interface (flutter/packages#5210) 2024-07-30 49699333+dependabot[bot]@users.noreply.github.com [url_launcher]: Bump androidx.browser:browser from 1.5.0 to 1.8.0 in /packages/url_launcher/url_launcher_android/android (flutter/packages#6811) 2024-07-30 49699333+dependabot[bot]@users.noreply.github.com [in_app_pur]: Bump com.android.billingclient:billing from 6.1.0 to 6.2.0 in /packages/in_app_purchase/in_app_purchase_android/android (flutter/packages#6413) 2024-07-30 [email protected] [path_provider] fix 151823: update minimum required path_provider_android to 2.2.0 (flutter/packages#7181) 2024-07-30 [email protected] [shared_preferences] Platform implementations of async api (flutter/packages#6965) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

github-actions bot added platform-android platform-linux platform-web platform-windows p: shared_preferences labels Oct 24, 2023

tarrinneal changed the title ~~first draft~~ [shared_preferences] full api redesign Oct 30, 2023

tarrinneal changed the title ~~[shared_preferences] full api redesign~~ [shared_preferences] full api redesign with cache-less option Oct 30, 2023

tarrinneal commented Oct 30, 2023

View reviewed changes

packages/shared_preferences/shared_preferences/lib/better_shared_preference.dart Outdated Show resolved Hide resolved

tarrinneal marked this pull request as ready for review October 30, 2023 23:57

tarrinneal requested review from cbracken, cyanglaz, reidbaker and ditman as code owners October 30, 2023 23:57

tarrinneal requested a review from stuartmorgan October 30, 2023 23:58

This comment was marked as off-topic.

Sign in to view

tarrinneal requested review from hellohuanlin and removed request for cyanglaz November 21, 2023 23:48

reidbaker reviewed Nov 27, 2023

View reviewed changes

tarrinneal force-pushed the spr branch from 8074009 to dc794ec Compare November 29, 2023 03:30

hellohuanlin reviewed Nov 29, 2023

View reviewed changes

stuartmorgan requested changes Dec 1, 2023

View reviewed changes

tarrinneal marked this pull request as draft January 11, 2024 18:27

github-actions bot added platform-ios platform-macos labels Jan 25, 2024

tarrinneal mentioned this pull request Jul 18, 2024

[shared_preferences] Platform implementations of async api #6965

Merged

tarrinneal force-pushed the spr branch from bded8bd to a47a024 Compare July 23, 2024 02:49

auto-submit bot pushed a commit that referenced this pull request Jul 30, 2024

[shared_preferences] Platform implementations of async api (#6965)

315ed8a

part 2 of #5210

github-actions bot removed platform-ios platform-linux platform-macos platform-web platform-windows labels Jul 30, 2024

Shared prefs async and with cache, doc changes on plat int

d2b1c87

tarrinneal force-pushed the spr branch from 0b0caff to d2b1c87 Compare July 30, 2024 18:19

github-actions bot removed the platform-android label Jul 30, 2024

excerpts and version updates

0792a51

stuartmorgan approved these changes Jul 30, 2024

View reviewed changes

tarrinneal added 3 commits July 30, 2024 12:29

nits

3314a34

flutter version instead of sdk

beee656

dart

946856b

tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 30, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 30, 2024

tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 30, 2024

auto-submit bot merged commit 644000b into flutter:main Jul 30, 2024
76 checks passed

engine-flutter-autoroll mentioned this pull request Jul 31, 2024

Roll Packages from 99e860679a9a to 46a712f38301 (8 revisions) flutter/flutter#152622

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 31, 2024

644000b [shared_preferences] full api redesign with DataStore and cac…

fa39495

…he-less interface (flutter/packages#5210)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[shared_preferences] full api redesign with DataStore and cache-less interface #5210

[shared_preferences] full api redesign with DataStore and cache-less interface #5210

tarrinneal commented Oct 24, 2023 •

edited

Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

reidbaker Nov 27, 2023

stuartmorgan Dec 1, 2023

stuartmorgan Jun 27, 2024

hellohuanlin commented Nov 27, 2023

tarrinneal commented Nov 29, 2023

tarrinneal commented Dec 12, 2023

tarrinneal commented Jul 30, 2024

tarrinneal commented Jul 30, 2024

auto-submit bot commented Jul 30, 2024

xVemu commented Aug 1, 2024

tarrinneal commented Aug 1, 2024

[shared_preferences] full api redesign with DataStore and cache-less interface #5210

[shared_preferences] full api redesign with DataStore and cache-less interface #5210

Conversation

tarrinneal commented Oct 24, 2023 • edited Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

reidbaker Nov 27, 2023

Choose a reason for hiding this comment

stuartmorgan Dec 1, 2023

Choose a reason for hiding this comment

stuartmorgan Jun 27, 2024

Choose a reason for hiding this comment

hellohuanlin commented Nov 27, 2023

tarrinneal commented Nov 29, 2023

tarrinneal commented Dec 12, 2023

tarrinneal commented Jul 30, 2024

tarrinneal commented Jul 30, 2024

auto-submit bot commented Jul 30, 2024

xVemu commented Aug 1, 2024

tarrinneal commented Aug 1, 2024

tarrinneal commented Oct 24, 2023 •

edited

Loading