Merge pull request #1645 from ahoppen/extended-logging

Log full options with which SourceKit-LSP is initialized

Author: ahoppen

Sources/LanguageServerProtocolJSONRPC/LoggableMessageTypes.swift

@@ -14,37 +14,27 @@ import Foundation
 import LanguageServerProtocol
 import SKLogging
 
-fileprivate extension Encodable {
-  var prettyPrintJSON: String {
-    let encoder = JSONEncoder()
-    encoder.outputFormatting.insert(.prettyPrinted)
-    encoder.outputFormatting.insert(.sortedKeys)
-    guard let data = try? encoder.encode(self) else {
-      return "\(self)"
-    }
-    guard let string = String(data: data, encoding: .utf8) else {
-      return "\(self)"
-    }
-    // Don't escape '/'. Most JSON readers don't need it escaped and it makes
-    // paths a lot easier to read and copy-paste.
-    return string.replacingOccurrences(of: "\\/", with: "/")
-  }
-}
-
 // 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.prettyPrintJSON)
+      \(request.prettyPrintedJSON)
       """
   }
 
-  public var redactedDescription: String {
-    return "\(type(of: request).method)"
+  package var redactedDescription: String {
+    return """
+      \(type(of: request).method)
+      \(request.prettyPrintedRedactedJSON)
+      """
   }
 }
 
@@ -56,18 +46,25 @@ 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.prettyPrintJSON)
+      \(notification.prettyPrintedJSON)
       """
   }
 
-  public var redactedDescription: String {
-    return "\(type(of: notification).method)"
+  package var redactedDescription: String {
+    return """
+      \(type(of: notification).method)
+      \(notification.prettyPrintedRedactedJSON)
+      """
   }
 }
 
@@ -79,19 +76,24 @@ 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.prettyPrintJSON)
+      \(response.prettyPrintedJSON)
       """
   }
 
-  var redactedDescription: String {
+  package var redactedDescription: String {
     return """
       \(type(of: response))
