Skip to content

Issue142 refactor read many merge master+m #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coeit merged 18 commits into from
Oct 7, 2020
Merged

Issue142 refactor read many merge master+m #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d4adeb7
i142 add Helpers
Aug 13, 2020
ffe357d
i142 empty edges object if no records
Aug 14, 2020
db0ad0b
i142 add LIMIT must not be negative check for pagination first|last: -1
Aug 14, 2020
95a3a30
i145 cbp arg validation check (undef not valid) + JSDOC update
Aug 25, 2020
3933320
refactor: rename checkCountAndReduceRecordLimitHelper -> checkCountAn…
Aug 28, 2020
8e5cd8f
add helpers for generic readAllCursor
Sep 2, 2020
f630ec5
add isForwardPagination to orderConditionsToSequelize Helper to deter…
Sep 2, 2020
0c7590d
remove vscode shit it did.
Sep 2, 2020
2fed0ae
add default ordering to order argument for genericCursor options
Sep 2, 2020
502eff9
add default empty array for order in generic options
Sep 2, 2020
1c3a3bf
FIX: add default empty array for order in generic options
Sep 2, 2020
e902a18
Merge branch 'issue142-refactor-readMany' into issue142-refactor-read…
Sep 3, 2020
d5111b9
update static role, user, role_to_user model
Sep 3, 2020
748bf08
add missing user/role/role_to_user resolver/schema static files
Sep 4, 2020
3f29ed6
Merge remote-tracking branch 'origin/issue142-refactor-readMany-merge…
framirez07 Oct 2, 2020
d4618a4
fix cursorPaginationArgumentsToSequelize
framirez07 Oct 5, 2020
37657d6
fix: undefined checks
Oct 5, 2020
22a57ec
fixed pagination validation to consider notNull - includeCursor to fa…
framirez07 Oct 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
449 changes: 51 additions & 398 deletions models/sql/role.js
View file
Open in desktop

Large diffs are not rendered by default.

244 changes: 28 additions & 216 deletions models/sql/role_to_user.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,229 +75,44 @@ module.exports = class role_to_user extends Sequelize.Model {
}

static async countRecords(search) {
let options = {};
if (search !== undefined && search !== null) {

//check
if (typeof search !== 'object') {
throw new Error('Illegal "search" argument type, it must be an object.');
}

let arg = new searchArg(search);
let arg_sequelize = arg.toSequelize();
options['where'] = arg_sequelize;
}
let options = {}
options['where'] = helper.searchConditionsToSequelize(search);
return super.count(options);
}

