Create correctly structured framework for macOS #38748

jonahwilliams · 2019-08-17T16:44:18Z

Description

~~TBD: which Info.plist should I be using?~~

Template created from xcode, copyright removed and flutter bundle identifier added.

codecov · 2019-08-17T17:19:19Z

Codecov Report

Merging #38748 into master will decrease coverage by 0.1%.
The diff coverage is 83.87%.

@@            Coverage Diff             @@
##           master   #38748      +/-   ##
==========================================
- Coverage   56.24%   56.13%   -0.11%     
==========================================
  Files         195      195              
  Lines       18275    18298      +23     
==========================================
- Hits        10278    10271       -7     
- Misses       7997     8027      +30

Flag	Coverage Δ
#flutter_tool	`56.13% <83.87%> (-0.11%)`	⬇️

Impacted Files	Coverage Δ
...tter_tools/lib/src/build_system/targets/macos.dart	`50.41% <83.87%> (+8.57%)`	⬆️
...ackages/flutter_tools/lib/src/commands/config.dart	`52% <0%> (-34.67%)`	⬇️
...ckages/flutter_tools/lib/src/commands/devices.dart	`53.84% <0%> (-23.08%)`	⬇️
packages/flutter_tools/lib/src/device.dart	`54.81% <0%> (-2.41%)`	⬇️
...ages/flutter_tools/lib/src/linux/linux_device.dart	`41.3% <0%> (-2.18%)`	⬇️
.../flutter_tools/lib/src/android/android_device.dart	`32% <0%> (-2%)`	⬇️
packages/flutter_tools/lib/src/version.dart	`90.73% <0%> (-1.96%)`	⬇️
packages/flutter_tools/lib/src/cache.dart	`43.02% <0%> (-0.73%)`	⬇️
.../flutter_tools/lib/src/fuchsia/fuchsia_device.dart	`55.01% <0%> (-0.38%)`	⬇️
packages/flutter_tools/lib/src/project.dart	`82.58% <0%> (+0.32%)`	⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8edc3f7...7487c7a. Read the comment docs.

stuartmorgan-g

For the plist, you'll need a template like https://github.com/flutter/flutter/blob/c40d701e9638e9182a8581ecd3634203228618a5/packages/flutter_tools/templates/app/ios.tmpl/Flutter/AppFrameworkInfo.plist

Looking at that one, I think it's probably just a stock framework plist with the bundle ID changed, so you can create a new macOS framework project in Xcode, take that, and change the ID. Please use the same bundle ID so that the FlutterDartProject change I need to do can share as much logic as possible.

stuartmorgan-g · 2019-08-17T20:44:23Z

packages/flutter_tools/lib/src/build_system/targets/macos.dart

+      if (!currentResources.existsSync()) {
+        currentResources.createSync(fs.path.join(currentVersion.path, 'Resources'));
+      }
+      // Create symlink to current resources


s/resources/binary/

stuartmorgan-g · 2019-08-17T20:44:51Z

packages/flutter_tools/lib/src/build_system/targets/macos.dart

