Merge branch 'pr-migrations'

Author: sadortun

CHANGELOG.md

@@ -114,6 +114,7 @@ ___
 - Added Deprecation Policy to govern the introduction of breaking changes in a phased pattern that is more predictable for developers (Manuel Trezza) [#7199](https://github.com/parse-community/parse-server/pull/7199)
 - Add REST API endpoint `/loginAs` to create session of any user with master key; allows to impersonate another user. (GormanFletcher) [#7406](https://github.com/parse-community/parse-server/pull/7406)
 - Add official support for MongoDB 5.0 (Manuel Trezza) [#7469](https://github.com/parse-community/parse-server/pull/7469)
+- Add user-defined schema and migrations (Antoine Cormouls, Samuel Denis-D'Ortun) [#7418](https://github.com/parse-community/parse-server/pull/7418)
 
 ### Other Changes
 - Support native mongodb syntax in aggregation pipelines (Raschid JF Rafeally) [#7339](https://github.com/parse-community/parse-server/pull/7339)

src/Adapters/Storage/Mongo/MongoSchemaCollection.js

@@ -1,5 +1,6 @@
 import MongoCollection from './MongoCollection';
 import Parse from 'parse/node';
+import _ from 'lodash'
 
 function mongoFieldToParseSchemaField(type) {
   if (type[0] === '*') {
@@ -276,8 +277,9 @@ class MongoSchemaCollection {
   }
 
   async updateFieldOptions(className: string, fieldName: string, fieldType: any) {
-    // eslint-disable-next-line no-unused-vars
-    const { type, targetClass, ...fieldOptions } = fieldType;
+    const fieldOptions = _.cloneDeep(fieldType);
+    delete fieldOptions.type
+    delete fieldOptions.targetClass
     await this.upsertSchema(
       className,
       { [fieldName]: { $exists: true } },

src/Config.js

@@ -14,7 +14,6 @@ import {
   SchemaOptions,
 } from './Options/Definitions';
 import { isBoolean, isString, isArray } from 'lodash';
-import type { MigrationsOptions } from './SchemaMigrations/Migrations';
 
 function removeTrailingSlash(str) {
   if (!str) {
@@ -77,6 +76,7 @@ export class Config {
     fileUpload,
     pages,
     security,
+    schema,
   }) {
     if (masterKey === readOnlyMasterKey) {
       throw new Error('masterKey and readOnlyMasterKey should be different');
@@ -113,7 +113,7 @@ export class Config {
     this.validateIdempotencyOptions(idempotencyOptions);
     this.validatePagesOptions(pages);
     this.validateSecurityOptions(security);
-    this.validateSchemaOptions(security);
+    this.validateSchemaOptions(schema);
   }
 
   static validateSecurityOptions(security) {
@@ -132,7 +132,7 @@ export class Config {
     }
   }
 
-  static validateSchemaOptions(schema: MigrationsOptions) {
+  static validateSchemaOptions(schema: SchemaOptions) {
     if (Object.prototype.toString.call(schema) !== '[object Object]') {
       throw 'Parse Server option schema must be an object.';
     }

src/Options/Definitions.js

@@ -441,13 +441,6 @@ module.exports.SecurityOptions = {
   },
 };
 module.exports.SchemaOptions = {
-  // definitions: JSONSchema[];
-  // strict: ?boolean;
-  // deleteExtraFields: ?boolean;
-  // recreateModifiedFields: ?boolean;
-  // lockSchemas: ?boolean;
-  // beforeMigration: ?() => void | Promise<void>;
-  // afterMigration: ?() => void | Promise<void>;
   definitions: {
     help: 'The schema definitions.',
     default: [],

src/Options/index.js

@@ -8,7 +8,7 @@ import { MailAdapter } from '../Adapters/Email/MailAdapter';
 import { PubSubAdapter } from '../Adapters/PubSub/PubSubAdapter';
 import { WSSAdapter } from '../Adapters/WebSocketServer/WSSAdapter';
 import { CheckGroup } from '../Security/CheckGroup';
-import type { MigrationsOptions } from '../SchemaMigrations/Migrations';
+import type { SchemaOptions } from '../SchemaMigrations/Migrations';
 
 type Adapter<T> = string | any | T;
 type NumberOrBoolean = number | boolean;
@@ -243,7 +243,7 @@ export interface ParseServerOptions {
   /* Callback when server has started */
   serverStartComplete: ?(error: ?Error) => void;
   /* Rest representation on Parse.Schema https://docs.parseplatform.org/rest/guide/#adding-a-schema */
-  schema: ?MigrationsOptions;
+  schema: ?SchemaOptions;
   /* Callback when server has closed */
   serverCloseComplete: ?() => void;
   /* The security options to identify and report weak security settings.

src/SchemaMigrations/DefinedSchemas.js

@@ -9,22 +9,22 @@ import * as Migrations from './Migrations';
 
 export class DefinedSchemas {
   config: ParseServerOptions;
-  migrationsOptions: Migrations.MigrationsOptions;
+  schemaOptions: Migrations.SchemaOptions;
   localSchemas: Migrations.JSONSchema[];
   retries: number;
   maxRetries: number;
 
-  constructor(migrationsOptions: Migrations.MigrationsOptions, config: ParseServerOptions) {
+  constructor(schemaOptions: Migrations.SchemaOptions, config: ParseServerOptions) {
     this.localSchemas = [];
     this.config = Config.get(config.appId);
-    this.migrationsOptions = migrationsOptions;
+    this.schemaOptions = schemaOptions;
 
-    if (migrationsOptions && migrationsOptions.definitions) {
-      if (!Array.isArray(migrationsOptions.definitions)) {
+    if (schemaOptions && schemaOptions.definitions) {
+      if (!Array.isArray(schemaOptions.definitions)) {
         throw `"schema.definitions" must be an array of schemas`;
       }
 
-      this.localSchemas = migrationsOptions.definitions;
+      this.localSchemas = schemaOptions.definitions;
     }
 
     this.retries = 0;
@@ -66,14 +66,14 @@ export class DefinedSchemas {
   async execute() {
     try {
       logger.info('Running Migrations');
-      if (this.migrationsOptions && this.migrationsOptions.beforeMigration) {
-        await Promise.resolve(this.migrationsOptions.beforeMigration());
+      if (this.schemaOptions && this.schemaOptions.beforeMigration) {
+        await Promise.resolve(this.schemaOptions.beforeMigration());
       }
 
       await this.executeMigrations();
 
-      if (this.migrationsOptions && this.migrationsOptions.afterMigration) {
-        await Promise.resolve(this.migrationsOptions.afterMigration());
+      if (this.schemaOptions && this.schemaOptions.afterMigration) {
+        await Promise.resolve(this.schemaOptions.afterMigration());
       }
 
       logger.info('Running Migrations Completed');
@@ -122,7 +122,7 @@ export class DefinedSchemas {
   }
 
   checkForMissingSchemas() {
-    if (this.migrationsOptions.strict !== true) {
+    if (this.schemaOptions.strict !== true) {
       return;
     }
 
@@ -141,7 +141,7 @@ export class DefinedSchemas {
       process.exit(1);
     }
 
-    if (this.migrationsOptions.strict && missingSchemas.length) {
+    if (this.schemaOptions.strict && missingSchemas.length) {
       logger.warn(
         `The following schemas are currently present in the database, but not explicitly defined in a schema: "${missingSchemas.join(
           '", "'
@@ -273,22 +273,22 @@ export class DefinedSchemas {
         }
       });
 
-    if (this.migrationsOptions.deleteExtraFields === true) {
+    if (this.schemaOptions.deleteExtraFields === true) {
       fieldsToDelete.forEach(fieldName => {
         newLocalSchema.deleteField(fieldName);
       });
 
       // Delete fields from the schema then apply changes
       await this.updateSchemaToDB(newLocalSchema);
-    } else if (this.migrationsOptions.strict === true && fieldsToDelete.length) {
+    } else if (this.schemaOptions.strict === true && fieldsToDelete.length) {
       logger.warn(
         `The following fields exist in the database for "${
           localSchema.className
         }", but are missing in the schema : "${fieldsToDelete.join('" ,"')}"`
       );
     }
 
-    if (this.migrationsOptions.recreateModifiedFields === true) {
+    if (this.schemaOptions.recreateModifiedFields === true) {
       fieldsToRecreate.forEach(field => {
         newLocalSchema.deleteField(field.fieldName);
       });
@@ -300,7 +300,7 @@ export class DefinedSchemas {
         const field = localSchema.fields[fieldInfo.fieldName];
         this.handleFields(newLocalSchema, fieldInfo.fieldName, field);
       });
-    } else if (this.migrationsOptions.strict === true && fieldsToRecreate.length) {
+    } else if (this.schemaOptions.strict === true && fieldsToRecreate.length) {
       fieldsToRecreate.forEach(field => {
         const from =
           field.from.type + (field.from.targetClass ? ` (${field.from.targetClass})` : '');

src/SchemaMigrations/Migrations.js

@@ -35,7 +35,7 @@ export interface IndexesInterface {
   [key: string]: IndexInterface;
 }
 
-export interface MigrationsOptions {
+export interface SchemaOptions {
   definitions: JSONSchema[];
   strict: ?boolean;
   deleteExtraFields: ?boolean;

src/Security/CheckGroups/CheckGroupDatabase.js

@@ -8,9 +8,9 @@ import Config from '../../Config';
 import Parse from 'parse/node';
 
 /**
- * The security checks group for Parse Server configuration.
- * Checks common Parse Server parameters such as access keys.
- */
+* The security checks group for Parse Server configuration.
+* Checks common Parse Server parameters such as access keys.
+*/
 class CheckGroupDatabase extends CheckGroup {
   setName() {
     return 'Database';
@@ -23,8 +23,7 @@ class CheckGroupDatabase extends CheckGroup {
       new Check({
         title: 'Secure database password',
         warning: 'The database password is insecure and vulnerable to brute force attacks.',
-        solution:
-          'Choose a longer and/or more complex password with a combination of upper- and lowercase characters, numbers and special characters.',
+        solution: 'Choose a longer and/or more complex password with a combination of upper- and lowercase characters, numbers and special characters.',
         check: () => {
           const password = databaseUrl.match(/\/\/\S+:(\S+)@/)[1];
           const hasUpperCase = /[A-Z]/.test(password);

src/Security/CheckGroups/CheckGroupServerConfig.js

@@ -8,9 +8,9 @@ import Config from '../../Config';
 import Parse from 'parse/node';
 
 /**
- * The security checks group for Parse Server configuration.
- * Checks common Parse Server parameters such as access keys.
- */
+* The security checks group for Parse Server configuration.
+* Checks common Parse Server parameters such as access keys.
+*/
 class CheckGroupServerConfig extends CheckGroup {
   setName() {
     return 'Parse Server Configuration';
@@ -21,8 +21,7 @@ class CheckGroupServerConfig extends CheckGroup {
       new Check({
         title: 'Secure master key',
         warning: 'The Parse Server master key is insecure and vulnerable to brute force attacks.',
-        solution:
-          'Choose a longer and/or more complex master key with a combination of upper- and lowercase characters, numbers and special characters.',
+        solution: 'Choose a longer and/or more complex master key with a combination of upper- and lowercase characters, numbers and special characters.',
         check: () => {
           const masterKey = config.masterKey;
           const hasUpperCase = /[A-Z]/.test(masterKey);
@@ -42,7 +41,7 @@ class CheckGroupServerConfig extends CheckGroup {
       new Check({
         title: 'Security log disabled',
         warning: 'Security checks in logs may expose vulnerabilities to anyone access to logs.',
-        solution: "Change Parse Server configuration to 'security.enableCheckLog: false'.",
+        solution: 'Change Parse Server configuration to \'security.enableCheckLog: false\'.',
         check: () => {
           if (config.security && config.security.enableCheckLog) {
             throw 1;
@@ -51,9 +50,8 @@ class CheckGroupServerConfig extends CheckGroup {
       }),
       new Check({
         title: 'Client class creation disabled',
-        warning:
-          'Attackers are allowed to create new classes without restriction and flood the database.',
-        solution: "Change Parse Server configuration to 'allowClientClassCreation: false'.",
+        warning: 'Attackers are allowed to create new classes without restriction and flood the database.',
+        solution: 'Change Parse Server configuration to \'allowClientClassCreation: false\'.',
         check: () => {
           if (config.allowClientClassCreation || config.allowClientClassCreation == null) {
             throw 1;