Add Settings Module Support for the Android Platform

Libraries/Settings/Settings.ios.js → Libraries/Settings/Settings.js

@@ -11,25 +11,44 @@
  */
 'use strict';
 
-var RCTDeviceEventEmitter = require('RCTDeviceEventEmitter');
-var RCTSettingsManager = require('NativeModules').SettingsManager;
+const RCTDeviceEventEmitter = require('RCTDeviceEventEmitter');
+const RCTSettingsManager = require('NativeModules').SettingsManager;
 
-var invariant = require('fbjs/lib/invariant');
+const invariant = require('fbjs/lib/invariant');
 
-var subscriptions: Array<{keys: Array<string>, callback: ?Function}> = [];
+const subscriptions: Array<{keys: Array<string>; callback: ?Function}> = [];
 
-var Settings = {
+/**
+ * @class
+ * @description
+ * An interface to the native "preferences" file storage that uses simple key-value pairs
+ * 
+ */
+const Settings = {
   _settings: RCTSettingsManager && RCTSettingsManager.settings,
 
   get(key: string): mixed {
     return this._settings[key];
   },
 
-  set(settings: Object) {
-    this._settings = Object.assign(this._settings, settings);
+ /**
+   * Sets the value for a name-value pairs
+   * @param settings the object with the name/value pairs to set
+   *
+   * Note that on android the only allowed value types are number, string and boolean
+   */
+  set(settings: Object): void {
+    Object.assign(this._settings, settings);
     RCTSettingsManager.setValues(settings);
   },
 
+
+ /**
+   * Monitor one or more keys for changed values
+   * @param keys a string or an array of strings naming the keys to monitor
+   * @callback the callback to invoke when one of the specified keys updates its value
+   * @returns a number representing the watch ID which can be used to clear the watch
+   */
   watchKeys(keys: string | Array<string>, callback: Function): number {
     if (typeof keys === 'string') {
       keys = [keys];
@@ -40,11 +59,15 @@ var Settings = {
       'keys should be a string or array of strings'
     );
 
-    var sid = subscriptions.length;
+    const sid = subscriptions.length;
     subscriptions.push({keys: keys, callback: callback});
     return sid;
   },
 
+  /**
+   * 
+   * @param {*} watchId a number identifying which set of monitoried keys is to be cleared
+   */
   clearWatch(watchId: number) {
     if (watchId < subscriptions.length) {
       subscriptions[watchId] = {keys: [], callback: null};
@@ -53,8 +76,8 @@ var Settings = {
 
   _sendObservations(body: Object) {
     Object.keys(body).forEach((key) => {
-      var newValue = body[key];
-      var didChange = this._settings[key] !== newValue;
+      const newValue = body[key];
+      const didChange = this._settings[key] !== newValue;
       this._settings[key] = newValue;
 
       if (didChange) {

Libraries/Settings/__tests__/Settings-test.js

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+'use strict';
+
+jest.unmock('../Settings');
+jest.unmock('Platform');
+
+jest.unmock('BatchedBridge');
+jest.unmock('defineLazyObjectProperty');
+jest.unmock('MessageQueue');
+jest.unmock('NativeModules');
+
+let Platform = require('Platform');
+
+const Settings  = require('Settings');
+
+describe('Settings', () => {
+
+  describe('setting and getting', () => {
+    it('should set values and retrieve them', () => {
+
+      if (Platform.OS == 'ios') {
+        expect(true).toEqual(true);
+        return;
+      }
+
+      Settings.set({oneKey: 1});
+      Settings.set({twoKey: 2.0});
+      Settings.set({threeKey: 'three'});
+
+      const oneValue = Settings.get('oneKey');
+      const twoValue = Settings.get('twoKey');
+      const threeValue = Settings.get('threeKey');
+
+      expect(oneValue === 1).toBe(true);
+      expect(twoValue === 2.0).toBe(true);
+      expect(threeValue === 'three').toBe(true);
+    });
+  });
+});

ReactAndroid/src/main/java/com/facebook/react/modules/settings/BUCK

@@ -0,0 +1,18 @@
+include_defs("//ReactAndroid/DEFS")
+
+android_library(
+    name = "settings",
+    srcs = glob(["**/*.java"]),
+    visibility = [
+        "PUBLIC",
+    ],
+    deps = [
+        react_native_dep("third-party/java/infer-annotations:infer-annotations"),
+        react_native_dep("third-party/java/jsr-305:jsr-305"),
+        react_native_target("java/com/facebook/react/bridge:bridge"),
+        react_native_target("java/com/facebook/react/common:common"),
+        react_native_target("java/com/facebook/react/module/annotations:annotations"),
+        react_native_target("java/com/facebook/react/modules/core:core"),
+    ],
+)
+

ReactAndroid/src/main/java/com/facebook/react/modules/settings/SettingsModule.java

@@ -0,0 +1,180 @@
+/*
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+package com.facebook.react.modules.settings;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.util.Log;
+
+import com.facebook.react.bridge.Arguments;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.ReadableMapKeySetIterator;
+import com.facebook.react.bridge.ReadableType;
+import com.facebook.react.bridge.WritableMap;
+import com.facebook.react.module.annotations.ReactModule;
+import com.facebook.react.modules.core.DeviceEventManagerModule;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@ReactModule(name = SettingsModule.NAME)
+public class SettingsModule extends ReactContextBaseJavaModule implements SharedPreferences.OnSharedPreferenceChangeListener{
+
+  @SuppressWarnings("WeakerAccess")
+  static final String NAME = "SettingsManager";
+  static final String DEFAULT_FILE_NAME = "ReactNative";
+  static final String TAG = "SettingsMmodule";
+
+  private static boolean sSettingsModuleInstantiated = false;
+
+  static private String sFilename = "";
+  private Boolean ignoringUpdates = false;
+  private SharedPreferences mPreferences;
+
+  public SettingsModule(ReactApplicationContext context) {
+    super(context);
+
+  }
+
+  @Override
+  public String getName() {
+    return SettingsModule.NAME;
+  }
+
+  private SharedPreferences ensurePreferences() {
+    if (mPreferences == null) {
+      if (SettingsModule.sFilename.length() > 0) {
+        mPreferences = getReactApplicationContext().getSharedPreferences(SettingsModule.sFilename, Context.MODE_PRIVATE);
+      } else if (getCurrentActivity() != null) {
+        mPreferences = getCurrentActivity().getPreferences(Context.MODE_PRIVATE);
+      } else {
+        mPreferences = getReactApplicationContext().getSharedPreferences(DEFAULT_FILE_NAME, Context.MODE_PRIVATE);
+      }
+      sSettingsModuleInstantiated = true;
+      mPreferences.registerOnSharedPreferenceChangeListener(this);
+    }
+
+    return mPreferences;
+  }
+
+  /***
+   * Configure the Settings Module to use a SharedPreferences file with a specific name as its backing store.
+   * Useful if the Settings Module needs to use an existing SharedPreferences file or to ensure that Settings Modules
+   * belonging to different ReactPackages will all share the same SharedPreferences file for their backing store.
+   * <p></p>
+   * <b>Note:</b>this method may only be called before a Settings Module initialization (i.e. before a ReactMainPackage is instantiated)
+   * An app would typically invoke this function in the app's main activity before setting up the React Native environment
+   * @param filename the name of the SharedPreferences file to use or create for the backing store
+   * @throws IllegalStateException if called after instantiation of a Settings module
+   */
+  static public void setSharedPreferencesFilename(String filename) {
+    if (sSettingsModuleInstantiated) {
+      throw new IllegalStateException("Attempt to set Settings Module SharedPreferences file name after a Settings Module instantiation");
+    }
+    sFilename = filename;
+  }
+
+  @Override
+  public void onCatalystInstanceDestroy() {
+    ensurePreferences().unregisterOnSharedPreferenceChangeListener(this);
+  }
+
+  @ReactMethod
+  public void setValues(ReadableMap values) {
+    this.ignoringUpdates = true;
+
+    ReadableMapKeySetIterator iterator = values.keySetIterator();
+    SharedPreferences.Editor editor = mPreferences.edit();
+
+    while (iterator.hasNextKey()) {
+      String key = iterator.nextKey();
+      ReadableType type = values.getType(key);
+
+      switch (type) {
+        case Null:
+          editor.remove(key);
+          break;
+        case Boolean:
+          editor.putBoolean(key, values.getBoolean(key));
+          break;
+        case Number:
+          editor.putFloat(key, (float) values.getDouble(key));
+          break;
+        case String:
+          editor.putString(key, values.getString(key));
+          break;
+        case Map: // Not supported
+          throw new IllegalArgumentException(TAG + ": Cannot not store Map as value in Settings");
+        case Array: // Not supported
+          throw new IllegalArgumentException(TAG + ": Cannot not store Array as value in Settings");
+      }
+    }
+    editor.apply();
+
+    this.ignoringUpdates = false;
+  }
+
+  public Map<String, Object> getConstants() {
+    Map<String, Object> exportedValuePairs = new HashMap<String, Object>();
+    Map<String, ?> prefsMap = ensurePreferences().getAll();
+
+    for (String key : prefsMap.keySet()) {
+      Object value = prefsMap.get(key);
+      if (value instanceof String || value.getClass().isPrimitive()) {
+        exportedValuePairs.put(key, value);
+      } else {
+        // StringSets are not exported - could be used in the future to store JSON encoded arrays and maps
+        Log.d(TAG, "unexported setting: " + key);
+      }
+    }
+
+    HashMap<String, Object> constants = new HashMap<>();
+
+    constants.put("settings", exportedValuePairs);
+    return constants;
+  }
+
+  @Override
+  public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String prefKey) {
+    if (ignoringUpdates) {
+      return;
+    }
+    Map<String, ?> prefsMap = ensurePreferences().getAll();
+
+    WritableMap map = Arguments.createMap();
+
+    for (String key: prefsMap.keySet()) {
+      Object value = prefsMap.get(key);
+
+      if (value == null) {
+        map.putNull(key);
+      } else if (value instanceof String) {
+        map.putString(key, (String) value);
+      } else if (value instanceof Number) {
+        if (value instanceof Integer) {
+          map.putInt(key, (Integer) value);
+        } else {
+          map.putDouble(key, ((Number) value).doubleValue());
+        }
+      } else if (value instanceof Boolean) {
+        map.putBoolean(key, (Boolean) value);
+      } else {
+        Log.d(TAG, "ignoring setting: " + key);
+      }
+    }
+    if (getReactApplicationContext().hasActiveCatalystInstance()) {
+      getReactApplicationContext().getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
+        .emit("settingsUpdated", map);
+    }
+  }
+}

ReactAndroid/src/main/java/com/facebook/react/shell/BUCK

@@ -36,6 +36,7 @@ android_library(
         react_native_target("java/com/facebook/react/modules/network:network"),
         react_native_target("java/com/facebook/react/modules/permissions:permissions"),
         react_native_target("java/com/facebook/react/modules/share:share"),
+        react_native_target("java/com/facebook/react/modules/settings:settings"),
         react_native_target("java/com/facebook/react/modules/statusbar:statusbar"),
         react_native_target("java/com/facebook/react/modules/storage:storage"),
         react_native_target("java/com/facebook/react/modules/timepicker:timepicker"),

ReactAndroid/src/main/java/com/facebook/react/shell/MainReactPackage.java

@@ -52,6 +52,7 @@
 import com.facebook.react.modules.netinfo.NetInfoModule;
 import com.facebook.react.modules.network.NetworkingModule;
 import com.facebook.react.modules.permissions.PermissionsModule;
+import com.facebook.react.modules.settings.SettingsModule;
 import com.facebook.react.modules.share.ShareModule;
 import com.facebook.react.modules.statusbar.StatusBarModule;
 import com.facebook.react.modules.storage.AsyncStorageModule;
@@ -211,6 +212,12 @@ public NativeModule get() {
           return new PermissionsModule(context);
         }
       }),
+      new ModuleSpec(SettingsModule.class, new Provider<NativeModule>() {
+        @Override
+        public NativeModule get() {
+          return new SettingsModule(context);
+        }
+      }),
       new ModuleSpec(ShareModule.class, new Provider<NativeModule>() {
         @Override
         public NativeModule get() {

website/server/docsList.js

@@ -80,7 +80,7 @@ const apis = [
   '../Libraries/PermissionsAndroid/PermissionsAndroid.js',
   '../Libraries/Utilities/PixelRatio.js',
   '../Libraries/PushNotificationIOS/PushNotificationIOS.js',
-  '../Libraries/Settings/Settings.ios.js',
+  '../Libraries/Settings/Settings.js',
   '../Libraries/Share/Share.js',
   '../Libraries/Components/StatusBar/StatusBarIOS.ios.js',
   '../Libraries/StyleSheet/StyleSheet.js',