Skip to content

fix(rest): support json equality filtering #2088

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
ymc9 merged 1 commit into from
Apr 15, 2025
Merged

fix(rest): support json equality filtering #2088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 24 additions & 9 deletions packages/server/src/api/rest/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1349,14 +1349,14 @@ class RequestHandler extends APIHandlerBase {
private makePrismaIdFilter(idFields: FieldInfo[], resourceId: string, nested: boolean = true) {
const decodedId = decodeURIComponent(resourceId);
if (idFields.length === 1) {
return { [idFields[0].name]: this.coerce(idFields[0].type, decodedId) };
return { [idFields[0].name]: this.coerce(idFields[0], decodedId) };
} else if (nested) {
return {
// TODO: support `@@id` with custom name
[idFields.map((idf) => idf.name).join(prismaIdDivider)]: idFields.reduce(
(acc, curr, idx) => ({
...acc,
[curr.name]: this.coerce(curr.type, decodedId.split(this.idDivider)[idx]),
[curr.name]: this.coerce(curr, decodedId.split(this.idDivider)[idx]),
}),
{}
),
Expand All @@ -1365,7 +1365,7 @@ class RequestHandler extends APIHandlerBase {
return idFields.reduce(
(acc, curr, idx) => ({
...acc,
[curr.name]: this.coerce(curr.type, decodedId.split(this.idDivider)[idx]),
[curr.name]: this.coerce(curr, decodedId.split(this.idDivider)[idx]),
}),
{}
);
Expand All @@ -1381,13 +1381,13 @@ class RequestHandler extends APIHandlerBase {

private makeIdConnect(idFields: FieldInfo[], id: string | number) {
if (idFields.length === 1) {
return { [idFields[0].name]: this.coerce(idFields[0].type, id) };
return { [idFields[0].name]: this.coerce(idFields[0], id) };
} else {
return {
[this.makePrismaIdKey(idFields)]: idFields.reduce(
(acc, curr, idx) => ({
...acc,
[curr.name]: this.coerce(curr.type, `${id}`.split(this.idDivider)[idx]),
[curr.name]: this.coerce(curr, `${id}`.split(this.idDivider)[idx]),
}),
{}
),
Expand Down Expand Up @@ -1436,8 +1436,17 @@ class RequestHandler extends APIHandlerBase {
}
}

private coerce(type: string, value: any) {
private coerce(fieldInfo: FieldInfo, value: any) {
if (typeof value === 'string') {
if (fieldInfo.isTypeDef || fieldInfo.type === 'Json') {
try {
return JSON.parse(value);
} catch {
throw new InvalidValueError(`invalid JSON value: ${value}`);
}
}

const type = fieldInfo.type;
if (type === 'Int' || type === 'BigInt') {
const parsed = parseInt(value);
if (isNaN(parsed)) {
Expand Down Expand Up @@ -1738,6 +1747,7 @@ class RequestHandler extends APIHandlerBase {
}

private makeFilterValue(fieldInfo: FieldInfo, value: string, op: FilterOperationType): any {
// TODO: inequality filters?
if (fieldInfo.isDataModel) {
// relation filter is converted to an ID filter
const info = this.typeMap[lowerCaseFirst(fieldInfo.type)];
Expand All @@ -1753,7 +1763,7 @@ class RequestHandler extends APIHandlerBase {
return { is: this.makePrismaIdFilter(info.idFields, value, false) };
}
} else {
const coerced = this.coerce(fieldInfo.type, value);
const coerced = this.coerce(fieldInfo, value);
switch (op) {
case 'icontains':
return { contains: coerced, mode: 'insensitive' };
Expand All @@ -1762,7 +1772,7 @@ class RequestHandler extends APIHandlerBase {
const values = value
.split(',')
.filter((i) => i)
.map((v) => this.coerce(fieldInfo.type, v));
.map((v) => this.coerce(fieldInfo, v));
return { [op]: values };
}
case 'isEmpty':
Expand All @@ -1772,11 +1782,16 @@ class RequestHandler extends APIHandlerBase {
return { isEmpty: value === 'true' ? true : false };
default:
if (op === undefined) {
if (fieldInfo.isTypeDef || fieldInfo.type === 'Json') {
// handle JSON value equality filter
return { equals: coerced };
}

// regular filter, split value by comma
const values = value
.split(',')
.filter((i) => i)
.map((v) => this.coerce(fieldInfo.type, v));
.map((v) => this.coerce(fieldInfo, v));
return values.length > 1 ? { in: values } : { equals: values[0] };
} else {
return { [op]: coerced };
Expand Down
57 changes: 57 additions & 0 deletions packages/server/tests/api/rest.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ describe('REST server tests', () => {

describe('REST server tests - regular prisma', () => {
const schema = `
type Address {
city String
}

model User {
myId String @id @default(cuid())
createdAt DateTime @default (now())
Expand All @@ -30,6 +34,8 @@ describe('REST server tests', () => {
posts Post[]
likes PostLike[]
profile Profile?
address Address? @json
someJson Json?
}

model Profile {
Expand Down Expand Up @@ -428,6 +434,8 @@ describe('REST server tests', () => {
data: {
myId: 'user1',
email: '[email protected]',
address: { city: 'Seattle' },
someJson: 'foo',
posts: {
create: { id: 1, title: 'Post1' },
},
Expand Down Expand Up @@ -714,6 +722,55 @@ describe('REST server tests', () => {
},
],
});

// typedef equality filter
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[address]']: JSON.stringify({ city: 'Seattle' }) },
prisma,
});
expect(r.body.data).toHaveLength(1);
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[address]']: JSON.stringify({ city: 'Tokyo' }) },
prisma,
});
expect(r.body.data).toHaveLength(0);

// plain json equality filter
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[someJson]']: JSON.stringify('foo') },
prisma,
});
expect(r.body.data).toHaveLength(1);
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[someJson]']: JSON.stringify('bar') },
prisma,
});
expect(r.body.data).toHaveLength(0);

// invalid json
r = await handler({
method: 'get',
path: '/user',
query: { ['filter[someJson]']: '{ hello: world }' },
prisma,
});
expect(r.body).toMatchObject({
errors: [
{
status: 400,
code: 'invalid-value',
title: 'Invalid value for type',
},
],
});
});

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