Changes Git index handling with disposable pattern

Author: eamodio

src/env/node/git/sub-providers/patch.ts

@@ -1,5 +1,3 @@
-import { promises as fs } from 'fs';
-import { tmpdir } from 'os';
 import { window } from 'vscode';
 import type { Container } from '../../../../container';
 import { CancellationError } from '../../../../errors';
@@ -17,7 +15,6 @@ import type { GitCommit } from '../../../../git/models/commit';
 import { log } from '../../../../system/decorators/log';
 import { Logger } from '../../../../system/logger';
 import { getLogScope } from '../../../../system/logger.scope';
-import { joinPaths } from '../../../../system/path';
 import type { Git } from '../git';
 import type { LocalGitProvider } from '../localGitProvider';
 
@@ -175,40 +172,10 @@ export class PatchGitSubProvider implements GitPatchSubProvider {
 		}
 
 		// Create a temporary index file
-		const tempDir = await fs.mkdtemp(joinPaths(tmpdir(), 'gl-'));
-		const tempIndex = joinPaths(tempDir, 'index');
+		await using disposableIndex = await this.provider.staging!.createTemporaryIndex(repoPath, baseRef);
+		const { env } = disposableIndex;
 
 		try {
-			// Tell Git to use our soon to be created index file
-			const env = { GIT_INDEX_FILE: tempIndex };
-
-			// Create the temp index file from a base ref/sha
-
-			// Get the tree of the base
-			const newIndex = await this.git.exec<string>(
-				{
-					cwd: repoPath,
-					env: env,
-				},
-				'ls-tree',
-				'-z',
-				'-r',
-				'--full-name',
-				baseRef,
-			);
-
-			// Write the tree to our temp index
-			await this.git.exec<string>(
-				{
-					cwd: repoPath,
-					env: env,
-					stdin: newIndex,
-				},
-				'update-index',
-				'-z',
-				'--index-info',
-			);
-
 			// Apply the patch to our temp index, without touching the working directory
 			await this.git.apply2(repoPath, { env: env, stdin: contents }, '--cached');
 
@@ -245,13 +212,6 @@ export class PatchGitSubProvider implements GitPatchSubProvider {
 			debugger;
 
 			throw ex;
-		} finally {
-			// Delete the temporary index file
-			try {
-				await fs.rm(tempDir, { recursive: true });
-			} catch (_ex) {
-				debugger;
-			}
 		}
 	}
 

src/env/node/git/sub-providers/staging.ts

@@ -1,8 +1,14 @@
+import { promises as fs } from 'fs';
+import { tmpdir } from 'os';
 import type { Uri } from 'vscode';
 import type { Container } from '../../../../container';
-import type { GitStagingSubProvider } from '../../../../git/gitProvider';
+import type { DisposableTemporaryGitIndex, GitStagingSubProvider } from '../../../../git/gitProvider';
 import { splitPath } from '../../../../system/-webview/path';
 import { log } from '../../../../system/decorators/log';
+import { Logger } from '../../../../system/logger';
+import { joinPaths } from '../../../../system/path';
+import { mixinAsyncDisposable } from '../../../../system/unifiedDisposable';
+import { scope } from '../../../../webviews/commitDetails/protocol';
 import type { Git } from '../git';
 
 export class StagingGitSubProvider implements GitStagingSubProvider {
@@ -11,6 +17,68 @@ export class StagingGitSubProvider implements GitStagingSubProvider {
 		private readonly git: Git,
 	) {}
 
+	@log()
+	async createTemporaryIndex(repoPath: string, baseRef: string): Promise<DisposableTemporaryGitIndex> {
+		// Create a temporary index file
+		const tempDir = await fs.mkdtemp(joinPaths(tmpdir(), 'gl-'));
+		const tempIndex = joinPaths(tempDir, 'index');
+
+		async function dispose() {
+			// Delete the temporary index file
+			try {
+				await fs.rm(tempDir, { recursive: true });
+			} catch (_ex) {
+				debugger;
+			}
+		}
+
+		try {
+			// Tell Git to use our soon to be created index file
+			const env = { GIT_INDEX_FILE: tempIndex };
+
+			// Create the temp index file from a base ref/sha
+
+			// Get the tree of the base
+			const newIndex = await this.git.exec<string>(
+				{
+					cwd: repoPath,
+					env: env,
+				},
+				'ls-tree',
+				'-z',
+				'-r',
+				'--full-name',
+				baseRef,
+			);
+
+			// Write the tree to our temp index
+			await this.git.exec<string>(
+				{
+					cwd: repoPath,
+					env: env,
+					stdin: newIndex,
+				},
+				'update-index',
+				'-z',
+				'--index-info',
+			);
+
+			return mixinAsyncDisposable(
+				{
+					path: tempIndex,
+					env: { GIT_INDEX_FILE: tempIndex },
+				},
+				dispose,
+			);
+		} catch (ex) {
+			Logger.error(ex, scope);
+			debugger;
+
+			void dispose();
+			throw ex;
+		}
+	}
+
 	@log()
 	async stageFile(repoPath: string, pathOrUri: string | Uri, options?: { intentToAdd?: boolean }): Promise<void> {
 		await this.git.add(

src/git/gitProvider.ts

@@ -5,6 +5,7 @@ import type { GitConfigKeys } from '../constants';
 import type { SearchQuery } from '../constants.search';
 import type { Features } from '../features';
 import type { HostingIntegration } from '../plus/integrations/integration';
+import type { UnifiedAsyncDisposable } from '../system/unifiedDisposable';
 import type { GitUri } from './gitUri';
 import type { GitBlame, GitBlameLine } from './models/blame';
 import type { GitBranch } from './models/branch';
@@ -521,7 +522,13 @@ export interface GitRemotesSubProvider {
 	setRemoteAsDefault(repoPath: string, name: string, value?: boolean): Promise<void>;
 }
 
+export interface DisposableTemporaryGitIndex extends UnifiedAsyncDisposable {
+	path: string;
+	env: { GIT_INDEX_FILE: string };
+}
+
 export interface GitStagingSubProvider {
+	createTemporaryIndex(repoPath: string, baseRef: string): Promise<DisposableTemporaryGitIndex>;
 	stageFile(repoPath: string, pathOrUri: string | Uri, options?: { intentToAdd?: boolean }): Promise<void>;
 	stageFiles(repoPath: string, pathOrUri: string[] | Uri[], options?: { intentToAdd?: boolean }): Promise<void>;
 	stageDirectory(repoPath: string, directoryOrUri: string | Uri, options?: { intentToAdd?: boolean }): Promise<void>;

src/system/unifiedDisposable.ts

@@ -28,6 +28,18 @@ export function createAsyncDisposable(
 	};
 }
 
-export function mixinDisposable<T extends object>(obj: T, dispose: () => void): T & UnifiedDisposable {
-	return { ...obj, ...createDisposable(dispose) };
+export function mixinDisposable<T extends object>(
+	obj: T,
+	dispose: () => void,
+	options?: { once?: boolean },
+): T & UnifiedDisposable {
+	return { ...obj, ...createDisposable(dispose, options) };
+}
+
+export function mixinAsyncDisposable<T extends object>(
+	obj: T,
+	dispose: () => Promise<any>,
+	options?: { once?: boolean },
+): T & UnifiedAsyncDisposable {
+	return { ...obj, ...createAsyncDisposable(dispose, options) };
 }