Function onCopilotHover

Extension/src/LanguageServer/extension.ts:1541–1658

()

// This uses several workarounds for interacting with the hover feature.
// A proposal for dynamic hover content would help, such as the one here (https://github.com/microsoft/vscode/issues/195394)
async function onCopilotHover(): Promise<void> {
    telemetry.logLanguageServerEvent("CopilotHover");

    const vscodelm = util.getVSCodeLanguageModel();
    if (!vscodelm) {
        return;
    }

    const copilotHoverProvider = clients.getDefaultClient().getCopilotHoverProvider();
    if (!copilotHoverProvider) {
        return;
    }

    const hoverDocument = copilotHoverProvider.getCurrentHoverDocument();
    const hoverPosition = copilotHoverProvider.getCurrentHoverPosition();
    if (!hoverDocument || !hoverPosition) {
        return;
    }

    // Prep hover with wait message.
    copilotHoverProvider.showWaiting();

    if (copilotHoverProvider.isCancelled(hoverDocument, hoverPosition)) {
        return;
    }

    // Move the cursor to the hover position, but don't focus the editor.
    await vscode.window.showTextDocument(hoverDocument, { preserveFocus: true, selection: new vscode.Selection(hoverPosition, hoverPosition) });

    if (!await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition)) {
        return;
    }

    // Gather the content for the query from the client.
    const requestInfo = await copilotHoverProvider.getRequestInfo(hoverDocument, hoverPosition);
    try {
        for (const file of requestInfo.files) {
            const fileUri = vscode.Uri.file(file);
            if (await vscodelm.fileIsIgnored(fileUri, copilotHoverProvider.getCurrentHoverCancellationToken() ?? CancellationToken.None)) {
                telemetry.logLanguageServerEvent("CopilotHover", { "Message": "Copilot summary is not available due to content exclusion." });
                await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, localize("copilot.hover.unavailable", "Copilot summary is not available.") + "\n\n" +
                    localize("copilot.hover.excluded", "The file containing this symbol's definition or declaration has been excluded from use with Copilot."));
                return;
            }
        }
    } catch (err) {
        if (err instanceof Error) {
            await reportCopilotFailure(copilotHoverProvider, hoverDocument, hoverPosition, err.name);
        }
        return;
    }
    if (requestInfo.content.length === 0) {
        // Context is not available for this symbol.
        telemetry.logLanguageServerEvent("CopilotHover", { "Message": "Copilot summary is not available for this symbol." });
        await showCopilotContent(copilotHoverProvider, hoverDocument, hoverPosition, localize("copilot.hover.unavailable.symbol", "Copilot summary is not available for this symbol."));
        return;
    }