ref: SentryOptions in Swift

[noahsmartin]

This change may look big, but I've done everything that can be done to make it as small as possible. It only looks big because the generated API json file changed, the actual lines of code added are ~800. So many files were touched because I had to remove a bunch of imports of the objc class

This converts SentryOptions.h/.m to SentryOptions.swift and in doing so removes the last blocker for using SPM. It also cleans up a lot of gross bridging we had to do, like with SentryExperimentalOptions and the beforeSendLog callback. This is now replaced with one piece of cross bridging, which I'll get to later...

Almost all the relevant implementation here is in Options.swift. This matches the old ObjC API almost exactly, except that the class is now final. The API json file changed a lot structurally just because it represents Swift and ObjC differently, not because the actual API changed.

The tricky part of this is that we can't call an objc header that uses a swift type from Swift code. (This works in xcodebuild but not cocoapods/SPM) To work around this the value that gets passed toSentrySDKInternal needs to be type-erased. This is the same as what we had to do with types defined in Swift on SentryOptions.h prior to this PR. To make it easy to follow this change I've kept the Swift type almost everywhere, but in a few header files I had to use SentryOptionsObjc which is just an alias for NSObject. There are extensions at the end of Options.swift that explains what is done in more detail.

#skip-changelog

Closes #6690

[codecov]

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
3931	1	3930	55

View the top 1 failed test(s) by shortest run time

iOS_SwiftUI_UITests.FeedbackUITests::testWidgetDisplayInSwiftUIApp

Stack Traces | 0s run time

.../iOS-SwiftUI/iOS-SwiftUI-UITests/FeedbackUITests.swift:14 - Failed to get matching snapshots: Timed out while evaluating UI query.

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

[github-actions]

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1222.98 ms	1261.93 ms	38.96 ms
Size	23.75 KiB	1.01 MiB	1012.60 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
854ca12	1219.94 ms	1251.32 ms	31.38 ms
a6f5396	1211.81 ms	1245.63 ms	33.82 ms
d637379	1226.43 ms	1250.77 ms	24.34 ms
4a7a005	1229.15 ms	1243.35 ms	14.20 ms
d48a247	1243.59 ms	1273.27 ms	29.67 ms
079bcc8	1217.88 ms	1234.88 ms	17.00 ms
1fecbb8	1242.78 ms	1265.40 ms	22.62 ms
acac774	1217.76 ms	1253.29 ms	35.52 ms
2a6f451	1212.89 ms	1237.45 ms	24.56 ms
75b23cd	1227.10 ms	1253.61 ms	26.51 ms

App size

Revision	Plain	With Sentry	Diff
854ca12	23.74 KiB	996.96 KiB	973.22 KiB
a6f5396	23.75 KiB	989.12 KiB	965.38 KiB
d637379	23.75 KiB	855.38 KiB	831.63 KiB
4a7a005	23.75 KiB	979.96 KiB	956.22 KiB
d48a247	23.75 KiB	994.73 KiB	970.99 KiB
079bcc8	23.74 KiB	874.07 KiB	850.33 KiB
1fecbb8	23.75 KiB	969.28 KiB	945.53 KiB
acac774	23.75 KiB	866.51 KiB	842.76 KiB
2a6f451	23.75 KiB	913.13 KiB	889.38 KiB
75b23cd	23.75 KiB	933.66 KiB	909.92 KiB

Previous results on branch: optionsInSwift

Startup times

Revision	Plain	With Sentry	Diff
e2114d5	1216.94 ms	1237.02 ms	20.08 ms
b65d755	1234.36 ms	1258.38 ms	24.02 ms

App size

Revision	Plain	With Sentry	Diff
e2114d5	23.75 KiB	1.03 MiB	1.01 MiB
b65d755	23.75 KiB	1.03 MiB	1.01 MiB

[cursor]

Bug: Inconsistent beforeSendLog exposure Across Swift Packages

The beforeSendLog callback is still conditionally excluded from dictionary initialization when SWIFT_PACKAGE is defined (#if !SWIFT_PACKAGE), but the new Swift Options class (introduced in this PR) always exposes the beforeSendLog property without any conditional compilation. This creates an inconsistency where dictionary-based initialization (via SentryOptionsInternal.initWithDict) will not properly set the beforeSendLog callback when using Swift Package Manager, even though the property exists and is accessible on the Swift Options class. The #if !SWIFT_PACKAGE guard should be removed to match the Swift implementation.

Sources/Sentry/SentryOptionsInternal.m#L116-L120

sentry-cocoa/Sources/Sentry/SentryOptionsInternal.m

Lines 116 to 120 in 26bfb46

	#if !SWIFT_PACKAGE
	if ([self isBlock:options[@"beforeSendLog"]]) {
	sentryOptions.beforeSendLog = options[@"beforeSendLog"];
	}
	#endif // !SWIFT_PACKAGE

 

---

[github-actions]

🚨 Detected changes in high risk code 🚨

High-risk code can easily blow up and is hard to test. We had severe bugs in the past. Be extra careful when changing these files, and have an extra careful look at these:

• Sources/Sentry/SentryNetworkTracker.m
• Sources/Sentry/SentryUIViewControllerSwizzling.m