Update flutter_tools to look for new VM service message (#97683)

* Update flutter_tools to look for new VM service message

The Dart SDK will soon move away from the current Observatory message:

"Observatory listening on ..."

To a new message that no longer references Observatory:

"Dart VM Service listening on ..."

This change updates all tests with mocks to check for the new message
and also adds support for the new message in ProtocolDiscovery.

See https://github.com/dart-lang/sdk/issues/46756

* Fix some parsing locations

* Fix analysis failures

* Update message

* Remove extra comment

* Update message

* Add globals prefix

dev/devicelab/lib/framework/runner.dart

@@ -190,7 +190,7 @@ Future<TaskResult> runTask(
       .transform<String>(const LineSplitter())
       .listen((String line) {
     if (!uri.isCompleted) {
-      final Uri? serviceUri = parseServiceUri(line, prefix: 'Observatory listening on ');
+      final Uri? serviceUri = parseServiceUri(line, prefix: RegExp('(Observatory|Dart VM Service) listening on '));
       if (serviceUri != null)
         uri.complete(serviceUri);
     }

packages/flutter/lib/src/widgets/widget_inspector.dart

@@ -688,7 +688,7 @@ class _WidgetInspectorService = Object with WidgetInspectorService;
 ///
 /// Calls to this object are typically made from GUI tools such as the [Flutter
 /// IntelliJ Plugin](https://github.com/flutter/flutter-intellij/blob/master/README.md)
-/// using the [Dart VM Service protocol](https://github.com/dart-lang/sdk/blob/main/runtime/vm/service/service.md).
+/// using the [Dart VM Service](https://github.com/dart-lang/sdk/blob/main/runtime/vm/service/service.md).
 /// This class uses its own object id and manages object lifecycles itself
 /// instead of depending on the [object ids](https://github.com/dart-lang/sdk/blob/main/runtime/vm/service/service.md#getobject)
 /// specified by the VM Service Protocol because the VM Service Protocol ids

packages/flutter_tools/lib/src/globals.dart

@@ -281,3 +281,7 @@ PreRunValidator get preRunValidator => context.get<PreRunValidator>() ?? const N
 
 // TODO(fujino): Migrate to 'main' https://github.com/flutter/flutter/issues/95041
 const String kDefaultFrameworkChannel = 'master';
+
+// Used to build RegExp instances which can detect the VM service message.
+const String kServicePrefixRegExp = '(?:Observatory|The Dart VM service is)';
+final RegExp kVMServiceMessageRegExp = RegExp(kServicePrefixRegExp + r' listening on ((http|//)[a-zA-Z0-9:/=_\-\.\[\]]+)');

packages/flutter_tools/lib/src/ios/ios_deploy.dart

@@ -313,7 +313,7 @@ class IOSDeployDebugger {
 
         // (lldb)     run
         // success
-        // 2020-09-15 13:42:25.185474-0700 Runner[477:181141] flutter: Observatory listening on http://127.0.0.1:57782/
+        // 2020-09-15 13:42:25.185474-0700 Runner[477:181141] flutter: The Dart VM service is listening on http://127.0.0.1:57782/
         if (_lldbRun.hasMatch(line)) {
           _logger.printTrace(line);
           _debuggerState = _IOSDeployDebuggerState.launching;

packages/flutter_tools/lib/src/ios/simulators.dart

@@ -757,8 +757,8 @@ class _IOSSimulatorLogReader extends DeviceLogReader {
   }
 
   // Match the log prefix (in order to shorten it):
-  // * Xcode 8: Sep 13 15:28:51 cbracken-macpro localhost Runner[37195]: (Flutter) Observatory listening on http://127.0.0.1:57701/
-  // * Xcode 9: 2017-09-13 15:26:57.228948-0700  localhost Runner[37195]: (Flutter) Observatory listening on http://127.0.0.1:57701/
+  // * Xcode 8: Sep 13 15:28:51 cbracken-macpro localhost Runner[37195]: (Flutter) The Dart VM service is listening on http://127.0.0.1:57701/
+  // * Xcode 9: 2017-09-13 15:26:57.228948-0700  localhost Runner[37195]: (Flutter) The Dart VM service is listening on http://127.0.0.1:57701/
   static final RegExp _mapRegex = RegExp(r'\S+ +\S+ +(?:\S+) (.+?(?=\[))\[\d+\]\)?: (\(.*?\))? *(.*)$');
 
   // Jan 31 19:23:28 --- last message repeated 1 time ---

packages/flutter_tools/lib/src/protocol_discovery.dart

@@ -8,6 +8,7 @@ import 'base/io.dart';
 import 'base/logger.dart';
 import 'device.dart';
 import 'device_port_forwarder.dart';
+import 'globals.dart' as globals;
 
 /// Discovers a specific service protocol on a device, and forwards the service
 /// protocol device port to the host.
@@ -104,8 +105,7 @@ class ProtocolDiscovery {
   }
 
   Match? _getPatternMatch(String line) {
-    final RegExp r = RegExp(RegExp.escape(serviceName) + r' listening on ((http|//)[a-zA-Z0-9:/=_\-\.\[\]]+)');
-    return r.firstMatch(line);
+    return globals.kVMServiceMessageRegExp.firstMatch(line);
   }
 
   Uri? _getObservatoryUri(String line) {

packages/flutter_tools/lib/src/resident_runner.dart

@@ -367,7 +367,7 @@ class FlutterDevice {
       return;
     }
     _loggingSubscription = logStream.listen((String line) {
-      if (!line.contains('Observatory listening on http')) {
+      if (!line.contains(globals.kVMServiceMessageRegExp)) {
         globals.printStatus(line, wrap: false);
       }
     });

packages/flutter_tools/lib/src/test/flutter_tester_device.dart

@@ -20,6 +20,7 @@ import '../base/os.dart';
 import '../base/platform.dart';
 import '../convert.dart';
 import '../device.dart';
+import '../globals.dart' as globals;
 import '../project.dart';
 import '../vmservice.dart';
 
@@ -294,7 +295,6 @@ class FlutterTesterTestDevice extends TestDevice {
     @required Process process,
     @required Future<void> Function(Uri uri) reportObservatoryUri,
   }) {
-    const String observatoryString = 'Observatory listening on ';
     for (final Stream<List<int>> stream in <Stream<List<int>>>[
       process.stderr,
       process.stdout,
@@ -306,9 +306,10 @@ class FlutterTesterTestDevice extends TestDevice {
             (String line) async {
           logger.printTrace('test $id: Shell: $line');
 
-          if (line.startsWith(observatoryString)) {
+          final Match match = globals.kVMServiceMessageRegExp.firstMatch(line);
+          if (match != null) {
             try {
-              final Uri uri = Uri.parse(line.substring(observatoryString.length));
+              final Uri uri = Uri.parse(match[1]);
               if (reportObservatoryUri != null) {
                 await reportObservatoryUri(uri);
               }

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

@@ -104,7 +104,7 @@ void main() {
       testUsingContext('finds observatory port and forwards', () async {
         device.onGetLogReader = () {
           fakeLogReader.addLine('Foo');
-          fakeLogReader.addLine('Observatory listening on http://127.0.0.1:$devicePort');
+          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
           return fakeLogReader;
         };
         testDeviceManager.addDevice(device);
@@ -133,7 +133,7 @@ void main() {
       testUsingContext('Fails with tool exit on bad Observatory uri', () async {
         device.onGetLogReader = () {
           fakeLogReader.addLine('Foo');
-          fakeLogReader.addLine('Observatory listening on http://127.0.0.1:$devicePort');
+          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
           fakeLogReader.dispose();
           return fakeLogReader;
         };
@@ -148,7 +148,7 @@ void main() {
       testUsingContext('accepts filesystem parameters', () async {
         device.onGetLogReader = () {
           fakeLogReader.addLine('Foo');
-          fakeLogReader.addLine('Observatory listening on http://127.0.0.1:$devicePort');
+          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
           return fakeLogReader;
         };
         testDeviceManager.addDevice(device);
@@ -223,7 +223,7 @@ void main() {
       testUsingContext('exits when observatory-port is specified and debug-port is not', () async {
         device.onGetLogReader = () {
           fakeLogReader.addLine('Foo');
-          fakeLogReader.addLine('Observatory listening on http://127.0.0.1:$devicePort');
+          fakeLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:$devicePort');
           return fakeLogReader;
         };
         testDeviceManager.addDevice(device);

packages/flutter_tools/test/general.shard/android/android_device_start_test.dart

@@ -200,7 +200,7 @@ void main() {
         '10',
         'app.apk'
       ],
-      stdout: '\n\nObservatory listening on http://127.0.0.1:456\n\n',
+      stdout: '\n\nThe Dart VM service is listening on http://127.0.0.1:456\n\n',
     ));
     processManager.addCommand(kShaCommand);
     processManager.addCommand(const FakeCommand(

packages/flutter_tools/test/general.shard/custom_devices/custom_device_test.dart

@@ -370,7 +370,7 @@ void main() {
       FakeCommand(
         command: testConfig.runDebugCommand,
         completer: runDebugCompleter,
-        stdout: 'Observatory listening on http://127.0.0.1:12345/abcd/\n',
+        stdout: 'The Dart VM service is listening on http://127.0.0.1:12345/abcd/\n',
       ),
       FakeCommand(
         command: testConfig.forwardPortCommand,
@@ -411,7 +411,7 @@ void main() {
         FakeCommand(
           command: testConfigNonForwarding.runDebugCommand,
           completer: runDebugCompleter,
-          stdout: 'Observatory listening on http://192.168.178.123:12345/abcd/\n'
+          stdout: 'The Dart VM service is listening on http://192.168.178.123:12345/abcd/\n'
         ),
       ]
     );
@@ -456,7 +456,7 @@ void main() {
           FakeCommand(
             command: testConfig.runDebugCommand,
             completer: runDebugCompleter,
-            stdout: 'Observatory listening on http://127.0.0.1:12345/abcd/\n',
+            stdout: 'The Dart VM service is listening on http://127.0.0.1:12345/abcd/\n',
           ),
           FakeCommand(
             command: testConfig.forwardPortCommand,

packages/flutter_tools/test/general.shard/desktop_device_test.dart

@@ -81,7 +81,7 @@ void main() {
       final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
         FakeCommand(
           command: const <String>['debug'],
-          stdout: 'Observatory listening on http://127.0.0.1/0\n',
+          stdout: 'The Dart VM service is listening on http://127.0.0.1/0\n',
           completer: completer,
         ),
       ]);
@@ -118,7 +118,7 @@ void main() {
       final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
         FakeCommand(
           command: const <String>['debug'],
-          stdout: 'Observatory listening on http://127.0.0.1/0\n',
+          stdout: 'The Dart VM service is listening on http://127.0.0.1/0\n',
           completer: completer,
         ),
       ]);
@@ -140,7 +140,7 @@ void main() {
     final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
       FakeCommand(
         command: const <String>['debug'],
-        stdout: 'Observatory listening on http://127.0.0.1/0\n',
+        stdout: 'The Dart VM service is listening on http://127.0.0.1/0\n',
         completer: completer,
         environment: const <String, String>{
           'FLUTTER_ENGINE_SWITCH_1': 'enable-dart-profiling=true',
@@ -202,7 +202,7 @@ void main() {
     final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
       FakeCommand(
         command: const <String>['debug'],
-        stdout: 'Observatory listening on http://127.0.0.1/0\n',
+        stdout: 'The Dart VM service is listening on http://127.0.0.1/0\n',
         completer: completer,
         environment: const <String, String>{
           'FLUTTER_ENGINE_SWITCH_1': 'enable-dart-profiling=true',
@@ -251,7 +251,7 @@ void main() {
     final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
       FakeCommand(
         command: const <String>['debug', 'arg1', 'arg2'],
-        stdout: 'Observatory listening on http://127.0.0.1/0\n',
+        stdout: 'The Dart VM service is listening on http://127.0.0.1/0\n',
         completer: completer,
       ),
     ]);

packages/flutter_tools/test/general.shard/flutter_tester_device_test.dart

@@ -247,7 +247,7 @@ void main() {
             '--packages=.dart_tool/package_config.json',
             'example.dill'
           ],
-          stdout: 'Observatory listening on http://localhost:1234',
+          stdout: 'The Dart VM service is listening on http://localhost:1234',
           stderr: 'failure',
         )
       ]);

packages/flutter_tools/test/general.shard/ios/ios_device_start_prebuilt_test.dart

@@ -128,7 +128,7 @@ void main() {
     // Start writing messages to the log reader.
     Timer.run(() {
       deviceLogReader.addLine('Foo');
-      deviceLogReader.addLine('Observatory listening on http://127.0.0.1:456');
+      deviceLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:456');
     });
 
     final LaunchResult launchResult = await device.startApp(iosApp,
@@ -166,7 +166,7 @@ void main() {
     // Start writing messages to the log reader.
     Timer.run(() {
       deviceLogReader.addLine('Foo');
-      deviceLogReader.addLine('Observatory listening on http://127.0.0.1:456');
+      deviceLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:456');
     });
 
     final LaunchResult launchResult = await device.startApp(iosApp,
@@ -206,7 +206,7 @@ void main() {
     Timer.run(() async {
       await Future<void>.delayed(const Duration(milliseconds: 1));
       deviceLogReader.addLine('Foo');
-      deviceLogReader.addLine('Observatory listening on http://127.0.0.1:456');
+      deviceLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:456');
     });
 
     final LaunchResult launchResult = await device.startApp(iosApp,
@@ -311,7 +311,7 @@ void main() {
 
     // Start writing messages to the log reader.
     Timer.run(() {
-      deviceLogReader.addLine('Observatory listening on http://127.0.0.1:1234');
+      deviceLogReader.addLine('The Dart VM service is listening on http://127.0.0.1:1234');
     });
 
     final LaunchResult launchResult = await device.startApp(iosApp,

packages/flutter_tools/test/general.shard/ios/simulators_test.dart

@@ -495,7 +495,7 @@ void main() {
           ..addCommand(const FakeCommand(
             command:  <String>['tail', '-n', '0', '-F', 'system.log'],
             stdout: '''
-Dec 20 17:04:32 md32-11-vm1 My Super Awesome App[88374]: flutter: Observatory listening on http://127.0.0.1:64213/1Uoeu523990=/
+Dec 20 17:04:32 md32-11-vm1 My Super Awesome App[88374]: flutter: The Dart VM service is listening on http://127.0.0.1:64213/1Uoeu523990=/
 Dec 20 17:04:32 md32-11-vm1 Another App[88374]: Ignore this text'''
           ))
           ..addCommand(const FakeCommand(
@@ -514,7 +514,7 @@ Dec 20 17:04:32 md32-11-vm1 Another App[88374]: Ignore this text'''
 
         final List<String> lines = await logReader.logLines.toList();
         expect(lines, <String>[
-          'flutter: Observatory listening on http://127.0.0.1:64213/1Uoeu523990=/',
+          'flutter: The Dart VM service is listening on http://127.0.0.1:64213/1Uoeu523990=/',
         ]);
         expect(fakeProcessManager.hasRemainingExpectations, isFalse);
       }, overrides: <Type, Generator>{
@@ -529,7 +529,7 @@ Dec 20 17:04:32 md32-11-vm1 Another App[88374]: Ignore this text'''
           ..addCommand(const FakeCommand(
             command:  <String>['tail', '-n', '0', '-F', 'system.log'],
             stdout: '''
-2017-09-13 15:26:57.228948-0700  localhost My Super Awesome App[37195]: (Flutter) Observatory listening on http://127.0.0.1:57701/
+2017-09-13 15:26:57.228948-0700  localhost My Super Awesome App[37195]: (Flutter) The Dart VM service is listening on http://127.0.0.1:57701/
 2017-09-13 15:26:57.228948-0700  localhost My Super Awesome App[37195]: (Flutter) ))))))))))
 2017-09-13 15:26:57.228948-0700  localhost My Super Awesome App[37195]: (Flutter) #0      Object.noSuchMethod (dart:core-patch/dart:core/object_patch.dart:46)'''
           ))
@@ -549,7 +549,7 @@ Dec 20 17:04:32 md32-11-vm1 Another App[88374]: Ignore this text'''
 
         final List<String> lines = await logReader.logLines.toList();
         expect(lines, <String>[
-          'Observatory listening on http://127.0.0.1:57701/',
+          'The Dart VM service is listening on http://127.0.0.1:57701/',
           '))))))))))',
           '#0      Object.noSuchMethod (dart:core-patch/dart:core/object_patch.dart:46)',
         ]);

packages/flutter_tools/test/general.shard/preview_device_test.dart

@@ -61,7 +61,7 @@ void main() {
           command: const <String>[
             '/.tmp_rand0/flutter_preview.rand0/splash'
           ],
-          stdout: 'Observatory listening on http://127.0.0.1:64494/fZ_B2N6JRwY=/\n',
+          stdout: 'The Dart VM service is listening on http://127.0.0.1:64494/fZ_B2N6JRwY=/\n',
           completer: completer,
         )
       ]),

packages/flutter_tools/test/general.shard/tester/flutter_tester_test.dart

@@ -154,7 +154,7 @@ void main() {
         completer: completer,
         stdout:
         '''
-Observatory listening on $observatoryUri
+The Dart VM service is listening on $observatoryUri
 Hello!
 ''',
       ));