Merge pull request #9009 from getsentry/prepare-release/7.69.0

meta(changelog): Update changelog for 7.69.0

Author: mydea

.github/workflows/build.yml

@@ -789,9 +789,11 @@ jobs:
             'create-remix-app',
             'nextjs-app-dir',
             'react-create-hash-router',
+            'react-router-6-use-routes',
             'standard-frontend-react',
             'standard-frontend-react-tracing-import',
             'sveltekit',
+            'generic-ts3.8',
           ]
         build-command:
           - false
@@ -818,7 +820,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v3
         with:
-          node-version-file: 'package.json'
+          node-version-file: 'packages/e2e-tests/package.json'
       - name: Restore caches
         uses: ./.github/actions/restore-cache
         env:
@@ -833,7 +835,7 @@ jobs:
       - name: Get node version
         id: versions
         run: |
-          echo "echo node=$(jq -r '.volta.node' package.json)" >> $GITHUB_OUTPUT
+          echo "echo node=$(jq -r '.volta.node' packages/e2e-tests/package.json)" >> $GITHUB_OUTPUT
 
       - name: Validate Verdaccio
         run: yarn test:validate

CHANGELOG.md

@@ -4,6 +4,93 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+## 7.69.0
+
+### Important Changes
+
+- **New Performance APIs**
+  - feat: Update span performance API names (#8971)
+  - feat(core): Introduce startSpanManual (#8913)
+
+This release introduces a new set of top level APIs for the Performance Monitoring SDKs. These aim to simplify creating spans and reduce the boilerplate needed for performance instrumentation. The three new methods introduced are `Sentry.startSpan`, `Sentry.startInactiveSpan`, and `Sentry.startSpanManual`. These methods are available in the browser and node SDKs.
+
+`Sentry.startSpan` wraps a callback in a span. The span is automatically finished when the callback returns. This is the recommended way to create spans.
+
+```js
+// Start a span that tracks the duration of expensiveFunction
+const result = Sentry.startSpan({ name: 'important function' }, () => {
+  return expensiveFunction();
+});
+
+// You can also mutate the span wrapping the callback to set data or status
+Sentry.startSpan({ name: 'important function' }, (span) => {
+  // span is undefined if performance monitoring is turned off or if
+  // the span was not sampled. This is done to reduce overhead.
+  span?.setData('version', '1.0.0');
+  return expensiveFunction();
+});
+```
+
+If you don't want the span to finish when the callback returns, use `Sentry.startSpanManual` to control when the span is finished. This is useful for event emitters or similar.
+
+```js
+// Start a span that tracks the duration of middleware
+function middleware(_req, res, next) {
+  return Sentry.startSpanManual({ name: 'middleware' }, (span, finish) => {
+    res.once('finish', () => {
+      span?.setHttpStatus(res.status);
+      finish();
+    });
+    return next();
+  });
+}
+```
+
+`Sentry.startSpan` and `Sentry.startSpanManual` create a span and make it active for the duration of the callback. Any spans created while this active span is running will be added as a child span to it. If you want to create a span without making it active, use `Sentry.startInactiveSpan`. This is useful for creating parallel spans that are not related to each other.
+
+```js
+const span1 = Sentry.startInactiveSpan({ name: 'span1' });
+
+someWork();
+
+const span2 = Sentry.startInactiveSpan({ name: 'span2' });
+
+moreWork();
+
+const span3 = Sentry.startInactiveSpan({ name: 'span3' });
+
+evenMoreWork();
+
+span1?.finish();
+span2?.finish();
+span3?.finish();
+```
+
+### Other Changes
+
+- feat(core): Export `BeforeFinishCallback` type (#8999)
+- build(eslint): Enforce that ts-expect-error is used (#8987)
+- feat(integration): Ensure `LinkedErrors` integration runs before all event processors (#8956)
+- feat(node-experimental): Keep breadcrumbs on transaction (#8967)
+- feat(redux): Add 'attachReduxState' option  (#8953)
+- feat(remix): Accept `org`, `project` and `url` as args to upload script (#8985)
+- fix(utils): Prevent iterating over VueViewModel (#8981)
+- fix(utils): uuidv4 fix for cloudflare (#8968)
+- fix(core): Always use event message and exception values for `ignoreErrors` (#8986)
+- fix(nextjs): Add new potential location for Next.js request AsyncLocalStorage (#9006)
+- fix(node-experimental): Ensure we only create HTTP spans when outgoing (#8966)
+- fix(node-experimental): Ignore OPTIONS & HEAD requests (#9001)
+- fix(node-experimental): Ignore outgoing Sentry requests (#8994)
+- fix(node-experimental): Require parent span for `pg` spans (#8993)
+- fix(node-experimental): Use Sentry logger as Otel logger (#8960)
+- fix(node-otel): Refactor OTEL span reference cleanup (#9000)
+- fix(react): Switch to props in `useRoutes` (#8998)
+- fix(remix): Add `glob` to Remix SDK dependencies. (#8963)
+- fix(replay): Ensure `handleRecordingEmit` aborts when event is not added (#8938)
+- fix(replay): Fully stop & restart session when it expires (#8834)
+
+Work in this release contributed by @Duncanxyz and @malay44. Thank you for your contributions!
+
 ## 7.68.0
 
 - feat(browser): Add `BroadcastChannel` and `SharedWorker` to TryCatch EventTargets (#8943)

MIGRATION.md

@@ -1,6 +1,6 @@
 # Deprecations in 7.x
 
-You can use [@sentry/migr8](https://www.npmjs.com/package/@sentry/migr8) to automatically update your SDK usage and fix most deprecations:
+You can use the **Experimental** [@sentry/migr8](https://www.npmjs.com/package/@sentry/migr8) to automatically update your SDK usage and fix most deprecations. This requires Node 18+.
 
 ```bash
 npx @sentry/migr8@latest

packages/angular/src/tracing.ts

@@ -55,9 +55,7 @@ export function getActiveTransaction(): Transaction | undefined {
 
   if (currentHub) {
     const scope = currentHub.getScope();
-    if (scope) {
-      return scope.getTransaction();
-    }
+    return scope.getTransaction();
   }
 
   return undefined;

packages/angular/test/errorhandler.test.ts

@@ -532,7 +532,7 @@ describe('SentryErrorHandler', () => {
           }),
         };
 
-        // @ts-ignore this is a minmal hub, we're missing a few props but that's ok
+        // @ts-expect-error this is a minmal hub, we're missing a few props but that's ok
         jest.spyOn(SentryBrowser, 'getCurrentHub').mockImplementationOnce(() => {
           return { getClient: () => client };
         });

packages/browser-integration-tests/suites/replay/bufferMode/test.ts

@@ -68,7 +68,7 @@ sentryTest(
     expect(
       await page.evaluate(() => {
         const replayIntegration = (window as unknown as Window & { Replay: InstanceType<typeof Replay> }).Replay;
-        // @ts-ignore private
+        // @ts-expect-error private
         const replay = replayIntegration._replay;
         replayIntegration.startBuffering();
         return replay.isEnabled();
@@ -210,7 +210,7 @@ sentryTest(
     expect(
       await page.evaluate(() => {
         const replayIntegration = (window as unknown as Window & { Replay: InstanceType<typeof Replay> }).Replay;
-        // @ts-ignore private
+        // @ts-expect-error private
         const replay = replayIntegration._replay;
         replayIntegration.startBuffering();
         return replay.isEnabled();

packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/captureRequestBody/test.ts

@@ -41,7 +41,7 @@ sentryTest('captures text request body', async ({ getLocalTestPath, page, browse
       method: 'POST',
       body: 'input body',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -120,7 +120,7 @@ sentryTest('captures JSON request body', async ({ getLocalTestPath, page, browse
       method: 'POST',
       body: '{"foo":"bar"}',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -203,7 +203,7 @@ sentryTest('captures non-text request body', async ({ getLocalTestPath, page, br
       method: 'POST',
       body: body,
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -282,7 +282,7 @@ sentryTest('captures text request body when matching relative URL', async ({ get
       method: 'POST',
       body: 'input body',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -359,7 +359,7 @@ sentryTest('does not capture request body when URL does not match', async ({ get
       method: 'POST',
       body: 'input body',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */

packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/captureRequestHeaders/test.ts

@@ -38,7 +38,7 @@ sentryTest('handles empty/missing request headers', async ({ getLocalTestPath, p
     fetch('http://localhost:7654/foo', {
       method: 'POST',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -117,7 +117,7 @@ sentryTest('captures request headers as POJO', async ({ getLocalTestPath, page,
         'X-Test-Header': 'test-value',
       },
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -201,7 +201,7 @@ sentryTest('captures request headers on Request', async ({ getLocalTestPath, pag
     });
     /* eslint-disable */
     fetch(request).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -284,7 +284,7 @@ sentryTest('captures request headers as Headers instance', async ({ getLocalTest
       method: 'POST',
       headers,
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -367,7 +367,7 @@ sentryTest('does not captures request headers if URL does not match', async ({ g
         'X-Test-Header': 'test-value',
       },
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */

packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/captureRequestSize/test.ts

@@ -39,7 +39,7 @@ sentryTest('captures request body size when body is sent', async ({ getLocalTest
       method: 'POST',
       body: '{"foo":"bar"}',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -125,7 +125,7 @@ sentryTest('captures request size from non-text request body', async ({ getLocal
       method: 'POST',
       body: blob,
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */

packages/browser-integration-tests/suites/replay/extendNetworkBreadcrumbs/fetch/captureResponseBody/test.ts

@@ -41,7 +41,7 @@ sentryTest('captures text response body', async ({ getLocalTestPath, page, brows
     fetch('http://localhost:7654/foo', {
       method: 'POST',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -122,7 +122,7 @@ sentryTest('captures JSON response body', async ({ getLocalTestPath, page, brows
     fetch('http://localhost:7654/foo', {
       method: 'POST',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -203,7 +203,7 @@ sentryTest('captures non-text response body', async ({ getLocalTestPath, page, b
     fetch('http://localhost:7654/foo', {
       method: 'POST',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */
@@ -282,7 +282,7 @@ sentryTest('does not capture response body when URL does not match', async ({ ge
     fetch('http://localhost:7654/bar', {
       method: 'POST',
     }).then(() => {
-      // @ts-ignore Sentry is a global
+      // @ts-expect-error Sentry is a global
       Sentry.captureException('test error');
     });
     /* eslint-enable */