feat: Read `sentry.options.json` during cocoa init #4447

krystofwoldrich · 2025-01-15T10:26:37Z

📢 Type of change

New feature

⛓️ PR Chain

📜 Description

This PR adds [RNSentrySDK start] function (exported by RNSentry/RNSentry.h) which allows users to initialize Sentry Cocoa in RN applications without any additional params because the options are loaded from sentry.options.json.

This PR adds automatic copy of sentry.options.json resource from root of the RN project. This works as long as users setuped sentry-xcode.sh on their Bundle RN build phase.

💡 Motivation and Context

Initialize native SDKs before JS #3608

💚 How did you test it?

Only in Sample app for now, tests will follow.

📝 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

… on iOS

…platforms`

github-actions · 2025-01-15T10:27:04Z

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

Generated by 🚫 dangerJS against 7eb1786

github-actions · 2025-01-15T10:52:33Z

Android (new) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	650.96 ms	736.00 ms	85.04 ms
Size	7.15 MiB	8.38 MiB	1.23 MiB

Baseline results on branch: kw-add-react-native-ios-manual-init

Startup times

Revision	Plain	With Sentry	Diff
`a1ab76a`+dirty	412.92 ms	538.19 ms	125.27 ms

App size

Revision	Plain	With Sentry	Diff
`a1ab76a`+dirty	7.15 MiB	8.38 MiB	1.23 MiB

Previous results on branch: kw-add-read-ios-options-file

Startup times

Revision	Plain	With Sentry	Diff
`eda229b`+dirty	424.00 ms	469.60 ms	45.60 ms

App size

Revision	Plain	With Sentry	Diff
`eda229b`+dirty	7.15 MiB	8.38 MiB	1.23 MiB

github-actions · 2025-01-15T10:57:59Z

iOS (legacy) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1227.22 ms	1229.13 ms	1.90 ms
Size	2.63 MiB	3.69 MiB	1.05 MiB

Baseline results on branch: capture-app-start-errors

Startup times

Revision	Plain	With Sentry	Diff
`555070f`+dirty	1213.59 ms	1217.79 ms	4.20 ms
`208f4af`+dirty	1209.44 ms	1217.13 ms	7.70 ms

App size

Revision	Plain	With Sentry	Diff
`555070f`+dirty	2.63 MiB	3.69 MiB	1.05 MiB
`208f4af`+dirty	2.63 MiB	3.69 MiB	1.05 MiB

Previous results on branch: kw-add-read-ios-options-file

Startup times

Revision	Plain	With Sentry	Diff
`4682761`+dirty	1219.41 ms	1228.23 ms	8.82 ms
`eda229b`+dirty	1224.98 ms	1225.46 ms	0.48 ms

App size

Revision	Plain	With Sentry	Diff
`4682761`+dirty	2.63 MiB	3.69 MiB	1.05 MiB
`eda229b`+dirty	2.63 MiB	3.69 MiB	1.05 MiB

github-actions · 2025-01-15T11:04:07Z

iOS (new) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1218.25 ms	1216.94 ms	-1.31 ms
Size	3.19 MiB	4.25 MiB	1.07 MiB

Baseline results on branch: capture-app-start-errors

Startup times

Revision	Plain	With Sentry	Diff
`555070f`+dirty	1223.61 ms	1227.57 ms	3.96 ms
`208f4af`+dirty	1213.08 ms	1223.82 ms	10.73 ms

App size

Revision	Plain	With Sentry	Diff
`555070f`+dirty	3.19 MiB	4.25 MiB	1.06 MiB
`208f4af`+dirty	3.19 MiB	4.25 MiB	1.06 MiB

Previous results on branch: kw-add-read-ios-options-file

Startup times

Revision	Plain	With Sentry	Diff
`4682761`+dirty	1221.30 ms	1225.33 ms	4.03 ms
`eda229b`+dirty	1227.17 ms	1235.08 ms	7.91 ms

App size

Revision	Plain	With Sentry	Diff
`4682761`+dirty	3.19 MiB	4.25 MiB	1.07 MiB
`eda229b`+dirty	3.19 MiB	4.25 MiB	1.07 MiB

…to kw-add-read-ios-options-file

github-actions · 2025-01-15T13:47:28Z

Android (legacy) Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	483.20 ms	503.78 ms	20.59 ms
Size	17.75 MiB	20.11 MiB	2.37 MiB

Baseline results on branch: capture-app-start-errors

Startup times

Revision	Plain	With Sentry	Diff
`555070f`	438.67 ms	428.30 ms	-10.37 ms
`208f4af`	439.23 ms	427.31 ms	-11.92 ms

App size

Revision	Plain	With Sentry	Diff
`555070f`	17.75 MiB	20.11 MiB	2.37 MiB
`208f4af`	17.75 MiB	20.11 MiB	2.37 MiB

Previous results on branch: kw-add-read-ios-options-file

Startup times

Revision	Plain	With Sentry	Diff
`4682761`	398.02 ms	424.46 ms	26.44 ms
`eda229b`	461.02 ms	578.98 ms	117.96 ms

App size

Revision	Plain	With Sentry	Diff
`4682761`	17.75 MiB	20.11 MiB	2.37 MiB
`eda229b`	17.75 MiB	20.11 MiB	2.37 MiB

brustolin

ObjC code looks good.

…l-init

…os-options-file

antonis

The code looks good and the sample app worked as expected for me with [RNSentrySDK start] 🚀
Thank you for the added tests 🙇

…w-add-read-ios-options-file

…to kw-add-read-ios-options-file

krystofwoldrich added 16 commits January 14, 2025 13:47

chore: Initialize RNSentryTimeToDisplay during native module init…

4328298

… on iOS

ref(ios): Extract Cocoa SDK init into standalone file

27d76de

fix lint

5a28c03

rename rnsentrysdk to rnsentrystart

8b67bf1

rename class name also to rnsentrystart, fix tests

05cef29

explicitly import only used classes

778478f

fix call cocoa start not itself

3d3d0b4

also extract didBecomeActive notification

e2e40fa

add explanation comment to native crash handling

83106a7

explain notification purpose

742f28c

fix sdk name

4897aa3

fix native sdk not react native package

d37ebdd

fix lint sentry start

13a0b89

add changelog

d7270b1

feat(experimental): Add native startWithConfigureOptions for Apple …

580590b

…platforms`

