Add enableSchemaHooks option

Author: dplewis

CHANGELOG.md

@@ -89,9 +89,9 @@ ___
 ## Unreleased (Master Branch)
 [Full Changelog](https://github.com/parse-community/parse-server/compare/4.5.0...master)
 ### Breaking Changes
-Leveraging database real-time hooks, schema caching has been drastically improved. These improvements allows for reduced calls to the DB, faster queries and prevention of memory leaks. A breaking change can occur if you are horizontally scaling Parse Server (multiple Parse Server instances using the same DB). Set `horizontalScaling` parameter in [Parse Server Options](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html). If you are horizontal scaling instances connected to MongoDB, you must use replica set clusters with WiredTiger, see [ChangeStream](https://docs.mongodb.com/manual/changeStreams/#availability)
+Leveraging database real-time hooks, schema caching has been drastically improved. These improvements allows for reduced calls to the DB, faster queries and prevention of memory leaks. A breaking change can occur if you are horizontally scaling Parse Server (multiple Parse Server instances connecting to the same DB). Set `enableSchemaHooks` parameter in [Parse Server Options](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html) (`enableSingleSchemaCache` and `schemaCacheTTL` have been removed). If you are horizontal scaling instances connected to MongoDB, you must use replica set clusters with WiredTiger, see [ChangeStream](https://docs.mongodb.com/manual/changeStreams/#availability)
 
-The new schema cache uses a singleton object that is stored in-memory. In a horizontally scaled environment, if you update the schema in one instance the DB hooks will update the schema in all other instances. `horizontalScaling: true` enables the DB hooks. If you have multiple server instances but `horizontalScaling: false`, your schema maybe out of sync in your instances (resyncing will happen if an instance restarts). (Diamond Lewis, SebC) [#7214](https://github.com/parse-community/parse-server/issues/7214)
+The new schema cache uses a singleton object that is stored in-memory. In a horizontally scaled environment, if you update the schema in one instance the DB hooks will update the schema in all other instances. `enableSchemaHooks: true` enables the DB hooks. If you have multiple server instances but `enableSchemaHooks: false`, your schema maybe out of sync in your instances (resyncing will happen if an instance restarts). (Diamond Lewis, SebC) [#7214](https://github.com/parse-community/parse-server/issues/7214)
 - Added file upload restriction. File upload is now only allowed for authenticated users by default for improved security. To allow file upload also for Anonymous Users or Public, set the `fileUpload` parameter in the [Parse Server Options](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html) (dblythy, Manuel Trezza) [#7071](https://github.com/parse-community/parse-server/pull/7071)
 ### Notable Changes
 - Added Parse Server Security Check to report weak security settings (Manuel Trezza, dblythy) [#7247](https://github.com/parse-community/parse-server/issues/7247)

spec/MongoStorageAdapter.spec.js

@@ -554,10 +554,10 @@ describe_only_db('mongo')('MongoStorageAdapter', () => {
       it('should change', async done => {
         const adapter = new MongoStorageAdapter({ uri: databaseURI });
         await reconfigureServer({
-          horizontalScaling: true,
+          enableSchemaHooks: true,
           databaseAdapter: adapter,
         });
-        expect(adapter.enableHooks).toBe(true);
+        expect(adapter.enableSchemaHooks).toBe(true);
         spyOn(adapter, '_onchange');
         const schema = {
           fields: {

spec/PostgresStorageAdapter.spec.js

@@ -392,22 +392,23 @@ describe_only_db('postgres')('PostgresStorageAdapter', () => {
   });
 
   it('should watch _SCHEMA changes', async () => {
-    const enableHooks = true;
+    const enableSchemaHooks = true;
     await reconfigureServer({
-      horizontalScaling: true,
+      enableSchemaHooks: true,
     });
     const { database } = Config.get(Parse.applicationId);
     const { adapter } = database;
-    expect(adapter.enableHooks).toBe(enableHooks);
+    expect(adapter.enableSchemaHooks).toBe(enableSchemaHooks);
     spyOn(adapter, '_onchange');
+    enableSchemaHooks;
 
     const otherInstance = new PostgresStorageAdapter({
       uri: databaseURI,
       collectionPrefix: '',
       databaseOptions: {},
-      enableHooks,
+      enableSchemaHooks,
     });
-    expect(otherInstance.enableHooks).toBe(enableHooks);
+    expect(otherInstance.enableSchemaHooks).toBe(enableSchemaHooks);
     otherInstance._listenToSchema();
 
     await otherInstance.createClass('Stuff', {

spec/SchemaPerformance.spec.js

@@ -11,7 +11,7 @@ describe_only_db('mongo')('Schema Performance', function () {
     config.schemaCache.clear();
     const databaseAdapter = new MongoStorageAdapter({ uri: mongoURI });
     await reconfigureServer({
-      horizontalScaling: false,
+      enableSchemaHooks: false,
       databaseAdapter,
     });
     getAllSpy = spyOn(databaseAdapter, 'getAllClasses').and.callThrough();

spec/helper.js

@@ -97,7 +97,7 @@ const defaultConfiguration = {
   fileKey: 'test',
   silent,
   logLevel,
-  horizontalScaling: false,
+  enableSchemaHooks: false,
   fileUpload: {
     enableForPublic: true,
     enableForAnonymousUser: true,

src/Adapters/Storage/Mongo/MongoStorageAdapter.js

@@ -121,13 +121,13 @@ export class MongoStorageAdapter implements StorageAdapter {
   client: MongoClient;
   _maxTimeMS: ?number;
   canSortOnJoinTables: boolean;
-  enableHooks: boolean;
+  enableSchemaHooks: boolean;
 
   constructor({
     uri = defaults.DefaultMongoURI,
     collectionPrefix = '',
     mongoOptions = {},
-    enableHooks = false,
+    enableSchemaHooks = false,
   }: any) {
     this._uri = uri;
     this._collectionPrefix = collectionPrefix;
@@ -139,7 +139,7 @@ export class MongoStorageAdapter implements StorageAdapter {
     // MaxTimeMS is not a global MongoDB client option, it is applied per operation.
     this._maxTimeMS = mongoOptions.maxTimeMS;
     this.canSortOnJoinTables = true;
-    this.enableHooks = enableHooks;
+    this.enableSchemaHooks = enableSchemaHooks;
     delete mongoOptions.maxTimeMS;
   }
 
@@ -213,7 +213,7 @@ export class MongoStorageAdapter implements StorageAdapter {
     return this.connect()
       .then(() => this._adaptiveCollection(MongoSchemaCollectionName))
       .then(collection => {
-        if (!this._stream && this.enableHooks) {
+        if (!this._stream && this.enableSchemaHooks) {
           this._stream = collection._mongoCollection.watch();
           this._stream.on('change', () => this._onchange());
         }

src/Adapters/Storage/Postgres/PostgresStorageAdapter.js

@@ -796,7 +796,7 @@ const buildWhereClause = ({ schema, query, index, caseInsensitive }): WhereClaus
 
 export class PostgresStorageAdapter implements StorageAdapter {
   canSortOnJoinTables: boolean;
-  enableHooks: boolean;
+  enableSchemaHooks: boolean;
 
   // Private
   _collectionPrefix: string;
@@ -806,9 +806,14 @@ export class PostgresStorageAdapter implements StorageAdapter {
   _stream: any;
   _uuid: any;
 
-  constructor({ uri, collectionPrefix = '', databaseOptions = {}, enableHooks = false }: any) {
+  constructor({
+    uri,
+    collectionPrefix = '',
+    databaseOptions = {},
+    enableSchemaHooks = false,
+  }: any) {
     this._collectionPrefix = collectionPrefix;
-    this.enableHooks = enableHooks;
+    this.enableSchemaHooks = enableSchemaHooks;
 
     const { client, pgp } = createClient(uri, databaseOptions);
     this._client = client;
@@ -843,7 +848,7 @@ export class PostgresStorageAdapter implements StorageAdapter {
   }
 
   async _listenToSchema() {
-    if (!this._stream && this.enableHooks) {
+    if (!this._stream && this.enableSchemaHooks) {
       this._stream = await this._client.connect({ direct: true });
       this._stream.client.on('notification', data => {
         const payload = JSON.parse(data.payload);

src/Controllers/index.js

@@ -143,7 +143,7 @@ export function getLiveQueryController(options: ParseServerOptions): LiveQueryCo
 }
 
 export function getDatabaseController(options: ParseServerOptions): DatabaseController {
-  const { databaseURI, collectionPrefix, horizontalScaling } = options;
+  const { databaseURI, collectionPrefix, enableSchemaHooks } = options;
   let { databaseAdapter, databaseOptions } = options;
   if (
     (databaseOptions ||
@@ -158,11 +158,11 @@ export function getDatabaseController(options: ParseServerOptions): DatabaseCont
       databaseURI,
       collectionPrefix,
       databaseOptions,
-      horizontalScaling
+      enableSchemaHooks
     );
   } else {
     databaseAdapter = loadAdapter(databaseAdapter);
-    databaseAdapter.enableHooks = !!horizontalScaling;
+    databaseAdapter.enableSchemaHooks = !!enableSchemaHooks;
   }
   return new DatabaseController(databaseAdapter);
 }
@@ -224,7 +224,12 @@ export function getAuthDataManager(options: ParseServerOptions) {
   return authDataManager(auth, enableAnonymousUsers);
 }
 
-export function getDatabaseAdapter(databaseURI, collectionPrefix, databaseOptions, enableHooks) {
+export function getDatabaseAdapter(
+  databaseURI,
+  collectionPrefix,
+  databaseOptions,
+  enableSchemaHooks
+) {
   let protocol;
   try {
     const parsedURI = url.parse(databaseURI);
@@ -238,14 +243,14 @@ export function getDatabaseAdapter(databaseURI, collectionPrefix, databaseOption
         uri: databaseURI,
         collectionPrefix,
         databaseOptions,
-        enableHooks,
+        enableSchemaHooks,
       });
     default:
       return new MongoStorageAdapter({
         uri: databaseURI,
         collectionPrefix,
         mongoOptions: databaseOptions,
-        enableHooks,
+        enableSchemaHooks,
       });
   }
 }

src/Options/Definitions.js

@@ -149,6 +149,13 @@ module.exports.ParseServerOptions = {
     action: parsers.booleanParser,
     default: false,
   },
+  enableSchemaHooks: {
+    env: 'PARSE_SERVER_ENABLE_SCHEMA_HOOKS',
+    help:
+      'Enables database hooks to update single schema cache. Set to true if using multiple Parse Servers instances connected to the same database.',
+    action: parsers.booleanParser,
+    default: false,
+  },
   encryptionKey: {
     env: 'PARSE_SERVER_ENCRYPTION_KEY',
     help: 'Key for encrypting your files',
@@ -183,13 +190,6 @@ module.exports.ParseServerOptions = {
     env: 'PARSE_SERVER_GRAPH_QLSCHEMA',
     help: 'Full path to your GraphQL custom schema.graphql file',
   },
-  horizontalScaling: {
-    env: 'PARSE_SERVER_HORIZONTAL_SCALING',
-    help:
-      'Set to true if multiple Parse Servers instances are used with the same database. Enables database hooks to update single schema cache.',
-    action: parsers.booleanParser,
-    default: false,
-  },
   host: {
     env: 'PARSE_SERVER_HOST',
     help: 'The host to serve ParseServer on, defaults to 0.0.0.0',

src/Options/docs.js

@@ -27,14 +27,14 @@
  * @property {Number} emailVerifyTokenValidityDuration Email verification token validity duration, in seconds
  * @property {Boolean} enableAnonymousUsers Enable (or disable) anonymous users, defaults to true
  * @property {Boolean} enableExpressErrorHandler Enables the default express error handler for all errors
+ * @property {Boolean} enableSchemaHooks Enables database hooks to update single schema cache. Set to true if using multiple Parse Servers instances connected to the same database.
  * @property {String} encryptionKey Key for encrypting your files
  * @property {Boolean} expireInactiveSessions Sets wether we should expire the inactive sessions, defaults to true
  * @property {String} fileKey Key for your files
  * @property {Adapter<FilesAdapter>} filesAdapter Adapter module for the files sub-system
  * @property {FileUploadOptions} fileUpload Options for file uploads
  * @property {String} graphQLPath Mount path for the GraphQL endpoint, defaults to /graphql
  * @property {String} graphQLSchema Full path to your GraphQL custom schema.graphql file
- * @property {Boolean} horizontalScaling Set to true if multiple Parse Servers instances are used with the same database. Enables database hooks to update single schema cache.
  * @property {String} host The host to serve ParseServer on, defaults to 0.0.0.0
  * @property {IdempotencyOptions} idempotencyOptions Options for request idempotency to deduplicate identical requests that may be caused by network issues. Caution, this is an experimental feature that may not be appropriate for production.
  * @property {String} javascriptKey Key for the Javascript SDK