Move embedding and linking macOS Flutter frameworks into the tool #71764

jmagman · 2020-12-05T03:25:09Z

Description

macOS version of #51453. See details and discussion there.

Push linker and embedding logic into the tool so future changes (like distributing as an XCFramework, renaming FlutterMacOS.framework, etc) do not require changes in the user's project.

At some point FlutterMacOS.framework will ship with x86 and ARM slices. With this change, we will be able to introduce thinning (as iOS does) in the script without requiring a user project migration.

This change would also set us up to stop copying FlutterMacOS.framework to Flutter/ephemeral. On iOS, for example, the framework is copied directly from the artifacts directory to the BUILT_PRODUCTS_DIR so there's never a mismatch between a Release build and a Debug version of Flutter.

Changes

Remove App.framework and FlutterMacOS.framework link step in template build phase.
Remove App.framework and FlutterMacOS.framework from the framework embedding build phase.
Add migrator to do this automatically based on the Xcode identifiers. I confirmed these are the original template identifiers introduced in Support create for macOS (app and plugin) #40851.
Build the example and integration test macOS apps and see them migrate.
Remove disable_input_output_paths from the generated Podfile, and from the example projects. Now that FlutterMacOS.framework isn't being technically emitted by a build phase, the Disable CocoaPods input and output paths in Xcode build phase and adopt new Xcode build system #33684 workaround is no longer necessary.

Future Documentation

Add a macOS doc like https://flutter.dev/docs/development/ios-project-migration and include in the error message.
Add a website note like Add tip to remove disable_input_output_paths from Podfile website#4019 that disable_input_output_paths can be deleted. We decided not to automatically migrate this for existing iOS projects.

Related Issues

Fixes #56581
Part of #70413
Will make #60113 easier.

Tests

macos_project_migration_test

jmagman · 2020-12-05T03:26:04Z

packages/flutter_tools/bin/macos_assemble.sh

-if [[ -n "$VERBOSE_SCRIPT_LOGGING" ]]; then
-    verbose_flag="--verbose"
-fi
+BuildApp() {


This logic is unchanged other than putting it in a function (so whitespace indentation) and adding locals.

jmagman · 2020-12-05T03:26:14Z

packages/flutter_tools/bin/macos_assemble.sh

+
+# Adds the App.framework as an embedded binary and the flutter_assets as
+# resources.
+EmbedFrameworks() {


This is new.

jmagman · 2020-12-05T03:26:29Z

packages/flutter_tools/bin/macos_assemble.sh

+  fi
+}
+
+# Main entry point.


jmagman · 2020-12-05T03:27:52Z

...tter_tools/lib/src/macos/migrations/remove_macos_framework_link_and_embedding_migration.dart

@@ -0,0 +1,102 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.


This file is almost the same as https://github.com/flutter/flutter/blob/e1598c96c072a6323e8dbf2a1724a896533a6c27/packages/flutter_tools/lib/src/ios/migrations/remove_framework_link_and_embedding_migration.dart with different identifiers, doesn't do anything with add-to-app, and leaves off any Xcode version checks.

jmagman · 2020-12-05T03:28:31Z

...tter_tools/lib/src/macos/migrations/remove_macos_framework_link_and_embedding_migration.dart

+              label: 'failure', flutterUsage: _usage)
+          .send();
+      throwToolExit(
+          'Your Xcode project requires migration.');


I'll write a doc like https://flutter.dev/docs/development/ios-project-migration and link it here in a future PR.

stuartmorgan

LGTM with nit. The Dart rework part is optional; if you go that route I can re-review that piece.

Thanks for tackling this; it's great to reduce delta relative to iOS, and this sets us up for some great improvements!

dev/benchmarks/macrobenchmarks/macos/Runner.xcodeproj/project.pbxproj

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

dev/integration_tests/ui/macos/Runner.xcodeproj/project.pbxproj

dev/manual_tests/macos/Runner.xcodeproj/project.pbxproj

stuartmorgan · 2020-12-08T12:44:36Z

packages/flutter_tools/bin/macos_assemble.sh

+    "embed")
+      EmbedFrameworks ;;
+  esac
+fi


This is non-trivial new bash code; any chance we could use this as the impetus to finally switch macOS over to tool_backend.* so that this could all be Dart code instead?

I'm converging macOS and iOS scripts, and I'd like to do https://github.com/flutter/flutter/pull/70224/files#diff-cf570f69a008f028e95cfad7690ee32b3acbbc88379d340ea08ef67c0a3aff69R297 for macOS next (copy the FlutterMacOS framework directly to BUILT_PRODUCTS_DIR instead of ephemeral).

