Native assets: package in framework on iOS and MacOS #140907

dcharkes · 2024-01-03T19:52:21Z

Packages the native assets for iOS and MacOS in frameworks.

Issue:

Details

This packages dylibs from the native assets feature in frameworks. It packages every dylib in a separate framework.
The dylib name is updated to use @rpath instead of @executable_path.
The dylibs for flutter-tester are no longer modified to change the install name. (Previously it was wrongly updating the install name to the location the dylib would have once deployed in an app.)
Use symlinking on MacOS.

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, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
All existing and new tests are passing.

dcharkes · 2024-01-08T08:45:33Z

@jmagman @vashworth Friendly ping!

vashworth · 2024-01-08T20:52:18Z

packages/flutter_tools/lib/src/ios/native_assets.dart

-      return asset.copyWith(path: AssetAbsolutePath(Uri(path: fileName)));
+      final String name =
+          fileName.replaceFirst('lib', '').replaceFirst('.dylib', '');
+      return asset.copyWith(


Are all absolute asset paths guaranteed to start with lib?

Also, are other path types guaranteed to be the correct name?

Can you add a comment, explaining why this is needed?

I've moved it to a separate function and added the comments there.

It's still unclear to me why only AssetAbsolutePath need to have the name parsed.

The other 3 types do not reflect path types in the destination app:

Executable: symbol is available in the current executable (will be used once we have static linking)

Process: symbol is available in the current process (current executable or a dylib already loaded)

System: symbol is available in the system include path (e.g. win32 dlls on Windows)

All these 3 path types are untreated by the Flutter tools. Whatever build.dart outputs will be put 1 on 1 into the native assets mapping.
The paths are untreated, because there are no files being treated.

For absolute asset paths, the files are being treated by Flutter, we lipo them, put them in a .framework and resign them.

packages/flutter_tools/lib/src/macos/native_assets.dart

dcharkes · 2024-01-12T13:45:08Z

@jmagman @vashworth Friendly ping!

vashworth

LGTM

dcharkes · 2024-01-17T14:08:21Z

Friendly ping @jmagman.

jmagman

Apologies for the delay on this.
@dcharkes can you point me to an example of how to generate these frameworks? I try it out and see if the bundle format looks correct with a manual test.

packages/flutter_tools/lib/src/macos/native_assets_host.dart

dcharkes · 2024-01-17T18:40:31Z

Apologies for the delay on this. @dcharkes can you point me to an example of how to generate these frameworks? I try it out and see if the bundle format looks correct with a manual test.

You can run test/integration.shard/native_assets_test.dart locally and stop it from deleting the temp folders.
Or you can do the steps manually, flutter create --template=package_ffi --target=macos,ios and use flutter build macos.

packages/flutter_tools/lib/src/macos/native_assets_host.dart

Co-authored-by: Jenn Magder <magder@google.com>

jmagman

LGTM, thanks for tackling all this!

dcharkes · 2024-01-19T19:51:53Z

LGTM, thanks for tackling all this!

You're welcome! And thanks for pointing me in the right direction!

Thanks @SKKbySSK for reporting the problem!

auto-submit · 2024-01-19T19:59:25Z

auto label is removed for flutter/flutter/140907, due to - The status or check suite Mac tool_integration_tests_4_4 has failed. Please fix the issues identified (or deflake) before re-applying this label.

jmagman · 2024-01-19T20:04:15Z

Not sure about that overall_experience_test failure, I filed #141892 to investigate. Re-running.

…/flutter#140907)

Manual roll Flutter from f77f824 to 684247a (39 revisions) Manual roll requested by dit@google.com flutter/flutter@f77f824...684247a 2024-01-19 reidbaker@google.com Use Integer instead of int in map in flutter.groovy (flutter/flutter#141895) 2024-01-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from c953c83112ba to f2b441a26416 (4 revisions) (flutter/flutter#141894) 2024-01-19 dacoharkes@google.com Native assets: package in framework on iOS and MacOS (flutter/flutter#140907) 2024-01-19 ian@hixie.ch Revert "Make tests more resilient to Skia gold failures and refactor flutter_goldens for extensive technical debt removal (#140101)" (flutter/flutter#141814) 2024-01-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 538975f2511b to c953c83112ba (3 revisions) (flutter/flutter#141886) 2024-01-19 36861262+QuncCccccc@users.noreply.github.com Add `showDragHandle` to `showBottomSheet` (flutter/flutter#141754) 2024-01-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9a6c64de8a46 to 538975f2511b (8 revisions) (flutter/flutter#141881) 2024-01-19 goderbauer@google.com Make pumpWidget's arguments named (flutter/flutter#141728) 2024-01-19 5236035+fzyzcjy@users.noreply.github.com Tiny fix inaccurate documentations about bindings (flutter/flutter#140282) 2024-01-19 zanderso@users.noreply.github.com Roll engine to 9a6c64de8a4694cef59a338cd33ac1a9e7d23d9d (flutter/flutter#141870) 2024-01-19 engine-flutter-autoroll@skia.org Roll Packages from 83c2c4d to 129e08c (13 revisions) (flutter/flutter#141865) 2024-01-19 godofredoc@google.com Add mac_x64_ios configuration. (flutter/flutter#141828) 2024-01-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from 90be25d8aac3 to d1afda52d254 (1 revision) (flutter/flutter#141825) 2024-01-19 ian@hixie.ch Move the requestKeyboard up to the widgets layer (flutter/flutter#141655) 2024-01-19 engine-flutter-autoroll@skia.org Roll Flutter Engine from dde3ebf6551a to 90be25d8aac3 (1 revision) (flutter/flutter#141817) 2024-01-18 yjbanov@google.com enable more tests in web mode (flutter/flutter#141791) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9dded186bcff to dde3ebf6551a (2 revisions) (flutter/flutter#141811) 2024-01-18 davidmartos96@gmail.com Update margin between label and icon in Tab to better reflect Material specs (flutter/flutter#140698) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3106e08e1219 to 9dded186bcff (2 revisions) (flutter/flutter#141807) 2024-01-18 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Enable native compilation for windows-arm64 " (flutter/flutter#141809) 2024-01-18 godofredoc@google.com Run framework_tests_misc in arm64 and x64. (flutter/flutter#141797) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from f4a4f046b173 to 3106e08e1219 (1 revision) (flutter/flutter#141802) 2024-01-18 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.1.0 to 4.2.0 (flutter/flutter#141803) 2024-01-18 goderbauer@google.com Update labeler.yml (flutter/flutter#141697) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from 75400c49fa0b to f4a4f046b173 (2 revisions) (flutter/flutter#141800) 2024-01-18 polinach@google.com Reland "Remove hack from PageView." (flutter/flutter#141533) 2024-01-18 smartercallum@gmail.com ScaleGestureRecognizer pointerCount=2 for trackpad gestures (flutter/flutter#140745) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from de68e7612948 to 75400c49fa0b (2 revisions) (flutter/flutter#141796) 2024-01-18 15619084+vashworth@users.noreply.github.com Run `flutter_gallery_ios__start_up` test on Mac-14 in staging (flutter/flutter#141795) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from d80fe1cb5854 to de68e7612948 (1 revision) (flutter/flutter#141789) 2024-01-18 101587250+pbo-linaro@users.noreply.github.com Enable native compilation for windows-arm64 (flutter/flutter#137618) 2024-01-18 xilaizhang@google.com [github actions] Fix token issue on actions/checkout package (flutter/flutter#141652) 2024-01-18 engine-flutter-autoroll@skia.org Roll Flutter Engine from b75d6d80d813 to d80fe1cb5854 (2 revisions) (flutter/flutter#141785) 2024-01-18 jesus_sguerrero@hotmail.com Revert "Native assets: roll deps" (flutter/flutter#141748) 2024-01-18 6655696+guidezpl@users.noreply.github.com Deprecate M2 curves (flutter/flutter#134417) 2024-01-18 rmolivares@renzo-olivares.dev Fix: TextField can inherit `errorStyle` from `InputDecorationTheme`. (flutter/flutter#141227) 2024-01-18 109111084+yaakovschectman@users.noreply.github.com Add check for Bank of Brazil security module to Windows Flutter Doctor validators (flutter/flutter#141135) 2024-01-18 reidbaker@google.com Fix gradle lints No semantic change should be present. (flutter/flutter#141692) 2024-01-18 engine-flutter-autoroll@skia.org Roll Packages from 1a2b780 to 83c2c4d (5 revisions) (flutter/flutter#141778) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC dit@google.com,rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human ...

SKKbySSK · 2024-01-29T11:00:37Z

@dcharkes
I've confirmed that the framework was built as expected on the latest master.
Thanks for handling the issue!

dcharkes · 2024-01-29T11:17:32Z

@dcharkes I've confirmed that the framework was built as expected on the latest master. Thanks for handling the issue!

Thanks for double checking! 🙏

github-actions bot added platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. a: desktop Running on desktop labels Jan 3, 2024

dcharkes requested review from jmagman and vashworth January 3, 2024 19:59

dcharkes mentioned this pull request Jan 3, 2024

Native Assets should use Framework instead of dylib on iOS. #140544

Closed

Native assets package in framework

d7e14f9

dcharkes force-pushed the native-assets-frameworks branch from e204e61 to d7e14f9 Compare January 4, 2024 12:29

formatting

414c157

gspencergoog requested a review from cbracken January 4, 2024 19:15

vashworth reviewed Jan 8, 2024

View reviewed changes

dcharkes added 7 commits January 9, 2024 09:12

Merge branch 'master' into native-assets-frameworks

632cb41

Formatting and fix comment

942c157

Move framework naming to shared function

f30dd1b

Merge branch 'master' into native-assets-frameworks

83962e2

Fix test

3f747e9

Remove path separator

a666eb3

Merge branch 'master' into native-assets-frameworks

8242241

vashworth approved these changes Jan 12, 2024

View reviewed changes

jmagman reviewed Jan 17, 2024

View reviewed changes

packages/flutter_tools/lib/src/macos/native_assets_host.dart Outdated Show resolved Hide resolved

packages/flutter_tools/lib/src/macos/native_assets_host.dart Outdated Show resolved Hide resolved

dcharkes added 4 commits January 19, 2024 10:15

Merge branch 'master' into native-assets-frameworks

95b7f49

Add more constraints on the framework name

878301e

Fix test

bfd360a

More test fixage

cd2e70a

dcharkes requested a review from jmagman January 19, 2024 16:25

jmagman reviewed Jan 19, 2024

View reviewed changes

packages/flutter_tools/lib/src/macos/native_assets_host.dart Outdated Show resolved Hide resolved

Update packages/flutter_tools/lib/src/macos/native_assets_host.dart

dbe3261

Co-authored-by: Jenn Magder <magder@google.com>

jmagman approved these changes Jan 19, 2024

View reviewed changes

dcharkes added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 19, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 19, 2024

dcharkes added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 19, 2024

auto-submit bot merged commit 2e229be into master Jan 19, 2024

auto-submit bot deleted the native-assets-frameworks branch January 19, 2024 20:29

engine-flutter-autoroll mentioned this pull request Jan 19, 2024

Manual roll Flutter from f77f82435a97 to 684247a3c78a (39 revisions) flutter/packages#5948

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 19, 2024

2e229be Native assets: package in framework on iOS and MacOS (flutter…

1762cc5

…/flutter#140907)

dcharkes mentioned this pull request Feb 14, 2024

Framework support? dart-lang/native#159

Closed

dcharkes mentioned this pull request Apr 18, 2024

[Question] How to add .framework to asset correctly dart-lang/native#1094

Closed

dcharkes mentioned this pull request May 7, 2025

cargo rust .dylib in ios #168453

Closed

Native assets: package in framework on iOS and MacOS #140907

Native assets: package in framework on iOS and MacOS #140907

Uh oh!

Conversation

dcharkes commented Jan 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Pre-launch Checklist

Uh oh!

dcharkes commented Jan 8, 2024

Uh oh!

vashworth Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

vashworth Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

vashworth Jan 8, 2024

Choose a reason for hiding this comment

Uh oh!

dcharkes Jan 9, 2024

Choose a reason for hiding this comment

Uh oh!

vashworth Jan 9, 2024

Choose a reason for hiding this comment

Uh oh!

dcharkes Jan 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dcharkes commented Jan 12, 2024

Uh oh!

vashworth left a comment

Choose a reason for hiding this comment

Uh oh!

dcharkes commented Jan 17, 2024

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dcharkes commented Jan 17, 2024

Uh oh!

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

dcharkes commented Jan 19, 2024

Uh oh!

auto-submit bot commented Jan 19, 2024

Uh oh!

jmagman commented Jan 19, 2024

Uh oh!

SKKbySSK commented Jan 29, 2024

Uh oh!

dcharkes commented Jan 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dcharkes commented Jan 3, 2024 •

edited

Loading