Don’t pass the finished taskDescription to indexTaskDidFinish callback

This follows the general paradigm that callbacks shouldn’t carry much state and instead only notify an observer that state has changed, which the observer can then poll.

Author: ahoppen

Sources/SemanticIndex/SemanticIndexManager.swift

@@ -49,15 +49,15 @@ public final actor SemanticIndexManager {
   /// Callback that is called when an index task has finished.
   ///
   /// Currently only used for testing.
-  private let indexTaskDidFinish: (@Sendable (AnyIndexTaskDescription) -> Void)?
+  private let indexTaskDidFinish: (@Sendable () -> Void)?
 
   // MARK: - Public API
 
   public init(
     index: UncheckedIndex,
     buildSystemManager: BuildSystemManager,
     indexTaskScheduler: TaskScheduler<AnyIndexTaskDescription>,
-    indexTaskDidFinish: (@Sendable (AnyIndexTaskDescription) -> Void)?
+    indexTaskDidFinish: (@Sendable () -> Void)?
   ) {
     self.index = index.checked(for: .modifiedFiles)
     self.buildSystemManager = buildSystemManager
@@ -138,7 +138,7 @@ public final actor SemanticIndexManager {
       )
     )
     await self.indexTaskScheduler.schedule(priority: priority, taskDescription).value
-    self.indexTaskDidFinish?(taskDescription)
+    self.indexTaskDidFinish?()
   }
 
   /// Update the index store for the given files, assuming that their targets have already been prepared.
@@ -154,7 +154,7 @@ public final actor SemanticIndexManager {
     for file in files {
       self.indexStatus[file] = .upToDate
     }
-    self.indexTaskDidFinish?(taskDescription)
+    self.indexTaskDidFinish?()
   }
 
   /// Index the given set of files at the given priority.

Sources/SourceKitLSP/Workspace.swift

@@ -298,7 +298,7 @@ public struct IndexOptions {
   /// A callback that is called when an index task finishes.
   ///
   /// Intended for testing purposes.
-  public var indexTaskDidFinish: (@Sendable (AnyIndexTaskDescription) -> Void)?
+  public var indexTaskDidFinish: (@Sendable () -> Void)?
 
   public init(
     indexStorePath: AbsolutePath? = nil,
@@ -307,7 +307,7 @@ public struct IndexOptions {
     listenToUnitEvents: Bool = true,
     enableBackgroundIndexing: Bool = false,
     maxCoresPercentageToUseForBackgroundIndexing: Double = 1,
-    indexTaskDidFinish: (@Sendable (AnyIndexTaskDescription) -> Void)? = nil
+    indexTaskDidFinish: (@Sendable () -> Void)? = nil
   ) {
     self.indexStorePath = indexStorePath
     self.indexDatabasePath = indexDatabasePath

Tests/SourceKitLSPTests/BackgroundIndexingTests.swift

@@ -165,10 +165,10 @@ final class BackgroundIndexingTests: XCTestCase {
 
   func testBackgroundIndexingHappensWithLowPriority() async throws {
     var serverOptions = backgroundIndexingOptions
-    serverOptions.indexOptions.indexTaskDidFinish = { taskDescription in
+    serverOptions.indexOptions.indexTaskDidFinish = {
       XCTAssert(
         Task.currentPriority == .low,
-        "\(taskDescription.description) ran with priority \(Task.currentPriority)"
+        "An index task ran with priority \(Task.currentPriority)"
       )
     }
     let project = try await SwiftPMTestProject(