refactor: Optimize code for request options sent to RESTController (#2430)

Author: dplewis

.github/workflows/ci.yml

@@ -96,7 +96,9 @@ jobs:
         node-version: ${{ matrix.NODE_VERSION }}
         cache: npm
     - run: npm ci
-    - run: npm test -- --maxWorkers=4
+    # Run unit tests
+    - run: npm test -- --maxWorkers=4 
+    # Run integration tests
     - run: npm run test:mongodb
       env:
         CI: true

eslint.config.js

@@ -24,7 +24,6 @@ module.exports = tseslint.config({
     "no-useless-escape": "off",
     "no-var": "error",
     "no-console": 0,
-    "no-prototype-builtins": "off",
     "require-atomic-updates": "off",
     "prefer-spread": "off",
     "prefer-rest-params": "off",

integration/test/ParseUserTest.js

@@ -598,8 +598,8 @@ describe('Parse User', () => {
       })
       .then(() => {
         assert.equal(Object.keys(user.attributes).length, 5);
-        assert(user.attributes.hasOwnProperty('username'));
-        assert(user.attributes.hasOwnProperty('email'));
+        assert(Object.hasOwn(user.attributes, 'username'));
+        assert(Object.hasOwn(user.attributes, 'email'));
         return user.destroy();
       })
       .then(() => {

src/Cloud.ts

@@ -26,30 +26,22 @@ import type { RequestOptions } from './RESTController';
  * @param {string} name The function name.
  * @param {object} data The parameters to send to the cloud function.
  * @param {object} options
+ * Valid options are:<ul>
+ *   <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
+ *     be used for this request.
+ *   <li>sessionToken: A valid session token, used for making a request on
+ *        behalf of a specific user.
+ *   <li>installationId: the installationId which made the request
+ *   <li>context: A dictionary that is accessible in Cloud Code triggers.
+ * </ul>
  * @returns {Promise} A promise that will be resolved with the result
  * of the function.
  */
 export function run(name: string, data: any, options: RequestOptions): Promise<any> {
-  options = options || {};
-
   if (typeof name !== 'string' || name.length === 0) {
     throw new TypeError('Cloud function name must be a string.');
   }
-
-  const requestOptions: RequestOptions = {};
-  if (options.hasOwnProperty('useMasterKey')) {
-    requestOptions.useMasterKey = !!options.useMasterKey;
-  }
-  if (options.sessionToken) {
-    requestOptions.sessionToken = options.sessionToken;
-  }
-  if (options.installationId) {
-    requestOptions.installationId = options.installationId;
-  }
-  if (options.context && typeof options.context === 'object') {
-    requestOptions.context = options.context;
-  }
-
+  const requestOptions = ParseObject._getRequestOptions(options);
   return CoreManager.getCloudController().run(name, data, requestOptions);
 }
 
@@ -62,10 +54,7 @@ export function run(name: string, data: any, options: RequestOptions): Promise<a
  * of the function.
  */
 export function getJobsData(): Promise<any> {
-  const requestOptions = {
-    useMasterKey: true,
-  };
-  return CoreManager.getCloudController().getJobsData(requestOptions);
+  return CoreManager.getCloudController().getJobsData({ useMasterKey: true });
 }
 
 /**
@@ -82,10 +71,7 @@ export function startJob(name: string, data: any): Promise<string> {
   if (typeof name !== 'string' || name.length === 0) {
     throw new TypeError('Cloud job name must be a string.');
   }
-  const requestOptions = {
-    useMasterKey: true,
-  };
-  return CoreManager.getCloudController().startJob(name, data, requestOptions);
+  return CoreManager.getCloudController().startJob(name, data, { useMasterKey: true });
 }
 
 /**
@@ -104,17 +90,15 @@ export function getJobStatus(jobStatusId: string): Promise<ParseObject> {
 const DefaultController = {
   run(name: string, data: any, options: RequestOptions) {
     const RESTController = CoreManager.getRESTController();
-
     const payload = encode(data, true);
 
     const request = RESTController.request('POST', 'functions/' + name, payload, options);
-
     return request.then(res => {
-      if (typeof res === 'object' && Object.keys(res).length > 0 && !res.hasOwnProperty('result')) {
+      if (typeof res === 'object' && Object.keys(res).length > 0 && !Object.hasOwn(res, 'result')) {
         throw new ParseError(ParseError.INVALID_JSON, 'The server returned an invalid response.');
       }
       const decoded = decode(res);
-      if (decoded && decoded.hasOwnProperty('result')) {
+      if (decoded && Object.hasOwn(decoded, 'result')) {
         return Promise.resolve(decoded.result);
       }
       return Promise.resolve(undefined);
@@ -123,7 +107,6 @@ const DefaultController = {
 
   getJobsData(options: RequestOptions) {
     const RESTController = CoreManager.getRESTController();
-
     return RESTController.request('GET', 'cloud_code/jobs/data', null, options);
   },
 

src/CoreManager.ts

@@ -340,7 +340,7 @@ function requireMethods(name: string, methods: Array<string>, controller: any) {
 
 const CoreManager = {
   get: function (key: string): any {
-    if (config.hasOwnProperty(key)) {
+    if (Object.hasOwn(config, key)) {
       return config[key];
     }
     throw new Error('Configuration key not found: ' + key);
@@ -351,7 +351,7 @@ const CoreManager = {
   },
 
   setIfNeeded: function (key: string, value: any): any {
-    if (!config.hasOwnProperty(key)) {
+    if (!Object.hasOwn(config, key)) {
       config[key] = value;
     }
     return config[key];

src/ParseFile.ts

@@ -320,7 +320,7 @@ class ParseFile {
       throw new ParseError(ParseError.FILE_DELETE_UNNAMED_ERROR, 'Cannot delete an unnamed file.');
     }
     const destroyOptions = { useMasterKey: true };
-    if (options.hasOwnProperty('useMasterKey')) {
+    if (Object.hasOwn(options, 'useMasterKey')) {
       destroyOptions.useMasterKey = !!options.useMasterKey;
     }
     const controller = CoreManager.getFileController();