Sveltekit errors are not captured by sentry

[Wizzel1]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/sveltekit

SDK Version

8.22.0

Framework Version

"@sveltejs/kit": "^2.5.20",

Link to Sentry event

No response

Reproduction Example/SDK Setup

No response

Steps to Reproduce

1. Create a new sveltekit app.
2. Run the sveltekit installation wizard npx @sentry/wizard@latest -i sveltekit and create the example endpoint that throws an error.
3. Change the code in the example endpoint to:

// This is just a very simple API route that throws an example error.
// Feel free to delete this file and the entire sentry route.
import { error } from '@sveltejs/kit';

export const GET = async () => {
  error(500, 'Sentry Example API Route Error');
};

Expected Result

I was expecting this error to be caught be cause the documentation of error says

Throws an error with a HTTP status code and an optional message. When called during request handling, this will cause SvelteKit to return an error response without invoking handleError. Make sure you're not catching the thrown error, which would prevent SvelteKit from handling it."

Actual Result

No event showed up in sentry. It only works when I use throw new Error("Sentry Example API Route Error");

[andreiborza]

Hi, thanks for raising this. We are looking into it.

[Lms24]

Hey @Wizzel1 I just had a look and can confirm that in +server.ts routes, we don't catch errors thrown via error(). There are two reasons for that:

1. we don't directly wrap the exported functions (GET, POST, etc). Unlike in load functions where error() calls are actually automatically caught in Sentry. So our general request handler (sentryHandle) probably comes in too late in the promise chain to actually catch the thrown error because SvelteKit internally already caught and processed the error.
2. One could argue that because error() calls are expected errors, our SDK shouldn't catch them by default anyway. Unfortunately we're a bit inconsistent with this behaviour, given that they are caught in load functions.

Here's my question to you (and to everyone reading the issue): Would you like to see expected errors being always caught by Sentry? We can think of something to do this but it's not high on our list of priorities at the moment.

For the moment you can write your own wrapper for your server routes. It's not perfect but maybe something like this would do:

const get = async () => {
  console.log('API call');
  error(500, 'Sentry Example API Route Error');
  return new Response(JSON.stringify({ myMessage: 'xxx' }));
};

function wrapServerRouteWithSentry(routeHandler: (request: RequestEvent) => Promise<Response>) {
  return async (request: RequestEvent) => {
    try {
      return await routeHandler(request);
    } catch (e) {
      Sentry.captureException(e);
      throw e;
    }
  };
}

export const GET = wrapServerRouteWithSentry(get);

[Wizzel1]

@Lms24 I understand that because error() are expected errors you treat them differently but I would still like to get notified because even an expected error is useful when enriched with context. At the moment I don't know what is going on unless I treat every error as unexpected error.

In general I would like to see a full stack example of how to use sentry with sveltekit.

[Lms24]

Hey @Wizzel1

but I would still like to get notified because even an expected error is useful when enriched with context

thanks for the feedback and I think that's fair. I opened #13247 which basically expands on the wrapper I posted initially and adds it to the SDK. For now though, we'll update docs that this can be added manually if you want to wrap your server routes. Auto instrumentation would be nice but I currently don't have the bandwidth to figure out the inevitable quirks around messing with build time instrumentation.

In general I would like to see a full stack example of how to use sentry with sveltekit.

Are you looking to solve specific problems that are not covered by our docs? You might want to take a look at our SvelteKit E2E test apps (example). They have a couple of routes and use different SvelteKit features. But they're not super "fullstack" in the sense of using components outside a sveltekit app.