Move Flutter.framework to build directory instead of ios/Flutter #70224

jmagman · 2020-11-10T20:27:44Z

Description

Create UnpackIOS build system target similar to UnpackMacOS so assemble will copy the Flutter.framework from the engine artifacts to the built products directory. For example, flutter build ios -v --simulator will copy to /build/ios/Debug-iphonesimulator/Flutter.framework.
Stop copying the Flutter.framework to ios/Flutter/Flutter.framework. Remove it with flutter clean.
Remove FRAMEWORK_SEARCH_PATHS build setting from template and all example projects to prefer the built products directory, which we always get for free. I didn't write a migrator since leaving this around in existing apps is harmless--the inherited part means it will find our copied framework first.
Move the Flutter search path and linking behavior out of CocoaPods by generating a "fake" Flutter.podspec that doesn't point to a real framework. This is necessary because plugin podspecs contain s.dependency 'Flutter' and CocoaPods will try to download it from the CoocaPods trunk if the Podfile doesn't pod 'Flutter', :path => relative/file
Search path and linking is now handled by adding build settings in the Podfile via the podhelper.rb. Plugins will now link on the frameworks in the artifact cache (this is an absolute path added to the Pods project, but it's already excluded from source control in the .gitignore so this should be fine).
This doesn't change any add-to-app copying behavior--the framework is still being copied to the .ios/Flutter/engine directory. It will embed the assembly copied framework in the built products directory. I think this can be fixed, but it can be done in another PR.

This will have the added benefit of speeding up build times since the framework will only be copied to the built products directory if assemble decides it's necessary.

Related Issues

Fixes #12631
Fixes #29840
Fixes #37850
Fixes #51989
Fixes #55013

First step of #60109
#60118
Similar to the work done to move App.framework to the built products directory #69699

Avoids #39356 (comment) (it would be possible to turn bitcode on if all plugins support bitcode)
App deltas may become easier to implement because the framework won't be re-copied (still more work needed to not re-codesign if it's already signed?) #67580

Tests

Unpack copies Flutter.framework
plugin_lint_mac
clean test

Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change. If not, delete the remainder of this section.

jmagman · 2020-11-14T02:06:14Z

dev/integration_tests/release_smoke_test/ios/Runner.xcodeproj/project.pbxproj

CocoaPods removed this since it's no longer embedding and code signing the Flutter.framework.

jmagman · 2020-11-14T02:08:31Z

packages/flutter_tools/bin/podhelper.rb

The :debug and :release build configuration mapping is pulled from the Podfile, so flavor build configurations will be handled instead of trying to parse Flavor-Release==ios-release etc:

flutter/packages/flutter_tools/templates/cocoapods/Podfile-ios-swift

Lines 7 to 10 in 319a61f

