joe/kami-parse-server
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Validation Handler Update (#6968)

Browse Source 
* Initial Commit

* Update FunctionsRouter.js

* Update FunctionsRouter.js

* Change params to fields

* Changes requested

* Fix failing tests

* More tests

* More tests

* Remove existing functionality

* Remove legacy tests

* fix array typo

* Update triggers.js

* Docs

* Allow requireUserKeys to be object

* validateMasterKey

* Improve documentation

Co-authored-by: Diamond Lewis <findlewis@gmail.com>
This commit is contained in:
dblythy
2020-10-26 04:36:54 +11:00
committed by GitHub
parent e89cf25bc2
commit c2f2281e6d
8 changed files with 1752 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

213
src/cloud-code/Parse.Cloud.js
View File

@@ -32,11 +32,24 @@ var ParseCloud = {};
* Defines a Cloud Function.
*
* **Available in Cloud Code only.**
*
* ```
* Parse.Cloud.define('functionName', (request) => {
* // code here
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.define('functionName', (request) => {
* // code here
* }, { ...validationObject });
* ```
*
* @static
* @memberof Parse.Cloud
* @param {String} name The name of the Cloud Function
* @param {Function} data The Cloud Function to register. This function can be an async function and should take one parameter a {@link Parse.Cloud.FunctionRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.FunctionRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.define = function (functionName, handler, validationHandler) {
triggers.addFunction(
@@ -73,25 +86,29 @@ ParseCloud.job = function (functionName, handler) {
* ```
* Parse.Cloud.beforeSave('MyCustomClass', (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeSave(Parse.User, (request) => {
* // code here
* })
* }, { ...validationObject })
* ```
*
* @method beforeSave
* @name Parse.Cloud.beforeSave
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after save function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run before a save. This function can be async and should take one parameter a {@link Parse.Cloud.TriggerRequest};
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.TriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeSave = function (parseClass, handler) {
ParseCloud.beforeSave = function (parseClass, handler, validationHandler) {
var className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.beforeSave,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -104,25 +121,29 @@ ParseCloud.beforeSave = function (parseClass, handler) {
* ```
* Parse.Cloud.beforeDelete('MyCustomClass', (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeDelete(Parse.User, (request) => {
* // code here
* })
* }, { ...validationObject })
*```
*
* @method beforeDelete
* @name Parse.Cloud.beforeDelete
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the before delete function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run before a delete. This function can be async and should take one parameter, a {@link Parse.Cloud.TriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.TriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeDelete = function (parseClass, handler) {
ParseCloud.beforeDelete = function (parseClass, handler, validationHandler) {
var className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.beforeDelete,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -177,8 +198,7 @@ ParseCloud.beforeLogin = function (handler) {
* ```
* Parse.Cloud.afterLogin((request) => {
* // code here
* })
*
* });
* ```
*
* @method afterLogin
@@ -212,8 +232,7 @@ ParseCloud.afterLogin = function (handler) {
* ```
* Parse.Cloud.afterLogout((request) => {
* // code here
* })
*
* });
* ```
*
* @method afterLogout
@@ -246,25 +265,29 @@ ParseCloud.afterLogout = function (handler) {
* ```
* Parse.Cloud.afterSave('MyCustomClass', async function(request) {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.afterSave(Parse.User, async function(request) {
* // code here
* })
* }, { ...validationObject });
* ```
*
* @method afterSave
* @name Parse.Cloud.afterSave
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after save function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run after a save. This function can be an async function and should take just one parameter, {@link Parse.Cloud.TriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.TriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.afterSave = function (parseClass, handler) {
ParseCloud.afterSave = function (parseClass, handler, validationHandler) {
var className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.afterSave,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -277,25 +300,29 @@ ParseCloud.afterSave = function (parseClass, handler) {
* ```
* Parse.Cloud.afterDelete('MyCustomClass', async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.afterDelete(Parse.User, async (request) => {
* // code here
* })
* }, { ...validationObject });
*```
*
* @method afterDelete
* @name Parse.Cloud.afterDelete
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after delete function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run after a delete. This function can be async and should take just one parameter, {@link Parse.Cloud.TriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.TriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.afterDelete = function (parseClass, handler) {
ParseCloud.afterDelete = function (parseClass, handler, validationHandler) {
var className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.afterDelete,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -308,25 +335,29 @@ ParseCloud.afterDelete = function (parseClass, handler) {
* ```
* Parse.Cloud.beforeFind('MyCustomClass', async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeFind(Parse.User, async (request) => {
* // code here
* })
* }, { ...validationObject });
*```
*
* @method beforeFind
* @name Parse.Cloud.beforeFind
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the before find function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run before a find. This function can be async and should take just one parameter, {@link Parse.Cloud.BeforeFindRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.BeforeFindRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeFind = function (parseClass, handler) {
ParseCloud.beforeFind = function (parseClass, handler, validationHandler) {
var className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.beforeFind,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -339,25 +370,29 @@ ParseCloud.beforeFind = function (parseClass, handler) {
* ```
* Parse.Cloud.afterFind('MyCustomClass', async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.afterFind(Parse.User, async (request) => {
* // code here
* })
* }, { ...validationObject });
*```
*
* @method afterFind
* @name Parse.Cloud.afterFind
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after find function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run before a find. This function can be async and should take just one parameter, {@link Parse.Cloud.AfterFindRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.AfterFindRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.afterFind = function (parseClass, handler) {
ParseCloud.afterFind = function (parseClass, handler, validationHandler) {
const className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.afterFind,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -369,18 +404,26 @@ ParseCloud.afterFind = function (parseClass, handler) {
* ```
* Parse.Cloud.beforeSaveFile(async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeSaveFile(async (request) => {
* // code here
* }, { ...validationObject });
*```
*
* @method beforeSaveFile
* @name Parse.Cloud.beforeSaveFile
* @param {Function} func The function to run before saving a file. This function can be async and should take just one parameter, {@link Parse.Cloud.FileTriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.FileTriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeSaveFile = function (handler) {
ParseCloud.beforeSaveFile = function (handler, validationHandler) {
triggers.addFileTrigger(
triggers.Types.beforeSaveFile,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -392,18 +435,26 @@ ParseCloud.beforeSaveFile = function (handler) {
* ```
* Parse.Cloud.afterSaveFile(async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.afterSaveFile(async (request) => {
* // code here
* }, { ...validationObject });
*```
*
* @method afterSaveFile
* @name Parse.Cloud.afterSaveFile
* @param {Function} func The function to run after saving a file. This function can be async and should take just one parameter, {@link Parse.Cloud.FileTriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.FileTriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.afterSaveFile = function (handler) {
ParseCloud.afterSaveFile = function (handler, validationHandler) {
triggers.addFileTrigger(
triggers.Types.afterSaveFile,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -415,18 +466,26 @@ ParseCloud.afterSaveFile = function (handler) {
* ```
* Parse.Cloud.beforeDeleteFile(async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeDeleteFile(async (request) => {
* // code here
* }, { ...validationObject });
*```
*
* @method beforeDeleteFile
* @name Parse.Cloud.beforeDeleteFile
* @param {Function} func The function to run before deleting a file. This function can be async and should take just one parameter, {@link Parse.Cloud.FileTriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.FileTriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeDeleteFile = function (handler) {
ParseCloud.beforeDeleteFile = function (handler, validationHandler) {
triggers.addFileTrigger(
triggers.Types.beforeDeleteFile,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -438,18 +497,26 @@ ParseCloud.beforeDeleteFile = function (handler) {
* ```
* Parse.Cloud.afterDeleteFile(async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.afterDeleteFile(async (request) => {
* // code here
* }, { ...validationObject });
*```
*
* @method afterDeleteFile
* @name Parse.Cloud.afterDeleteFile
* @param {Function} func The function to after before deleting a file. This function can be async and should take just one parameter, {@link Parse.Cloud.FileTriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.FileTriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.afterDeleteFile = function (handler) {
ParseCloud.afterDeleteFile = function (handler, validationHandler) {
triggers.addFileTrigger(
triggers.Types.afterDeleteFile,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -461,18 +528,26 @@ ParseCloud.afterDeleteFile = function (handler) {
* ```
* Parse.Cloud.beforeConnect(async (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeConnect(async (request) => {
* // code here
* }, { ...validationObject });
*```
*
* @method beforeConnect
* @name Parse.Cloud.beforeConnect
* @param {Function} func The function to before connection is made. This function can be async and should take just one parameter, {@link Parse.Cloud.ConnectTriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.ConnectTriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeConnect = function (handler) {
ParseCloud.beforeConnect = function (handler, validationHandler) {
triggers.addConnectTrigger(
triggers.Types.beforeConnect,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -485,25 +560,29 @@ ParseCloud.beforeConnect = function (handler) {
* ```
* Parse.Cloud.beforeSubscribe('MyCustomClass', (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.beforeSubscribe(Parse.User, (request) => {
* // code here
* })
* }, { ...validationObject });
*```
*
* @method beforeSubscribe
* @name Parse.Cloud.beforeSubscribe
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the before subscription function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run before a subscription. This function can be async and should take one parameter, a {@link Parse.Cloud.TriggerRequest}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.TriggerRequest}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.beforeSubscribe = function (parseClass, handler) {
ParseCloud.beforeSubscribe = function (parseClass, handler, validationHandler) {
var className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.beforeSubscribe,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -519,21 +598,33 @@ ParseCloud.onLiveQueryEvent = function (handler) {
* ```
* Parse.Cloud.afterLiveQueryEvent('MyCustomClass', (request) => {
* // code here
* })
* }, (request) => {
* // validation code here
* });
*
* Parse.Cloud.afterLiveQueryEvent('MyCustomClass', (request) => {
* // code here
* }, { ...validationObject });
*```
*
* @method afterLiveQueryEvent
* @name Parse.Cloud.afterLiveQueryEvent
* @param {(String|Parse.Object)} arg1 The Parse.Object subclass to register the after live query event function for. This can instead be a String that is the className of the subclass.
* @param {Function} func The function to run after a live query event. This function can be async and should take one parameter, a {@link Parse.Cloud.LiveQueryEventTrigger}.
* @param {(Object|Function)} validator An optional function to help validating cloud code. This function can be an async function and should take one parameter a {@link Parse.Cloud.LiveQueryEventTrigger}, or a {@link Parse.Cloud.ValidatorObject}.
*/
ParseCloud.afterLiveQueryEvent = function (parseClass, handler) {
ParseCloud.afterLiveQueryEvent = function (
parseClass,
handler,
validationHandler
) {
const className = getClassName(parseClass);
triggers.addTrigger(
triggers.Types.afterEvent,
className,
handler,
Parse.applicationId
Parse.applicationId,
validationHandler
);
};
@@ -642,3 +733,23 @@ module.exports = ParseCloud;
* @property {Object} params The params passed to the background job.
* @property {function} message If message is called with a string argument, will update the current message to be stored in the job status.
*/
/**
* @interface Parse.Cloud.ValidatorObject
* @property {Boolean} requireUser whether the cloud trigger requires a user.
* @property {Boolean} requireMaster whether the cloud trigger requires a master key.
* @property {Boolean} validateMasterKey whether the validator should run if masterKey is provided. Defaults to false.
*
* @property {Array<String>|Object} requireUserKeys If set, keys required on request.user to make the request.
* @property {String} requireUserKeys.field If requireUserKeys is an object, name of field to validate on request user
* @property {Array|function|Any} requireUserKeys.field.options array of options that the field can be, function to validate field, or single value. Throw an error if value is invalid.
* @property {String} requireUserKeys.field.error custom error message if field is invalid.
*
* @property {Object|Array<String>} fields if an array of strings, validator will look for keys in request.params, and throw if not provided. If Object, fields to validate. If the trigger is a cloud function, `request.params` will be validated, otherwise `request.object`.
* @property {String} fields.field name of field to validate.
* @property {String} fields.field.type expected type of data for field.
* @property {Boolean} fields.field.constant whether the field can be modified on the object.
* @property {Any} fields.field.default default value if field is `null`, or initial value `constant` is `true`.
* @property {Array|function|Any} fields.field.options array of options that the field can be, function to validate field, or single value. Throw an error if value is invalid.
* @property {String} fields.field.error custom error message if field is invalid.
*/