Skip to content

Commit c46e8a5

Browse files
pdiazpdiaz
authored
Optimize redundant logic used in queries (#7061)
* Optimize redundant logic used in queries * Added CHANGELOG * Fixed comments and code style after recommendations. * Fixed code style after recommendation. * Improved explanation in comments * Added tests to for logic optimizations * Added two test cases more and some comments * Added extra test cases and fixed issue found with them. * Removed empty lines as requested. Co-authored-by: Pedro Diaz <p.diaz@wemersive.com>
1 parent 4405ddd commit c46e8a5

File tree

3 files changed

+176
-2
lines changed

3 files changed

+176
-2
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
### master
44
[Full Changelog](https://github.com/parse-community/parse-server/compare/4.5.0...master)
5+
- IMPROVE: Optimize queries on classes with pointer permissions. [#7061](https://github.com/parse-community/parse-server/pull/7061). Thanks to [Pedro Diaz](https://github.com/pdiaz)
56

67
### 4.5.0
78
[Full Changelog](https://github.com/parse-community/parse-server/compare/4.4.0...4.5.0)

‎spec/DatabaseController.spec.js‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,57 @@ describe('DatabaseController', function () {
236236
done();
237237
});
238238

239+
it('should not return a $or operation if the query involves one of the two fields also used as array/pointer permissions', done => {
240+
const clp = buildCLP(['users', 'user']);
241+
const query = { a: 'b', user: createUserPointer(USER_ID) };
242+
schemaController.testPermissionsForClassName
243+
.withArgs(CLASS_NAME, ACL_GROUP, OPERATION)
244+
.and.returnValue(false);
245+
schemaController.getClassLevelPermissions.withArgs(CLASS_NAME).and.returnValue(clp);
246+
schemaController.getExpectedType
247+
.withArgs(CLASS_NAME, 'user')
248+
.and.returnValue({ type: 'Pointer' });
249+
schemaController.getExpectedType
250+
.withArgs(CLASS_NAME, 'users')
251+
.and.returnValue({ type: 'Array' });
252+
const output = databaseController.addPointerPermissions(
253+
schemaController,
254+
CLASS_NAME,
255+
OPERATION,
256+
query,
257+
ACL_GROUP
258+
);
259+
expect(output).toEqual({ ...query, user: createUserPointer(USER_ID) });
260+
done();
261+
});
262+
263+
it('should not return a $or operation if the query involves one of the fields also used as array/pointer permissions', done => {
264+
const clp = buildCLP(['user', 'users', 'userObject']);
265+
const query = { a: 'b', user: createUserPointer(USER_ID) };
266+
schemaController.testPermissionsForClassName
267+
.withArgs(CLASS_NAME, ACL_GROUP, OPERATION)
268+
.and.returnValue(false);
269+
schemaController.getClassLevelPermissions.withArgs(CLASS_NAME).and.returnValue(clp);
270+
schemaController.getExpectedType
271+
.withArgs(CLASS_NAME, 'user')
272+
.and.returnValue({ type: 'Pointer' });
273+
schemaController.getExpectedType
274+
.withArgs(CLASS_NAME, 'users')
275+
.and.returnValue({ type: 'Array' });
276+
schemaController.getExpectedType
277+
.withArgs(CLASS_NAME, 'userObject')
278+
.and.returnValue({ type: 'Object' });
279+
const output = databaseController.addPointerPermissions(
280+
schemaController,
281+
CLASS_NAME,
282+
OPERATION,
283+
query,
284+
ACL_GROUP
285+
);
286+
expect(output).toEqual({ ...query, user: createUserPointer(USER_ID) });
287+
done();
288+
});
289+
239290
it('should throw an error if for some unexpected reason the property specified in the CLP is neither a pointer nor an array', done => {
240291
const clp = buildCLP(['user']);
241292
const query = { a: 'b' };
@@ -265,6 +316,51 @@ describe('DatabaseController', function () {
265316
done();
266317
});
267318
});
319+
320+
describe('reduceOperations', function () {
321+
const databaseController = new DatabaseController();
322+
323+
it('objectToEntriesStrings', done => {
324+
const output = databaseController.objectToEntriesStrings({ a: 1, b: 2, c: 3 });
325+
expect(output).toEqual(['"a":1', '"b":2', '"c":3']);
326+
done();
327+
});
328+
329+
it('reduceOrOperation', done => {
330+
expect(databaseController.reduceOrOperation({ a: 1 })).toEqual({ a: 1 });
331+
expect(databaseController.reduceOrOperation({ $or: [{ a: 1 }, { b: 2 }] })).toEqual({
332+
$or: [{ a: 1 }, { b: 2 }],
333+
});
334+
expect(databaseController.reduceOrOperation({ $or: [{ a: 1 }, { a: 2 }] })).toEqual({
335+
$or: [{ a: 1 }, { a: 2 }],
336+
});
337+
expect(databaseController.reduceOrOperation({ $or: [{ a: 1 }, { a: 1 }] })).toEqual({ a: 1 });
338+
expect(
339+
databaseController.reduceOrOperation({ $or: [{ a: 1, b: 2, c: 3 }, { a: 1 }] })
340+
).toEqual({ a: 1 });
341+
expect(
342+
databaseController.reduceOrOperation({ $or: [{ b: 2 }, { a: 1, b: 2, c: 3 }] })
343+
).toEqual({ b: 2 });
344+
done();
345+
});
346+
347+
it('reduceAndOperation', done => {
348+
expect(databaseController.reduceAndOperation({ a: 1 })).toEqual({ a: 1 });
349+
expect(databaseController.reduceAndOperation({ $and: [{ a: 1 }, { b: 2 }] })).toEqual({
350+
$and: [{ a: 1 }, { b: 2 }],
351+
});
352+
expect(databaseController.reduceAndOperation({ $and: [{ a: 1 }, { a: 2 }] })).toEqual({
353+
$and: [{ a: 1 }, { a: 2 }],
354+
});
355+
expect(databaseController.reduceAndOperation({ $and: [{ a: 1 }, { a: 1 }] })).toEqual({
356+
a: 1,
357+
});
358+
expect(
359+
databaseController.reduceAndOperation({ $and: [{ a: 1, b: 2, c: 3 }, { b: 2 }] })
360+
).toEqual({ a: 1, b: 2, c: 3 });
361+
done();
362+
});
363+
});
268364
});
269365

270366
function buildCLP(pointerNames) {

‎src/Controllers/DatabaseController.js‎

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1365,6 +1365,83 @@ class DatabaseController {
13651365
});
13661366
}
13671367

1368+
// This helps to create intermediate objects for simpler comparison of
1369+
// key value pairs used in query objects. Each key value pair will represented
1370+
// in a similar way to json
1371+
objectToEntriesStrings(query: any): Array<string> {
1372+
return Object.entries(query).map(a => a.map(s => JSON.stringify(s)).join(':'));
1373+
}
1374+
1375+
// Naive logic reducer for OR operations meant to be used only for pointer permissions.
1376+
reduceOrOperation(query: { $or: Array<any> }): any {
1377+
if (!query.$or) {
1378+
return query;
1379+
}
1380+
const queries = query.$or.map(q => this.objectToEntriesStrings(q));
1381+
let repeat = false;
1382+
do {
1383+
repeat = false;
1384+
for (let i = 0; i < queries.length - 1; i++) {
1385+
for (let j = i + 1; j < queries.length; j++) {
1386+
const [shorter, longer] = queries[i].length > queries[j].length ? [j, i] : [i, j];
1387+
const foundEntries = queries[shorter].reduce(
1388+
(acc, entry) => acc + (queries[longer].includes(entry) ? 1 : 0),
1389+
0
1390+
);
1391+
const shorterEntries = queries[shorter].length;
1392+
if (foundEntries === shorterEntries) {
1393+
// If the shorter query is completely contained in the longer one, we can strike
1394+
// out the longer query.
1395+
query.$or.splice(longer, 1);
1396+
queries.splice(longer, 1);
1397+
repeat = true;
1398+
break;
1399+
}
1400+
}
1401+
}
1402+
} while (repeat);
1403+
if (query.$or.length === 1) {
1404+
query = { ...query, ...query.$or[0] };
1405+
delete query.$or;
1406+
}
1407+
return query;
1408+
}
1409+
1410+
// Naive logic reducer for AND operations meant to be used only for pointer permissions.
1411+
reduceAndOperation(query: { $and: Array<any> }): any {
1412+
if (!query.$and) {
1413+
return query;
1414+
}
1415+
const queries = query.$and.map(q => this.objectToEntriesStrings(q));
1416+
let repeat = false;
1417+
do {
1418+
repeat = false;
1419+
for (let i = 0; i < queries.length - 1; i++) {
1420+
for (let j = i + 1; j < queries.length; j++) {
1421+
const [shorter, longer] = queries[i].length > queries[j].length ? [j, i] : [i, j];
1422+
const foundEntries = queries[shorter].reduce(
1423+
(acc, entry) => acc + (queries[longer].includes(entry) ? 1 : 0),
1424+
0
1425+
);
1426+
const shorterEntries = queries[shorter].length;
1427+
if (foundEntries === shorterEntries) {
1428+
// If the shorter query is completely contained in the longer one, we can strike
1429+
// out the shorter query.
1430+
query.$and.splice(shorter, 1);
1431+
queries.splice(shorter, 1);
1432+
repeat = true;
1433+
break;
1434+
}
1435+
}
1436+
}
1437+
} while (repeat);
1438+
if (query.$and.length === 1) {
1439+
query = { ...query, ...query.$and[0] };
1440+
delete query.$and;
1441+
}
1442+
return query;
1443+
}
1444+
13681445
// Constraints query using CLP's pointer permissions (PP) if any.
13691446
// 1. Etract the user id from caller's ACLgroup;
13701447
// 2. Exctract a list of field names that are PP for target collection and operation;
@@ -1448,13 +1525,13 @@ class DatabaseController {
14481525
}
14491526
// if we already have a constraint on the key, use the $and
14501527
if (Object.prototype.hasOwnProperty.call(query, key)) {
1451-
return { $and: [queryClause, query] };
1528+
return this.reduceAndOperation({ $and: [queryClause, query] });
14521529
}
14531530
// otherwise just add the constaint
14541531
return Object.assign({}, query, queryClause);
14551532
});
14561533

1457-
return queries.length === 1 ? queries[0] : { $or: queries };
1534+
return queries.length === 1 ? queries[0] : this.reduceOrOperation({ $or: queries });
14581535
} else {
14591536
return query;
14601537
}

0 commit comments

Comments
 (0)