Local Datastore (#612)

* initial setup

* object pinning

* initial setup

* object pinning

* finished object pinning

* fetchfromlocaldatastore

* Add Query Functionality

* remove circular dependencies

* fix unpinallobjects

* ungodly amount of jest test

* added on destroy remove pin

* coverage improvement

* run tests against local storage

* lint and remove pinName if empty

* lint n nits

* Revert "lint n nits"

This reverts commit 0e06b14.

* test for enabled and disabled datastore

* getLocalDatastore rename

* add react and promises

* rename object key to ${className]_${id}

* add documentation

* Offline Query Tests and Documentation

* test fix

* Update ParseLocalDatastoreTest.js

* tests for fetch

* auto remove reference if not pinned to name

* fetch object from LDS with children

* add containedBy, withinPolygon, polygonContains

* reduce number of async calls

* lint

* test fix

* jest tests

* prevent fetch from overriding server data

improve coverage and clean up unused code

* lint

* use bfs to avoid recursion

Author: dplewis

integration/cloud/main.js

@@ -7,6 +7,13 @@ Parse.Cloud.define("bar", function(request) {
   }
 });
 
+Parse.Cloud.define('TestFetchFromLocalDatastore', function (request) {
+  const object = new Parse.Object('Item');
+  object.id = request.params.id;
+  object.set('foo', 'changed');
+  return object.save();
+});
+
 Parse.Cloud.define('CloudFunctionUndefined', function() {
   return undefined;
 });

integration/test/ParseLocalDatastoreTest.js

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+
+let mockStorage = {};
+const mockLocalStorage = {
+
+  getItem(path) {
+    return mockStorage[path] || null;
+  },
+
+  setItem(path, value) {
+    mockStorage[path] = value;
+  },
+
+  removeItem(path) {
+    delete mockStorage[path];
+  },
+
+  get length() {
+    return Object.keys(mockStorage).length;
+  },
+
+  key: (i) => {
+    const keys = Object.keys(mockStorage);
+    return keys[i] || null;
+  },
+
+  clear() {
+    mockStorage = {};
+  },
+};
+
+module.exports = mockLocalStorage;

integration/test/mockLocalStorage.js

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+
+let mockStorage = {};
+const mockRNStorage = {
+  getItem(path, cb) {
+    cb(undefined, mockStorage[path] || null);
+  },
+
+  setItem(path, value, cb) {
+    mockStorage[path] = value;
+    cb();
+  },
+
+  removeItem(path, cb) {
+    delete mockStorage[path];
+    cb();
+  },
+
+  getAllKeys(cb) {
+    cb(undefined, Object.keys(mockStorage));
+  },
+
+  clear() {
+    mockStorage = {};
+  },
+};
+
+module.exports = mockRNStorage;

integration/test/mockRNStorage.js

@@ -108,6 +108,13 @@ type StorageController = {
   removeItemAsync: (path: string) => Promise;
   clear: () => void;
 };
+type LocalDatastoreController = {
+  fromPinWithName: (name: string) => ?any;
+  pinWithName: (name: string, objects: any) => void;
+  unPinWithName: (name: string) => void;
+  getAllContents: () => ?any;
+  clear: () => void;
+};
 type UserController = {
   setCurrentUser: (user: ParseUser) => Promise;
   currentUser: () => ?ParseUser;
@@ -144,6 +151,7 @@ type Config = {
   SchemaController?: SchemaController,
   SessionController?: SessionController,
   StorageController?: StorageController,
+  LocalDatastoreController?: LocalDatastoreController,
   UserController?: UserController,
   HooksController?: HooksController,
 };
@@ -331,6 +339,23 @@ module.exports = {
     config['StorageController'] = controller;
   },
 
+  setLocalDatastoreController(controller: LocalDatastoreController) {
+    requireMethods('LocalDatastoreController', ['pinWithName', 'fromPinWithName', 'unPinWithName', 'getAllContents', 'clear'], controller);
+    config['LocalDatastoreController'] = controller;
+  },
+
+  getLocalDatastoreController(): LocalDatastoreController {
+    return config['LocalDatastoreController'];
+  },
+
+  setLocalDatastore(store: any) {
+    config['LocalDatastore'] = store;
+  },
+
+  getLocalDatastore() {
+    return config['LocalDatastore'];
+  },
+
   getStorageController(): StorageController {
     return config['StorageController'];
   },