feat: Add support for custom EventEmitter (#1999)

Author: dplewis

integration/test/ParseLocalDatastoreTest.js

@@ -1,36 +1,52 @@
 'use strict';
 
 const assert = require('assert');
-const Parse = require('../../node');
 
 global.localStorage = require('./mockLocalStorage');
+global.WebSocket = require('ws');
 const mockRNStorage = require('./mockRNStorage');
-const LocalDatastoreUtils = require('../../lib/node/LocalDatastoreUtils');
+const serverURL = 'http://localhost:1337/parse';
 
-const { DEFAULT_PIN, PIN_PREFIX, isLocalDatastoreKey } = LocalDatastoreUtils;
+function runTest(controller) {
+  const Parse = require(`../../${controller.name}`);
+  const LocalDatastoreUtils = require('../../lib/node/LocalDatastoreUtils');
 
-function LDS_KEY(object) {
-  return Parse.LocalDatastore.getKeyForObject(object);
-}
-function LDS_FULL_JSON(object) {
-  const json = object._toFullJSON();
-  if (object._localId) {
-    json._localId = object._localId;
+  const { DEFAULT_PIN, PIN_PREFIX, isLocalDatastoreKey } = LocalDatastoreUtils;
+
+  const Item = Parse.Object.extend('Item');
+  const TestObject = Parse.Object.extend('TestObject');
+
+  function LDS_KEY(object) {
+    return Parse.LocalDatastore.getKeyForObject(object);
   }
-  return json;
-}
-function runTest(controller) {
+  function LDS_FULL_JSON(object) {
+    const json = object._toFullJSON();
+    if (object._localId) {
+      json._localId = object._localId;
+    }
+    return json;
+  }
+
   describe(`Parse Object Pinning (${controller.name})`, () => {
     beforeEach(async () => {
       const StorageController = require(controller.file);
       Parse.CoreManager.setAsyncStorage(mockRNStorage);
       Parse.CoreManager.setLocalDatastoreController(StorageController);
-      Parse.enableLocalDatastore();
+      Parse.CoreManager.setEventEmitter(require('events').EventEmitter);
+      Parse.User.enableUnsafeCurrentUser();
       await Parse.LocalDatastore._clear();
+      Parse.initialize('integration');
+      Parse.CoreManager.set('SERVER_URL', serverURL);
+      Parse.CoreManager.set('MASTER_KEY', 'notsosecret');
+      const RESTController = Parse.CoreManager.getRESTController();
+      RESTController._setXHR(require('xmlhttprequest').XMLHttpRequest);
+      Parse.enableLocalDatastore();
     });
+
     function getStorageCount(storage) {
       return Object.keys(storage).reduce((acc, key) => acc + (isLocalDatastoreKey(key) ? 1 : 0), 1);
     }
+
     it(`${controller.name} can clear localDatastore`, async () => {
       const obj1 = new TestObject();
       const obj2 = new TestObject();
@@ -1060,8 +1076,15 @@ function runTest(controller) {
       const StorageController = require(controller.file);
       Parse.CoreManager.setAsyncStorage(mockRNStorage);
       Parse.CoreManager.setLocalDatastoreController(StorageController);
-      Parse.enableLocalDatastore();
+      Parse.CoreManager.setEventEmitter(require('events').EventEmitter);
       Parse.LocalDatastore._clear();
+      Parse.User.enableUnsafeCurrentUser();
+      Parse.initialize('integration');
+      Parse.CoreManager.set('SERVER_URL', serverURL);
+      Parse.CoreManager.set('MASTER_KEY', 'notsosecret');
+      const RESTController = Parse.CoreManager.getRESTController();
+      RESTController._setXHR(require('xmlhttprequest').XMLHttpRequest);
+      Parse.enableLocalDatastore();
 
       const numbers = [];
       for (let i = 0; i < 10; i++) {
@@ -2949,20 +2972,10 @@ function runTest(controller) {
 }
 
 describe('Parse LocalDatastore', () => {
-  beforeEach(() => {
-    Parse.CoreManager.getInstallationController()._setInstallationIdCache('1234');
-    Parse.enableLocalDatastore();
-    Parse.User.enableUnsafeCurrentUser();
-  });
-
   const controllers = [
-    { name: 'Default', file: '../../lib/node/LocalDatastoreController' },
-    {
-      name: 'React-Native',
-      file: '../../lib/node/LocalDatastoreController.react-native',
-    },
+    { name: 'node', file: '../../lib/node/LocalDatastoreController' },
+    { name: 'react-native', file: '../../lib/react-native/LocalDatastoreController.react-native' },
   ];
-
   for (let i = 0; i < controllers.length; i += 1) {
     const controller = controllers[i];
     runTest(controller);

src/CoreManager.js

@@ -217,6 +217,13 @@ const CoreManager = {
     config[key] = value;
   },
 
+  setIfNeeded: function (key: string, value: any): any {
+    if (!config.hasOwnProperty(key)) {
+      config[key] = value;
+    }
+    return config[key];
+  },
+
   /* Specialized Controller Setters/Getters */
 
   setAnalyticsController(controller: AnalyticsController) {
@@ -255,6 +262,14 @@ const CoreManager = {
     return config['CryptoController'];
   },
 
+  setEventEmitter(eventEmitter: any) {
+    config['EventEmitter'] = eventEmitter;
+  },
+
+  getEventEmitter(): any {
+    return config['EventEmitter'];
+  },
+
   setFileController(controller: FileController) {
     requireMethods('FileController', ['saveFile', 'saveBase64'], controller);
     config['FileController'] = controller;
@@ -273,6 +288,14 @@ const CoreManager = {
     return config['InstallationController'];
   },
 
+  setLiveQuery(liveQuery: any) {
+    config['LiveQuery'] = liveQuery;
+  },
+
+  getLiveQuery(): any {
+    return config['LiveQuery'];
+  },
+
   setObjectController(controller: ObjectController) {
     requireMethods('ObjectController', ['save', 'fetch', 'destroy'], controller);
     config['ObjectController'] = controller;

src/EventEmitter.js

@@ -2,13 +2,19 @@
  * This is a simple wrapper to unify EventEmitter implementations across platforms.
  */
 
-if (process.env.PARSE_BUILD === 'react-native') {
-  let EventEmitter = require('react-native/Libraries/vendor/emitter/EventEmitter');
-  if (EventEmitter.default) {
-    EventEmitter = EventEmitter.default;
+let EventEmitter;
+
+try {
+  if (process.env.PARSE_BUILD === 'react-native') {
+    EventEmitter = require('react-native/Libraries/vendor/emitter/EventEmitter');
+    if (EventEmitter.default) {
+      EventEmitter = EventEmitter.default;
+    }
+    EventEmitter.prototype.on = EventEmitter.prototype.addListener;
+  } else {
+    EventEmitter = require('events').EventEmitter;
   }
-  EventEmitter.prototype.on = EventEmitter.prototype.addListener;
-  module.exports = EventEmitter;
-} else {
-  module.exports = require('events').EventEmitter;
+} catch (_) {
+  // EventEmitter unavailable
 }
+module.exports = EventEmitter;

src/LiveQueryClient.js

@@ -1,7 +1,6 @@
 /* global WebSocket */
 
 import CoreManager from './CoreManager';
-import EventEmitter from './EventEmitter';
 import ParseObject from './ParseObject';
 import LiveQuerySubscription from './LiveQuerySubscription';
 import { resolvingPromise } from './promiseUtils';
@@ -63,7 +62,6 @@ const generateInterval = k => {
 
 /**
  * Creates a new LiveQueryClient.
- * Extends events.EventEmitter
  * <a href="https://nodejs.org/api/events.html#events_class_eventemitter">cloud functions</a>.
  *
  * A wrapper of a standard WebSocket client. We add several useful methods to
@@ -105,7 +103,7 @@ const generateInterval = k => {
  *
  * @alias Parse.LiveQueryClient
  */
-class LiveQueryClient extends EventEmitter {
+class LiveQueryClient {
   attempts: number;
   id: number;
   requestId: number;
@@ -138,8 +136,6 @@ class LiveQueryClient extends EventEmitter {
     sessionToken,
     installationId,
   }) {
-    super();
-
     if (!serverURL || serverURL.indexOf('ws') !== 0) {
       throw new Error(
         'You need to set a proper Parse LiveQuery server url before using LiveQueryClient'
@@ -160,7 +156,11 @@ class LiveQueryClient extends EventEmitter {
     this.connectPromise = resolvingPromise();
     this.subscriptions = new Map();
     this.state = CLIENT_STATE.INITIALIZED;
+    const EventEmitter = CoreManager.getEventEmitter();
+    this.emitter = new EventEmitter();
 
+    this.on = this.emitter.on;
+    this.emit = this.emitter.emit;
     // adding listener so process does not crash
     // best practice is for developer to register their own listener
     this.on('error', () => {});

src/LiveQuerySubscription.js

@@ -1,10 +1,8 @@
-import EventEmitter from './EventEmitter';
 import CoreManager from './CoreManager';
 import { resolvingPromise } from './promiseUtils';
 
 /**
  * Creates a new LiveQuery Subscription.
- * Extends events.EventEmitter
  * <a href="https://nodejs.org/api/events.html#events_class_eventemitter">cloud functions</a>.
  *
  * <p>Response Object - Contains data from the client that made the request
@@ -84,24 +82,25 @@ import { resolvingPromise } from './promiseUtils';
  * subscription.on('close', () => {
  *
  * });</pre></p>
- *
- * @alias Parse.LiveQuerySubscription
  */
-class Subscription extends EventEmitter {
+class Subscription {
   /*
    * @param {string} id - subscription id
    * @param {string} query - query to subscribe to
    * @param {string} sessionToken - optional session token
    */
   constructor(id, query, sessionToken) {
-    super();
     this.id = id;
     this.query = query;
     this.sessionToken = sessionToken;
     this.subscribePromise = resolvingPromise();
     this.unsubscribePromise = resolvingPromise();
     this.subscribed = false;
+    const EventEmitter = CoreManager.getEventEmitter();
+    this.emitter = new EventEmitter();
 
+    this.on = this.emitter.on;
+    this.emit = this.emitter.emit;
     // adding listener so process does not crash
     // best practice is for developer to register their own listener
     this.on('error', () => {});

src/Parse.ts

@@ -11,6 +11,7 @@ import AnonymousUtils from './AnonymousUtils'
 import * as Cloud from './Cloud';
 import CLP from './ParseCLP';
 import CoreManager from './CoreManager';
+import EventEmitter from './EventEmitter';
 import Config from './ParseConfig'
 import ParseError from './ParseError'
 import FacebookUtils from './FacebookUtils'
@@ -76,7 +77,7 @@ interface ParseType {
   Session: typeof Session,
   Storage: typeof Storage,
   User: typeof User,
-  LiveQuery: typeof LiveQuery,
+  LiveQuery?: typeof LiveQuery,
   LiveQueryClient: typeof LiveQueryClient,
 
   initialize(applicationId: string, javaScriptKey: string): void,
@@ -143,13 +144,12 @@ const Parse: ParseType = {
   Session:  Session,
   Storage:  Storage,
   User:  User,
-  LiveQuery:  LiveQuery,
   LiveQueryClient:  LiveQueryClient,
+  LiveQuery:  undefined,
   IndexedDB: undefined,
   Hooks: undefined,
   Parse: undefined,
 
-
   /**
    * Call this method first to set up your authentication tokens for Parse.
    *
@@ -179,6 +179,10 @@ const Parse: ParseType = {
     CoreManager.set('JAVASCRIPT_KEY', javaScriptKey);
     CoreManager.set('MASTER_KEY', masterKey);
     CoreManager.set('USE_MASTER_KEY', false);
+    CoreManager.setIfNeeded('EventEmitter', EventEmitter);
+
+    Parse.LiveQuery = new LiveQuery();
+    CoreManager.setIfNeeded('LiveQuery', Parse.LiveQuery);
   },
 
   /**
@@ -422,7 +426,6 @@ const Parse: ParseType = {
   isEncryptedUserEnabled () {
     return this.encryptedUser;
   },
-
 };
 
 if (process.env.PARSE_BUILD === 'browser') {