Use a more structured response type for ConnectedApp.getVmServices API

This CL:
- changes the name of the `ConnectedApp.getVmServiceUris` service method to `ConnectedApp.getVmServices` since the response includes more than just the URI for each VM service object.
- Adds a new response type `VmServicesResponse`
- Enhances test coverage for existing response types

Work towards #60540.

Change-Id: Id4a1c05dde28c9b23975ad1d2ca68cb9e2bddb22
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/430545
Reviewed-by: Ben Konyi <[email protected]>
Commit-Queue: Kenzie Davisson <[email protected]>

Author: kenzieschmoll

pkg/dtd/CHANGELOG.md

@@ -4,7 +4,8 @@
 applications that DTD is aware of.
 - Log exceptions from invalid `streamNotify` events.
 - Added `getRegisteredServices` API.
-- Added a new response type `RegisteredServicesResponse`.
+- Added new response types `RegisteredServicesResponse` and
+`VmServicesResponse`.
 - **Breaking Change**: Changed the `serviceName` parameter for the
 `DartToolingDaemon.call` method to have type `String?` instead of `String.`
 - **Breaking Change**: When the `params` parameter for the

pkg/dtd/lib/src/constants.dart

@@ -39,7 +39,7 @@ extension ConnectedAppServiceConstants on Never {
 
   /// Service method name for the method that returns a list of VM service URIs
   /// for running applications in the context of a DTD instance.
-  static const getVmServiceUris = 'getVmServiceUris';
+  static const getVmServices = 'getVmServices';
 
   /// Service method name for the method that registers a new VM service
   /// connection.

pkg/dtd/lib/src/response_types/_connected_app.dart

@@ -0,0 +1,107 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+part of 'response_types.dart';
+
+/// A DTD response that contains information about a set of VM service
+/// connections.
+class VmServicesResponse {
+  const VmServicesResponse({required this.vmServicesInfos});
+
+  factory VmServicesResponse.fromDTDResponse(DTDResponse response) {
+    if (response.result[_kType] != type) {
+      throw json_rpc.RpcException.invalidParams(
+        'Expected $_kType param to be $type, got: ${response.result[_kType]}',
+      );
+    }
+    return VmServicesResponse._fromDTDResponse(response);
+  }
+
+  VmServicesResponse._fromDTDResponse(DTDResponse response)
+      : vmServicesInfos = List<Map<String, Object?>>.from(
+          (response.result[_kVmServices] as List).cast<Map<String, Object?>>(),
+        ).map(VmServiceInfo.fromJson).toList();
+
+  /// The key for the type parameter.
+  static const String _kType = 'type';
+
+  /// The key for the VM services parameter.
+  static const String _kVmServices = 'vmServices';
+
+  /// A list of VM services and their associated metadata.
+  final List<VmServiceInfo> vmServicesInfos;
+
+  static String get type => 'VmServicesResponse';
+
+  Map<String, Object?> toJson() => <String, Object?>{
+        _kType: type,
+        _kVmServices: vmServicesInfos.map((info) => info.toJson()).toList(),
+      };
+
+  @override
+  String toString() => '[$type $_kVmServices: $vmServicesInfos]';
+}
+
+/// Information about a VM service connection that is exposed via the DTD.
+class VmServiceInfo {
+  const VmServiceInfo({
+    required this.uri,
+    this.exposedUri,
+    this.name,
+  });
+
+  /// Deserializes a [json] object to create a [VmServiceInfo] object.
+  static VmServiceInfo fromJson(Map<String, Object?> json) => VmServiceInfo(
+        uri: json[_kUri] as String,
+        exposedUri: json[_kExposedUri] as String?,
+        name: json[_kName] as String?,
+      );
+
+  static const String _kUri = 'uri';
+  static const String _kExposedUri = 'exposedUri';
+  static const String _kName = 'name';
+
+  /// The URI for the VM service connection.
+  final String uri;
+
+  /// The URI for the VM service connection that has been exposed to the
+  /// user/client machine if the backend VM service is running in a different
+  /// location (for example, an editor running in the user's browser with the
+  /// backend on a remote server).
+  ///
+  /// Code that runs on the user/client machine (such as DevTools and DevTools
+  /// extensions) should prefer this URI (if provided) whereas code that also
+  /// runs on the backend (such as the debug adapter) should always use [uri].
+  ///
+  /// This value will be null or identical to [uri] in environments where
+  /// there is no exposing to do (for example, an editor running locally on the
+  /// same machine that the VM service is running).
+  final String? exposedUri;
+
+  /// The human-readable name for this VM service connection as defined by tool
+  /// or service that started it (e.g. 'Flutter - Pixel 5').
+  ///
+  /// This is optional and may be null if the DTD client that registered the VM
+  /// service did not provide a name.
+  final String? name;
+
+  /// Serializes this [VmServiceInfo] object to JSON.
+  Map<String, Object?> toJson() => <String, Object?>{
+        _kUri: uri,
+        if (exposedUri != null) _kExposedUri: exposedUri,
+        if (name != null) _kName: name,
+      };
+
+  @override
+  String toString() {
+    final sb = StringBuffer()..write(uri);
+    if (exposedUri != null && exposedUri != uri) {
+      sb.write(' (exposed: $exposedUri)');
+    }
+    if (name != null) {
+      sb.write(' - $name');
+    }
+    return sb.toString();
+  }
+}

pkg/dtd/lib/src/response_types/response_types.dart

@@ -7,6 +7,7 @@ import 'package:json_rpc_2/json_rpc_2.dart' as json_rpc;
 
 import '../dart_tooling_daemon.dart';
 
+part '_connected_app.dart';
 part '_file_system.dart';
 
 /// A DTD response that indicates success.

pkg/dtd/lib/src/services/connected_app_service.dart

@@ -88,12 +88,12 @@ extension ConnectedAppsExtension on DartToolingDaemon {
     );
   }
 
