Background - improve worktree changes calculation (#2685)

* Background - improve worktree changes calculation

* Adjust order

* Pull request feedback

Author: lszomoru

src/extension/chatSessions/vscode-node/chatSessionWorktreeServiceImpl.ts

@@ -16,7 +16,7 @@ import { coalesce } from '../../../util/vs/base/common/arrays';
 import { Disposable } from '../../../util/vs/base/common/lifecycle';
 import { derived, IObservable } from '../../../util/vs/base/common/observable';
 import * as path from '../../../util/vs/base/common/path';
-import { basename } from '../../../util/vs/base/common/resources';
+import { basename, isEqual } from '../../../util/vs/base/common/resources';
 import { ChatSessionWorktreeData, ChatSessionWorktreeProperties, IChatSessionWorktreeService } from '../common/chatSessionWorktreeService';
 
 const CHAT_SESSION_WORKTREE_MEMENTO_KEY = 'github.copilot.cli.sessionWorktrees';
@@ -233,24 +233,42 @@ export class ChatSessionWorktreeService extends Disposable implements IChatSessi
 	}
 
 	async getWorktreeChanges(sessionId: string): Promise<vscode.ChatSessionChangedFile[] | undefined> {
-		await this.gitService.initialize();
-
 		if (this._sessionWorktreeChanges.has(sessionId)) {
 			return this._sessionWorktreeChanges.get(sessionId);
 		}
 
+		// Check whether the session has an associated worktree
 		const worktreePath = this.getWorktreePath(sessionId);
-		const worktreeProperties = this.getWorktreeProperties(sessionId);
-
 		if (!worktreePath) {
+			return undefined;
+		}
+
+		// Ensure the initial repository discovery is completed and the repository
+		// states are initialized in the vscode.git extension. At this point, the
+		// worktrees may not have been opened yet so we may need to explicitly open
+		// them.
+		await this.gitService.initialize();
+
+		// Check whether the worktree belongs to any of the discovered repositories
+		const worktreePaths = this.gitService.repositories.map(r => r.worktrees.map(w => w.path)).flat();
+		if (!worktreePaths.some(p => isEqual(vscode.Uri.file(p), worktreePath))) {
 			this._sessionWorktreeChanges.set(sessionId, undefined);
 			return undefined;
 		}
 
+		// Open the worktree repository. This will initialize the repository state
+		// in the vscode.git extension but the source control provider will not be
+		// shown in the Source Control view since it is being hidden.
+		const repository = await this.gitService.getRepository(worktreePath);
+		if (!repository) {
+			this._sessionWorktreeChanges.set(sessionId, undefined);
+			return undefined;
+		}
+
+		const worktreeProperties = this.getWorktreeProperties(sessionId);
 		if (worktreeProperties === undefined || worktreeProperties.autoCommit === false) {
 			// These changes are staged in the worktree but not yet committed
-			const repository = await this.gitService.getRepository(worktreePath, false);
-			if (!repository?.changes) {
+			if (!repository.changes) {
 				this._sessionWorktreeChanges.set(sessionId, []);
 				return [];
 			}

src/platform/git/common/gitService.ts

@@ -9,7 +9,7 @@ import { Event } from '../../../util/vs/base/common/event';
 import { IObservable } from '../../../util/vs/base/common/observableInternal';
 import { equalsIgnoreCase } from '../../../util/vs/base/common/strings';
 import { URI } from '../../../util/vs/base/common/uri';
-import { Change, Commit, CommitShortStat, DiffChange, LogOptions, Ref, RefQuery } from '../vscode/git';
+import { Change, Commit, CommitShortStat, DiffChange, LogOptions, Ref, RefQuery, Worktree } from '../vscode/git';
 import { CancellationToken } from '../../../util/vs/base/common/cancellation';
 
 export interface RepoContext {
@@ -23,9 +23,9 @@ export interface RepoContext {
 	// to change every test.
 	readonly remoteFetchUrls?: Array<string | undefined>;
 	readonly remotes: string[];
+	readonly worktrees: Worktree[];
 	readonly changes: { mergeChanges: Change[]; indexChanges: Change[]; workingTree: Change[]; untrackedChanges: Change[] } | undefined;
 
-
 	readonly headBranchNameObs: IObservable<string | undefined>;
 	readonly headCommitHashObs: IObservable<string | undefined>;
 	readonly upstreamBranchNameObs: IObservable<string | undefined>;

src/platform/git/vscode/git.d.ts

@@ -78,6 +78,13 @@ export interface Remote {
 	readonly isReadOnly: boolean;
 }
 
+export interface Worktree {
+	readonly name: string;
+	readonly path: string;
+	readonly ref: string;
+	readonly detached: boolean;
+}
+
 export const enum Status {
 	INDEX_MODIFIED,
 	INDEX_ADDED,
@@ -125,6 +132,7 @@ export interface RepositoryState {
 	readonly refs: Ref[];
 	readonly remotes: Remote[];
 	readonly submodules: Submodule[];
+	readonly worktrees: Worktree[];
 	readonly rebaseCommit: Commit | undefined;
 
 	readonly mergeChanges: Change[];

src/platform/git/vscode/gitServiceImpl.ts

@@ -386,6 +386,7 @@ export class RepoContextImpl implements RepoContext {
 	public readonly isRebasing = this._repo.state.rebaseCommit !== null;
 	public readonly remotes = this._repo.state.remotes.map(r => r.name);
 	public readonly remoteFetchUrls = this._repo.state.remotes.map(r => r.fetchUrl);
+	public readonly worktrees = this._repo.state.worktrees;
 
 	public readonly changes = {
 		mergeChanges: this._repo.state.mergeChanges,

src/platform/test/node/simulationWorkspaceServices.ts

@@ -725,6 +725,7 @@ export class TestingGitService implements IGitService {
 					`https://github.com/microsoft/simuluation-test-${basename(workspaceFolderPath)}`
 				],
 				remotes: [],
+				worktrees: [],
 				changes: undefined,
 				headBranchNameObs: constObservable(undefined),
 				headCommitHashObs: constObservable(undefined),