Skip to content

Rest api sparse fieldsets #2251

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

Closed
wants to merge 6 commits into from
Closed

Rest api sparse fieldsets #2251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f8444b
setup quick testing and debugging
sw34 Sep 23, 2025
08f7b31
implement sparse fields for collection reads
sw34 Sep 25, 2025
7250f8f
implement sparse fields for single reads
sw34 Sep 25, 2025
ed379e5
add test for include on read single
sw34 Sep 25, 2025
14fd00e
implement sparse fields for relationships, add more tests
sw34 Sep 25, 2025
f92fea4
remove testing shortcut
sw34 Sep 25, 2025
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
92 changes: 86 additions & 6 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 @@ -177,6 +177,10 @@ class RequestHandler extends APIHandlerBase {
status: 400,
title: 'Invalid value for type',
},
duplicatedFieldsParameter: {
status: 400,
title: 'Fields Parameter Duplicated',
},
forbidden: {
status: 403,
title: 'Operation is forbidden',
Expand All @@ -185,6 +189,7 @@ class RequestHandler extends APIHandlerBase {
status: 422,
title: 'Operation is unprocessable due to validation errors',
},

unknownError: {
status: 400,
title: 'Unknown error',
Expand Down Expand Up @@ -511,7 +516,7 @@ class RequestHandler extends APIHandlerBase {
// handle "include" query parameter
let include: string[] | undefined;
if (query?.include) {
const { select, error, allIncludes } = this.buildRelationSelect(type, query.include);
const { select, error, allIncludes } = this.buildRelationSelect(type, query.include, query);
if (error) {
return error;
}
Expand All @@ -521,6 +526,20 @@ class RequestHandler extends APIHandlerBase {
include = allIncludes;
}

// handle partial results for requested type
const { select, error } = this.buildPartialSelect(type, query);
if (error) return error;
if (select) {
args.select = { ...select, ...args.select };
if (args.include) {
args.select = {
...args.select,
...args.include,
};
args.include = undefined;
}
}

const entity = await prisma[type].findUnique(args);

if (entity) {
Expand Down Expand Up @@ -555,7 +574,7 @@ class RequestHandler extends APIHandlerBase {
// handle "include" query parameter
let include: string[] | undefined;
if (query?.include) {
const { select: relationSelect, error, allIncludes } = this.buildRelationSelect(type, query.include);
const { select: relationSelect, error, allIncludes } = this.buildRelationSelect(type, query.include, query);
if (error) {
return error;
}
Expand All @@ -566,7 +585,14 @@ class RequestHandler extends APIHandlerBase {
select = relationSelect;
}

select = select ?? { [relationship]: true };
// handle partial results for requested type
if (!select) {
const { select: partialFields, error } = this.buildPartialSelect(lowerCaseFirst(relationInfo.type), query);
if (error) return error;

select = partialFields ? { [relationship]: { select: { ...partialFields } } } : { [relationship]: true };
}

const args: any = {
where: this.makePrismaIdFilter(typeInfo.idFields, resourceId),
select,
Expand Down Expand Up @@ -710,7 +736,7 @@ class RequestHandler extends APIHandlerBase {
// handle "include" query parameter
let include: string[] | undefined;
if (query?.include) {
const { select, error, allIncludes } = this.buildRelationSelect(type, query.include);
const { select, error, allIncludes } = this.buildRelationSelect(type, query.include, query);
if (error) {
return error;
}
Expand All @@ -720,6 +746,20 @@ class RequestHandler extends APIHandlerBase {
include = allIncludes;
}

// handle partial results for requested type
const { select, error } = this.buildPartialSelect(type, query);
if (error) return error;
if (select) {
args.select = { ...select, ...args.select };
if (args.include) {
args.select = {
...args.select,
...args.include,
};
args.include = undefined;
}
}

const { offset, limit } = this.getPagination(query);
if (offset > 0) {
args.skip = offset;
Expand All @@ -738,6 +778,7 @@ class RequestHandler extends APIHandlerBase {
};
} else {
args.take = limit;

const [entities, count] = await Promise.all([
prisma[type].findMany(args),
prisma[type].count({ where: args.where ?? {} }),
Expand All @@ -762,6 +803,33 @@ class RequestHandler extends APIHandlerBase {
}
}

private buildPartialSelect(type: string, query: Record<string, string | string[]> | undefined) {
const selectFieldsQuery = query?.[`fields[${type}]`];
if (!selectFieldsQuery) {
return { select: undefined, error: undefined };
}

if (Array.isArray(selectFieldsQuery)) {
return {
select: undefined,
error: this.makeError('duplicatedFieldsParameter', `duplicated fields query for type ${type}`),
};
}

const typeInfo = this.typeMap[lowerCaseFirst(type)];
if (!typeInfo) {
return { select: undefined, error: this.makeUnsupportedModelError(type) };
}

const selectFieldNames = selectFieldsQuery.split(',').filter((i) => i);

const fields = selectFieldNames.reduce((acc, curr) => ({ ...acc, [curr]: true }), {});

return {
select: { ...this.makeIdSelect(typeInfo.idFields), ...fields },
};
}

private addTotalCountToMeta(meta: any, total: any) {
return meta ? Object.assign(meta, { total }) : Object.assign({}, { total });
}
Expand Down Expand Up @@ -1790,7 +1858,11 @@ class RequestHandler extends APIHandlerBase {
return { sort: result, error: undefined };
}

private buildRelationSelect(type: string, include: string | string[]) {
private buildRelationSelect(
type: string,
include: string | string[],
query: Record<string, string | string[]> | undefined
) {
const typeInfo = this.typeMap[lowerCaseFirst(type)];
if (!typeInfo) {
return { select: undefined, error: this.makeUnsupportedModelError(type) };
Expand Down Expand Up @@ -1820,11 +1892,19 @@ class RequestHandler extends APIHandlerBase {
return { select: undefined, error: this.makeUnsupportedModelError(relationInfo.type) };
}

// handle partial results for requested type
const { select, error } = this.buildPartialSelect(lowerCaseFirst(relationInfo.type), query);
if (error) return { select: undefined, error };

if (i !== parts.length - 1) {
currPayload[relation] = { include: { ...currPayload[relation]?.include } };
currPayload = currPayload[relation].include;
} else {
currPayload[relation] = true;
currPayload[relation] = select
? {
select: { ...select },
}
: true;
}
}
}
Expand Down
Loading
Loading