Align web terminal messages with the VM #163268

srujzs · 2025-02-13T23:15:36Z

Adds better instructions for hot reload (if using the right flags), hot restart, quitting, clearing, and more. These were already being printed when using the VM, so this aligns with that.
Adds an extra parameter for CommandHelp to ResidentRunner so ResidentWebRunner can pass a version of it that uses its separate logger and not globals. In order to support this, classes up the stack also provide a Terminal, Platform, and OutputPreferences.
Fixes up use of globals from an earlier change to implement hot reload to use the logger instead. Same with globals.platform.
Adds tests to check that only hot restart is printed when not using the extra front-end flags, and both hot restart and hot reload is printed when you are.

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].
I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
All existing and new tests are passing.

Adds better instructions for hot reload (if using the right flags), hot restart, quitting, clearing, and more.

flutter-dashboard · 2025-02-13T23:15:39Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

…check that output is correct

biggs0125 · 2025-02-14T01:20:52Z

It'd be nice to share this code between the ReloadHot runner and our ResidentWebRunner... and even ReloadCold which is very similar. We're likely to just get more divergence over time if we have multiple copies of this code.

Can we just add 2 boolean getters to the ResidentRunner: supportsReload and supportsDetach? Then printHelp is just a single implementation on ResidentRunner and it hides r and d based on those flags. I think everything else is the same between all 3 configurations.

Eventually we can look into implementing detach on the web and then we can even delete supportsDetach.

- Adds supportsDetach getter to determine whether to print the command for detach. - Adds extra parameter to printHelp to avoid printing hot reload command when hot reload is implemented with hot restart.

srujzs · 2025-02-14T02:26:56Z

I originally shied away from that as there exists a boolean for hot reload: canHotReload. This is always set to true for the web, even though hot reload is implemented as hot restart. This boolean also determines whether to do anything when the user types 'r', so I didn't want to start returning false for it as it previously did a hot restart on the web.

However, I think adding an extra parameter to printHelp to tell it not to print the command for hot reload when not using the DDC library bundle format is sufficient here to get what we want.

There was also some oddness around the VM using globals and the web using _logger to log things in printHelp, but ResidentRunner.logger is the respective expected value anyways, so a shared implementation of printHelp is possible.

It looks like the VM only supports detach under certain conditions depending on the runner, so supportsDetach will likely stay.

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

biggs0125

Thanks for aligning these!

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

packages/flutter_tools/lib/src/resident_runner.dart

bkonyi

Thanks for the changes! LGTM!

