Skip to content

fix(server): exclude stack trace from REST error responses #2501

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 3 commits into from
Mar 20, 2026
Merged

fix(server): exclude stack trace from REST error responses #2501

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
520fa89
fix(server): exclude stack trace from REST generic error responses
ymc9 Mar 20, 2026
17223e4
Merge remote-tracking branch 'origin/dev' into fix/rest-error-no-stack
ymc9 Mar 20, 2026
e449af6
improve error logging
ymc9 Mar 20, 2026
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
18 changes: 14 additions & 4 deletions packages/server/src/api/rest/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { clone, enumerate, lowerCaseFirst, paramCase } from '@zenstackhq/common-helpers';
import { clone, enumerate, lowerCaseFirst, paramCase, safeJSONStringify } from '@zenstackhq/common-helpers';
import { ORMError, ORMErrorReason, type ClientContract } from '@zenstackhq/orm';
import type { FieldDef, ModelDef, SchemaDef } from '@zenstackhq/orm/schema';
import { Decimal } from 'decimal.js';
Expand Down Expand Up @@ -508,7 +508,13 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
}

private handleGenericError(err: unknown): Response | PromiseLike<Response> {
return this.makeError('unknownError', err instanceof Error ? `${err.message}\n${err.stack}` : 'Unknown error');
const resp = this.makeError('unknownError', err instanceof Error ? `${err.message}` : 'Unknown error');
log(
this.options.log,
'debug',
() => `sending error response: ${safeJSONStringify(resp)}${err instanceof Error ? '\n' + err.stack : ''}`,
);
return resp;
}

private async processProcedureRequest({
Expand Down Expand Up @@ -585,14 +591,18 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api

private makeProcBadInputErrorResponse(message: string): Response {
const resp = this.makeError('invalidPayload', message, 400);
log(this.log, 'debug', () => `sending error response: ${JSON.stringify(resp)}`);
log(this.log, 'debug', () => `sending error response: ${safeJSONStringify(resp)}`);
return resp;
}

private makeProcGenericErrorResponse(err: unknown): Response {
const message = err instanceof Error ? err.message : 'unknown error';
const resp = this.makeError('unknownError', message, 500);
log(this.log, 'debug', () => `sending error response: ${JSON.stringify(resp)}`);
log(
this.log,
'debug',
() => `sending error response: ${safeJSONStringify(resp)}${err instanceof Error ? '\n' + err.stack : ''}`,
);
return resp;
}

Expand Down
Loading