feat: Support for iOS & macOS using Cocoa SDK integration by limbonaut · Pull Request #266 · getsentry/sentry-godot

limbonaut · 2025-07-23T13:25:41Z

This PR brings Sentry Cocoa SDK integration as a backend on macOS and iOS platforms. This switches macOS builds to utilize Sentry Cocoa as well.

Build system manages Sentry Cocoa package, reading modules/sentry-cocoa.package file, downloading the corresponding package with dynamic framework from GitHub Releases, extracting and processing it. It also updates it if the version changes in the .package file. Dependency update should be trivial to add.

The build system takes the respective slices from the Sentry Cocoa XCFramework and puts them in the project/. For macOS, it also flattens the framework, so we don’t have any problems with symlinks on Windows and with Godot Engine. Framework is linked dynamically.

This PR also includes a simple system for custom options. GodotCPP tends to complain about those – so there is a workaround for that too. A new option is added to generate iOS framework from iOS build artifacts: generate_ios_framework=yes|no

Local build instructions

Build macOS libs:

scons target=editor debug_symbols=yes
scons target=template_release debug_symbols=yes

Build iOS libs:

scons platform=ios target=editor arch=arm64 ios_simulator=no
scons platform=ios target=editor arch=universal ios_simulator=yes generate_ios_framework=yes

All unit tests passed on macOS. Due to limitations of the unit test framework, can't run tests on iOS. However, there are separate mobile tests which I ran via demo project – all succeeded.

Known issues and limitations

Script source context is not available: Add support for script source context on iOS and macOS #295
Local variables are not available: Add support for local variables on macOS & iOS #296
Scene tree information is not available (aka view hierarchy): Add support for scene tree info on macOS & iOS #297
CI doesn't make proper iOS builds yet. It does compilation, but does not generate XCFramework yet. Follow-up: ci: Build iOS artifacts #291
Debug output is not routed to Godot console yet. You can see it in a terminal app. It's also quite noisy. Send debug output to Godot console on Apple platforms #298
Godot generates runtime errors when OS.get_memory_info() is called on iOS – so I disabled it on iOS: Fix memory information in device context on iOS #299

jpnurmi · 2025-08-04T08:19:51Z

Could we have some basic unit tests for rfc3339_timestamp_to_microseconds and microseconds_to_rfc3339_timestamp? A separate PR could also be a welcome option to offload some parts of this rather heavy PR and get things going. :)

limbonaut · 2025-08-04T18:42:05Z

@jpnurmi The tests we maintain are in GDScript, which don't have direct access to such methods; however, we test them indirectly via:

sentry-godot/project/test/suites/test_event.gd

Lines 28 to 45 in efbdb39

    
           func test_event_timestamp() -> void: 
        
           	var event := SentrySDK.create_event() 
        
           	assert_str(event.timestamp).is_not_empty() 
        
           	# Example of how to format a timestamp: 
        
           	var unix_time: float = Time.get_unix_time_from_system() 
        
           	var dt: Dictionary = Time.get_datetime_dict_from_unix_time(unix_time) 
        
           	var date := "%04d-%02d-%02d" % [dt.year, dt.month, dt.day] 
        
           	var time := "%02d:%02d:%02d" % [dt.hour, dt.minute, dt.second] 
        
           	var fractional: float = unix_time - int(unix_time) 
        
           	var micros := int(round(fractional * 1000000)) 
        
           	var timestamp := "%sT%s.%06dZ" % [date, time, micros] 
        
           	event.timestamp = timestamp 
        
           	# Test timestamp equality by comparing only up to milliseconds precision. 
        
           	# This avoids test failures due to microsecond-level rounding differences that can occur on some platforms. 
        
           	assert_str(event.timestamp.left(23)).is_equal(timestamp.left(23))

We could expand such tests to include various formats in RFC3339 and also test some edge cases. Extracting these functions into separate PR make less sense as they only used with cocoa sdk, and we wouldn't be able to test them unless we introduce another testing layer, just for internal C++ stuff.

limbonaut · 2025-08-04T19:20:17Z

@jpnurmi Almost forgot, I’ve been working on a dedicated SentryTimestamp public API class some time ago. I stopped working on it, as I’m not entirely sure if we really need it, so I’d love to hear your thoughts. It actually has a pretty comprehensive test suite :)
One of the limitations it tries to overcome is lack of dedicated datetime/timestamp type in GDScript. This is all we have in Godot: https://docs.godotengine.org/en/latest/classes/class_time.html

UPDATE:

See feat: Intoduce SentryTimestamp class to improve timestamp handling #286

limbonaut · 2025-08-05T18:57:50Z

Timestamp functionality is taken care of by #286. So, this PR doesn’t deal with it anymore.

CHANGELOG.md

jpnurmi

Looks good! Thanks for splitting off the timestamp changes. 🙏

src/sentry/cocoa/cocoa_util.mm

src/sentry/cocoa/cocoa_util.h

src/sentry/cocoa/cocoa_event.mm

src/sentry/cocoa/cocoa_sdk.mm

