Add a DTD method to get all registered services.

This CL contains breaking changes for package:dtd and prepares both package:dart_service_protocol_shared and package:dtd for publish.

This CL also fixes #60757 so that DTD-registered services are sent over the `Service` stream upon initial subscription like what is done for client-registered services.

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

Author: kenzieschmoll

pkg/analysis_server/CONTRIBUTING.md

@@ -64,6 +64,14 @@ To run just the analysis server integration tests:
 ./tools/test.py -mrelease pkg/analysis_server/test/integration/
 ```
 
+To run a single test:
+
+```
+dart test pkg/analysis_server/test/some_test.dart
+```
+
+> Note: `dart` may need to point to a Dart SDK built from source
+depending on the changes you are testing.
 
 [building]: https://github.com/dart-lang/sdk/wiki/Building
 [contributing]: https://github.com/dart-lang/sdk/blob/master/CONTRIBUTING.md

pkg/analysis_server/lib/src/lsp/handlers/custom/handler_experimental_echo.dart

@@ -29,10 +29,10 @@ class ExperimentalEchoHandler extends SharedMessageHandler<Object?, Object?> {
     MessageInfo message,
     CancellationToken token,
   ) async {
-    // The DTD client automatically converts `null` params to an empty map, but
-    // (because of a previous bug) we want to test null results. So if the
-    // params are an empty map, return null. This is tested by
-    // `test_service_success_echo_nullResponse` in `SharedDtdTests`.
+    // The DTD client may send an empty map as params. Return null in this case.
+    // This is tested by
+    //`test_service_success_echo_nullResponse_with_empty_params` in
+    // `SharedDtdTests`.
     if (params is Map && params.isEmpty) {
       return success(null);
     }

pkg/analysis_server/lib/src/services/dart_tooling_daemon/dtd_services.dart

@@ -179,7 +179,7 @@ class DtdServices {
     var message = IncomingMessage(
       jsonrpc: jsonRpcVersion,
       method: method,
-      params: params.asMap,
+      params: params.value,
     );
     var scheduler = _server.messageScheduler;
     var completer = Completer<Map<String, Object?>>();

pkg/analysis_server/test/shared/shared_dtd_tests.dart

@@ -88,7 +88,10 @@ mixin SharedDtdTests
 
   /// A list of service/methods that the test client has seen registered (and
   /// not yet unregistered) over the DTD connection.
-  final availableMethods = <(String, Method)>[];
+  ///
+  /// The service name is a nullable String because DTD-internal methods and
+  /// services do not have a service name.
+  final availableMethods = <(String?, Method)>[];
 
   /// An invalid DTD URI used for testing connection failures.
   final invalidUri = Uri.parse('ws://invalid:345/invalid');
@@ -207,12 +210,12 @@ mixin SharedDtdTests
       switch (e.kind) {
         case 'ServiceRegistered':
           availableMethods.add((
-            e.data['service'] as String,
+            e.data['service'] as String?,
             Method(e.data['method'] as String),
           ));
         case 'ServiceUnregistered':
           availableMethods.remove((
-            e.data['service'] as String,
+            e.data['service'] as String?,
             Method(e.data['method'] as String),
           ));
       }
@@ -470,7 +473,24 @@ FutureOr<void>? a;
     expect(result, equals({'a': 'b'}));
   }
 
-  Future<void> test_service_success_echo_nullResponse() async {
+  Future<void>
+  test_service_success_echo_nullResponse_with_empty_params() async {
+    await initializeServer();
+    await sendConnectToDtdRequest(registerExperimentalHandlers: true);
+
+    var response = await dtd.connection.call(
+      lspServiceName,
+      CustomMethods.experimentalEcho.toString(),
+      params: const <String, Object?>{},
+    );
+
+    var result = response.result['result'] as Map<String, Object?>?;
+
+    expect(response.type, 'Null');
+    expect(result, isNull);
+  }
+
+  Future<void> test_service_success_echo_nullResponse_with_null_params() async {
     await initializeServer();
     await sendConnectToDtdRequest(registerExperimentalHandlers: true);
 
@@ -512,7 +532,10 @@ void [!myFun^ction!]() {}
     await initializeServer();
     await sendConnectToDtdRequest();
 
-    expect(availableMethods, isNotEmpty);
+    var lspMethods = availableMethods.where(
+      (serviceMethod) => serviceMethod.$1 == 'Lsp',
+    );
+    expect(lspMethods, isNotEmpty);
 
     // Send a request to the server to connect to DTD. This will only complete
     // once all services are registered, however there's no guarantee about the
@@ -521,9 +544,9 @@ void [!myFun^ction!]() {}
     await shutdownServer();
 
     // Wait for the services to be unregistered.
-    while (availableMethods.isNotEmpty) {
+    while (lspMethods.isNotEmpty) {
       await pumpEventQueue(times: 5000);
     }
-    expect(availableMethods, isEmpty);
+    expect(lspMethods, isEmpty);
   }
 }

pkg/dart_service_protocol_shared/CHANGELOG.md

@@ -1,5 +1,8 @@
-## 0.0.3-wip
+## 0.0.3
 - Update sdk constraint to '^3.5.0'
+- Added `ClientServiceInfo.fromJson` and `ClientServiceInfo.toJson` methods.
+- Added `ClientServiceMethodInfo.fromJson` and `ClientServiceMethodInfo.toJson`
+methods.
 
 ## 0.0.2
 - Fixed an issue with streamNotify data type being too specific.

pkg/dart_service_protocol_shared/lib/src/client.dart

@@ -48,6 +48,26 @@ class ClientServiceInfo {
   ClientServiceInfo(this.name, [Map<String, ClientServiceMethodInfo>? methods])
       : methods = methods ?? {};
 
+  /// Deserializes a [json] object to create a [ClientServiceInfo] object.
+  static ClientServiceInfo fromJson(Map<String, Object?> json) {
+    if (json case {_kName: final String name, _kMethods: final List methods}) {
+      return ClientServiceInfo(
+        name,
+        <String, ClientServiceMethodInfo>{
+          for (final method in methods
+              .cast<Map<String, Object?>>()
+              .map(ClientServiceMethodInfo.fromJson))
+            method.name: method
+        },
+      );
+    }
+    throw ArgumentError('Unexpected JSON format: $json');
+  }
+
+  static const _kName = 'name';
+
+  static const _kMethods = 'methods';
+
   /// The name of the service.
   ///
   /// A client can register multiple services each with multiple methods.
@@ -58,13 +78,35 @@ class ClientServiceInfo {
 
   /// The service methods registered for this service.
   final Map<String, ClientServiceMethodInfo> methods;
+
+  /// Serializes this [ClientServiceInfo] object to JSON.
+  Map<String, Object?> toJson() => {
+        _kName: name,
+        _kMethods: methods.values.map((m) => m.toJson()).toList(),
+      };
 }
 
 /// Information about an individual method of a service provided by a
 /// client.
 class ClientServiceMethodInfo {
   ClientServiceMethodInfo(this.name, [this.capabilities]);
 
+  /// Deserializes a [json] object to create a [ClientServiceMethodInfo] object.
+  static ClientServiceMethodInfo fromJson(Map<String, Object?> json) {
+    try {
+      return ClientServiceMethodInfo(
+        json[_kName] as String,
+        json[_kCapabilities] as Map<String, Object?>?,
+      );
+    } catch (e) {
+      throw ArgumentError('Unexpected JSON format: $json');
+    }
+  }
+
+  static const _kName = 'name';
+
+  static const _kCapabilities = 'capabilities';
+
   /// The name of the method.
   ///
   /// A client can register multiple methods for each service but can only use
@@ -74,6 +116,12 @@ class ClientServiceMethodInfo {
 
   /// Optional capabilities of this service method provided by the client.
   final Map<String, Object?>? capabilities;
+
+  /// Serializes this [ClientServiceMethodInfo] object to JSON.
+  Map<String, Object?> toJson() => {
+        _kName: name,
+        if (capabilities != null) _kCapabilities: capabilities,
+      };
 }
 
 /// Used for keeping track and managing clients that are connected to a given

pkg/dart_service_protocol_shared/pubspec.yaml

@@ -1,7 +1,7 @@
 name: dart_service_protocol_shared
 description: A package that implements service extensions and stream managers.
 
-version: 0.0.3-wip
+version: 0.0.3
 repository: https://github.com/dart-lang/sdk/tree/main/pkg/dart_service_protocol_shared
 
 environment:

pkg/dart_service_protocol_shared/test/client_test.dart

@@ -128,4 +128,82 @@ void main() {
       );
     });
   });
+
+  group('ClientServiceInfo', () {
+    test('toJson and fromJson', () {
+      final serviceInfo = ClientServiceInfo(
+        'testService',
+        {
+          'method1': ClientServiceMethodInfo('method1', {'capability': true}),
+          'method2': ClientServiceMethodInfo('method2'),
+        },
+      );
+
+      final json = serviceInfo.toJson();
+      final deserialized = ClientServiceInfo.fromJson(json);
+
+      expect(deserialized.name, 'testService');
+      expect(deserialized.methods.length, 2);
+      expect(deserialized.methods['method1']?.name, 'method1');
+      expect(
+        deserialized.methods['method1']?.capabilities,
+        {'capability': true},
+      );
+      expect(deserialized.methods['method2']?.name, 'method2');
+      expect(deserialized.methods['method2']?.capabilities, isNull);
+    });
+
+    test('fromJson throws with invalid json', () {
+      expect(
+        () => ClientServiceInfo.fromJson({
+          'name': 'testService',
+          'methods': [
+            {'bad': 'format'}
+          ],
+        }),
+        throwsA(isA<ArgumentError>()),
+      );
+      expect(
+        () => ClientServiceInfo.fromJson({
+          'methods': [
+            {'name': 'method1'}
+          ],
+        }),
+        throwsA(isA<ArgumentError>()),
+        reason: 'Missing "name" field in top-level map',
+      );
+    });
+  });
+
+  group('ClientServiceMethodInfo', () {
+    test('toJson and parse', () {
+      final methodInfo =
+          ClientServiceMethodInfo('testMethod', {'capability': 123});
+
+      final json = methodInfo.toJson();
+      final deserialized = ClientServiceMethodInfo.fromJson(json);
+
+      expect(deserialized.name, 'testMethod');
+      expect(deserialized.capabilities, {'capability': 123});
+    });
+
+    test('toJson and parse without capabilities', () {
+      final methodInfo = ClientServiceMethodInfo('testMethod');
+
+      final json = methodInfo.toJson();
+      final deserialized = ClientServiceMethodInfo.fromJson(json);
+
+      expect(deserialized.name, 'testMethod');
+      expect(deserialized.capabilities, isNull);
+    });
+  });
+
+  test('ClientServiceMethodInfo throws with invalid json', () {
+    expect(
+      () => ClientServiceMethodInfo.fromJson({
+        'bad': 'format',
+      }),
+      throwsA(isA<ArgumentError>()),
+    );
+  });
 }

pkg/dtd/CHANGELOG.md

@@ -1,8 +1,15 @@
-## 2.6.0
+## 3.0.0
 
-- Add `ConnectedAppService` to store the connections to Dart and Flutter
+- Added `ConnectedAppService` to store the connections to Dart and Flutter
 applications that DTD is aware of.
 - Log exceptions from invalid `streamNotify` events.
+- Added `getRegisteredServices` API.
+- Added a new response type `RegisteredServicesResponse`.
+- **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
+`DartToolingDaemon.call` method is null, pass the null value along to the client
+peer request instead of sending an empty Map value.
 
 ## 2.5.1
 

pkg/dtd/example/dtd_service_example.dart

@@ -34,9 +34,13 @@ void main(List<String> args) async {
     clientB.onEvent('Service').listen((e) {
       switch (e.kind) {
         case 'ServiceRegistered':
-          serviceRegisteredCompleted.complete();
+          if (e.data['service'] == 'ExampleServer') {
+            serviceRegisteredCompleted.complete();
+          }
         case 'ServiceUnregistered':
-          serviceUnregisteredCompleted.complete();
+          if (e.data['service'] == 'ExampleServer') {
+            serviceUnregisteredCompleted.complete();
+          }
       }
       print(jsonEncode({'stream': e.stream, 'kind': e.kind, 'data': e.data}));
     });