refactor: Migrate SentryMsgPackSerializer from Objective-C to Swift #6143

philprime · 2025-09-11T09:57:11Z

Summary

This PR migrates the SentryMsgPackSerializer from Objective-C to Swift while maintaining 100% behavioral compatibility.

Changes Made

Complete Migration

Converted SentryMsgPackSerializer.m/.h to modular Swift implementation
Reorganized code into separate files in Sources/Swift/Tools/MsgPack/ directory:
- SentryMsgPackSerializer.swift - Main serialization logic
- SentryStreamable.swift - Protocol definition
- SentryMsgPackSerializerError.swift - Error types
- Data+SentryStreamable.swift - Data extension
- URL+SentryStreamable.swift - URL extension
- NSData+SentryStreamable.swift - NSData extension
- NSURL+SentryStreamable.swift - NSURL extension

Behavioral Compatibility

Maintained exact behavior matching original Objective-C implementation
Preserved edge cases like silent key length truncation for >255 byte keys
Kept error handling patterns including -1 return values for file size errors
Maintained logging levels (error vs debug) matching original code

Enhanced Test Coverage

Added comprehensive test suite with 14 test cases covering all code paths
Added edge case testing for large dictionaries, long keys, stream errors
Improved error validation for nil input streams and invalid file paths
AAA test pattern with proper setup/teardown and temp file cleanup

Implementation Improvements

Modern Swift patterns with proper error throwing instead of boolean returns
Type safety with explicit error types via SentryMsgPackSerializerError
Memory safety improvements while maintaining compatibility
Cleaner byte operations using modern Swift APIs

Key Technical Details

Protocol signature: Uses streamSize() -> Int to support -1 error values from Objective-C
Truncating conversion: Uses UInt8(truncatingIfNeeded:) to match Objective-C silent truncation
Error propagation: Swift errors are caught and converted to boolean returns for Objective-C compatibility
File I/O: Improved path validation through Swift's Data.write(to:) method

Testing

All existing functionality verified through comprehensive test suite:

14 tests covering all code paths and edge cases
100% backward compatibility with existing behavior
Proper error handling for all failure scenarios

Closes #6140

#skip-changelog

…nverted tests - Updated SentryMsgPackSerializer to log errors instead of debug messages for empty data and input stream issues. - Modified the `asInputStream` method in the SentryStreamable protocol to return nullable streams. - Removed outdated Objective-C tests and added comprehensive Swift tests for SentryMsgPackSerializer, covering various scenarios including nil input streams and invalid file paths. - Ensured proper cleanup of temporary files in tests.

codecov · 2025-09-11T10:09:02Z

Codecov Report

❌ Patch coverage is 97.12644% with 5 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@debf3e9). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
.../Swift/Tools/MsgPack/SentryMsgPackSerializer.swift	96.842%	3 Missing ⚠️
...ces/Swift/Tools/MsgPack/URL+SentryStreamable.swift	88.235%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main     #6143   +/-   ##
========================================
  Coverage        ?   86.925%           
========================================
  Files           ?       454           
  Lines           ?     37654           
  Branches        ?     17422           
========================================
  Hits            ?     32731           
  Misses          ?      4645           
  Partials        ?       278

