nes: ghost: support showing ghost-text requests in the debug log tree (#2590)

* nes: formatting

* nes: ghost: support showing ghost-text requests in the debug log tree

Author: ulugbekna

package.json

@@ -2175,6 +2175,14 @@
 				"command": "github.copilot.chat.debug.hideNesRequests",
 				"title": "Hide NES Requests"
 			},
+			{
+				"command": "github.copilot.chat.debug.showGhostRequests",
+				"title": "Show Ghost Requests"
+			},
+			{
+				"command": "github.copilot.chat.debug.hideGhostRequests",
+				"title": "Hide Ghost Requests"
+			},
 			{
 				"command": "github.copilot.chat.debug.showRawRequestBody",
 				"title": "Show Raw Request Body"
@@ -4123,6 +4131,14 @@
 					"command": "github.copilot.chat.debug.hideNesRequests",
 					"when": "false"
 				},
+				{
+					"command": "github.copilot.chat.debug.showGhostRequests",
+					"when": "false"
+				},
+				{
+					"command": "github.copilot.chat.debug.hideGhostRequests",
+					"when": "false"
+				},
 				{
 					"command": "github.copilot.chat.debug.exportLogItem",
 					"when": "false"
@@ -4447,6 +4463,16 @@
 					"command": "github.copilot.chat.debug.hideNesRequests",
 					"when": "!github.copilot.chat.debug.nesRequestsHidden",
 					"group": "commands@2"
+				},
+				{
+					"command": "github.copilot.chat.debug.showGhostRequests",
+					"when": "github.copilot.chat.debug.ghostRequestsHidden",
+					"group": "commands@3"
+				},
+				{
+					"command": "github.copilot.chat.debug.hideGhostRequests",
+					"when": "!github.copilot.chat.debug.ghostRequestsHidden",
+					"group": "commands@3"
 				}
 			],
 			"notebook/toolbar": [

src/extension/completions-core/common/ghostTextContext.ts

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { InlineEditRequestLogContext } from '../../../platform/inlineEdits/common/inlineEditLogContext';
+import { basename } from '../../../util/vs/base/common/path';
+
+export class GhostTextContext extends InlineEditRequestLogContext {
+	override get includeInLogTree(): boolean {
+		return true;
+	}
+	override getDebugName(): string {
+		return `Ghost | ${basename(this.filePath)} (v${this.version})`;
+	}
+}

src/extension/completions-core/vscode-node/extension/src/inlineCompletion.ts

@@ -17,7 +17,13 @@ import {
 	workspace,
 } from 'vscode';
 import { Disposable } from '../../../../../util/vs/base/common/lifecycle';
+import { LineEdit } from '../../../../../util/vs/editor/common/core/edits/lineEdit';
+import { TextEdit, TextReplacement } from '../../../../../util/vs/editor/common/core/edits/textEdit';
+import { Range } from '../../../../../util/vs/editor/common/core/range';
+import { LineBasedText } from '../../../../../util/vs/editor/common/core/text/abstractText';
 import { IInstantiationService, ServicesAccessor } from '../../../../../util/vs/platform/instantiation/common/instantiation';
+import { InlineEditLogger } from '../../../../inlineEdits/vscode-node/parts/inlineEditLogger';
+import { GhostTextContext } from '../../../common/ghostTextContext';
 import { ICompletionsTelemetryService } from '../../bridge/src/completionsTelemetryServiceBridge';
 import { BuildInfo } from '../../lib/src/config';
 import { CopilotConfigPrefix } from '../../lib/src/constants';
@@ -53,6 +59,7 @@ export function exception(accessor: ServicesAccessor, error: unknown, origin: st
 export class CopilotInlineCompletionItemProvider extends Disposable implements InlineCompletionItemProvider {
 	private readonly copilotCompletionFeedbackTracker: CopilotCompletionFeedbackTracker;
 	private readonly ghostTextProvider: InlineCompletionItemProvider;
+	private readonly inlineEditLogger: InlineEditLogger;
 
 	public onDidChange = undefined;
 	public handleListEndOfLifetime: InlineCompletionItemProvider['handleListEndOfLifetime'] = undefined;
@@ -65,6 +72,7 @@ export class CopilotInlineCompletionItemProvider extends Disposable implements I
 		super();
 		this.copilotCompletionFeedbackTracker = this._register(this.instantiationService.createInstance(CopilotCompletionFeedbackTracker));
 		this.ghostTextProvider = this.instantiationService.createInstance(GhostTextProvider);
+		this.inlineEditLogger = this.instantiationService.createInstance(InlineEditLogger);
 	}
 
 	async provideInlineCompletionItems(
@@ -73,17 +81,22 @@ export class CopilotInlineCompletionItemProvider extends Disposable implements I
 		context: InlineCompletionContext,
 		token: CancellationToken
 	): Promise<InlineCompletionList | undefined> {
+		const logContext = new GhostTextContext(doc.uri.toString(), doc.version, context);
 		try {
-			return await this._provideInlineCompletionItems(doc, position, context, token);
+			return await this._provideInlineCompletionItems(doc, position, context, logContext, token);
 		} catch (e) {
+			logContext.setError(e);
 			this.telemetryService.sendGHTelemetryException(e, 'codeUnification.completions.exception');
+		} finally {
+			this.inlineEditLogger.add(logContext);
 		}
 	}
 
 	private async _provideInlineCompletionItems(
 		doc: TextDocument,
 		position: Position,
 		context: InlineCompletionContext,
+		logContext: GhostTextContext,
 		token: CancellationToken
 	): Promise<InlineCompletionList | undefined> {
 		if (context.triggerKind === InlineCompletionTriggerKind.Automatic) {
@@ -103,23 +116,31 @@ export class CopilotInlineCompletionItemProvider extends Disposable implements I
 		if (!copilotConfig.get('respectSelectedCompletionInfo', quickSuggestionsDisabled() || BuildInfo.isPreRelease())) {
 			context = { ...context, selectedCompletionInfo: undefined };
 		}
+
 		try {
 			let items = await this.ghostTextProvider.provideInlineCompletionItems(doc, position, context, token);
 
 			if (!items) {
+				if (token.isCancellationRequested) {
+					logContext.setIsSkipped();
+				}
 				return undefined;
 			}
 
 			// If the language client provides a list of items, we want to add the send feedback command to it.
 			if (Array.isArray(items)) {
 				items = { items };
 			}
+
+			this.logSuggestion(logContext, doc, items);
+
 			return {
 				...items,
 				commands: [sendCompletionFeedbackCommand],
 			};
 		} catch (e) {
 			this.instantiationService.invokeFunction(exception, e, '.provideInlineCompletionItems', logger);
+			logContext.setError(e);
 		}
 	}
 
@@ -150,4 +171,43 @@ export class CopilotInlineCompletionItemProvider extends Disposable implements I
 			this.instantiationService.invokeFunction(exception, e, '.handleEndOfLifetime', logger);
 		}
 	}
+
+	private logSuggestion(
+		logContext: GhostTextContext,
+		doc: TextDocument,
+		items: InlineCompletionList
+	) {
+		if (items.items.length === 0) {
+			logContext.markAsNoSuggestions();
+			logContext.addLog('No inline completion items provided');
+			return;
+		}
+		const firstItem = items.items[0];
+		if (!firstItem.range) {
+			logContext.addLog('Inline completion item has no range');
+			return;
+		}
+		if (typeof firstItem.insertText !== 'string') {
+			logContext.addLog('Inline completion item has non-string insertText');
+			return;
+		}
+
+		const text = new LineBasedText(lineNumber => doc.lineAt(lineNumber - 1).text, doc.lineCount);
+
+		const lineEdit = LineEdit.fromTextEdit(
+			new TextEdit(
+				[new TextReplacement(
+					new Range(firstItem.range.start.line + 1, firstItem.range.start.character + 1, firstItem.range.end.line + 1, firstItem.range.end.character + 1),
+					firstItem.insertText,
+				)],
+			),
+			text
+		);
+
+		const patch = lineEdit.humanReadablePatch(text.getLines());
+
+		logContext.addLog(`Provided inline completion item:`);
+		logContext.addCodeblockToLog(patch);
+		logContext.setResult(patch);
+	}
 }

