Debounced the Reloading Package work done progress

Author: ahoppen

Sources/SourceKitLSP/CMakeLists.txt

@@ -19,7 +19,6 @@ add_library(SourceKitLSP STATIC
   TestDiscovery.swift
   TextEdit+IsNoop.swift
   WorkDoneProgressManager.swift
-  WorkDoneProgressState.swift
   Workspace.swift
 )
 target_sources(SourceKitLSP PRIVATE

Sources/SourceKitLSP/IndexProgressManager.swift

@@ -127,7 +127,7 @@ actor IndexProgressManager {
     } else {
       workDoneProgress = await WorkDoneProgressManager(
         server: sourceKitLSPServer,
-        initialDebounce: sourceKitLSPServer.options.indexProgressDebounceDuration,
+        initialDebounce: sourceKitLSPServer.options.workDoneProgressDebounceDuration,
         title: "Indexing",
         message: message,
         percentage: percentage

Sources/SourceKitLSP/SourceKitLSPServer+Options.swift

@@ -48,9 +48,10 @@ extension SourceKitLSPServer {
     /// notification when running unit tests.
     public var swiftPublishDiagnosticsDebounceDuration: TimeInterval
 
-    /// When an index task is started, how many milliseconds to wait before sending a work done progress to the client.
-    // This prevents flickering of the work done progress in the client for short-lived index tasks
-    public var indexProgressDebounceDuration: Duration
+    /// When a task is started that should be displayed to the client as a work done progress, how many milliseconds to
+    /// wait before actually starting the work done progress. This prevents flickering of the work done progress in the
+    /// client for short-lived index tasks which end within this duration.
+    public var workDoneProgressDebounceDuration: Duration
 
     /// Experimental features that are enabled.
     public var experimentalFeatures: Set<ExperimentalFeature>
@@ -65,7 +66,7 @@ extension SourceKitLSPServer {
       completionOptions: SKCompletionOptions = .init(),
       generatedInterfacesPath: AbsolutePath = defaultDirectoryForGeneratedInterfaces,
       swiftPublishDiagnosticsDebounceDuration: TimeInterval = 2, /* 2s */
-      indexProgressDebounceDuration: Duration = .seconds(0),
+      workDoneProgressDebounceDuration: Duration = .seconds(0),
       experimentalFeatures: Set<ExperimentalFeature> = [],
       indexTestHooks: IndexTestHooks = IndexTestHooks()
     ) {
@@ -77,7 +78,7 @@ extension SourceKitLSPServer {
       self.generatedInterfacesPath = generatedInterfacesPath
       self.swiftPublishDiagnosticsDebounceDuration = swiftPublishDiagnosticsDebounceDuration
       self.experimentalFeatures = experimentalFeatures
-      self.indexProgressDebounceDuration = indexProgressDebounceDuration
+      self.workDoneProgressDebounceDuration = workDoneProgressDebounceDuration
       self.indexTestHooks = indexTestHooks
     }
   }

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -127,10 +127,10 @@ public actor SourceKitLSPServer {
   /// initializer.
   private nonisolated(unsafe) var indexProgressManager: IndexProgressManager!
 
-  private var packageLoadingWorkDoneProgress = WorkDoneProgressState(
-    "SourceKitLSP.SourceKitLSPServer.reloadPackage",
-    title: "SourceKit-LSP: Reloading Package"
-  )
+  /// Number of workspaces that are currently reloading swift package. When this is not 0, a
+  /// `packageLoadingWorkDoneProgress` is created to show a work done progress indicator in the client.
+  private var inProgressPackageLoadingOperations = 0
+  private var packageLoadingWorkDoneProgress: WorkDoneProgressManager?
 
   /// **Public for testing**
   public var _documentManager: DocumentManager {
@@ -898,6 +898,27 @@ extension SourceKitLSPServer {
     )
   }
 
+  private func reloadPackageStatusCallback(_ status: ReloadPackageStatus) async {
+    switch status {
+    case .start:
+      inProgressPackageLoadingOperations += 1
+      if let capabilityRegistry, packageLoadingWorkDoneProgress == nil {
+        packageLoadingWorkDoneProgress = WorkDoneProgressManager(
+          server: self,
+          capabilityRegistry: capabilityRegistry,
+          initialDebounce: options.workDoneProgressDebounceDuration,
+          title: "SourceKit-LSP: Reloading Package"
+        )
+      }
+    case .end:
+      inProgressPackageLoadingOperations -= 1
+      if inProgressPackageLoadingOperations == 0, let packageLoadingWorkDoneProgress {
+        self.packageLoadingWorkDoneProgress = nil
+        await packageLoadingWorkDoneProgress.end()
+      }
+    }
+  }
+
   /// Creates a workspace at the given `uri`.
   ///
   /// If the build system that was determined for the workspace does not satisfy `condition`, `nil` is returned.
@@ -916,13 +937,7 @@ extension SourceKitLSPServer {
       options: options,
       toolchainRegistry: toolchainRegistry,
       reloadPackageStatusCallback: { [weak self] status in
-        guard let self else { return }
-        switch status {
-        case .start:
-          await self.packageLoadingWorkDoneProgress.startProgress(server: self)
-        case .end:
-          await self.packageLoadingWorkDoneProgress.endProgress(server: self)
-        }
+        await self?.reloadPackageStatusCallback(status)
       }
     )
     guard await condition(buildSystem) else {

Sources/SourceKitLSP/WorkDoneProgressManager.swift

@@ -61,7 +61,14 @@ final actor WorkDoneProgressManager {
     guard let capabilityRegistry = await server.capabilityRegistry else {
       return nil
     }
-    self.init(server: server, capabilityRegistry: capabilityRegistry, title: title, message: message)
+    self.init(
+      server: server,
+      capabilityRegistry: capabilityRegistry,
+      initialDebounce: initialDebounce,
+      title: title,
+      message: message,
+      percentage: percentage
+    )
   }
 
   init?(
@@ -109,7 +116,7 @@ final actor WorkDoneProgressManager {
           )
         )
       } else {
-        let token = ProgressToken.string("WorkDoneProgress-\(UUID())")
+        let token = ProgressToken.string(UUID().uuidString)
         do {
           _ = try await server.client.send(CreateWorkDoneProgressRequest(token: token))
         } catch {

Sources/SourceKitLSP/WorkDoneProgressState.swift

@@ -207,8 +207,8 @@ struct SourceKitLSP: AsyncParsableCommand {
   @Option(help: .hidden)
   var completionMaxResults = 200
 
-  @Option(help: .hidden)
-  var indexProgressDebounceDuration: Int = 1_000
+  @Option(name: .customLong("progress-debounce-duration"), help: .hidden)
+  var workDoneProgressDebounceDuration: Int = 1_000
 
   func mapOptions() -> SourceKitLSPServer.Options {
     var serverOptions = SourceKitLSPServer.Options()
@@ -228,7 +228,7 @@ struct SourceKitLSP: AsyncParsableCommand {
     serverOptions.generatedInterfacesPath = generatedInterfacesPath
     serverOptions.experimentalFeatures = Set(experimentalFeatures)
     serverOptions.completionOptions.maxResults = completionMaxResults
-    serverOptions.indexProgressDebounceDuration = .milliseconds(indexProgressDebounceDuration)
+    serverOptions.workDoneProgressDebounceDuration = .milliseconds(workDoneProgressDebounceDuration)
 
     return serverOptions
   }