Add a work done progress that shows the index progress #1275
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hamishknight
approved these changes
May 13, 2024
Comment on lines
188
to
229
| for file in files { | ||
| if case .scheduled(let task) = self.indexStatus[file] { | ||
| self.indexStatus[file] = .executing(task) | ||
| } | ||
| } | ||
| case .cancelledToBeRescheduled: | ||
| for file in files { | ||
| if case .executing(let task) = self.indexStatus[file] { | ||
| self.indexStatus[file] = .scheduled(task) | ||
| } | ||
| } | ||
| case .finished: | ||
| for file in files { | ||
| self.indexStatus[file] = .upToDate | ||
| } |
There was a problem hiding this comment.
Should we log an error or something if a file is in an unexpected state?
| } | ||
|
|
||
| func startProgressImpl(server: SourceKitLSPServer) async { | ||
| await server.waitUntilInitialized() | ||
| activeTasks += 1 | ||
| guard await server.capabilityRegistry?.clientCapabilities.window?.workDoneProgress ?? false else { | ||
| // If the client doesn't support workDoneProgress, keep track of the active task count but don't update the state. |
There was a problem hiding this comment.
This comment talks about handling the case where this is called before initialization finishes, I guess that's no longer relevant?
ahoppen
changed the title
|
@swift-ci Please test |
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
1 similar comment
|
@swift-ci Please test Windows |
|
@swift-ci Please test |
This simplifies the implementation.
This fixes a bug where `indexTaskDidFinish` would also get called when a task is cancelled to be rescheduled.
…lback 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.
…an be executed before SourceKit-LSP is initialized
…o be executed in any order
This makes it a lot easier to work on background indexing because you can easily see how background indexing is making progress. Resolves apple#1257 rdar://127474057
|
@swift-ci Please test |
ahoppen
changed the title
|
@swift-ci Please test Windows |
1 similar comment
|
@swift-ci Please test Windows |
bnbarham
reviewed
May 16, 2024
Comment on lines
+149
to
+151
| reloadPackageStatusCallback: @Sendable @escaping (ReloadPackageStatus) async -> Void, | ||
| indexTasksWereScheduled: @Sendable @escaping (Int) -> Void, | ||
| indexTaskDidFinish: @Sendable @escaping () -> Void |
There was a problem hiding this comment.
Might need a ServerCallbacks struct soon 😬
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes it a lot easier to work on background indexing because you can easily see how background indexing is making progress.
Resolves #1257
rdar://127474057