[iOS] Bundle dSYM packages in Flutter.xcframework #54414

cbracken · 2024-08-07T22:21:48Z

As of Xcode 16, App Store validation requires dSYMs for frameworks in app archives. Bundling dSYMs also significantly simplifies stack trace symbolification, so we should be doing this regardless.

This adds both framework and simulator framework dSYMs to the Flutter.xcframework bundle.

Issue: flutter/flutter#116493

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the CLA.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

As of Xcode 16, App Store validation requires dSYMs for frameworks in app archives. Bundling dSYMs also significantly simplifies stack trace symbolification, so we should be doing this regardless. This adds both framework and simulator framework dSYMs to the Flutter.xcframework bundle. Issue: flutter/flutter#116493

zanderso · 2024-08-08T01:32:40Z

sky/tools/create_xcframework.py

@@ -22,15 +22,22 @@ def main():
      help='The framework paths used to create the XCFramework.',
      required=True
  )
+  parser.add_argument(


It looks like the new argument isn't passed in this PR. What's the plan for using the new code in this file?

It's passed from create_full_ios_framework.py (here), which uses it because the invocation in mac_ios_engine.json already uses the --dsym flag.

YOU ARE IN A MAZE OF TWISTY PYTHON SCRIPTS, ALL ALIKE. YOU ARE LIKELY TO BE EATEN BY A GRUE.

LIGHT LAMP.

…engine#54414)

…153111) flutter/engine@3978ddd...387f6f3 2024-08-08 [email protected] Fix FlutterMetalLayer testDealloc flakiness on iOS 18 (flutter/engine#54403) 2024-08-08 [email protected] [iOS] Bundle dSYM packages in Flutter.xcframework (flutter/engine#54414) 2024-08-08 [email protected] Roll Dart SDK from 0131aabd8631 to 067c7cfcbc8c (1 revision) (flutter/engine#54437) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

Renames our Flutter framework dSYM to `Flutter.framework.dSYM` for consistency with all other dSYM bundle names. In iOS release archives, all other dSYM files are: * `App.framework`: `App.framework.dSYM` * `Runner.app`: `Runner.app.dSYM` We continue to archive the dSYM to `Flutter.dSYM.zip` for backward compatibility with the existing instructions for manual symbolification in `docs/Crashes.md` and to remain compatible with dart-lang/dart-ci's symbolizer which expects `Flutter.dSYM` in [`Symbolizer._symbolizeIosFrames`][symbolizer]. Followup to: #54414 Issue: flutter/flutter#116493 Motto: [Embrace the yak shave][yak_shave]. [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

As of Xcode 16, App Store validation now requires that apps uploaded to the App store bundle dSYM debug information bundles for each Framework they embed. dSYM bundles are packaged in the Flutter.xcframework shipped in the `ios-release` tools archive as of engine patches: * flutter/engine#54414 * flutter/engine#54458 This copies the Flutter.framework.dSYM bundle from the tools cache to the app archive produced by `flutter build ipa`. Issue: flutter#116493

As of the following three patches, we now bundle Flutter.framework.dSYM as part of Flutter.xcframework and bundle them in the .xcarchive bundles produced by `flutter build ipa` / Xcode Product > Archive for upload to the iOS App Store. * flutter#54414 * flutter#54458 * flutter/flutter#153215 The .dSYM bundle is now available both in the uploaded .xcarchive and, in the xcframework in Flutter's internal artifact cache. For developers with CI toolchains that do additional manual handling or local archiving of .dSYMs, the dSYMs no longer need to be downloaded from cloud storage as previously detailed in `docs/Crashes.md`, but can instead be copied up from the appropriate dSYM subdirectory in the framework cache: * `flutter/bin/cache/artifacts/engine/ios-release/Flutter.xcframework` Issue: flutter/flutter#116493 Credo: [Embrace the yak shave](https://suno.com/song/37cb7c43-85ad-40f2-87e6-9aec7baa0419)

As of the following three patches, we now bundle Flutter.framework.dSYM as part of Flutter.xcframework and bundle them in the .xcarchive bundles produced by `flutter build ipa` / Xcode Product > Archive for upload to the iOS App Store. * #54414 * #54458 * flutter/flutter#153215 The .dSYM bundle is now available both in the uploaded .xcarchive and in the xcframework in Flutter's internal artifact cache. For developers with CI toolchains that do additional manual handling or local archiving of .dSYMs, the dSYMs no longer need to be downloaded from cloud storage as previously detailed in `docs/Crashes.md`, but can instead be copied up from the appropriate dSYM subdirectory in the framework cache: * `flutter/bin/cache/artifacts/engine/ios-release/Flutter.xcframework` Issue: flutter/flutter#116493 Credo: [Embrace the yak shave](https://suno.com/song/37cb7c43-85ad-40f2-87e6-9aec7baa0419) [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

As of Xcode 16, App Store validation now requires that apps uploaded to the App store bundle dSYM debug information bundles for each Framework they embed. dSYM bundles are packaged in the Flutter.xcframework shipped in the `ios-release` tools archive as of engine patches: * flutter/engine#54414 * flutter/engine#54458 This copies the Flutter.framework.dSYM bundle from the tools cache to the app archive produced by `flutter build ipa`. Issue: #116493

As of Xcode 16, App Store validation requires dSYMs for frameworks in app archives. Bundling dSYMs also significantly simplifies stack trace symbolification, so we should be doing this regardless. This adds both framework and simulator framework dSYMs to the Flutter.xcframework bundle. Issue: flutter/flutter#116493 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

Renames our Flutter framework dSYM to `Flutter.framework.dSYM` for consistency with all other dSYM bundle names. In iOS release archives, all other dSYM files are: * `App.framework`: `App.framework.dSYM` * `Runner.app`: `Runner.app.dSYM` We continue to archive the dSYM to `Flutter.dSYM.zip` for backward compatibility with the existing instructions for manual symbolification in `docs/Crashes.md` and to remain compatible with dart-lang/dart-ci's symbolizer which expects `Flutter.dSYM` in [`Symbolizer._symbolizeIosFrames`][symbolizer]. Followup to: flutter#54414 Issue: flutter/flutter#116493 Motto: [Embrace the yak shave][yak_shave]. [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

…lutter#153111) flutter/engine@3978ddd...387f6f3 2024-08-08 [email protected] Fix FlutterMetalLayer testDealloc flakiness on iOS 18 (flutter/engine#54403) 2024-08-08 [email protected] [iOS] Bundle dSYM packages in Flutter.xcframework (flutter/engine#54414) 2024-08-08 [email protected] Roll Dart SDK from 0131aabd8631 to 067c7cfcbc8c (1 revision) (flutter/engine#54437) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

As of Xcode 16, App Store validation now requires that apps uploaded to the App store bundle dSYM debug information bundles for each Framework they embed. dSYM bundles are packaged in the Flutter.xcframework shipped in the `ios-release` tools archive as of engine patches: * flutter/engine#54414 * flutter/engine#54458 This copies the Flutter.framework.dSYM bundle from the tools cache to the app archive produced by `flutter build ipa`. Issue: flutter#116493

In flutter/engine#54414, we added dSYM files for physical and simulator binaries in both regular and extension-safe framework builds. In flutter/engine#54576 we added the dSYMs to the without_entitlements.txt list. The `dev/bots/suite_runners/run_verify_binaries_codesigned_tests.dart` test was updated to reflect these changes in: * flutter#153787 * flutter#154027 This cherrypicks these two changes to the release branch. Issue: flutter#116493

In flutter/engine#54414, we added dSYM files for physical and simulator binaries in both regular and extension-safe framework builds. In flutter/engine#54576 we added the dSYMs to the without_entitlements.txt list. The `dev/bots/suite_runners/run_verify_binaries_codesigned_tests.dart` test was updated to reflect these changes in: * #153787 * #154027 This cherrypicks these two changes to the release branch. Issue: #116493

This updates the codesigning test to account for iOS and macOS binaries in the artifact cache that are _expected_ to not be codesigned. In flutter/engine#54414 we started bundling dSYM (debugging symbols) within Flutter.xcframework, a requirement for App Store verification using Xcode 16. We did the same for macOS in flutter/engine#54696. Unlike the framework dylib, dSYM contents are not directly codesigned (though the xcframework containing them is). Issue: flutter#154571

This updates the codesigning test to account for iOS and macOS binaries in the artifact cache that are _expected_ to not be codesigned. In flutter/engine#54414 we started bundling dSYM (debugging symbols) within Flutter.xcframework, a requirement for App Store verification using Xcode 16. We did the same for macOS in flutter/engine#54696. Unlike the framework dylib, dSYM contents are not directly codesigned (though the xcframework containing them is). Issue: #154571

This updates the codesigning test to account for iOS and macOS binaries in the artifact cache that are _expected_ to not be codesigned. In flutter/engine#54414 we started bundling dSYM (debugging symbols) within Flutter.xcframework, a requirement for App Store verification using Xcode 16. We did the same for macOS in flutter/engine#54696. Unlike the framework dylib, dSYM contents are not directly codesigned (though the xcframework containing them is). Issue: #154571 This is a cherry-pick of #154591 to the flutter-3.24-candidate.0 branch.

This updates the code-signing workflow to account for iOS and macOS binaries in the artifact cache that are _expected_ to not be codesigned. In flutter/engine#54414 we started bundling dSYM (debugging symbols) within Flutter.xcframework, a requirement for App Store verification using Xcode 16. We did the same for macOS in flutter/engine#54696. Unlike the framework dylib, dSYM contents are not directly codesigned (though the xcframework containing them is). This skips code-signing for files found in `unsigned_binaries.txt`, which will be added in a followup patch to the framework artifact archive creation scripts in engine: * `sky/tools/create_ios_framework.py` * `sky/tools/create_macos_framework.py` Issue: flutter/flutter#154571

lanistor · 2024-10-02T17:30:21Z

Does Flutter 3.22 merged this commit? I still got this problem.

Flutter: 3.22.3
Xcode: 16.0

Logs:

The archive did not include a dSYM for the Flutter.framework with the UUIDs [4C4C44DC-5555-3144-A1B8-F18F0C0EE878]. Ensure that the archive's dSYM folder includes a DWARF file for Flutter.framework with the expected UUIDs.

cbracken · 2024-10-02T17:47:11Z

Does Flutter 3.22 merged this commit? I still got this problem.

Unfortunately, no. You'll need to migrate to Flutter 3.24 (currently on stable channel).

jmagman · 2024-10-02T18:16:48Z

@lanistor There may be a way to do this manually by copying the Flutter dSYMs into your project: https://stackoverflow.com/a/52417617/431116
You can find the dSYMs at <flutter-sdk>/bin/cache/artifacts/engine/ios-release/Flutter.xcframework/ios-arm64/dSYMs/Flutter.framework.dSYM/

jmagman · 2024-10-02T18:25:33Z

Alternatively, it may work if you downgrade to Xcode 15.

GhassanAlKaraan · 2024-10-03T20:46:13Z

@lanistor There may be a way to do this manually by copying the Flutter dSYMs into your project: https://stackoverflow.com/a/52417617/431116 You can find the dSYMs at <flutter-sdk>/bin/cache/artifacts/engine/ios-release/Flutter.xcframework/ios-arm64/dSYMs/Flutter.framework.dSYM/

hey there. I can't find the dSYMs folder why? :) I am using flutter 3.19.0

lanistor · 2024-10-05T14:22:50Z

@lanistor There may be a way to do this manually by copying the Flutter dSYMs into your project: https://stackoverflow.com/a/52417617/431116 You can find the dSYMs at <flutter-sdk>/bin/cache/artifacts/engine/ios-release/Flutter.xcframework/ios-arm64/dSYMs/Flutter.framework.dSYM/

Thanks, i will try again.

GhassanAlKaraan · 2024-10-23T06:28:58Z

@lanistor There may be a way to do this manually by copying the Flutter dSYMs into your project: https://stackoverflow.com/a/52417617/431116 You can find the dSYMs at <flutter-sdk>/bin/cache/artifacts/engine/ios-release/Flutter.xcframework/ios-arm64/dSYMs/Flutter.framework.dSYM/

hey there. I can't find the dSYMs folder why? :) I am using flutter 3.19.0

Nevermind, I downgraded to xcode 15 to run my older flutter version 3.19.0

xcode 16 works fine with the newest stable flutter versions.

As of Xcode 16, App Store validation now requires that apps uploaded to the App store bundle dSYM debug information bundles for each Framework they embed. dSYM bundles are packaged in the Flutter.xcframework shipped in the `ios-release` tools archive as of engine patches: * flutter/engine#54414 * flutter/engine#54458 This copies the Flutter.framework.dSYM bundle from the tools cache to the app archive produced by `flutter build ipa`. Issue: flutter#116493

cbracken force-pushed the bundle-dSYM-in-archive branch 2 times, most recently from 5fce468 to f93be7c Compare August 8, 2024 00:21

cbracken requested review from jmagman and zanderso August 8, 2024 00:21

cbracken marked this pull request as ready for review August 8, 2024 00:21

cbracken force-pushed the bundle-dSYM-in-archive branch from f93be7c to 9f118f6 Compare August 8, 2024 00:21

zanderso reviewed Aug 8, 2024

View reviewed changes

zanderso approved these changes Aug 8, 2024

View reviewed changes

jmagman approved these changes Aug 8, 2024

View reviewed changes

cbracken added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 8, 2024

auto-submit bot merged commit ab6b776 into flutter:main Aug 8, 2024
27 checks passed

cbracken deleted the bundle-dSYM-in-archive branch August 8, 2024 17:01

engine-flutter-autoroll mentioned this pull request Aug 8, 2024

Roll Flutter Engine from 3978ddd8d7a7 to 387f6f3c5fdb (3 revisions) flutter/flutter#153111

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 8, 2024

ab6b7764a [iOS] Bundle dSYM packages in Flutter.xcframework (flutter/…

f494b3e

…engine#54414)

jmagman mentioned this pull request Aug 8, 2024

Flutter application missing framework dSYMs, validation error "The archive did not include a dSYM for the Flutter.framework with the UUIDs" flutter/flutter#116493

Closed

cbracken mentioned this pull request Aug 9, 2024

[iOS] Rename Flutter.dSYM to Flutter.framework.dSYM #54458

Merged

8 tasks

cbracken mentioned this pull request Aug 10, 2024

[iOS] Copy Flutter.framework.dSYM into app archive flutter/flutter#153215

Merged

9 tasks

cbracken mentioned this pull request Aug 10, 2024

[iOS] Do not archive/upload Flutter.dSYM to cloud #54492

Merged

8 tasks

jmagman added the cp: stable cherry pick to the stable release candidate branch label Aug 12, 2024

cbracken mentioned this pull request Sep 3, 2024

[CP] Add iOS dSYMs to codesign test flutter/flutter#154582

Merged

9 tasks

cbracken mentioned this pull request Sep 3, 2024

iOS,macOS: Add list of expected-unsigned binaries flutter/flutter#154591

Merged

9 tasks

cbracken mentioned this pull request Sep 4, 2024

iOS,macOS: Add list of expected-unsigned binaries flutter/flutter#154636

Merged

9 tasks

cbracken mentioned this pull request Sep 5, 2024

iOS,macOS: Skip codesigning files in unsigned_binaries.txt flutter/cocoon#3890

Merged

8 tasks

This comment was marked as off-topic.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[iOS] Bundle dSYM packages in Flutter.xcframework #54414

[iOS] Bundle dSYM packages in Flutter.xcframework #54414

cbracken commented Aug 7, 2024 •

edited

Loading

zanderso Aug 8, 2024

cbracken Aug 8, 2024 •

edited

Loading

zanderso Aug 8, 2024

cbracken Aug 8, 2024

lanistor commented Oct 2, 2024

cbracken commented Oct 2, 2024

jmagman commented Oct 2, 2024 •

edited

Loading

jmagman commented Oct 2, 2024

GhassanAlKaraan commented Oct 3, 2024

lanistor commented Oct 5, 2024

This comment was marked as off-topic.

GhassanAlKaraan commented Oct 23, 2024

[iOS] Bundle dSYM packages in Flutter.xcframework #54414

[iOS] Bundle dSYM packages in Flutter.xcframework #54414

Conversation

cbracken commented Aug 7, 2024 • edited Loading

Pre-launch Checklist

zanderso Aug 8, 2024

Choose a reason for hiding this comment

cbracken Aug 8, 2024 • edited Loading

Choose a reason for hiding this comment

zanderso Aug 8, 2024

Choose a reason for hiding this comment

cbracken Aug 8, 2024

Choose a reason for hiding this comment

lanistor commented Oct 2, 2024

cbracken commented Oct 2, 2024

jmagman commented Oct 2, 2024 • edited Loading

jmagman commented Oct 2, 2024

GhassanAlKaraan commented Oct 3, 2024

lanistor commented Oct 5, 2024

This comment was marked as off-topic.

GhassanAlKaraan commented Oct 23, 2024

cbracken commented Aug 7, 2024 •

edited

Loading

cbracken Aug 8, 2024 •

edited

Loading

jmagman commented Oct 2, 2024 •

edited

Loading