implement plugins for custom devices #90958

ardera · 2021-09-29T13:48:24Z

Implements plugin for custom devices: See #86864
See also the design doc: https://flutter.dev/go/plugin-support-for-custom-embeddings

Summary of the changes

custom_devices/custom_device_config.dart:

add 3 new keys:
- embedder, the name of the embedder
- configureNativeProject (should basically invoke cmake in the native project directory)
- buildNativeProject (should basically invoke ninja in the native project directory)
- native project directory is the x-flutter-pi subdir of the flutter project directory
- (if the embedder is called flutter-pi)

custom_devices/custom_device.dart:

add methods for invoking the configureNativeProject and buildNativeProject commands of the custom device config
check the return value of the postBuildCommand, return LaunchResult.failed() if not successful
check the return value of the installCommand, return LaunchResult.failed() if not successful

flutter_plugins.dart:

expand writing of .flutter-plugins-dependencies for custom devices plugins
expand the generated dart plugin registrant for custom devices plugins
- for example, the flutter-pi variant of a plugin is activated if -Dflutter.customPlatform=flutter-pi was given as a dart define, or the FLUTTER_CUSTOM_PLATFORM environment variable equals flutter-pi (needed for debug mode)
also creating plugin symlinks for custom devices plugins
allow resolving platform interface resolutions for custom devices plugins
add method to find all plugins for custom embedder with a given platform key

project.dart:

expand FlutterProjectFactory and FlutterProject for custom devices support
FlutterProject.customEmbedderProjects lists all custom embedder subprojects of this flutter project
to do that, it needs to know which custom embedders are currently configured
it gets that info from the flutter project factory (which just queries the CustomDevicesConfig)

Tests:

add tests for all the changes
add makeProjectFactory inside test/src/common.dart with creates a project factory with some default arguments, make all tests use that instead of constructing a FlutterProjectFactory themselves

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.

flutter-dashboard · 2021-10-28T00:24:04Z

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

ardera · 2022-02-08T13:07:00Z

(ping) @christopherfujino

packages/flutter_tools/lib/src/custom_devices/custom_device.dart

packages/flutter_tools/lib/src/custom_devices/custom_device_config.dart

packages/flutter_tools/lib/src/plugins.dart

christopherfujino · 2022-03-03T21:09:22Z

packages/flutter_tools/lib/src/platform_plugins.dart

