Add VisionOS Support for Carthage

[armcknight]

We don't have an xrOS slice in our xcframework deliverable as of Sentry 8.15.2.

Support for VisionOS was added in Carthage 0.39.1 to add xrOS slices to xcframeworks.

The VisionOS SDK is still only delivered in the latest Xcode beta (15.1b3 released 14 Nov) and not the latest GA release version (15.0.1), and we don't currently use betas in our release job. (In fact, we're still running Xcode 14.3 for building the xcframework: #3411.) UPDATE: there is movement on this front, now that Xcode 15.2 is out with GA support for VisionPro/xrOS, and GitHub has a prerelease actions runner with the requisite OS/toolchains: #3410 (comment)

Part of us upgrading to Xcode 15.2 in CI will overlap with #3329

After we support VisionOS for Carthage, we need to update the docs getsentry/sentry-docs#8496.

[brustolin]

All we need to do is start using a Xcode that has visionOS support, but I don't recommend using a beta version to release our official XCFramework artefact.

[philipphofmann]

Xcode that has visionOS support

Only Xcode beta has support, which doesn't run on GH actions.

[philipphofmann]

For now, our users can do the following to build their own XCFramwork with visionOS support by using Xcode beta:

1. Download Xcode beta
2. Ensure to have all bet platforms installed you want for Xcode (iOS 17.2, tvOS 17.2, vision 1.0)
3. Select the Xcode beta version with something like sudo xcode-select -s /Applications/Xcode-beta.app/Contents/Developer/
4. Checkout the Sentry Cocoa GH repository
5. Call make init
6. Then call make build-xcframework which will compile the XCFramework

[marksands]

We're trying to build locally, but keep running into this issue:

/path/to/Sources/Sentry/include/SentrySwift.h:4:9: fatal error: module 'SentryPrivate' not found
@import SentryPrivate;
 ~~~~~~~^~~~~~~~~~~~~
1 error generated.

Any advice on how to fix this? We're running the Makefile commands as given in the instructions, with the downloaded source, so there shouldn't be any differential here.

[marksands]

Ok interesting finding...

This succeeds:

xcodebuild -workspace /Users/mark.sands/Downloads/sentry-cocoa-8.3.2/Sentry.xcworkspace -scheme Sentry -configuration Release -sdk iphoneos archive

This fails:

xcodebuild -workspace /Users/mark.sands/Downloads/sentry-cocoa-8.3.2/Sentry.xcworkspace -scheme Sentry -configuration Release -sdk xros archive

So we're currently looking for an incompatibility with some xros setting.

[marksands]

We figured it out! For some reason, $(SDKROOT__CARTHAGE_$(CARTHAGE)) wasn't being fully defined for us, so we hardcoded SDKROOT = macosx locally to get the intermediate frameworks to build for xros. I'm not sure if this had to do with a Carthage change, since we had to use 0.39.1 to build with it. Hope that helps!

[samwu888]

Mark is out today but this was another issued we encountered

We were able to work around that issue, but another one that came up is when we were trying to link the SentrySwiftUI framework to our app targets.

"ld: linking against a dylib which is not safe for use in application extensions: /Users/jenkins/workspace/ios_Dominguez_PR-14846/build/Build/Products/Debug-appletvsimulator/SentrySwiftUI.framework/SentrySwiftUI"

This error came up for all of our platform targets except visionOS, which was odd. It definitely could be related to how we built it with our workaround above, but just in case, I'm adding that to the discussion. Thanks!

[kahest]

Hi @marksands & @samwu888 - thank you for the details! To clarify, are you currently blocked, and if so, on which platform(s)? Also, is the version in the snippet above (sentry-cocoa-8.3.2) correct? Did you try using a more recent version of the SDK?

[kahest]

All we need to do is start using a Xcode that has visionOS support, but I don't recommend using a beta version to release our official XCFramework artefact.

Xcode 15.2 GM has been released yesterday, which is the first official Xcode release with full visionOS support. We can now test and work towards supporting this.

[kahest]

There's a pre-release macos-13 runner-image with Xcode 15.2 available now: https://github.com/actions/runner-images/releases/tag/macos-13%2F20240114.1