I'd rather get them to be the same bash script first since I know the iOS variant works, then swap them both over to the same dart code. That way each PR is a good improvement that isn't doing too much and is easy to review, and if it causes issues won't be a big painful revert.

Actually, a macOS version of #59044 needs to happen first because the BUILT_PRODUCTS_DIR update requires a Podfile change, but you get the idea.

...tter_tools/lib/src/macos/migrations/remove_macos_framework_link_and_embedding_migration.dart

packages/flutter_tools/templates/app/macos.tmpl/Runner.xcodeproj/project.pbxproj.tmpl

packages/integration_test/example/macos/Runner.xcodeproj/project.pbxproj

jmagman · 2020-12-08T19:58:32Z

Google testing failing because #71757 hasn't rolled yet.

…tool (#71764)" This reverts commit 70f8fde.

…tool (#71764)" (#71951) This reverts commit 70f8fde.

…utter#71764)

jmagman self-assigned this Dec 5, 2020

flutter-dashboard bot added team Infra upgrades, team productivity, code health, technical debt. See also team: labels. tool Affects the "flutter" command-line tool. See also t: labels. labels Dec 5, 2020

google-cla bot added the cla: yes label Dec 5, 2020

jmagman commented Dec 5, 2020

View reviewed changes

jmagman force-pushed the macos-link-tool branch from e0c4519 to 0c3af8f Compare December 7, 2020 19:35

jmagman requested a review from stuartmorgan December 7, 2020 20:19

stuartmorgan approved these changes Dec 8, 2020

View reviewed changes

jmagman added 2 commits December 8, 2020 10:55

Move embedding and linking macOS Flutter frameworks into the tool

18d50b8

&&

7238631

jmagman force-pushed the macos-link-tool branch from 0c3af8f to 7238631 Compare December 8, 2020 18:58

jmagman merged commit 70f8fde into flutter:master Dec 8, 2020

jmagman deleted the macos-link-tool branch December 8, 2020 19:59

jmagman added a commit that referenced this pull request Dec 8, 2020

Revert "Move embedding and linking macOS Flutter frameworks into the …

0b42c3c

…tool (#71764)" This reverts commit 70f8fde.

jmagman mentioned this pull request Dec 8, 2020

Revert "Move embedding and linking macOS Flutter frameworks into the tool" #71951

Merged

jmagman added a commit that referenced this pull request Dec 8, 2020

Revert "Move embedding and linking macOS Flutter frameworks into the …

c88ab79

…tool (#71764)" (#71951) This reverts commit 70f8fde.

jmagman added a commit to jmagman/flutter that referenced this pull request Dec 9, 2020

Move embedding and linking macOS Flutter frameworks into the tool (fl…

d4eb08e

…utter#71764)

This was referenced Dec 9, 2020

Reland Move embedding and linking macOS Flutter frameworks into the tool #71965

Merged

Load macOS dart bundle by URL fallback flutter/engine#22979

Merged

Reland Move embedding and linking macOS Flutter frameworks into the tool #72372

Merged

This was referenced Dec 21, 2020

Load App.framework in macOS app flutter/engine#23221

Merged

[MacOS] Apple rejects MacOS archive with "ITMS-90332: Invalid Symbolic Link" #73028

Closed

Avoid broken symlinks in embedded Flutter frameworks #73052

Merged

jmagman mentioned this pull request Nov 1, 2022

Condense iOS and macOS into a single Xcode project #114179

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move embedding and linking macOS Flutter frameworks into the tool #71764

Move embedding and linking macOS Flutter frameworks into the tool #71764

jmagman commented Dec 5, 2020 •

edited

jmagman Dec 5, 2020

jmagman Dec 5, 2020

jmagman Dec 5, 2020

jmagman Dec 5, 2020

jmagman Dec 5, 2020

stuartmorgan left a comment

stuartmorgan Dec 8, 2020

jmagman Dec 8, 2020

jmagman Dec 8, 2020

jmagman commented Dec 8, 2020

		@@ -0,0 +1,102 @@
		// Copyright 2014 The Flutter Authors. All rights reserved.

Move embedding and linking macOS Flutter frameworks into the tool #71764

Move embedding and linking macOS Flutter frameworks into the tool #71764

Conversation

jmagman commented Dec 5, 2020 • edited

Description

Changes

Future Documentation

Related Issues

Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stuartmorgan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmagman commented Dec 8, 2020

jmagman commented Dec 5, 2020 •

edited