Reset cache for reportTasks if needed

Author: joehsieh

Sources/SourceKitLSP/Swift/DiagnosticReportManager.swift

@@ -58,10 +58,9 @@ actor DiagnosticReportManager {
 
   func diagnosticReport(
     for snapshot: DocumentSnapshot,
-    buildSettings: SwiftCompileCommand?,
-    useCache: Bool = false
+    buildSettings: SwiftCompileCommand?
   ) async throws -> RelatedFullDocumentDiagnosticReport {
-    if useCache, let report = try await reportTask(for: snapshot.id, buildSettings: buildSettings)?.value {
+    if let report = try await reportTask(for: snapshot.id, buildSettings: buildSettings)?.value {
       return report
     }
     let reportTask: Task<RelatedFullDocumentDiagnosticReport, Error>
@@ -85,6 +84,13 @@ actor DiagnosticReportManager {
     return try await reportTask.value
   }
 
+  func resetCache() async {
+    for item in reportTaskCache {
+      item.reportTask.cancel()
+    }
+    reportTaskCache.removeAll()
+  }
+
   private func requestReport(
     with snapshot: DocumentSnapshot,
     compilerArgs: [String]

Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift

@@ -277,6 +277,7 @@ extension SwiftLanguageServer {
 
   private func reopenDocument(_ snapshot: DocumentSnapshot, _ compileCmd: SwiftCompileCommand?) async {
     cancelInFlightPublishDiagnosticsTask(for: snapshot.uri)
+    await diagnosticReportManager.resetCache()
 
     let keys = self.keys
     let path = snapshot.uri.pseudoPath
@@ -324,6 +325,7 @@ extension SwiftLanguageServer {
 
   public func openDocument(_ note: DidOpenTextDocumentNotification) async {
     cancelInFlightPublishDiagnosticsTask(for: note.textDocument.uri)
+    await diagnosticReportManager.resetCache()
 
     let keys = self.keys
 
@@ -351,6 +353,7 @@ extension SwiftLanguageServer {
   public func closeDocument(_ note: DidCloseTextDocumentNotification) async {
     cancelInFlightPublishDiagnosticsTask(for: note.textDocument.uri)
     inFlightPublishDiagnosticsTasks[note.textDocument.uri] = nil
+    await diagnosticReportManager.resetCache()
 
     let keys = self.keys
 
@@ -982,8 +985,7 @@ extension SwiftLanguageServer {
     let buildSettings = await self.buildSettings(for: params.textDocument.uri)
     let diagnosticReport = try await self.diagnosticReportManager.diagnosticReport(
       for: snapshot,
-      buildSettings: buildSettings,
-      useCache: true
+      buildSettings: buildSettings
     )
 
     let codeActions = diagnosticReport.items.flatMap { (diag) -> [CodeAction] in

Tests/SourceKitLSPTests/LocalSwiftTests.swift

@@ -86,7 +86,7 @@ final class LocalSwiftTests: XCTestCase {
 
     testClient.send(
       DidChangeTextDocumentNotification(
-        textDocument: .init(uri, version: 14),
+        textDocument: .init(uri, version: 15),
         contentChanges: [
           .init(range: Position(line: 1, utf16index: 0)..<Position(line: 1, utf16index: 3), text: "foo")
         ]
@@ -105,7 +105,7 @@ final class LocalSwiftTests: XCTestCase {
 
     testClient.send(
       DidChangeTextDocumentNotification(
-        textDocument: .init(uri, version: 15),
+        textDocument: .init(uri, version: 16),
         contentChanges: [
           .init(range: Position(line: 1, utf16index: 0)..<Position(line: 1, utf16index: 3), text: "fooTypo")
         ]
@@ -128,7 +128,7 @@ final class LocalSwiftTests: XCTestCase {
 
     testClient.send(
       DidChangeTextDocumentNotification(
-        textDocument: .init(uri, version: 16),
+        textDocument: .init(uri, version: 17),
         contentChanges: [
           .init(
             range: nil,
@@ -210,7 +210,7 @@ final class LocalSwiftTests: XCTestCase {
 
     testClient.send(
       DidChangeTextDocumentNotification(
-        textDocument: .init(uri, version: 14),
+        textDocument: .init(uri, version: 15),
         contentChanges: [
           .init(range: Position(line: 1, utf16index: 0)..<Position(line: 1, utf16index: 3), text: "foo")
         ]
@@ -229,7 +229,7 @@ final class LocalSwiftTests: XCTestCase {
 
     testClient.send(
       DidChangeTextDocumentNotification(
-        textDocument: .init(uri, version: 15),
+        textDocument: .init(uri, version: 16),
         contentChanges: [
           .init(range: Position(line: 1, utf16index: 0)..<Position(line: 1, utf16index: 3), text: "fooTypo")
         ]
@@ -251,7 +251,7 @@ final class LocalSwiftTests: XCTestCase {
 
     testClient.send(
       DidChangeTextDocumentNotification(
-        textDocument: .init(uri, version: 16),
+        textDocument: .init(uri, version: 17),
         contentChanges: [
           .init(
             range: nil,