Adds CacheController for cache invalidation

eamodio · eamodio · commit 3289d1797518 · 2025-11-24T12:35:10.000-05:00
- Replaces the `Cancellable` interface
diff --git a/src/env/node/git/sub-providers/commits.ts b/src/env/node/git/sub-providers/commits.ts
@@ -54,7 +54,7 @@ import { filterMap, first, join, last, some } from '../../../../system/iterable'
 import { Logger } from '../../../../system/logger';
 import { getLogScope } from '../../../../system/logger.scope';
 import { isFolderGlob, stripFolderGlob } from '../../../../system/path';
-import type { Cancellable } from '../../../../system/promiseCache';
+import type { CacheController } from '../../../../system/promiseCache';
 import { maybeStopWatch } from '../../../../system/stopwatch';
 import { createDisposable } from '../../../../system/unifiedDisposable';
 import type { CachedLog, TrackedGitDocument } from '../../../../trackers/trackedDocument';
@@ -183,7 +183,7 @@ export class CommitsGitSubProvider implements GitCommitsSubProvider {
 
 		const scope = getLogScope();
 
-		const getCore = async (cancellable?: Cancellable) => {
+		const getCore = async (cacheable?: CacheController) => {
 			try {
 				// Use for-each-ref with %(HEAD) to mark current branch with *
 				const result = await this.git.exec(
@@ -242,7 +242,7 @@ export class CommitsGitSubProvider implements GitCommitsSubProvider {
 
 				return { refs: refs };
 			} catch (ex) {
-				cancellable?.cancelled();
+				cacheable?.invalidate();
 				debugger;
 				if (isCancellationError(ex)) throw ex;
 
diff --git a/src/env/node/git/sub-providers/contributors.ts b/src/env/node/git/sub-providers/contributors.ts
@@ -14,7 +14,7 @@ import { log } from '../../../../system/decorators/log';
 import { Logger } from '../../../../system/logger';
 import { getLogScope } from '../../../../system/logger.scope';
 import { normalizePath } from '../../../../system/path';
-import type { Cancellable } from '../../../../system/promiseCache';
+import type { CacheController } from '../../../../system/promiseCache';
 import { createDisposable } from '../../../../system/unifiedDisposable';
 import type { Git } from '../git';
 import { gitConfigsLog } from '../git';
@@ -46,7 +46,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 
 		const scope = getLogScope();
 
-		const getCore = async (cancellable?: Cancellable): Promise<GitContributorsResult> => {
+		const getCore = async (cacheable?: CacheController): Promise<GitContributorsResult> => {
 			const contributors = new Map<string, GitContributor>();
 
 			try {
@@ -95,7 +95,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 
 				for await (const c of parser.parseAsync(stream)) {
 					if (signal?.aborted || cancellation?.isCancellationRequested) {
-						cancellable?.cancelled();
+						cacheable?.invalidate();
 						break;
 					}
 
@@ -176,7 +176,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 							: undefined,
 				};
 			} catch (ex) {
-				cancellable?.cancelled();
+				cacheable?.invalidate();
 				Logger.error(ex, scope);
 				debugger;
 
@@ -234,7 +234,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 			options = { ...options, all: true };
 		}
 
-		const getCore = async (cancellable?: Cancellable) => {
+		const getCore = async (cacheable?: CacheController) => {
 			try {
 				// eventually support `--group=author --group=trailer:co-authored-by`
 				const args = ['shortlog', '-s', '-e', '-n'];
@@ -262,7 +262,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 				const shortlog = parseShortlog(result.stdout, repoPath, await currentUserPromise);
 				return shortlog.contributors;
 			} catch (ex) {
-				cancellable?.cancelled();
+				cacheable?.invalidate();
 				Logger.error(ex, scope);
 				debugger;
 
diff --git a/src/env/node/git/sub-providers/remotes.ts b/src/env/node/git/sub-providers/remotes.ts
@@ -50,7 +50,7 @@ export class RemotesGitSubProvider extends RemotesGitProviderBase implements Git
 				);
 				return remotes;
 			} catch (ex) {
-				cancellable.cancelled();
+				cancellable.invalidate();
 				Logger.error(ex, scope);
 				return [];
 			}
diff --git a/src/env/node/git/sub-providers/tags.ts b/src/env/node/git/sub-providers/tags.ts
@@ -80,7 +80,7 @@ export class TagsGitSubProvider implements GitTagsSubProvider {
 
 				return { values: tags };
 			} catch (ex) {
-				cancellable.cancelled();
+				cancellable.invalidate();
 				Logger.error(ex, scope);
 				if (isCancellationError(ex)) throw ex;
 
diff --git a/src/plus/ai/aiProviderService.ts b/src/plus/ai/aiProviderService.ts
@@ -1101,7 +1101,7 @@ export class AIProviderService implements AIService, Disposable {
 					variables: result.data.variables as (keyof PromptTemplateContext<T>)[],
 				} satisfies PromptTemplate<T>;
 			} catch (ex) {
-				cancellable.cancelled();
+				cancellable.invalidate();
 				if (!(ex instanceof AuthenticationRequiredError)) {
 					debugger;
 					Logger.error(ex, scope, String(ex));
diff --git a/src/plus/integrations/providers/github/sub-providers/contributors.ts b/src/plus/integrations/providers/github/sub-providers/contributors.ts
@@ -12,7 +12,7 @@ import { isUserMatch } from '../../../../../git/utils/user.utils';
 import { log } from '../../../../../system/decorators/log';
 import { Logger } from '../../../../../system/logger';
 import { getLogScope } from '../../../../../system/logger.scope';
-import type { Cancellable } from '../../../../../system/promiseCache';
+import type { CacheController } from '../../../../../system/promiseCache';
 import type { GitHubGitProviderInternal } from '../githubGitProvider';
 
 export class ContributorsGitSubProvider implements GitContributorsSubProvider {
@@ -40,7 +40,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 
 		const scope = getLogScope();
 
-		const getCore = async (cancellable?: Cancellable): Promise<GitContributorsResult> => {
+		const getCore = async (cacheable?: CacheController): Promise<GitContributorsResult> => {
 			const contributors: GitContributor[] = [];
 
 			try {
@@ -195,7 +195,7 @@ export class ContributorsGitSubProvider implements GitContributorsSubProvider {
 					cancelled: cancellation?.isCancellationRequested ? { reason: 'cancelled' } : undefined,
 				};
 			} catch (ex) {
-				cancellable?.cancelled();
+				cacheable?.invalidate();
 				Logger.error(ex, scope);
 				debugger;
 
diff --git a/src/plus/integrations/providers/github/sub-providers/tags.ts b/src/plus/integrations/providers/github/sub-providers/tags.ts
@@ -92,7 +92,7 @@ export class TagsGitSubProvider implements GitTagsSubProvider {
 							cursor = result.paging.cursor;
 						}
 					} catch (ex) {
-						cancellable.cancelled();
+						cancellable.invalidate();
 						Logger.error(ex, scope);
 						debugger;
 
diff --git a/src/system/promiseCache.ts b/src/system/promiseCache.ts
@@ -7,8 +7,15 @@ interface CacheEntry<V> {
 	accessTTL: number | undefined;
 }
 
-export interface Cancellable {
-	cancelled(): void;
+export class CacheController {
+	#invalidated = false;
+	get invalidated(): boolean {
+		return this.#invalidated;
+	}
+
+	invalidate(): void {
+		this.#invalidated = true;
+	}
 }
 
 interface PromiseCacheOptions {
@@ -32,7 +39,7 @@ export class PromiseCache<K, V> {
 
 	async getOrCreate(
 		key: K,
-		factory: (cancellable: Cancellable) => Promise<V>,
+		factory: (cacheable: CacheController) => Promise<V>,
 		options?: {
 			/** TTL (time-to-live) in milliseconds since creation */
 			createTTL?: number;
@@ -56,10 +63,10 @@ export class PromiseCache<K, V> {
 			return entry.promise;
 		}
 
-		let cancelled = false;
-		const promise = factory({ cancelled: () => (cancelled = true) });
+		const cacheable = new CacheController();
+		const promise = factory(cacheable);
 		void promise.finally(() => {
-			if (cancelled) {
+			if (cacheable.invalidated) {
 				this.cache.delete(key);
 			}
 		});
@@ -152,15 +159,15 @@ export class PromiseMap<K, V> {
 	 * Gets a promise from the cache or creates a new one using the factory function.
 	 * Failed promises are automatically removed from the cache.
 	 */
-	getOrCreate(key: K, factory: (cancellable: Cancellable) => Promise<V>): Promise<V> {
+	getOrCreate(key: K, factory: (cacheable: CacheController) => Promise<V>): Promise<V> {
 		let promise = this.cache.get(key);
 		if (promise == null) {
-			let cancelled = false;
-			promise = factory({ cancelled: () => (cancelled = true) });
+			const cacheable = new CacheController();
+			promise = factory(cacheable);
 			// Automatically remove failed promises from the cache
 			promise.catch(() => this.cache.delete(key));
 			void promise.finally(() => {
-				if (cancelled) {
+				if (cacheable.invalidated) {
 					this.cache.delete(key);
 				}
 			});
@@ -283,7 +290,7 @@ export class RepoPromiseCacheMap<K, V> {
 	getOrCreate(
 		repoPath: string,
 		key: K,
-		factory: (cancellable: Cancellable) => Promise<V>,
+		factory: (cacheable: CacheController) => Promise<V>,
 		options?: {
 			/** TTL (time-to-live) in milliseconds since creation */
 			createTTL?: number;
@@ -358,7 +365,7 @@ export class RepoPromiseMap<K, V> {
 	 * @param key - The cache key within the repository (inner key)
 	 * @param factory - Factory function to create the value if not cached
 	 */
-	getOrCreate(repoPath: string, key: K, factory: (cancellable: Cancellable) => Promise<V>): Promise<V> {
+	getOrCreate(repoPath: string, key: K, factory: (cacheable: CacheController) => Promise<V>): Promise<V> {
 		let repoCache = this.cache.get(repoPath);
 		if (repoCache == null) {
 			repoCache = new PromiseMap<K, V>();

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ export class RemotesGitSubProvider extends RemotesGitProviderBase implements Git`
`50`	`50`	`);`
`51`	`51`	`return remotes;`
`52`	`52`	`} catch (ex) {`
`53`		`- cancellable.cancelled();`
	`53`	`+ cancellable.invalidate();`
`54`	`54`	`Logger.error(ex, scope);`
`55`	`55`	`return [];`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ export class TagsGitSubProvider implements GitTagsSubProvider {`
`92`	`92`	`cursor = result.paging.cursor;`
`93`	`93`	`}`
`94`	`94`	`} catch (ex) {`
`95`		`- cancellable.cancelled();`
	`95`	`+ cancellable.invalidate();`
`96`	`96`	`Logger.error(ex, scope);`
`97`	`97`	`debugger;`
`98`	`98`