[shared_preferences] Unhardcode Flutter prefix in platform code

AUTHORS

@@ -43,3 +43,4 @@ Audrius Karosevicius <[email protected]>
 Lukasz Piliszczuk <[email protected]>
 SoundReply Solutions GmbH <[email protected]>
 Rafal Wachol <[email protected]>
+Nino Uzelac <[email protected]>

packages/shared_preferences/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.4
+
+* Remove hardcoded prefix from internal platform calls
+
 ## 0.5.3+4
 
 * Copy `List` instances when reading and writing values to prevent mutations from propagating.

packages/shared_preferences/android/src/main/java/io/flutter/plugins/sharedpreferences/SharedPreferencesPlugin.java

@@ -77,11 +77,11 @@ private String encodeList(List<String> list) throws IOException {
   }
 
   // Filter preferences to only those set by the flutter app.
-  private Map<String, Object> getAllPrefs() throws IOException {
+  private Map<String, Object> getAllPrefs(String prefix) throws IOException {
     Map<String, ?> allPrefs = preferences.getAll();
     Map<String, Object> filteredPrefs = new HashMap<>();
     for (String key : allPrefs.keySet()) {
-      if (key.startsWith("flutter.")) {
+      if (key.startsWith(prefix)) {
         Object value = allPrefs.get(key);
         if (value instanceof String) {
           String stringValue = (String) value;
@@ -179,13 +179,13 @@ public void onMethodCall(MethodCall call, MethodChannel.Result result) {
           result.success(true);
           break;
         case "getAll":
-          result.success(getAllPrefs());
+          result.success(getAllPrefs((String) call.argument("prefix")));
           return;
         case "remove":
           commitAsync(preferences.edit().remove(key), result);
           break;
         case "clear":
-          Set<String> keySet = getAllPrefs().keySet();
+          Set<String> keySet = getAllPrefs((String) call.argument("prefix")).keySet();
           Editor clearEditor = preferences.edit();
           for (String keyToDelete : keySet) {
             clearEditor.remove(keyToDelete);

packages/shared_preferences/ios/Classes/SharedPreferencesPlugin.m

@@ -16,7 +16,8 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
     NSDictionary *arguments = [call arguments];
 
     if ([method isEqualToString:@"getAll"]) {
-      result(getAllPrefs());
+      NSString *prefix = arguments[@"prefix"];
+      result(getAllPrefs(prefix));
     } else if ([method isEqualToString:@"setBool"]) {
       NSString *key = arguments[@"key"];
       NSNumber *value = arguments[@"value"];
@@ -54,7 +55,8 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
       result(@YES);
     } else if ([method isEqualToString:@"clear"]) {
       NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
-      for (NSString *key in getAllPrefs()) {
+      NSString *prefix = arguments[@"prefix"];
+      for (NSString *key in getAllPrefs(prefix)) {
         [defaults removeObjectForKey:key];
       }
       result(@YES);
@@ -66,13 +68,13 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
 
 #pragma mark - Private
 
-static NSMutableDictionary *getAllPrefs() {
+static NSMutableDictionary *getAllPrefs(NSString *prefix) {
   NSString *appDomain = [[NSBundle mainBundle] bundleIdentifier];
   NSDictionary *prefs = [[NSUserDefaults standardUserDefaults] persistentDomainForName:appDomain];
   NSMutableDictionary *filteredPrefs = [NSMutableDictionary dictionary];
   if (prefs != nil) {
     for (NSString *candidateKey in prefs) {
-      if ([candidateKey hasPrefix:@"flutter."]) {
+      if ([candidateKey hasPrefix:prefix]) {
         [filteredPrefs setObject:prefs[candidateKey] forKey:candidateKey];
       }
     }

packages/shared_preferences/lib/shared_preferences.dart

@@ -148,8 +148,11 @@ class SharedPreferences {
 
   /// Completes with true once the user preferences for the app has been cleared.
   Future<bool> clear() async {
+    final Map<String, dynamic> params = <String, dynamic>{
+      'prefix': '$_prefix',
+    };
     _preferenceCache.clear();
-    return await _kChannel.invokeMethod<bool>('clear');
+    return await _kChannel.invokeMethod<bool>('clear', params);
   }
 
   /// Fetches the latest values from the host platform.
@@ -164,8 +167,11 @@ class SharedPreferences {
   }
 
   static Future<Map<String, Object>> _getSharedPreferencesMap() async {
+    final Map<String, dynamic> params = <String, dynamic>{
+      'prefix': '$_prefix',
+    };
     final Map<String, Object> fromSystem =
-        await _kChannel.invokeMapMethod<String, Object>('getAll');
+        await _kChannel.invokeMapMethod<String, Object>('getAll', params);
     assert(fromSystem != null);
     // Strip the flutter. prefix from the returned preferences.
     final Map<String, Object> preferencesMap = <String, Object>{};

packages/shared_preferences/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for reading and writing simple key-value pairs.
   Wraps NSUserDefaults on iOS and SharedPreferences on Android.
 author: Flutter Team <[email protected]>
 homepage: https://github.com/flutter/plugins/tree/master/packages/shared_preferences
-version: 0.5.3+4
+version: 0.5.4
 
 flutter:
   plugin:

packages/shared_preferences/test/shared_preferences_test.dart

@@ -143,7 +143,11 @@ void main() {
       expect(preferences.getInt('int'), null);
       expect(preferences.getDouble('double'), null);
       expect(preferences.getStringList('List'), null);
-      expect(log, <Matcher>[isMethodCall('clear', arguments: null)]);
+      expect(log, <Matcher>[
+        isMethodCall('clear', arguments: <String, dynamic>{
+          'prefix': 'flutter.',
+        })
+      ]);
     });
 
     test('reloading', () async {