TestFlight rejects the app due to malformed framework bundles

[limbonaut]

User reported that TestFlight rejected the app due to malformed framework bundles. The Sentry and libsentry.macos.release frameworks are missing required symbolic links.

The original message:

Also, after publishing to test flight i get

We noticed one or more issues with a recent delivery for the following app:

App Apple ID
Version 1.0.0
Build 1.0.0
Please correct the following issues and upload a new binary to App Store Connect.

ITMS-90291: Malformed Framework - The framework bundle Sentry (<>.app/Contents/Frameworks/Sentry.framework) must contain a symbolic link 'Sentry' -> 'Versions/Current/Sentry'. Refer to the Anatomy of Framework Bundles for more information.

ITMS-90291: Malformed Framework - The framework bundle Sentry (<>.app/Contents/Frameworks/Sentry.framework) must contain a symbolic link 'Resources' -> 'Versions/Current/Resources'. Refer to the Anatomy of Framework Bundles for more information.

ITMS-90292: Malformed Framework - The framework bundle Sentry (<>.app/Contents/Frameworks/Sentry.framework) 'Versions' directory must contain a symbolic link 'Current' resolving to a specific version directory. Resolved link target: '${linkTarget}'. Refer to the Anatomy of Framework Bundles for more information.

ITMS-90291: Malformed Framework - The framework bundle libsentry.macos.release (<>.app/Contents/Frameworks/libsentry.macos.release.framework) must contain a symbolic link 'libsentry.macos.release' -> 'Versions/Current/libsentry.macos.release'. Refer to the Anatomy of Framework Bundles for more information.

ITMS-90291: Malformed Framework - The framework bundle libsentry.macos.release (<>.app/Contents/Frameworks/libsentry.macos.release.framework) must contain a symbolic link 'Resources' -> 'Versions/Current/Resources'. Refer to the Anatomy of Framework Bundles for more information.

ITMS-90292: Malformed Framework - The framework bundle libsentry.macos.release (<>.app/Contents/Frameworks/libsentry.macos.release.framework) 'Versions' directory must contain a symbolic link 'Current' resolving to a specific version directory. Resolved link target: '${linkTarget}'. Refer to the Anatomy of Framework Bundles for more information.

Originally posted by @Ughuuu in #457

[linear]

GODOT-137

[limbonaut]

The issue currently is that we are flattening the internal Cocoa SDK framework structure, so that it's possible to store and export projects on Windows as it doesn't natively support symlinks without elevated permissions, and it leads to broken exports. I think we need to test the behavior with TestFlight and consider the options we have to resolve this.

[Ughuuu]

On this, after fixing this issue, test flight accepts the binary (able to test with locally). But if I send it for review, I get:

Guideline 2.5.1 - Performance - Software Requirements


Your app uses or references the following non-public or deprecated APIs:


Contents/MacOS/PolyglotPirates

Classes:

• CAContext

Symbols:

• _kCAContextCIFilterBehavior


The use of non-public or deprecated APIs is not permitted on the App Store, as they can lead to a poor user experience should these APIs change and are otherwise not supported on Apple platforms.

I'm investigating if this is due to Sentry or Godot itself, or something else.

In my app I only have sentry and godotswift as gdextensions. So one of the two, or Godot itself must be causing this (this is happening after the TestFlight initial check, on the review stage).

[limbonaut]

@Ughuuu

I see you already opened a ticket in godot for this other issue:

• Godot 4.5.1 App fails macOS App Review godotengine/godot#113953

On this, after fixing this issue, test flight accepts the binary

I want to clarify what you mean by "after fixing this issue". Did you copy the framework with symlinks from the sentry-cocoa release package?

[Ughuuu]

Yes, I have copied the framework with symlinks, as well as making version folders, etc.. As the error from the Apple Review asked. As for the second one, it appears to be a bug in Godot 4.5.1.

[limbonaut]

I gave it a bit of testing, and indeed can confirm that the flat frameworks cause issues when an app is submitted to App Store Connect. It affects both the flattened sentry-cocoa framework, as well as the framework library from GDExtension build.

Flat frameworks -- no symlinks:

Versioned frameworks -- with symlinks:

---

We'll need to find a way to fix these issues. The problem with supplying frameworks that adhere to versioned structure as described in the Apple docs is that on Windows, by default, you can't create symlinks without elevated permissions. Packaging such symlinks in an archive leads to errors when unpacking it on Windows.

[limbonaut]

Hey @Ughuuu! I’m working on a fix.
Can you check if #468 resolves this issue?
You can use this build: https://github.com/getsentry/sentry-godot/actions/runs/20352112026

[Ughuuu]

#468

Oh, but that's not what I did locally. Locally I am still using frameworks, just created the symlinks and it works. Not sure if it will pass with just libraries or not. I can give it a try in a bit, but I think it should remain with frameworks, as those can be signed also (has the _CodeSign folder)

[Ughuuu]

I see you are already using ubuntu runners though, so it should just be a matter of making links and what they ask in the validation, can be done with a script after build succeeds.