Skip to content

Create static plugin frameworks build ios-framework --static #104576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
fluttergithubbot merged 1 commit into from
May 25, 2022
Merged

Create static plugin frameworks build ios-framework --static #104576

fluttergithubbot merged 1 commit into from
May 25, 2022

Conversation

@jmagman
Copy link
Member

@jmagman jmagman commented May 25, 2022

Just the plugins part of #52217. Build the plugin xcframeworks as static frameworks. Flutter.xcframework and App.xcframework are still dylibs.

Previous behavior creates dylibs dynamically linked shared library:

$ flutter build ios-framework
$ $ file build/ios/framework/Debug/url_launcher_ios.xcframework/ios-arm64/url_launcher_ios.framework/url_launcher_ios
build/ios/framework/Debug/url_launcher_ios.xcframework/ios-arm64/url_launcher_ios.framework/url_launcher_ios: Mach-O 64-bit dynamically linked shared library arm64

With --static the plugins are ar archive random library

$ flutter build ios-framework --static
$ file build/ios/framework/Debug/url_launcher_ios.xcframework/ios-arm64/url_launcher_ios.framework/url_launcher_ios
build/ios/framework/Debug/url_launcher_ios.xcframework/ios-arm64/url_launcher_ios.framework/url_launcher_ios: current ar archive random library

I tested this manually by:

  1. Adding a plugin url_launcher: to the sample project pubspec.
  2. Adding a button that launches a URL to the dart code:
@override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            await launchUrl(Uri.parse('https://www.google.com'));
          },
          child: Text('Launch URL'),
        ),
      ),
    );
  }
  1. Calling GeneratedPluginRegistrant.register(with: self.flutterEngine!); in the AppDelegate
  2. Linking (not embedding!) the static url_launcher_ios and FlutterPluginRegistrant xcframeworks
    in the Xcode project
		F733C128283DD5C7005295FB /* url_launcher_ios.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = url_launcher_ios.xcframework; path = "Flutter/$(CONFIGURATION)/url_launcher_ios.xcframework"; sourceTree = "<group>"; };
		F733C12B283DD6C4005295FB /* FlutterPluginRegistrant.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = FlutterPluginRegistrant.xcframework; path = "Flutter/$(CONFIGURATION)/FlutterPluginRegistrant.xcframework"; sourceTree = "<group>"; };

			isa = PBXFrameworksBuildPhase;
			buildActionMask = 2147483647;
			files = (
				F733C12C283DD6C4005295FB /* FlutterPluginRegistrant.xcframework in Frameworks */,
				F77F88F1255396AD00309E51 /* App.xcframework in Frameworks */,
				F77F88F2255396AD00309E51 /* Flutter.xcframework in Frameworks */,
				F733C129283DD5C7005295FB /* url_launcher_ios.xcframework in Frameworks */,
			);
			runOnlyForDeploymentPostprocessing = 0;

etc.

Run the app, tap the button, the URL launches.

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.

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

@jmagman jmagman added platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. a: existing-apps Integration with existing apps via the add-to-app flow labels May 25, 2022
@jmagman jmagman self-assigned this May 25, 2022
@flutter-dashboard flutter-dashboard bot added the c: contributor-productivity Team-specific productivity, code health, technical debt. label May 25, 2022
jmagman
jmagman commented May 25, 2022
View reviewed changes
dev/devicelab/bin/tasks/build_ios_framework_module_test.dart
'FlutterPluginRegistrant.framework',
'FlutterPluginRegistrant',
);
await _checkStatic(registrantFrameworkPath);
Copy link
Member Author

@jmagman jmagman May 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FlutterPluginRegistrant was already static.

@jmagman jmagman mentioned this pull request May 25, 2022
Open
cyanglaz
cyanglaz approved these changes May 25, 2022
View reviewed changes
Copy link
Contributor

@cyanglaz cyanglaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a very optional nits.

@fluttergithubbot fluttergithubbot merged commit f3e567c into flutter:master May 25, 2022
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 25, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 25, 2022
@engine-flutter-autoroll
f3e567c Create static plugin frameworks build ios-framework --static (f…
ace95fb 
…lutter/flutter#104576)
@jmagman jmagman deleted the static-fw branch May 25, 2022 16:06
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 25, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request May 25, 2022
@engine-flutter-autoroll
f3e567c Create static plugin frameworks build ios-framework --static (f…
5594c17 
…lutter/flutter#104576)
camsim99 pushed a commit to camsim99/flutter that referenced this pull request Aug 10, 2022
@jmagman @camsim99
Create static plugin frameworks build ios-framework --static (flutter…
fd48e33 
…#104576)
@blastmann
Copy link

blastmann commented Aug 19, 2022

Can I enable this feature on Flutter 3.0?

@jmagman
Copy link
Member Author

jmagman commented Aug 19, 2022

This is available on 3.1.0-9.0.pre, currently in the beta channel.

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2022
@engine-flutter-autoroll
f3e567c Create static plugin frameworks build ios-framework --static (f…
14afd39 
…lutter/flutter#104576)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 30, 2022
@engine-flutter-autoroll
f3e567c Create static plugin frameworks build ios-framework --static (f…
c8ea240 
…lutter/flutter#104576)
@jmagman jmagman mentioned this pull request Dec 4, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christopherfujino christopherfujino Awaiting requested review from christopherfujino

1 more reviewer

@cyanglaz cyanglaz cyanglaz approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@jmagman jmagman

Labels

a: existing-apps Integration with existing apps via the add-to-app flow c: contributor-productivity Team-specific productivity, code health, technical debt. platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jmagman @blastmann @cyanglaz @fluttergithubbot