Merge branch 'alpha' into expo-live-query

Author: dplewis

README.md

@@ -28,6 +28,7 @@ A library that gives you access to the powerful Parse Server backend from your J
 
 - [Getting Started](#getting-started)
   - [Using Parse on Different Platforms](#using-parse-on-different-platforms)
+    - [Core Manager](#core-manager)
 - [Compatibility](#compatibility)
   - [Parse Server](#parse-server)
   - [Node.js](#nodejs)
@@ -89,6 +90,18 @@ $ npm install @types/parse
 
 Types are updated manually after every release. If a definition doesn't exist, please submit a pull request to [@types/parse][types-parse]
 
+#### Core Manager
+
+The SDK has a [Core Manager](src/CoreManager.js) that handles all configurations and controllers. These modules can be swapped out for customization before you initialize the SDK. For full list of all available modules take a look at the [Core Manager Documentation](src/CoreManager.js).
+
+```js
+// Configuration example
+Parse.CoreManager.set('REQUEST_ATTEMPT_LIMIT', 1)
+
+// Controller example
+Parse.CoreManager.setRESTController(MyRESTController);
+```
+
 ## Compatibility
 
 ### Parse Server

changelogs/CHANGELOG_alpha.md

@@ -1,3 +1,10 @@
+# [5.1.0-alpha.3](https://github.com/parse-community/Parse-SDK-JS/compare/5.1.0-alpha.2...5.1.0-alpha.3) (2024-04-14)
+
+
+### Features
+
+* Lazy load `Parse.CoreManager` controllers to add support for swappable `CryptoController`, `LocalDatastoreController`, `StorageController`, `WebSocketController`, `ParseLiveQuery` ([#2100](https://github.com/parse-community/Parse-SDK-JS/issues/2100)) ([fbd0ab1](https://github.com/parse-community/Parse-SDK-JS/commit/fbd0ab1402792e241c4d9d6496b451e4cc268b8b))
+
 # [5.1.0-alpha.2](https://github.com/parse-community/Parse-SDK-JS/compare/5.1.0-alpha.1...5.1.0-alpha.2) (2024-04-13)
 
 

integration/test/ParseReactNativeTest.js

@@ -0,0 +1,104 @@
+'use strict';
+
+const Parse = require('../../react-native');
+const { resolvingPromise } = require('../../lib/react-native/promiseUtils');
+const CryptoController = require('../../lib/react-native/CryptoController');
+const LocalDatastoreController = require('../../lib/react-native/LocalDatastoreController.default');
+const StorageController = require('../../lib/react-native/StorageController.default');
+const RESTController = require('../../lib/react-native/RESTController');
+
+RESTController._setXHR(require('xmlhttprequest').XMLHttpRequest);
+
+describe('Parse React Native', () => {
+  beforeEach(() => {
+    // Set up missing controllers and configurations
+    Parse.CoreManager.setWebSocketController(require('ws'));
+    Parse.CoreManager.setEventEmitter(require('events').EventEmitter);
+    Parse.CoreManager.setLocalDatastoreController(LocalDatastoreController);
+    Parse.CoreManager.setStorageController(StorageController);
+    Parse.CoreManager.setRESTController(RESTController);
+    Parse.CoreManager.setCryptoController(CryptoController);
+
+    Parse.initialize('integration');
+    Parse.CoreManager.set('SERVER_URL', 'http://localhost:1337/parse');
+    Parse.CoreManager.set('MASTER_KEY', 'notsosecret');
+    Parse.enableLocalDatastore();
+  });
+
+  afterEach(async () => {
+    await Parse.User.logOut();
+    Parse.Storage._clear();
+  });
+
+  it('can log in a user', async () => {
+    // Handle Storage Controller
+    await Parse.User.signUp('asdf', 'zxcv')
+    const user = await Parse.User.logIn('asdf', 'zxcv');
+    expect(user.get('username')).toBe('asdf');
+    expect(user.existed()).toBe(true);
+  });
+
+  it('can encrypt user', async () => {
+    // Handle Crypto Controller
+    Parse.User.enableUnsafeCurrentUser();
+    Parse.enableEncryptedUser();
+    Parse.secret = 'My Secret Key';
+    const user = new Parse.User();
+    user.setUsername('usernameENC');
+    user.setPassword('passwordENC');
+    await user.signUp();
+
+    const path = Parse.Storage.generatePath('currentUser');
+    const encryptedUser = Parse.Storage.getItem(path);
+
+    const crypto = Parse.CoreManager.getCryptoController();
+
+    const decryptedUser = crypto.decrypt(encryptedUser, Parse.CoreManager.get('ENCRYPTED_KEY'));
+    expect(JSON.parse(decryptedUser).objectId).toBe(user.id);
+
+    const currentUser = Parse.User.current();
+    expect(currentUser).toEqual(user);
+
+    const currentUserAsync = await Parse.User.currentAsync();
+    expect(currentUserAsync).toEqual(user);
+    await Parse.User.logOut();
+    Parse.CoreManager.set('ENCRYPTED_USER', false);
+    Parse.CoreManager.set('ENCRYPTED_KEY', null);
+  });
+
+  it('can pin saved object LDS', async () => {
+    // Handle LocalDatastore Controller
+    function LDS_KEY(object) {
+      return Parse.LocalDatastore.getKeyForObject(object);
+    }
+    const object = new Parse.Object('TestObject');
+    object.set('field', 'test');
+    await object.save();
+    await object.pin();
+    const localDatastore = await Parse.LocalDatastore._getAllContents();
+    const cachedObject = localDatastore[LDS_KEY(object)][0];
+    expect(Object.keys(localDatastore).length).toBe(2);
+    expect(cachedObject.objectId).toBe(object.id);
+    expect(cachedObject.field).toBe('test');
+  });
+
+  it('can subscribe to query', async () => {
+    // Handle WebSocket Controller
+    const object = new Parse.Object('TestObject');
+    await object.save();
+    const installationId = await Parse.CoreManager.getInstallationController().currentInstallationId();
+
+    const query = new Parse.Query('TestObject');
+    query.equalTo('objectId', object.id);
+    const subscription = await query.subscribe();
+    const promise = resolvingPromise();
+    subscription.on('update', (object, _, response) => {
+      expect(object.get('foo')).toBe('bar');
+      expect(response.installationId).toBe(installationId);
+      promise.resolve();
+    });
+    object.set({ foo: 'bar' });
+    await object.save();
+    await promise;
+  });
+});

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "parse",
-  "version": "5.1.0-alpha.2",
+  "version": "5.1.0-alpha.3",
   "description": "Parse JavaScript SDK",
   "homepage": "https://parseplatform.org",
   "keywords": [

package.json

@@ -1,5 +1,3 @@
-/* global WebSocket */
-
 import CoreManager from './CoreManager';
 import ParseObject from './ParseObject';
 import LiveQuerySubscription from './LiveQuerySubscription';
@@ -502,16 +500,4 @@ class LiveQueryClient {
   }
 }
 
-if (process.env.PARSE_BUILD === 'node') {
-  CoreManager.setWebSocketController(require('ws'));
-} else if (process.env.PARSE_BUILD === 'browser') {
-  CoreManager.setWebSocketController(
-    typeof WebSocket === 'function' || typeof WebSocket === 'object' ? WebSocket : null
-  );
-} else if (process.env.PARSE_BUILD === 'weapp') {
-  CoreManager.setWebSocketController(require('./Socket.weapp'));
-} else if (process.env.PARSE_BUILD === 'react-native') {
-  CoreManager.setWebSocketController(WebSocket);
-}
-
 export default LiveQueryClient;

src/LiveQueryClient.js

@@ -0,0 +1,67 @@
+/**
+ * @flow
+ */
+import { isLocalDatastoreKey } from './LocalDatastoreUtils';
+import Storage from './Storage';
+
+const LocalDatastoreController = {
+  async fromPinWithName(name: string): Array<Object> {
+    const values = await Storage.getItemAsync(name);
+    if (!values) {
+      return [];
+    }
+    const objects = JSON.parse(values);
+    return objects;
+  },
+
+  pinWithName(name: string, value: any) {
+    const values = JSON.stringify(value);
+    return Storage.setItemAsync(name, values);
+  },
+
+  unPinWithName(name: string) {
+    return Storage.removeItemAsync(name);
+  },
+
+  async getAllContents(): Object {
+    const keys = await Storage.getAllKeysAsync();
+    return keys.reduce(async (previousPromise, key) => {
+      const LDS = await previousPromise;
+      if (isLocalDatastoreKey(key)) {
+        const value = await Storage.getItemAsync(key);
+        try {
+          LDS[key] = JSON.parse(value);
+        } catch (error) {
+          console.error('Error getAllContents: ', error);
+        }
+      }
+      return LDS;
+    }, Promise.resolve({}));
+  },
+
+  // Used for testing
+  async getRawStorage(): Object {
+    const keys = await Storage.getAllKeysAsync();
+    return keys.reduce(async (previousPromise, key) => {
+      const LDS = await previousPromise;
+      const value = await Storage.getItemAsync(key);
+      LDS[key] = value;
+      return LDS;
+    }, Promise.resolve({}));
+  },
+
+  async clear(): Promise {
+    const keys = await Storage.getAllKeysAsync();
+
+    const toRemove = [];
+    for (const key of keys) {
+      if (isLocalDatastoreKey(key)) {
+        toRemove.push(key);
+      }
+    }
+    const promises = toRemove.map(this.unPinWithName);
+    return Promise.all(promises);
+  },
+};
+
+module.exports = LocalDatastoreController;

src/LocalDatastoreController.default.js

@@ -1,67 +1,5 @@
-/**
- * @flow
- */
-import { isLocalDatastoreKey } from './LocalDatastoreUtils';
-import Storage from './Storage';
-
-const LocalDatastoreController = {
-  async fromPinWithName(name: string): Array<Object> {
-    const values = await Storage.getItemAsync(name);
-    if (!values) {
-      return [];
-    }
-    const objects = JSON.parse(values);
-    return objects;
-  },
-
-  pinWithName(name: string, value: any) {
-    const values = JSON.stringify(value);
-    return Storage.setItemAsync(name, values);
-  },
-
-  unPinWithName(name: string) {
-    return Storage.removeItemAsync(name);
-  },
-
-  async getAllContents(): Object {
-    const keys = await Storage.getAllKeysAsync();
-    return keys.reduce(async (previousPromise, key) => {
-      const LDS = await previousPromise;
-      if (isLocalDatastoreKey(key)) {
-        const value = await Storage.getItemAsync(key);
-        try {
-          LDS[key] = JSON.parse(value);
-        } catch (error) {
-          console.error('Error getAllContents: ', error);
-        }
-      }
-      return LDS;
-    }, Promise.resolve({}));
-  },
-
-  // Used for testing
-  async getRawStorage(): Object {
-    const keys = await Storage.getAllKeysAsync();
-    return keys.reduce(async (previousPromise, key) => {
-      const LDS = await previousPromise;
-      const value = await Storage.getItemAsync(key);
-      LDS[key] = value;
-      return LDS;
-    }, Promise.resolve({}));
-  },
-
-  async clear(): Promise {
-    const keys = await Storage.getAllKeysAsync();
-
-    const toRemove = [];
-    for (const key of keys) {
-      if (isLocalDatastoreKey(key)) {
-        toRemove.push(key);
-      }
-    }
-    const promises = toRemove.map(this.unPinWithName);
-    return Promise.all(promises);
-  },
-};
-
-module.exports = LocalDatastoreController;
+if (process.env.PARSE_BUILD === 'react-native') {
+  module.exports = require('./LocalDatastoreController.react-native');
+} else {
+  module.exports = require('./LocalDatastoreController.default');
+}