fix: suggested changes

Author: RahulLanjewar93

spec/DefinedSchemas.spec.js

@@ -371,7 +371,7 @@ describe('DefinedSchemas', () => {
       expect(schema.indexes).toEqual(indexes);
     });
 
-    it('should delete unknown indexes when dropUnknownIndexes is not set', async () => {
+    it('should delete unknown indexes when keepUnknownIndexes is not set', async () => {
       const server = await reconfigureServer();
 
       let indexes = { complex: { createdAt: 1, updatedAt: 1 } };
@@ -394,16 +394,16 @@ describe('DefinedSchemas', () => {
       expect(schema.indexes).toBeUndefined();
     });
 
-    it('should delete unknown indexes when dropUnknownIndexes is set to true', async () => {
+    it('should delete unknown indexes when keepUnknownIndexes is set to false', async () => {
       const server = await reconfigureServer();
 
       let indexes = { complex: { createdAt: 1, updatedAt: 1 } };
 
-      let schemas = { definitions: [{ className: 'Test', indexes }], dropUnknownIndexes: true };
+      let schemas = { definitions: [{ className: 'Test', indexes }], keepUnknownIndexes: false };
       await new DefinedSchemas(schemas, server.config).execute();
 
       indexes = {};
-      schemas = { definitions: [{ className: 'Test', indexes }], dropUnknownIndexes: true };
+      schemas = { definitions: [{ className: 'Test', indexes }], keepUnknownIndexes: false };
       // Change indexes
       await new DefinedSchemas(schemas, server.config).execute();
       let schema = await new Parse.Schema('Test').get();
@@ -417,15 +417,15 @@ describe('DefinedSchemas', () => {
       expect(schema.indexes).toBeUndefined();
     });
 
-    it('should not delete unknown indexes when dropUnknownIndexes is set to false', async () => {
+    it('should not delete unknown indexes when keepUnknownIndexes is set to true', async () => {
       const server = await reconfigureServer();
 
       const indexes = { complex: { createdAt: 1, updatedAt: 1 } };
 
-      let schemas = { definitions: [{ className: 'Test', indexes }], dropUnknownIndexes: false };
+      let schemas = { definitions: [{ className: 'Test', indexes }], keepUnknownIndexes: true };
       await new DefinedSchemas(schemas, server.config).execute();
 
-      schemas = { definitions: [{ className: 'Test', indexes: {} }], dropUnknownIndexes: false };
+      schemas = { definitions: [{ className: 'Test', indexes: {} }], keepUnknownIndexes: true };
 
       // Change indexes
       await new DefinedSchemas(schemas, server.config).execute();

src/Options/Definitions.js

@@ -28,12 +28,12 @@ module.exports.SchemaOptions = {
     action: parsers.booleanParser,
     default: false,
   },
-  dropUnknownIndexes: {
-    env: 'PARSE_SERVER_SCHEMA_DROP_UNKNOWN_INDEXES',
+  keepUnknownIndexes: {
+    env: 'PARSE_SERVER_SCHEMA_KEEP_UNKNOWN_INDEXES',
     help:
-      'Drops indexes that are not defined in the schema and are present in the database. Set this false if you are adding indexes manually so that it wont be dropped when you run schema migration',
+      'Keep indexes that are not defined in the schema and are present in the database. Set this to true if you are adding indexes manually so that it wont be dropped when you run schema migration',
     action: parsers.booleanParser,
-    default: true,
+    default: false,
   },
   lockSchemas: {
     env: 'PARSE_SERVER_SCHEMA_LOCK_SCHEMAS',

src/Options/docs.js

@@ -25,9 +25,9 @@ export interface SchemaOptions {
   /* Is true if Parse Server will reject any attempts to modify the schema while the server is running.
   :DEFAULT: false */
   lockSchemas: ?boolean;
-  /* Drops indexes that are not defined in the schema and are present in the database. Set this false if you are adding indexes manually so that it wont be dropped when you run schema migration
-  :DEFAULT: true */
-  dropUnknownIndexes: ?boolean;
+  /* Keep indexes that are not defined in the schema and are present in the database. Set this to true if you are adding indexes manually so that it wont be dropped when you run schema migration
+  :DEFAULT: false */
+  keepUnknownIndexes: ?boolean;
   /* Execute a callback before running schema migrations. */
   beforeMigration: ?() => void | Promise<void>;
   /* Execute a callback after running schema migrations. */

src/Options/index.js

@@ -349,8 +349,8 @@ export class DefinedSchemas {
       Object.keys(cloudSchema.indexes).forEach(indexName => {
         if (!this.isProtectedIndex(localSchema.className, indexName)) {
           if (!localSchema.indexes || !localSchema.indexes[indexName]) {
-            // Only delete indexes which are present in database if dropUnknownIndexes is `true`
-            if(this.schemaOptions.dropUnknownIndexes !== false){
+            // If keepUnknownIndex is falsy, then delete all unknown indexes from the db.
+            if(!this.schemaOptions.keepUnknownIndexes){
               newLocalSchema.deleteIndex(indexName);
             }
           } else if (

src/SchemaMigrations/DefinedSchemas.js

@@ -6,7 +6,7 @@ export interface SchemaOptions {
   deleteExtraFields: ?boolean;
   recreateModifiedFields: ?boolean;
   lockSchemas: ?boolean;
-  dropUnknownIndexes: ?boolean;
+  keepUnknownIndexes: ?boolean;
   beforeMigration: ?() => void | Promise<void>;
   afterMigration: ?() => void | Promise<void>;
 }