+    required String pluginPath,
+    required FileSystem fileSystem
+  }) {
+    assert(validate(yaml));


so asserts don't run in the tool unless you explicitly enable them by editing the shell script entrypoint. should we run this validation always?

The check in

flutter/packages/flutter_tools/lib/src/plugins.dart

Line 280 in 90fa1b3

static List<String> validatePluginYaml(YamlMap? yaml) {

should've already made sure the yaml is valid (except I forgot to add some validation there, but I did that now)

christopherfujino · 2022-03-03T21:09:30Z

@stuartmorgan can you review the changes to:

packages/flutter_tools/lib/src/flutter_plugins.dart
packages/flutter_tools/lib/src/platform_plugins.dart

custom_devices/custom_device_config.dart: - add 3 new keys: - `embedder`, the name of the embedder - `configureNativeProject` (should basically invoke `cmake` in the native project directory) - `buildNativeProject` (should basically invoke `ninja` in the native project directory) - native project directory is the `x-flutter-pi` subdir of the flutter project directory - (if the embedder is called flutter-pi) - add `-tt` ssh argument on linux and macOS to force a pseudo-terminal (so remote will get a SIGHUP when the host kills ssh, otherwise the embedder won't terminate) - add trailing comma to argument lists custom_devices/custom_device.dart: - add methods for invoking the `configureNativeProject` and `buildNativeProject` commands of the custom device config - check the return value of the postBuildCommand, return LaunchResult.failed() if not successful - check the return value of the installCommand, return LaunchResult.failed() if not successful plugins.dart: - add validation, parsing for pubspec.yaml custom device stuff flutter_plugins.dart: - expand writing of .flutter-plugins-dependencies for custom devices plugins - expand the generated dart plugin registrant for custom devices plugins - for example, the `flutter-pi` variant of a plugin is activated if `-Dflutter.customPlatform=flutter-pi` was given as a dart define, or the `FLUTTER_CUSTOM_PLATFORM` environment variable equals `flutter-pi` (needed for debug mode) - also creating plugin symlinks for custom devices plugins - allow resolving platform interface resolutions for custom devices plugins - add method to find all plugins for custom embedder with a given platform key project.dart: - expand `FlutterProjectFactory` and `FlutterProject` for custom devices support - `FlutterProject.customEmbedderProjects` lists all custom embedder subprojects of this flutter project - to do that, it needs to know which custom embedders are currently configured - it gets that info from the flutter project factory (which just queries the CustomDevicesConfig) - add tests for all the changes - add makeProjectFactory inside test/src/common.dart with creates a project factory with some default arguments, make all tests use that instead of constructing a FlutterProjectFactory themselves packages/flutter_tools/lib/src/custom_devices/custom_device.dart packages/flutter_tools/lib/src/custom_devices/custom_device_config.dart packages/flutter_tools/test/commands.shard/hermetic/custom_devices_test.dart packages/flutter_tools/test/general.shard/android/android_device_test.dart packages/flutter_tools/test/general.shard/android/gradle_utils_test.dart packages/flutter_tools/test/general.shard/crash_reporting_test.dart packages/flutter_tools/test/general.shard/custom_devices/custom_device_test.dart packages/flutter_tools/test/general.shard/custom_devices/custom_devices_config_test.dart packages/flutter_tools/test/general.shard/custom_devices/custom_devices_plugins_test.dart packages/flutter_tools/test/general.shard/github_template_test.dart packages/flutter_tools/test/general.shard/linux/linux_device_test.dart packages/flutter_tools/test/general.shard/macos/macos_device_test.dart packages/flutter_tools/test/general.shard/plugin_parsing_test.dart packages/flutter_tools/test/general.shard/windows/windows_device_test.dart

platform_plugins.dart: - remove `CustomEmbedderPlugin.isNative`, no longer present in parent - support `hasDart`, `hasFfi`, `hasMethodChannel` (just add some boolean flags in the pubspec for the latter two) flutter_plugins.dart: - rework findNativeCustomEmbedderPlugins

ardera · 2022-04-19T09:11:27Z

Sorry for the delay!

(had to squash because I had 1000s of merge conflicts because of formatting changes in my commits that I reverted in later commits, sry if that messes up the review or something)

- fix passing of removed parameter `fileSystem` for `CustomEmbedderPlugin` - remove unused import in test

- documentation URL was updated to point to an actual website, use that in the test too

- custom device config template has changed, update test to match against the updated template

stuartmorgan-g · 2022-05-20T16:00:45Z

packages/flutter_tools/lib/src/platform_plugins.dart

@@ -532,6 +535,78 @@ class LinuxPlugin extends PluginPlatform implements NativeOrDartPlugin {
  }
 }

+class CustomEmbedderPlugin extends PluginPlatform implements NativeOrDartPlugin {


Related to my comments on the design document: I don't think that this should implement NativeOrDartPlugin, because it's a specific set of implementation keys, and keys are 100% platform-dependent. An alternate web embedder, for instance, would definitely not be a NativeOrDartPlugin.

stuartmorgan-g · 2022-05-20T16:01:22Z

packages/flutter_tools/lib/src/platform_plugins.dart

+    required this.embedderName,
+    required this.name,
+    required this.pluginPath,
+    this.dartPluginClass,


Per the discussion in the doc, there's currently no approach to actually implement this, so it shouldn't be a universal key.

stuartmorgan-g · 2022-05-20T16:01:31Z

packages/flutter_tools/lib/src/platform_plugins.dart

+    required this.pluginPath,
+    this.dartPluginClass,
+    this.defaultPackage,
+    bool? ffiPlugin,


This may not apply to all embedders.

stuartmorgan-g · 2022-05-20T16:01:36Z

packages/flutter_tools/lib/src/platform_plugins.dart

+    this.dartPluginClass,
+    this.defaultPackage,
+    bool? ffiPlugin,
+    bool? methodChannelPlugin


Nor this.

I'm not even clear on what this is; it's unused AFAICT.

stuartmorgan-g · 2022-05-20T16:03:59Z

packages/flutter_tools/lib/src/plugins.dart

+    List<String> platforms,
+    String pluginClass,
+    String androidPackage, [
+    List<String> emptyPlatforms = const <String>[],


This needs explanation in the method comment.

stuartmorgan-g · 2022-05-20T16:05:12Z

packages/flutter_tools/lib/src/plugins.dart

@@ -320,6 +350,11 @@ class Plugin {
    if (isInvalid(WindowsPlugin.kConfigKey, WindowsPlugin.validate)) {
      errors.add('Invalid "windows" plugin specification.');
    }
+    yaml.forEach((dynamic key, dynamic value) {
+      if (key is String && key.startsWith('x-')) {
+        isInvalid(key, CustomEmbedderPlugin.validate);


I'm not sure we can meaningfully validate custom plugin sections; they could contain anything.

ardera · 2022-08-17T05:42:07Z

I apologize for the delay. I hope I'll get to it this week or next week.

eximius313 · 2022-11-01T21:38:36Z

@ardera do you have plans regarding this feature?

christopherfujino · 2022-12-01T21:39:20Z

Hey @ardera, I am going to close this PR just to get it off our PR review queue. Feel free to re-open if/when you have time to pick it up again.

flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Sep 29, 2021

google-cla bot added the cla: yes label Sep 29, 2021

ardera force-pushed the feature/custom-devices-plugins branch 2 times, most recently from 4915821 to 75bb480 Compare November 6, 2021 10:58

ardera force-pushed the feature/custom-devices-plugins branch from 7ea7daf to a1f785d Compare November 15, 2021 12:43

christopherfujino self-requested a review January 13, 2022 22:13

christopherfujino self-assigned this Feb 17, 2022

christopherfujino reviewed Feb 17, 2022

View reviewed changes

packages/flutter_tools/lib/src/custom_devices/custom_device.dart Outdated Show resolved Hide resolved

packages/flutter_tools/lib/src/custom_devices/custom_device.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Feb 17, 2022

View reviewed changes

packages/flutter_tools/lib/src/custom_devices/custom_device_config.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Feb 17, 2022

View reviewed changes

packages/flutter_tools/lib/src/custom_devices/custom_device_config.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Mar 3, 2022

View reviewed changes

packages/flutter_tools/lib/src/plugins.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Mar 3, 2022

View reviewed changes

ardera added 2 commits April 19, 2022 10:22

ardera force-pushed the feature/custom-devices-plugins branch from a1f785d to 90fa1b3 Compare April 19, 2022 08:55

ardera mentioned this pull request Apr 19, 2022

Add documentation on how to use plugins with custom-devices #102133

Open

ardera added 3 commits April 19, 2022 11:13

fixes

9763ffa

- fix passing of removed parameter `fileSystem` for `CustomEmbedderPlugin` - remove unused import in test

fix test

8773d40

- documentation URL was updated to point to an actual website, use that in the test too

update tests

d70451e

- custom device config template has changed, update test to match against the updated template

guidezpl removed the cla: yes label May 1, 2022

stuartmorgan-g requested changes May 20, 2022

View reviewed changes

ardera mentioned this pull request Aug 8, 2022

Allow enabling custom-devices feature on all channels by default #108787

Open

ardera mentioned this pull request Aug 19, 2022

MissingPluginException ardera/flutter-pi#222

Closed

Jasguerrero added the waiting for customer response The Flutter team cannot make further progress on this issue until the original reporter responds label Sep 22, 2022

doesnotexist mentioned this pull request Sep 27, 2022

Create Flutter tools for embedded Linux sony/flutter-embedded-linux#59

Closed

christopherfujino closed this Dec 1, 2022

implement plugins for custom devices #90958

implement plugins for custom devices #90958

Uh oh!

Conversation

ardera commented Sep 29, 2021

Summary of the changes

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Oct 28, 2021

Uh oh!

ardera commented Feb 8, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino commented Mar 3, 2022

Uh oh!

ardera commented Apr 19, 2022

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!

ardera commented Aug 17, 2022

Uh oh!

eximius313 commented Nov 1, 2022

Uh oh!

christopherfujino commented Dec 1, 2022

Uh oh!

Uh oh!