[file_selector] Add Windows support #4424

stuartmorgan-g · 2021-10-11T18:55:53Z

Brings file_selector_windows into flutter/plugins from FDE, with the following changes:

Non-trivially refactored to allow for unit tests of almost all of the native code
Added native unit test coverage
Added an in-package example (almost an exact duplicate of the app-facing version, but written against the platform interface, as is our current practice)
(See [file_selector] Implement for Windows #3265 for some background)

Does not currently include native UI tests to allow for end-to-end testing (since it shows native UI Flutter integration tests can't be used). They should be added later, but the unit tests give substantial coverage, making it substantially better to move the plugin now to get those tests running.

(In the future, this could potentially be replaced by an FFI-based implementation, but this version allows us to leverage existing, field-tested code rather than starting from scratch.)

Windows portion of flutter/flutter#70221

Pre-launch Checklist

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

…ows/ boilerplate

stuartmorgan-g · 2021-10-11T19:03:45Z

High-level notes for review (most of what I said here for the macOS version applies):

The example is pretty much just a copy of the existing example + boilerplate. It's exactly the macOS example + boilerplate since they both use the platform interface APIs
If you do incremental review based on the initial copy-from-FDE commit:
- string_utils.cpp is just moved code
- file_selector_plugin.cpp is basically the initial plugin code moved to a new file, just adjusted sightly to use FileDialogController.
- the CMake changes are the same as what was done for url_launcher_windows
- file_dialog_controller.* is new code to allow for unit testing. It's pretty straightforward since it's as minimal as it can be by design.
- there's a bunch of new test utility code because actually getting the tests set up is non-trivial. Hopefully each piece is relatively straightforward to understand though.

stuartmorgan-g · 2021-10-11T19:08:38Z

packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp

+      fake_selected_file_2.file(),
+  };
+  IShellItemArrayPtr fake_result_array;
+  ::SHCreateShellItemArrayFromIDLists(2, fake_selected_files,


You're probably wondering why this setup is totally different than the other tests that return only one file. I.e., why not use ScopedTestShellItem and then create an IShellItemArrayPtr from those IShellItemPtrs? And the answer is: because there's an API to create an IShellItemArray from exactly one IShellItem, and there's an API to create an IShellItemArray from a list of ITEMIDLISTs, but there's no API to create an IShellItemArray from multiple IShellItems. Because Win32 😒

ditman · 2021-10-11T19:09:42Z

written against the platform interface, as is our current practice

@stuartmorgan I think you should be calling the user-exposed methods of the plugin package in the example app.

This is assuming that the frontend plugin is just a pass-through for method calls to the platform interface (which in this case it is, but in the case of Google Maps, for example, it isn't).

stuartmorgan-g · 2021-10-11T19:15:42Z

@stuartmorgan I think you should be calling the user-exposed methods of the plugin package in the example app.

This ends badly for reasons that aren't immediately obvious; it's on my list to document in the federated plugin playbook. I'll follow up in Discord since the scope is well beyond this plugin.

cbracken

Sending out the comments so far to help get things moving. I've reviewed up to but not including file_selector_plugin_test.cpp.

packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart

cbracken · 2022-01-25T19:16:31Z

packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart

+
+/// Widget that displays a text file in a dialog
+class TextDisplay extends StatelessWidget {
+  /// Default Constructor


nit: Here and on a few others (e.g. directoryPath below), the comment is probably unnecessary.

We have the default analysis settings on, which require docs for anything public. It's easier to just put the not-very-helpful comment than to disable the warning for the line (and I think we should leave it on in general since it's example code).

I did a pass over the member variables and tried to give them somewhat more useful comments.

packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart

packages/file_selector/file_selector_windows/example/lib/open_text_page.dart

cbracken · 2022-01-25T19:25:20Z

packages/file_selector/file_selector_windows/example/lib/save_text_page.dart

+import 'package:file_selector_platform_interface/file_selector_platform_interface.dart';
+import 'package:flutter/material.dart';
+
+/// Page for showing an example of saving with file_selector


nit: for consistency use 'Screen' here or 'Page' across the board. Not sure which I prefer, personally -- both seem fine :)

Fixed to match the others.

packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt

cbracken · 2022-01-25T19:33:27Z

packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp

+
+FileDialogController::FileDialogController(IFileDialog* dialog)
+    : dialog_(dialog) {
+  dialog_->AddRef();


Nothing to do here, but I wonder if long-term it might be useful to use ComPtr for these sorts of cases -- this one and the local below.

I smartened all of the pointers in the plugin.

cbracken · 2022-01-25T19:38:39Z

packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp

+// From x_type_group.dart
+// Only 'extensions' are supported by Windows for filtering.
+const char kTypeGroupLabelKey[] = "label";
+const char kTypeGroupExtensionsKey[] = "extensions";


nit: these could all be constexpr.

Thanks, still working off that muscle memory :)

cbracken · 2022-01-25T19:39:51Z

packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp

+// empty string on failure.
+std::string GetPathForShellItem(IShellItem *shell_item) {
+  wchar_t *wide_path = nullptr;
+  if (!SUCCEEDED(shell_item->GetDisplayName(SIGDN_FILESYSPATH, &wide_path))) {


Consider adding null-check bailout on shell_item.

cbracken · 2022-01-25T19:42:02Z

packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp

+
+  std::unique_ptr<FileDialogController> CreateController(
+      IFileDialog *dialog) const override {
+    return std::make_unique<FileDialogController>(dialog);


Consider adding an assert not null here.

cbracken

Alright - done! Looks good modulo mostly nits.

cbracken · 2022-01-25T19:56:36Z

packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp

+      fake_selected_file_2.file(),
+  };
+  IShellItemArrayPtr fake_result_array;
+  ::SHCreateShellItemArrayFromIDLists(2, fake_selected_files,


cbracken · 2022-01-25T20:02:12Z

packages/file_selector/file_selector_windows/windows/test/test_utils.h

+// the instance goes out of scope.
+//
+// This creates a file on the filesystem since creating IShellItem instances for
+// files that don't exist is not-trivial.


pedantic nit: non-trivial or not trivial :P

Yep, that was a typo. Fixed.

stuartmorgan-g

I'm afraid I added some more files to review: while updating for the review comments I realized I hadn't come back to update this PR to reflect the decision to switch plugins to using internal method channels. So I've added file_selector_windows.dart and file_selector_windows_test.dart, which for now are barely-edited copies of the shared method channel that it was using before. Later it can be adjusted to be better tailored to match the native Windows code to simplify the native side.

(I also noticed that some C++ files had the wrong pointer alignment as the prevailing style, and fixed those.)

packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart

stuartmorgan-g · 2022-01-25T20:26:25Z

packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart

+
+/// Widget that displays a text file in a dialog
+class TextDisplay extends StatelessWidget {
+  /// Default Constructor


We have the default analysis settings on, which require docs for anything public. It's easier to just put the not-very-helpful comment than to disable the warning for the line (and I think we should leave it on in general since it's example code).

I did a pass over the member variables and tried to give them somewhat more useful comments.

packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart

packages/file_selector/file_selector_windows/example/lib/open_text_page.dart

stuartmorgan-g · 2022-01-25T20:30:50Z

packages/file_selector/file_selector_windows/example/lib/save_text_page.dart

+import 'package:file_selector_platform_interface/file_selector_platform_interface.dart';
+import 'package:flutter/material.dart';
+
+/// Page for showing an example of saving with file_selector


Fixed to match the others.

stuartmorgan-g · 2022-01-25T20:55:56Z

packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp

+
+FileDialogController::FileDialogController(IFileDialog* dialog)
+    : dialog_(dialog) {
+  dialog_->AddRef();


I smartened all of the pointers in the plugin.

stuartmorgan-g · 2022-01-25T21:02:09Z

packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp

+// From x_type_group.dart
+// Only 'extensions' are supported by Windows for filtering.
+const char kTypeGroupLabelKey[] = "label";
+const char kTypeGroupExtensionsKey[] = "extensions";


Thanks, still working off that muscle memory :)

stuartmorgan-g · 2022-01-25T21:03:01Z

packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp

+// empty string on failure.
+std::string GetPathForShellItem(IShellItem *shell_item) {
+  wchar_t *wide_path = nullptr;
+  if (!SUCCEEDED(shell_item->GetDisplayName(SIGDN_FILESYSPATH, &wide_path))) {


stuartmorgan-g · 2022-01-25T21:03:40Z

packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp

+
+  std::unique_ptr<FileDialogController> CreateController(
+      IFileDialog *dialog) const override {
+    return std::make_unique<FileDialogController>(dialog);


stuartmorgan-g · 2022-01-25T21:04:03Z

packages/file_selector/file_selector_windows/windows/test/test_utils.h

+// the instance goes out of scope.
+//
+// This creates a file on the filesystem since creating IShellItem instances for
+// files that don't exist is not-trivial.


Yep, that was a typo. Fixed.

cbracken

stuartmorgan-g added 8 commits September 24, 2021 15:23

Initial copy directly from FDE

31ffa90

Duplicate macOS example, and replace the macos/ boilerplate with wind…

c0fbde3

…ows/ boilerplate

Extract the plugin class into its own files

e2dcf5f

Placeholder tests

b0c1f49

Refactor for testability

e760f00

Real tests

d81ac0c

CHANGELOG

1c2beff

Exclude integration test

031aa60

stuartmorgan-g requested a review from cbracken October 11, 2021 18:55

stuartmorgan-g requested a review from ditman as a code owner October 11, 2021 18:55

github-actions bot added p: file_selector platform-windows labels Oct 11, 2021

google-cla bot added the cla: yes label Oct 11, 2021

stuartmorgan-g removed the request for review from ditman October 11, 2021 19:03

stuartmorgan-g commented Oct 11, 2021

View reviewed changes

stuartmorgan-g added 6 commits October 11, 2021 15:23

Remove template-generated analysis options

44d35cf

Add AUTHORS

698936c

Missing licenses in template code

e49ba48

More formatting

27a9425

Fix directory test

a36d5d5

pubspec fixes

1685aa5

stuartmorgan-g mentioned this pull request Oct 19, 2021

[image_picker] Added initial support. #4437

Closed

11 tasks

Merge branch 'master' into file-selector-windows

a52837a

godofredoc changed the base branch from master to main January 6, 2022 22:45

stuartmorgan-g added 3 commits January 11, 2022 13:40

Merge branch 'main' into file-selector-windows

5c715a4

Minor fixes

55f8826

Fix publish warning

2219023

Update build for repo changes

d67e159

cbracken suggested changes Jan 25, 2022

View reviewed changes

cbracken reviewed Jan 25, 2022

View reviewed changes

cbracken mentioned this pull request Jan 25, 2022

[file_selector] Add macOS support #4381

Merged

11 tasks

stuartmorgan-g added 5 commits January 25, 2022 15:59

Merge branch 'main' into file-selector-windows

401af26

Review comments

53348b8

Fix pointer aligments

6de2ea5

Fix bug in single-file example

24ba33e

Switch to internal method channel

2e9d23b

stuartmorgan-g commented Jan 25, 2022

View reviewed changes

cbracken approved these changes Jan 25, 2022

View reviewed changes

Add cross_file to deps

8f17b22

stuartmorgan-g added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Jan 26, 2022

fluttergithubbot merged commit cd97c19 into flutter:main Jan 26, 2022

engine-flutter-autoroll mentioned this pull request Jan 26, 2022

Roll Plugins from 4d8e98d62703 to bd7dfb78d8f9 (5 revisions) flutter/flutter#97295

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 26, 2022

cd97c19 [file_selector] Add Windows support (flutter/plugins#4424)

e30a497

[file_selector] Add Windows support #4424

[file_selector] Add Windows support #4424

Uh oh!

Conversation

stuartmorgan-g commented Oct 11, 2021

Pre-launch Checklist

Uh oh!

stuartmorgan-g commented Oct 11, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ditman commented Oct 11, 2021

Uh oh!

stuartmorgan-g commented Oct 11, 2021

Uh oh!

cbracken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbracken 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!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

cbracken left a comment

Choose a reason for hiding this comment

Uh oh!