getsentry · Lms24 · Dec 22, 2023 · Dec 21, 2023 · Dec 21, 2023 · Dec 21, 2023
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/basic/subject.js b/packages/browser-integration-tests/suites/public-api/startSpan/basic/subject.js
@@ -0,0 +1,9 @@
+async function run() {
+  Sentry.startSpan({ name: 'parent_span' }, () => {
+    Sentry.startSpan({ name: 'child_span' }, () => {
+      // whatever a user would do here
+    });
+  });
+}
+
+run();
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/basic/test.ts b/packages/browser-integration-tests/suites/public-api/startSpan/basic/test.ts
@@ -0,0 +1,34 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/types';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest('should send a transaction in an envelope', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipTracingTest()) {
+    sentryTest.skip();
+  }
+
+  const url = await getLocalTestPath({ testDir: __dirname });
+  const transaction = await getFirstSentryEnvelopeRequest<Event>(page, url);
+
+  expect(transaction.transaction).toBe('parent_span');
+  expect(transaction.spans).toBeDefined();
+});
+
+sentryTest('should report finished spans as children of the root transaction', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipTracingTest()) {
+    sentryTest.skip();
+  }
+
+  const url = await getLocalTestPath({ testDir: __dirname });
+  const transaction = await getFirstSentryEnvelopeRequest<Event>(page, url);
+
+  const rootSpanId = transaction?.contexts?.trace?.spanId;
+
+  expect(transaction.spans).toHaveLength(1);
+
+  const span_1 = transaction.spans?.[0];
+  expect(span_1?.description).toBe('child_span');
+  expect(span_1?.parentSpanId).toEqual(rootSpanId);
+});
diff --git a/...es/browser-integration-tests/suites/public-api/startSpan/error-async-reject/template.html b/...es/browser-integration-tests/suites/public-api/startSpan/error-async-reject/template.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title></title>
+  </head>
+  <body>
+    <button id="button1" type="button">Button 1</button>
+
+    <script>
+      async function run() {
+        await Sentry.startSpan({ name: 'parent_span', op: 'test' }, async () => {
+          Promise.reject('Async Promise Rejection');
+        });
+      }
+
+      const button = document.getElementById('button1');
+      button.addEventListener('click', async () => {
+        await run();
+      });
+    </script>
+  </body>
+</html>
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/error-async-reject/test.ts b/packages/browser-integration-tests/suites/public-api/startSpan/error-async-reject/test.ts
@@ -0,0 +1,30 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/types';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getMultipleSentryEnvelopeRequests, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest(
+  'should capture a promise rejection within an async startSpan callback',
+  async ({ getLocalTestPath, page }) => {
+    if (shouldSkipTracingTest()) {
+      sentryTest.skip();
+    }
+
+    const url = await getLocalTestPath({ testDir: __dirname });
+    const envelopePromise = getMultipleSentryEnvelopeRequests<Event>(page, 2);
+
+    await page.goto(url);
+
+    const clickPromise = page.getByText('Button 1').click();
+
+    const [, events] = await Promise.all([clickPromise, envelopePromise]);
+    const [txn, err] = events[0]?.type === 'transaction' ? [events[0], events[1]] : [events[1], events[0]];
+
+    expect(txn).toMatchObject({ transaction: 'parent_span' });
+
+    expect(err?.exception?.values?.[0]?.value).toBe(
+      'Non-Error promise rejection captured with value: Async Promise Rejection',
+    );
+  },
+);
diff --git a/.../browser-integration-tests/suites/public-api/startSpan/error-async-throw-ii/template.html b/.../browser-integration-tests/suites/public-api/startSpan/error-async-throw-ii/template.html
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title></title>
+  </head>
+  <body>
+    <button id="button1" type="button">Button 1</button>
+
+    <script type="module">
+      async function run() {
+        Sentry.startSpan({ name: 'parent_span', op: 'test' }, async () => {
+          console.log('throwing error')
+          throw new Error('Async Thrown Error');
+        });
+      }
+
+      const button = document.getElementById('button1');
+      button.addEventListener('click', () => {
+        void run();
+        console.log('click');
+      });
+    </script>
+  </body>
+</html>
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/error-async-throw-ii/test.ts b/packages/browser-integration-tests/suites/public-api/startSpan/error-async-throw-ii/test.ts
@@ -0,0 +1,27 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/types';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getMultipleSentryEnvelopeRequests, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest(
+  "should capture a thrown error within an async startSpan callback that's not awaited properly",
+  async ({ getLocalTestPath, page }) => {
+    if (shouldSkipTracingTest()) {
+      sentryTest.skip();
+    }
+    const envelopePromise = getMultipleSentryEnvelopeRequests<Event>(page, 2);
+
+    const url = await getLocalTestPath({ testDir: __dirname });
+    await page.goto(url);
+
+    const clickPromise = page.getByText('Button 1').click();
+
+    // awaiting both events simultaneously to avoid race conditions
+    const [, events] = await Promise.all([clickPromise, envelopePromise]);
+    const [txn, err] = events[0]?.type === 'transaction' ? [events[0], events[1]] : [events[1], events[0]];
+
+    expect(txn).toMatchObject({ transaction: 'parent_span' });
+    expect(err?.exception?.values?.[0]?.value).toBe('Async Thrown Error');
+  },
+);
diff --git a/...ges/browser-integration-tests/suites/public-api/startSpan/error-async-throw/template.html b/...ges/browser-integration-tests/suites/public-api/startSpan/error-async-throw/template.html
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title></title>
+  </head>
+  <body>
+    <button id="button1" type="button">Button 1</button>
+
+    <script type="module">
+      async function run() {
+        await Promise.resolve();
+        await Sentry.startSpan({ name: 'parent_span', op: 'test' }, async () => {
+          console.log('throwing error')
+          throw new Error('Async Thrown Error');
+        });
+      }
+
+      const button = document.getElementById('button1');
+      button.addEventListener('click', () => {
+        void run();
+        console.log('click');
+      });
+    </script>
+  </body>
+</html>
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/error-async-throw/test.ts b/packages/browser-integration-tests/suites/public-api/startSpan/error-async-throw/test.ts
@@ -0,0 +1,24 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/types';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getMultipleSentryEnvelopeRequests, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest('should capture a thrown error within an async startSpan callback', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipTracingTest()) {
+    sentryTest.skip();
+  }
+  const envelopePromise = getMultipleSentryEnvelopeRequests<Event>(page, 2);
+
+  const url = await getLocalTestPath({ testDir: __dirname });
+  await page.goto(url);
+
+  const clickPromise = page.getByText('Button 1').click();
+
+  // awaiting both events simultaneously to avoid race conditions
+  const [, events] = await Promise.all([clickPromise, envelopePromise]);
+  const [txn, err] = events[0]?.type === 'transaction' ? [events[0], events[1]] : [events[1], events[0]];
+
+  expect(txn).toMatchObject({ transaction: 'parent_span' });
+  expect(err?.exception?.values?.[0]?.value).toBe('Async Thrown Error');
+});
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/error-sync/subject.js b/packages/browser-integration-tests/suites/public-api/startSpan/error-sync/subject.js
@@ -0,0 +1,9 @@
+function run() {
+  Sentry.startSpan({ name: 'parent_span' }, () => {
+    throw new Error('Sync Error');
+  });
+}
+
+// using `setTimeout` here because otherwise the thrown error will be
+// thrown as a generic "Script Error." instead of the actual error".
+setTimeout(run);
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/error-sync/test.ts b/packages/browser-integration-tests/suites/public-api/startSpan/error-sync/test.ts
@@ -0,0 +1,22 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/types';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getMultipleSentryEnvelopeRequests, shouldSkipTracingTest } from '../../../../utils/helpers';
+
+sentryTest('should capture an error within a sync startSpan callback', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipTracingTest()) {
+    sentryTest.skip();
+  }
+
+  const url = await getLocalTestPath({ testDir: __dirname });
+  const gotoPromise = page.goto(url);
+  const envelopePromise = getMultipleSentryEnvelopeRequests<Event>(page, 2);
+
+  const [_, events] = await Promise.all([gotoPromise, envelopePromise]);
+
+  const [txn, err] = events[0]?.type === 'transaction' ? [events[0], events[1]] : [events[1], events[0]];
+
+  expect(txn).toMatchObject({ transaction: 'parent_span' });
+  expect(err?.exception?.values?.[0]?.value).toBe('Sync Error');
+});
diff --git a/packages/browser-integration-tests/suites/public-api/startSpan/init.js b/packages/browser-integration-tests/suites/public-api/startSpan/init.js
@@ -0,0 +1,10 @@
+import * as Sentry from '@sentry/browser';
+// eslint-disable-next-line no-unused-vars
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  tracesSampleRate: 1.0,
+  normalizeDepth: 10,
+});
diff --git a/packages/core/src/tracing/trace.ts b/packages/core/src/tracing/trace.ts
@@ -55,23 +55,25 @@ export function trace<T>(
   }
 
   if (isThenable(maybePromiseResult)) {
-    Promise.resolve(maybePromiseResult).then(
-      () => {
+    // @ts-expect-error - the isThenable check returns the "wrong" type here
+    return maybePromiseResult.then(
+      res => {
         finishAndSetSpan();
         afterFinish();
+        return res;
       },
       e => {
         activeSpan && activeSpan.setStatus('internal_error');
         onError(e, activeSpan);
         finishAndSetSpan();
         afterFinish();
+        throw e;
       },
     );
-  } else {
-    finishAndSetSpan();
-    afterFinish();
   }
 
+  finishAndSetSpan();
+  afterFinish();
   return maybePromiseResult;
 }
 
@@ -89,6 +91,7 @@ export function trace<T>(
 export function startSpan<T>(context: TransactionContext, callback: (span: Span | undefined) => T): T {
   const ctx = normalizeContext(context);
 
+  // @ts-expect-error - isThenable returns the wrong type
   return withScope(scope => {
     const hub = getCurrentHub();
     const parentSpan = scope.getSpan();
@@ -110,19 +113,20 @@ export function startSpan<T>(context: TransactionContext, callback: (span: Span
     }
 
     if (isThenable(maybePromiseResult)) {
-      Promise.resolve(maybePromiseResult).then(
-        () => {
+      return maybePromiseResult.then(
+        res => {
           finishAndSetSpan();
+          return res;
         },
-        () => {
+        e => {
           activeSpan && activeSpan.setStatus('internal_error');
           finishAndSetSpan();
+          throw e;
         },
       );
-    } else {
-      finishAndSetSpan();
     }
 
+    finishAndSetSpan();
     return maybePromiseResult;
   });
 }
@@ -149,6 +153,7 @@ export function startSpanManual<T>(
 ): T {
   const ctx = normalizeContext(context);
 
+  // @ts-expect-error - isThenable returns the wrong type
   return withScope(scope => {
     const hub = getCurrentHub();
     const parentSpan = scope.getSpan();
@@ -169,9 +174,13 @@ export function startSpanManual<T>(
     }
 
     if (isThenable(maybePromiseResult)) {
-      Promise.resolve(maybePromiseResult).then(undefined, () => {
-        activeSpan && activeSpan.setStatus('internal_error');
-      });
+      return maybePromiseResult.then(
+        res => res,
+        e => {
+          activeSpan && activeSpan.setStatus('internal_error');
+          throw e;
+        },
+      );
     }
 
     return maybePromiseResult;