Address issues with request cancelation (#10296)

Author: Colengms

Extension/src/LanguageServer/Providers/codeActionProvider.ts

@@ -3,7 +3,7 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
-import { DefaultClient, FormatParams, FormatDocumentRequest } from '../client';
+import { DefaultClient, FormatParams, FormatDocumentRequest, FormatResult } from '../client';
 import { CppSettings, getEditorConfigSettings, OtherSettings } from '../settings';
 import { makeVscodeTextEdits } from '../utils';
 
@@ -69,7 +69,11 @@ export class DocumentFormattingEditProvider implements vscode.DocumentFormatting
             // because there is not currently cancellation logic for formatting
             // in the native process. Formatting is currently done directly in
             // message handling thread.
-            const results: vscode.TextEdit[] = makeVscodeTextEdits(await this.client.languageClient.sendRequest(FormatDocumentRequest, params));
+            const response: FormatResult = await this.client.languageClient.sendRequest(FormatDocumentRequest, params, token);
+            if (token.isCancellationRequested || response.edits === undefined) {
+                throw new vscode.CancellationError();
+            }
+            const results: vscode.TextEdit[] = makeVscodeTextEdits(response.edits);
             // Apply insert_final_newline from .editorconfig
             if (document.lineCount > 0 && editorConfigSettings !== undefined && editorConfigSettings.insert_final_newline) {
                 // Check if there is already a newline at the end.  If so, formatting edits should not replace it.

Extension/src/LanguageServer/Providers/documentFormattingEditProvider.ts

@@ -3,7 +3,7 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
-import { DefaultClient, FormatParams, FormatRangeRequest } from '../client';
+import { DefaultClient, FormatParams, FormatRangeRequest, FormatResult } from '../client';
 import { CppSettings, getEditorConfigSettings } from '../settings';
 import { makeVscodeTextEdits } from '../utils';
 
@@ -45,7 +45,11 @@ export class DocumentRangeFormattingEditProvider implements vscode.DocumentRange
             // because there is not currently cancellation logic for formatting
             // in the native process. Formatting is currently done directly in
             // message handling thread.
-            return makeVscodeTextEdits(await this.client.languageClient.sendRequest(FormatRangeRequest, params));
+            const response: FormatResult = await this.client.languageClient.sendRequest(FormatRangeRequest, params, token);
+            if (token.isCancellationRequested || response.edits === undefined) {
+                throw new vscode.CancellationError();
+            }
+            return makeVscodeTextEdits(response.edits);
         };
         if (!useVcFormat) {
             return configCallBack(undefined);

Extension/src/LanguageServer/Providers/documentRangeFormattingEditProvider.ts

@@ -3,7 +3,7 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
-import { DefaultClient, LocalizeDocumentSymbol, GetDocumentSymbolRequestParams, GetDocumentSymbolRequest, SymbolScope, Client } from '../client';
+import { DefaultClient, LocalizeDocumentSymbol, GetDocumentSymbolRequestParams, GetDocumentSymbolRequest, SymbolScope, Client, GetDocumentSymbolResult } from '../client';
 import { clients, processDelayedDidOpen } from '../extension';
 import { makeVscodeRange } from '../utils';
 import { getLocalizedString, getLocalizedSymbolScope } from '../localization';
@@ -60,14 +60,16 @@ export class DocumentSymbolProvider implements vscode.DocumentSymbolProvider {
             if (!defaultClient.TrackedDocuments.has(document)) {
                 processDelayedDidOpen(document);
             }
-            return defaultClient.requestWhenReady(async () => {
-                const params: GetDocumentSymbolRequestParams = {
-                    uri: document.uri.toString()
-                };
-                const symbols: LocalizeDocumentSymbol[] = await defaultClient.languageClient.sendRequest(GetDocumentSymbolRequest, params, token);
-                const resultSymbols: vscode.DocumentSymbol[] = this.getChildrenSymbols(symbols);
-                return resultSymbols;
-            });
+            await defaultClient.awaitUntilLanguageClientReady();
+            const params: GetDocumentSymbolRequestParams = {
+                uri: document.uri.toString()
+            };
+            const response: GetDocumentSymbolResult = await defaultClient.languageClient.sendRequest(GetDocumentSymbolRequest, params, token);
+            if (token.isCancellationRequested || response.symbols === undefined) {
+                throw new vscode.CancellationError();
+            };
+            const resultSymbols: vscode.DocumentSymbol[] = this.getChildrenSymbols(response.symbols);
+            return resultSymbols;
         }
         return [];
     }

Extension/src/LanguageServer/Providers/documentSymbolProvider.ts

@@ -23,12 +23,12 @@ export class FoldingRangeProvider implements vscode.FoldingRangeProvider {
             uri: document.uri.toString()
         };
         await this.client.awaitUntilLanguageClientReady();
-        const ranges: GetFoldingRangesResult = await this.client.languageClient.sendRequest(GetFoldingRangesRequest, params, token);
-        if (ranges.canceled) {
-            return undefined;
+        const response: GetFoldingRangesResult = await this.client.languageClient.sendRequest(GetFoldingRangesRequest, params, token);
+        if (token.isCancellationRequested || response.ranges === undefined) {
+            throw new vscode.CancellationError();
         }
         const result: vscode.FoldingRange[] = [];
-        ranges.ranges.forEach((r: CppFoldingRange) => {
+        response.ranges.forEach((r: CppFoldingRange) => {
             const foldingRange: vscode.FoldingRange = {
                 start: r.range.startLine,
                 end: r.range.endLine

Extension/src/LanguageServer/Providers/foldingRangeProvider.ts

@@ -29,7 +29,6 @@ interface CppInlayHint {
 
 interface GetInlayHintsResult {
     fileVersion: number;
-    canceled: boolean;
     inlayHints: CppInlayHint[];
 }
 
@@ -59,25 +58,22 @@ export class InlayHintsProvider implements vscode.InlayHintsProvider {
         const uriString: string = document.uri.toString();
 
         // Get results from cache if available.
-        const cacheEntry: InlayHintsCacheEntry | undefined = this.cache.get(uriString);
+        let cacheEntry: InlayHintsCacheEntry | undefined = this.cache.get(uriString);
         if (cacheEntry?.FileVersion === document.version) {
             return this.buildVSCodeHints(document.uri, cacheEntry);
         }
 
         // Get new results from the language server
         const params: GetInlayHintsParams = { uri: uriString };
         const inlayHintsResult: GetInlayHintsResult = await this.client.languageClient.sendRequest(GetInlayHintsRequest, params, token);
-        if (!inlayHintsResult.canceled) {
-            if (inlayHintsResult.fileVersion === openFileVersions.get(uriString)) {
-                const cacheEntry: InlayHintsCacheEntry = this.createCacheEntry(inlayHintsResult);
-                this.cache.set(uriString, cacheEntry);
-                return this.buildVSCodeHints(document.uri, cacheEntry);
-            } else {
-                // Force another request because file versions do not match.
-                this.onDidChangeInlayHintsEvent.fire();
-            }
+        if (token.isCancellationRequested || inlayHintsResult.inlayHints === undefined || inlayHintsResult.fileVersion !== openFileVersions.get(uriString)) {
+            throw new vscode.CancellationError();
         }
-        return undefined;
+
+        cacheEntry = this.createCacheEntry(inlayHintsResult);
+        this.cache.set(uriString, cacheEntry);
+        return this.buildVSCodeHints(document.uri, cacheEntry);
+
     }
 
     public invalidateFile(uri: string): void {

Extension/src/LanguageServer/Providers/inlayHintProvider.ts

@@ -3,7 +3,7 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
-import { DefaultClient, FormatParams, FormatOnTypeRequest } from '../client';
+import { DefaultClient, FormatParams, FormatOnTypeRequest, FormatResult } from '../client';
 import { CppSettings, getEditorConfigSettings } from '../settings';
 import { makeVscodeTextEdits } from '../utils';
 
@@ -45,7 +45,11 @@ export class OnTypeFormattingEditProvider implements vscode.OnTypeFormattingEdit
             // because there is not currently cancellation logic for formatting
             // in the native process. Formatting is currently done directly in
             // message handling thread.
-            return makeVscodeTextEdits(await this.client.languageClient.sendRequest(FormatOnTypeRequest, params));
+            const response: FormatResult = await this.client.languageClient.sendRequest(FormatOnTypeRequest, params, token);
+            if (token.isCancellationRequested || response.edits === undefined) {
+                throw new vscode.CancellationError();
+            }
+            return makeVscodeTextEdits(response.edits);
         };
         if (!useVcFormat) {
             // If not using vcFormat, only process on-type requests for ';'

Extension/src/LanguageServer/Providers/onTypeFormattingEditProvider.ts

@@ -23,27 +23,21 @@ export class SemanticTokensProvider implements vscode.DocumentSemanticTokensProv
         const cache: [number, vscode.SemanticTokens] | undefined = this.tokenCaches.get(uriString);
         if (cache && cache[0] === document.version) {
             return cache[1];
-        } else {
-            const params: GetSemanticTokensParams = {
-                uri: uriString
-            };
-            const tokensResult: GetSemanticTokensResult = await this.client.languageClient.sendRequest(GetSemanticTokensRequest, params, token);
-            if (tokensResult.canceled) {
-                throw new vscode.CancellationError();
-            } else {
-                if (tokensResult.fileVersion !== openFileVersions.get(uriString)) {
-                    throw new vscode.CancellationError();
-                } else {
-                    const builder: vscode.SemanticTokensBuilder = new vscode.SemanticTokensBuilder(semanticTokensLegend);
-                    tokensResult.tokens.forEach((semanticToken) => {
-                        builder.push(semanticToken.line, semanticToken.character, semanticToken.length, semanticToken.type, semanticToken.modifiers);
-                    });
-                    const tokens: vscode.SemanticTokens = builder.build();
-                    this.tokenCaches.set(uriString, [tokensResult.fileVersion, tokens]);
-                    return tokens;
-                }
-            }
         }
+        const params: GetSemanticTokensParams = {
+            uri: uriString
+        };
+        const tokensResult: GetSemanticTokensResult = await this.client.languageClient.sendRequest(GetSemanticTokensRequest, params, token);
+        if (token.isCancellationRequested || tokensResult.tokens === undefined || tokensResult.fileVersion !== openFileVersions.get(uriString)) {
+            throw new vscode.CancellationError();
+        }
+        const builder: vscode.SemanticTokensBuilder = new vscode.SemanticTokensBuilder(semanticTokensLegend);
+        tokensResult.tokens.forEach((semanticToken) => {
+            builder.push(semanticToken.line, semanticToken.character, semanticToken.length, semanticToken.type, semanticToken.modifiers);
+        });
+        const tokens: vscode.SemanticTokens = builder.build();
+        this.tokenCaches.set(uriString, [tokensResult.fileVersion, tokens]);
+        return tokens;
     }
 
     public invalidateFile(uri: string): void {

Extension/src/LanguageServer/Providers/semanticTokensProvider.ts

@@ -20,6 +20,9 @@ export class WorkspaceSymbolProvider implements vscode.WorkspaceSymbolProvider {
 
         const symbols: LocalizeSymbolInformation[] = await this.client.languageClient.sendRequest(GetSymbolInfoRequest, params, token);
         const resultSymbols: vscode.SymbolInformation[] = [];
+        if (token.isCancellationRequested) {
+            throw new vscode.CancellationError();
+        }
 
         // Convert to vscode.Command array
         symbols.forEach((symbol) => {

Extension/src/LanguageServer/Providers/workspaceSymbolProvider.ts

@@ -337,6 +337,10 @@ export interface LocalizeDocumentSymbol {
     children: LocalizeDocumentSymbol[];
 }
 
+export interface GetDocumentSymbolResult {
+    symbols: LocalizeDocumentSymbol[];
+}
+
 export interface LocalizeSymbolInformation {
     name: string;
     kind: vscode.SymbolKind;
@@ -368,6 +372,10 @@ export interface FormatParams {
     onChanges: boolean;
 }
 
+export interface FormatResult {
+    edits: TextEdit[];
+}
+
 export interface GetFoldingRangesParams {
     uri: string;
 }
@@ -385,7 +393,6 @@ export interface CppFoldingRange {
 }
 
 export interface GetFoldingRangesResult {
-    canceled: boolean;
     ranges: CppFoldingRange[];
 }
 
@@ -403,7 +410,6 @@ interface SemanticToken {
 
 export interface GetSemanticTokensResult {
     fileVersion: number;
-    canceled: boolean;
     tokens: SemanticToken[];
 }
 
@@ -531,13 +537,13 @@ const QueryCompilerDefaultsRequest: RequestType<QueryDefaultCompilerParams, conf
 const QueryTranslationUnitSourceRequest: RequestType<QueryTranslationUnitSourceParams, QueryTranslationUnitSourceResult, void> = new RequestType<QueryTranslationUnitSourceParams, QueryTranslationUnitSourceResult, void>('cpptools/queryTranslationUnitSource');
 const SwitchHeaderSourceRequest: RequestType<SwitchHeaderSourceParams, string, void> = new RequestType<SwitchHeaderSourceParams, string, void>('cpptools/didSwitchHeaderSource');
 const GetDiagnosticsRequest: RequestType<void, GetDiagnosticsResult, void> = new RequestType<void, GetDiagnosticsResult, void>('cpptools/getDiagnostics');
-export const GetDocumentSymbolRequest: RequestType<GetDocumentSymbolRequestParams, LocalizeDocumentSymbol[], void> = new RequestType<GetDocumentSymbolRequestParams, LocalizeDocumentSymbol[], void>('cpptools/getDocumentSymbols');
+export const GetDocumentSymbolRequest: RequestType<GetDocumentSymbolRequestParams, GetDocumentSymbolResult, void> = new RequestType<GetDocumentSymbolRequestParams, GetDocumentSymbolResult, void>('cpptools/getDocumentSymbols');
 export const GetSymbolInfoRequest: RequestType<WorkspaceSymbolParams, LocalizeSymbolInformation[], void> = new RequestType<WorkspaceSymbolParams, LocalizeSymbolInformation[], void>('cpptools/getWorkspaceSymbols');
 export const GetFoldingRangesRequest: RequestType<GetFoldingRangesParams, GetFoldingRangesResult, void> = new RequestType<GetFoldingRangesParams, GetFoldingRangesResult, void>('cpptools/getFoldingRanges');
 export const GetSemanticTokensRequest: RequestType<GetSemanticTokensParams, GetSemanticTokensResult, void> = new RequestType<GetSemanticTokensParams, GetSemanticTokensResult, void>('cpptools/getSemanticTokens');
-export const FormatDocumentRequest: RequestType<FormatParams, TextEdit[], void> = new RequestType<FormatParams, TextEdit[], void>('cpptools/formatDocument');
-export const FormatRangeRequest: RequestType<FormatParams, TextEdit[], void> = new RequestType<FormatParams, TextEdit[], void>('cpptools/formatRange');
-export const FormatOnTypeRequest: RequestType<FormatParams, TextEdit[], void> = new RequestType<FormatParams, TextEdit[], void>('cpptools/formatOnType');
+export const FormatDocumentRequest: RequestType<FormatParams, FormatResult, void> = new RequestType<FormatParams, FormatResult, void>('cpptools/formatDocument');
+export const FormatRangeRequest: RequestType<FormatParams, FormatResult, void> = new RequestType<FormatParams, FormatResult, void>('cpptools/formatRange');
+export const FormatOnTypeRequest: RequestType<FormatParams, FormatResult, void> = new RequestType<FormatParams, FormatResult, void>('cpptools/formatOnType');
 const CreateDeclarationOrDefinitionRequest: RequestType<CreateDeclarationOrDefinitionParams, CreateDeclarationOrDefinitionResult, void> = new RequestType<CreateDeclarationOrDefinitionParams, CreateDeclarationOrDefinitionResult, void>('cpptools/createDeclDef');
 const GoToDirectiveInGroupRequest: RequestType<GoToDirectiveInGroupParams, Position | undefined, void> = new RequestType<GoToDirectiveInGroupParams, Position | undefined, void>('cpptools/goToDirectiveInGroup');
 const GenerateDoxygenCommentRequest: RequestType<GenerateDoxygenCommentParams, GenerateDoxygenCommentResult | undefined, void> = new RequestType<GenerateDoxygenCommentParams, GenerateDoxygenCommentResult, void>('cpptools/generateDoxygenComment');
@@ -1688,7 +1694,8 @@ export class DefaultClient implements Client {
     }
 
     public async logDiagnostics(): Promise<void> {
-        const response: GetDiagnosticsResult = await this.requestWhenReady(() => this.languageClient.sendRequest(GetDiagnosticsRequest, null));
+        await this.awaitUntilLanguageClientReady();
+        const response: GetDiagnosticsResult = await this.languageClient.sendRequest(GetDiagnosticsRequest, null);
         const diagnosticsChannel: vscode.OutputChannel = getDiagnosticsChannel();
         diagnosticsChannel.clear();