Skip to content

avoid reporting cancellation as errors #13552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2025
Merged

avoid reporting cancellation as errors #13552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions Extension/src/LanguageServer/copilotProviders.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface CopilotApi {
uri: vscode.Uri,
context: { flags: Record<string, unknown> },
cancellationToken: vscode.CancellationToken
) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] }>
) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] } | undefined>
): Disposable;
getContextProviderAPI(version: string): Promise<ContextProviderApiV1 | undefined>;
}
Expand Down Expand Up @@ -91,15 +91,18 @@ export async function registerRelatedFilesProvider(): Promise<void> {
return { entries: await includesPromise, traits: await traitsPromise };
}
catch (exception) {
try {
const err: Error = exception as Error;
logger.getOutputChannelLogger().appendLine(localize("copilot.relatedfilesprovider.error", "Error while retrieving result. Reason: {0}", err.message));
// Avoid logging the error message if it is a cancellation error.
if (exception instanceof vscode.CancellationError) {
telemetryProperties["error"] = "cancellation";
telemetryProperties["cancellation"] = "true";
throw exception; // Rethrow the cancellation error to be handled by the caller.
} else if (exception instanceof Error) {
telemetryProperties["error"] = "true";
logger.getOutputChannelLogger().appendLine(localize("copilot.relatedfilesprovider.error", "Error while retrieving result. Reason: {0}", exception.message));
}
catch {
// Intentionally swallow any exception.
}
telemetryProperties["error"] = "true";
throw exception; // Throw the exception for auto-retry.

// In case of error retrieving the include files, we signal the caller of absence of the results by returning undefined.
return undefined;
} finally {
telemetryMetrics['duration'] = performance.now() - start;
telemetry.logCopilotEvent('RelatedFilesProvider', telemetryProperties, telemetryMetrics);
Expand Down
10 changes: 5 additions & 5 deletions Extension/test/scenarios/SingleRootProject/tests/copilotProviders.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ describe('copilotProviders Tests', () => {
let getClientsStub: sinon.SinonStub;
let activeClientStub: sinon.SinonStubbedInstance<DefaultClient>;
let vscodeGetExtensionsStub: sinon.SinonStub;
let callbackPromise: Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] }> | undefined;
let callbackPromise: Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] } | undefined> | undefined;
let vscodeExtension: vscode.Extension<unknown>;
let telemetryStub: sinon.SinonStub;

Expand Down Expand Up @@ -52,7 +52,7 @@ describe('copilotProviders Tests', () => {
uri: vscode.Uri,
context: { flags: Record<string, unknown> },
cancellationToken: vscode.CancellationToken
) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] }>
) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] } | undefined>
): vscode.Disposable & { [Symbol.dispose](): void } {
return {
dispose: () => { },
Expand Down Expand Up @@ -88,13 +88,13 @@ describe('copilotProviders Tests', () => {
});

const arrange = ({ vscodeExtension, getIncludeFiles, projectContext, rootUri, flags }:
{ vscodeExtension?: vscode.Extension<unknown>; getIncludeFiles?: GetIncludesResult; projectContext?: ProjectContext; rootUri?: vscode.Uri; flags?: Record<string, unknown> } =
{ vscodeExtension: undefined, getIncludeFiles: undefined, projectContext: undefined, rootUri: undefined, flags: {} }
{ vscodeExtension?: vscode.Extension<unknown>; getIncludeFiles?: GetIncludesResult; projectContext?: ProjectContext; rootUri?: vscode.Uri; flags?: Record<string, unknown> } =
{ vscodeExtension: undefined, getIncludeFiles: undefined, projectContext: undefined, rootUri: undefined, flags: {} }
) => {
activeClientStub.getIncludes.resolves(getIncludeFiles);
sinon.stub(lmTool, 'getProjectContext').resolves(projectContext);
sinon.stub(activeClientStub, 'RootUri').get(() => rootUri);
mockCopilotApi.registerRelatedFilesProvider.callsFake((_providerId: { extensionId: string; languageId: string }, callback: (uri: vscode.Uri, context: { flags: Record<string, unknown> }, cancellationToken: vscode.CancellationToken) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] }>) => {
mockCopilotApi.registerRelatedFilesProvider.callsFake((_providerId: { extensionId: string; languageId: string }, callback: (uri: vscode.Uri, context: { flags: Record<string, unknown> }, cancellationToken: vscode.CancellationToken) => Promise<{ entries: vscode.Uri[]; traits?: CopilotTrait[] } | undefined>) => {
if (_providerId.languageId === 'cpp') {
const tokenSource = new vscode.CancellationTokenSource();
try {
Expand Down