src/extension/inlineEdits/vscode-node/parts/inlineEditLogger.ts

@@ -17,7 +17,9 @@ export class InlineEditLogger extends Disposable {
 	}
 
 	add(request: InlineEditRequestLogContext): void {
-		if (!request.includeInLogTree) { return; }
+		if (!request.includeInLogTree) {
+			return;
+		}
 
 		this._requestLogger.addEntry({
 			type: LoggedRequestKind.MarkdownContentRequest,

src/extension/log/vscode-node/requestLogTree.ts

@@ -817,6 +817,7 @@ class LogTreeFilters extends Disposable {
 	private _elementsShown = true;
 	private _toolsShown = true;
 	private _nesRequestsShown = true;
+	private _ghostRequestsShown = true;
 
 	private readonly _onDidChangeFilters = new vscode.EventEmitter<void>();
 	readonly onDidChangeFilters = this._onDidChangeFilters.event;
@@ -829,6 +830,7 @@ class LogTreeFilters extends Disposable {
 		this.setElementsShown(!vscodeExtensionContext.workspaceState.get(this.getStorageKey('elements')));
 		this.setToolsShown(!vscodeExtensionContext.workspaceState.get(this.getStorageKey('tools')));
 		this.setNesRequestsShown(!vscodeExtensionContext.workspaceState.get(this.getStorageKey('nesRequests')));
+		this.setGhostRequestsShown(!vscodeExtensionContext.workspaceState.get(this.getStorageKey('ghostRequests')));
 	}
 
 	private getStorageKey(name: string): string {
@@ -850,6 +852,11 @@ class LogTreeFilters extends Disposable {
 		this.setShown('nesRequests', this._nesRequestsShown);
 	}
 
+	setGhostRequestsShown(value: boolean) {
+		this._ghostRequestsShown = value;
+		this.setShown('ghostRequests', this._ghostRequestsShown);
+	}
+
 	itemIncluded(item: TreeItem): boolean {
 		if (item instanceof ChatPromptItem) {
 			if (this.isNesRequest(item)) {
@@ -865,11 +872,20 @@ class LogTreeFilters extends Disposable {
 			if (this.isNesRequest(item)) {
 				return this._nesRequestsShown;
 			}
+			// Check if this is a Ghost request
+			if (this.isGhostRequest(item)) {
+				return this._ghostRequestsShown;
+			}
 		}
 
 		return true;
 	}
 
+	private isGhostRequest(item: ChatRequestItem): boolean {
+		const debugName = item.info.entry.debugName.toLowerCase();
+		return debugName === 'ghost' || debugName.startsWith('ghost |');
+	}
+
 	private isNesRequest(item: ChatPromptItem | ChatRequestItem): boolean {
 		let debugName: string;
 		if (item instanceof ChatPromptItem) {
@@ -898,5 +914,7 @@ class LogTreeFilterCommands extends Disposable {
 		this._register(vscode.commands.registerCommand('github.copilot.chat.debug.hideTools', () => filters.setToolsShown(false)));
 		this._register(vscode.commands.registerCommand('github.copilot.chat.debug.showNesRequests', () => filters.setNesRequestsShown(true)));
 		this._register(vscode.commands.registerCommand('github.copilot.chat.debug.hideNesRequests', () => filters.setNesRequestsShown(false)));
+		this._register(vscode.commands.registerCommand('github.copilot.chat.debug.showGhostRequests', () => filters.setGhostRequestsShown(true)));
+		this._register(vscode.commands.registerCommand('github.copilot.chat.debug.hideGhostRequests', () => filters.setGhostRequestsShown(false)));
 	}
 }

src/platform/inlineEdits/common/inlineEditLogContext.ts

@@ -164,7 +164,11 @@ export class InlineEditRequestLogContext {
 		} else if (this._nesTypePicked === 'llm' && this._resultEdit) {
 			lines.push(`## Result:`);
 			lines.push('``` patch');
-			lines.push(this._resultEdit.toString());
+			if (typeof this._resultEdit === 'string') {
+				lines.push(this._resultEdit);
+			} else {
+				lines.push(this._resultEdit.toString());
+			}
 			lines.push('```');
 		} else {
 			lines.push(`## Result: <NOT-SET>`);
@@ -200,11 +204,11 @@ export class InlineEditRequestLogContext {
 		this._nextEditRequest = nextEditRequest;
 	}
 
-	private _resultEdit: RootedLineEdit | undefined = undefined;
+	private _resultEdit: RootedLineEdit | string | undefined = undefined;
 
-	setResult(resultEdit: RootedLineEdit) {
+	setResult(resultEditOrPatchString: RootedLineEdit | string) {
 		this._isVisible = true;
-		this._resultEdit = resultEdit;
+		this._resultEdit = resultEditOrPatchString;
 	}
 
 	protected _diagnosticsResultEdit: RootedLineEdit | undefined = undefined;