fix(sveltekit): Avoid capturing "Not Found" errors on client side

Author: Lms24

packages/sveltekit/src/client/handleError.ts

@@ -11,23 +11,39 @@ function defaultErrorHandler({ error }: Parameters<HandleClientError>[0]): Retur
   });
 }
 
-// TODO: add backwards-compatible type for kit 1.x (soon)
 type HandleClientErrorInput = Parameters<HandleClientError>[0];
 
+/**
+ * Backwards-compatible HandleServerError Input type for SvelteKit 1.x and 2.x
+ * `message` and `status` were added in 2.x.
+ * For backwards-compatibility, we make them optional
+ *
+ * @see https://kit.svelte.dev/docs/migrating-to-sveltekit-2#improved-error-handling
+ */
+type SafeHandleServerErrorInput = Omit<HandleClientErrorInput, 'status' | 'message'> &
+  Partial<Pick<HandleClientErrorInput, 'status' | 'message'>>;
+
 /**
  * Wrapper for the SvelteKit error handler that sends the error to Sentry.
  *
  * @param handleError The original SvelteKit error handler.
  */
 export function handleErrorWithSentry(handleError: HandleClientError = defaultErrorHandler): HandleClientError {
-  return (input: HandleClientErrorInput): ReturnType<HandleClientError> => {
-    captureException(input.error, {
-      mechanism: {
-        type: 'sveltekit',
-        handled: false,
-      },
-    });
+  return (input: SafeHandleServerErrorInput): ReturnType<HandleClientError> => {
+    const { status, message } = input;
+    const isNotFoundError = status === 404 && message === 'Not Found';
+
+    if (!isNotFoundError) {
+      captureException(input.error, {
+        mechanism: {
+          type: 'sveltekit',
+          handled: false,
+        },
+      });
+    }
 
+    // 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);
   };
 }

packages/sveltekit/test/client/handleError.test.ts

@@ -38,6 +38,7 @@ describe('handleError', () => {
     it('invokes the default handler if no handleError func is provided', async () => {
       const wrappedHandleError = handleErrorWithSentry();
       const mockError = new Error('test');
+      // @ts-expect-error - purposefully omitting status and message to cover SvelteKit 1.x compatibility
       const returnVal = await wrappedHandleError({ error: mockError, event: navigationEvent });
 
       expect(returnVal).not.toBeDefined();
@@ -50,6 +51,7 @@ describe('handleError', () => {
     it('invokes the user-provided error handler', async () => {
       const wrappedHandleError = handleErrorWithSentry(handleError);
       const mockError = new Error('test');
+      // @ts-expect-error - purposefully omitting status and message to cover SvelteKit 1.x compatibility
       const returnVal = (await wrappedHandleError({ error: mockError, event: navigationEvent })) as any;
 
       expect(returnVal.message).toEqual('Whoops!');
@@ -59,4 +61,19 @@ describe('handleError', () => {
       expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
     });
   });
+
+  it('doesn\'t capture "Not Found" errors', async () => {
+    const wrappedHandleError = handleErrorWithSentry(handleError);
+    const returnVal = (await wrappedHandleError({
+      error: new Error('404 Not Found'),
+      event: navigationEvent,
+      status: 404,
+      message: 'Not Found',
+    })) as any;
+
+    expect(returnVal.message).toEqual('Whoops!');
+    expect(mockCaptureException).not.toHaveBeenCalled();
+    // Check that the default handler wasn't invoked
+    expect(consoleErrorSpy).toHaveBeenCalledTimes(0);
+  });
 });