ref(sveltekit): Adjust mechanism of error events (#17646)

mechanism type now follows the trace origin naming scheme

closes #17639

Author: Lms24

CHANGELOG.md

@@ -31,6 +31,7 @@
   - ref(remix): Adjust event mechanism of `captureRemixServerException` ([#17629](https://github.com/getsentry/sentry-javascript/pull/17629))
   - ref(replay-internal): Add mechanism to error caught by `replayIntegration` in debug mode ([#17606](https://github.com/getsentry/sentry-javascript/pull/17606))
   - ref(solid): Add `mechanism` to error captured by `withSentryErrorBoundary` ([#17607](https://github.com/getsentry/sentry-javascript/pull/17607))
+  - ref(sveltekit): Adjust `mechanism` of error events ([#17646](https://github.com/getsentry/sentry-javascript/pull/17646))
   - ref(vue): Adjust mechanism in Vue error handler ([#17647](https://github.com/getsentry/sentry-javascript/pull/17647))
 
   <br/>

dev-packages/e2e-tests/test-applications/sveltekit-2/tests/errors.server.test.ts

@@ -73,9 +73,7 @@ test.describe('server-side errors', () => {
             value: "'HttpError' captured as exception with keys: body, status",
             mechanism: {
               handled: false,
-              data: {
-                function: 'serverRoute',
-              },
+              type: 'auto.function.sveltekit.server_route',
             },
             stacktrace: { frames: expect.any(Array) },
           },

packages/sveltekit/src/client/handleError.ts

@@ -38,7 +38,7 @@ export function handleErrorWithSentry(handleError?: HandleClientError): HandleCl
 
     captureException(input.error, {
       mechanism: {
-        type: 'sveltekit',
+        type: 'auto.function.sveltekit.handle_error',
         handled: !!handleError,
       },
     });

packages/sveltekit/src/client/load.ts

@@ -29,11 +29,8 @@ function sendErrorToSentry(e: unknown): unknown {
 
   captureException(objectifiedErr, {
     mechanism: {
-      type: 'sveltekit',
+      type: 'auto.function.sveltekit.load',
       handled: false,
-      data: {
-        function: 'load',
-      },
     },
   });
 

packages/sveltekit/src/server-common/handleError.ts

@@ -36,7 +36,7 @@ export function handleErrorWithSentry(handleError?: HandleServerError): HandleSe
 
     captureException(input.error, {
       mechanism: {
-        type: 'sveltekit',
+        type: 'auto.function.sveltekit.handle_error',
         handled: !!handleError,
       },
     });

packages/sveltekit/src/server-common/serverRoute.ts

@@ -62,7 +62,7 @@ export function wrapServerRouteWithSentry<T extends RequestEvent>(
           () => wrappingTarget.apply(thisArg, args),
         );
       } catch (e) {
-        sendErrorToSentry(e, 'serverRoute');
+        sendErrorToSentry(e, 'server_route');
         throw e;
       } finally {
         await flushIfServerless();

packages/sveltekit/src/server-common/utils.ts

@@ -23,7 +23,7 @@ export function getTracePropagationData(event: RequestEvent): { sentryTrace: str
  *
  * @returns an objectified version of @param e
  */
-export function sendErrorToSentry(e: unknown, handlerFn: 'handle' | 'load' | 'serverRoute'): object {
+export function sendErrorToSentry(e: unknown, handlerFn: 'handle' | 'load' | 'server_route'): object {
   // In case we have a primitive, wrap it in the equivalent wrapper class (string -> String, etc.) so that we can
   // store a seen flag on it.
   const objectifiedErr = objectify(e);
@@ -42,11 +42,8 @@ export function sendErrorToSentry(e: unknown, handlerFn: 'handle' | 'load' | 'se
 
   captureException(objectifiedErr, {
     mechanism: {
-      type: 'sveltekit',
+      type: `auto.function.sveltekit.${handlerFn}`,
       handled: false,
-      data: {
-        function: handlerFn,
-      },
     },
   });
 

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

@@ -21,10 +21,6 @@ const navigationEvent: NavigationEvent = {
   url: new URL('http://example.org/users/123'),
 };
 
-const captureExceptionEventHint = {
-  mechanism: { handled: false, type: 'sveltekit' },
-};
-
 const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(_ => {});
 
 describe('handleError (client)', () => {
@@ -42,7 +38,9 @@ describe('handleError (client)', () => {
 
       expect(returnVal).not.toBeDefined();
       expect(mockCaptureException).toHaveBeenCalledTimes(1);
-      expect(mockCaptureException).toHaveBeenCalledWith(mockError, captureExceptionEventHint);
+      expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
+        mechanism: { handled: false, type: 'auto.function.sveltekit.handle_error' },
+      });
       // The default handler logs the error to the console
       expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
     });
@@ -56,7 +54,7 @@ describe('handleError (client)', () => {
       expect(returnVal.message).toEqual('Whoops!');
       expect(mockCaptureException).toHaveBeenCalledTimes(1);
       expect(mockCaptureException).toHaveBeenCalledWith(mockError, {
-        mechanism: { handled: true, type: 'sveltekit' },
+        mechanism: { handled: true, type: 'auto.function.sveltekit.handle_error' },
       });
 
       // Check that the default handler wasn't invoked

packages/sveltekit/test/client/load.test.ts

@@ -154,7 +154,7 @@ describe('wrapLoadWithSentry', () => {
 
     expect(mockCaptureException).toHaveBeenCalledTimes(1);
     expect(mockCaptureException).toHaveBeenCalledWith(expect.any(Error), {
-      mechanism: { handled: false, type: 'sveltekit', data: { function: 'load' } },
+      mechanism: { handled: false, type: 'auto.function.sveltekit.load' },
     });
   });
 

packages/sveltekit/test/server-common/handle.test.ts

@@ -317,7 +317,7 @@ describe('sentryHandle', () => {
       } catch (e) {
         expect(mockCaptureException).toBeCalledTimes(1);
         expect(mockCaptureException).toBeCalledWith(expect.any(Error), {
-          mechanism: { handled: false, type: 'sveltekit', data: { function: 'handle' } },
+          mechanism: { handled: false, type: 'auto.function.sveltekit.handle' },
         });
       }
     });