cleanup

Author: Lms24

dev-packages/browser-integration-tests/suites/public-api/withScope/throwError/test.ts

@@ -4,16 +4,30 @@ import type { Event } from '@sentry/types';
 import { sentryTest } from '../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';
 
-sentryTest('scope is applied to thrown error', async ({ getLocalTestPath, page }) => {
-  const url = await getLocalTestPath({ testDir: __dirname });
+/**
+ * Why does this test exist?
+ *
+ * We recently discovered that errors caught by global handlers will potentially loose scope data from the active scope
+ * where the error was thrown in. The simple example in this test (see subject.ts) demonstrates this behavior (in a
+ * browser environment but the same behavior applies to the server; see the test there).
+ *
+ * This test nevertheless covers the behavior so that we're aware.
+ */
+sentryTest(
+  'withScope scope is NOT applied to thrown error caught by global handler',
+  async ({ getLocalTestPath, page }) => {
+    const url = await getLocalTestPath({ testDir: __dirname });
 
-  const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);
+    const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);
 
-  const ex = eventData.exception?.values ? eventData.exception.values[0] : undefined;
+    const ex = eventData.exception?.values ? eventData.exception.values[0] : undefined;
 
-  expect(eventData.tags).toMatchObject({
-    global: 'tag',
-    local: 'tag', // this tag is missing :(
-  });
-  expect(ex?.value).toBe('test error');
-});
+    // This tag is missing :(
+    expect(eventData.tags?.local).toBeUndefined();
+
+    expect(eventData.tags).toMatchObject({
+      global: 'tag',
+    });
+    expect(ex?.value).toBe('test error');
+  },
+);

dev-packages/node-integration-tests/suites/express/handle-error-withScope/server.ts

@@ -14,7 +14,7 @@ app.use(Sentry.Handlers.requestHandler());
 
 Sentry.setTag('global', 'tag');
 
-app.get('/test/express', () => {
+app.get('/test/withScope', () => {
   Sentry.withScope(scope => {
     scope.setTag('local', 'tag');
     throw new Error('test_error');

dev-packages/node-integration-tests/suites/express/handle-error-withScope/test.ts

@@ -4,6 +4,15 @@ afterAll(() => {
   cleanupChildProcesses();
 });
 
+/**
+ * Why does this test exist?
+ *
+ * We recently discovered that errors caught by global handlers will potentially loose scope data from the active scope
+ * where the error was originally thrown in. The simple example in this test (see subject.ts) demonstrates this behavior
+ * (in a Node environment but the same behavior applies to the browser; see the test there).
+ *
+ * This test nevertheless covers the behavior so that we're aware.
+ */
 test('applies withScope scope to thrown error', done => {
   const runner = createRunner(__dirname, 'server.ts')
     .ignore('session', 'sessions')
@@ -32,11 +41,11 @@ test('applies withScope scope to thrown error', done => {
         },
         tags: {
           global: 'tag',
-          local: 'tag', // This tag is missing :(
+          local: undefined, // This tag is missing :(
         },
       },
     })
     .start(done);
 
-  expect(() => runner.makeRequest('get', '/test/express')).rejects.toThrow();
+  expect(() => runner.makeRequest('get', '/test/withScope')).rejects.toThrow();
 });