Files with missing lines	Coverage Δ
SentryTestUtils/TestStreamableObject.swift	`100.000% <100.000%> (ø)`
Sources/Sentry/SentryClient.m	`99.321% <ø> (ø)`
...es/Swift/Tools/MsgPack/Data+SentryStreamable.swift	`100.000% <100.000%> (ø)`
Sources/Swift/Tools/SentryEnvelopeItem.swift	`91.034% <100.000%> (ø)`
...ces/Swift/Tools/MsgPack/URL+SentryStreamable.swift	`88.235% <88.235%> (ø)`
.../Swift/Tools/MsgPack/SentryMsgPackSerializer.swift	`96.842% <96.842%> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update debf3e9...e6ec86d. Read the comment docs.

github-actions · 2025-09-11T10:17:54Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1217.40 ms	1247.78 ms	30.38 ms
Size	23.75 KiB	1.01 MiB	1011.93 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`5c5648e`	1234.44 ms	1253.79 ms	19.35 ms
`fb48c9a`	1232.49 ms	1266.27 ms	33.78 ms
`d72784d`	1214.31 ms	1241.35 ms	27.04 ms
`7af87c1`	1229.31 ms	1253.84 ms	24.53 ms
`029a804`	1219.65 ms	1241.96 ms	22.30 ms
`139db8b`	1231.50 ms	1258.19 ms	26.69 ms
`7f4bf81`	1241.73 ms	1270.66 ms	28.93 ms
`83bb978`	1238.33 ms	1260.04 ms	21.71 ms
`42cfd79`	1222.13 ms	1244.23 ms	22.10 ms
`aac24ac`	1225.94 ms	1256.38 ms	30.45 ms

App size

Revision	Plain	With Sentry	Diff
`5c5648e`	23.75 KiB	879.60 KiB	855.86 KiB
`fb48c9a`	23.75 KiB	1006.34 KiB	982.59 KiB
`d72784d`	23.75 KiB	988.01 KiB	964.27 KiB
`7af87c1`	23.75 KiB	933.34 KiB	909.59 KiB
`029a804`	23.75 KiB	928.11 KiB	904.36 KiB
`139db8b`	23.75 KiB	920.64 KiB	896.89 KiB
`7f4bf81`	23.75 KiB	919.70 KiB	895.95 KiB
`83bb978`	23.75 KiB	920.64 KiB	896.89 KiB
`42cfd79`	23.75 KiB	880.20 KiB	856.45 KiB
`aac24ac`	23.75 KiB	1019.17 KiB	995.42 KiB

Previous results on branch: philprime/msg-pack-serializer-null-handling

Startup times

Revision	Plain	With Sentry	Diff
`13910c9`	1222.09 ms	1248.02 ms	25.93 ms
`2c09b1c`	1196.13 ms	1225.79 ms	29.66 ms
`43dc3b5`	1236.69 ms	1255.65 ms	18.95 ms
`8215a0d`	1206.23 ms	1237.04 ms	30.81 ms
`c0e1523`	1229.65 ms	1263.41 ms	33.76 ms

App size

Revision	Plain	With Sentry	Diff
`13910c9`	23.74 KiB	1.00 MiB	1002.97 KiB
`2c09b1c`	23.75 KiB	992.26 KiB	968.52 KiB
`43dc3b5`	23.75 KiB	988.55 KiB	964.80 KiB
`8215a0d`	23.75 KiB	969.21 KiB	945.46 KiB
`c0e1523`	23.75 KiB	988.63 KiB	964.88 KiB

…rializer-null-handling

…nal serialization tests - Added support for error streams in TestStreamableObject. - Introduced new test cases for serializing empty dictionaries, single elements, large dictionaries, long keys, and handling invalid paths. - Implemented a custom ErrorInputStream to simulate read errors during serialization.

…ntation - Deleted the Objective-C SentryMsgPackSerializer and its associated header files. - Introduced a new Swift implementation of SentryMsgPackSerializer with improved error handling. - Added SentryStreamable protocol and extensions for Data, NSData, NSURL, and URL to support serialization. - Updated tests to validate the new Swift serialization logic and error handling.

…r error propagation - Changed keyData.withUnsafeBytes to use try for improved error handling. - This ensures that any errors during buffer address retrieval are properly thrown.

philprime · 2025-09-15T09:18:41Z

@cursor review

- Introduced TestStreamableObject to simulate various SentryStreamable behaviors, including handling nil and error streams. - Updated SentryMsgPackSerializerTests to utilize TestStreamableObject for improved test coverage on serialization scenarios. - Removed redundant TestStreamableObject implementation from SentryMsgPackSerializerTests to streamline code.

…rializer-null-handling

philprime · 2025-09-23T12:19:26Z

@cursor review
@seer review

Sources/Swift/Tools/MsgPack/NSData+SentryStreamable.swift

Sources/Swift/Tools/MsgPack/NSURL+SentryStreamable.swift

Sources/Swift/Tools/MsgPack/NSData+SentryStreamable.swift

Sources/Swift/Tools/MsgPack/NSURL+SentryStreamable.swift

…rializer-null-handling

philprime · 2025-10-09T11:59:07Z

@sentry review

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

Sources/Swift/Tools/MsgPack/SentryStreamable.swift

Tests/SentryTests/SentryMsgPackSerializerTests.swift

…rializer-null-handling

…ror handling - Updated `serializeDictionary` method to directly serialize to a file. - Introduced `serializeToFile` method for better separation of concerns. - Enhanced error handling to clean up partial files on serialization failure. - Updated tests to validate new serialization approach and error scenarios.

cursor · 2025-10-23T09:14:53Z

Bug: Logging Level Change Causes Unnecessary Alerts

The logging level for file attribute read errors changed from DEBUG to ERROR. This goes against the PR's goal of maintaining original logging levels and may cause unwanted log spam or trigger monitoring alerts for expected failure cases.

noahsmartin · 2025-10-24T15:28:11Z

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

+ * We only need to concatenate a list of NSData into an envelope item.
+ */
+class SentryMsgPackSerializer {
+    @objc


Since the class itself is not marked with @objc I guess this is only called from Swift? Can we remove this objc?

noahsmartin · 2025-10-24T15:28:17Z

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

+ * This is a partial implementation of the MessagePack format.
+ * We only need to concatenate a list of NSData into an envelope item.
+ */
+class SentryMsgPackSerializer {


noahsmartin · 2025-10-24T15:29:32Z

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

+ */
+class SentryMsgPackSerializer {
+    @objc
+    static func serializeDictionary(toMessagePack dictionary: [String: Any], intoFile fileURL: URL) -> Bool {


Can we make this input type [String: SentryStreamable] I think we can since the function doesn't need to be exposed to objc.

noahsmartin · 2025-10-24T15:29:50Z

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

+    }
+
+    // swiftlint:disable:next function_body_length cyclomatic_complexity
+    private static func serializeToFile(dictionary: [String: Any], fileURL: URL) throws {


Assuming we change the above not to use Any, can change this as well

noahsmartin · 2025-10-24T15:32:36Z

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

+            guard let value = anyValue as? SentryStreamable else {
+                throw SentryMsgPackSerializerError.invalidValue("Value does not conform to SentryStreamable: \(anyValue)")
+            }
+            guard let keyData = key.data(using: .utf8) else {


I think we can use Data(key.utf8) and then it won't be optional

noahsmartin · 2025-10-24T15:34:53Z

Sources/Swift/Tools/MsgPack/SentryMsgPackSerializer.swift

+
+            // Write UInt32 as big endian bytes
+            let lengthBytes = [
+                UInt8((valueLength >> 24) & 0xFF),


Can we still use NSSwapHostIntToBig like the objc code did? That function should be available to Swift

philprime self-assigned this Sep 11, 2025

philprime requested review from itaybre, noahsmartin and philipphofmann as code owners September 11, 2025 09:57

philprime marked this pull request as draft September 11, 2025 11:32

philprime added 3 commits September 15, 2025 10:29

Merge remote-tracking branch 'origin/main' into philprime/msg-pack-se…

6eb1e43

…rializer-null-handling

philprime changed the title ~~refactor: Add nullability-handling to SentryMsgPackSerializer with converted tests~~ refactor: Migrate SentryMsgPackSerializer from Objective-C to Swift Sep 15, 2025

fix: Update keyData handling in SentryMsgPackSerializer to use try fo…

b73f131

…r error propagation - Changed keyData.withUnsafeBytes to use try for improved error handling. - This ensures that any errors during buffer address retrieval are properly thrown.

This comment was marked as outdated.

Sign in to view

philprime added 2 commits September 23, 2025 14:17

Merge remote-tracking branch 'origin/main' into philprime/msg-pack-se…

9b91dac

…rializer-null-handling

This comment was marked as outdated.

Sign in to view

fix potential overflow for very large files

7726ae1

philprime marked this pull request as ready for review September 23, 2025 12:49

This comment was marked as outdated.

Sign in to view

philprime added the Waiting for: Review ⏳ label Sep 26, 2025

noahsmartin reviewed Oct 6, 2025

View reviewed changes

Sources/Swift/Tools/MsgPack/NSData+SentryStreamable.swift Outdated Show resolved Hide resolved

noahsmartin reviewed Oct 6, 2025

View reviewed changes

Sources/Swift/Tools/MsgPack/NSURL+SentryStreamable.swift Outdated Show resolved Hide resolved

noahsmartin reviewed Oct 6, 2025

View reviewed changes

Sources/Swift/Tools/MsgPack/NSData+SentryStreamable.swift Outdated Show resolved Hide resolved

noahsmartin reviewed Oct 6, 2025

View reviewed changes

Sources/Swift/Tools/MsgPack/NSURL+SentryStreamable.swift Outdated Show resolved Hide resolved

philprime added 2 commits October 9, 2025 13:24

Merge remote-tracking branch 'origin/main' into philprime/msg-pack-se…

2307fe1

…rializer-null-handling

remove legacy extensions

5181e9e

This comment was marked as outdated.

Sign in to view

resolve conversion mistakes

568d287

philprime requested a review from noahsmartin October 9, 2025 11:58

This comment was marked as outdated.

Sign in to view

seer-by-sentry bot reviewed Oct 9, 2025

View reviewed changes

philprime added 3 commits October 21, 2025 12:13

Merge remote-tracking branch 'origin/main' into philprime/msg-pack-se…

157de83

…rializer-null-handling

Fix xcode proj

e7abc0a

This comment was marked as outdated.

Sign in to view

philprime added Waiting for: Review ⏳ and removed Waiting for: Review ⏳ labels Oct 22, 2025

Merge branch 'main' into philprime/msg-pack-serializer-null-handling

e6ec86d

noahsmartin reviewed Oct 24, 2025

View reviewed changes

philprime marked this pull request as draft October 24, 2025 15:31

noahsmartin reviewed Oct 24, 2025

View reviewed changes

philprime removed the Waiting for: Review ⏳ label Oct 28, 2025

Uh oh!

Uh oh!

refactor: Migrate SentryMsgPackSerializer from Objective-C to Swift #6143

Are you sure you want to change the base?

refactor: Migrate SentryMsgPackSerializer from Objective-C to Swift #6143

Uh oh!

Conversation

philprime commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes Made

Complete Migration

Behavioral Compatibility

Enhanced Test Coverage

Implementation Improvements

Key Technical Details

Testing

Uh oh!

codecov bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

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

Uh oh!

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: philprime/msg-pack-serializer-null-handling

Startup times

App size

Uh oh!

philprime commented Sep 15, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

philprime commented Sep 23, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

philprime commented Oct 9, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot commented Oct 23, 2025

Bug: Logging Level Change Causes Unnecessary Alerts

Uh oh!

noahsmartin Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

noahsmartin Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

noahsmartin Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

noahsmartin Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

noahsmartin Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

philprime commented Sep 11, 2025 •

edited

Loading

codecov bot commented Sep 11, 2025 •

edited

Loading

github-actions bot commented Sep 11, 2025 •

edited

Loading