Skip to content

Commit

Permalink
feat: implement filter operators in restful service (zenstackhq#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ymc9
ymc9 authored May 12, 2023
1 parent 4ebaa1f commit 52f44c5
Show file tree
Hide file tree
Showing 2 changed files with 182 additions and 14 deletions.
69 changes: 63 additions & 6 deletions packages/server/src/api/rest/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,24 @@ class InvalidValueError extends Error {

const DEFAULT_PAGE_SIZE = 100;

const FilterOperations = [
'lt',
'lte',
'gt',
'gte',
'contains',
'icontains',
'search',
'startsWith',
'endsWith',
'has',
'hasEvery',
'hasSome',
'isEmpty',
] as const;

type FilterOperationType = (typeof FilterOperations)[number] | undefined;

/**
* RESTful style API request handler (compliant with JSON:API)
*/
Expand Down Expand Up @@ -1227,6 +1245,7 @@ class RequestHandler {
if (!match || !match.groups) {
continue;
}

const filterKeys = match.groups.match
.replaceAll(/[[\]]/g, ' ')
.split(' ')
Expand All @@ -1243,7 +1262,21 @@ class RequestHandler {

for (const filterValue of enumerate(value)) {
for (let i = 0; i < filterKeys.length; i++) {
const filterKey = filterKeys[i];
// extract filter operation from (optional) trailing $op
let filterKey = filterKeys[i];
let filterOp: FilterOperationType | undefined;
const pos = filterKey.indexOf('$');
if (pos > 0) {
filterOp = filterKey.substring(pos + 1) as FilterOperationType;
filterKey = filterKey.substring(0, pos);
}

if (!!filterOp && !FilterOperations.includes(filterOp)) {
return {
filter: undefined,
error: this.makeError('invalidFilter', `invalid filter operation: ${filterOp}`),
};
}

const fieldInfo =
filterKey === 'id'
Expand All @@ -1259,11 +1292,11 @@ class RequestHandler {
// must be the last segment of a filter
return { filter: undefined, error: this.makeError('invalidFilter') };
}
curr[fieldInfo.name] = this.makeFilterValue(fieldInfo, filterValue);
curr[fieldInfo.name] = this.makeFilterValue(fieldInfo, filterValue, filterOp);
} else {
// relation field
if (i === filterKeys.length - 1) {
curr[fieldInfo.name] = this.makeFilterValue(fieldInfo, filterValue);
curr[fieldInfo.name] = this.makeFilterValue(fieldInfo, filterValue, filterOp);
} else {
// keep going
curr = curr[fieldInfo.name] = {};
Expand Down Expand Up @@ -1399,18 +1432,42 @@ class RequestHandler {
return { select: result, error: undefined, allIncludes };
}

private makeFilterValue(fieldInfo: FieldInfo, value: string): any {
private makeFilterValue(fieldInfo: FieldInfo, value: string, op: FilterOperationType): any {
if (fieldInfo.isDataModel) {
// relation filter is converted to an ID filter
const info = this.typeMap[lowerCaseFirst(fieldInfo.type)];
if (fieldInfo.isArray) {
// filtering a to-many relation, imply 'some' operator
return { some: this.makeIdFilter(info.idField, info.idFieldType, value) };
const values = value.split(',').filter((i) => i);
const filterValue =
values.length > 1
? { OR: values.map((v) => this.makeIdFilter(info.idField, info.idFieldType, v)) }
: this.makeIdFilter(info.idField, info.idFieldType, value);
return { some: filterValue };
} else {
return { is: this.makeIdFilter(info.idField, info.idFieldType, value) };
}
} else {
return this.coerce(fieldInfo.type, value);
const coerced = this.coerce(fieldInfo.type, value);
switch (op) {
case 'icontains':
return { contains: coerced, mode: 'insensitive' };
case 'hasSome':
case 'hasEvery': {
const values = value
.split(',')
.filter((i) => i)
.map((v) => this.coerce(fieldInfo.type, v));
return { [op]: values };
}
case 'isEmpty':
if (value !== 'true' && value !== 'false') {
throw new InvalidValueError(`Not a boolean: ${value}`);
}
return { isEmpty: value === 'true' ? true : false };
default:
return op ? { [op]: coerced } : { equals: coerced };
}
}
}

Expand Down
127 changes: 119 additions & 8 deletions packages/server/tests/api/rest/rest.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ describe('REST server tests', () => {
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 'user2' });

// attribute filter
// String filter
r = await handler({
method: 'get',
path: '/user',
Expand All @@ -329,30 +329,53 @@ describe('REST server tests', () => {
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 'user1' });

// filter to empty
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[id]']: 'user3' },
query: { ['filter[email$contains]']: '1@abc' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 'user1' });

r = await handler({
method: 'get',
path: '/user',
query: { ['filter[email$contains]']: '1@bc' },
prisma,
});
expect((r.body as any).data).toHaveLength(0);

// to-many relation collection filter
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[posts]']: '2' },
query: { ['filter[email$startsWith]']: 'user1' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 'user2' });
expect((r.body as any).data[0]).toMatchObject({ id: 'user1' });

// multi filter
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[id]']: 'user1', ['filter[posts]']: '2' },
query: { ['filter[email$startsWith]']: 'ser1' },
prisma,
});
expect((r.body as any).data).toHaveLength(0);

r = await handler({
method: 'get',
path: '/user',
query: { ['filter[email$endsWith]']: '1@abc.com' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 'user1' });

r = await handler({
method: 'get',
path: '/user',
query: { ['filter[email$endsWith]']: '1@abc' },
prisma,
});
expect((r.body as any).data).toHaveLength(0);
Expand All @@ -367,6 +390,41 @@ describe('REST server tests', () => {
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 2 });

r = await handler({
method: 'get',
path: '/post',
query: { ['filter[viewCount$gt]']: '0' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 2 });

r = await handler({
method: 'get',
path: '/post',
query: { ['filter[viewCount$gte]']: '1' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 2 });

r = await handler({
method: 'get',
path: '/post',
query: { ['filter[viewCount$lt]']: '0' },
prisma,
});
expect((r.body as any).data).toHaveLength(0);

r = await handler({
method: 'get',
path: '/post',
query: { ['filter[viewCount$lte]']: '0' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 1 });

// Boolean filter
r = await handler({
method: 'get',
Expand All @@ -377,6 +435,42 @@ describe('REST server tests', () => {
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 2 });

// filter to empty
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[id]']: 'user3' },
prisma,
});
expect((r.body as any).data).toHaveLength(0);

// to-many relation collection filter
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[posts]']: '2' },
prisma,
});
expect((r.body as any).data).toHaveLength(1);
expect((r.body as any).data[0]).toMatchObject({ id: 'user2' });

r = await handler({
method: 'get',
path: '/user',
query: { ['filter[posts]']: '1,2,3' },
prisma,
});
expect((r.body as any).data).toHaveLength(2);

// multi filter
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[id]']: 'user1', ['filter[posts]']: '2' },
prisma,
});
expect((r.body as any).data).toHaveLength(0);

// to-one relation filter
r = await handler({
method: 'get',
Expand Down Expand Up @@ -420,6 +514,23 @@ describe('REST server tests', () => {
},
],
});

// invalid filter operation
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[email$foo]']: '1' },
prisma,
});
expect(r.body).toMatchObject({
errors: [
{
status: 400,
code: 'invalid-filter',
title: 'Invalid filter',
},
],
});
});

it('related data filtering', async () => {
Expand Down

0 comments on commit 52f44c5

Please sign in to comment.