feat: Bump to Sentry Javascript V9 #4568

lucas-zimerman · 2025-02-19T12:37:45Z

📢 Type of change

Bugfix
New feature
Enhancement
Refactoring

📜 Description

This PR bumps JavaScript to version V9 and also fixes any break changes found.
In short, normal users not experience any changes, as shown on the sample apps, there were no required changes for this bump.

Changes handled:

In regard to shutdownTimeout, we can keep it as an additional parameter or completely remove it if that is the plan.

💡 Motivation and Context

💚 How did you test it?

Sample App, CI, Sentry.io discover

📝 Checklist

I added tests to verify changes
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled
I updated the docs if needed.
I updated the wizard if needed.
All tests passing
No breaking changes

🔮 Next steps

Update Changelog with breakchanges.
Create Migration Doc.

#skip-changelog for now

github-actions · 2025-02-19T13:01:43Z

iOS (legacy) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1219.71 ms	1223.00 ms	3.29 ms
Size	2.63 MiB	3.73 MiB	1.10 MiB

Previous results on branch: lz/bump/jsv9

Startup times

Revision	Plain	With Sentry	Diff
`35eb9e7`+dirty	1213.46 ms	1221.42 ms	7.96 ms
`987dc4d`+dirty	1216.13 ms	1227.20 ms	11.08 ms
`e54b1ed`+dirty	1227.33 ms	1254.46 ms	27.14 ms
`71f7309`+dirty	1222.02 ms	1224.81 ms	2.79 ms
`345e497`+dirty	1218.83 ms	1218.73 ms	-0.10 ms

App size

Revision	Plain	With Sentry	Diff
`35eb9e7`+dirty	2.63 MiB	3.73 MiB	1.10 MiB
`987dc4d`+dirty	2.63 MiB	3.73 MiB	1.10 MiB
`e54b1ed`+dirty	2.63 MiB	3.68 MiB	1.05 MiB
`71f7309`+dirty	2.63 MiB	3.73 MiB	1.10 MiB
`345e497`+dirty	2.63 MiB	3.68 MiB	1.05 MiB

github-actions · 2025-02-19T13:26:37Z

Android (legacy) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	427.02 ms	451.34 ms	24.32 ms
Size	17.75 MiB	20.14 MiB	2.39 MiB

Previous results on branch: lz/bump/jsv9

Startup times

Revision	Plain	With Sentry	Diff
`987dc4d`	422.12 ms	478.34 ms	56.22 ms
`345e497`	397.98 ms	423.40 ms	25.42 ms
`35eb9e7`	383.45 ms	415.65 ms	32.21 ms
`71f7309`	412.45 ms	431.62 ms	19.18 ms
`e54b1ed`	434.79 ms	429.52 ms	-5.27 ms

App size

Revision	Plain	With Sentry	Diff
`987dc4d`	17.75 MiB	20.10 MiB	2.36 MiB
`345e497`	17.75 MiB	20.10 MiB	2.36 MiB
`35eb9e7`	17.75 MiB	20.10 MiB	2.36 MiB
`71f7309`	17.75 MiB	20.10 MiB	2.36 MiB
`e54b1ed`	17.75 MiB	20.10 MiB	2.36 MiB

github-actions · 2025-02-19T13:36:43Z

Android (new) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	382.61 ms	384.00 ms	1.39 ms
Size	7.15 MiB	8.40 MiB	1.25 MiB

Previous results on branch: lz/bump/jsv9

Startup times

Revision	Plain	With Sentry	Diff
`987dc4d`+dirty	411.89 ms	418.60 ms	6.71 ms
`35eb9e7`+dirty	426.84 ms	453.53 ms	26.69 ms
`71f7309`+dirty	361.15 ms	369.90 ms	8.75 ms
`345e497`+dirty	375.33 ms	377.23 ms	1.90 ms
`e54b1ed`+dirty	435.06 ms	429.19 ms	-5.87 ms

App size

Revision	Plain	With Sentry	Diff
`987dc4d`+dirty	7.15 MiB	8.37 MiB	1.22 MiB
`35eb9e7`+dirty	7.15 MiB	8.37 MiB	1.22 MiB
`71f7309`+dirty	7.15 MiB	8.37 MiB	1.22 MiB
`345e497`+dirty	7.15 MiB	8.37 MiB	1.22 MiB
`e54b1ed`+dirty	7.15 MiB	8.37 MiB	1.22 MiB

github-actions · 2025-02-19T13:48:55Z

iOS (new) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1219.63 ms	1222.88 ms	3.24 ms
Size	3.19 MiB	4.30 MiB	1.11 MiB

Previous results on branch: lz/bump/jsv9

Startup times

Revision	Plain	With Sentry	Diff
`35eb9e7`+dirty	1219.31 ms	1217.37 ms	-1.94 ms
`987dc4d`+dirty	1209.94 ms	1215.25 ms	5.31 ms
`e54b1ed`+dirty	1227.90 ms	1230.92 ms	3.02 ms
`71f7309`+dirty	1206.00 ms	1214.28 ms	8.28 ms
`345e497`+dirty	1210.67 ms	1207.50 ms	-3.17 ms

