fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

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
Lms24 merged 2 commits into from
Jul 28, 2025
Merged

fix(v9/sveltekit): Align error status filtering and mechanism in handleErrorWithSentry#17174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25af09f
fix(sveltekit): Align error status filtering and mechanism in `handle…
Lms24 Jul 25, 2025
c05b2ce
start ci?
Lms24 Jul 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
41 changes: 28 additions & 13 deletions packages/sveltekit/src/client/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,20 +28,35 @@ type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
// SvelteKit 2.0 offers a reliable way to check for a 404 error:
if (input.status !== 404) {
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
},
});
export function handleErrorWithSentry(handleError?: HandleClientError): HandleClientError {
const errorHandler = handleError ?? defaultErrorHandler;

return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
if (is4xxError(input)) {
return errorHandler(input);
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: !!handleError,
},
});

return errorHandler(input);
};
}

// 4xx are expected errors and thus we don't want to capture them
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { status } = input;

// Pre-SvelteKit 2.x, the status is not available,
// so we don't know if this is a 4xx error
if (!status) {
return false;
}

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
return status >= 400 && status < 500;
}
22 changes: 10 additions & 12 deletions packages/sveltekit/src/server-common/handleError.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,18 +27,18 @@ type SafeHandleServerErrorInput = Omit<HandleServerErrorInput, 'status' | 'messa
*
* @param handleError The original SvelteKit error handler.
*/
export function handleErrorWithSentry(handleError: HandleServerError = defaultErrorHandler): HandleServerError {
return async (input: SafeHandleServerErrorInput): Promise<void | App.Error> => {
if (isNotFoundError(input)) {
// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
export function handleErrorWithSentry(handleError?: HandleServerError): HandleServerError {
const errorHandler = handleError ?? defaultErrorHandler;

return async (input: HandleServerErrorInput): Promise<void | App.Error> => {
if (is4xxError(input)) {
return errorHandler(input);
}

captureException(input.error, {
mechanism: {
type: 'sveltekit',
handled: false,
handled: !!handleError,
},
});

Expand All@@ -60,20 +60,18 @@ export function handleErrorWithSentry(handleError: HandleServerError = defaultEr
await flushIfServerless();
}

// We're extra cautious with SafeHandleServerErrorInput - this type is not compatible with HandleServerErrorInput
// @ts-expect-error - we're still passing the same object, just with a different (backwards-compatible) type
return handleError(input);
return errorHandler(input);
};
}

/**
* When a page request fails because the page is not found, SvelteKit throws a "Not found" error.
*/
function isNotFoundError(input: SafeHandleServerErrorInput): boolean {
function is4xxError(input: SafeHandleServerErrorInput): boolean {
const { error, event, status } = input;

// SvelteKit 2.0 offers a reliable way to check for a Not Found error:
if (status === 404) {
if (!!status && status >= 400 && status < 500) {
return true;
}

Expand Down
15 changes: 9 additions & 6 deletions packages/sveltekit/test/client/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const captureExceptionEventHint = {

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (client)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand DownExpand Up@@ -55,19 +55,22 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});

// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
});

it("doesn't capture 404 errors", async () => {
it.each([400, 401, 402, 403, 404, 429, 499])("doesn't capture %s errors", async statusCode => {
const wrappedHandleError = handleErrorWithSentry(handleError);
const returnVal = (await wrappedHandleError({
error: new Error('404 Not Found'),
error: new Error(`Error with status ${statusCode}`),
event: navigationEvent,
status: 404,
message: 'Not Found',
status: statusCode,
message: `Error with status ${statusCode}`,
})) as any;

expect(returnVal.message).toEqual('Whoops!');
Expand Down
33 changes: 19 additions & 14 deletions packages/sveltekit/test/server-common/handleError.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ const requestEvent = {} as RequestEvent;

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});

describe('handleError', () => {
describe('handleError (server)', () => {
beforeEach(() => {
mockCaptureException.mockClear();
consoleErrorSpy.mockClear();
Expand All@@ -42,20 +42,23 @@ describe('handleError', () => {
expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
});

it('doesn\'t capture "Not found" errors for incorrect navigations [Kit 2.x]', async () => {
const wrappedHandleError = handleErrorWithSentry();
it.each([400, 401, 402, 403, 404, 429, 499])(
"doesn't capture %s errors for incorrect navigations [Kit 2.x]",
async statusCode => {
const wrappedHandleError = handleErrorWithSentry();

const returnVal = await wrappedHandleError({
error: new Error('404 /asdf/123'),
event: requestEvent,
status: 404,
message: 'Not Found',
});
const returnVal = await wrappedHandleError({
error: new Error(`Error with status ${statusCode}`),
event: requestEvent,
status: statusCode,
message: `Error with status ${statusCode}`,
});

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

describe('calls captureException', () => {
it('invokes the default handler if no handleError func is provided', async () => {
Expand DownExpand Up@@ -87,7 +90,9 @@ describe('handleError', () => {

expect(returnVal.message).toEqual('Whoops!');
expect(mockCaptureException).toHaveBeenCalledTimes(1);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
mechanism: { handled: true, type: 'sveltekit' },
});
// Check that the default handler wasn't invoked
expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
});
Expand Down
Loading