Merge pull request #1171 from ahoppen/ahoppen/6.0/update-from-main-04-08

[6.0] Merge changes from `main`

Author: ahoppen

Sources/Diagnose/SourceReducer.swift

@@ -196,7 +196,10 @@ fileprivate class SourceReducer {
 
   /// Replace the first `import` declaration in the source file by the contents of the Swift interface.
   private func inlineFirstImport(_ requestInfo: RequestInfo) async throws -> RequestInfo? {
-    let reductionResult = try await runReductionStep(requestInfo: requestInfo) { tree in
+    // Don't report progress after inlining an import because it might increase the file size before we have a chance
+    // to increase `fileSizeAfterLastImportInline`. Progress will get updated again on the next successful reduction
+    // step.
+    let reductionResult = try await runReductionStep(requestInfo: requestInfo, reportProgress: false) { tree in
       let edits = await Diagnose.inlineFirstImport(
         in: tree,
         executor: sourcekitdExecutor,
@@ -216,15 +219,22 @@ fileprivate class SourceReducer {
   // MARK: Primitives to run reduction steps
 
   private func logSuccessfulReduction(_ requestInfo: RequestInfo, tree: SourceFileSyntax) {
-    let numberOfImports = tree.numberOfImports
+    // The number of imports can grow if inlining a single module adds more than 1 new import.
+    // To keep progress between 0 and 1, clamp the number of imports to the initial import count.
+    let numberOfImports = min(tree.numberOfImports, initialImportCount)
     let fileSize = requestInfo.fileContents.utf8.count
 
     let progressPerRemovedImport = Double(1) / Double(initialImportCount + 1)
     let removeImportProgress = Double(initialImportCount - numberOfImports) * progressPerRemovedImport
     let fileReductionProgress =
       (1 - Double(fileSize) / Double(fileSizeAfterLastImportInline)) * progressPerRemovedImport
-    let progress = removeImportProgress + fileReductionProgress
-    precondition(progress >= 0 && progress <= 1)
+    var progress = removeImportProgress + fileReductionProgress
+    if progress < 0 || progress > 1 {
+      logger.fault(
+        "Trying to report progress \(progress) from remove import progress \(removeImportProgress) and file reduction progress \(fileReductionProgress)"
+      )
+      progress = max(min(progress, 1), 0)
+    }
     progressUpdate(progress, "Reduced to \(numberOfImports) imports and \(fileSize) bytes")
   }
 
@@ -234,6 +244,7 @@ fileprivate class SourceReducer {
   /// Otherwise, return `nil`
   private func runReductionStep(
     requestInfo: RequestInfo,
+    reportProgress: Bool = true,
     reduce: (_ tree: SourceFileSyntax) async throws -> ReducerResult
   ) async throws -> ReductionStepResult {
     let tree = Parser.parse(source: requestInfo.fileContents)
@@ -263,7 +274,9 @@ fileprivate class SourceReducer {
     let result = try await sourcekitdExecutor.run(request: reducedRequestInfo)
     if case .reproducesIssue = result {
       logger.debug("Reduction successful")
-      logSuccessfulReduction(reducedRequestInfo, tree: tree)
+      if reportProgress {
+        logSuccessfulReduction(reducedRequestInfo, tree: tree)
+      }
       return .reduced(reducedRequestInfo)
     } else {
       logger.debug("Reduction did not reproduce the issue")

Sources/LSPTestSupport/TestJSONRPCConnection.swift

@@ -197,7 +197,7 @@ public final class TestServer: MessageHandler {
 
 private let testMessageRegistry = MessageRegistry(
   requests: [EchoRequest.self, EchoError.self],
-  notifications: [EchoNotification.self]
+  notifications: [EchoNotification.self, ShowMessageNotification.self]
 )
 
 #if compiler(<5.11)

Sources/LanguageServerProtocol/Requests/IndexedRenameRequest.swift

@@ -72,7 +72,9 @@ extension IndexedRenameRequest: Codable {
     )
     self.oldName = try container.decode(String.self, forKey: IndexedRenameRequest.CodingKeys.oldName)
     self.newName = try container.decode(String.self, forKey: IndexedRenameRequest.CodingKeys.newName)
-    self.positions = try container.decode([String: [Position]].self, forKey: .positions).mapKeys(DocumentURI.init)
+    self.positions = try container.decode([String: [Position]].self, forKey: .positions).compactMapKeys {
+      try? DocumentURI(string: $0)
+    }
   }
 
   public func encode(to encoder: Encoder) throws {
@@ -81,13 +83,22 @@ extension IndexedRenameRequest: Codable {
     try container.encode(self.textDocument, forKey: IndexedRenameRequest.CodingKeys.textDocument)
     try container.encode(self.oldName, forKey: IndexedRenameRequest.CodingKeys.oldName)
     try container.encode(self.newName, forKey: IndexedRenameRequest.CodingKeys.newName)
-    try container.encode(self.positions.mapKeys(\.stringValue), forKey: IndexedRenameRequest.CodingKeys.positions)
+    try container.encode(
+      self.positions.compactMapKeys { $0.stringValue },
+      forKey: IndexedRenameRequest.CodingKeys.positions
+    )
 
   }
 }
 
 fileprivate extension Dictionary {
-  func mapKeys<NewKeyType: Hashable>(_ transform: (Key) -> NewKeyType) -> [NewKeyType: Value] {
-    return [NewKeyType: Value](uniqueKeysWithValues: self.map { (transform($0.key), $0.value) })
+  func compactMapKeys<NewKeyType: Hashable>(_ transform: (Key) -> NewKeyType?) -> [NewKeyType: Value] {
+    let newKeysAndValues = self.compactMap { (key, value) -> (NewKeyType, Value)? in
+      guard let newKey = transform(key) else {
+        return nil
+      }
+      return (newKey, value)
+    }
+    return [NewKeyType: Value](uniqueKeysWithValues: newKeysAndValues)
   }
 }

Sources/LanguageServerProtocol/SupportTypes/DocumentURI.swift

@@ -12,6 +12,14 @@
 
 import Foundation
 
+struct FailedToConstructDocumentURIFromStringError: Error, CustomStringConvertible {
+  let string: String
+
+  var description: String {
+    return "Failed to construct DocumentURI from '\(string)'"
+  }
+}
+
 public struct DocumentURI: Codable, Hashable, Sendable {
   /// The URL that store the URIs value
   private let storage: URL
@@ -55,9 +63,9 @@ public struct DocumentURI: Codable, Hashable, Sendable {
 
   /// Construct a DocumentURI from the given URI string, automatically parsing
   ///  it either as a URL or an opaque URI.
-  public init(string: String) {
+  public init(string: String) throws {
     guard let url = URL(string: string) else {
-      fatalError("Failed to construct DocumentURI from '\(string)'")
+      throw FailedToConstructDocumentURIFromStringError(string: string)
     }
     self.init(url)
   }
@@ -68,7 +76,7 @@ public struct DocumentURI: Codable, Hashable, Sendable {
   }
 
   public init(from decoder: Decoder) throws {
-    self.init(string: try decoder.singleValueContainer().decode(String.self))
+    try self.init(string: decoder.singleValueContainer().decode(String.self))
   }
 
   /// Equality check to handle escape sequences in file URLs.

Sources/LanguageServerProtocol/SupportTypes/TextDocumentIdentifier.swift

@@ -26,7 +26,10 @@ extension TextDocumentIdentifier: LSPAnyCodable {
     guard case .string(let uriString)? = dictionary[CodingKeys.uri.stringValue] else {
       return nil
     }
-    self.uri = DocumentURI(string: uriString)
+    guard let uri = try? DocumentURI(string: uriString) else {
+      return nil
+    }
+    self.uri = uri
   }
 
   public func encodeToLSPAny() -> LSPAny {

Sources/LanguageServerProtocol/SupportTypes/WorkspaceEdit.swift

@@ -49,7 +49,7 @@ extension WorkspaceEdit: Codable {
     if let changesDict = try container.decodeIfPresent([String: [TextEdit]].self, forKey: .changes) {
       var changes = [DocumentURI: [TextEdit]]()
       for change in changesDict {
-        let uri = DocumentURI(string: change.key)
+        let uri = try DocumentURI(string: change.key)
         changes[uri] = change.value
       }
       self.changes = changes
@@ -311,8 +311,10 @@ extension WorkspaceEdit: LSPAnyCodable {
     }
     var dictionary = [DocumentURI: [TextEdit]]()
     for (key, value) in lspDict {
-      let uri = DocumentURI(string: key)
-      guard let edits = [TextEdit](fromLSPArray: value) else {
+      guard
+        let uri = try? DocumentURI(string: key),
+        let edits = [TextEdit](fromLSPArray: value)
+      else {
         return nil
       }
       dictionary[uri] = edits