Skip to content

fix: fix the incorrect query args reduction when there're mixed boolean operators #690

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
merged 3 commits into from
Sep 14, 2023
Merged

fix: fix the incorrect query args reduction when there're mixed boolean operators #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b303b7
fix: fix the incorrect query args reduction when there're mixed boole…
ymc9 Sep 13, 2023
36890d9
fix tests
ymc9 Sep 13, 2023
e4317f5
more fixes
ymc9 Sep 14, 2023
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
2 changes: 1 addition & 1 deletion packages/runtime/src/enhancements/model-meta.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export function getDefaultModelMeta(): ModelMeta {
* Resolves a model field to its metadata. Returns undefined if not found.
*/
export function resolveField(modelMeta: ModelMeta, model: string, field: string): FieldInfo | undefined {
return modelMeta.fields[lowerCaseFirst(model)][field];
return modelMeta.fields[lowerCaseFirst(model)]?.[field];
}

/**
Expand Down
127 changes: 84 additions & 43 deletions packages/runtime/src/enhancements/policy/policy-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { getFields, resolveField } from '../model-meta';
import { NestedWriteVisitorContext } from '../nested-write-vistor';
import type { InputCheckFunc, ModelMeta, PolicyDef, ReadFieldCheckFunc, ZodSchemas } from '../types';
import {
enumerate,
formatObject,
getIdFields,
getModelFields,
Expand Down Expand Up @@ -54,14 +55,28 @@ export class PolicyUtil {
* Creates a conjunction of a list of query conditions.
*/
and(...conditions: (boolean | object | undefined)[]): object {
return this.reduce({ AND: conditions });
const filtered = conditions.filter((c) => c !== undefined);
if (filtered.length === 0) {
return this.makeTrue();
} else if (filtered.length === 1) {
return this.reduce(filtered[0]);
} else {
return this.reduce({ AND: filtered });
}
}

/**
* Creates a disjunction of a list of query conditions.
*/
or(...conditions: (boolean | object | undefined)[]): object {
return this.reduce({ OR: conditions });
const filtered = conditions.filter((c) => c !== undefined);
if (filtered.length === 0) {
return this.makeFalse();
} else if (filtered.length === 1) {
return this.reduce(filtered[0]);
} else {
return this.reduce({ OR: filtered });
}
}

/**
Expand Down Expand Up @@ -116,48 +131,75 @@ export class PolicyUtil {
return this.makeFalse();
}

if ('AND' in condition && Array.isArray(condition.AND)) {
const children = condition.AND.map((c: any) => this.reduce(c)).filter(
(c) => c !== undefined && !this.isTrue(c)
);
if (children.length === 0) {
return this.makeTrue();
} else if (children.some((c) => this.isFalse(c))) {
return this.makeFalse();
} else if (children.length === 1) {
return children[0];
} else {
return { AND: children };
}
if (condition === null) {
return condition;
}

if ('OR' in condition && Array.isArray(condition.OR)) {
const children = condition.OR.map((c: any) => this.reduce(c)).filter(
(c) => c !== undefined && !this.isFalse(c)
);
if (children.length === 0) {
return this.makeFalse();
} else if (children.some((c) => this.isTrue(c))) {
return this.makeTrue();
} else if (children.length === 1) {
return children[0];
} else {
return { OR: children };
const result: any = {};
for (const [key, value] of Object.entries<any>(condition)) {
if (value === null || value === undefined) {
result[key] = value;
continue;
}
}

if ('NOT' in condition && condition.NOT !== null && typeof condition.NOT === 'object') {
const child = this.reduce(condition.NOT);
if (this.isTrue(child)) {
return this.makeFalse();
} else if (this.isFalse(child)) {
return this.makeTrue();
} else {
return { NOT: child };
switch (key) {
case 'AND': {
const children = enumerate(value)
.map((c: any) => this.reduce(c))
.filter((c) => c !== undefined && !this.isTrue(c));
if (children.length === 0) {
result[key] = []; // true
} else if (children.some((c) => this.isFalse(c))) {
result['OR'] = []; // false
} else {
if (!this.isTrue({ AND: result[key] })) {
// use AND only if it's not already true
result[key] = !Array.isArray(value) && children.length === 1 ? children[0] : children;
}
}
break;
}

case 'OR': {
const children = enumerate(value)
.map((c: any) => this.reduce(c))
.filter((c) => c !== undefined && !this.isFalse(c));
if (children.length === 0) {
result[key] = []; // false
} else if (children.some((c) => this.isTrue(c))) {
result['AND'] = []; // true
} else {
if (!this.isFalse({ OR: result[key] })) {
// use OR only if it's not already false
result[key] = !Array.isArray(value) && children.length === 1 ? children[0] : children;
}
}
break;
}

case 'NOT': {
result[key] = this.reduce(value);
break;
}

default: {
const booleanKeys = ['AND', 'OR', 'NOT', 'is', 'isNot', 'none', 'every', 'some'];
if (
typeof value === 'object' &&
value &&
// recurse only if the value has at least one boolean key
Object.keys(value).some((k) => booleanKeys.includes(k))
) {
result[key] = this.reduce(value);
} else {
result[key] = value;
}
break;
}
}
}

return condition;
return result;
}

//#endregion
Expand Down Expand Up @@ -349,18 +391,18 @@ export class PolicyUtil {
operation: PolicyOperationKind
) {
const guard = this.getAuthGuard(db, fieldInfo.type, operation);

// is|isNot and flat fields conditions are mutually exclusive

if (payload.is || payload.isNot) {
if (payload.is) {
this.injectGuardForRelationFields(db, fieldInfo.type, payload.is, operation);
// turn "is" into: { is: { AND: [ originalIs, guard ] }
payload.is = this.and(payload.is, guard);
}
if (payload.isNot) {
this.injectGuardForRelationFields(db, fieldInfo.type, payload.isNot, operation);
// turn "isNot" into: { isNot: { AND: [ originalIsNot, { NOT: guard } ] } }
payload.isNot = this.and(payload.isNot, this.not(guard));
delete payload.isNot;
}
// merge guard with existing "is": { is: [originalIs, guard] }
payload.is = this.and(payload.is, guard);
} else {
this.injectGuardForRelationFields(db, fieldInfo.type, payload, operation);
// turn direct conditions into: { is: { AND: [ originalConditions, guard ] } }
Expand Down Expand Up @@ -1062,7 +1104,6 @@ export class PolicyUtil {
throw new Error('invalid where clause');
}

extra = this.reduce(extra);
if (this.isTrue(extra)) {
return;
}
Expand Down
147 changes: 147 additions & 0 deletions tests/integration/tests/enhancements/with-policy/query-reduction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
import { loadSchema } from '@zenstackhq/testtools';
import path from 'path';

describe('With Policy: query reduction', () => {
let origDir: string;

beforeAll(async () => {
origDir = path.resolve('.');
});

afterEach(() => {
process.chdir(origDir);
});

it('test query reduction', async () => {
const { prisma, withPolicy } = await loadSchema(
`
model User {
id Int @id @default(autoincrement())
role String @default("User")
posts Post[]
private Boolean @default(false)
age Int

@@allow('all', auth() == this)
@@allow('read', !private)
}

model Post {
id Int @id @default(autoincrement())
user User @relation(fields: [userId], references: [id])
userId Int
title String
published Boolean @default(false)
viewCount Int @default(0)

@@allow('all', auth() == user)
@@allow('read', published)
}
`
);

await prisma.user.create({
data: {
id: 1,
role: 'User',
age: 18,
posts: {
create: [
{ id: 1, title: 'Post 1' },
{ id: 2, title: 'Post 2', published: true },
],
},
},
});
await prisma.user.create({
data: {
id: 2,
role: 'Admin',
age: 28,
private: true,
posts: {
create: [{ id: 3, title: 'Post 3', viewCount: 100 }],
},
},
});

const dbUser1 = withPolicy({ id: 1 });
const dbUser2 = withPolicy({ id: 2 });

await expect(
dbUser1.user.findMany({
where: { id: 2, AND: { age: { gt: 20 } } },
})
).resolves.toHaveLength(0);

await expect(
dbUser2.user.findMany({
where: { id: 2, AND: { age: { gt: 20 } } },
})
).resolves.toHaveLength(1);

await expect(
dbUser1.user.findMany({
where: {
AND: { age: { gt: 10 } },
OR: [{ age: { gt: 25 } }, { age: { lt: 20 } }],
NOT: { private: true },
},
})
).resolves.toHaveLength(1);

await expect(
dbUser2.user.findMany({
where: {
AND: { age: { gt: 10 } },
OR: [{ age: { gt: 25 } }, { age: { lt: 20 } }],
NOT: { private: true },
},
})
).resolves.toHaveLength(1);

// to-many relation query
await expect(
dbUser1.user.findMany({
where: { posts: { some: { published: true } } },
})
).resolves.toHaveLength(1);
await expect(
dbUser1.user.findMany({
where: { posts: { some: { AND: [{ published: true }, { viewCount: { gt: 0 } }] } } },
})
).resolves.toHaveLength(0);
await expect(
dbUser2.user.findMany({
where: { posts: { some: { AND: [{ published: false }, { viewCount: { gt: 0 } }] } } },
})
).resolves.toHaveLength(1);
await expect(
dbUser1.user.findMany({
where: { posts: { every: { published: true } } },
})
).resolves.toHaveLength(0);
await expect(
dbUser1.user.findMany({
where: { posts: { none: { published: true } } },
})
).resolves.toHaveLength(0);

// to-one relation query
await expect(
dbUser1.post.findMany({
where: { user: { role: 'Admin' } },
})
).resolves.toHaveLength(0);
await expect(
dbUser1.post.findMany({
where: { user: { is: { role: 'Admin' } } },
})
).resolves.toHaveLength(0);
await expect(
dbUser1.post.findMany({
where: { user: { isNot: { role: 'User' } } },
})
).resolves.toHaveLength(0);
});
});
4 changes: 2 additions & 2 deletions tests/integration/tests/enhancements/with-policy/relation-one-to-one-filter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ describe('With Policy: relation one-to-one filter', () => {
},
},
})
).toResolveTruthy();
).toResolveFalsy();

// m1 with m2 and m3
await db.m1.create({
Expand Down Expand Up @@ -257,7 +257,7 @@ describe('With Policy: relation one-to-one filter', () => {
},
},
})
).toResolveTruthy();
).toResolveFalsy();
});

it('direct object filter', async () => {
Expand Down
Loading