static readAll(search, order, pagination, benignErrorReporter) {
let options = {};
if (search !== undefined && search !== null) {

//check
if (typeof search !== 'object') {
throw new Error('Illegal "search" argument type, it must be an object.');
}

let arg = new searchArg(search);
let arg_sequelize = arg.toSequelize();
options['where'] = arg_sequelize;
}

static async readAll(search, order, pagination, benignErrorReporter) {
//use default BenignErrorReporter if no BenignErrorReporter defined
benignErrorReporter = errorHelper.getDefaultBenignErrorReporterIfUndef(benignErrorReporter);

return super.count(options).then(async items => {
if (order !== undefined) {
options['order'] = order.map((orderItem) => {
return [orderItem.field, orderItem.order];
});
} else if (pagination !== undefined) {
options['order'] = [
["id", "ASC"]
];
}

if (pagination !== undefined) {
options['offset'] = pagination.offset === undefined ? 0 : pagination.offset;
options['limit'] = pagination.limit === undefined ? (items - options['offset']) : pagination.limit;
} else {
options['offset'] = 0;
options['limit'] = items;
}

if (globals.LIMIT_RECORDS < options['limit']) {
throw new Error(`Request of total role_to_users exceeds max limit of ${globals.LIMIT_RECORDS}. Please use pagination.`);
}
let records = await super.findAll(options);
return validatorUtil.bulkValidateData('validateAfterRead', this, records, benignErrorReporter);
});
// build the sequelize options object for limit-offset-based pagination
let options = helper.buildLimitOffsetSequelizeOptions(search, order, pagination, this.idAttribute());
let records = await super.findAll(options);
// validationCheck after read
return validatorUtil.bulkValidateData('validateAfterRead', this, records, benignErrorReporter);
}

static readAllCursor(search, order, pagination, benignErrorReporter) {
//check valid pagination arguments
let argsValid = (pagination === undefined) || (pagination.first && !pagination.before && !pagination.last) || (pagination.last && !pagination.after && !pagination.first);
if (!argsValid) {
throw new Error('Illegal cursor based pagination arguments. Use either "first" and optionally "after", or "last" and optionally "before"!');
}

let isForwardPagination = !pagination || !(pagination.last != undefined);
let options = {};
options['where'] = {};

/*
* Search conditions
*/
if (search !== undefined && search !== null) {

//check
if (typeof search !== 'object') {
throw new Error('Illegal "search" argument type, it must be an object.');
}

let arg = new searchArg(search);
let arg_sequelize = arg.toSequelize();
options['where'] = arg_sequelize;
}

static async readAllCursor(search, order, pagination, benignErrorReporter) {
//use default BenignErrorReporter if no BenignErrorReporter defined
benignErrorReporter = errorHelper.getDefaultBenignErrorReporterIfUndef(benignErrorReporter);

/*
* Count
*/
return super.count(options).then(countA => {
options['offset'] = 0;
options['order'] = [];
options['limit'] = countA;
/*
* Order conditions
*/
if (order !== undefined) {
options['order'] = order.map((orderItem) => {
return [orderItem.field, orderItem.order];
});
}
if (!options['order'].map(orderItem => {
return orderItem[0]
}).includes("id")) {
options['order'] = [...options['order'], ...[
["id", "ASC"]
]];
}

/*
* Pagination conditions
*/
if (pagination) {
//forward
if (isForwardPagination) {
if (pagination.after) {
let decoded_cursor = JSON.parse(this.base64Decode(pagination.after));
options['where'] = {
...options['where'],
...helper.parseOrderCursor(options['order'], decoded_cursor, "id", pagination.includeCursor)
};
}
} else { //backward
if (pagination.before) {
let decoded_cursor = JSON.parse(this.base64Decode(pagination.before));
options['where'] = {
...options['where'],
...helper.parseOrderCursorBefore(options['order'], decoded_cursor, "id", pagination.includeCursor)
};
}
}
}
//woptions: copy of {options} with only 'where' options
let woptions = {};
woptions['where'] = {
...options['where']
};
/*
* Count (with only where-options)
*/
return super.count(woptions).then(countB => {
/*
* Limit conditions
*/
if (pagination) {
//forward
if (isForwardPagination) {

if (pagination.first) {
options['limit'] = pagination.first;
}
} else { //backward
if (pagination.last) {
options['limit'] = pagination.last;
options['offset'] = Math.max((countB - pagination.last), 0);
}
}
}
//check: limit
if (globals.LIMIT_RECORDS < options['limit']) {
throw new Error(`Request of total role_to_users exceeds max limit of ${globals.LIMIT_RECORDS}. Please use pagination.`);
}

/*
* Get records
*/
return super.findAll(options).then(async records => {
//validate records
records = await validatorUtil.bulkValidateData('validateAfterRead', this, records, benignErrorReporter);

let edges = [];
let pageInfo = {
hasPreviousPage: false,
hasNextPage: false,
startCursor: null,
endCursor: null
};

//edges
if (records.length > 0) {
edges = records.map(record => {
return {
node: record,
cursor: record.base64Enconde()
}
});
}

//forward
if (isForwardPagination) {

pageInfo = {
hasPreviousPage: ((countA - countB) > 0),
hasNextPage: (pagination && pagination.first ? (countB > pagination.first) : false),
startCursor: (records.length > 0) ? edges[0].cursor : null,
endCursor: (records.length > 0) ? edges[edges.length - 1].cursor : null
}
} else { //backward

pageInfo = {
hasPreviousPage: (pagination && pagination.last ? (countB > pagination.last) : false),
hasNextPage: ((countA - countB) > 0),
startCursor: (records.length > 0) ? edges[0].cursor : null,
endCursor: (records.length > 0) ? edges[edges.length - 1].cursor : null
}
}

return {
edges,
pageInfo
};

}).catch(error => {
throw error;
});
}).catch(error => {
throw error;
});
}).catch(error => {
throw error;
});
// build the sequelize options object for cursor-based pagination
let options = helper.buildCursorBasedSequelizeOptions(search, order, pagination, this.idAttribute());
let records = await super.findAll(options);
// validationCheck after read
records = await validatorUtil.bulkValidateData('validateAfterRead', this, records, benignErrorReporter);
// get the first record (if exists) in the opposite direction to determine pageInfo.
// if no cursor was given there is no need for an extra query as the results will start at the first (or last) page.
let oppRecords = [];
if (pagination && (pagination.after || pagination.before)) {
let oppOptions = helper.buildOppositeSearchSequelize(search, order, {...pagination, includeCursor: false}, this.idAttribute());
oppRecords = await super.findAll(oppOptions);
}
// build the graphql Connection Object
let edges = helper.buildEdgeObject(records);
let pageInfo = helper.buildPageInfo(edges, oppRecords, pagination);
return {
edges,
pageInfo
};
}

static async addOne(input) {
Expand Down Expand Up @@ -437,7 +252,6 @@ module.exports = class role_to_user extends Sequelize.Model {
*
* @return {type} Name of the attribute that functions as an internalId
*/

static idAttribute() {
return role_to_user.definition.id.name;
}
Expand All @@ -447,7 +261,6 @@ module.exports = class role_to_user extends Sequelize.Model {
*
* @return {type} Type given in the JSON model
*/

static idAttributeType() {
return role_to_user.definition.id.type;
}
Expand All @@ -457,7 +270,6 @@ module.exports = class role_to_user extends Sequelize.Model {
*
* @return {type} id value
*/

getIdValue() {
return this[role_to_user.idAttribute()]
}
Expand Down
Loading