[analysis_server] Make it easier to print protocol messages when running LSP-over-Legacy tests

This moves the existing `debugPrintCommunication` flag out of `test/lsp` into `test/` and passes it to the `MockServerChannel` to simplify printing protocol messages for LSP-over-Legacy tests (similar to what MockLspServerChannel already does).

Change-Id: Ic5fa6309e8de01ce0c624584ad6eb653ced90698
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/406021
Commit-Queue: Samuel Rawlins <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>

Author: DanTup

pkg/analysis_server/lib/src/utilities/mocks.dart

@@ -56,7 +56,11 @@ class MockServerChannel implements ServerCommunicationChannel {
 
   String? name;
 
-  MockServerChannel();
+  /// True if we are printing out messages exchanged with the server.
+  final bool printMessages;
+
+  MockServerChannel({bool? printMessages})
+    : printMessages = printMessages ?? false;
 
   /// Return the broadcast stream of notifications.
   Stream<Notification> get notifications {
@@ -99,12 +103,14 @@ class MockServerChannel implements ServerCommunicationChannel {
 
   @override
   void sendRequest(Request request) {
+    var jsonString = jsonEncode(request.toJson());
+    if (printMessages) {
+      print('<== $jsonString');
+    }
+
     // Round-trip via JSON to ensure all types are fully serialized as they
     // would be in a real setup.
-    request =
-        Request.fromJson(
-          jsonDecode(jsonEncode(request.toJson())) as Map<String, Object?>,
-        )!;
+    request = Request.fromJson(jsonDecode(jsonString) as Map<String, Object?>)!;
 
     serverRequestsSent.add(request);
     responseController.add(request);
@@ -117,12 +123,15 @@ class MockServerChannel implements ServerCommunicationChannel {
       return;
     }
 
+    var jsonString = jsonEncode(response.toJson());
+    if (printMessages) {
+      print('<== $jsonString');
+    }
+
     // Round-trip via JSON to ensure all types are fully serialized as they
     // would be in a real setup.
     response =
-        Response.fromJson(
-          jsonDecode(jsonEncode(response.toJson())) as Map<String, Object?>,
-        )!;
+        Response.fromJson(jsonDecode(jsonString) as Map<String, Object?>)!;
 
     responsesReceived.add(response);
     responseController.add(response);
@@ -138,12 +147,14 @@ class MockServerChannel implements ServerCommunicationChannel {
       throw Exception('simulateRequestFromClient after connection closed');
     }
 
+    var jsonString = jsonEncode(request.toJson());
+    if (printMessages) {
+      print('==> $jsonString');
+    }
+
     // Round-trip via JSON to ensure all types are fully serialized as they
     // would be in a real setup.
-    request =
-        Request.fromJson(
-          jsonDecode(jsonEncode(request)) as Map<String, Object?>,
-        )!;
+    request = Request.fromJson(jsonDecode(jsonString) as Map<String, Object?>)!;
 
     requestController.add(request);
     var response = await waitForResponse(request);
@@ -166,12 +177,15 @@ class MockServerChannel implements ServerCommunicationChannel {
       throw Exception('simulateRequestFromClient after connection closed');
     }
 
+    var jsonString = jsonEncode(response.toJson());
+    if (printMessages) {
+      print('==> $jsonString');
+    }
+
     // Round-trip via JSON to ensure all types are fully serialized as they
     // would be in a real setup.
     response =
-        Response.fromJson(
-          jsonDecode(jsonEncode(response)) as Map<String, Object?>,
-        )!;
+        Response.fromJson(jsonDecode(jsonString) as Map<String, Object?>)!;
 
     requestController.add(response);
   }

pkg/analysis_server/test/analysis_server_base.dart

@@ -24,6 +24,7 @@ import 'package:meta/meta.dart';
 import 'package:test/test.dart';
 import 'package:unified_analytics/unified_analytics.dart';
 
+import 'constants.dart';
 import 'mocks.dart';
 import 'support/configuration_files.dart';
 import 'test_macros.dart';
@@ -189,7 +190,7 @@ abstract class ContextResolutionTest with ResourceProviderMixin {
 
   @mustCallSuper
   void setUp() {
-    serverChannel = MockServerChannel();
+    serverChannel = MockServerChannel(printMessages: debugPrintCommunication);
 
     createMockSdk(resourceProvider: resourceProvider, root: sdkRoot);
 

pkg/analysis_server/test/analysis_server_test.dart

@@ -21,6 +21,8 @@ import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 import 'package:unified_analytics/unified_analytics.dart';
 
+import 'constants.dart';
+
 void main() {
   defineReflectiveSuite(() {
     defineReflectiveTests(AnalysisServerTest);
@@ -41,7 +43,7 @@ class AnalysisServerTest with ResourceProviderMixin {
   late LegacyAnalysisServer server;
 
   void setUp() {
-    channel = MockServerChannel();
+    channel = MockServerChannel(printMessages: debugPrintCommunication);
 
     // Create an SDK in the mock file system.
     var sdkRoot = newFolder('/sdk');

pkg/analysis_server/test/constants.dart

@@ -6,6 +6,11 @@ const String CODE = 'code';
 const String COMPLETION_RESULTS = 'completion.results';
 const String CONTEXT_MESSAGES = 'contextMessages';
 const String CORRECTION = 'correction';
+
+/// Useful for debugging locally, setting this to true will cause all JSON
+/// communication to be printed to stdout.
+const debugPrintCommunication = false;
+
 const String EDITS = 'edits';
 const String END_COLUMN = 'endColumn';
 const String END_LINE = 'endLine';

pkg/analysis_server/test/integration/support/web_sockets.dart

@@ -7,7 +7,7 @@ import 'dart:async';
 import 'package:stream_channel/stream_channel.dart';
 import 'package:web_socket_channel/web_socket_channel.dart';
 
-import '../../lsp/server_abstract.dart';
+import '../../constants.dart';
 
 /// Creates a [StreamChannel] for a connection to a WebSocket at [wsUri] that
 /// prints all communication if [debugPrintCommunication] is `true`.

pkg/analysis_server/test/lsp/server_abstract.dart

@@ -31,6 +31,7 @@ import 'package:path/path.dart' as path;
 import 'package:test/test.dart' hide expect;
 import 'package:unified_analytics/unified_analytics.dart';
 
+import '../constants.dart';
 import '../mocks.dart';
 import '../mocks_lsp.dart';
 import '../shared/shared_test_interface.dart';
@@ -41,10 +42,6 @@ import 'request_helpers_mixin.dart';
 
 const dartLanguageId = 'dart';
 
-/// Useful for debugging locally, setting this to true will cause all JSON
-/// communication to be printed to stdout.
-const debugPrintCommunication = false;
-
 abstract class AbstractLspAnalysisServerTest
     with
         ResourceProviderMixin,