Fix backtick in search query breaking tool result codespan (#515)

* Fix backtick in search query breaking tool result codespan

* Fix

Author: roblourens

src/extension/tools/node/findTextInFilesTool.tsx

@@ -102,11 +102,27 @@ export class FindTextInFilesTool implements ICopilotTool<IFindTextInFilesToolPar
 		};
 	}
 
-	private formatQueryString(input: IFindTextInFilesToolParams): string {
-		return input.includePattern && input.includePattern !== '**/*' ?
-			`\`${input.query}\` (\`${input.includePattern}\`)` :
-			`\`${input.query}\``;
+	/**
+	 * Formats text as a Markdown inline code span that is resilient to backticks within the text.
+	 * It chooses a backtick fence one longer than the longest run of backticks in the content,
+	 * and pads with a space when the content begins or ends with a backtick as per CommonMark.
+	 */
+	private formatCodeSpan(text: string): string {
+		const matches = text.match(/`+/g);
+		const maxRun = matches ? matches.reduce((m, s) => Math.max(m, s.length), 0) : 0;
+		const fence = '`'.repeat(maxRun + 1);
+		const needsPadding = text.startsWith('`') || text.endsWith('`');
+		const inner = needsPadding ? ` ${text} ` : text;
+		return `${fence}${inner}${fence}`;
+	}
 
+	private formatQueryString(input: IFindTextInFilesToolParams): string {
+		const querySpan = this.formatCodeSpan(input.query);
+		if (input.includePattern && input.includePattern !== '**/*') {
+			const patternSpan = this.formatCodeSpan(input.includePattern);
+			return `${querySpan} (${patternSpan})`;
+		}
+		return querySpan;
 	}
 
 	async resolveInput(input: IFindTextInFilesToolParams, _promptContext: IBuildPromptContext, mode: CopilotToolMode): Promise<IFindTextInFilesToolParams> {

src/extension/tools/node/test/findTextInFiles.spec.tsx

@@ -17,6 +17,7 @@ import { SyncDescriptor } from '../../../../util/vs/platform/instantiation/commo
 import { IInstantiationService } from '../../../../util/vs/platform/instantiation/common/instantiation';
 import { createExtensionUnitTestingServices } from '../../../test/node/services';
 import { FindTextInFilesTool } from '../findTextInFilesTool';
+import { MarkdownString } from '../../../../util/vs/base/common/htmlContent';
 
 suite('FindTextInFiles', () => {
 	let accessor: ITestingServicesAccessor;
@@ -72,6 +73,14 @@ suite('FindTextInFiles', () => {
 		const tool = accessor.get(IInstantiationService).createInstance(FindTextInFilesTool);
 		await tool.invoke({ input: { query: 'hello', includePattern: workspaceFolder }, toolInvocationToken: null!, }, CancellationToken.None);
 	});
+
+	test('escapes backtick', async () => {
+		setup(new RelativePattern(URI.file(workspaceFolder), ''));
+
+		const tool = accessor.get(IInstantiationService).createInstance(FindTextInFilesTool);
+		const prepared = await tool.prepareInvocation({ input: { query: 'hello `world`' }, }, CancellationToken.None);
+		expect((prepared?.invocationMessage as any as MarkdownString).value).toMatchInlineSnapshot(`"Searching text for \`\` hello \`world\` \`\`"`);
+	});
 });
 
 class TestSearchService extends AbstractSearchService {