+      }
+    } on FileSystemException {
+      throw Exception('Failed to create symlinks for framework. try removing '
+        'the "macos/Fluter/ephemeral" directory and rerunning');


Flutter

(Or even better, get this from the project instead of hard-coding the string, so it won't get stale.)

…mework

jonahwilliams · 2019-08-19T17:52:39Z

I've updated the Info.plist to use one from a cocoa application created by Xcode, minus the copyright key and with the flutter bundle identifier.

stuartmorgan-g · 2019-08-19T21:33:27Z

packages/flutter_tools/lib/src/build_system/targets/macos.dart

+    // Copy Info.plist template.
+    assetDirectory.parent.childFile('Info.plist')
+      ..createSync()
+      ..writeAsStringSync(r'''


Why inline rather than a template file like iOS?

I'm assuming that since this is ephemeral we don't want to require the user to manually create it each time. Using the templating is complex, It's not tested as well as I like and it relies on mirrors via a 3rd party templating library.

jmagman · 2019-08-20T00:18:24Z

packages/flutter_tools/lib/src/build_system/targets/macos.dart

+	<string>$(MACOSX_DEPLOYMENT_TARGET)</string>
+	<key>NSMainStoryboardFile</key>
+	<string>Main</string>
+	<key>NSPrincipalClass</key>


This looks like an application Info.plist, not a Framework one. CFBundleIconFile, NSPrincipalClass, NSMainStoryboardFile keys shouldn't be there, and the CFBundlePackageType should be FMWK.
The one I just generated:

$ plutil -p Info.plist { "CFBundleDevelopmentRegion" => "$(DEVELOPMENT_LANGUAGE)" "CFBundleExecutable" => "$(EXECUTABLE_NAME)" "CFBundleIdentifier" => "$(PRODUCT_BUNDLE_IDENTIFIER)" "CFBundleInfoDictionaryVersion" => "6.0" "CFBundleName" => "$(PRODUCT_NAME)" "CFBundlePackageType" => "$(PRODUCT_BUNDLE_PACKAGE_TYPE)" "CFBundleShortVersionString" => "1.0" "CFBundleVersion" => "$(CURRENT_PROJECT_VERSION)" "NSHumanReadableCopyright" => "Copyright © 2019 <etc> . All rights reserved." }

And once it was a built product from Xcode:

{ "BuildMachineOSBuild" => "18G87" "CFBundleDevelopmentRegion" => "en" "CFBundleExecutable" => "TestFramework" "CFBundleIdentifier" => "com.google.TestFramework" "CFBundleInfoDictionaryVersion" => "6.0" "CFBundleName" => "TestFramework" "CFBundlePackageType" => "FMWK" "CFBundleShortVersionString" => "1.0" "CFBundleSupportedPlatforms" => [ 0 => "MacOSX" ] "CFBundleVersion" => "1" "DTCompiler" => "com.apple.compilers.llvm.clang.1_0" "DTPlatformBuild" => "11M382q" "DTPlatformVersion" => "GM" "DTSDKBuild" => "19A526e" "DTSDKName" => "macosx10.15" "DTXcode" => "1100" "DTXcodeBuild" => "11M382q" "NSHumanReadableCopyright" => "Copyright © 2019 <etc> . All rights reserved." }

Ahh, thanks! I'll update the template

Updated to use the Info.plist from a cocoa framework project. I don't think we need/want the copyright key, correct?

jmagman · 2019-08-20T00:41:03Z

packages/flutter_tools/lib/src/build_system/targets/macos.dart

+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>


Sorry, I should have been more clear. Because this isn't getting run through Xcode, those build setting variables probably need to be resolved.

<dict> <key>CFBundleDevelopmentRegion</key> <string>en</string> <key>CFBundleExecutable</key> <string>App</string> <key>CFBundleIdentifier</key> <string>io.flutter.flutter.app</string> <key>CFBundleInfoDictionaryVersion</key> <string>6.0</string> <key>CFBundleName</key> <string>App</string> <key>CFBundlePackageType</key> <string>FMWK</string> <key>CFBundleShortVersionString</key> <string>1.0</string> <key>CFBundleVersion</key> <string>1.0</string> </dict>

jmagman · 2019-08-20T00:51:17Z

packages/flutter_tools/lib/src/build_system/targets/macos.dart

+    // Copy App into framework directory.
+    environment.buildDir
+      .childDirectory('App.framework')
+      .childFile('App')


This binary should also be a symlink from frameworkRootDirectory, not a copy.

Just to look at the anatomy of an embedded Xcode framework (because if they aren't getting it right then no one is) at Xcode.app/Contents/Frameworks/DFRSupportKit.framework:

lrwxr-xr-x 1 primarygroup 30 Jul 29 14:36 ./DFRSupportKit -> Versions/Current/DFRSupportKit lrwxr-xr-x 1 primarygroup 26 Jul 29 14:36 ./Resources -> Versions/Current/Resources drwxr-xr-x 4 primarygroup 128 Jul 29 14:51 ./Versions drwxr-xr-x 5 primarygroup 160 Jul 26 10:01 ./Versions/A -rwxr-xr-x 1 primarygroup 22704 Jul 26 10:01 ./Versions/A/DFRSupportKit drwxr-xr-x 4 primarygroup 128 Jul 25 02:18 ./Versions/A/Resources -rw-r--r-- 1 primarygroup 789 Jul 25 02:18 ./Versions/A/Resources/Info.plist -rw-r--r-- 1 primarygroup 521 Jul 25 02:18 ./Versions/A/Resources/version.plist drwxr-xr-x 3 primarygroup 96 Jul 25 02:18 ./Versions/A/_CodeSignature -rw-r--r-- 1 primarygroup 2674 Jul 26 10:01 ./Versions/A/_CodeSignature/CodeResources lrwxr-xr-x 1 primarygroup 1 Jul 29 14:36 ./Versions/Current -> A

The only non-symlink -type file files are in Versions/A/ but the symlinks all link Versions/Current

-rwxr-xr-x 1 primarygroup 22704 Jul 26 10:01 ./Versions/A/DFRSupportKit -rw-r--r-- 1 primarygroup 789 Jul 25 02:18 ./Versions/A/Resources/Info.plist -rw-r--r-- 1 primarygroup 521 Jul 25 02:18 ./Versions/A/Resources/version.plist -rw-r--r-- 1 primarygroup 2674 Jul 26 10:01 ./Versions/A/_CodeSignature/CodeResources

The binary is located under versions/A. The copy in build_dir is in a build cache under .dart_tool/flutter_build/hashed-values.

jmagman

LGTM!

jonahwilliams added 2 commits August 17, 2019 09:36

create full framework for macOS

9eb900c

fix macOS test case

dfcf39e

fluttergithubbot added the tool Affects the "flutter" command-line tool. See also t: labels. label Aug 17, 2019

googlebot added the cla: yes label Aug 17, 2019

jonahwilliams mentioned this pull request Aug 17, 2019

Correct flutter_assets path for full framework google/flutter-desktop-embedding#488

Merged

stuartmorgan-g requested changes Aug 17, 2019

View reviewed changes

jonahwilliams added 2 commits August 19, 2019 10:36

Merge branch 'master' of github.com:flutter/flutter into fix_full_fra…

5ec222a

…mework

use templated info plist, fix string

c6cd4d0

jonahwilliams requested a review from stuartmorgan-g August 19, 2019 19:30

stuartmorgan-g approved these changes Aug 19, 2019

View reviewed changes

jmagman requested changes Aug 20, 2019

View reviewed changes

fix Info.plist

32df9ac

jonahwilliams requested a review from jmagman August 20, 2019 00:35

jmagman requested changes Aug 20, 2019

View reviewed changes

Update macos.dart

7487c7a

jonahwilliams requested a review from jmagman August 20, 2019 16:58

jmagman approved these changes Aug 20, 2019

View reviewed changes

jonahwilliams merged commit 2504a41 into flutter:master Aug 20, 2019

jonahwilliams deleted the fix_full_framework branch August 20, 2019 17:49

github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2021

Create correctly structured framework for macOS #38748

Create correctly structured framework for macOS #38748

Uh oh!

Conversation

jonahwilliams commented Aug 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

codecov bot commented Aug 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonahwilliams commented Aug 19, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman Aug 20, 2019 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jonahwilliams commented Aug 17, 2019 •

edited

Loading

codecov bot commented Aug 17, 2019 •

edited

Loading

jmagman Aug 20, 2019 •

edited

Loading