Roll Flutter from e8f34a9 to 39b4951 (95 revisions) flutter/flutter@e8f34a9...39b4951 2025-02-18 [email protected] Marks Windows_arm64 plugin_test_windows to be flaky (flutter/flutter#163123) 2025-02-18 [email protected] [android] use macro definition to shrink repetitive JNI code size. (flutter/flutter#163395) 2025-02-18 [email protected] Roll pub packages (flutter/flutter#163474) 2025-02-18 [email protected] [web] Cleanup everything HTML from the engine (outside html/ folder) (flutter/flutter#162840) 2025-02-18 [email protected] [Impeller] add support for rational bezier conics to Path (flutter/flutter#163282) 2025-02-18 [email protected] Change `cardTheme`, `dialogTheme`, and `tabBarTheme` type to `xxxThemeData` (flutter/flutter#157292) 2025-02-18 [email protected] Update integration test and benchmark Android .gitignore files to match the current app template (flutter/flutter#163276) 2025-02-18 [email protected] [Impeller] Don't create a redundant typography context. (flutter/flutter#163513) 2025-02-18 [email protected] Roll Dart SDK from fcef25f18e4d to 023ac80cef14 (1 revision) (flutter/flutter#163110) 2025-02-18 [email protected] update module_host_with_custom_build_v2_embedding to target android 35 and to use the latest gradle and agp versions (flutter/flutter#163542) 2025-02-18 [email protected] [Impeller] when binding to READ_FRAMEBUFFER, treat multisampled textures as single sampled. (flutter/flutter#163345) 2025-02-18 [email protected] Add missing properties to _ArcPaintPredicate. (flutter/flutter#162572) 2025-02-18 [email protected] Roll Packages from 8542af3 to cb4fb13 (4 revisions) (flutter/flutter#163544) 2025-02-18 [email protected] Remove bringup for android_display_cutout (flutter/flutter#163312) 2025-02-18 [email protected] Create VersionUtils class and unit tests and extract logic out of flutter.groovy (flutter/flutter#163166) 2025-02-18 [email protected] Invalidate `pod install` output if `.flutter-plugins-dependencies` content changes. (flutter/flutter#163275) 2025-02-18 [email protected] Replace hard coded numbers with mouse button defines (flutter/flutter#163503) 2025-02-18 [email protected] Roll Skia from 9147a9654043 to 6da10829d017 (1 revision) (flutter/flutter#163531) 2025-02-18 [email protected] Roll Skia from 92aaa4e20ea7 to 9147a9654043 (2 revisions) (flutter/flutter#163512) 2025-02-17 [email protected] Roll Skia from 71a160edc9d9 to 92aaa4e20ea7 (1 revision) (flutter/flutter#163488) 2025-02-17 [email protected] Roll Packages from 625023a to 8542af3 (21 revisions) (flutter/flutter#163484) 2025-02-17 [email protected] Roll Skia from 7e3129d5db11 to 71a160edc9d9 (1 revision) (flutter/flutter#163459) 2025-02-17 [email protected] Roll Skia from 40ce5ef20d22 to 7e3129d5db11 (1 revision) (flutter/flutter#163451) 2025-02-16 [email protected] Roll Skia from bb166c85957b to 40ce5ef20d22 (1 revision) (flutter/flutter#163403) 2025-02-15 [email protected] Roll Skia from ff94581f1f8a to bb166c85957b (1 revision) (flutter/flutter#163381) 2025-02-15 [email protected] Move DWDS initialization into the onLoadEndCallback for the DDC library bundle format (flutter/flutter#163338) 2025-02-14 [email protected] [canvaskit] Handle MakeGrContext returning null (flutter/flutter#163332) 2025-02-14 [email protected] Roll Skia from 13a3b6f34ee8 to ff94581f1f8a (1 revision) (flutter/flutter#163347) 2025-02-14 [email protected] Fix failing chrome_dev_mode tests (flutter/flutter#163346) 2025-02-14 [email protected] Adds all semantics roles (flutter/flutter#163075) 2025-02-14 [email protected] Roll Skia from 20924303cc25 to 13a3b6f34ee8 (1 revision) (flutter/flutter#163336) 2025-02-14 [email protected] [ Widget Preview ] Add experimental support for web-based widget preview environment (flutter/flutter#163154) 2025-02-14 [email protected] [Impeller] don't use glFramebufferBlit for onscreen restore. (flutter/flutter#163327) 2025-02-14 [email protected] Align web terminal messages with the VM (flutter/flutter#163268) 2025-02-14 [email protected] Manually roll customer_testing to enable rfw tests (flutter/flutter#163030) 2025-02-14 [email protected] Refactor SliverMainAxisGroup for reverse mode. (flutter/flutter#161849) 2025-02-14 [email protected] Tweaked TextContents math to avoid floating point errors (flutter/flutter#162480) 2025-02-14 [email protected] [release] Update cherry-pick CHANGELOG requirements (flutter/flutter#163318) 2025-02-14 [email protected] Roll Skia from 85722a1db585 to 20924303cc25 (2 revisions) (flutter/flutter#163293) 2025-02-14 [email protected] Roll Skia from 5a38d23ee247 to 85722a1db585 (1 revision) (flutter/flutter#163286) 2025-02-14 [email protected] Add `.flutter-plugins-dependencies` to `FlutterBuildSystem`; update logic, add tests. (flutter/flutter#163278) 2025-02-14 [email protected] Add table related semantics role (flutter/flutter#162339) 2025-02-14 [email protected] [Impeller] Call glDebugMessageControlKHR only if the KHR_debug extension is available (flutter/flutter#163273) 2025-02-14 [email protected] Roll Skia from 748415976ad1 to 5a38d23ee247 (3 revisions) (flutter/flutter#163271) 2025-02-14 [email protected] [canvaskit] Use `transferToImageBitmap` instead of `createImageBitmap` (flutter/flutter#163175) 2025-02-14 [email protected] [skwasm] Use `transferToImageBitmap` instead of `createImageBitmap` (flutter/flutter#163251) ...

Align web terminal messages with the VM

772ec66

Adds better instructions for hot reload (if using the right flags), hot restart, quitting, clearing, and more.

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Feb 13, 2025

srujzs added 2 commits February 13, 2025 15:16

Merge remote-tracking branch 'upstream/master' into webterminallogs

8d65abc

Add param to ResidentRunner to accept a CommandHelp and add tests to …

cb18c1c

…check that output is correct

srujzs requested review from biggs0125 and bkonyi February 14, 2025 00:07

srujzs added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 14, 2025

srujzs removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 14, 2025

Share implementation of printHelp

d01448c

- Adds supportsDetach getter to determine whether to print the command for detach. - Adds extra parameter to printHelp to avoid printing hot reload command when hot reload is implemented with hot restart.

Add missing new lines to test expectations

24b0625

biggs0125 reviewed Feb 14, 2025

View reviewed changes

packages/flutter_tools/lib/src/isolated/resident_web_runner.dart Show resolved Hide resolved

biggs0125 approved these changes Feb 14, 2025

View reviewed changes

bkonyi reviewed Feb 14, 2025

View reviewed changes

packages/flutter_tools/lib/src/isolated/resident_web_runner.dart Outdated Show resolved Hide resolved

packages/flutter_tools/lib/src/isolated/resident_web_runner.dart Outdated Show resolved Hide resolved

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

Address review comments

a41df30

bkonyi approved these changes Feb 14, 2025

View reviewed changes

srujzs added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 14, 2025

auto-submit bot added this pull request to the merge queue Feb 14, 2025

Merged via the queue into flutter:master with commit 9393aae Feb 14, 2025
138 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 14, 2025

engine-flutter-autoroll mentioned this pull request Feb 15, 2025

Roll Flutter from 892f9c13a2bb to c5ba240021b5 (142 revisions) flutter/packages#8638

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 15, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

1ebaf5f

engine-flutter-autoroll mentioned this pull request Feb 15, 2025

Roll Flutter from 892f9c13a2bb to c5ba240021b5 (142 revisions) flutter/packages#8639

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 15, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

ccc1a85

engine-flutter-autoroll mentioned this pull request Feb 16, 2025

Roll Flutter from 892f9c13a2bb to c7047d33c4d2 (143 revisions) flutter/packages#8643

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 16, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

36dcbc4

engine-flutter-autoroll mentioned this pull request Feb 16, 2025

Roll Flutter from 892f9c13a2bb to c7047d33c4d2 (143 revisions) flutter/packages#8644

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 16, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

b21fc42

engine-flutter-autoroll mentioned this pull request Feb 17, 2025

Roll Flutter from 892f9c13a2bb to d96f6212f4de (145 revisions) flutter/packages#8647

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 17, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

7f0547c

engine-flutter-autoroll mentioned this pull request Feb 17, 2025

Roll Flutter from 892f9c13a2bb to 22c78a0716da (146 revisions) flutter/packages#8648

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 17, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

d11df3f

engine-flutter-autoroll mentioned this pull request Feb 17, 2025

Roll Flutter from 892f9c13a2bb to e3ea776da3f7 (147 revisions) flutter/packages#8649

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 17, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

0cf4f6e

engine-flutter-autoroll mentioned this pull request Feb 18, 2025

Roll Flutter from e8f34a9eea90 to ffd53ff16641 (78 revisions) flutter/packages#8651

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 18, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

46428db

engine-flutter-autoroll mentioned this pull request Feb 18, 2025

Roll Flutter from e8f34a9eea90 to 5365993ff52e (79 revisions) flutter/packages#8653

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 18, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

64f95ec

engine-flutter-autoroll mentioned this pull request Feb 18, 2025

Roll Flutter from e8f34a9eea90 to 5365993ff52e (79 revisions) flutter/packages#8655

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 18, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

84c17b6

engine-flutter-autoroll mentioned this pull request Feb 19, 2025

Roll Flutter from e8f34a9eea90 to 7e155bc18e57 (90 revisions) flutter/packages#8660

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 19, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

9d2a90e

engine-flutter-autoroll mentioned this pull request Feb 19, 2025

Roll Flutter from e8f34a9eea90 to 7e155bc18e57 (90 revisions) flutter/packages#8662

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 19, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

6a4c7d7

engine-flutter-autoroll mentioned this pull request Feb 19, 2025

Roll Flutter from e8f34a9eea90 to 39b4951f8f0b (95 revisions) flutter/packages#8663

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 19, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

35b18e3

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 20, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

ac9e2ab

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 20, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

c35419a

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 20, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

ee4b6fc

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 20, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

c5ae8fb

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

15c0e7c

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

ecd2456

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

9393aae Align web terminal messages with the VM (flutter/flutter#163268)

9cafb31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Align web terminal messages with the VM #163268

Align web terminal messages with the VM #163268

Uh oh!

srujzs commented Feb 13, 2025 •

edited

Loading

Uh oh!

flutter-dashboard bot commented Feb 13, 2025

Uh oh!

biggs0125 commented Feb 14, 2025

Uh oh!

srujzs commented Feb 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

biggs0125 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bkonyi left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Align web terminal messages with the VM #163268

Align web terminal messages with the VM #163268

Uh oh!

Conversation

srujzs commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Feb 13, 2025

Uh oh!

biggs0125 commented Feb 14, 2025

Uh oh!

srujzs commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

biggs0125 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bkonyi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

srujzs commented Feb 13, 2025 •

edited

Loading

srujzs commented Feb 14, 2025 •

edited

Loading