Skip to content

feat(ui): Change API request exceptions to use cause property #37262

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
billyvg merged 1 commit into from
Aug 2, 2022
Merged

feat(ui): Change API request exceptions to use cause property #37262

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
5 changes: 2 additions & 3 deletions static/app/api.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ export class Client {
// This *should* get logged to Sentry only if the promise rejection is not handled
// (since SDK captures unhandled rejections). Ideally we explicitly ignore rejection
// or handle with a user friendly error message
const preservedError = new Error();
const preservedError = new Error('API Request Error');

return new Promise((resolve, reject) =>
this.request(path, {
Expand All @@ -567,11 +567,10 @@ export class Client {
error: (resp: ResponseMeta) => {
const errorObjectToUse = createRequestError(
resp,
preservedError.stack,
preservedError,
options.method,
path
);
errorObjectToUse.removeFrames(2);

// Although `this.request` logs all error responses, this error object can
// potentially be logged by Sentry's unhandled rejection handler
Expand Down
8 changes: 2 additions & 6 deletions static/app/utils/requestError/createRequestError.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ const ERROR_MAP = {
*/
export default function createRequestError(
resp: ResponseMeta,
stack: string | undefined,
cause: Error,
method: 'POST' | 'GET' | 'DELETE' | 'PUT' | undefined,
path: string
) {
const err = new RequestError(method, path);
const err = new RequestError(method, path, {cause});

if (resp) {
const errorName = ERROR_MAP[resp.status];
Expand All @@ -41,9 +41,5 @@ export default function createRequestError(
err.setResponse(resp);
}

if (stack) {
err.setStack(stack);
}

return err;
}
25 changes: 5 additions & 20 deletions static/app/utils/requestError/requestError.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@ import {ResponseMeta} from 'sentry/api';

import {sanitizePath} from './sanitizePath';

interface ErrorOptionsObject {
cause: Error;
}
export default class RequestError extends Error {
responseText?: string;
responseJSON?: any;
status?: number;
statusText?: string;

constructor(method: string | undefined, path: string) {
super(`${method || 'GET'} ${sanitizePath(path)}`);
constructor(method: string | undefined, path: string, options: ErrorOptionsObject) {
super(`${method || 'GET'} "${sanitizePath(path)}"`, options);
Copy link
Member Author

@billyvg billyvg Jul 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to quote this because of a bug in our SDK

this.name = 'RequestError';
Object.setPrototypeOf(this, new.target.prototype);
}
Expand Down Expand Up @@ -41,25 +44,7 @@ export default class RequestError extends Error {
this.message = message;
}

setStack(newStack: string) {
this.stack = newStack;
}

setName(name: string) {
this.name = name;
}

removeFrames(numLinesToRemove) {
// Drop some frames so stack trace starts at callsite
//
// Note that babel will add a call to support extending Error object

// Old browsers may not have stack trace
if (!this.stack) {
return;
}

const lines = this.stack.split('\n');
this.stack = [lines[0], ...lines.slice(numLinesToRemove)].join('\n');
}
}