Skip to content

ApiError surfaces the decoded response body as its message for non-JSON / non-conforming error bodies #189

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

Draft
parthban-db wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ApiError surfaces the decoded response body as its message for non-JSON / non-conforming error bodies #189

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
19 changes: 12 additions & 7 deletions packages/core/src/apierror/apierror.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,17 +141,20 @@ export class ApiError extends Error {
});
}

// Decode the body to a string for JSON parsing.
// Decode the body once; it doubles as the JSON source and as a readable
// fallback message for non-JSON or non-conforming bodies.
const decoded = new TextDecoder().decode(body);

let parsed: unknown;
try {
parsed = JSON.parse(new TextDecoder().decode(body));
parsed = JSON.parse(decoded);
} catch (e: unknown) {
// The JSON error is simply swallowed, this typically happens when the
// error does not come directly from a Databricks API. A typical example
// is when the error is returned by a proxy.
// The body is not JSON; this typically happens when the error does not
// come directly from a Databricks API (e.g. a proxy). Surface the decoded
// body as the message so the failure is debuggable instead of empty.
return new ApiError({
code: Code.UNKNOWN,
message: '',
message: decoded,
details: emptyDetails,
httpStatusCode: statusCode,
httpHeader: header,
Expand All @@ -162,9 +165,11 @@ export class ApiError extends Error {

const result = errorResponseSchema.safeParse(parsed);
if (!result.success) {
// The body parsed as JSON but does not match the error schema. Surface
// the decoded body as the message so the failure is debuggable.
return new ApiError({
code: Code.UNKNOWN,
message: '',
message: decoded,
details: emptyDetails,
httpStatusCode: statusCode,
httpHeader: header,
Expand Down
8 changes: 4 additions & 4 deletions packages/core/tests/apierror/apierror.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,22 +160,22 @@ describe('fromHttpError', () => {
}),
},
{
desc: 'HTML body',
desc: 'HTML body decoded into message',
statusCode: 502,
body: encode('<html><body>Bad Gateway</body></html>'),
want: new ApiError({
code: Code.UNKNOWN,
message: '',
message: '<html><body>Bad Gateway</body></html>',
details: emptyDetails,
}),
},
{
desc: 'malformed JSON',
desc: 'malformed JSON decoded into message',
statusCode: 400,
body: encode('{not valid json'),
want: new ApiError({
code: Code.UNKNOWN,
message: '',
message: '{not valid json',
details: emptyDetails,
}),
},
Expand Down
Loading