-  /// Returns a list of VM service URIs for running applications in the context
-  /// of this DTD instance.
-  Future<StringListResponse> getVmServiceUris() {
-    return _callOnConnectedAppService<StringListResponse>(
-      ConnectedAppServiceConstants.getVmServiceUris,
-      parseResponse: StringListResponse.fromDTDResponse,
+  /// Returns a response containing information about the set of VM service
+  /// connections this DTD instance is aware of.
+  Future<VmServicesResponse> getVmServices() {
+    return _callOnConnectedAppService<VmServicesResponse>(
+      ConnectedAppServiceConstants.getVmServices,
+      parseResponse: VmServicesResponse.fromDTDResponse,
     );
   }
 

pkg/dtd/test/connected_app_service_test.dart

@@ -55,8 +55,12 @@ void main() {
           expect(response.type, 'Success');
           expect(response.value, null);
           expect(
-            (await client.getVmServiceUris()).value,
-            [testApp.vmServiceUri],
+            (await client.getVmServices())
+                .vmServicesInfos
+                .map((s) => s.toJson()),
+            [
+              {'uri': testApp.vmServiceUri},
+            ],
           );
 
           response = await client.registerVmService(
@@ -66,8 +70,12 @@ void main() {
           expect(response.type, 'Success');
           expect(response.value, null);
           expect(
-            (await client.getVmServiceUris()).value,
-            [testApp.vmServiceUri],
+            (await client.getVmServices())
+                .vmServicesInfos
+                .map((s) => s.toJson()),
+            [
+              {'uri': testApp.vmServiceUri},
+            ],
           );
         });
 
@@ -100,8 +108,12 @@ void main() {
           expect(response.type, 'Success');
           expect(response.value, null);
           expect(
-            (await client.getVmServiceUris()).value,
-            [testApp.vmServiceUri],
+            (await client.getVmServices())
+                .vmServicesInfos
+                .map((s) => s.toJson()),
+            [
+              {'uri': testApp.vmServiceUri},
+            ],
           );
 
           response = await client.unregisterVmService(
@@ -110,7 +122,7 @@ void main() {
           );
           expect(response.type, 'Success');
           expect(response.value, null);
-          expect((await client.getVmServiceUris()).value, <String>[]);
+          expect((await client.getVmServices()).vmServicesInfos, isEmpty);
         });
 
         test('succeeds for URI that is not in the registry', () async {
@@ -161,13 +173,14 @@ void main() {
       });
     });
 
-    test('getVmServiceUris', () async {
+    test('getVmServices', () async {
       await startDtd();
 
       final testApp1 = DartCliAppProcess();
       await testApp1.start();
       var response = await client.registerVmService(
         uri: testApp1.vmServiceUri,
+        name: 'app 1',
         secret: dtdSecret!,
       );
       expect(response.type, 'Success');
@@ -177,13 +190,20 @@ void main() {
       await testApp2.start();
       response = await client.registerVmService(
         uri: testApp2.vmServiceUri,
+        exposedUri: testApp2.vmServiceUri,
         secret: dtdSecret!,
       );
       expect(response.type, 'Success');
       expect(response.value, null);
 
-      final uris = await client.getVmServiceUris();
-      expect(uris.value, [testApp1.vmServiceUri, testApp2.vmServiceUri]);
+      final servicesResponse = await client.getVmServices();
+      expect(
+        servicesResponse.vmServicesInfos.map((s) => s.toJson()),
+        [
+          {'uri': testApp1.vmServiceUri, 'name': 'app 1'},
+          {'uri': testApp2.vmServiceUri, 'exposedUri': testApp2.vmServiceUri},
+        ],
+      );
     });
 
     group('sends stream updates', () {

pkg/dtd/test/dart_tooling_daemon_test.dart

@@ -153,7 +153,7 @@ void main() {
               'getRegisteredServices',
               'ConnectedApp.registerVmService',
               'ConnectedApp.unregisterVmService',
-              'ConnectedApp.getVmServiceUris',
+              'ConnectedApp.getVmServices',
               'FileSystem.readFileAsString',
               'FileSystem.writeFileAsString',
               'FileSystem.listDirectoryContents',