-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Simplify LSP refresh queue management #81864
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+15
−19
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9e80c1a
Properly await calls to ensure exception handling works for sync and …
CyrusNajmabadi 459aaf7
Fix
CyrusNajmabadi 7a9547a
Merge remote-tracking branch 'upstream/main' into asyncLSP
CyrusNajmabadi d9c3930
Add docs
CyrusNajmabadi f576333
Simplify refresh queue management
CyrusNajmabadi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,8 +30,6 @@ internal abstract class AbstractRefreshQueue : | |
| private readonly CancellationTokenSource _disposalTokenSource; | ||
| private readonly LspWorkspaceRegistrationService _lspWorkspaceRegistrationService; | ||
|
|
||
| protected bool _isQueueCreated; | ||
|
|
||
| protected abstract string GetFeatureAttribute(); | ||
| protected abstract bool? GetRefreshSupport(ClientCapabilities clientCapabilities); | ||
| protected abstract string GetWorkspaceRefreshName(); | ||
|
|
@@ -42,7 +40,6 @@ public AbstractRefreshQueue( | |
| LspWorkspaceManager lspWorkspaceManager, | ||
| IClientLanguageServerManager notificationManager) | ||
| { | ||
| _isQueueCreated = false; | ||
| _asyncListener = asynchronousOperationListenerProvider.GetListener(GetFeatureAttribute()); | ||
| _lspWorkspaceRegistrationService = lspWorkspaceRegistrationService; | ||
| _disposalTokenSource = new(); | ||
|
|
@@ -71,7 +68,6 @@ public void Initialize(ClientCapabilities clientCapabilities) | |
| equalityComparer: EqualityComparer<DocumentUri?>.Default, | ||
| asyncListener: _asyncListener, | ||
| _disposalTokenSource.Token); | ||
| _isQueueCreated = true; | ||
| _lspWorkspaceRegistrationService.LspSolutionChanged += OnLspSolutionChanged; | ||
| } | ||
| } | ||
|
|
@@ -95,16 +91,15 @@ protected virtual void OnLspSolutionChanged(object? sender, WorkspaceChangeEvent | |
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Enqueues a request to refresh the workspace. If <paramref name="documentUri"/> is null, then the refresh will | ||
| /// always happen. If non-null, the refresh will only happen if the client is <em>not</em> tracking that document. | ||
| /// If the client is tracking the document, no refresh is necessary as the client clearly knows about the change. | ||
| /// </summary> | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. added docs as the semantics weren't previous clear to me. |
||
| protected void EnqueueRefreshNotification(DocumentUri? documentUri) | ||
| { | ||
| if (_isQueueCreated) | ||
| { | ||
| Contract.ThrowIfNull(_refreshQueue); | ||
| _refreshQueue.AddWork(documentUri); | ||
| } | ||
| } | ||
| => _refreshQueue?.AddWork(documentUri); | ||
|
|
||
| private ValueTask FilterLspTrackedDocumentsAsync( | ||
| private async ValueTask FilterLspTrackedDocumentsAsync( | ||
| LspWorkspaceManager lspWorkspaceManager, | ||
| IClientLanguageServerManager notificationManager, | ||
| ImmutableSegmentedList<DocumentUri?> documentUris, | ||
|
|
@@ -117,7 +112,11 @@ private ValueTask FilterLspTrackedDocumentsAsync( | |
| { | ||
| try | ||
| { | ||
| return notificationManager.SendRequestAsync(GetWorkspaceRefreshName(), cancellationToken); | ||
| // Fire the notification and immediately return. Refresh notifications are server-wide, and are not | ||
| // associated with a particular project/document. So once we've sent one, we can stop processing | ||
| // entirely. | ||
| await notificationManager.SendRequestAsync(GetWorkspaceRefreshName(), cancellationToken).ConfigureAwait(false); | ||
| return; | ||
| } | ||
| catch (Exception ex) when (ex is ObjectDisposedException or ConnectionLostException) | ||
| { | ||
|
|
@@ -128,7 +127,6 @@ private ValueTask FilterLspTrackedDocumentsAsync( | |
| } | ||
|
|
||
| // LSP is already tracking all changed documents so we don't need to send a refresh request. | ||
| return ValueTask.CompletedTask; | ||
| } | ||
|
|
||
| public virtual void Dispose() | ||
|
|
||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed this. we already have the presence/absence of the queue we can check.