Merge branch 'master' into liveQueryACLFix

Author: dblythy

.github/workflows/ci.yml

@@ -91,7 +91,7 @@ jobs:
             MONGODB_VERSION: 4.4.4
             MONGODB_TOPOLOGY: standalone
             MONGODB_STORAGE_ENGINE: wiredTiger
-            NODE_VERSION: 12.21.0
+            NODE_VERSION: 12.22.0
           - name: Node 15
             MONGODB_VERSION: 4.4.4
             MONGODB_TOPOLOGY: standalone

CHANGELOG.md

@@ -119,6 +119,7 @@ ___
 - LDAP: Properly unbind client on group search error (Diamond Lewis) [#7265](https://github.com/parse-community/parse-server/pull/7265)
 - Improve data consistency in Push and Job Status update (Diamond Lewis) [#7267](https://github.com/parse-community/parse-server/pull/7267)
 - Excluding keys that have trailing edges.node when performing GraphQL resolver (Chris Bland) [#7273](https://github.com/parse-community/parse-server/pull/7273)
+- Added centralized feature deprecation with standardized warning logs (Manuel Trezza) [#7303](https://github.com/parse-community/parse-server/pull/7303)
 ___
 ## 4.5.0
 [Full Changelog](https://github.com/parse-community/parse-server/compare/4.4.0...4.5.0)

README.md

@@ -113,9 +113,9 @@ Parse Server is continuously tested with the most recent releases of Node.js to
 | Version    | Latest Patch Version | End-of-Life Date | Compatibility      |
 |------------|----------------------|------------------|--------------------|
 | Node.js 10 | 10.24.0              | April 2021       | ✅ Fully compatible |
-| Node.js 12 | 12.21.0              | April 2022       | ✅ Fully compatible |
+| Node.js 12 | 12.22.0              | April 2022       | ✅ Fully compatible |
 | Node.js 14 | 14.16.0              | April 2023       | ✅ Fully compatible |
-| Node.js 15 | 15.12.0               | June 2021        | ✅ Fully compatible |
+| Node.js 15 | 15.12.0              | June 2021        | ✅ Fully compatible |
 
 #### MongoDB
 Parse Server is continuously tested with the most recent releases of MongoDB to ensure compatibility. We follow the [MongoDB support schedule](https://www.mongodb.com/support-policy) and only test against versions that are officially supported and have not reached their end-of-life date.
@@ -300,7 +300,7 @@ For the full list of available options, run `parse-server --help` or take a look
 * `port` - The default port is 1337, specify this parameter to use a different port.
 * `serverURL` - URL to your Parse Server (don't forget to specify http:// or https://). This URL will be used when making requests to Parse Server from Cloud Code.
 * `cloud` - The absolute path to your cloud code `main.js` file.
-* `push` - Configuration options for APNS and GCM push. See the [Push Notifications quick start](http://docs.parseplatform.org/parse-server/guide/#push-notifications_push-notifications-quick-start).
+* `push` - Configuration options for APNS and GCM push. See the [Push Notifications quick start](https://docs.parseplatform.org/parse-server/guide/#push-notifications-quick-start).
 
 ## Client Key Options
 

package-lock.json

@@ -60,7 +60,7 @@
     "uuid": "8.3.2",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0",
-    "ws": "7.4.3"
+    "ws": "7.4.4"
   },
   "devDependencies": {
     "@actions/core": "1.2.6",

package.json

@@ -0,0 +1,36 @@
+'use strict';
+
+const Deprecator = require('../lib/Deprecator/Deprecator');
+
+describe('Deprecator', () => {
+  let deprecations = [];
+
+  beforeEach(async () => {
+    deprecations = [{ optionKey: 'exampleKey', changeNewDefault: 'exampleNewDefault' }];
+  });
+
+  it('deprecations are an array', async () => {
+    expect(Deprecator._getDeprecations()).toBeInstanceOf(Array);
+  });
+
+  it('logs deprecation for new default', async () => {
+    deprecations = [{ optionKey: 'exampleKey', changeNewDefault: 'exampleNewDefault' }];
+
+    spyOn(Deprecator, '_getDeprecations').and.callFake(() => deprecations);
+    const logger = require('../lib/logger').logger;
+    const logSpy = spyOn(logger, 'warn').and.callFake(() => {});
+
+    await reconfigureServer();
+    expect(logSpy.calls.all()[0].args[0]).toContain(deprecations[0].optionKey);
+    expect(logSpy.calls.all()[0].args[0]).toContain(deprecations[0].changeNewDefault);
+  });
+
+  it('does not log deprecation for new default if option is set manually', async () => {
+    deprecations = [{ optionKey: 'exampleKey', changeNewDefault: 'exampleNewDefault' }];
+
+    spyOn(Deprecator, '_getDeprecations').and.callFake(() => deprecations);
+    const logSpy = spyOn(Deprecator, '_log').and.callFake(() => {});
+    await reconfigureServer({ [deprecations[0].optionKey]: 'manuallySet' });
+    expect(logSpy).not.toHaveBeenCalled();
+  });
+});

spec/Deprecator.spec.js

@@ -7083,6 +7083,77 @@ describe('ParseGraphQLServer', () => {
           expect(result.data.resetPassword.clientMutationId).toEqual(clientMutationId);
           expect(result.data.resetPassword.ok).toBeTruthy();
         });
+
+        it('should reset password', async () => {
+          const clientMutationId = uuidv4();
+          let resetPasswordToken;
+          const emailAdapter = {
+            sendVerificationEmail: () => {},
+            sendPasswordResetEmail: ({ link }) => {
+              resetPasswordToken = link.split('token=')[1].split('&')[0];
+            },
+            sendMail: () => {},
+          };
+          parseServer = await global.reconfigureServer({
+            appName: 'test',
+            emailAdapter: emailAdapter,
+            publicServerURL: 'http://localhost:13377/parse',
+            auth: {
+              myAuth: {
+                module: global.mockCustomAuthenticator('parse', 'graphql'),
+              },
+            },
+          });
+          const user = new Parse.User();
+          user.setUsername('user1');
+          user.setPassword('user1');
+          user.setEmail('user1@user1.user1');
+          await user.signUp();
+          await Parse.User.logOut();
+          await Parse.User.requestPasswordReset('user1@user1.user1');
+          await apolloClient.mutate({
+            mutation: gql`
+              mutation ConfirmResetPassword($input: ConfirmResetPasswordInput!) {
+                confirmResetPassword(input: $input) {
+                  clientMutationId
+                  ok
+                }
+              }
+            `,
+            variables: {
+              input: {
+                clientMutationId,
+                username: 'user1',
+                password: 'newPassword',
+                token: resetPasswordToken,
+              },
+            },
+          });
+          const result = await apolloClient.mutate({
+            mutation: gql`
+              mutation LogInUser($input: LogInInput!) {
+                logIn(input: $input) {
+                  clientMutationId
+                  viewer {
+                    sessionToken
+                  }
+                }
+              }
+            `,
+            variables: {
+              input: {
+                clientMutationId,
+                username: 'user1',
+                password: 'newPassword',
+              },
+            },
+          });
+
+          expect(result.data.logIn.clientMutationId).toEqual(clientMutationId);
+          expect(result.data.logIn.viewer.sessionToken).toBeDefined();
+          expect(typeof result.data.logIn.viewer.sessionToken).toBe('string');
+        });
+
         it('should send verification email again', async () => {
           const clientMutationId = uuidv4();
           const emailAdapter = {

spec/ParseGraphQLServer.spec.js

@@ -0,0 +1,14 @@
+/**
+ * The deprecations.
+ *
+ * Add deprecations to the array using the following keys:
+ * - `optionKey`: The option key incl. its path, e.g. `security.enableCheck`.
+ * - `envKey`: The environment key, e.g. `PARSE_SERVER_SECURITY`.
+ * - `changeNewKey`: Set the new key name if the current key will be replaced,
+ * or set to an empty string if the current key will be removed without replacement.
+ * - `changeNewDefault`: Set the new default value if the key's default value
+ * will change in a future version.
+ *
+ * If there are no deprecations this must return an empty array anyway.
+ */
+module.exports = [];

src/Deprecator/Deprecations.js

@@ -0,0 +1,71 @@
+import logger from '../logger';
+import Deprecations from './Deprecations';
+
+/**
+ * The deprecator class.
+ */
+class Deprecator {
+  /**
+   * Scans the Parse Server for deprecated options.
+   * This needs to be called before setting option defaults, otherwise it
+   * becomes indistinguishable whether an option has been set manually or
+   * by default.
+   * @param {any} options The Parse Server options.
+   */
+  static scanParseServerOptions(options) {
+    // Scan for deprecations
+    for (const deprecation of Deprecator._getDeprecations()) {
+      // Get deprecation properties
+      const optionKey = deprecation.optionKey;
+      const changeNewDefault = deprecation.changeNewDefault;
+
+      // If default will change, only throw a warning if option is not set
+      if (changeNewDefault != null && options[optionKey] == null) {
+        Deprecator._log({ optionKey, changeNewDefault });
+      }
+    }
+  }
+
+  /**
+   * Returns the deprecation definitions.
+   * @returns {Array<Object>} The deprecations.
+   */
+  static _getDeprecations() {
+    return Deprecations;
+  }
+
+  /**
+   * Logs a deprecation warning for a Parse Server option.
+   * @param {String} optionKey The option key incl. its path, e.g. `security.enableCheck`.
+   * @param {String} envKey The environment key, e.g. `PARSE_SERVER_SECURITY`.
+   * @param {String} changeNewKey Set the new key name if the current key will be replaced,
+   * or set to an empty string if the current key will be removed without replacement.
+   * @param {String} changeNewDefault Set the new default value if the key's default value
+   * will change in a future version.
+   * @param {String} [solution] The instruction to resolve this deprecation warning. This
+   * message must not include the warning that the parameter is deprecated, that is
+   * automatically added to the message. It should only contain the instruction on how
+   * to resolve this warning.
+   */
+  static _log({ optionKey, envKey, changeNewKey, changeNewDefault, solution }) {
+    const type = optionKey ? 'option' : 'environment key';
+    const key = optionKey ? optionKey : envKey;
+    const keyAction =
+      changeNewKey == null
+        ? undefined
+        : changeNewKey.length > 0
+          ? `renamed to '${changeNewKey}'`
+          : `removed`;
+
+    // Compose message
+    let output = `DeprecationWarning: The Parse Server ${type} '${key}' `;
+    output += changeNewKey ? `is deprecated and will be ${keyAction} in a future version.` : '';
+    output += changeNewDefault
+      ? `default will change to '${changeNewDefault}' in a future version.`
+      : '';
+    output += solution ? ` ${solution}` : '';
+    logger.warn(output);
+  }
+}
+
+module.exports = Deprecator;

src/Deprecator/Deprecator.js

@@ -5,6 +5,7 @@ import * as objectsMutations from '../helpers/objectsMutations';
 import { OBJECT } from './defaultGraphQLTypes';
 import { getUserFromSessionToken } from './usersQueries';
 import { transformTypes } from '../transformers/mutation';
+import Parse from 'parse/node';
 
 const usersRouter = new UsersRouter();
 
@@ -250,6 +251,61 @@ const load = parseGraphQLSchema => {
   parseGraphQLSchema.addGraphQLType(resetPasswordMutation.type, true, true);
   parseGraphQLSchema.addGraphQLMutation('resetPassword', resetPasswordMutation, true, true);
 
+  const confirmResetPasswordMutation = mutationWithClientMutationId({
+    name: 'ConfirmResetPassword',
+    description:
+      'The confirmResetPassword mutation can be used to reset the password of an existing user.',
+    inputFields: {
+      username: {
+        descriptions: 'Username of the user that have received the reset email',
+        type: new GraphQLNonNull(GraphQLString),
+      },
+      password: {
+        descriptions: 'New password of the user',
+        type: new GraphQLNonNull(GraphQLString),
+      },
+      token: {
+        descriptions: 'Reset token that was emailed to the user',
+        type: new GraphQLNonNull(GraphQLString),
+      },
+    },
+    outputFields: {
+      ok: {
+        description: "It's always true.",
+        type: new GraphQLNonNull(GraphQLBoolean),
+      },
+    },
+    mutateAndGetPayload: async ({ username, password, token }, context) => {
+      const { config } = context;
+      if (!username) {
+        throw new Parse.Error(Parse.Error.USERNAME_MISSING, 'you must provide a username');
+      }
+      if (!password) {
+        throw new Parse.Error(Parse.Error.PASSWORD_MISSING, 'you must provide a password');
+      }
+      if (!token) {
+        throw new Parse.Error(Parse.Error.OTHER_CAUSE, 'you must provide a token');
+      }
+
+      const userController = config.userController;
+      await userController.updatePassword(username, token, password);
+      return { ok: true };
+    },
+  });
+
+  parseGraphQLSchema.addGraphQLType(
+    confirmResetPasswordMutation.args.input.type.ofType,
+    true,
+    true
+  );
+  parseGraphQLSchema.addGraphQLType(confirmResetPasswordMutation.type, true, true);
+  parseGraphQLSchema.addGraphQLMutation(
+    'confirmResetPassword',
+    confirmResetPasswordMutation,
+    true,
+    true
+  );
+
   const sendVerificationEmailMutation = mutationWithClientMutationId({
     name: 'SendVerificationEmail',
     description:

src/GraphQL/loaders/usersMutations.js

@@ -43,6 +43,7 @@ import * as controllers from './Controllers';
 import { ParseGraphQLServer } from './GraphQL/ParseGraphQLServer';
 import { SecurityRouter } from './Routers/SecurityRouter';
 import CheckRunner from './Security/CheckRunner';
+import Deprecator from './Deprecator/Deprecator';
 
 // Mutate the Parse object to add the Cloud Code handlers
 addParseCloud();
@@ -55,6 +56,9 @@ class ParseServer {
    * @param {ParseServerOptions} options the parse server initialization options
    */
   constructor(options: ParseServerOptions) {
+    // Scan for deprecated Parse Server options
+    Deprecator.scanParseServerOptions(options);
+    // Set option defaults
     injectDefaults(options);
     const {
       appId = requiredParameter('You must provide an appId!'),

src/ParseServer.js

@@ -1,6 +1,8 @@
 /* eslint-disable no-console */
 import { Command } from 'commander';
 import path from 'path';
+import Deprecator from '../../Deprecator/Deprecator';
+
 let _definitions;
 let _reverseDefinitions;
 let _defaults;
@@ -40,7 +42,7 @@ Command.prototype.loadDefinitions = function (definitions) {
   }, {});
 
   _defaults = Object.keys(definitions).reduce((defs, opt) => {
-    if (_definitions[opt].default) {
+    if (_definitions[opt].default !== undefined) {
       defs[opt] = _definitions[opt].default;
     }
     return defs;
@@ -119,6 +121,8 @@ Command.prototype.parse = function (args, env) {
   this.setValuesIfNeeded(envOptions);
   // Load from file to override
   this.setValuesIfNeeded(fromFile);
+  // Scan for deprecated Parse Server options
+  Deprecator.scanParseServerOptions(this);
   // Last set the defaults
   this.setValuesIfNeeded(_defaults);
 };