[flutter_tools] support flutter run -d winuwp #79684

jonahwilliams · 2021-04-03T00:34:01Z

Allow flutter run to work end to end with a UWP device.

Uses win32/ffi for the actual launch of the application, injected via the native API class. This is structured to avoid a g3 dependency.

Install and amuid require powershell scripts for now.

Actually connecting to the observatory requires running a command in an elevated prompt. Instructions are presented to the user if a terminal is attached.

clarkezone · 2021-04-28T02:34:59Z

For the path: build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.1.3.0_x64_Debug_Test

build\winuwp\runner_uwp\AppPackages is a constant
helloreloaded is a value in the manifest that will ultimately by injected by the flutter tool
the next dir is a concat of
- helloreloaded the same as the injected app name
- 1.1.0.0 comes from the manifest
- _x64_Debug_Test should correspond to the build arguments passed to / by cmake and should be the same for any project for release and debug

jonahwilliams · 2021-04-28T16:29:57Z

packages/flutter_tools/pubspec.yaml

  cli_util: 0.3.0 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade"
  clock: 1.1.0 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade"
  csslib: 0.17.0 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade"
-  devtools: 2.1.1 # THIS LINE IS AUTOGENERATED - TO UPDATE USE "flutter update-packages --force-upgrade"


jonahwilliams · 2021-04-28T16:34:59Z

packages/flutter_tools/lib/src/isolated/devfs_web.dart

      useSseForDebugProxy: useSseForDebugProxy,
      useSseForDebugBackend: useSseForDebugBackend,
      useSseForInjectedClient: useSseForInjectedClient,
-      serveDevTools: false,


This change was required to roll in dwds, was the fix for the removal of the devtools dep I landed to resolve the version conflict post mortem

zanderso · 2021-04-28T17:05:57Z

Is it possible to stage the package updates before this PR so they can be tested separately on CI?

jonahwilliams · 2021-04-28T17:27:25Z

Done here: #81403

clarkezone

LGTM

…o checking_win32

zanderso · 2021-04-29T16:13:37Z

packages/flutter_tools/lib/src/cmake.dart

+  if (!cmakeFile.existsSync()) {
+    return null;
+  }
+  final RegExp nameSetPattern = RegExp(r'^\s*set\(PACKAGE_GUID\s*"(.*)"\s*\)\s*$');


Does this regexp have test coverage?

zanderso · 2021-04-29T16:18:26Z

packages/flutter_tools/lib/src/isolated/native_api_win32.dart

+      throw WindowsException(hResult);
+    }
+    final int id = processId.value;
+    free(aumid);


free() calls should go in a finally {} block, for example to cover the exception thrown on line 30.

zanderso · 2021-04-29T16:19:47Z

packages/flutter_tools/lib/src/isolated/native_api_win32.dart

+    free(processId);
+    free(aam.ptr);
+    free(arguments);
+    CoUninitialize();


And I'm guessing this as well would have to go in the finally {} ?

zanderso · 2021-04-29T16:21:54Z

packages/flutter_tools/lib/src/windows/windows_device.dart

