[shared_preferences] fix cast error and mutable list error with getStringList (#7355)

tarrinneal · web-flow · commit cdd6e1368ffd · 2024-08-09T20:16:24.000Z
fixes flutter/flutter#153106 fixes flutter/flutter#153112 Will add a follow up pr adding a test to the top level package after this pr lands.
diff --git a/packages/shared_preferences/shared_preferences_android/CHANGELOG.md b/packages/shared_preferences/shared_preferences_android/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.3.1
+
+* Fixes `getStringList` returning immutable list.
+
 ## 2.3.0
 
 * Adds new `SharedPreferencesAsyncAndroid` API.
diff --git a/packages/shared_preferences/shared_preferences_android/example/integration_test/shared_preferences_test.dart b/packages/shared_preferences/shared_preferences_android/example/integration_test/shared_preferences_test.dart
@@ -555,6 +555,16 @@ void main() {
       expect(await preferences.getStringList(listKey, emptyOptions), testList);
     });
 
+    testWidgets('getStringList returns mutable list', (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      final List<String>? list =
+          await preferences.getStringList(listKey, emptyOptions);
+      list?.add('value');
+      expect(list?.length, testList.length + 1);
+    });
+
     testWidgets('getPreferences', (WidgetTester _) async {
       final SharedPreferencesAsyncPlatform preferences = await getPreferences();
       await Future.wait(<Future<void>>[
diff --git a/packages/shared_preferences/shared_preferences_android/lib/src/shared_preferences_async_android.dart b/packages/shared_preferences/shared_preferences_android/lib/src/shared_preferences_async_android.dart
@@ -146,7 +146,8 @@ base class SharedPreferencesAsyncAndroid
     // is fixed. In practice, the values will never be null, and the native implementation assumes that.
     return _convertKnownExceptions<List<String>>(() async =>
         (await _api.getStringList(key, _convertOptionsToPigeonOptions(options)))
-            ?.cast<String>());
+            ?.cast<String>()
+            .toList());
   }
 
   Future<T?> _convertKnownExceptions<T>(Future<T?> Function() method) async {
diff --git a/packages/shared_preferences/shared_preferences_android/pubspec.yaml b/packages/shared_preferences/shared_preferences_android/pubspec.yaml
@@ -2,7 +2,7 @@ name: shared_preferences_android
 description: Android implementation of the shared_preferences plugin
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences_android
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.3.0
+version: 2.3.1
 
 environment:
   sdk: ^3.4.0
diff --git a/packages/shared_preferences/shared_preferences_foundation/CHANGELOG.md b/packages/shared_preferences/shared_preferences_foundation/CHANGELOG.md
@@ -1,5 +1,6 @@
-## NEXT
+## 2.5.1
 
+* Fixes `getStringList` returning immutable list.
 * Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.
 
 ## 2.5.0
diff --git a/packages/shared_preferences/shared_preferences_foundation/example/integration_test/shared_preferences_test.dart b/packages/shared_preferences/shared_preferences_foundation/example/integration_test/shared_preferences_test.dart
@@ -544,6 +544,16 @@ void main() {
       expect(await preferences.getStringList(listKey, emptyOptions), testList);
     });
 
+    testWidgets('getStringList returns mutable list', (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      final List<String>? list =
+          await preferences.getStringList(listKey, emptyOptions);
+      list?.add('value');
+      expect(list?.length, testList.length + 1);
+    });
+
     testWidgets('getPreferences', (WidgetTester _) async {
       final SharedPreferencesAsyncPlatform preferences = await getPreferences();
       await Future.wait(<Future<void>>[
diff --git a/packages/shared_preferences/shared_preferences_foundation/lib/src/shared_preferences_async_foundation.dart b/packages/shared_preferences/shared_preferences_foundation/lib/src/shared_preferences_async_foundation.dart
@@ -158,7 +158,8 @@ base class SharedPreferencesAsyncFoundation
     return _convertKnownExceptions<List<String>>(() async =>
         ((await _api.getValue(key, _convertOptionsToPigeonOptions(options)))
                 as List<Object?>?)
-            ?.cast<String>());
+            ?.cast<String>()
+            .toList());
   }
 
   @override
diff --git a/packages/shared_preferences/shared_preferences_foundation/pubspec.yaml b/packages/shared_preferences/shared_preferences_foundation/pubspec.yaml
@@ -2,7 +2,7 @@ name: shared_preferences_foundation
 description: iOS and macOS implementation of the shared_preferences plugin.
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences_foundation
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.5.0
+version: 2.5.1
 
 environment:
   sdk: ^3.3.0
diff --git a/packages/shared_preferences/shared_preferences_linux/CHANGELOG.md b/packages/shared_preferences/shared_preferences_linux/CHANGELOG.md
@@ -1,5 +1,7 @@
-## NEXT
+## 2.4.1
 
+* Fixes `getStringList` returning immutable list.
+* Fixes `getStringList` cast error.
 * Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.
 
 ## 2.4.0
diff --git a/packages/shared_preferences/shared_preferences_linux/example/integration_test/shared_preferences_test.dart b/packages/shared_preferences/shared_preferences_linux/example/integration_test/shared_preferences_test.dart
@@ -354,12 +354,15 @@ void main() {
     const double testDouble = 3.14159;
     const List<String> testList = <String>['foo', 'bar'];
 
-    Future<SharedPreferencesAsyncPlatform> getPreferences() async {
+    Future<SharedPreferencesAsyncPlatform> getPreferences(
+        {bool clear = true}) async {
       final SharedPreferencesAsyncPlatform preferences =
           SharedPreferencesAsyncPlatform.instance!;
-      await preferences.clear(
-          const ClearPreferencesParameters(filter: PreferencesFilters()),
-          emptyOptions);
+      if (clear) {
+        await preferences.clear(
+            const ClearPreferencesParameters(filter: PreferencesFilters()),
+            emptyOptions);
+      }
       return preferences;
     }
 
@@ -397,6 +400,24 @@ void main() {
       await preferences.setStringList(listKey, testList, emptyOptions);
       expect(await preferences.getStringList(listKey, emptyOptions), testList);
     });
+    testWidgets('getStringList does not throw cast error',
+        (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      await (preferences as SharedPreferencesAsyncLinux).reload(emptyOptions);
+      expect(await preferences.getStringList(listKey, emptyOptions), testList);
+    });
+
+    testWidgets('getStringList returns mutable list', (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      final List<String>? list =
+          await preferences.getStringList(listKey, emptyOptions);
+      list?.add('value');
+      expect(list?.length, testList.length + 1);
+    });
 
     testWidgets('getPreferences', (WidgetTester _) async {
       final SharedPreferencesAsyncPlatform preferences = await getPreferences();
diff --git a/packages/shared_preferences/shared_preferences_linux/lib/shared_preferences_linux.dart b/packages/shared_preferences/shared_preferences_linux/lib/shared_preferences_linux.dart
@@ -253,7 +253,7 @@ base class SharedPreferencesAsyncLinux extends SharedPreferencesAsyncPlatform {
     SharedPreferencesOptions options,
   ) async {
     final Map<String, Object> data = await _readAll(<String>{key}, options);
-    return (data[key] as List<String>?)?.toList();
+    return (data[key] as List<Object?>?)?.cast<String>().toList();
   }
 
   @override
@@ -282,6 +282,14 @@ base class SharedPreferencesAsyncLinux extends SharedPreferencesAsyncPlatform {
     return _readAll(parameters.filter.allowList, options);
   }
 
+  /// Reloads preferences from file.
+  @visibleForTesting
+  Future<void> reload(
+    SharedPreferencesLinuxOptions options,
+  ) async {
+    _cachedPreferences = await _reload(options.fileName);
+  }
+
   Future<Map<String, Object>> _readAll(
     Set<String>? allowList,
     SharedPreferencesOptions options,
diff --git a/packages/shared_preferences/shared_preferences_linux/pubspec.yaml b/packages/shared_preferences/shared_preferences_linux/pubspec.yaml
@@ -2,7 +2,7 @@ name: shared_preferences_linux
 description: Linux implementation of the shared_preferences plugin
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences_linux
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.4.0
+version: 2.4.1
 
 environment:
   sdk: ^3.3.0
diff --git a/packages/shared_preferences/shared_preferences_web/CHANGELOG.md b/packages/shared_preferences/shared_preferences_web/CHANGELOG.md
@@ -1,5 +1,6 @@
-## NEXT
+## 2.4.2
 
+* Fixes `getStringList` returning immutable list.
 * Updates minimum supported SDK version to Flutter 3.22/Dart 3.4.
 
 ## 2.4.1
diff --git a/packages/shared_preferences/shared_preferences_web/example/integration_test/shared_preferences_web_test.dart b/packages/shared_preferences/shared_preferences_web/example/integration_test/shared_preferences_web_test.dart
@@ -444,6 +444,16 @@ void main() {
       expect(await preferences.getStringList(listKey, emptyOptions), testList);
     });
 
+    testWidgets('getStringList returns mutable list', (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      final List<String>? list =
+          await preferences.getStringList(listKey, emptyOptions);
+      list?.add('value');
+      expect(list?.length, testList.length + 1);
+    });
+
     testWidgets('getPreferences', (WidgetTester _) async {
       final SharedPreferencesAsyncPlatform preferences = await getPreferences();
       await Future.wait(<Future<void>>[
diff --git a/packages/shared_preferences/shared_preferences_web/lib/shared_preferences_web.dart b/packages/shared_preferences/shared_preferences_web/lib/shared_preferences_web.dart
@@ -243,7 +243,7 @@ base class SharedPreferencesAsyncWeb extends SharedPreferencesAsyncPlatform {
   ) async {
     final Map<String, Object> data =
         await _readAllFromLocalStorage(<String>{key}, options);
-    return data[key] as List<String>?;
+    return (data[key] as List<String>?)?.toList();
   }
 }
 
diff --git a/packages/shared_preferences/shared_preferences_web/pubspec.yaml b/packages/shared_preferences/shared_preferences_web/pubspec.yaml
@@ -2,7 +2,7 @@ name: shared_preferences_web
 description: Web platform implementation of shared_preferences
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences_web
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.4.1
+version: 2.4.2
 
 environment:
   sdk: ^3.4.0
diff --git a/packages/shared_preferences/shared_preferences_windows/CHANGELOG.md b/packages/shared_preferences/shared_preferences_windows/CHANGELOG.md
@@ -1,5 +1,7 @@
-## NEXT
+## 2.4.1
 
+* Fixes `getStringList` returning immutable list.
+* Fixes `getStringList` cast error.
 * Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.
 
 ## 2.4.0
diff --git a/packages/shared_preferences/shared_preferences_windows/example/integration_test/shared_preferences_test.dart b/packages/shared_preferences/shared_preferences_windows/example/integration_test/shared_preferences_test.dart
@@ -354,12 +354,15 @@ void main() {
     const double testDouble = 3.14159;
     const List<String> testList = <String>['foo', 'bar'];
 
-    Future<SharedPreferencesAsyncPlatform> getPreferences() async {
+    Future<SharedPreferencesAsyncPlatform> getPreferences(
+        {bool clear = true}) async {
       final SharedPreferencesAsyncPlatform preferences =
           SharedPreferencesAsyncPlatform.instance!;
-      await preferences.clear(
-          const ClearPreferencesParameters(filter: PreferencesFilters()),
-          emptyOptions);
+      if (clear) {
+        await preferences.clear(
+            const ClearPreferencesParameters(filter: PreferencesFilters()),
+            emptyOptions);
+      }
       return preferences;
     }
 
@@ -398,6 +401,25 @@ void main() {
       expect(await preferences.getStringList(listKey, emptyOptions), testList);
     });
 
+    testWidgets('getStringList does not throw cast error',
+        (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      await (preferences as SharedPreferencesAsyncWindows).reload(emptyOptions);
+      expect(await preferences.getStringList(listKey, emptyOptions), testList);
+    });
+
+    testWidgets('getStringList returns mutable list', (WidgetTester _) async {
+      final SharedPreferencesAsyncPlatform preferences = await getPreferences();
+
+      await preferences.setStringList(listKey, testList, emptyOptions);
+      final List<String>? list =
+          await preferences.getStringList(listKey, emptyOptions);
+      list?.add('value');
+      expect(list?.length, testList.length + 1);
+    });
+
     testWidgets('getPreferences', (WidgetTester _) async {
       final SharedPreferencesAsyncPlatform preferences = await getPreferences();
       await preferences.setString(stringKey, testString, emptyOptions);
diff --git a/packages/shared_preferences/shared_preferences_windows/lib/shared_preferences_windows.dart b/packages/shared_preferences/shared_preferences_windows/lib/shared_preferences_windows.dart
@@ -254,7 +254,7 @@ base class SharedPreferencesAsyncWindows
     SharedPreferencesOptions options,
   ) async {
     final Map<String, Object> data = await _readAll(<String>{key}, options);
-    return (data[key] as List<String>?)?.toList();
+    return (data[key] as List<Object?>?)?.cast<String>().toList();
   }
 
   @override
@@ -283,6 +283,14 @@ base class SharedPreferencesAsyncWindows
     return _readAll(parameters.filter.allowList, options);
   }
 
+  /// Reloads preferences from file.
+  @visibleForTesting
+  Future<void> reload(
+    SharedPreferencesWindowsOptions options,
+  ) async {
+    _cachedPreferences = await _readFromFile(options.fileName);
+  }
+
   Future<Map<String, Object>> _readAll(
     Set<String>? allowList,
     SharedPreferencesOptions options,
diff --git a/packages/shared_preferences/shared_preferences_windows/pubspec.yaml b/packages/shared_preferences/shared_preferences_windows/pubspec.yaml
@@ -2,7 +2,7 @@ name: shared_preferences_windows
 description: Windows implementation of shared_preferences
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences_windows
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.4.0
+version: 2.4.1
 
 environment:
   sdk: ^3.3.0

Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,8 @@ base class SharedPreferencesAsyncAndroid`
`146`	`146`	`// is fixed. In practice, the values will never be null, and the native implementation assumes that.`
`147`	`147`	`return _convertKnownExceptions<List<String>>(() async =>`
`148`	`148`	`(await _api.getStringList(key, _convertOptionsToPigeonOptions(options)))`
`149`		`- ?.cast<String>());`
	`149`	`+ ?.cast<String>()`
	`150`	`+ .toList());`
`150`	`151`	`}`
`151`	`152`
`152`	`153`	`Future<T?> _convertKnownExceptions<T>(Future<T?> Function() method) async {`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,8 @@ base class SharedPreferencesAsyncFoundation`
`158`	`158`	`return _convertKnownExceptions<List<String>>(() async =>`
`159`	`159`	`((await _api.getValue(key, _convertOptionsToPigeonOptions(options)))`
`160`	`160`	`as List<Object?>?)`
`161`		`- ?.cast<String>());`
	`161`	`+ ?.cast<String>()`
	`162`	`+ .toList());`
`162`	`163`	`}`
`163`	`164`
`164`	`165`	`@override`