Align web terminal messages with the VM (#163268)

- 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

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

Author: srujzs

packages/flutter_tools/lib/executable.dart

@@ -218,6 +218,8 @@ List<FlutterCommand> generateCommands({required bool verboseHelp, required bool
         fileSystem: globals.fs,
         logger: globals.logger,
         platform: globals.platform,
+        terminal: globals.terminal,
+        outputPreferences: globals.outputPreferences,
         signals: globals.signals,
       ),
       EmulatorsCommand(),

packages/flutter_tools/lib/src/base/command_help.dart

@@ -15,7 +15,7 @@ const int maxLineWidth = 84;
 class CommandHelp {
   CommandHelp({
     required Logger logger,
-    required AnsiTerminal terminal,
+    required Terminal terminal,
     required Platform platform,
     required OutputPreferences outputPreferences,
   }) : _logger = logger,
@@ -25,7 +25,7 @@ class CommandHelp {
 
   final Logger _logger;
 
-  final AnsiTerminal _terminal;
+  final Terminal _terminal;
 
   final Platform _platform;
 

packages/flutter_tools/lib/src/commands/daemon.dart

@@ -710,6 +710,9 @@ class AppDomain extends Domain {
         analytics: globals.analytics,
         systemClock: globals.systemClock,
         logger: globals.logger,
+        terminal: globals.terminal,
+        platform: globals.platform,
+        outputPreferences: globals.outputPreferences,
         fileSystem: globals.fs,
       );
     } else if (enableHotReload) {

packages/flutter_tools/lib/src/commands/drive.dart

@@ -17,6 +17,7 @@ import '../base/io.dart';
 import '../base/logger.dart';
 import '../base/platform.dart';
 import '../base/signals.dart';
+import '../base/terminal.dart';
 import '../base/utils.dart';
 import '../build_info.dart';
 import '../dart/package_map.dart';
@@ -60,11 +61,15 @@ class DriveCommand extends RunCommandBase {
     required FileSystem fileSystem,
     required Logger logger,
     required Platform platform,
+    required Terminal terminal,
+    required OutputPreferences outputPreferences,
     required this.signals,
   }) : _flutterDriverFactory = flutterDriverFactory,
        _fileSystem = fileSystem,
        _logger = logger,
        _platform = platform,
+       _terminal = terminal,
+       _outputPreferences = outputPreferences,
        _fsUtils = FileSystemUtils(fileSystem: fileSystem, platform: platform),
        super(verboseHelp: verboseHelp) {
     requiresPubspecYaml();
@@ -200,6 +205,8 @@ class DriveCommand extends RunCommandBase {
   final FileSystem _fileSystem;
   final Logger _logger;
   final Platform _platform;
+  final Terminal _terminal;
+  final OutputPreferences _outputPreferences;
   final FileSystemUtils _fsUtils;
   Timer? timeoutTimer;
   Map<ProcessSignal, Object>? screenshotTokens;
@@ -298,6 +305,8 @@ class DriveCommand extends RunCommandBase {
       applicationPackageFactory: ApplicationPackageFactory.instance!,
       logger: _logger,
       platform: _platform,
+      terminal: _terminal,
+      outputPreferences: _outputPreferences,
       processUtils: globals.processUtils,
       dartSdkPath: globals.artifacts!.getArtifactPath(Artifact.engineDartBinary),
       devtoolsLauncher: DevtoolsLauncher.instance!,

packages/flutter_tools/lib/src/commands/run.dart

@@ -720,6 +720,9 @@ class RunCommand extends RunCommandBase {
         fileSystem: globals.fs,
         analytics: globals.analytics,
         logger: globals.logger,
+        terminal: globals.terminal,
+        platform: globals.platform,
+        outputPreferences: globals.outputPreferences,
         systemClock: globals.systemClock,
       );
     }

packages/flutter_tools/lib/src/drive/drive_service.dart

@@ -15,6 +15,7 @@ import '../base/dds.dart';
 import '../base/logger.dart';
 import '../base/platform.dart';
 import '../base/process.dart';
+import '../base/terminal.dart';
 import '../build_info.dart';
 import '../device.dart';
 import '../resident_runner.dart';
@@ -26,19 +27,25 @@ class FlutterDriverFactory {
     required ApplicationPackageFactory applicationPackageFactory,
     required Platform platform,
     required Logger logger,
+    required Terminal terminal,
+    required OutputPreferences outputPreferences,
     required ProcessUtils processUtils,
     required String dartSdkPath,
     required DevtoolsLauncher devtoolsLauncher,
   }) : _applicationPackageFactory = applicationPackageFactory,
        _platform = platform,
        _logger = logger,
+       _terminal = terminal,
+       _outputPreferences = outputPreferences,
        _processUtils = processUtils,
        _dartSdkPath = dartSdkPath,
        _devtoolsLauncher = devtoolsLauncher;
 
   final ApplicationPackageFactory _applicationPackageFactory;
   final Platform _platform;
   final Logger _logger;
+  final Terminal _terminal;
+  final OutputPreferences _outputPreferences;
   final ProcessUtils _processUtils;
   final String _dartSdkPath;
   final DevtoolsLauncher _devtoolsLauncher;
@@ -48,7 +55,9 @@ class FlutterDriverFactory {
     if (web) {
       return WebDriverService(
         logger: _logger,
+        terminal: _terminal,
         platform: _platform,
+        outputPreferences: _outputPreferences,
         processUtils: _processUtils,
         dartSdkPath: _dartSdkPath,
       );

packages/flutter_tools/lib/src/drive/web_driver_service.dart

@@ -15,6 +15,7 @@ import '../base/io.dart';
 import '../base/logger.dart';
 import '../base/platform.dart';
 import '../base/process.dart';
+import '../base/terminal.dart';
 import '../base/utils.dart';
 import '../build_info.dart';
 import '../convert.dart';
@@ -32,15 +33,21 @@ class WebDriverService extends DriverService {
     required String dartSdkPath,
     required Platform platform,
     required Logger logger,
+    required Terminal terminal,
+    required OutputPreferences outputPreferences,
   }) : _processUtils = processUtils,
        _dartSdkPath = dartSdkPath,
        _platform = platform,
-       _logger = logger;
+       _logger = logger,
+       _terminal = terminal,
+       _outputPreferences = outputPreferences;
 
   final ProcessUtils _processUtils;
   final String _dartSdkPath;
   final Platform _platform;
   final Logger _logger;
+  final Terminal _terminal;
+  final OutputPreferences _outputPreferences;
 
   late ResidentRunner _residentRunner;
   Uri? _webUri;
@@ -99,6 +106,9 @@ class WebDriverService extends DriverService {
       fileSystem: globals.fs,
       analytics: globals.analytics,
       logger: _logger,
+      terminal: _terminal,
+      platform: _platform,
+      outputPreferences: _outputPreferences,
       systemClock: globals.systemClock,
     );
     final Completer<void> appStartedCompleter = Completer<void>.sync();

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

@@ -12,11 +12,13 @@ import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart' hide
 
 import '../application_package.dart';
 import '../base/async_guard.dart';
+import '../base/command_help.dart';
 import '../base/common.dart';
 import '../base/file_system.dart';
 import '../base/io.dart';
 import '../base/logger.dart';
 import '../base/net.dart';
+import '../base/platform.dart';
 import '../base/terminal.dart';
 import '../base/time.dart';
 import '../base/utils.dart';
@@ -52,6 +54,9 @@ class DwdsWebRunnerFactory extends WebRunnerFactory {
     required DebuggingOptions debuggingOptions,
     UrlTunneller? urlTunneller,
     required Logger logger,
+    required Terminal terminal,
+    required Platform platform,
+    required OutputPreferences outputPreferences,
     required FileSystem fileSystem,
     required SystemClock systemClock,
     required Analytics analytics,
@@ -69,6 +74,9 @@ class DwdsWebRunnerFactory extends WebRunnerFactory {
       systemClock: systemClock,
       fileSystem: fileSystem,
       logger: logger,
+      terminal: terminal,
+      platform: platform,
+      outputPreferences: outputPreferences,
     );
   }
 }
@@ -88,13 +96,17 @@ class ResidentWebRunner extends ResidentRunner {
     required DebuggingOptions debuggingOptions,
     required FileSystem fileSystem,
     required Logger logger,
+    required Terminal terminal,
+    required Platform platform,
+    required OutputPreferences outputPreferences,
     required SystemClock systemClock,
     required Analytics analytics,
     UrlTunneller? urlTunneller,
     // TODO(bkonyi): remove when ready to serve DevTools from DDS.
     ResidentDevtoolsHandlerFactory devtoolsHandler = createDefaultHandler,
   }) : _fileSystem = fileSystem,
        _logger = logger,
+       _platform = platform,
        _systemClock = systemClock,
        _analytics = analytics,
        _urlTunneller = urlTunneller,
@@ -105,10 +117,17 @@ class ResidentWebRunner extends ResidentRunner {
          stayResident: stayResident,
          machine: machine,
          devtoolsHandler: devtoolsHandler,
+         commandHelp: CommandHelp(
+           logger: logger,
+           terminal: terminal,
+           platform: platform,
+           outputPreferences: outputPreferences,
+         ),
        );
 
   final FileSystem _fileSystem;
   final Logger _logger;
+  final Platform _platform;
   final SystemClock _systemClock;
   final Analytics _analytics;
   final UrlTunneller? _urlTunneller;
@@ -146,6 +165,20 @@ class ResidentWebRunner extends ResidentRunner {
 
   bool get _enableDwds => debuggingEnabled;
 
+  @override
+  bool get reloadIsRestart =>
+      // Web behavior when not using the DDC library bundle format is to restart
+      // when a reload is issued. We can't use `canHotReload` to signal this
+      // since we still want a reload command to succeed, but to do a hot
+      // restart.
+      debuggingOptions.buildInfo.ddcModuleFormat != DdcModuleFormat.ddc ||
+      debuggingOptions.buildInfo.canaryFeatures != true;
+
+  // TODO(srujzs): Return true when web supports detaching.
+  // https://github.com/flutter/flutter/issues/163329
+  @override
+  bool get supportsDetach => false;
+
   ConnectionResult? _connectionResult;
   StreamSubscription<vmservice.Event>? _stdOutSub;
   StreamSubscription<vmservice.Event>? _stdErrSub;
@@ -205,24 +238,6 @@ class ResidentWebRunner extends ResidentRunner {
     appFinished();
   }
 
-  @override
-  void printHelp({bool details = true}) {
-    if (details) {
-      return printHelpDetails();
-    }
-    const String fire = '🔥';
-    const String rawMessage = '  To hot restart changes while running, press "r" or "R".';
-    final String message = _logger.terminal.color(
-      fire + _logger.terminal.bolden(rawMessage),
-      TerminalColor.red,
-    );
-    _logger.printStatus(message);
-    const String quitMessage = 'To quit, press "q".';
-    _logger.printStatus('For a more detailed help message, press "h". $quitMessage');
-    _logger.printStatus('');
-    printDebuggerList();
-  }
-
   @override
   Future<void> stopEchoingDeviceLog() async {
     // Do nothing for ResidentWebRunner
@@ -310,7 +325,7 @@ Please provide a valid TCP port (an integer between 0 and 65535, inclusive).
           isWasm: debuggingOptions.webUseWasm,
           useLocalCanvasKit: debuggingOptions.buildInfo.useLocalCanvasKit,
           rootDirectory: fileSystem.directory(projectRootPath),
-          isWindows: globals.platform.isWindows,
+          isWindows: _platform.isWindows,
         );
         Uri url = await device!.devFS!.create();
         if (debuggingOptions.tlsCertKeyPath != null && debuggingOptions.tlsCertPath != null) {
@@ -475,10 +490,10 @@ Please provide a valid TCP port (an integer between 0 and 65535, inclusive).
             // has some internal error, we should still surface it to make
             // debugging easier.
             String reloadFailedMessage = 'Hot reload failed:';
-            globals.printError(reloadFailedMessage);
+            _logger.printError(reloadFailedMessage);
             for (final ReasonForCancelling reason in contents.notices) {
               reloadFailedMessage += reason.toString();
-              globals.printError(reason.toString());
+              _logger.printError(reason.toString());
             }
             return OperationResult(1, reloadFailedMessage);
           }