Add a --print-dtd flag to print the DTD address served by DevTools server (#144272)

Author: kenzieschmoll

packages/flutter_tools/lib/executable.dart

@@ -3,7 +3,6 @@
 // found in the LICENSE file.
 
 import 'runner.dart' as runner;
-import 'src/artifacts.dart';
 import 'src/base/context.dart';
 import 'src/base/io.dart';
 import 'src/base/logger.dart';
@@ -110,7 +109,7 @@ Future<void> main(List<String> args) async {
       // devtools source code.
       DevtoolsLauncher: () => DevtoolsServerLauncher(
         processManager: globals.processManager,
-        dartExecutable: globals.artifacts!.getArtifactPath(Artifact.engineDartBinary),
+        artifacts: globals.artifacts!,
         logger: globals.logger,
         botDetector: globals.botDetector,
       ),

packages/flutter_tools/lib/src/context_runner.dart

@@ -218,7 +218,7 @@ Future<T> runInContext<T>(
       ),
       DevtoolsLauncher: () => DevtoolsServerLauncher(
         processManager: globals.processManager,
-        dartExecutable: globals.artifacts!.getArtifactPath(Artifact.engineDartBinary),
+        artifacts: globals.artifacts!,
         logger: globals.logger,
         botDetector: globals.botDetector,
       ),

packages/flutter_tools/lib/src/devtools_launcher.dart

@@ -2,35 +2,35 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-
-
 import 'dart:async';
 
 import 'package:meta/meta.dart';
 import 'package:process/process.dart';
 
+import 'artifacts.dart';
 import 'base/bot_detector.dart';
 import 'base/common.dart';
 import 'base/io.dart' as io;
 import 'base/logger.dart';
 import 'convert.dart';
 import 'resident_runner.dart';
 
-/// An implementation of the devtools launcher that uses `pub global activate` to
-/// start a server instance.
+/// An implementation of the devtools launcher that uses `dart devtools` to
+/// start a DevTools server instance.
 class DevtoolsServerLauncher extends DevtoolsLauncher {
   DevtoolsServerLauncher({
     required ProcessManager processManager,
-    required String dartExecutable,
     required Logger logger,
     required BotDetector botDetector,
+    required Artifacts artifacts,
   })  : _processManager = processManager,
-        _dartExecutable = dartExecutable,
         _logger = logger,
-        _botDetector = botDetector;
+        _botDetector = botDetector,
+        _artifacts = artifacts;
 
   final ProcessManager _processManager;
-  final String _dartExecutable;
+  final Artifacts _artifacts;
+  late final String _dartExecutable = _artifacts.getArtifactPath(Artifact.engineDartBinary);
   final Logger _logger;
   final BotDetector _botDetector;
   final Completer<void> _processStartCompleter = Completer<void>();
@@ -42,6 +42,8 @@ class DevtoolsServerLauncher extends DevtoolsLauncher {
 
   static final RegExp _serveDevToolsPattern =
       RegExp(r'Serving DevTools at ((http|//)[a-zA-Z0-9:/=_\-\.\[\]]+?)\.?$');
+  static final RegExp _serveDtdPattern =
+      RegExp(r'Serving the Dart Tooling Daemon at (ws:\/\/[a-zA-Z0-9:/=_\-\.\[\]]+?)\.?$');
 
   @override
   Future<void> get processStart => _processStartCompleter.future;
@@ -55,21 +57,28 @@ class DevtoolsServerLauncher extends DevtoolsLauncher {
         _dartExecutable,
         'devtools',
         '--no-launch-browser',
+        if (printDtdUri) '--print-dtd',
         if (vmServiceUri != null) '--vm-uri=$vmServiceUri',
         ...?additionalArguments,
       ]);
       _processStartCompleter.complete();
-      final Completer<Uri> completer = Completer<Uri>();
+
+      final Completer<Uri> devToolsCompleter = Completer<Uri>();
       _devToolsProcess!.stdout
           .transform(utf8.decoder)
           .transform(const LineSplitter())
           .listen((String line) {
-            final Match? match = _serveDevToolsPattern.firstMatch(line);
-            if (match != null) {
-              final String url = match[1]!;
-              completer.complete(Uri.parse(url));
-            }
-         });
+        final Match? dtdMatch = _serveDtdPattern.firstMatch(line);
+        if (dtdMatch != null) {
+          final String uri = dtdMatch[1]!;
+          dtdUri = Uri.parse(uri);
+        }
+        final Match? devToolsMatch = _serveDevToolsPattern.firstMatch(line);
+        if (devToolsMatch != null) {
+          final String url = devToolsMatch[1]!;
+          devToolsCompleter.complete(Uri.parse(url));
+        }
+      });
       _devToolsProcess!.stderr
           .transform(utf8.decoder)
           .transform(const LineSplitter())
@@ -84,7 +93,11 @@ class DevtoolsServerLauncher extends DevtoolsLauncher {
         }
       );
 