+      \(response.prettyPrintedRedactedJSON)
       """
   }
 }

Sources/SKLogging/CustomLogStringConvertible.swift

@@ -64,7 +64,8 @@ extension String {
   /// A hash value that can be logged in a redacted description without
   /// disclosing any private information about the string.
   package var hashForLogging: String {
-    return Insecure.MD5.hash(data: Data(self.utf8)).description
+    let hash = SHA256.hash(data: Data(self.utf8)).prefix(8).map { String(format: "%02x", $0) }.joined()
+    return "<private \(hash)>"
   }
 }
 
@@ -86,58 +87,51 @@ extension Optional where Wrapped: CustomLogStringConvertible {
   }
 }
 
-/// A JSON-like description of the object.
-public func recursiveDescription(of subject: Any) -> String {
-  return "{"
-    + Mirror(reflecting: subject).children.map { (key, value) in
-      "\(key ?? "<nil>"): \(String(describing: value))"
-    }.joined(separator: ", ")
-    + "}"
-}
-
-fileprivate protocol OptionalProtocol {
-  associatedtype Wrapped
-  var asOptional: Wrapped? { get }
-}
-extension Optional: OptionalProtocol {
-  var asOptional: Wrapped? { self }
-}
-
-/// A JSON-like description of the object that shows trivial values but redacts values that might contain sensitive
-/// information.
-public func recursiveRedactedDescription(of value: Any) -> String {
-  switch value {
-  case let value as Bool:
-    return value.description
-  case let value as Int:
-    return value.description
-  case let value as Double:
-    return value.description
-  case let value as String:
-    return value.hashForLogging
-  case let value as any OptionalProtocol:
-    if let value = value.asOptional {
-      return recursiveRedactedDescription(of: value)
-    } else {
-      return "nil"
+extension Encodable {
+  package var prettyPrintedJSON: String {
+    let encoder = JSONEncoder()
+    encoder.outputFormatting.insert(.prettyPrinted)
+    encoder.outputFormatting.insert(.sortedKeys)
+    guard let data = try? encoder.encode(self) else {
+      return "\(self)"
+    }
+    guard let string = String(data: data, encoding: .utf8) else {
+      return "\(self)"
     }
-  default:
-    break
+    // Don't escape '/'. Most JSON readers don't need it escaped and it makes
+    // paths a lot easier to read and copy-paste.
+    return string.replacingOccurrences(of: "\\/", with: "/")
   }
 
-  let children = Mirror(reflecting: value).children.sorted { $0.label ?? "" < $1.label ?? "" }
-  if !children.isEmpty {
-    let childrenKeyValuePairs = children.map { (label, value) -> String in
-      let label = label ?? "<nil>"
-      let value =
-        if let value = value as? any CustomLogStringConvertible {
-          value.redactedDescription
-        } else {
-          recursiveRedactedDescription(of: value)
-        }
-      return "\(label): \(value)"
+  package var prettyPrintedRedactedJSON: String {
+    func redact(subject: Any) -> Any {
+      if let subject = subject as? [String: Any] {
+        return subject.mapValues { redact(subject: $0) }
+      } else if let subject = subject as? [Any] {
+        return subject.map { redact(subject: $0) }
+      } else if let subject = subject as? String {
+        return subject.hashForLogging
+      } else if let subject = subject as? Int {
+        return subject
+      } else if let subject = subject as? Double {
+        return subject
+      } else if let subject = subject as? Bool {
+        return subject
+      } else {
+        return "<private>"
+      }
+    }
+
+    guard let encoded = try? JSONEncoder().encode(self),
+      let jsonObject = try? JSONSerialization.jsonObject(with: encoded),
+      let data = try? JSONSerialization.data(
+        withJSONObject: redact(subject: jsonObject),
+        options: [.prettyPrinted, .sortedKeys]
+      ),
+      let string = String(data: data, encoding: .utf8)
+    else {
+      return "<private>"
     }
-    return "{" + childrenKeyValuePairs.joined(separator: ", ") + "}"
+    return string
   }
-  return "<private>"
 }

Sources/SKLogging/SplitLogMessage.swift

@@ -17,7 +17,8 @@
 ///
 ///  - Note: This will only split along newline boundary. If a single line is longer than `maxChunkSize`, it won't be
 ///    split. This is fine for compiler argument splitting since a single argument is rarely longer than 800 characters.
-package func splitLongMultilineMessage(message: String, maxChunkSize: Int = 800) -> [String] {
+package func splitLongMultilineMessage(message: String) -> [String] {
+  let maxChunkSize = 800
   var chunks: [String] = []
   for line in message.split(separator: "\n", omittingEmptySubsequences: false) {
     if let lastChunk = chunks.last, lastChunk.utf8.count + line.utf8.count < maxChunkSize {
@@ -34,3 +35,34 @@ package func splitLongMultilineMessage(message: String, maxChunkSize: Int = 800)
   }
   return chunks
 }
+
+extension Logger {
+  /// Implementation detail of `logFullObjectInMultipleLogMessages`
+  private struct LoggableChunk: CustomLogStringConvertible {
+    var description: String
+    var redactedDescription: String
+  }
+
+  package func logFullObjectInMultipleLogMessages(
+    level: LogLevel = .default,
+    header: StaticString,
+    _ subject: some CustomLogStringConvertible
+  ) {
+    let chunks = splitLongMultilineMessage(message: subject.description)
+    let redactedChunks = splitLongMultilineMessage(message: subject.redactedDescription)
+    let maxChunkCount = max(chunks.count, redactedChunks.count)
+    for i in 0..<maxChunkCount {
+      let loggableChunk = LoggableChunk(
+        description: i < chunks.count ? chunks[i] : "",
+        redactedDescription: i < redactedChunks.count ? redactedChunks[i] : ""
+      )
+      self.log(
+        level: level,
+        """
+        \(header, privacy: .public) (\(i + 1)/\(maxChunkCount))
+        \(loggableChunk.forLogging)
+        """
+      )
+    }
+  }
+}

Sources/SKOptions/SourceKitLSPOptions.swift

@@ -21,7 +21,7 @@ import struct TSCBasic.AbsolutePath
 ///
 /// See `ConfigurationFile.md` for a description of the configuration file's behavior.
 public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogStringConvertible {
-  public struct SwiftPMOptions: Sendable, Codable, Equatable, CustomLogStringConvertible {
+  public struct SwiftPMOptions: Sendable, Codable, Equatable {
     /// Build configuration (debug|release).
     ///
     /// Equivalent to SwiftPM's `--configuration` option.
@@ -94,17 +94,9 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogString
         disableSandbox: override?.disableSandbox ?? base.disableSandbox
       )
     }
-
-    public var description: String {
-      recursiveDescription(of: self)
-    }
-
-    public var redactedDescription: String {
-      recursiveRedactedDescription(of: self)
-    }
   }
 
-  public struct CompilationDatabaseOptions: Sendable, Codable, Equatable, CustomLogStringConvertible {
+  public struct CompilationDatabaseOptions: Sendable, Codable, Equatable {
     /// Additional paths to search for a compilation database, relative to a workspace root.
     public var searchPaths: [String]?
 
@@ -118,17 +110,9 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogString
     ) -> CompilationDatabaseOptions {
       return CompilationDatabaseOptions(searchPaths: override?.searchPaths ?? base.searchPaths)
     }
-
-    public var description: String {
-      recursiveDescription(of: self)
-    }
-
-    public var redactedDescription: String {
-      recursiveRedactedDescription(of: self)
-    }
   }
 
-  public struct FallbackBuildSystemOptions: Sendable, Codable, Equatable, CustomLogStringConvertible {
+  public struct FallbackBuildSystemOptions: Sendable, Codable, Equatable {
     public var cCompilerFlags: [String]?
     public var cxxCompilerFlags: [String]?
     public var swiftCompilerFlags: [String]?
@@ -157,17 +141,9 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogString
         sdk: override?.sdk ?? base.sdk
       )
     }
-
-    public var description: String {
-      recursiveDescription(of: self)
-    }
-
-    public var redactedDescription: String {
-      recursiveRedactedDescription(of: self)
-    }
   }
 
-  public struct IndexOptions: Sendable, Codable, Equatable, CustomLogStringConvertible {
+  public struct IndexOptions: Sendable, Codable, Equatable {
     public var indexStorePath: String?
     public var indexDatabasePath: String?
     public var indexPrefixMap: [String: String]?
@@ -210,17 +186,9 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogString
         updateIndexStoreTimeout: override?.updateIndexStoreTimeout ?? base.updateIndexStoreTimeout
       )
     }
-
-    public var description: String {
-      recursiveDescription(of: self)
-    }
-
-    public var redactedDescription: String {
-      recursiveRedactedDescription(of: self)
-    }
   }
 
-  public struct LoggingOptions: Sendable, Codable, Equatable, CustomLogStringConvertible {
+  public struct LoggingOptions: Sendable, Codable, Equatable {
     /// The level from which one onwards log messages should be written.
     public var level: String?
     /// Whether potentially sensitive information should be redacted.
@@ -240,14 +208,6 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogString
         privacyLevel: override?.privacyLevel ?? base.privacyLevel
       )
     }
-
-    public var description: String {
-      recursiveDescription(of: self)
-    }
-
-    public var redactedDescription: String {
-      recursiveRedactedDescription(of: self)
-    }
   }
 
   public enum BackgroundPreparationMode: String {
@@ -477,10 +437,10 @@ public struct SourceKitLSPOptions: Sendable, Codable, Equatable, CustomLogString
   }
 
   public var description: String {
-    recursiveDescription(of: self)
+    self.prettyPrintedJSON
   }
 
   public var redactedDescription: String {
-    recursiveRedactedDescription(of: self)
+    self.prettyPrintedRedactedJSON
   }
 }