LocalDatastore fixes for React-Native

integration/test/mockRNStorage.js

@@ -27,6 +27,16 @@ const mockRNStorage = {
     cb(undefined, Object.keys(mockStorage));
   },
 
+  multiGet(keys, cb) {
+    const objects = keys.map((key) => [key, mockStorage[key]]);
+    cb(undefined, objects);
+  },
+
+  multiRemove(keys, cb) {
+    keys.map((key) => delete mockStorage[key]);
+    cb(undefined);
+  },
+
   clear() {
     mockStorage = {};
   },

src/LocalDatastore.js

@@ -13,10 +13,30 @@ import CoreManager from './CoreManager';
 
 import type ParseObject from './ParseObject';
 import ParseQuery from './ParseQuery';
+import { DEFAULT_PIN, PIN_PREFIX, OBJECT_PREFIX } from './LocalDatastoreUtils';
 
-const DEFAULT_PIN = '_default';
-const PIN_PREFIX = 'parsePin_';
-
+/**
+ * Provides a local datastore which can be used to store and retrieve <code>Parse.Object</code>. <br />
+ * To enable this functionality, call <code>Parse.enableLocalDatastore()</code>.
+ *
+ * To store objects you can pin them.
+ *
+ * <pre>await object.pin();</pre>
+ * <pre>await object.pinWithName('pinName');</pre>
+ *
+ * You can query your objects by changing the source of your query.
+ *
+ * <pre>query.fromLocalDatastore();</pre>
+ * <pre>query.fromPin();</pre>
+ * <pre>query.fromPinWithName();</pre>
+ *
+ * Once your source is changed, you can query your objects from LocalDatastore
+ *
+ * <pre>const localObjects = await query.find();</pre>
+ *
+ * @class Parse.LocalDatastore
+ * @static
+ */
 const LocalDatastore = {
   fromPinWithName(name: string): Promise {
     const controller = CoreManager.getLocalDatastoreController();
@@ -38,6 +58,12 @@ const LocalDatastore = {
     return controller.getAllContents();
   },
 
+  // Use for testing
+  _getRawStorage(): Promise {
+    const controller = CoreManager.getLocalDatastoreController();
+    return controller.getRawStorage();
+  },
+
   _clear(): Promise {
     const controller = CoreManager.getLocalDatastoreController();
     return controller.clear();
@@ -130,7 +156,7 @@ const LocalDatastore = {
     const localDatastore = await this._getAllContents();
     const allObjects = [];
     for (const key in localDatastore) {
-      if (key !== DEFAULT_PIN && !key.startsWith(PIN_PREFIX)) {
+      if (key.startsWith(OBJECT_PREFIX)) {
         allObjects.push(localDatastore[key]);
       }
     }
@@ -187,15 +213,16 @@ const LocalDatastore = {
 
   // Called when an object is save / fetched
   // Update object pin value
-  async _updateObjectIfPinned(object: ParseObject) {
+  async _updateObjectIfPinned(object: ParseObject): Promise {
     if (!this.isEnabled) {
-      return;
+      return Promise.resolve();
     }
     const objectKey = this.getKeyForObject(object);
     const pinned = await this.fromPinWithName(objectKey);
-    if (pinned) {
-      await this.pinWithName(objectKey, object._toFullJSON());
+    if (!pinned) {
+      return Promise.resolve();
     }
+    return this.pinWithName(objectKey, object._toFullJSON());
   },
 
   // Called when object is destroyed
@@ -236,7 +263,7 @@ const LocalDatastore = {
     if (!this.isEnabled) {
       return;
     }
-    const localKey = `${object.className}_${localId}`;
+    const localKey = `${OBJECT_PREFIX}${object.className}_${localId}`;
     const objectKey = this.getKeyForObject(object);
 
     const unsaved = await this.fromPinWithName(localKey);
@@ -266,7 +293,8 @@ const LocalDatastore = {
    * <pre>
    * await Parse.LocalDatastore.updateFromServer();
    * </pre>
-   *
+   * @method updateFromServer
+   * @name Parse.LocalDatastore.updateFromServer
    * @static
    */
   async updateFromServer() {
@@ -276,7 +304,7 @@ const LocalDatastore = {
     const localDatastore = await this._getAllContents();
     const keys = [];
     for (const key in localDatastore) {
-      if (key !== DEFAULT_PIN && !key.startsWith(PIN_PREFIX)) {
+      if (key.startsWith(OBJECT_PREFIX)) {
         keys.push(key);
       }
     }
@@ -286,7 +314,8 @@ const LocalDatastore = {
     this.isSyncing = true;
     const pointersHash = {};
     for (const key of keys) {
-      const [className, objectId] = key.split('_');
+      // Ignore the OBJECT_PREFIX
+      const [ , , className, objectId] = key.split('_');
       if (!(className in pointersHash)) {
         pointersHash[className] = new Set();
       }
@@ -313,15 +342,14 @@ const LocalDatastore = {
       await Promise.all(pinPromises);
       this.isSyncing = false;
     } catch(error) {
-      console.log('Error syncing LocalDatastore'); // eslint-disable-line
-      console.log(error); // eslint-disable-line
+      console.log('Error syncing LocalDatastore: ', error); // eslint-disable-line
       this.isSyncing = false;
     }
   },
 
   getKeyForObject(object: any) {
     const objectId = object.objectId || object._getId();
-    return `${object.className}_${objectId}`;
+    return `${OBJECT_PREFIX}${object.className}_${objectId}`;
   },
 
   getPinName(pinName: ?string) {
@@ -339,8 +367,6 @@ const LocalDatastore = {
   }
 };
 
-LocalDatastore.DEFAULT_PIN = DEFAULT_PIN;
-LocalDatastore.PIN_PREFIX = PIN_PREFIX;
 LocalDatastore.isEnabled = false;
 LocalDatastore.isSyncing = false;
 

src/LocalDatastoreController.browser.js

@@ -10,6 +10,7 @@
  */
 
 /* global localStorage */
+import { isLocalDatastoreKey } from './LocalDatastoreUtils';
 
 const LocalDatastoreController = {
   fromPinWithName(name: string): Promise {
@@ -40,14 +41,36 @@ const LocalDatastoreController = {
     const LDS = {};
     for (let i = 0; i < localStorage.length; i += 1) {
       const key = localStorage.key(i);
-      const value = localStorage.getItem(key);
-      LDS[key] = JSON.parse(value);
+      if (isLocalDatastoreKey(key)) {
+        const value = localStorage.getItem(key);
+        LDS[key] = JSON.parse(value);
+      }
     }
     return Promise.resolve(LDS);
   },
 
+  getRawStorage(): Promise {
+    const storage = {};
+    for (let i = 0; i < localStorage.length; i += 1) {
+      const key = localStorage.key(i);
+      const value = localStorage.getItem(key);
+      storage[key] = value;
+    }
+    return Promise.resolve(storage);
+  },
+
   clear(): Promise {
-    return Promise.resolve(localStorage.clear());
+    const toRemove = [];
+    for (let i = 0; i < localStorage.length; i += 1) {
+      const key = localStorage.key(i);
+      if (isLocalDatastoreKey(key)) {
+        toRemove.push(key);
+      }
+    }
+    for (const key of toRemove) {
+      localStorage.removeItem(key);
+    }
+    return Promise.resolve();
   }
 };
 

src/LocalDatastoreController.default.js

@@ -8,34 +8,50 @@
  *
  * @flow
  */
+import { isLocalDatastoreKey } from './LocalDatastoreUtils';
 
 const memMap = {};
 const LocalDatastoreController = {
-  fromPinWithName(name: string): ?any {
-    if (memMap.hasOwnProperty(name)) {
-      return memMap[name];
+  fromPinWithName(name: string): Promise {
+    if (!memMap.hasOwnProperty(name)) {
+      return Promise.resolve(null);
     }
-    return null;
+    const objects = JSON.parse(memMap[name]);
+    return Promise.resolve(objects);
   },
 
-  pinWithName(name: string, value: any) {
-    memMap[name] = value;
+  pinWithName(name: string, value: any): Promise {
+    const values = JSON.stringify(value);
+    memMap[name] = values;
+    return Promise.resolve();
   },
 
-  unPinWithName(name: string) {
+  unPinWithName(name: string): Promise {
     delete memMap[name];
+    return Promise.resolve();
   },
 
-  getAllContents() {
-    return memMap;
+  getAllContents(): Promise {
+    const LDS = {};
+    for (const key in memMap) {
+      if (memMap.hasOwnProperty(key) && isLocalDatastoreKey(key)) {
+        LDS[key] = JSON.parse(memMap[key]);
+      }
+    }
+    return Promise.resolve(LDS);
+  },
+
+  getRawStorage(): Promise {
+    return Promise.resolve(memMap);
   },
 
-  clear() {
+  clear(): Promise {
     for (const key in memMap) {
-      if (memMap.hasOwnProperty(key)) {
+      if (memMap.hasOwnProperty(key) && isLocalDatastoreKey(key)) {
         delete memMap[key];
       }
     }
+    return Promise.resolve();
   }
 };
 

src/LocalDatastoreController.react-native.js

@@ -10,6 +10,7 @@
  */
 
 const RNStorage = require('./StorageController.react-native');
+import { isLocalDatastoreKey } from './LocalDatastoreUtils';
 
 const LocalDatastoreController = {
   async fromPinWithName(name: string): Promise {
@@ -38,18 +39,52 @@ const LocalDatastoreController = {
   },
 
   async getAllContents(): Promise {
-    const LDS = {};
     const keys = await RNStorage.getAllKeys();
+    const batch = [];
     for (let i = 0; i < keys.length; i += 1) {
       const key = keys[i];
-      const value = await RNStorage.getItemAsync(key);
-      LDS[key] = JSON.parse(value);
+      if (isLocalDatastoreKey(key)) {
+        batch.push(key);
+      }
     }
+    const LDS = {};
+    const results = await RNStorage.multiGet(batch);
+    results.map((pair) => {
+      const [key, value] = pair;
+      try {
+        LDS[key] = JSON.parse(value);
+      } catch (error) {
+        LDS[key] = null;
+      }
+    });
     return Promise.resolve(LDS);
   },
 
-  clear(): Promise {
-    return RNStorage.clear();
+  async getRawStorage(): Promise {
+    const keys = await RNStorage.getAllKeys();
+    const storage = {};
+    const results = await RNStorage.multiGet(keys);
+    results.map((pair) => {
+      const [key, value] = pair;
+      storage[key] = value;
+    });
+    return Promise.resolve(storage);
+  },
+
+  async clear(): void {
+    try {
+      const keys = await RNStorage.getAllKeys();
+      const batch = [];
+      for (let i = 0; i < keys.length; i += 1) {
+        const key = keys[i];
+        if (isLocalDatastoreKey(key)) {
+          batch.push(key);
+        }
+      }
+      await RNStorage.multiRemove(batch);
+    } catch (error) {
+      console.log(error); // eslint-disable-line
+    }
   }
 };
 

src/LocalDatastoreUtils.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2015-present, Parse, LLC.
+ * 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.
+ *
+ * @flow
+ */
+const DEFAULT_PIN = '_default';
+const PIN_PREFIX = 'parsePin_';
+const OBJECT_PREFIX = 'Parse_LDS_';
+
+function isLocalDatastoreKey(key: string): boolean {
+  return !!(key && (key === DEFAULT_PIN || key.startsWith(PIN_PREFIX) || key.startsWith(OBJECT_PREFIX)));
+}
+
+export {
+  DEFAULT_PIN,
+  PIN_PREFIX,
+  OBJECT_PREFIX,
+  isLocalDatastoreKey,
+};