fix: Upload Symbols Failed when uploading iOS build via Xcode

[wbbtech]

App ID: 072cf011-5a6e-40d8-9dce-7fa1010e024d

Description

When uploading an iOS release build via xcode it shows the attached warning.

Steps To Reproduce

1. Create a build with the following command
   shorebird release ios --public-key-path ./shorebird_public_key.pem
2. Open file /build/ios/archive in xcode and upload to testflight

Expected Behavior

Upload ios build without warnings

Screenshots

Additional Context

Shorebird 1.6.9 • [email protected]:shorebirdtech/shorebird.git
Flutter 3.27.3 • revision 3d75b30b181d1d4ce66c426c64aca2498529f2e0
Engine • revision 9637b88761740c1ea1d6efac2e2b73235e6eb4de

[bryanoltman]

This seems similar to #2803

[bryanoltman]

Did the archive contain a Flutter.dSYM? If so, what is its UDID? You can find this using dwarfdump -u Flutter.dSYM

[wbbtech]

I couldn't find the Flutter.dSYM file you mentioned, this is the message I get when I try to upload an iOS build: "The archive did not include a dSYM for the Flutter.framework with the UUIDs [4C4C4441-5555-3144-A1AF-4B15A67E23CB]. Ensure that the archive's dSYM folder includes a DWARF file for Flutter.framework with the expected UUIDs."

[eseidel]

Flutter.dsym should be downloadable from the console.

e.g.

Although it looks like it isn't for mac builds (filed and I don't have an iOS build to test with handy.
#2845

[wbbtech]

Flutter.dsym should be downloadable from the console.

e.g.

Although it looks like it isn't for _mac_ builds (filed and I don't have an _iOS_ build to test with handy. [#2845](https://github.com//issues/2845)

It is likely only available when submitting patches.

[eseidel]

Sorry, it appears we don't currently link .dsym from the console, but we should. They can be gotten manually:
https://docs.shorebird.dev/guides/crash-reporting/uploading-symbols/

[wbbtech]

The Flutter.DSYM file is available for download, what would be the next step?

[eseidel]

You'd add it to build/ios/archive along with all the other .dsym files and upload the whole folder together. That should make the validation error go away.

[wbbtech]

Done, the error is now gone, however, it is possible to add this missing file automatically during compilation with the shorebird release command

[eseidel]

Yes, I think we should just make shorebird release ios automatically download this file for you.

[bryanoltman]

I'm surprised apps built with vanilla Flutter don't have this issue

[eseidel]

a. it might be a new requirement, and b. maybe we're not providing Flutter.dsym as an artifact? Or we're providing the upstream one and the xcode tools are (silently) rejecting it do to mis-matched uiid?
I guess the easy way to test is trying flutter build ios --no-codesign and see if build/ios/archive/Runner.xcarchive/dSYM/ has a Flutter.dsym or not.

[bryanoltman]

I think --no-codesign is a red herring. I think this is our problem https://github.com/shorebirdtech/flutter/blob/shorebird/dev/packages/flutter_tools/lib/src/build_system/targets/ios.dart#L347-L372

[bryanoltman]

Yeah, Flutter is looking for a dsym at cache/artifacts/engine/ios-release/Flutter.xcframework/ios-arm64/dSYMs/Flutter.framework.dSYM, which I don't think our build script packages up. That should be easy enough to fix.

[eseidel]

https://github.com/flutter/flutter/blob/master/engine/src/flutter/ci/builders/mac_ios_engine.json will have whatever upstream does to package.

[bryanoltman]

Can confirm that our fork of Flutter's bin/cache/artifacts/engine/ios-release/Flutter.xcframework/ios-arm64 does not contain a dSYMs directory. Updated build_runner to use the same xcframework packaging script as upstream in https://github.com/shorebirdtech/_build_engine/commit/f3b4d0d5fc95b37985e62909ffcaff2b5044168b, which I believe should fix the issue. Engine build running now.

[bryanoltman]

This should now be fixed in the latest revision of Flutter version 3.27.3. You may need to run shorebird cache clear to see this change.