improve worktree creation progress #1869
Merged
+12
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the worktree creation progress reporting in the Copilot CLI chat sessions to use a task-based progress indicator instead of separate progress and warning calls.
- Modernizes progress reporting to use
stream.progress()with a callback task - Changes warning reporting to use
progress.report()within the task callback - Provides a more integrated UX by showing progress status during the asynchronous operation
Comment on lines
+45
to
58
| await stream.progress(vscode.l10n.t('Creating isolated worktree for session...'), async (progress) => { | ||
| try { | ||
| const worktreePath = await vscode.commands.executeCommand('git.createWorktreeWithDefaults') as string | undefined; | ||
| if (worktreePath) { | ||
| return vscode.l10n.t('Created isolated worktree at {0}', worktreePath); | ||
| } else { | ||
| progress.report(new vscode.ChatResponseWarningPart(vscode.l10n.t('Failed to create worktree for isolation, using default workspace directory'))); | ||
| } | ||
| } catch (error) { | ||
| progress.report(new vscode.ChatResponseWarningPart(vscode.l10n.t('Error creating worktree for isolation: {0}', error instanceof Error ? error.message : String(error)))); | ||
| } | ||
| } catch (error) { | ||
| stream.warning(vscode.l10n.t('Error creating worktree for isolation: {0}', error instanceof Error ? error.message : String(error))); | ||
| } | ||
| }); | ||
|
|
||
| return undefined; |
There was a problem hiding this comment.
The refactored code breaks the function's return value. Previously, createWorktreeIfNeeded would return the worktreePath string on success, which was then used at line 350 to store the worktree path. Now the function always returns undefined at line 58, even when a worktree is successfully created at line 47.
The worktree path needs to be captured from the progress callback and returned:
let worktreePath: string | undefined = undefined;
await stream.progress(vscode.l10n.t('Creating isolated worktree for session...'), async (progress) => {
try {
worktreePath = await vscode.commands.executeCommand('git.createWorktreeWithDefaults') as string | undefined;
if (worktreePath) {
return vscode.l10n.t('Created isolated worktree at {0}', worktreePath);
} else {
progress.report(new vscode.ChatResponseWarningPart(vscode.l10n.t('Failed to create worktree for isolation, using default workspace directory')));
}
} catch (error) {
progress.report(new vscode.ChatResponseWarningPart(vscode.l10n.t('Error creating worktree for isolation: {0}', error instanceof Error ? error.message : String(error))));
}
});
return worktreePath;
dmitrivMS
approved these changes
Nov 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.