App size

Revision	Plain	With Sentry	Diff
`35eb9e7`+dirty	3.19 MiB	4.30 MiB	1.11 MiB
`987dc4d`+dirty	3.19 MiB	4.30 MiB	1.11 MiB
`e54b1ed`+dirty	3.19 MiB	4.25 MiB	1.06 MiB
`71f7309`+dirty	3.19 MiB	4.30 MiB	1.11 MiB
`345e497`+dirty	3.19 MiB	4.25 MiB	1.06 MiB

lucas-zimerman · 2025-02-24T14:31:54Z

I will wait for some information in regard to getsentry/sentry-javascript#15471 in case it's a problem on the JavaScript SDK

krystofwoldrich · 2025-02-25T10:21:46Z

@lucas-zimerman The yarn.lock seems to be completely regenerated.

How have you upgraded to the JS v9?

We should review it and ensure only the @sentry/* are upgraded to avoid issues like #4592

The yarn.lock change should be readable as only sentry deps should change.

lucas-zimerman · 2025-02-25T14:00:48Z

@lucas-zimerman The yarn.lock seems to be completely regenerated.

How have you upgraded to the JS v9?

We should review it and ensure only the @sentry/* are upgraded to avoid issues like #4592

The yarn.lock change should be readable as only sentry deps should change.

I fixed on 028dbf9, At the time there were a conflict with yarn.lock, and I created a new one. Next time I will get the target branch yarn.lock and install again on the PR

packages/core/package.json

krystofwoldrich · 2025-02-25T14:07:13Z

Thank you @lucas-zimerman, now the yarn.lock looks good.

packages/core/src/js/tracing/span.ts

lucas-zimerman · 2025-02-25T18:38:44Z

@antonis @krystofwoldrich I'd say now it's ready for review :D

packages/core/package.json

packages/core/src/js/integrations/reactnativeerrorhandlers.ts

github-actions · 2025-03-11T16:56:07Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 578ad2c

krystofwoldrich · 2025-03-12T17:53:56Z

CHANGELOG.md

+
+### Major Changes
+
+- Remove autoSessionTracking option


The Browser SDK now recommends directly using https://github.com/getsentry/sentry-javascript/blob/defeaaf99ff6180be714ae770ce1ed0da6243676/packages/browser/src/integrations/browsersession.ts#L12

RN SDK has also enableAutoSessionTracking

sentry-react-native/packages/core/src/js/options.ts

Line 45 in f8289de

enableAutoSessionTracking?: boolean;

autoSessionTracking and enableAutoSessionTracking were two unrelated flags.

We should make it clear to the users.

In regard to this, should we remove the integration autoSessionTracking when running natively?
Before it was only added when autoSessionTracking was added, but now its added by default.
We could exclude it when enableAutioSessionTracking is set to true and it's running on browser, what do you think?

Yes, makes sense, let's add the browserSessionIntegration when enableAutioSessionTracking and we are running in a browser.

We can also do this in a follow up PR.

CHANGELOG.md

packages/core/android/src/main/java/io/sentry/react/RNSentryModuleImpl.java

packages/core/package.json

krystofwoldrich · 2025-03-12T19:32:45Z

packages/core/src/js/sdk.tsx

@@ -157,6 +157,7 @@ export function wrap<P extends Record<string, unknown>>(
  const profilerProps = {
    ...(options?.profilerProps ?? {}),
    name: RootComponent.displayName ?? 'Root',
+    updateProps: {}


Is this required? I don't know the prop.

It was always required, but for for some reason it only started to complain once I started working on V9
https://github.com/getsentry/sentry-javascript/blob/6914a2453472b3683fe76e67e248414d7ec4ec06/packages/react/src/profiler.tsx#L24

Okay, I see, thank you for the details.

Could you open a follow-up PR with options?.profilerProps type update to exclude the update props and children. https://github.com/getsentry/sentry-javascript/blob/1048a437b09955d31118960624b6d58242389c45/packages/react/src/profiler.tsx#L158

packages/core/test/feedback.test.ts

packages/core/test/tracing/addTracingExtensions.test.ts

krystofwoldrich · 2025-03-12T19:48:11Z

packages/core/test/tracing/timetodisplaynative.web.test.tsx

-jest.mock('react-native', () => {
-  const RN = jest.requireActual('react-native');
-  RN.UIManager = {};
-  return RN;
-});
-


Was it just not needed or does it break the test after the JS SDK upgrade?

The test was failing with the mock

FAIL test/tracing/timetodisplaynative.web.test.tsx ● Test suite failed to run TypeError: Cannot set property UIManager of #<Object> which has only a getter 1 | jest.mock('react-native', () => { 2 | const RN = jest.requireActual('react-native'); > 3 | RN.UIManager = {}; | ^ 4 | return RN; 5 | }); 6 | jest.mock('../../src/js/utils/rnlibraries', () => { at test/tracing/timetodisplaynative.web.test.tsx:3:15 at Object.require (src/js/tracing/timetodisplaynative.tsx:3:1) at Object.<anonymous> (test/tracing/timetodisplaynative.web.test.tsx:13:1)

Since removing the mock made the error to not happen again I opted to not mock it.

The issue with removing the mock is that this test is now not ensuring the component is not throwing in react-native-web environment.

RN Web UIManager https://github.com/necolas/react-native-web/blob/fcbe2d1e9225282671e39f9f639e2cb04c7e1e65/packages/react-native-web/src/exports/UIManager/index.js#L55

has a different interface from the RN UIManager, for example, the hasViewManagerConfig doesn't exist there.

I would prefer to update the mock in a way so we avoid the type error but still ensure we test for the web env.

Maybe we can mock the whole RN object, instead of overwritting the UIManager property.

packages/core/test/utils/safe.test.ts

packages/core/test/tracing/integrations/userInteraction.test.ts

krystofwoldrich · 2025-03-12T19:57:53Z

Overall the PR looks good. Thank you for all the changes.

I have just a few suggestions and some questions to understand the v9 changes.

krystofwoldrich · 2025-03-20T10:58:32Z

Looks good, thank you for all the comments, changes and explanations.

Two things we should do in a follow-up PRs:

Update the type of options?.profilerProps feat: Bump to Sentry Javascript V9 #4568 (comment)
Auto add browserSessionIntegration feat: Bump to Sentry Javascript V9 #4568 (comment)
Use getMainCarrier feat: Bump to Sentry Javascript V9 #4568 (comment)

One item to finalize this PR:

Update the mock of the UIManager to test the RN Web version of the components. feat: Bump to Sentry Javascript V9 #4568 (comment)

krystofwoldrich · 2025-03-20T12:22:21Z

packages/core/src/js/transports/encodePolyfill.ts

@@ -6,7 +8,7 @@ export const useEncodePolyfill = (): void => {
    (RN_GLOBAL_OBJ.__SENTRY__ as Partial<(typeof RN_GLOBAL_OBJ)['__SENTRY__']>) = {};
  }

-  RN_GLOBAL_OBJ.__SENTRY__.encodePolyfill = encodePolyfill;
+  RN_GLOBAL_OBJ.__SENTRY__[SDK_VERSION].encodePolyfill = encodePolyfill;


The SDK_VERSION is created as a side effect of creating Sentry Logger (https://github.com/getsentry/sentry-javascript/blob/bf323b111b7e7b781e60e6299e432ce89f144970/packages/core/src/utils-hoist/logger.ts#L102)

But it's not guaranteed that it will exist.

We should use https://github.com/getsentry/sentry-javascript/blob/d773cb7324480ed3cffc14504f0e41951e344d19/packages/core/src/carrier.ts#L42

Also can be a follow up PR.

lucas-zimerman added 4 commits February 14, 2025 14:02

bump SDKs

04b6c06

bump SDKs

0dc4bca

fix build

382fef6

fix tests

33af36c

fix tests

ad6a76c

lucas-zimerman added 3 commits February 19, 2025 11:17

fix lint errors

15342a2

test ts 5.0

c267f9b

rollback

efea84f

antonis mentioned this pull request Feb 19, 2025

chore(deps): Fixes JS SDK v9 breakages #4566

Closed

10 tasks

lucas-zimerman added the Blocked label Feb 24, 2025

Merge branch 'v7' into lz/bump/jsv9

65a10d5

antonis mentioned this pull request Feb 25, 2025

chore(dep): fix expo sample version to 52.0.19 #4592

Closed

10 tasks

lucas-zimerman removed the Blocked label Feb 25, 2025

krystofwoldrich reviewed Feb 25, 2025

View reviewed changes

packages/core/package.json Show resolved Hide resolved

lucas-zimerman commented Feb 25, 2025

View reviewed changes

packages/core/src/js/tracing/span.ts Show resolved Hide resolved

lucas-zimerman added 2 commits February 25, 2025 13:16

fix merge conflict with yarn

028dbf9

fix new lint issue

a57459a

lucas-zimerman marked this pull request as ready for review February 25, 2025 18:37

lucas-zimerman requested a review from antonis as a code owner February 25, 2025 18:37

antonis reviewed Feb 26, 2025

View reviewed changes

packages/core/package.json Outdated Show resolved Hide resolved

antonis reviewed Feb 26, 2025

View reviewed changes

packages/core/src/js/integrations/reactnativeerrorhandlers.ts Outdated Show resolved Hide resolved

lucas-zimerman added 4 commits February 26, 2025 11:54

fix incorrect cli version

55c1961

fix lint

97853c6

Merge branch 'v7' into lz/bump/jsv9

dc2e123

remove shutdowntimeout from android / use newer wizard version

9a0b21e

lucas-zimerman requested a review from krystofwoldrich March 3, 2025 21:15

lucas-zimerman mentioned this pull request Mar 3, 2025

fix(sdk): Set {{auto}} if user.ip_address is undefined #4466

Open

10 tasks

krystofwoldrich changed the title ~~(WIP) Feat: Sentry Javascript V9~~ feat: Bump to Sentry Javascript V9 Mar 11, 2025