project 'Runner', {

'Debug' => :debug,

'Profile' => :release,

'Release' => :release,

jmagman · 2020-11-14T02:09:41Z

packages/flutter_tools/bin/podhelper.rb

This is the tricksy bit. CocoaPods is satisfied because Flutter.podspec exists, but it doesn't actually add the Flutter.framework or any embedding logic because the framework doesn't exist at this path.

jmagman · 2020-11-14T02:10:17Z

packages/flutter_tools/bin/xcode_backend.sh

It's okay to use the BUILT_PRODUCTS_DIR engine for add-to-app because assemble put it in the right place.

jmagman · 2020-11-14T02:17:39Z

dev/integration_tests/flutter_gallery/ios/Runner.xcodeproj/project.pbxproj

CocoaPods removed this since it's no longer embedding and code signing the Flutter.framework.

jonahwilliams

LGTM

Do you have any other concerns about the fake podspec file? Is there a more difficult but more correct option that should be tracked?

jmagman · 2020-11-16T19:14:15Z

Do you have any other concerns about the fake podspec file? Is there a more difficult but more correct option that should be tracked?

The only thing I can think of is to remove the s.dependency 'Flutter' from the plugin template the next time we increase the sdk version constraint (like #62605) past this change, though I think we would need to keep supporting this for older plugins.

Another concern would be if CocoaPods changes its validation behavior to fail at pod install if the vendored framework path doesn't exist. Right now it doesn't complain, creates the Flutter pod target, but doesn't add a framework and doesn't add the bogus path to the other pods's search path, which is exactly what we want.

fluttergithubbot · 2020-11-16T23:03:02Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Mac build_tests has failed. Please fix the issues identified (or deflake) before re-applying this label.

jmagman · 2020-11-16T23:30:22Z

@jonahwilliams Nice test, you got me.

Not all build targets cached after second run.
The target performance data was: 
...
{"name":"debug_unpack_ios","skipped":false,"succeeded":true,"elapsedMilliseconds":33},

jmagman added platform-ios iOS applications specifically t: xcode "xcodebuild" on iOS and general Xcode project management labels Nov 10, 2020

jmagman self-assigned this Nov 10, 2020

flutter-dashboard bot added d: examples Sample code and demos c: contributor-productivity Team-specific productivity, code health, technical debt. tool Affects the "flutter" command-line tool. See also t: labels. work in progress; do not review labels Nov 10, 2020

google-cla bot added the cla: yes label Nov 10, 2020

jmagman force-pushed the framework-build-system branch 2 times, most recently from dd75ed5 to f0732b9 Compare November 14, 2020 01:43

jmagman commented Nov 14, 2020

View reviewed changes

jmagman marked this pull request as ready for review November 14, 2020 02:10

jmagman commented Nov 14, 2020

View reviewed changes

kluv161 approved these changes Nov 14, 2020

View reviewed changes

jmagman requested review from jonahwilliams, stuartmorgan-g and xster November 14, 2020 03:05

jmagman removed the work in progress; do not review label Nov 14, 2020

jonahwilliams approved these changes Nov 16, 2020

View reviewed changes

jmagman added the waiting for tree to go green label Nov 16, 2020

fluttergithubbot removed the waiting for tree to go green label Nov 16, 2020

jmagman force-pushed the framework-build-system branch from f0732b9 to d442b2d Compare November 16, 2020 23:32

jmagman added 2 commits November 16, 2020 15:49

Move Flutter.framework copy into build system

ff2bafe

Stop copying Flutter.framework to project directory

f34bbcc

jmagman mentioned this pull request Nov 18, 2020

Stop extra framework copy during build ios-framework #70790

Merged

xster mentioned this pull request Nov 26, 2020

Plugin linking fails using local engine: Flutter.framework/Flutter, building for iOS-arm64 but attempting to link with file built for iOS Simulator-x86_64 #51989

Open

jmagman mentioned this pull request Dec 28, 2020

The 'Pods-Runner' target has transitive dependencies that include statically linked binaries: (/Users/tossdown/Documents/FLUTTER/Projects/shezan/ios/Flutter/Flutter.framework) #58584

Open

jmagman mentioned this pull request Jan 8, 2021

Enable bitcode for new iOS projects #73607

Closed

jmagman mentioned this pull request Jan 27, 2021

[!] The 'Pods-Runner' target has transitive dependencies that include static frameworks: #20045

Closed

jmagman mentioned this pull request Apr 14, 2021

Could not find or use auto-linked framework 'Flutter' from app extension #78436

Closed

jmagman mentioned this pull request May 27, 2021

iPad running iOS 12 -- Stuck on Splash Screen #22765

Closed

jmagman mentioned this pull request Aug 25, 2021

The 'Pods-Runner' target has transitive dependencies #14161

Open

jmagman mentioned this pull request Dec 13, 2021

Failed to find assets path for "Frameworks/App.framework/flutter_assets" from flutter module #94481

Closed

jmagman mentioned this pull request Apr 14, 2022

Exclude armv7 from iOS add-to-app plugins #101943

Merged

8 tasks

jmagman mentioned this pull request May 4, 2022

Remove unused iOS and macOS podspecs flutter/engine#33115

Merged

8 tasks

jmagman mentioned this pull request Nov 18, 2022

Flutter run way slower than XCode build #115419

Closed

jmagman mentioned this pull request Sep 6, 2024

Flutter iOS app opened in Xcode shows a confusing "Cannot find module 'Flutter'" error until the app is built the first time #154647

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Move Flutter.framework to build directory instead of ios/Flutter #70224

Move Flutter.framework to build directory instead of ios/Flutter #70224

Uh oh!

jmagman commented Nov 10, 2020 •

edited

Loading

Uh oh!

jmagman Nov 14, 2020

Uh oh!

jmagman Nov 14, 2020 •

edited

Loading

Uh oh!

jmagman Nov 14, 2020

Uh oh!

jmagman Nov 14, 2020

Uh oh!

jmagman Nov 14, 2020

Uh oh!

jonahwilliams left a comment

Uh oh!

jmagman commented Nov 16, 2020

Uh oh!

fluttergithubbot commented Nov 16, 2020

Uh oh!

jmagman commented Nov 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	project 'Runner', {
	'Debug' => :debug,
	'Profile' => :release,
	'Release' => :release,

Move Flutter.framework to build directory instead of ios/Flutter #70224

Move Flutter.framework to build directory instead of ios/Flutter #70224

Uh oh!

Conversation

jmagman commented Nov 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

jmagman Nov 14, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Nov 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman Nov 14, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Nov 14, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Nov 14, 2020

Choose a reason for hiding this comment

Uh oh!

jonahwilliams left a comment

Choose a reason for hiding this comment

Uh oh!

jmagman commented Nov 16, 2020

Uh oh!

fluttergithubbot commented Nov 16, 2020

Uh oh!

jmagman commented Nov 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jmagman commented Nov 10, 2020 •

edited

Loading

jmagman Nov 14, 2020 •

edited

Loading