+       _nativeApi = nativeApi,
+       _operatingSystemUtils = operatingSystemUtils,
+       _fileSystem = fileSystem,
+      super(


Is the indentation right here?

zanderso · 2021-04-29T16:27:55Z

packages/flutter_tools/lib/src/isolated/native_api_win32.dart

+  const Win32NativeApi();
+
+  @override
+  int launchApp(String amuid, List<String> args) {


@clarkezone @cbracken Was an alternative design considered in which we would get this functionality from a utility bundled with the Windows engine artifacts instead of adding the ffi dependencies to the flutter_tool? For example, the Windows engine artifacts could come with a program, like uwp_launcher that does what is in this file, and then the flutter_tool could launch a uwp app using dart:io as usual through that launcher program?

Having an adb like program for UWP would be pretty neat. I have to add that I'm indifferent between that and using ffi, but prefer both to calling out to powershell scripts. The former could give reasonable exit codes with meaning, the latter is just sort of a jumbled mess of text

Even something less ambitious than adb might be easier to maintain and test than introducing dart:ffi to the tool for the first time. I would like to hear thoughts from @clarkezone and @cbracken on this before we land this PR because I suspect if this is landed as-is we won't take the opportunity to consider this again.

I don't have strong opinion either way, although in the short term getting a E2E working solution is a high priority so I would prefer to get to that and improve / refactor later than do a big refactor now.

jonahwilliams · 2021-04-29T17:45:47Z

Fixed the issues with the install path @clarkezone , but hit another error.

PS C:\Users\Jonah\Documents\flutter-uwp-template\src> C:\Users\Jonah\Documents\flutter-uwp-template\src\build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.1.0.0_Debug_Test\Add-AppDevPackage.ps1
Found bundle: C:\Users\Jonah\Documents\flutter-uwp-template\src\build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.1.0.0_Debug_Test\helloreloaded_1.1.0.0_x64_Debug.msixbundle

Installing app...
Found dependency package(s):
C:\Users\Jonah\Documents\flutter-uwp-template\src\build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.1.0.0_Debug_Test\Dependencies\x86\Microsoft.VCLibs.x86.Debug.14.00.appx
C:\Users\Jonah\Documents\flutter-uwp-template\src\build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.1.0.0_Debug_Test\Dependencies\x64\Microsoft.VCLibs.x64.Debug.14.00.appx

Add-AppxPackage: C:\Users\Jonah\Documents\flutter-uwp-template\src\build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.1.0.0_Debug_Test\Add-AppDevPackage.ps1:444
Line |
 444 |              Add-AppxPackage -Path $DeveloperPackagePath.FullName -Dep …
     |              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Specified cast is not valid.

Error: Could not install the app.

I'm assuming this script requires some additional arguments?

clarkezone · 2021-04-29T17:52:32Z

Hmm that's weird.. I'm not needing to provide extra arguments from the cmdline. What happens if you powershell .\add-appdevpackage.ps1 from a cmd prompt?

jonahwilliams · 2021-04-29T17:55:48Z

Oh duh, my b

…o checking_win32

jonahwilliams · 2021-04-29T18:04:52Z

The actual error is:

Add-AppxPackage : Deployment failed with HRESULT: 0x80073CFB, The provided package is already installed, and
reinstallation of the package was blocked. Check the AppXDeployment-Server event log for details.

Deployment of package F941A77F-8AE1-4E3E-9611-68FBD3C62AE8_1.1.0.0_x64__d7c8pgvss6ysm was blocked because the provided
package has the same identity as an already-installed package but the contents are different. Increment the version
number of the package to be installed, or remove the old package for every user on the system before installing this
package.

NOTE: For additional information, look for [ActivityId] fa72d8bc-327e-0000-e31c-d1fa7e32d701 in the Event Log or use
the command line Get-AppPackageLog -ActivityID fa72d8bc-327e-0000-e31c-d1fa7e32d701

At C:\Users\Jonah\Documents\flutter-uwp-template\src\build\winuwp\runner_uwp\AppPackages\helloreloaded\helloreloaded_1.
1.0.0_Debug_Test\Add-AppDevPackage.ps1:444 char:13
+             Add-AppxPackage -Path $DeveloperPackagePath.FullName -Dep ...
+             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceExists: (C:\Users\Jonah\...ebug.msixbundle:String) [Add-AppxPackage], PSInvalidO
   perationException
    + FullyQualifiedErrorId : DeploymentError,Microsoft.Windows.Appx.PackageManager.Commands.AddAppxPackageCommand

Error: Could not install the app.

clarkezone · 2021-04-29T20:56:01Z

Try going to start menu and uninstalling the app manually

jonahwilliams · 2021-04-30T16:54:24Z

The problem is that the Add App package script does not install in dev mode by default, need to call install.ps1 which is in the same folder

clarkezone · 2021-04-30T17:32:01Z

Does that fix it?

jonahwilliams · 2021-04-30T17:46:12Z

Seems to work consistently. Unfortunately on ToT the app isn't actually starting for me, I just a blank blue screen

jonahwilliams · 2021-04-30T21:01:07Z

OK, problem was the old that was installed correctly was never getting uninstalled

clarkezone · 2021-05-04T02:11:19Z

#70211

@jonahwilliams

Allow flutter run to work end to end with a UWP device. Uses win32/ffi for the actual launch of the application, injected via the native API class. This is structured to avoid a g3 dependency. Install and amuid require powershell scripts for now. Actually connecting to the observatory requires running a command in an elevated prompt. Instructions are presented to the user if a terminal is attached. This is a rebased version of flutter#79684 by @jonahwilliams.

@jonahwilliams

Allow flutter run to work end-to-end with a UWP device. Uses win32/ffi for the actual launch of the application, injected via the native API class. This is structured to avoid a g3 dependency. Install and amuid require powershell scripts for now. Actually connecting to the observatory requires running a command in an elevated prompt. Instructions are presented to the user if a terminal is attached. This is a rebased version of #79684 by @jonahwilliams, updated to remove `NativeApi` and replace is with calls to `uwptool`. Part of #82085

jonahwilliams · 2021-05-13T03:49:51Z

Superseded by #82373

[flutter_tools] add scaffolding for winuwp native launch

d9e7758

flutter-dashboard bot added c: contributor-productivity Team-specific productivity, code health, technical debt. tool Affects the "flutter" command-line tool. See also t: labels. labels Apr 3, 2021

google-cla bot added the cla: yes label Apr 3, 2021

jonahwilliams added 5 commits April 22, 2021 09:15

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

80ed3a1

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

dd84c91

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

f20b325

more uwp work

c8da592

forward all options

86563ab

jonahwilliams added 3 commits April 28, 2021 08:14

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

99d822d

Update install script

9451625

update versions

bd86b92

jonahwilliams commented Apr 28, 2021

View reviewed changes

fix removal of devtools

67737cd

jonahwilliams marked this pull request as ready for review April 28, 2021 16:33

jonahwilliams requested a review from Piinks as a code owner April 28, 2021 16:33

jonahwilliams requested review from cbracken, clarkezone and zanderso April 28, 2021 16:33

jonahwilliams commented Apr 28, 2021

View reviewed changes

Update native_api_win32.dart

035c9c6

jonahwilliams mentioned this pull request Apr 28, 2021

[versions] roll versions and add ffi dep #81403

Merged

Jonah Williams added 2 commits April 28, 2021 10:28

Update project.dart

6bc1484

Update getaumidfromname.ps1

fb0ddd9

clarkezone approved these changes Apr 28, 2021

View reviewed changes

jonahwilliams added 2 commits April 28, 2021 11:23

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

09b5ad8

Merge branch 'checking_win32' of github.com:jonahwilliams/flutter int…

a9bd173

…o checking_win32

jonahwilliams and others added 2 commits April 28, 2021 11:24

fix dev tools pubspec

c7b50d2

Update win32_native_api_test.dart

1ca0d92

jonahwilliams changed the title ~~[flutter_tools] add scaffolding for winuwp native launch~~ [flutter_tools] support flutter run -d winuwp Apr 28, 2021

zanderso reviewed Apr 29, 2021

View reviewed changes

jonahwilliams added 2 commits April 29, 2021 11:03

Address review comments

fa17fc9

Merge branch 'checking_win32' of github.com:jonahwilliams/flutter int…

6dde066

…o checking_win32

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

8a77c37

small updates

8e4e34a

package guid test coverage

9ace98a

clarkezone added the e: uwp label May 4, 2021

jonahwilliams marked this pull request as draft May 11, 2021 21:49

cbracken mentioned this pull request May 12, 2021

[flutter_tools] support flutter run -d winuwp #82373

Merged

8 tasks

jonahwilliams closed this May 13, 2021

jonahwilliams deleted the checking_win32 branch May 13, 2021 03:49

[flutter_tools] support flutter run -d winuwp #79684

[flutter_tools] support flutter run -d winuwp #79684

Uh oh!

Conversation

jonahwilliams commented Apr 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

clarkezone commented Apr 28, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zanderso commented Apr 28, 2021

Uh oh!

jonahwilliams commented Apr 28, 2021

Uh oh!

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

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!

jonahwilliams commented Apr 29, 2021

Uh oh!

clarkezone commented Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonahwilliams commented Apr 29, 2021

Uh oh!

jonahwilliams commented Apr 29, 2021

Uh oh!

clarkezone commented Apr 29, 2021

Uh oh!

jonahwilliams commented Apr 30, 2021

Uh oh!

clarkezone commented Apr 30, 2021

Uh oh!

jonahwilliams commented Apr 30, 2021

Uh oh!

jonahwilliams commented Apr 30, 2021

Uh oh!

clarkezone commented May 4, 2021

Uh oh!

jonahwilliams commented May 13, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jonahwilliams commented Apr 3, 2021 •

edited

Loading

clarkezone commented Apr 29, 2021 •

edited

Loading