Skip ensuring some indexes to be created when running against Azure Cosmos DB for MongoDB

Add docs change and config validator

Author: ApteanVictorJiang

src/Config.js

@@ -85,6 +85,7 @@ export class Config {
     allowExpiredAuthDataToken,
     logLevels,
     rateLimit,
+    azureCosmosMongoDbCompatibleMode,
     databaseOptions,
   }) {
     if (masterKey === readOnlyMasterKey) {
@@ -120,6 +121,7 @@ export class Config {
     this.validateSchemaOptions(schema);
     this.validateEnforcePrivateUsers(enforcePrivateUsers);
     this.validateAllowExpiredAuthDataToken(allowExpiredAuthDataToken);
+    this.validateAzureCosmosMongoDbCompatibleMode(azureCosmosMongoDbCompatibleMode);
     this.validateRequestKeywordDenylist(requestKeywordDenylist);
     this.validateRateLimit(rateLimit);
     this.validateLogLevels(logLevels);
@@ -166,6 +168,12 @@ export class Config {
     }
   }
 
+  static validateAzureCosmosMongoDbCompatibleMode(azureCosmosMongoDbCompatibleMode) {
+    if (typeof azureCosmosMongoDbCompatibleMode !== 'boolean') {
+      throw 'Parse Server option azureCosmosMongoDbCompatibleMode must be a boolean.';
+    }
+  }
+
   static validateSecurityOptions(security) {
     if (Object.prototype.toString.call(security) !== '[object Object]') {
       throw 'Parse Server option security must be an object.';

src/Controllers/DatabaseController.js

@@ -1706,30 +1706,33 @@ class DatabaseController {
       throw error;
     });
 
-    await this.adapter
-      .ensureIndex('_User', requiredUserFields, ['username'], 'case_insensitive_username', true)
-      .catch(error => {
-        logger.warn('Unable to create case insensitive username index: ', error);
-        throw error;
-      });
-    await this.adapter
-      .ensureIndex('_User', requiredUserFields, ['username'], 'case_insensitive_username', true)
-      .catch(error => {
-        logger.warn('Unable to create case insensitive username index: ', error);
-        throw error;
-      });
-
+    if (!this.options.azureCosmosMongoDbCompatibleMode) {
+      await this.adapter
+        .ensureIndex('_User', requiredUserFields, ['username'], 'case_insensitive_username', true)
+        .catch(error => {
+          logger.warn('Unable to create case insensitive username index: ', error);
+          throw error;
+        });
+      await this.adapter
+        .ensureIndex('_User', requiredUserFields, ['username'], 'case_insensitive_username', true)
+        .catch(error => {
+          logger.warn('Unable to create case insensitive username index: ', error);
+          throw error;
+        });
+    }
     await this.adapter.ensureUniqueness('_User', requiredUserFields, ['email']).catch(error => {
       logger.warn('Unable to ensure uniqueness for user email addresses: ', error);
       throw error;
     });
 
-    await this.adapter
-      .ensureIndex('_User', requiredUserFields, ['email'], 'case_insensitive_email', true)
-      .catch(error => {
-        logger.warn('Unable to create case insensitive email index: ', error);
-        throw error;
-      });
+    if (!this.options.azureCosmosMongoDbCompatibleMode) {
+      await this.adapter
+        .ensureIndex('_User', requiredUserFields, ['email'], 'case_insensitive_email', true)
+        .catch(error => {
+          logger.warn('Unable to create case insensitive email index: ', error);
+          throw error;
+        });
+    }
 
     await this.adapter.ensureUniqueness('_Role', requiredRoleFields, ['name']).catch(error => {
       logger.warn('Unable to ensure uniqueness for role name: ', error);
@@ -1755,12 +1758,14 @@ class DatabaseController {
         options = this.idempotencyOptions;
         options.setIdempotencyFunction = true;
       }
-      await this.adapter
-        .ensureIndex('_Idempotency', requiredIdempotencyFields, ['expire'], 'ttl', false, options)
-        .catch(error => {
-          logger.warn('Unable to create TTL index for idempotency expire date: ', error);
-          throw error;
-        });
+      if (!this.options.azureCosmosMongoDbCompatibleMode) {
+        await this.adapter
+          .ensureIndex('_Idempotency', requiredIdempotencyFields, ['expire'], 'ttl', false, options)
+          .catch(error => {
+            logger.warn('Unable to create TTL index for idempotency expire date: ', error);
+            throw error;
+          });
+      }
     }
     await this.adapter.updateSchemaWithIndexes();
   }

src/Options/Definitions.js

@@ -103,6 +103,13 @@ module.exports.ParseServerOptions = {
       'Configuration for your authentication providers, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication',
     action: parsers.arrayParser,
   },
+  azureCosmosMongoDbCompatibleMode: {
+    env: 'PARSE_SERVER_AZURE_COSMOS_MONGO_DB_COMPATIBLE_MODE',
+    help:
+      'Set to true for running against Azure Cosmos for Mongo DB. This can bring some performance loss.',
+    action: parsers.booleanParser,
+    default: false,
+  },
   cacheAdapter: {
     env: 'PARSE_SERVER_CACHE_ADAPTER',
     help: 'Adapter module for the cache',

src/Options/docs.js

@@ -300,6 +300,9 @@ export interface ParseServerOptions {
   /* Options to limit repeated requests to Parse Server APIs. This can be used to protect sensitive endpoints such as `/requestPasswordReset` from brute-force attacks or Parse Server as a whole from denial-of-service (DoS) attacks.<br><br>ℹ️ Mind the following limitations:<br>- rate limits applied per IP address; this limits protection against distributed denial-of-service (DDoS) attacks where many requests are coming from various IP addresses<br>- if multiple Parse Server instances are behind a load balancer or ran in a cluster, each instance will calculate it's own request rates, independent from other instances; this limits the applicability of this feature when using a load balancer and another rate limiting solution that takes requests across all instances into account may be more suitable<br>- this feature provides basic protection against denial-of-service attacks, but a more sophisticated solution works earlier in the request flow and prevents a malicious requests to even reach a server instance; it's therefore recommended to implement a solution according to architecture and user case.
   :DEFAULT: [] */
   rateLimit: ?(RateLimitOptions[]);
+  /* Set to true for running against Azure Cosmos for Mongo DB. This can bring some performance loss.
+  :DEFAULT: false */
+  azureCosmosMongoDbCompatibleMode: ?boolean;
 }
 
 export interface RateLimitOptions {