Copilot summary should now only show up when there is already hover content from the main hover provider. Show error message on failure to prevent getting stuck showing the spinner.

Author: spebl

Extension/src/LanguageServer/Providers/CopilotHoverProvider.ts

@@ -26,7 +26,7 @@ export class CopilotHoverProvider implements vscode.HoverProvider {
         this.client = client;
     }
 
-    public async provideHover(document: vscode.TextDocument, position: vscode.Position, _token: vscode.CancellationToken): Promise<vscode.Hover | undefined> {
+    public async provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): Promise<vscode.Hover | undefined> {
         await this.client.ready;
         const settings: CppSettings = new CppSettings(vscode.workspace.getWorkspaceFolder(document.uri)?.uri);
         if (settings.hover === "disabled") {
@@ -35,7 +35,7 @@ export class CopilotHoverProvider implements vscode.HoverProvider {
 
         if (!this.isNewHover(document, position)) {
             if (this.ready) {
-                const contentMarkdown = new vscode.MarkdownString(`$(sparkle) Copilot\n\n${this.content}\n\n_AI-generated content may be incorrect._`, true);
+                const contentMarkdown = new vscode.MarkdownString(`$(sparkle) Copilot\n\n${this.content}\n\n_${localize("copilot.disclaimer", "AI-generated content may be incorrect.")}_`, true);
                 return new vscode.Hover(contentMarkdown);
             }
             if (this.waiting) {
@@ -46,6 +46,14 @@ export class CopilotHoverProvider implements vscode.HoverProvider {
 
         // Fresh hover, reset state.
         this.reset();
+        // Wait for the main hover provider to finish and confirm it has content.
+        const hoverProvider = this.client.getHoverProvider();
+        if (!await hoverProvider?.contentReady) {
+            return undefined;
+        }
+        if (token.isCancellationRequested) {
+            throw new vscode.CancellationError();
+        }
         this.currentDocument = document;
         this.currentPosition = position;
         const commandString = "$(sparkle) [" + localize("generate.copilot.description", "Generate Copilot summary") + "](command:C_Cpp.ShowCopilotHover)";

Extension/src/LanguageServer/Providers/HoverProvider.ts

@@ -4,17 +4,20 @@
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
 import { Position, ResponseError, TextDocumentPositionParams } from 'vscode-languageclient';
+import { ManualSignal } from '../../Utility/Async/manualSignal';
 import { DefaultClient, HoverRequest } from '../client';
 import { RequestCancelled, ServerCancelled } from '../protocolFilter';
 import { CppSettings } from '../settings';
 
 export class HoverProvider implements vscode.HoverProvider {
     private client: DefaultClient;
+    private readonly hasContent = new ManualSignal<boolean>(true);
     constructor(client: DefaultClient) {
         this.client = client;
     }
 
     public async provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): Promise<vscode.Hover | undefined> {
+        this.hasContent.reset();
         const settings: CppSettings = new CppSettings(vscode.workspace.getWorkspaceFolder(document.uri)?.uri);
         if (settings.hover === "disabled") {
             return undefined;
@@ -52,6 +55,11 @@ export class HoverProvider implements vscode.HoverProvider {
                 hoverResult.range.end.line, hoverResult.range.end.character);
         }
 
+        this.hasContent.resolve(strings.length > 0);
         return new vscode.Hover(strings, range);
     }
+
+    get contentReady(): Promise<boolean> {
+        return this.hasContent;
+    }
 }

Extension/src/LanguageServer/client.ts

@@ -836,6 +836,7 @@ export class DefaultClient implements Client {
     private settingsTracker: SettingsTracker;
     private loggingLevel: number = 1;
     private configurationProvider?: string;
+    private hoverProvider: HoverProvider | undefined;
     private copilotHoverProvider: CopilotHoverProvider | undefined;
 
     public lastCustomBrowseConfiguration: PersistentFolderState<WorkspaceBrowseConfiguration | undefined> | undefined;
@@ -1270,14 +1271,15 @@ export class DefaultClient implements Client {
                 this.registerFileWatcher();
                 initializedClientCount = 0;
                 this.inlayHintsProvider = new InlayHintsProvider();
+                this.hoverProvider = new HoverProvider(this);
 
                 const settings: CppSettings = new CppSettings();
                 if (settings.copilotHover === "enabled" ||
                     (settings.copilotHover === "default" && await telemetry.isFlightEnabled("cpp.copilotHover"))) {
                     this.copilotHoverProvider = new CopilotHoverProvider(this);
                     this.disposables.push(vscode.languages.registerHoverProvider(util.documentSelector, this.copilotHoverProvider));
                 }
-                this.disposables.push(vscode.languages.registerHoverProvider(util.documentSelector, new HoverProvider(this)));
+                this.disposables.push(vscode.languages.registerHoverProvider(util.documentSelector, this.hoverProvider));
                 this.disposables.push(vscode.languages.registerInlayHintsProvider(util.documentSelector, this.inlayHintsProvider));
                 this.disposables.push(vscode.languages.registerRenameProvider(util.documentSelector, new RenameProvider(this)));
                 this.disposables.push(vscode.languages.registerReferenceProvider(util.documentSelector, new FindAllReferencesProvider(this)));
@@ -4033,6 +4035,10 @@ export class DefaultClient implements Client {
         DebugConfigurationProvider.ClearDetectedBuildTasks();
     }
 
+    public getHoverProvider(): HoverProvider | undefined {
+        return this.hoverProvider;
+    }
+
     public getCopilotHoverProvider(): CopilotHoverProvider | undefined {
         return this.copilotHoverProvider;
     }

Extension/src/LanguageServer/extension.ts

@@ -21,6 +21,7 @@ import { modelSelector } from '../constants';
 import { getCrashCallStacksChannel } from '../logger';
 import { PlatformInformation } from '../platform';
 import * as telemetry from '../telemetry';
+import { CopilotHoverProvider } from './Providers/CopilotHoverProvider';
 import { Client, DefaultClient, DoxygenCodeActionCommandArguments, GetIncludesResult, openFileVersions } from './client';
 import { ClientCollection } from './clientCollection';
 import { CodeActionDiagnosticInfo, CodeAnalysisDiagnosticIdentifiersAndUri, codeAnalysisAllFixes, codeAnalysisCodeToFixes, codeAnalysisFileToCodeActions } from './codeAnalysis';
@@ -1448,30 +1449,18 @@ async function onCopilotHover(): Promise<void> {
         return;
     }
 
+    const errorMessage = localize("copilot.hover.error", "An error occurred while generating Copilot summary.");
+
     // Prep hover with wait message.
     copilotHoverProvider.showWaiting();
 
-    // Make sure the hover document has focus.
-    await vscode.window.showTextDocument(hoverDocument, { preserveFocus: false, selection: new vscode.Selection(hoverPosition, hoverPosition) });
-
-    // Workaround to force the editor to update it's content, needs to be called from another location first.
-    if (copilotHoverProvider.isCancelled(hoverDocument, hoverPosition)) {
-        return;
-    }
-    await vscode.commands.executeCommand('cursorMove', { to: 'right' });
-    await vscode.commands.executeCommand('editor.action.showHover', { focus: 'noAutoFocus' });
-
-    // Move back and show the correct hover.
-    if (copilotHoverProvider.isCancelled(hoverDocument, hoverPosition)) {
-        return;
-    }
-    await vscode.commands.executeCommand('cursorMove', { to: 'left' });
-    await vscode.commands.executeCommand('editor.action.showHover', { focus: 'noAutoFocus' });
+    await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition);
 
     // Gather the content for the query from the client.
     const requestInfo = await copilotHoverProvider.getRequestInfo(hoverDocument, hoverPosition);
 
     if (requestInfo.length === 0) {
+        await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, errorMessage);
         return;
     }
 
@@ -1493,6 +1482,7 @@ async function onCopilotHover(): Promise<void> {
     } catch (err) {
         if (err instanceof vscode.LanguageModelError) {
             console.log(err.message, err.code, err.cause);
+            await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, errorMessage);
         } else {
             throw err;
         }
@@ -1501,6 +1491,7 @@ async function onCopilotHover(): Promise<void> {
 
     // Ensure we have a valid response from Copilot.
     if (!chatResponse) {
+        await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, errorMessage);
         return;
     }
 
@@ -1511,13 +1502,19 @@ async function onCopilotHover(): Promise<void> {
             content += fragment;
         }
     } catch (err) {
+        await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, errorMessage);
         return;
     }
 
     if (content.length === 0) {
+        await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, errorMessage);
         return;
     }
 
+    await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, content);
+}
+
+async function showCopilotContent(copilotHoverProvider: CopilotHoverProvider, hoverDocument: vscode.TextDocument, hoverPosition: vscode.Position, content?: string): Promise<void> {
     // Make sure the hover document has focus.
     await vscode.window.showTextDocument(hoverDocument, { preserveFocus: false, selection: new vscode.Selection(hoverPosition, hoverPosition) });
 
@@ -1528,8 +1525,10 @@ async function onCopilotHover(): Promise<void> {
     await vscode.commands.executeCommand('cursorMove', { to: 'right' });
     await vscode.commands.executeCommand('editor.action.showHover', { focus: 'noAutoFocus' });
 
-    // Prepare and show the real content.
-    copilotHoverProvider.showContent(content);
+    if (content) {
+        copilotHoverProvider.showContent(content);
+    }
+
     if (copilotHoverProvider.isCancelled(hoverDocument, hoverPosition)) {
         return;
     }