-      devToolsUrl = await completer.future;
+      // We do not need to wait for a [Completer] holding the DTD URI because
+      // the DTD URI will be output to stdout before the DevTools URI. Awaiting
+      // a [Completer] for the DevTools URI ensures both values will be
+      // populated before returning.
+      devToolsUrl = await devToolsCompleter.future;
     } on Exception catch (e, st) {
       _logger.printError('Failed to launch DevTools: $e', stackTrace: st);
     }

packages/flutter_tools/lib/src/resident_devtools_handler.dart

@@ -24,6 +24,19 @@ abstract class ResidentDevtoolsHandler {
   /// The current devtools server, or null if one is not running.
   DevToolsServerAddress? get activeDevToolsServer;
 
+  /// The Dart Tooling Daemon (DTD) URI for the DTD instance being hosted by
+  /// DevTools server.
+  ///
+  /// This will be null if the DevTools server is not served through Flutter
+  /// tools (e.g. if it is served from an IDE).
+  Uri? get dtdUri;
+
+  /// Whether to print the Dart Tooling Daemon URI.
+  ///
+  /// This will always return false when there is not a DTD instance being
+  /// served from the DevTools server.
+  bool get printDtdUri;
+
   /// Whether it's ok to announce the [activeDevToolsServer].
   ///
   /// This should only return true once all the devices have been notified
@@ -63,6 +76,12 @@ class FlutterResidentDevtoolsHandler implements ResidentDevtoolsHandler {
     return _devToolsLauncher?.activeDevToolsServer;
   }
 
+  @override
+  Uri? get dtdUri => _devToolsLauncher?.dtdUri;
+
+  @override
+  bool get printDtdUri => _devToolsLauncher?.printDtdUri ?? false;
+
   @override
   bool get readyToAnnounce => _readyToAnnounce;
   bool _readyToAnnounce = false;
@@ -337,6 +356,12 @@ class NoOpDevtoolsHandler implements ResidentDevtoolsHandler {
     wasShutdown = true;
     return;
   }
+
+  @override
+  Uri? get dtdUri => null;
+
+  @override
+  bool get printDtdUri => false;
 }
 
 /// Convert a [URI] with query parameters into a display format instead

packages/flutter_tools/lib/src/resident_runner.dart

@@ -1526,6 +1526,12 @@ abstract class ResidentRunner extends ResidentHandlers {
         );
       }
       if (includeDevtools) {
+        if (_residentDevtoolsHandler!.printDtdUri) {
+          final Uri? dtdUri = residentDevtoolsHandler!.dtdUri;
+          if (dtdUri != null) {
+            globals.printStatus('The Dart Tooling Daemon is available at: $dtdUri\n');
+          }
+        }
         final Uri? uri = devToolsServerAddress!.uri?.replace(
           queryParameters: <String, dynamic>{'uri': '${device.vmService!.httpAddress}'},
         );
@@ -1945,6 +1951,26 @@ abstract class DevtoolsLauncher {
     }
   }
 
+  /// The Dart Tooling Daemon (DTD) URI for the DTD instance being hosted by
+  /// DevTools server.
+  ///
+  /// This will be null if the DevTools server is not served through Flutter
+  /// tools (e.g. if it is served from an IDE).
+  Uri? get dtdUri => _dtdUri;
+  Uri? _dtdUri;
+  @protected
+  set dtdUri(Uri? value) => _dtdUri = value;
+
+  /// Whether to print the Dart Tooling Daemon URI.
+  ///
+  /// This will always return false when there is not a DTD instance being
+  /// served from the DevTools server.
+  bool get printDtdUri => _printDtdUri ?? false;
+  bool? _printDtdUri;
+  set printDtdUri(bool value) {
+    _printDtdUri = value;
+  }
+
   /// The URL of the current DevTools server.
   ///
   /// Returns null if [ready] is not complete.

