Skip to content

Restore edits for background sessions #2180

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 3 commits into from
Nov 26, 2025
Merged

Restore edits for background sessions #2180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8193075
Restore edits for background sessions
DonJayamanne Nov 25, 2025
095dd36
Merge branch 'main' into don/permanent-sailfish
DonJayamanne Nov 26, 2025
433abf5
Merge branch 'main' into don/permanent-sailfish
DonJayamanne Nov 26, 2025
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
6 changes: 3 additions & 3 deletions src/extension/agents/common/externalEditTracker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { IDisposable } from '../../../util/vs/base/common/lifecycle';
* externalEdit API to ensure proper tracking and attribution of file changes.
*/
export class ExternalEditTracker {
private _ongoingEdits = new Map<string, { complete: () => void; onDidComplete: Thenable<void> }>();
private _ongoingEdits = new Map<string, { complete: () => void; onDidComplete: Thenable<string> }>();

/**
* Starts tracking an external edit operation.
Expand Down Expand Up @@ -65,12 +65,12 @@ export class ExternalEditTracker {
* @param editKey Unique identifier for the edit operation to complete
* @returns Promise that resolves when VS Code has finished tracking the edit
*/
public async completeEdit(editKey: string): Promise<void> {
public async completeEdit(editKey: string): Promise<string | undefined> {
const ongoingEdit = this._ongoingEdits.get(editKey);
if (ongoingEdit) {
this._ongoingEdits.delete(editKey);
ongoingEdit.complete();
await ongoingEdit.onDidComplete;
return await ongoingEdit.onDidComplete;
}
}
}
58 changes: 36 additions & 22 deletions src/extension/agents/copilotcli/common/copilotCLITools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import type { ChatPromptReference, ChatTerminalToolInvocationData, ExtendedChatR
import { isLocation } from '../../../../util/common/types';
import { ResourceSet } from '../../../../util/vs/base/common/map';
import { URI } from '../../../../util/vs/base/common/uri';
import { ChatRequestTurn2, ChatResponseMarkdownPart, ChatResponsePullRequestPart, ChatResponseThinkingProgressPart, ChatResponseTurn2, ChatToolInvocationPart, MarkdownString, Uri } from '../../../../vscodeTypes';
import { ChatRequestTurn2, ChatResponseCodeblockUriPart, ChatResponseMarkdownPart, ChatResponsePullRequestPart, ChatResponseTextEditPart, ChatResponseThinkingProgressPart, ChatResponseTurn2, ChatToolInvocationPart, MarkdownString, Uri } from '../../../../vscodeTypes';
import { formatUriForFileWidget } from '../../../tools/common/toolUtils';
import { extractChatPromptReferences, getFolderAttachmentPath } from './copilotCLIPrompt';

Expand Down Expand Up @@ -283,12 +283,14 @@ function extractPRMetadata(content: string): { cleanedContent: string; prPart?:
* Build chat history from SDK events for VS Code chat session
* Converts SDKEvents into ChatRequestTurn2 and ChatResponseTurn2 objects
*/
export function buildChatHistoryFromEvents(events: readonly SessionEvent[]): (ChatRequestTurn2 | ChatResponseTurn2)[] {
export function buildChatHistoryFromEvents(events: readonly SessionEvent[], getVSCodeRequestId?: (sdkRequestId: string) => { requestId: string; toolIdEditMap: Record<string, string> } | undefined): (ChatRequestTurn2 | ChatResponseTurn2)[] {
const turns: (ChatRequestTurn2 | ChatResponseTurn2)[] = [];
let currentResponseParts: ExtendedChatResponsePart[] = [];
const pendingToolInvocations = new Map<string, ChatToolInvocationPart>();
const pendingToolInvocations = new Map<string, [ChatToolInvocationPart, toolData: ToolCall]>();

let details: { requestId: string; toolIdEditMap: Record<string, string> } | undefined;
for (const event of events) {
details = getVSCodeRequestId?.(event.id) ?? details;
switch (event.type) {
case 'user.message': {
// Flush any pending response parts before adding user message
Expand Down Expand Up @@ -338,7 +340,7 @@ export function buildChatHistoryFromEvents(events: readonly SessionEvent[]): (Ch
range
});
});
turns.push(new ChatRequestTurn2(stripReminders(event.data.content || ''), undefined, references, '', [], undefined));
turns.push(new ChatRequestTurn2(stripReminders(event.data.content || ''), undefined, references, '', [], undefined, details?.requestId));
break;
}
case 'assistant.message': {
Expand Down Expand Up @@ -367,9 +369,21 @@ export function buildChatHistoryFromEvents(events: readonly SessionEvent[]): (Ch
break;
}
case 'tool.execution_complete': {
const responsePart = processToolExecutionComplete(event, pendingToolInvocations);
if (responsePart && !(responsePart instanceof ChatResponseThinkingProgressPart)) {
currentResponseParts.push(responsePart);
const [responsePart, toolCall] = processToolExecutionComplete(event, pendingToolInvocations) ?? [undefined, undefined];
if (responsePart && toolCall && !(responsePart instanceof ChatResponseThinkingProgressPart)) {
const editId = details?.toolIdEditMap ? details.toolIdEditMap[toolCall.toolCallId] : undefined;
const editedUris = getAffectedUrisForEditTool(toolCall);
if (isCopilotCliEditToolCall(toolCall) && editId && editedUris.length > 0) {
for (const uri of editedUris) {
currentResponseParts.push(new ChatResponseMarkdownPart('\n````\n'));
currentResponseParts.push(new ChatResponseCodeblockUriPart(uri, true, editId));
currentResponseParts.push(new ChatResponseMarkdownPart('\n````\n'));
currentResponseParts.push(new ChatResponseTextEditPart(uri, []));
currentResponseParts.push(new ChatResponseTextEditPart(uri, true));
Copy link
Collaborator Author

@DonJayamanne DonJayamanne Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-emit the edits with the undo stop ids

}
} else {
currentResponseParts.push(responsePart);
}
}
break;
}
Expand All @@ -393,27 +407,27 @@ function getRangeInPrompt(prompt: string, referencedName: string): [number, numb
return undefined;
}

export function processToolExecutionStart(event: ToolExecutionStartEvent, pendingToolInvocations: Map<string, ChatToolInvocationPart | ChatResponseThinkingProgressPart>): ChatToolInvocationPart | ChatResponseThinkingProgressPart | undefined {
export function processToolExecutionStart(event: ToolExecutionStartEvent, pendingToolInvocations: Map<string, [ChatToolInvocationPart | ChatResponseThinkingProgressPart, toolData: ToolCall]>): ChatToolInvocationPart | ChatResponseThinkingProgressPart | undefined {
const toolInvocation = createCopilotCLIToolInvocation(event.data as ToolCall);
if (toolInvocation) {
// Store pending invocation to update with result later
pendingToolInvocations.set(event.data.toolCallId, toolInvocation);
pendingToolInvocations.set(event.data.toolCallId, [toolInvocation, event.data as ToolCall]);
}
return toolInvocation;
}

export function processToolExecutionComplete(event: ToolExecutionCompleteEvent, pendingToolInvocations: Map<string, ChatToolInvocationPart | ChatResponseThinkingProgressPart>): ChatToolInvocationPart | ChatResponseThinkingProgressPart | undefined {
export function processToolExecutionComplete(event: ToolExecutionCompleteEvent, pendingToolInvocations: Map<string, [ChatToolInvocationPart | ChatResponseThinkingProgressPart, toolData: ToolCall]>): [ChatToolInvocationPart | ChatResponseThinkingProgressPart, toolData: ToolCall] | undefined {
const invocation = pendingToolInvocations.get(event.data.toolCallId);
pendingToolInvocations.delete(event.data.toolCallId);

if (invocation && invocation instanceof ChatToolInvocationPart) {
invocation.isComplete = true;
invocation.isError = !!event.data.error;
invocation.invocationMessage = event.data.error?.message || invocation.invocationMessage;
if (invocation && invocation[0] instanceof ChatToolInvocationPart) {
invocation[0].isComplete = true;
invocation[0].isError = !!event.data.error;
invocation[0].invocationMessage = event.data.error?.message || invocation[0].invocationMessage;
if (!event.data.success && (event.data.error?.code === 'rejected' || event.data.error?.code === 'denied')) {
invocation.isConfirmed = false;
invocation[0].isConfirmed = false;
} else {
invocation.isConfirmed = true;
invocation[0].isConfirmed = true;
}
}

Expand All @@ -423,7 +437,7 @@ export function processToolExecutionComplete(event: ToolExecutionCompleteEvent,
/**
* Creates a formatted tool invocation part for CopilotCLI tools
*/
export function createCopilotCLIToolInvocation(data: { toolCallId: string; toolName: string; arguments?: unknown }): ChatToolInvocationPart | ChatResponseThinkingProgressPart | undefined {
export function createCopilotCLIToolInvocation(data: { toolCallId: string; toolName: string; arguments?: unknown }, editId?: string): ChatToolInvocationPart | ChatResponseThinkingProgressPart | undefined {
if (!Object.hasOwn(ToolFriendlyNameAndHandlers, data.toolName)) {
const invocation = new ChatToolInvocationPart(data.toolName ?? 'unknown', data.toolCallId ?? '', false);
invocation.isConfirmed = false;
Expand All @@ -450,11 +464,11 @@ export function createCopilotCLIToolInvocation(data: { toolCallId: string; toolN
invocation.isConfirmed = false;
invocation.isComplete = false;

(formatter as Formatter)(invocation, toolCall);
(formatter as Formatter)(invocation, toolCall, editId);
return invocation;
}

type Formatter = (invocation: ChatToolInvocationPart, toolCall: ToolCall) => void;
type Formatter = (invocation: ChatToolInvocationPart, toolCall: ToolCall, editId?: string) => void;
type ToolCallFor<T extends ToolCall['toolName']> = Extract<ToolCall, { toolName: T }>;

const ToolFriendlyNameAndHandlers: { [K in ToolCall['toolName']]: [string, (invocation: ChatToolInvocationPart, toolCall: ToolCallFor<K>) => void] } = {
Expand Down Expand Up @@ -513,7 +527,7 @@ function formatViewToolInvocation(invocation: ChatToolInvocationPart, toolCall:
}
}

function formatStrReplaceEditorInvocation(invocation: ChatToolInvocationPart, toolCall: StringReplaceEditorTool): void {
function formatStrReplaceEditorInvocation(invocation: ChatToolInvocationPart, toolCall: StringReplaceEditorTool, editId?: string): void {
if (!toolCall.arguments.path) {
return;
}
Expand Down Expand Up @@ -554,7 +568,7 @@ function formatUndoEdit(invocation: ChatToolInvocationPart, toolCall: UndoEditTo
}
}

function formatEditToolInvocation(invocation: ChatToolInvocationPart, toolCall: EditTool): void {
function formatEditToolInvocation(invocation: ChatToolInvocationPart, toolCall: EditTool, editId?: string): void {
const args = toolCall.arguments;
const display = args.path ? formatUriForFileWidget(Uri.file(args.path)) : '';

Expand All @@ -564,7 +578,7 @@ function formatEditToolInvocation(invocation: ChatToolInvocationPart, toolCall:
}


function formatCreateToolInvocation(invocation: ChatToolInvocationPart, toolCall: CreateTool): void {
function formatCreateToolInvocation(invocation: ChatToolInvocationPart, toolCall: CreateTool, editId?: string): void {
const args = toolCall.arguments;
const display = args.path ? formatUriForFileWidget(Uri.file(args.path)) : '';

Expand Down
11 changes: 6 additions & 5 deletions src/extension/agents/copilotcli/common/test/copilotCLITools.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ import {
isCopilotCliEditToolCall,
processToolExecutionComplete,
processToolExecutionStart,
stripReminders
stripReminders,
ToolCall
} from '../copilotCLITools';

// Helper to extract invocation message text independent of MarkdownString vs string
Expand Down Expand Up @@ -160,21 +161,21 @@ describe('CopilotCLITools', () => {

describe('process tool execution lifecycle', () => {
it('marks tool invocation complete and confirmed on success', () => {
const pending = new Map<string, ChatToolInvocationPart | ChatResponseThinkingProgressPart>();
const pending = new Map<string, [ChatToolInvocationPart | ChatResponseThinkingProgressPart, toolData: ToolCall]>();
const startEvent: any = { type: 'tool.execution_start', data: { toolName: 'bash', toolCallId: 'bash-1', arguments: { command: 'echo hi' } } };
const part = processToolExecutionStart(startEvent, pending);
expect(part).toBeInstanceOf(ChatToolInvocationPart);
const completeEvent: any = { type: 'tool.execution_complete', data: { toolName: 'bash', toolCallId: 'bash-1', success: true } };
const completed = processToolExecutionComplete(completeEvent, pending) as ChatToolInvocationPart;
const [completed,] = processToolExecutionComplete(completeEvent, pending)! as [ChatToolInvocationPart, ToolCall];
expect(completed.isComplete).toBe(true);
expect(completed.isError).toBe(false);
expect(completed.isConfirmed).toBe(true);
});
it('marks tool invocation error and unconfirmed when denied', () => {
const pending = new Map<string, ChatToolInvocationPart | ChatResponseThinkingProgressPart>();
const pending = new Map<string, [ChatToolInvocationPart | ChatResponseThinkingProgressPart, toolData: ToolCall]>();
processToolExecutionStart({ type: 'tool.execution_start', data: { toolName: 'bash', toolCallId: 'bash-2', arguments: { command: 'rm *' } } } as any, pending);
const completeEvent: any = { type: 'tool.execution_complete', data: { toolName: 'bash', toolCallId: 'bash-2', success: false, error: { message: 'Denied', code: 'denied' } } };
const completed = processToolExecutionComplete(completeEvent, pending) as ChatToolInvocationPart;
const [completed,] = processToolExecutionComplete(completeEvent, pending)! as [ChatToolInvocationPart, ToolCall];
expect(completed.isComplete).toBe(true);
expect(completed.isError).toBe(true);
expect(completed.isConfirmed).toBe(false);
Expand Down
25 changes: 24 additions & 1 deletion src/extension/agents/copilotcli/node/copilotCli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { PermissionRequest } from './permissionHelpers';
import { ensureRipgrepShim } from './ripgrepShim';

const COPILOT_CLI_MODEL_MEMENTO_KEY = 'github.copilot.cli.sessionModel';
const COPILOT_CLI_REQUEST_MAP_KEY = 'github.copilot.cli.requestMap';
// Store last used Agent per workspace.
const COPILOT_CLI_AGENT_MEMENTO_KEY = 'github.copilot.cli.customAgent';
// Store last used Agent for a Session.
Expand Down Expand Up @@ -247,11 +248,15 @@ export interface ICopilotCLISDK {
readonly _serviceBrand: undefined;
getPackage(): Promise<typeof import('@github/copilot/sdk')>;
getAuthInfo(): Promise<NonNullable<SessionOptions['authInfo']>>;
getRequestId(sdkRequestId: string): RequestDetails['details'] | undefined;
setRequestId(sdkRequestId: string, details: { requestId: string; toolIdEditMap: Record<string, string> }): void;
getDefaultWorkingDirectory(): Promise<Uri | undefined>;
}

type RequestDetails = { details: { requestId: string; toolIdEditMap: Record<string, string> }; createdDateTime: number };
export class CopilotCLISDK implements ICopilotCLISDK {
declare _serviceBrand: undefined;
private requestMap: Record<string, RequestDetails> = {};

constructor(
@IVSCodeExtensionContext private readonly extensionContext: IVSCodeExtensionContext,
Expand All @@ -260,7 +265,25 @@ export class CopilotCLISDK implements ICopilotCLISDK {
@IInstantiationService protected readonly instantiationService: IInstantiationService,
@IAuthenticationService private readonly authentService: IAuthenticationService,
@IWorkspaceService private readonly workspaceService: IWorkspaceService,
) { }
) {
this.requestMap = this.extensionContext.workspaceState.get<Record<string, RequestDetails>>(COPILOT_CLI_REQUEST_MAP_KEY, {});
}

getRequestId(sdkRequestId: string): RequestDetails['details'] | undefined {
return this.requestMap[sdkRequestId]?.details;
}

setRequestId(sdkRequestId: string, details: { requestId: string; toolIdEditMap: Record<string, string> }): void {
this.requestMap[sdkRequestId] = { details, createdDateTime: Date.now() };
// Prune entries older than 7 days
const sevenDaysAgo = Date.now() - 7 * 24 * 60 * 60 * 1000;
for (const [key, value] of Object.entries(this.requestMap)) {
if (value.createdDateTime < sevenDaysAgo) {
delete this.requestMap[key];
}
}
this.extensionContext.workspaceState.update(COPILOT_CLI_REQUEST_MAP_KEY, this.requestMap);
}

public async getPackage(): Promise<typeof import('@github/copilot/sdk')> {
try {
Expand Down
Loading