Log full initialize request and response

The initialize request and response are often critical to debug issues with editor setups. Log them completely over multiple log messages, instead of truncating them in the normal logging path.

Author: ahoppen

Sources/LanguageServerProtocolJSONRPC/LoggableMessageTypes.swift

@@ -16,17 +16,21 @@ import SKLogging
 
 // MARK: - RequestType
 
-fileprivate struct AnyRequestType: CustomLogStringConvertible {
+package struct AnyRequestType: CustomLogStringConvertible {
   let request: any RequestType
 
-  public var description: String {
+  package init(request: any RequestType) {
+    self.request = request
+  }
+
+  package var description: String {
     return """
       \(type(of: request).method)
       \(request.prettyPrintedJSON)
       """
   }
 
-  public var redactedDescription: String {
+  package var redactedDescription: String {
     return """
       \(type(of: request).method)
       \(request.prettyPrintedRedactedJSON)
@@ -42,17 +46,21 @@ extension RequestType {
 
 // MARK: - NotificationType
 
-fileprivate struct AnyNotificationType: CustomLogStringConvertible {
+package struct AnyNotificationType: CustomLogStringConvertible {
   let notification: any NotificationType
 
-  public var description: String {
+  package init(notification: any NotificationType) {
+    self.notification = notification
+  }
+
+  package var description: String {
     return """
       \(type(of: notification).method)
       \(notification.prettyPrintedJSON)
       """
   }
 
-  public var redactedDescription: String {
+  package var redactedDescription: String {
     return """
       \(type(of: notification).method)
       \(notification.prettyPrintedRedactedJSON)
@@ -68,17 +76,21 @@ extension NotificationType {
 
 // MARK: - ResponseType
 
-fileprivate struct AnyResponseType: CustomLogStringConvertible {
+package struct AnyResponseType: CustomLogStringConvertible {
   let response: any ResponseType
 
-  var description: String {
+  package init(response: any ResponseType) {
+    self.response = response
+  }
+
+  package var description: String {
     return """
       \(type(of: response))
       \(response.prettyPrintedJSON)
       """
   }
 
-  var redactedDescription: String {
+  package var redactedDescription: String {
     return """
       \(type(of: response))
       \(response.prettyPrintedRedactedJSON)

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -16,6 +16,7 @@ import Dispatch
 import Foundation
 import IndexStoreDB
 import LanguageServerProtocol
+import LanguageServerProtocolJSONRPC
 import PackageLoading
 import SKLogging
 import SKOptions
@@ -873,6 +874,7 @@ extension SourceKitLSPServer {
   }
 
   func initialize(_ req: InitializeRequest) async throws -> InitializeResult {
+    logger.logFullObjectInMultipleLogMessages(header: "Initialize request", AnyRequestType(request: req))
     // If the client can handle `PeekDocumentsRequest`, they can enable the
     // experimental client capability `"workspace/peekDocuments"` through the `req.capabilities.experimental`.
     //
@@ -983,12 +985,14 @@ extension SourceKitLSPServer {
 
     assert(!self.workspaces.isEmpty)
 
-    return InitializeResult(
+    let result = InitializeResult(
       capabilities: await self.serverCapabilities(
         for: req.capabilities,
         registry: self.capabilityRegistry!
       )
     )
+    logger.logFullObjectInMultipleLogMessages(header: "Initialize response", AnyRequestType(request: req))
+    return result
   }
 
   func serverCapabilities(

Tests/SKLoggingTests/PrettyPrintedRedactedJSONTests.swift

@@ -100,4 +100,22 @@ class PrettyPrintedRedactedJSONTests: XCTestCase {
       """
     )
   }
+
+  func testArrayOfStrings() {
+    struct Struct: Codable {
+      var value: [String]
+    }
+
+    XCTAssertEqual(
+      Struct(value: ["password", "admin"]).prettyPrintedRedactedJSON,
+      """
+      {
+        "value" : [
+          "<private 5e884898da280471>",
+          "<private 8c6976e5b5410415>"
+        ]
+      }
+      """
+    )
+  }
 }