Added rest option: excludeKeys (#5737)

* Added restOption: excludeKeys

* improve tests
This commit is contained in:
Raschid J.F. Rafeally
2019-07-10 15:01:21 -05:00
committed by Diamond Lewis
parent 378e70afdc
commit 9816285205
3 changed files with 149 additions and 0 deletions

View File

@@ -13,6 +13,7 @@ const AlwaysSelectedKeys = ['objectId', 'createdAt', 'updatedAt', 'ACL'];
// count
// include
// keys
// excludeKeys
// redirectClassNameForKey
// readPreference
// includeReadPreference
@@ -102,6 +103,13 @@ function RestQuery(
this.keys = Array.from(new Set(keys));
break;
}
case 'excludeKeys': {
const exclude = restOptions.excludeKeys
.split(',')
.filter(k => AlwaysSelectedKeys.indexOf(k) < 0);
this.excludeKeys = Array.from(new Set(exclude));
break;
}
case 'count':
this.doCount = true;
break;
@@ -184,6 +192,9 @@ RestQuery.prototype.execute = function(executeOptions) {
.then(() => {
return this.handleIncludeAll();
})
.then(() => {
return this.handleExcludeKeys();
})
.then(() => {
return this.runFind(executeOptions);
})
@@ -705,6 +716,24 @@ RestQuery.prototype.handleIncludeAll = function() {
});
};
// Updates property `this.keys` to contain all keys but the ones unselected.
RestQuery.prototype.handleExcludeKeys = function() {
if (!this.excludeKeys) {
return;
}
if (this.keys) {
this.keys = this.keys.filter(k => !this.excludeKeys.includes(k));
return;
}
return this.config.database
.loadSchema()
.then(schemaController => schemaController.getOneSchema(this.className))
.then(schema => {
const fields = Object.keys(schema.fields);
this.keys = fields.filter(k => !this.excludeKeys.includes(k));
});
};
// Augments this.response with data at the paths provided in this.include.
RestQuery.prototype.handleInclude = function() {
if (this.include.length == 0) {

View File

@@ -165,6 +165,7 @@ export class ClassesRouter extends PromiseRouter {
'order',
'count',
'keys',
'excludeKeys',
'include',
'includeAll',
'redirectClassNameForKey',
@@ -200,6 +201,9 @@ export class ClassesRouter extends PromiseRouter {
if (typeof body.keys == 'string') {
options.keys = body.keys;
}
if (typeof body.excludeKeys == 'string') {
options.excludeKeys = body.excludeKeys;
}
if (body.include) {
options.include = String(body.include);
}