feat: Read sentry.options.json during cocoa init

2cc92f2

Update CHANGELOG.md

592b903

krystofwoldrich added 2 commits January 15, 2025 14:33

remove global processor

a2717bd

Merge remote-tracking branch 'origin/kw-add-read-ios-options-file' in…

5ecd6b2

…to kw-add-read-ios-options-file

krystofwoldrich requested review from brustolin, philipphofmann and philprime January 15, 2025 13:44

Update code docs for start methods

890133a

brustolin reviewed Jan 17, 2025

View reviewed changes

Merge branch 'main' into kw-ref-ios-sdk-init

2d021e8

krystofwoldrich added 4 commits January 20, 2025 15:48

fix lint

cfc6293

remove unused rnSentry

f2a041e

fix changelog

fc4ff7e

Merge branch 'kw-ref-ios-sdk-init' into kw-add-react-native-ios-manua…

879044f

…l-init

krystofwoldrich mentioned this pull request Jan 20, 2025

feat(experimental): Add native startWithConfigureOptions for Apple platforms #4444

Merged

7 tasks

krystofwoldrich added 7 commits January 20, 2025 18:57

wip! add manual init tests

dec9869

add tests

22e88c7

Merge branch 'kw-add-react-native-ios-manual-init' into kw-add-read-i…

4ac4896

…os-options-file

add tests

1baac18

remove unavailable and unused global events processors import

f92edd9

Merge branch 'kw-add-react-native-ios-manual-init' into kw-add-read-i…

2662dbd

…os-options-file

fix c-format

7baad41

krystofwoldrich marked this pull request as ready for review January 21, 2025 16:16

krystofwoldrich requested review from antonis and lucas-zimerman as code owners January 21, 2025 16:16

krystofwoldrich requested a review from brustolin January 21, 2025 16:16

antonis approved these changes Jan 22, 2025

View reviewed changes

remove old sentry-cocoa init code

6d81a10

Base automatically changed from kw-add-react-native-ios-manual-init to capture-app-start-errors January 22, 2025 13:24

krystofwoldrich added 3 commits January 22, 2025 16:49

Merge remote-tracking branch 'origin/capture-app-start-errors' into k…

92c32e9

…w-add-read-ios-options-file

Merge remote-tracking branch 'origin/kw-add-read-ios-options-file' in…

dcfdc6c

…to kw-add-read-ios-options-file

fix copy options json only if destination set and file exists

7eb1786

krystofwoldrich merged commit 7850677 into capture-app-start-errors Jan 22, 2025
65 of 66 checks passed

krystofwoldrich deleted the kw-add-read-ios-options-file branch January 22, 2025 16:55

Uh oh!

feat: Read sentry.options.json during cocoa init #4447

feat: Read sentry.options.json during cocoa init #4447

Uh oh!

Conversation

krystofwoldrich commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📢 Type of change

⛓️ PR Chain

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Android (new) Performance metrics 🚀

Baseline results on branch: kw-add-react-native-ios-manual-init

Startup times

App size

Previous results on branch: kw-add-read-ios-options-file

Startup times

App size

Uh oh!

github-actions bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

iOS (legacy) Performance metrics 🚀

Baseline results on branch: capture-app-start-errors

Startup times

App size

Previous results on branch: kw-add-read-ios-options-file

Startup times

App size

Uh oh!

github-actions bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

iOS (new) Performance metrics 🚀

Baseline results on branch: capture-app-start-errors

Startup times

App size

Previous results on branch: kw-add-read-ios-options-file

Startup times

App size

Uh oh!

github-actions bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Android (legacy) Performance metrics 🚀

Baseline results on branch: capture-app-start-errors

Startup times

App size

Previous results on branch: kw-add-read-ios-options-file

Startup times

App size

Uh oh!

brustolin left a comment

Choose a reason for hiding this comment

Uh oh!

antonis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: Read `sentry.options.json` during cocoa init #4447

feat: Read `sentry.options.json` during cocoa init #4447

krystofwoldrich commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading