Renames caches to types in git cache events

eamodio · eamodio · commit d0ffd63a09f1 · 2025-03-25T12:35:31.000-04:00
diff --git a/src/env/node/git/localGitProvider.ts b/src/env/node/git/localGitProvider.ts
@@ -982,7 +982,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 
 		try {
 			await this.git.checkout(repoPath, ref, options);
-			this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['branches', 'status'] });
+			this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['branches', 'status'] });
 		} catch (ex) {
 			const msg: string = ex?.toString() ?? '';
 			if (/overwritten by checkout/i.test(msg)) {
diff --git a/src/env/node/git/sub-providers/remotes.ts b/src/env/node/git/sub-providers/remotes.ts
@@ -80,7 +80,7 @@ export class RemotesGitSubProvider extends RemotesGitProviderBase implements Git
 	@log()
 	async addRemote(repoPath: string, name: string, url: string, options?: { fetch?: boolean }): Promise<void> {
 		await this.git.exec({ cwd: repoPath }, 'remote', 'add', options?.fetch ? '-f' : undefined, name, url);
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['remotes'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['remotes'] });
 	}
 
 	@gate()
@@ -100,13 +100,13 @@ export class RemotesGitSubProvider extends RemotesGitProviderBase implements Git
 	@log()
 	async pruneRemote(repoPath: string, name: string): Promise<void> {
 		await this.git.exec({ cwd: repoPath }, 'remote', 'prune', name);
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['remotes'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['remotes'] });
 	}
 
 	@gate()
 	@log()
 	async removeRemote(repoPath: string, name: string): Promise<void> {
 		await this.git.exec({ cwd: repoPath }, 'remote', 'remove', name);
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['remotes'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['remotes'] });
 	}
 }
diff --git a/src/env/node/git/sub-providers/stash.ts b/src/env/node/git/sub-providers/stash.ts
@@ -309,7 +309,7 @@ export class StashGitSubProvider implements GitStashSubProvider {
 	async deleteStash(repoPath: string, stashName: string, sha?: string): Promise<void> {
 		await this.deleteStashCore(repoPath, stashName, sha);
 		this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes'] });
 	}
 
 	private async deleteStashCore(repoPath: string, stashName: string, sha?: string): Promise<string | undefined> {
@@ -351,7 +351,7 @@ export class StashGitSubProvider implements GitStashSubProvider {
 		);
 
 		this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes'] });
 	}
 
 	@log<StashGitSubProvider['saveStash']>({ args: { 2: uris => uris?.length } })
@@ -364,7 +364,7 @@ export class StashGitSubProvider implements GitStashSubProvider {
 		if (!uris?.length) {
 			await this.git.stash__push(repoPath, message, options);
 			this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });
-			this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes', 'status'] });
+			this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes', 'status'] });
 			return;
 		}
 
@@ -397,7 +397,7 @@ export class StashGitSubProvider implements GitStashSubProvider {
 			pathspecs: pathspecs,
 			stdin: stdin,
 		});
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes', 'status'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes', 'status'] });
 	}
 
 	@gate()
@@ -414,6 +414,6 @@ export class StashGitSubProvider implements GitStashSubProvider {
 		await this.git.exec({ cwd: repoPath }, 'stash', 'store', ...args, id);
 
 		this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });
-		this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes'] });
+		this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes'] });
 	}
 }
diff --git a/src/env/node/git/sub-providers/worktrees.ts b/src/env/node/git/sub-providers/worktrees.ts
@@ -55,7 +55,7 @@ export class WorktreesGitSubProvider implements GitWorktreesSubProvider {
 
 			this.container.events.fire('git:cache:reset', {
 				repoPath: repoPath,
-				caches: options?.createBranch ? ['branches', 'worktrees'] : ['worktrees'],
+				types: options?.createBranch ? ['branches', 'worktrees'] : ['worktrees'],
 			});
 		} catch (ex) {
 			Logger.error(ex, scope);
@@ -241,7 +241,7 @@ export class WorktreesGitSubProvider implements GitWorktreesSubProvider {
 
 			throw new WorktreeDeleteError(undefined, ex);
 		} finally {
-			this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['worktrees'] });
+			this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['worktrees'] });
 		}
 	}
 }
diff --git a/src/eventBus.ts b/src/eventBus.ts
@@ -1,7 +1,7 @@
 import type { Disposable, Uri } from 'vscode';
 import { EventEmitter } from 'vscode';
 import type { CustomEditorIds, ViewIds, WebviewIds } from './constants.views';
-import type { GitCaches } from './git/gitProvider';
+import type { CachedGitTypes } from './git/gitProvider';
 import type { GitCommit } from './git/models/commit';
 import type { GitRevisionReference } from './git/models/reference';
 import type { RepositoryChange } from './git/models/repository';
@@ -33,7 +33,7 @@ interface FileSelectedEventArgs {
 export type GitCacheResetEvent = EventBusEvent<'git:cache:reset'>;
 interface GitCacheResetEventArgs {
 	readonly repoPath?: string;
-	readonly caches?: GitCaches[];
+	readonly types?: CachedGitTypes[];
 }
 
 /**
diff --git a/src/git/cache.ts b/src/git/cache.ts
@@ -4,7 +4,7 @@ import { configuration } from '../system/-webview/configuration';
 import { log } from '../system/decorators/log';
 import type { PromiseOrValue } from '../system/promise';
 import { PathTrie } from '../system/trie';
-import type { GitCaches, GitDir, PagedResult } from './gitProvider';
+import type { CachedGitTypes, GitDir, PagedResult } from './gitProvider';
 import type { GitBranch } from './models/branch';
 import type { GitContributor } from './models/contributor';
 import type { GitPausedOperationStatus } from './models/pausedOperationStatus';
@@ -41,7 +41,7 @@ export class GitCache implements Disposable {
 				}
 			}),
 			container.events.on('git:cache:reset', e =>
-				this.clearCaches(e.data.repoPath, ...(e.data.caches ?? emptyArray)),
+				this.clearCaches(e.data.repoPath, ...(e.data.types ?? emptyArray)),
 			),
 		);
 	}
@@ -118,44 +118,44 @@ export class GitCache implements Disposable {
 	}
 
 	@log({ singleLine: true })
-	clearCaches(repoPath: string | undefined, ...caches: GitCaches[]): void {
+	clearCaches(repoPath: string | undefined, ...types: CachedGitTypes[]): void {
 		const cachesToClear = new Set<Map<string, unknown> | PathTrie<unknown> | undefined>();
 
-		if (!caches.length || caches.includes('branches')) {
+		if (!types.length || types.includes('branches')) {
 			cachesToClear.add(this._branchCache);
 			cachesToClear.add(this._branchesCache);
 		}
 
-		if (!caches.length || caches.includes('contributors')) {
+		if (!types.length || types.includes('contributors')) {
 			cachesToClear.add(this._contributorsCache);
 		}
 
-		if (!caches.length || caches.includes('remotes')) {
+		if (!types.length || types.includes('remotes')) {
 			cachesToClear.add(this._remotesCache);
 			cachesToClear.add(this._bestRemotesCache);
 		}
 
-		if (!caches.length || caches.includes('providers')) {
+		if (!types.length || types.includes('providers')) {
 			cachesToClear.add(this._bestRemotesCache);
 		}
 
-		if (!caches.length || caches.includes('stashes')) {
+		if (!types.length || types.includes('stashes')) {
 			cachesToClear.add(this._stashesCache);
 		}
 
-		if (!caches.length || caches.includes('status')) {
+		if (!types.length || types.includes('status')) {
 			cachesToClear.add(this._pausedOperationStatusCache);
 		}
 
-		if (!caches.length || caches.includes('tags')) {
+		if (!types.length || types.includes('tags')) {
 			cachesToClear.add(this._tagsCache);
 		}
 
-		if (!caches.length || caches.includes('worktrees')) {
+		if (!types.length || types.includes('worktrees')) {
 			cachesToClear.add(this._worktreesCache);
 		}
 
-		if (!caches.length) {
+		if (!types.length) {
 			cachesToClear.add(this._repoInfoCache);
 			cachesToClear.add(this._trackedPaths);
 		}
diff --git a/src/git/gitProvider.ts b/src/git/gitProvider.ts
@@ -34,7 +34,7 @@ import type { RemoteProvider } from './remotes/remoteProvider';
 import type { GitGraphSearch } from './search';
 import type { BranchSortOptions, TagSortOptions } from './utils/-webview/sorting';
 
-export type GitCaches =
+export type CachedGitTypes =
 	| 'branches'
 	| 'contributors'
 	| 'providers'
@@ -43,8 +43,6 @@ export type GitCaches =
 	| 'status'
 	| 'tags'
 	| 'worktrees';
-export type GitRepositoryCaches = Extract<GitCaches, 'branches' | 'remotes'>;
-export const gitRepositoryCacheKeys = new Set<GitRepositoryCaches>(['branches', 'remotes']);
 
 export interface GitDir {
 	readonly uri: Uri;
diff --git a/src/git/gitProviderService.ts b/src/git/gitProviderService.ts
@@ -39,8 +39,8 @@ import type { Deferred } from '../system/promise';
 import { asSettled, defer, getDeferredPromiseIfPending, getSettledValue } from '../system/promise';
 import { VisitedPathsTrie } from '../system/trie';
 import type {
+	CachedGitTypes,
 	GitBranchesSubProvider,
-	GitCaches,
 	GitCommitsSubProvider,
 	GitConfigSubProvider,
 	GitContributorsSubProvider,
@@ -1352,8 +1352,8 @@ export class GitProviderService implements Disposable {
 	}
 
 	@log({ singleLine: true })
-	resetCaches(...caches: GitCaches[]): void {
-		this.container.events.fire('git:cache:reset', { caches: caches });
+	resetCaches(...types: CachedGitTypes[]): void {
+		this.container.events.fire('git:cache:reset', { types: types });
 	}
 
 	@log<GitProviderService['excludeIgnoredUris']>({ args: { 1: uris => uris.length } })
diff --git a/src/git/models/repository.ts b/src/git/models/repository.ts
@@ -291,7 +291,7 @@ export class Repository implements Disposable {
 		disposables.push(
 			this.container.events.on('git:cache:reset', e => {
 				if (!e.data.repoPath || e.data.repoPath === this.path) {
-					if (e.data.caches?.includes('providers')) {
+					if (e.data.types?.includes('providers')) {
 						this.fireChange(RepositoryChange.RemoteProviders);
 					}
 				}

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ export class RemotesGitSubProvider extends RemotesGitProviderBase implements Git`
`80`	`80`	`@log()`
`81`	`81`	`async addRemote(repoPath: string, name: string, url: string, options?: { fetch?: boolean }): Promise<void> {`
`82`	`82`	`await this.git.exec({ cwd: repoPath }, 'remote', 'add', options?.fetch ? '-f' : undefined, name, url);`
`83`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['remotes'] });`
	`83`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['remotes'] });`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`@gate()`
`@@ -100,13 +100,13 @@ export class RemotesGitSubProvider extends RemotesGitProviderBase implements Git`
`100`	`100`	`@log()`
`101`	`101`	`async pruneRemote(repoPath: string, name: string): Promise<void> {`
`102`	`102`	`await this.git.exec({ cwd: repoPath }, 'remote', 'prune', name);`
`103`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['remotes'] });`
	`103`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['remotes'] });`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`@gate()`
`107`	`107`	`@log()`
`108`	`108`	`async removeRemote(repoPath: string, name: string): Promise<void> {`
`109`	`109`	`await this.git.exec({ cwd: repoPath }, 'remote', 'remove', name);`
`110`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['remotes'] });`
	`110`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['remotes'] });`
`111`	`111`	`}`
`112`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -309,7 +309,7 @@ export class StashGitSubProvider implements GitStashSubProvider {`
`309`	`309`	`async deleteStash(repoPath: string, stashName: string, sha?: string): Promise<void> {`
`310`	`310`	`await this.deleteStashCore(repoPath, stashName, sha);`
`311`	`311`	`this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });`
`312`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes'] });`
	`312`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes'] });`
`313`	`313`	`}`
`314`	`314`
`315`	`315`	`private async deleteStashCore(repoPath: string, stashName: string, sha?: string): Promise<string \| undefined> {`
`@@ -351,7 +351,7 @@ export class StashGitSubProvider implements GitStashSubProvider {`
`351`	`351`	`);`
`352`	`352`
`353`	`353`	`this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });`
`354`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes'] });`
	`354`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes'] });`
`355`	`355`	`}`
`356`	`356`
`357`	`357`	`@log<StashGitSubProvider['saveStash']>({ args: { 2: uris => uris?.length } })`
`@@ -364,7 +364,7 @@ export class StashGitSubProvider implements GitStashSubProvider {`
`364`	`364`	`if (!uris?.length) {`
`365`	`365`	`await this.git.stash__push(repoPath, message, options);`
`366`	`366`	`this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });`
`367`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes', 'status'] });`
	`367`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes', 'status'] });`
`368`	`368`	`return;`
`369`	`369`	`}`
`370`	`370`
`@@ -397,7 +397,7 @@ export class StashGitSubProvider implements GitStashSubProvider {`
`397`	`397`	`pathspecs: pathspecs,`
`398`	`398`	`stdin: stdin,`
`399`	`399`	`});`
`400`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes', 'status'] });`
	`400`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes', 'status'] });`
`401`	`401`	`}`
`402`	`402`
`403`	`403`	`@gate()`
`@@ -414,6 +414,6 @@ export class StashGitSubProvider implements GitStashSubProvider {`
`414`	`414`	`await this.git.exec({ cwd: repoPath }, 'stash', 'store', ...args, id);`
`415`	`415`
`416`	`416`	`this.container.events.fire('git:repo:change', { repoPath: repoPath, changes: [RepositoryChange.Stash] });`
`417`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['stashes'] });`
	`417`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['stashes'] });`
`418`	`418`	`}`
`419`	`419`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ export class WorktreesGitSubProvider implements GitWorktreesSubProvider {`
`55`	`55`
`56`	`56`	`this.container.events.fire('git:cache:reset', {`
`57`	`57`	`repoPath: repoPath,`
`58`		`- caches: options?.createBranch ? ['branches', 'worktrees'] : ['worktrees'],`
	`58`	`+ types: options?.createBranch ? ['branches', 'worktrees'] : ['worktrees'],`
`59`	`59`	`});`
`60`	`60`	`} catch (ex) {`
`61`	`61`	`Logger.error(ex, scope);`
`@@ -241,7 +241,7 @@ export class WorktreesGitSubProvider implements GitWorktreesSubProvider {`
`241`	`241`
`242`	`242`	`throw new WorktreeDeleteError(undefined, ex);`
`243`	`243`	`} finally {`
`244`		`- this.container.events.fire('git:cache:reset', { repoPath: repoPath, caches: ['worktrees'] });`
	`244`	`+ this.container.events.fire('git:cache:reset', { repoPath: repoPath, types: ['worktrees'] });`
`245`	`245`	`}`
`246`	`246`	`}`
`247`	`247`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import { configuration } from '../system/-webview/configuration';`
`4`	`4`	`import { log } from '../system/decorators/log';`
`5`	`5`	`import type { PromiseOrValue } from '../system/promise';`
`6`	`6`	`import { PathTrie } from '../system/trie';`
`7`		`-import type { GitCaches, GitDir, PagedResult } from './gitProvider';`
	`7`	`+import type { CachedGitTypes, GitDir, PagedResult } from './gitProvider';`
`8`	`8`	`import type { GitBranch } from './models/branch';`
`9`	`9`	`import type { GitContributor } from './models/contributor';`
`10`	`10`	`import type { GitPausedOperationStatus } from './models/pausedOperationStatus';`
`@@ -41,7 +41,7 @@ export class GitCache implements Disposable {`
`41`	`41`	`}`
`42`	`42`	`}),`
`43`	`43`	`container.events.on('git:cache:reset', e =>`
`44`		`- this.clearCaches(e.data.repoPath, ...(e.data.caches ?? emptyArray)),`
	`44`	`+ this.clearCaches(e.data.repoPath, ...(e.data.types ?? emptyArray)),`
`45`	`45`	`),`
`46`	`46`	`);`
`47`	`47`	`}`
`@@ -118,44 +118,44 @@ export class GitCache implements Disposable {`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`@log({ singleLine: true })`
`121`		`- clearCaches(repoPath: string \| undefined, ...caches: GitCaches[]): void {`
	`121`	`+ clearCaches(repoPath: string \| undefined, ...types: CachedGitTypes[]): void {`
`122`	`122`	`const cachesToClear = new Set<Map<string, unknown> \| PathTrie<unknown> \| undefined>();`
`123`	`123`
`124`		`- if (!caches.length \|\| caches.includes('branches')) {`
	`124`	`+ if (!types.length \|\| types.includes('branches')) {`
`125`	`125`	`cachesToClear.add(this._branchCache);`
`126`	`126`	`cachesToClear.add(this._branchesCache);`
`127`	`127`	`}`
`128`	`128`
`129`		`- if (!caches.length \|\| caches.includes('contributors')) {`
	`129`	`+ if (!types.length \|\| types.includes('contributors')) {`
`130`	`130`	`cachesToClear.add(this._contributorsCache);`
`131`	`131`	`}`
`132`	`132`
`133`		`- if (!caches.length \|\| caches.includes('remotes')) {`
	`133`	`+ if (!types.length \|\| types.includes('remotes')) {`
`134`	`134`	`cachesToClear.add(this._remotesCache);`
`135`	`135`	`cachesToClear.add(this._bestRemotesCache);`
`136`	`136`	`}`
`137`	`137`
`138`		`- if (!caches.length \|\| caches.includes('providers')) {`
	`138`	`+ if (!types.length \|\| types.includes('providers')) {`
`139`	`139`	`cachesToClear.add(this._bestRemotesCache);`
`140`	`140`	`}`
`141`	`141`
`142`		`- if (!caches.length \|\| caches.includes('stashes')) {`
	`142`	`+ if (!types.length \|\| types.includes('stashes')) {`
`143`	`143`	`cachesToClear.add(this._stashesCache);`
`144`	`144`	`}`
`145`	`145`
`146`		`- if (!caches.length \|\| caches.includes('status')) {`
	`146`	`+ if (!types.length \|\| types.includes('status')) {`
`147`	`147`	`cachesToClear.add(this._pausedOperationStatusCache);`
`148`	`148`	`}`
`149`	`149`
`150`		`- if (!caches.length \|\| caches.includes('tags')) {`
	`150`	`+ if (!types.length \|\| types.includes('tags')) {`
`151`	`151`	`cachesToClear.add(this._tagsCache);`
`152`	`152`	`}`
`153`	`153`
`154`		`- if (!caches.length \|\| caches.includes('worktrees')) {`
	`154`	`+ if (!types.length \|\| types.includes('worktrees')) {`
`155`	`155`	`cachesToClear.add(this._worktreesCache);`
`156`	`156`	`}`
`157`	`157`
`158`		`- if (!caches.length) {`
	`158`	`+ if (!types.length) {`
`159`	`159`	`cachesToClear.add(this._repoInfoCache);`
`160`	`160`	`cachesToClear.add(this._trackedPaths);`
`161`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -291,7 +291,7 @@ export class Repository implements Disposable {`
`291`	`291`	`disposables.push(`
`292`	`292`	`this.container.events.on('git:cache:reset', e => {`
`293`	`293`	`if (!e.data.repoPath \|\| e.data.repoPath === this.path) {`
`294`		`- if (e.data.caches?.includes('providers')) {`
	`294`	`+ if (e.data.types?.includes('providers')) {`
`295`	`295`	`this.fireChange(RepositoryChange.RemoteProviders);`
`296`	`296`	`}`
`297`	`297`	`}`