Skip to content

fix(sveltekit): Avoid capturing "Not Found" errors in server handleError wrapper #7898

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.

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
merged 2 commits into from
Apr 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions packages/sveltekit/src/server/handleError.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ function defaultErrorHandler({ error }: Parameters<HandleServerError>[0]): Retur
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return (input: { error: unknown; event: RequestEvent }): ReturnType<HandleServerError> => {
if (isNotFoundError(input)) {
return handleError(input);
}

captureException(input.error, scope => {
scope.addEventProcessor(event => {
addExceptionMechanism(event, {
Expand All @@ -35,3 +39,25 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
return handleError(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
* In the error handler here, we can't access the response yet (which we do in the load instrumentation),
* so we have to check if the error is a "Not found" error by checking if the route id is missing and
* by checking the error message on top of the raw stack trace.
*/
function isNotFoundError(input: { error: unknown; event: RequestEvent }): boolean {
const { error, event } = input;

const hasNoRouteId = !event.route || !event.route.id;

const rawStack: string =
(error != null &&
typeof error === 'object' &&
'stack' in error &&
typeof error.stack === 'string' &&
error.stack) ||
'';

return hasNoRouteId && rawStack.startsWith('Error: Not found:');
}
17 changes: 17 additions & 0 deletions packages/sveltekit/test/server/handleError.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,23 @@ describe('handleError', () => {
mockScope = new Scope();
});

it('doesn\'t capture "Not found" errors for incorrect navigations', async () => {
const wrappedHandleError = handleErrorWithSentry();
const mockError = new Error('Not found: /asdf/123');
const mockEvent = {
url: new URL('https://myDomain.com/asdf/123'),
route: { id: null }, // <-- this is what SvelteKit puts in the event when the page is not found
// ...
} as RequestEvent;

const returnVal = await wrappedHandleError({ error: mockError, event: mockEvent });

expect(returnVal).not.toBeDefined();
expect(mockCaptureException).toHaveBeenCalledTimes(0);
expect(mockAddExceptionMechanism).toHaveBeenCalledTimes(0);
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
const wrappedHandleError = handleErrorWithSentry();
Expand Down