packages/flutter_tools/lib/src/runner/flutter_command_runner.dart

@@ -17,6 +17,7 @@ import '../base/utils.dart';
 import '../cache.dart';
 import '../convert.dart';
 import '../globals.dart' as globals;
+import '../resident_runner.dart';
 import '../tester/flutter_tester.dart';
 import '../version.dart';
 import '../web/web_device.dart';
@@ -35,6 +36,7 @@ abstract final class FlutterGlobalOptions {
   static const String kMachineFlag = 'machine';
   static const String kPackagesOption = 'packages';
   static const String kPrefixedErrorsFlag = 'prefixed-errors';
+  static const String kPrintDtd = 'print-dtd';
   static const String kQuietFlag = 'quiet';
   static const String kShowTestDeviceFlag = 'show-test-device';
   static const String kShowWebServerDeviceFlag = 'show-web-server-device';
@@ -116,6 +118,12 @@ class FlutterCommandRunner extends CommandRunner<void> {
     argParser.addOption(FlutterGlobalOptions.kPackagesOption,
         hide: !verboseHelp,
         help: 'Path to your "package_config.json" file.');
+    argParser.addFlag(
+      FlutterGlobalOptions.kPrintDtd,
+      negatable: false,
+      help: 'Print the address of the Dart Tooling Daemon, if one is hosted by the Flutter CLI.',
+      hide: !verboseHelp,
+    );
     if (verboseHelp) {
       argParser.addSeparator('Local build selection options (not normally required):');
     }
@@ -357,6 +365,10 @@ class FlutterCommandRunner extends CommandRunner<void> {
         if (machineFlag && topLevelResults.command?.name != 'analyze') {
           throwToolExit('The "--machine" flag is only valid with the "--version" flag or the "analyze --suggestions" command.', exitCode: 2);
         }
+
+        final bool shouldPrintDtdUri = topLevelResults[FlutterGlobalOptions.kPrintDtd] as bool? ?? false;
+        DevtoolsLauncher.instance!.printDtdUri = shouldPrintDtdUri;
+
         await super.runCommand(topLevelResults);
       },
     );

packages/flutter_tools/test/commands.shard/hermetic/daemon_test.dart

@@ -824,7 +824,7 @@ void main() {
       expect(result['host'], '127.0.0.1');
       expect(result['port'], 1234);
     }, overrides: <Type, Generator>{
-      DevtoolsLauncher: () => FakeDevtoolsLauncher(DevToolsServerAddress('127.0.0.1', 1234)),
+      DevtoolsLauncher: () => FakeDevtoolsLauncher(serverAddress: DevToolsServerAddress('127.0.0.1', 1234)),
     });
 
     testUsingContext('devtools.serve command should return null fields if null returned', () async {
@@ -840,7 +840,7 @@ void main() {
       expect(result['host'], null);
       expect(result['port'], null);
     }, overrides: <Type, Generator>{
-      DevtoolsLauncher: () => FakeDevtoolsLauncher(null),
+      DevtoolsLauncher: () => FakeDevtoolsLauncher(),
     });
 
     testUsingContext('proxy.connect tries to connect to an ipv4 address and proxies the connection correctly', () async {
@@ -1286,18 +1286,6 @@ class FakeDeviceLogReader implements DeviceLogReader {
 
 }
 
-class FakeDevtoolsLauncher extends Fake implements DevtoolsLauncher {
-  FakeDevtoolsLauncher(this._serverAddress);
-
-  final DevToolsServerAddress? _serverAddress;
-
-  @override
-  Future<DevToolsServerAddress?> serve() async => _serverAddress;
-
-  @override
-  Future<void> close() async {}
-}
-
 class FakeApplicationPackageFactory implements ApplicationPackageFactory {
   TargetPlatform? platformRequested;
   File? applicationBinaryRequested;