Commit
- Move related files code to its own module - Refactor related files provider code to enable unit testing - Add Cpp context traits to completions prompt
- Loading branch information
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* -------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All Rights Reserved. | ||
| * See 'LICENSE' in the project root for license information. | ||
| * ------------------------------------------------------------------------------------------ */ | ||
| 'use strict'; | ||
|
|
||
| import * as vscode from 'vscode'; | ||
| import * as util from '../common'; | ||
| import * as telemetry from '../telemetry'; | ||
| import { ChatContextResult, GetIncludesResult } from './client'; | ||
| import { getActiveClient } from './extension'; | ||
|
|
||
| let isRelatedFilesApiEnabled: boolean | undefined; | ||
|
|
||
| export interface CopilotTrait { | ||
| name: string; | ||
| value: string; | ||
| includeInPrompt?: boolean; | ||
| promptTextOverride?: string; | ||
| } | ||
|
|
||
| export interface CopilotApi { | ||
| registerRelatedFilesProvider( | ||
| providerId: { extensionId: string; languageId: string }, | ||
| callback: ( | ||
| uri: vscode.Uri, | ||
| context: { flags: Record<string, unknown> }, | ||
| cancellationToken: vscode.CancellationToken | ||
| ) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] }> | ||
| ): Disposable; | ||
| } | ||
|
|
||
| export async function registerRelatedFilesProvider(): Promise<void> { | ||
| if (!await getIsRelatedFilesApiEnabled()) { | ||
| return; | ||
| } | ||
|
|
||
| const api = await getCopilotApi(); | ||
| if (util.extensionContext && api) { | ||
| try { | ||
| for (const languageId of ['c', 'cpp', 'cuda-cpp']) { | ||
| api.registerRelatedFilesProvider( | ||
| { extensionId: util.extensionContext.extension.id, languageId }, | ||
| async (_uri: vscode.Uri, context: { flags: Record<string, unknown> }, token: vscode.CancellationToken) => { | ||
|
|
||
| const getIncludesHandler = async () => { | ||
|
Check failure on line 46 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| return (await getIncludesWithCancellation(1, token))?.includedFiles.map(file => vscode.Uri.file(file)) ?? []; | ||
| } | ||
|
Check failure on line 48 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| const getTraitsHandler = async () => { | ||
| const chatContext: ChatContextResult | undefined = await (getActiveClient().getChatContext(token) ?? undefined); | ||
|
|
||
| if (!chatContext) { | ||
| return undefined; | ||
| } | ||
|
|
||
| let traits: CopilotTrait[] = [ | ||
| { name: "language", value: chatContext.language, includeInPrompt: true, promptTextOverride: `The language is ${chatContext.language}.` }, | ||
| { name: "compiler", value: chatContext.compiler, includeInPrompt: true, promptTextOverride: `This project compiles using ${chatContext.compiler}.` }, | ||
| { name: "standardVersion", value: chatContext.standardVersion, includeInPrompt: true, promptTextOverride: `This project uses the ${chatContext.standardVersion} language standard.` }, | ||
| { name: "targetPlatform", value: chatContext.targetPlatform, includeInPrompt: true, promptTextOverride: `This build targets ${chatContext.targetPlatform}.` }, | ||
| { name: "targetArchitecture", value: chatContext.targetArchitecture, includeInPrompt: true, promptTextOverride: `This build targets ${chatContext.targetArchitecture}.` }, | ||
|
Check failure on line 61 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| ]; | ||
|
|
||
| const excludeTraits = (context.flags.copilotcppExcludeTraits as string[] ?? []); | ||
|
Check failure on line 64 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| traits = traits.filter(trait => !excludeTraits.includes(trait.name)); | ||
|
|
||
| return traits.length > 0 ? traits : undefined; | ||
| } | ||
|
Check failure on line 68 in Extension/src/LanguageServer/copilotProviders.ts
|
||
|
|
||
| // Call both handlers in parallel | ||
| let traitsPromise = ((context.flags.copilotcppTraits as boolean) ?? false) ? getTraitsHandler() : Promise.resolve(undefined); | ||
|
Check failure on line 71 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| let includesPromise = getIncludesHandler(); | ||
|
Check failure on line 72 in Extension/src/LanguageServer/copilotProviders.ts
|
||
|
|
||
| return ({ entries: await includesPromise, traits: await traitsPromise }); | ||
|
Check failure on line 74 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| } | ||
| ); | ||
| } | ||
| } catch { | ||
| console.log("Failed to register Copilot related files provider."); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export async function registerRelatedFilesCommands(commandDisposables: vscode.Disposable[], enabled: boolean): Promise<void> { | ||
| if (await getIsRelatedFilesApiEnabled()) { | ||
| commandDisposables.push(vscode.commands.registerCommand('C_Cpp.getIncludes', enabled ? (maxDepth: number) => getIncludes(maxDepth) : () => Promise.resolve())); | ||
| } | ||
| } | ||
|
|
||
| async function getIncludesWithCancellation(maxDepth: number, token: vscode.CancellationToken): Promise<GetIncludesResult> { | ||
| let activeClient = getActiveClient(); | ||
|
Check failure on line 91 in Extension/src/LanguageServer/copilotProviders.ts
|
||
| const includes = await activeClient.getIncludes(maxDepth, token); | ||
| const wksFolder = activeClient.RootUri?.toString(); | ||
|
|
||
| if (!wksFolder) { | ||
| return includes; | ||
| } | ||
|
|
||
| includes.includedFiles = includes.includedFiles.filter(header => vscode.Uri.file(header).toString().startsWith(wksFolder)); | ||
| return includes; | ||
| } | ||
|
|
||
| async function getIncludes(maxDepth: number): Promise<GetIncludesResult> { | ||
| const tokenSource = new vscode.CancellationTokenSource(); | ||
| try { | ||
| const includes = await getIncludesWithCancellation(maxDepth, tokenSource.token); | ||
| return includes; | ||
| } finally { | ||
| tokenSource.dispose(); | ||
| } | ||
| } | ||
|
|
||
| async function getIsRelatedFilesApiEnabled(): Promise<boolean> { | ||
| if (isRelatedFilesApiEnabled === undefined) { | ||
| isRelatedFilesApiEnabled = await telemetry.isExperimentEnabled("CppToolsRelatedFilesApi"); | ||
| } | ||
|
|
||
| return isRelatedFilesApiEnabled; | ||
| } | ||
|
|
||
| export async function getCopilotApi(): Promise<CopilotApi | undefined> { | ||
| const copilotExtension = vscode.extensions.getExtension<CopilotApi>('github.copilot'); | ||
| if (!copilotExtension) { | ||
| return undefined; | ||
| } | ||
|
|
||
| if (!copilotExtension.isActive) { | ||
| try { | ||
| return await copilotExtension.activate(); | ||
| } catch { | ||
| return undefined; | ||
| } | ||
| } else { | ||
| return copilotExtension.exports; | ||
| } | ||
| } | ||
