annotate more captureException calls, add a bunch of test assertions

Lms24 · Lms24 · commit 638238a3a306 · 2025-08-05T10:27:00.000+02:00
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-11/tests/cron-decorator.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-11/tests/cron-decorator.test.ts
@@ -71,6 +71,11 @@ test('Sends exceptions to Sentry on error in cron job', async ({ baseURL }) => {
 
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('Test error from cron job');
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.cron.nestjs.async',
+  });
+
   expect(errorEvent.contexts?.trace).toEqual({
     trace_id: expect.stringMatching(/[a-f0-9]{32}/),
     span_id: expect.stringMatching(/[a-f0-9]{16}/),
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-11/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-11/tests/errors.test.ts
@@ -13,6 +13,10 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
 
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
 
   expect(errorEvent.request).toEqual({
     method: 'GET',
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-8/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-8/tests/errors.test.ts
@@ -13,6 +13,10 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
 
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
 
   expect(errorEvent.request).toEqual({
     method: 'GET',
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-basic-with-graphql/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-basic-with-graphql/tests/errors.test.ts
@@ -14,6 +14,11 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
@@ -102,6 +107,11 @@ test('Sends graphql exception to Sentry', async ({ baseURL }) => {
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.graphql.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'POST',
     cookies: {},
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-basic/tests/cron-decorator.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-basic/tests/cron-decorator.test.ts
@@ -75,6 +75,11 @@ test('Sends exceptions to Sentry on error in async cron job', async ({ baseURL }
     span_id: expect.stringMatching(/[a-f0-9]{16}/),
   });
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.cron.nestjs.async',
+  });
+
   // kill cron so tests don't get stuck
   await fetch(`${baseURL}/kill-test-cron/test-async-cron-error`);
 });
@@ -92,6 +97,11 @@ test('Sends exceptions to Sentry on error in sync cron job', async ({ baseURL })
     span_id: expect.stringMatching(/[a-f0-9]{16}/),
   });
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.cron.nestjs',
+  });
+
   // kill cron so tests don't get stuck
   await fetch(`${baseURL}/kill-test-cron/test-sync-cron-error`);
 });
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-basic/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-basic/tests/errors.test.ts
@@ -13,6 +13,10 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
 
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
 
   expect(errorEvent.request).toEqual({
     method: 'GET',
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/tests/events.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/tests/events.test.ts
@@ -21,7 +21,10 @@ test('Event emitter', async () => {
         type: 'Error',
         value: 'Test error from event handler',
         stacktrace: expect.any(Object),
-        mechanism: expect.any(Object),
+        mechanism: {
+          handled: false,
+          type: 'auto.event.nestjs',
+        },
       },
     ],
   });
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/cron-decorator.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/cron-decorator.test.ts
@@ -71,6 +71,10 @@ test('Sends exceptions to Sentry on error in cron job', async ({ baseURL }) => {
 
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('Test error from cron job');
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.cron.nestjs.async',
+  });
   expect(errorEvent.contexts?.trace).toEqual({
     trace_id: expect.stringMatching(/[a-f0-9]{32}/),
     span_id: expect.stringMatching(/[a-f0-9]{16}/),
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/errors.test.ts
@@ -14,6 +14,11 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-graphql/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-graphql/tests/errors.test.ts
@@ -32,6 +32,11 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.graphql.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'POST',
     cookies: {},
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-with-submodules-decorator/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-with-submodules-decorator/tests/errors.test.ts
@@ -22,6 +22,11 @@ test('Sends unexpected exception to Sentry if thrown in module with global filte
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an uncaught exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.function.nestjs.exception_captured',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
@@ -59,6 +64,11 @@ test('Sends unexpected exception to Sentry if thrown in module with local filter
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an uncaught exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.function.nestjs.exception_captured',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
@@ -98,6 +108,11 @@ test('Sends unexpected exception to Sentry if thrown in module that was register
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an uncaught exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.function.nestjs.exception_captured',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
diff --git a/dev-packages/e2e-tests/test-applications/nestjs-with-submodules/tests/errors.test.ts b/dev-packages/e2e-tests/test-applications/nestjs-with-submodules/tests/errors.test.ts
@@ -14,6 +14,11 @@ test('Sends unexpected exception to Sentry if thrown in module with global filte
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an uncaught exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
@@ -43,6 +48,11 @@ test('Sends unexpected exception to Sentry if thrown in module with local filter
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an uncaught exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
@@ -74,6 +84,11 @@ test('Sends unexpected exception to Sentry if thrown in module that was register
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an uncaught exception!');
 
+  expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
+    handled: false,
+    type: 'auto.http.nestjs.global_filter',
+  });
+
   expect(errorEvent.request).toEqual({
     method: 'GET',
     cookies: {},
diff --git a/packages/nestjs/src/decorators.ts b/packages/nestjs/src/decorators.ts
@@ -19,12 +19,12 @@ export const SentryCron = (monitorSlug: string, monitorConfig?: MonitorConfig):
           try {
             result = originalMethod.apply(this, args);
           } catch (e) {
-            captureException(e);
+            captureException(e, { mechanism: { handled: false, type: 'auto.cron.nestjs' } });
             throw e;
           }
           if (isThenable(result)) {
             return result.then(undefined, e => {
-              captureException(e);
+              captureException(e, { mechanism: { handled: false, type: 'auto.cron.nestjs.async' } });
               throw e;
             });
           }
@@ -77,7 +77,7 @@ export function SentryExceptionCaptured() {
         return originalCatch.apply(this, [exception, host, ...args]);
       }
 
-      captureException(exception);
+      captureException(exception, { mechanism: { handled: false, type: 'auto.function.nestjs.exception_captured' } });
       return originalCatch.apply(this, [exception, host, ...args]);
     };
 
diff --git a/packages/nestjs/test/decorators.test.ts b/packages/nestjs/test/decorators.test.ts
@@ -275,7 +275,12 @@ describe('SentryExceptionCaptured decorator', () => {
     decoratedMethod(exception, host);
 
     expect(captureExceptionSpy).toHaveBeenCalledTimes(1);
-    expect(captureExceptionSpy).toHaveBeenCalledWith(exception);
+    expect(captureExceptionSpy).toHaveBeenCalledWith(exception, {
+      mechanism: {
+        handled: false,
+        type: 'auto.function.nestjs.exception_captured',
+      },
+    });
     expect(originalCatch).toHaveBeenCalledWith(exception, host);
 
     isExpectedErrorSpy.mockRestore();
