Skip to content

Commit dbdbfa7

Browse files
lforstandreiborza
andauthored
docs: Align migration guide with docs (#15324)
Co-authored-by: Andrei <[email protected]>
1 parent 54f56a9 commit dbdbfa7

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

MIGRATION.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ These docs walk through how to migrate our JavaScript SDKs through different maj
99

1010
# Upgrading from 8.x to 9.x
1111

12-
Version 9 of the Sentry JavaScript SDK concerns API cleanup and version support changes.
13-
This update contains behavioral changes that will not be caught by type checkers, linters or tests, so we recommend carefully reading through the entire migration guide instead of purely relying on automatic tooling.
12+
Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
13+
This update contains behavioral changes that will not be caught by type checkers, linters, or tests, so we recommend carefully reading through the entire migration guide instead of relying on automatic tooling.
1414

15-
`v9` of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v8).
15+
Version 9 of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v8).
1616
Lower versions may continue to work, but may not support all features.
1717

1818
## 1. Version Support Changes:
@@ -27,16 +27,16 @@ This includes features like Nullish Coalescing (`??`), Optional Chaining (`?.`),
2727
If you observe failures due to syntax or features listed above, it may indicate that your current runtime does not support ES2020.
2828
If your runtime does not support ES2020, we recommend transpiling the SDK using Babel or similar tooling.
2929

30-
**Node.js:** The minimum supported Node.js version is **18.0.0**, except for ESM-only SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`) which require Node.js version **18.19.1** or higher.
30+
**Node.js:** The minimum supported Node.js version is **18.0.0** (Released Apr 19, 2022), except for ESM-only SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`) which require Node.js version **18.19.1** (Released Feb 14, 2024) or higher.
3131

3232
**Browsers:** Due to SDK code now including ES2020 features, the minimum supported browser list now looks as follows:
3333

34-
- Chrome 80
35-
- Edge 80
36-
- Safari 14, iOS Safari 14.4
37-
- Firefox 74
38-
- Opera 67
39-
- Samsung Internet 13.0
34+
- Chrome 80 (Released Feb 5, 2020)
35+
- Edge 80 (Released Feb 7, 2020)
36+
- Safari 14, iOS Safari 14.4 (Released Sep 16, 2020)
37+
- Firefox 74 (Released Mar 10, 2020)
38+
- Opera 67 (Released Mar 12, 2020)
39+
- Samsung Internet 13.0 (Released Nov 20, 2020)
4040

4141
If you need to support older browsers, we recommend transpiling your code using SWC, Babel or similar tooling.
4242

@@ -54,11 +54,11 @@ Support for the following frameworks and library versions are dropped:
5454

5555
### TypeScript Version Policy
5656

57-
In preparation for v2 of the OpenTelemetry SDK, which will raise the minimum required TypeScript version, the minimum required TypeScript version is increased to version `5.0.4`.
57+
In preparation for v2 of the OpenTelemetry SDK, the minimum required TypeScript version is increased to version `5.0.4`.
5858

5959
Additionally, like the OpenTelemetry SDK, the Sentry JavaScript SDK will follow [DefinitelyType's version support policy](https://github.com/DefinitelyTyped/DefinitelyTyped#support-window) which has a support time frame of 2 years for any released version of TypeScript.
6060

61-
Older Typescript versions _may_ continue to be compatible, but no guarantees apply.
61+
Older TypeScript versions _may_ continue to be compatible, but no guarantees apply.
6262

6363
### AWS Lambda Layer Changes
6464

@@ -90,7 +90,7 @@ The ARN will be published in the [Sentry docs](https://docs.sentry.io/platforms/
9090
While in v8, the passed scope was set active directly on the passed scope, in v9, the scope is cloned. This behavior change does not apply to `@sentry/node` where the scope was already cloned.
9191
This change was made to ensure that the span only remains active within the callback and to align behavior between `@sentry/node` and all other SDKs.
9292
As a result of the change, span hierarchy should be more accurate.
93-
However, modifying the scope (e.g. set tags) within the `startSpan` callback behaves a bit differently now.
93+
However, modifying the scope (for example, setting tags) within the `startSpan` callback behaves a bit differently now.
9494

9595
```js
9696
startSpan({ name: 'example', scope: customScope }, () => {
@@ -101,12 +101,12 @@ The ARN will be published in the [Sentry docs](https://docs.sentry.io/platforms/
101101
```
102102

103103
- Passing `undefined` as a `tracesSampleRate` option value will now be treated the same as if the attribute was not defined at all.
104-
In previous versions, it was checked whether the `tracesSampleRate` property existed in the SDK options to determine whether to propagate trace data for distributed tracing.
104+
In previous versions, it was checked whether the `tracesSampleRate` property existed in the SDK options to decide if trace data should be propagated for tracing.
105105
Consequentially, this sometimes caused the SDK to propagate negative sampling decisions when `tracesSampleRate: undefined` was passed.
106106
This is no longer the case and sampling decisions will be deferred to downstream SDKs for distributed tracing.
107107
This is more of a bugfix rather than a breaking change, however, depending on the setup of your SDKs, an increase in sampled traces may be observed.
108108

109-
- If you use the optional `captureConsoleIntegration` and set `attachStackTrace: true` in your `Sentry.init` call, console messages will no longer be marked as unhandled (i.e. `handled: false`) but as handled (i.e. `handled: true`).
109+
- If you use the optional `captureConsoleIntegration` and set `attachStackTrace: true` in your `Sentry.init` call, console messages will no longer be marked as unhandled (`handled: false`) but as handled (`handled: true`).
110110
If you want to keep sending them as unhandled, configure the `handled` option when adding the integration:
111111

112112
```js

0 commit comments

Comments
 (0)