src/sentry/cocoa/cocoa_event.mm

jpnurmi

Are these "noop" builds anymore?

jpnurmi · 2025-08-06T07:37:48Z

Oh no, switching to Cocoa didn't help with that 🙁

libc++abi: Pure virtual function called!
/Users/runner/work/_temp/f74de61c-e6cf-42b0-8d86-f03e8521ab5d.sh: line 3: 1754 Abort trap: 6 ${GODOT} --headless --path project/ --import --verbose
Error: Process completed with exit code 134.

https://github.com/getsentry/sentry-godot/actions/runs/16770287480/job/47484472250?pr=266

limbonaut · 2025-08-06T07:43:22Z

Oh no, switching to Cocoa didn't help with that 🙁

Aww shame, cant even pin it to a commit as it's so flaky.

limbonaut · 2025-08-06T07:45:03Z

Are these "noop" builds anymore?

They are not, but I'd like to address it in a separate PR as it needs more than renaming – we also need to generate an xcframework from 2 libs in a post-process job.

limbonaut added 30 commits July 16, 2025 19:41

Create sentry-cocoa.properties

38e0d8d

Build: Cocoa SDK support

66af098

Use new platform defines

2e6795f

Fix null pointer dereference in SentrySDK::get_user

bc325a5

Remove redundant context initialization

6bd16ef

Move auto-initialization of user to ctor

9733f83

Add skeleton implementation for Apple platforms

8bffe94

squashed: Move Sentry classes into sentry namespace

1388089

Fix include path for sentry_attachment header

d198fa8

Rename Cocoa SDK file from .cpp to .mm

92b7397

Ditch Objective-C wrapper

c81b502

Use correct Sentry enums and import headers

ff4b10f

Refactor Cocoa SDK includes and utilities

770ff11

Move Cocoa implementation to sentry::cocoa namespace

ec2004a

Fix ambiguous type aliases in Cocoa includes

641de64

Refactor Cocoa SDK conversions

9850225

Simplify Cocoa SDK message capture code

0f041e9

Add support for packed array variants to objc conversion

e5636ab

Utilize more options for Cocoa SDK init

f8f2b11

Add checks for breadcrumb properties in CocoaSDK

2701dcd

Implement attachment support for Cocoa SDK

590f055

Only set dist in Cocoa SDK when value is not empty

91073af

Register global attachments in Cocoa SDK

c7eaa7a

Handle better initialization failure

dd9ba91

Pass more options

16ed537

Move global attachments to initialScope config

1e67ac5

Merge branch 'main' into feat/cocoa-integration

2a04603

Handle nil string conversion in string_from_objc

948f444

Start implementing CocoaEvent

6a18ffc

Add tag methods to CocoaEvent

bd138eb

Add depth limit to variant_to_objc()

5065616

limbonaut force-pushed the feat/cocoa-integration branch from f1fc79c to 5065616 Compare July 31, 2025 09:53

limbonaut added 5 commits July 31, 2025 21:05

Use threads for script stacktrace in Cocoa events

32486da

Move depth check into specific blocks

0751577

Merge branch 'main' into feat/cocoa-integration

db0fbfa

Use common constant for depth limit

1196b6b

Update CHANGELOG.md

efbdb39

limbonaut added 5 commits August 5, 2025 18:46

Merge branch 'main' into feat/cocoa-integration

6f49e3d

Update event timestamp to use SentryTimestamp type

eb67c83

Remove old timestamp code

5b186f9

Remove includes

7845385

Merge branch 'main' into feat/cocoa-integration

84ab83d

jpnurmi reviewed Aug 5, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Fix missing parenthesis in CHANGELOG.md link

19ac750

jpnurmi reviewed Aug 5, 2025

View reviewed changes

limbonaut added 5 commits August 6, 2025 08:53

Fix numeric type conversion in Cocoa

c1aa27d

Simplify timestamp conversion in Cocoa event

a9c4bfd

Simplify string conversions in CocoaSDK

b5728c7

Update CocoaEvent constructor to use initializer list

2602f31

Add __strong qualifier to Cocoa event pointer

d1fca83

jpnurmi approved these changes Aug 6, 2025

View reviewed changes

limbonaut merged commit c3d0745 into main Aug 6, 2025
82 of 83 checks passed

limbonaut deleted the feat/cocoa-integration branch August 6, 2025 09:54

Uh oh!

Comments

Conversation

limbonaut commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Known issues and limitations

Uh oh!

jpnurmi commented Aug 4, 2025

Uh oh!

limbonaut commented Aug 4, 2025

Uh oh!

limbonaut commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

limbonaut commented Aug 5, 2025

Uh oh!

Uh oh!

jpnurmi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jpnurmi left a comment

Choose a reason for hiding this comment

Uh oh!

jpnurmi commented Aug 6, 2025

Uh oh!

limbonaut commented Aug 6, 2025

Uh oh!

limbonaut commented Aug 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

limbonaut commented Jul 23, 2025 •

edited

Loading

limbonaut commented Aug 4, 2025 •

edited

Loading