aboutsummaryrefslogtreecommitdiff
path: root/editors/code
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2020-11-05 13:09:22 +0000
committerGitHub <[email protected]>2020-11-05 13:09:22 +0000
commit7709b6a2d4b74b5838fbe5b30b6188d6a549b580 (patch)
tree31f0539c641e7a793aeed4d4cb6189e8c1e2a5d7 /editors/code
parentf5b72638bd5a18c4ddbd577930b5deaf64306034 (diff)
parentd2bf2ebe15bd58e6d8937a5894a2363a1ca46b59 (diff)
Merge #6470
6470: Restore semantic token flickering workaround removed in #5697 r=kjeremy a=charlespierce Closes #6452 Info ----- * As discussed in #6452, the `Error('busy')` workaround for semantic token flickering was removed because the underlying issue was believed to be fixed in VS Code. * It turns out that the fix isn't yet complete, so this caused flickering of the semantic highlighting when making rapid edits (e.g. typing quickly). * This PR restores that workaround and makes it slightly more robust, covering all areas of semantic token middleware. Changes ----- * Added middleware functions for `provideDocumentSemanticTokens`, `provideDocumentSemanticTokensEdits`, and `provideDocumentRangeSemanticTokens` to match the 3 possible middleware hooks defined in https://github.com/microsoft/vscode-languageserver-node/blob/master/client/src/common/semanticTokens.ts#L33 * Each intercepts a `null` or `undefined` return and throws an error with the message `busy` instead, which prevents the tokens from being removed and re-added (causing the flickering behavior) Tested ----- * Tested locally that the flickering behavior is gone. * There don't appear to be any significant tests of the VS Code plugin side of things, other than that it loads. Is there somewhere I can / should add tests to cover this behavior? Co-authored-by: Charles Pierce <[email protected]>
Diffstat (limited to 'editors/code')
-rw-r--r--editors/code/src/client.ts17
1 files changed, 17 insertions, 0 deletions
diff --git a/editors/code/src/client.ts b/editors/code/src/client.ts
index 1ba2352ee..d032b45b7 100644
--- a/editors/code/src/client.ts
+++ b/editors/code/src/client.ts
@@ -2,6 +2,7 @@ import * as lc from 'vscode-languageclient/node';
2import * as vscode from 'vscode'; 2import * as vscode from 'vscode';
3import * as ra from '../src/lsp_ext'; 3import * as ra from '../src/lsp_ext';
4import * as Is from 'vscode-languageclient/lib/common/utils/is'; 4import * as Is from 'vscode-languageclient/lib/common/utils/is';
5import { DocumentSemanticsTokensSignature, DocumentSemanticsTokensEditsSignature, DocumentRangeSemanticTokensSignature } from 'vscode-languageclient/lib/common/semanticTokens';
5import { assert } from './util'; 6import { assert } from './util';
6 7
7function renderCommand(cmd: ra.CommandLink) { 8function renderCommand(cmd: ra.CommandLink) {
@@ -18,6 +19,13 @@ function renderHoverActions(actions: ra.CommandLinkGroup[]): vscode.MarkdownStri
18 return result; 19 return result;
19} 20}
20 21
22// Workaround for https://github.com/microsoft/vscode-languageserver-node/issues/576
23async function semanticHighlightingWorkaround<R, F extends (...args: any[]) => vscode.ProviderResult<R>>(next: F, ...args: Parameters<F>): Promise<R> {
24 const res = await next(...args);
25 if (res == null) throw new Error('busy');
26 return res;
27}
28
21export function createClient(serverPath: string, cwd: string): lc.LanguageClient { 29export function createClient(serverPath: string, cwd: string): lc.LanguageClient {
22 // '.' Is the fallback if no folder is open 30 // '.' Is the fallback if no folder is open
23 // TODO?: Workspace folders support Uri's (eg: file://test.txt). 31 // TODO?: Workspace folders support Uri's (eg: file://test.txt).
@@ -41,6 +49,15 @@ export function createClient(serverPath: string, cwd: string): lc.LanguageClient
41 diagnosticCollectionName: "rustc", 49 diagnosticCollectionName: "rustc",
42 traceOutputChannel, 50 traceOutputChannel,
43 middleware: { 51 middleware: {
52 provideDocumentSemanticTokens(document: vscode.TextDocument, token: vscode.CancellationToken, next: DocumentSemanticsTokensSignature): vscode.ProviderResult<vscode.SemanticTokens> {
53 return semanticHighlightingWorkaround(next, document, token);
54 },
55 provideDocumentSemanticTokensEdits(document: vscode.TextDocument, previousResultId: string, token: vscode.CancellationToken, next: DocumentSemanticsTokensEditsSignature): vscode.ProviderResult<vscode.SemanticTokensEdits | vscode.SemanticTokens> {
56 return semanticHighlightingWorkaround(next, document, previousResultId, token);
57 },
58 provideDocumentRangeSemanticTokens(document: vscode.TextDocument, range: vscode.Range, token: vscode.CancellationToken, next: DocumentRangeSemanticTokensSignature): vscode.ProviderResult<vscode.SemanticTokens> {
59 return semanticHighlightingWorkaround(next, document, range, token);
60 },
44 async provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, _next: lc.ProvideHoverSignature) { 61 async provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, _next: lc.ProvideHoverSignature) {
45 return client.sendRequest(lc.HoverRequest.type, client.code2ProtocolConverter.asTextDocumentPositionParams(document, position), token).then( 62 return client.sendRequest(lc.HoverRequest.type, client.code2ProtocolConverter.asTextDocumentPositionParams(document, position), token).then(
46 (result) => { 63 (result) => {