Update getErrors (GetErrors / problems) tool (#394)

* Update getErrors (GetErrors / problems) tool

Update this tool so it can gather all errors.

* Updated model description so agent knows the tool can gather all errors
* Updated implementation such that if no URL is given, the tool returns all
errors.

* Update tool definition

Made the 'filePaths' argument optional, and updated description
to indicate how the argument should be used.

* Updates from review

* Made filePaths on IGetErrorParams optional, updated implementation of
invoke accordingly.
* Updated prepareInvoke to handle optional argument properly as
well.

* Tweaks

---------

Co-authored-by: Rob Lourens <[email protected]>

Author: 2 people

package.json

@@ -400,22 +400,19 @@
 				"canBeReferencedInPrompt": true,
 				"icon": "$(error)",
 				"userDescription": "%copilot.tools.errors.description%",
-				"modelDescription": "Get any compile or lint errors in a code file. If the user mentions errors or problems in a file, they may be referring to these. Use the tool to see the same errors that the user is seeing. Also use this tool after editing a file to validate the change.",
+				"modelDescription": "Get any compile or lint errors in a specific file or across all files. If the user mentions errors or problems in a file, they may be referring to these. Use the tool to see the same errors that the user is seeing. If the user asks you to analyze all errors, or does not specify a file, use this tool to gather errors for all files. Also use this tool after editing a file to validate the change.",
 				"tags": [],
 				"inputSchema": {
 					"type": "object",
 					"properties": {
 						"filePaths": {
-							"description": "The absolute paths to the files to check for errors.",
+							"description": "The absolute paths to the files to check for errors. Omit 'filePaths' when retrieving all errors.",
 							"type": "array",
 							"items": {
 								"type": "string"
 							}
 						}
-					},
-					"required": [
-						"filePaths"
-					]
+					}
 				}
 			},
 			{

src/extension/tools/node/getErrorsTool.tsx

@@ -7,6 +7,7 @@ import * as l10n from '@vscode/l10n';
 import { BasePromptElementProps, PromptElement, PromptElementProps } from '@vscode/prompt-tsx';
 import type * as vscode from 'vscode';
 import { ILanguageDiagnosticsService } from '../../../platform/languages/common/languageDiagnosticsService';
+import { ILogService } from '../../../platform/log/common/logService';
 import { IPromptPathRepresentationService } from '../../../platform/prompts/common/promptPathRepresentationService';
 import { IWorkspaceService } from '../../../platform/workspace/common/workspaceService';
 import { getLanguage } from '../../../util/common/languages';
@@ -24,10 +25,14 @@ import { DiagnosticContext, Diagnostics } from '../../prompts/node/inline/diagno
 import { ToolName } from '../common/toolNames';
 import { ICopilotTool, ToolRegistry } from '../common/toolsRegistry';
 import { checkCancellation, formatUriForFileWidget, resolveToolInputPath } from './toolUtils';
+import { coalesce } from '../../../util/vs/base/common/arrays';
 
 interface IGetErrorsParams {
-	filePaths: string[];
+	// Note that empty array is not the same as absence; empty array
+	// will not return any errors. Absence returns all errors.
+	filePaths?: string[];
 	// sparse array of ranges, as numbers because it goes through JSON
+	// ignored if filePaths is missing / null.
 	ranges?: ([a: number, b: number, c: number, d: number] | undefined)[];
 }
 
@@ -39,12 +44,18 @@ class GetErrorsTool extends Disposable implements ICopilotTool<IGetErrorsParams>
 		@ILanguageDiagnosticsService private readonly languageDiagnosticsService: ILanguageDiagnosticsService,
 		@IWorkspaceService private readonly workspaceService: IWorkspaceService,
 		@IPromptPathRepresentationService private readonly promptPathRepresentationService: IPromptPathRepresentationService,
+		@ILogService private readonly logService: ILogService
 	) {
 		super();
 	}
 
 	async invoke(options: vscode.LanguageModelToolInvocationOptions<IGetErrorsParams>, token: CancellationToken) {
-		const diagnostics = await Promise.all(options.input.filePaths.map(async (filePath, i): Promise<{ context: DiagnosticContext; uri: URI; diagnostics: vscode.Diagnostic[] }> => {
+		const getAll = () => this.languageDiagnosticsService.getAllDiagnostics()
+			.map(d => ({ uri: d[0], diagnostics: d[1].filter(e => e.severity <= DiagnosticSeverity.Warning) }))
+			// filter any documents w/o warnings or errors
+			.filter(d => d.diagnostics.length > 0);
+
+		const getSome = (filePaths: string[]) => filePaths.map((filePath, i) => {
 			const uri = resolveToolInputPath(filePath, this.promptPathRepresentationService);
 			const range = options.input.ranges?.[i];
 			if (!uri) {
@@ -57,16 +68,28 @@ class GetErrorsTool extends Disposable implements ICopilotTool<IGetErrorsParams>
 
 			diagnostics = diagnostics.filter(d => d.severity <= DiagnosticSeverity.Warning);
 
-			const document = await this.workspaceService.openTextDocumentAndSnapshot(uri);
-			checkCancellation(token);
-
 			return {
-				context: { document, language: getLanguage(document) },
 				diagnostics,
 				uri,
 			};
-		}));
-
+		});
+
+		const ds = options.input.filePaths?.length ? getSome(options.input.filePaths) : getAll();
+
+		const diagnostics = coalesce(await Promise.all(ds.map((async ({ uri, diagnostics }) => {
+			try {
+				const document = await this.workspaceService.openTextDocumentAndSnapshot(uri);
+				checkCancellation(token);
+				return {
+					uri,
+					diagnostics,
+					context: { document, language: getLanguage(document) }
+				};
+			} catch (e) {
+				this.logService.error(e, 'get_errors failed to open doc with diagnostics');
+				return undefined;
+			}
+		}))));
 		checkCancellation(token);
 
 		const result = new ExtendedLanguageModelToolResult([
@@ -76,27 +99,41 @@ class GetErrorsTool extends Disposable implements ICopilotTool<IGetErrorsParams>
 		]);
 
 		const numDiagnostics = diagnostics.reduce((acc, { diagnostics }) => acc + diagnostics.length, 0);
-		result.toolResultMessage = numDiagnostics === 0 ?
-			new MarkdownString(l10n.t`Checked ${this.formatURIs(diagnostics.map(d => d.uri))}, no problems found`) :
-			numDiagnostics === 1 ?
-				new MarkdownString(l10n.t`Checked ${this.formatURIs(diagnostics.map(d => d.uri))}, 1 problem found`) :
-				new MarkdownString(l10n.t`Checked ${this.formatURIs(diagnostics.map(d => d.uri))}, ${numDiagnostics} problems found`);
+		const formattedURIs = this.formatURIs(diagnostics.map(d => d.uri));
+		if (options.input.filePaths?.length) {
+			result.toolResultMessage = numDiagnostics === 0 ?
+				new MarkdownString(l10n.t`Checked ${formattedURIs}, no problems found`) :
+				numDiagnostics === 1 ?
+					new MarkdownString(l10n.t`Checked ${formattedURIs}, 1 problem found`) :
+					new MarkdownString(l10n.t`Checked ${formattedURIs}, ${numDiagnostics} problems found`);
+		} else {
+			result.toolResultMessage = numDiagnostics === 0 ?
+				new MarkdownString(l10n.t`Checked workspace, no problems found`) :
+				numDiagnostics === 1 ?
+					new MarkdownString(l10n.t`Checked workspace, 1 problem found in ${formattedURIs}`) :
+					new MarkdownString(l10n.t`Checked workspace, ${numDiagnostics} problems found in ${formattedURIs}`);
+		}
+
 		return result;
 	}
 
 	prepareInvocation(options: vscode.LanguageModelToolInvocationPrepareOptions<IGetErrorsParams>, token: vscode.CancellationToken): vscode.ProviderResult<vscode.PreparedToolInvocation> {
 		if (!options.input.filePaths?.length) {
-			throw new Error('No file paths provided');
+			// When no file paths provided, check all files with diagnostics
+			return {
+				invocationMessage: new MarkdownString(l10n.t`Checking workspace for problems`),
+			};
 		}
+		else {
+			const uris = options.input.filePaths.map(filePath => resolveToolInputPath(filePath, this.promptPathRepresentationService));
+			if (uris.some(uri => uri === undefined)) {
+				throw new Error('Invalid file path provided');
+			}
 
-		const uris = options.input.filePaths.map(filePath => resolveToolInputPath(filePath, this.promptPathRepresentationService));
-		if (uris.some(uri => uri === undefined)) {
-			throw new Error('Invalid file path provided');
+			return {
+				invocationMessage: new MarkdownString(l10n.t`Checking ${this.formatURIs(uris)}`),
+			};
 		}
-
-		return {
-			invocationMessage: new MarkdownString(l10n.t`Checking ${this.formatURIs(uris)}`),
-		};
 	}
 
 	private formatURIs(uris: URI[]): string {

src/platform/languages/vscode/languageDiagnosticsServiceImpl.ts

@@ -6,17 +6,16 @@
 import * as vscode from 'vscode';
 import { AbstractLanguageDiagnosticsService } from '../common/languageDiagnosticsService';
 
-
 export class LanguageDiagnosticsServiceImpl extends AbstractLanguageDiagnosticsService {
-
-
+	private static ignoredSchemes = new Set(['git', 'chat-editing-snapshot-text-model', 'chat-editing-text-model']);
 	override onDidChangeDiagnostics: vscode.Event<vscode.DiagnosticChangeEvent> = vscode.languages.onDidChangeDiagnostics;
 
 	override getDiagnostics(resource: vscode.Uri): vscode.Diagnostic[] {
 		return vscode.languages.getDiagnostics(resource);
 	}
 
 	override getAllDiagnostics(): [vscode.Uri, vscode.Diagnostic[]][] {
-		return vscode.languages.getDiagnostics();
+		return vscode.languages.getDiagnostics()
+			.filter(([uri]) => !LanguageDiagnosticsServiceImpl.ignoredSchemes.has(uri.scheme));
 	}
 }