Call indexTaskDidFinish from SemanticIndexManager

This fixes a bug where `indexTaskDidFinish` would also get called when a task is cancelled to be rescheduled.

Author: ahoppen

Sources/SemanticIndex/PreparationTaskDescription.swift

@@ -35,11 +35,6 @@ public struct PreparationTaskDescription: IndexTaskDescription {
   /// The build system manager that is used to get the toolchain and build settings for the files to index.
   private let buildSystemManager: BuildSystemManager
 
-  /// A callback that is called when the task finishes.
-  ///
-  /// Intended for testing purposes.
-  private let didFinishCallback: @Sendable (PreparationTaskDescription) -> Void
-
   /// The task is idempotent because preparing the same target twice produces the same result as preparing it once.
   public var isIdempotent: Bool { true }
 
@@ -55,18 +50,13 @@ public struct PreparationTaskDescription: IndexTaskDescription {
 
   init(
     targetsToPrepare: [ConfiguredTarget],
-    buildSystemManager: BuildSystemManager,
-    didFinishCallback: @escaping @Sendable (PreparationTaskDescription) -> Void
+    buildSystemManager: BuildSystemManager
   ) {
     self.targetsToPrepare = targetsToPrepare
     self.buildSystemManager = buildSystemManager
-    self.didFinishCallback = didFinishCallback
   }
 
   public func execute() async {
-    defer {
-      didFinishCallback(self)
-    }
     // Only use the last two digits of the preparation ID for the logging scope to avoid creating too many scopes.
     // See comment in `withLoggingScope`.
     // The last 2 digits should be sufficient to differentiate between multiple concurrently running preparation operations

Sources/SemanticIndex/SemanticIndexManager.swift

@@ -131,38 +131,30 @@ public final actor SemanticIndexManager {
 
   /// Prepare the given targets for indexing
   private func prepare(targets: [ConfiguredTarget], priority: TaskPriority?) async {
-    await self.indexTaskScheduler.schedule(
-      priority: priority,
-      AnyIndexTaskDescription(
-        PreparationTaskDescription(
-          targetsToPrepare: targets,
-          buildSystemManager: self.buildSystemManager,
-          didFinishCallback: { [weak self] taskDescription in
-            self?.indexTaskDidFinish?(AnyIndexTaskDescription(taskDescription))
-          }
-        )
+    let taskDescription = AnyIndexTaskDescription(
+      PreparationTaskDescription(
+        targetsToPrepare: targets,
+        buildSystemManager: self.buildSystemManager
       )
-    ).value
+    )
+    await self.indexTaskScheduler.schedule(priority: priority, taskDescription).value
+    self.indexTaskDidFinish?(taskDescription)
   }
 
   /// Update the index store for the given files, assuming that their targets have already been prepared.
   private func updateIndexStore(for files: [DocumentURI], priority: TaskPriority?) async {
-    await self.indexTaskScheduler.schedule(
-      priority: priority,
-      AnyIndexTaskDescription(
-        UpdateIndexStoreTaskDescription(
-          filesToIndex: Set(files),
-          buildSystemManager: self.buildSystemManager,
-          index: self.index,
-          didFinishCallback: { [weak self] taskDescription in
-            self?.indexTaskDidFinish?(AnyIndexTaskDescription(taskDescription))
-          }
-        )
+    let taskDescription = AnyIndexTaskDescription(
+      UpdateIndexStoreTaskDescription(
+        filesToIndex: Set(files),
+        buildSystemManager: self.buildSystemManager,
+        index: self.index
       )
-    ).value
+    )
+    await self.indexTaskScheduler.schedule(priority: priority, taskDescription).value
     for file in files {
       self.indexStatus[file] = .upToDate
     }
+    self.indexTaskDidFinish?(taskDescription)
   }
 
   /// Index the given set of files at the given priority.

Sources/SemanticIndex/UpdateIndexStoreTaskDescription.swift

@@ -39,9 +39,6 @@ public struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
   /// case we don't need to index it again.
   private let index: CheckedIndex
 
-  /// A callback that is called when the index task finishes
-  private let didFinishCallback: @Sendable (UpdateIndexStoreTaskDescription) -> Void
-
   /// The task is idempotent because indexing the same file twice produces the same result as indexing it once.
   public var isIdempotent: Bool { true }
 
@@ -58,19 +55,14 @@ public struct UpdateIndexStoreTaskDescription: IndexTaskDescription {
   init(
     filesToIndex: Set<DocumentURI>,
     buildSystemManager: BuildSystemManager,
-    index: CheckedIndex,
-    didFinishCallback: @escaping @Sendable (UpdateIndexStoreTaskDescription) -> Void
+    index: CheckedIndex
   ) {
     self.filesToIndex = filesToIndex
     self.buildSystemManager = buildSystemManager
     self.index = index
-    self.didFinishCallback = didFinishCallback
   }
 
   public func execute() async {
-    defer {
-      didFinishCallback(self)
-    }
     // Only use the last two digits of the indexing ID for the logging scope to avoid creating too many scopes.
     // See comment in `withLoggingScope`.
     // The last 2 digits should be sufficient to differentiate between multiple concurrently running indexing operation.