Adds CloudCode handler for beforeFind (#2715)
* Adds CloudCode handler for beforeFind - Allows cloud code to modify a query before it is run - Works with promises for a safer environment - Supports modifiying the current query - Supports issuing new queries * Adds test for cornercase empty queries from rest * Makes sure restOptions is always definied
This commit is contained in:
@@ -45,6 +45,11 @@ ParseCloud.afterDelete = function(parseClass, handler) {
|
||||
triggers.addTrigger(triggers.Types.afterDelete, className, handler, Parse.applicationId);
|
||||
};
|
||||
|
||||
ParseCloud.beforeFind = function(parseClass, handler) {
|
||||
var className = getClassName(parseClass);
|
||||
triggers.addTrigger(triggers.Types.beforeFind, className, handler, Parse.applicationId);
|
||||
};
|
||||
|
||||
ParseCloud._removeAllHooks = () => {
|
||||
triggers._unregisterAll();
|
||||
}
|
||||
|
||||
@@ -17,8 +17,12 @@ var triggers = require('./triggers');
|
||||
// Returns a promise for an object with optional keys 'results' and 'count'.
|
||||
function find(config, auth, className, restWhere, restOptions, clientSDK) {
|
||||
enforceRoleSecurity('find', className, auth);
|
||||
let query = new RestQuery(config, auth, className, restWhere, restOptions, clientSDK);
|
||||
return query.execute();
|
||||
return triggers.maybeRunQueryTrigger(triggers.Types.beforeFind, className, restWhere, restOptions, config, auth).then((result) => {
|
||||
restWhere = result.restWhere || restWhere;
|
||||
restOptions = result.restOptions || restOptions;
|
||||
let query = new RestQuery(config, auth, className, restWhere, restOptions, clientSDK);
|
||||
return query.execute();
|
||||
});
|
||||
}
|
||||
|
||||
// get is just like find but only queries an objectId.
|
||||
|
||||
@@ -7,7 +7,8 @@ export const Types = {
|
||||
beforeSave: 'beforeSave',
|
||||
afterSave: 'afterSave',
|
||||
beforeDelete: 'beforeDelete',
|
||||
afterDelete: 'afterDelete'
|
||||
afterDelete: 'afterDelete',
|
||||
beforeFind: 'beforeFind'
|
||||
};
|
||||
|
||||
const baseStore = function() {
|
||||
@@ -154,6 +155,29 @@ export function getRequestObject(triggerType, auth, parseObject, originalParseOb
|
||||
return request;
|
||||
}
|
||||
|
||||
export function getRequestQueryObject(triggerType, auth, query, config) {
|
||||
var request = {
|
||||
triggerName: triggerType,
|
||||
query: query,
|
||||
master: false,
|
||||
log: config.loggerController
|
||||
};
|
||||
|
||||
if (!auth) {
|
||||
return request;
|
||||
}
|
||||
if (auth.isMaster) {
|
||||
request['master'] = true;
|
||||
}
|
||||
if (auth.user) {
|
||||
request['user'] = auth.user;
|
||||
}
|
||||
if (auth.installationId) {
|
||||
request['installationId'] = auth.installationId;
|
||||
}
|
||||
return request;
|
||||
}
|
||||
|
||||
// Creates the response object, and uses the request object to pass data
|
||||
// The API will call this with REST API formatted objects, this will
|
||||
// transform them to Parse.Object instances expected by Cloud Code.
|
||||
@@ -216,6 +240,66 @@ function logTriggerErrorBeforeHook(triggerType, className, input, auth, error) {
|
||||
});
|
||||
}
|
||||
|
||||
export function maybeRunQueryTrigger(triggerType, className, restWhere, restOptions, config, auth) {
|
||||
let trigger = getTrigger(className, triggerType, config.applicationId);
|
||||
if (!trigger) {
|
||||
return Promise.resolve({
|
||||
restWhere,
|
||||
restOptions
|
||||
});
|
||||
}
|
||||
|
||||
let parseQuery = new Parse.Query(className);
|
||||
if (restWhere) {
|
||||
parseQuery._where = restWhere;
|
||||
}
|
||||
if (restOptions) {
|
||||
if (restOptions.include && restOptions.include.length > 0) {
|
||||
parseQuery._include = restOptions.include.split(',');
|
||||
}
|
||||
if (restOptions.skip) {
|
||||
parseQuery._skip = restOptions.skip;
|
||||
}
|
||||
if (restOptions.limit) {
|
||||
parseQuery._limit = restOptions.limit;
|
||||
}
|
||||
}
|
||||
let requestObject = getRequestQueryObject(triggerType, auth, parseQuery, config);
|
||||
return Promise.resolve().then(() => {
|
||||
return trigger(requestObject);
|
||||
}).then((result) => {
|
||||
let queryResult = parseQuery;
|
||||
if (result && result instanceof Parse.Query) {
|
||||
queryResult = result;
|
||||
}
|
||||
let jsonQuery = queryResult.toJSON();
|
||||
if (jsonQuery.where) {
|
||||
restWhere = jsonQuery.where;
|
||||
}
|
||||
if (jsonQuery.limit) {
|
||||
restOptions = restOptions || {};
|
||||
restOptions.limit = jsonQuery.limit;
|
||||
}
|
||||
if (jsonQuery.skip) {
|
||||
restOptions = restOptions || {};
|
||||
restOptions.skip = jsonQuery.skip;
|
||||
}
|
||||
if (jsonQuery.include) {
|
||||
restOptions = restOptions || {};
|
||||
restOptions.include = jsonQuery.include;
|
||||
}
|
||||
return {
|
||||
restWhere,
|
||||
restOptions
|
||||
};
|
||||
}, (err) => {
|
||||
if (typeof err === 'string') {
|
||||
throw new Parse.Error(1, err);
|
||||
} else {
|
||||
throw err;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// To be used as part of the promise chain when saving/deleting an object
|
||||
// Will resolve successfully if no trigger is configured
|
||||
|
||||
Reference in New Issue
Block a user