Avoids gating/grouping w/ cancellation tokens

Author: eamodio

src/env/node/git/git.ts

@@ -33,9 +33,11 @@ import type { GitDir } from '../../../git/gitProvider';
 import type { GitDiffFilter } from '../../../git/models/diff';
 import { parseGitRemoteUrl } from '../../../git/parsers/remoteParser';
 import { isUncommitted, isUncommittedStaged, shortenRevision } from '../../../git/utils/revision.utils';
+import { getCancellationTokenId } from '../../../system/-webview/cancellation';
 import { configuration } from '../../../system/-webview/configuration';
 import { splitPath } from '../../../system/-webview/path';
 import { getHostEditorCommand } from '../../../system/-webview/vscode';
+import { getScopedCounter } from '../../../system/counter';
 import { log } from '../../../system/decorators/log';
 import { Logger } from '../../../system/logger';
 import { slowCallWarningThreshold } from '../../../system/logger.constants';
@@ -165,13 +167,7 @@ function defaultExceptionHandler(ex: Error, cwd: string | undefined, start?: [nu
 	throw ex;
 }
 
-let _uniqueCounterForStdin = 0;
-function getStdinUniqueKey(): number {
-	if (_uniqueCounterForStdin === Number.MAX_SAFE_INTEGER) {
-		_uniqueCounterForStdin = 0;
-	}
-	return _uniqueCounterForStdin++;
-}
+const uniqueCounterForStdin = getScopedCounter();
 
 type ExitCodeOnlyGitCommandOptions = GitCommandOptions & { exitCodeOnly: true };
 export type PushForceOptions = { withLease: true; ifIncludes?: boolean } | { withLease: false; ifIncludes?: never };
@@ -277,12 +273,12 @@ export class Git {
 
 		const gitCommand = `[${runOpts.cwd}] git ${runArgs.join(' ')}`;
 
-		const command = `${correlationKey !== undefined ? `${correlationKey}:` : ''}${
-			options?.stdin != null ? `${getStdinUniqueKey()}:` : ''
-		}${gitCommand}`;
+		const cacheKey = `${correlationKey !== undefined ? `${correlationKey}:` : ''}${
+			options?.stdin != null ? `${uniqueCounterForStdin.next()}:` : ''
+		}${cancellation != null ? `${getCancellationTokenId(cancellation)}:` : ''}${gitCommand}`;
 
 		let waiting;
-		let promise = this.pendingCommands.get(command);
+		let promise = this.pendingCommands.get(cacheKey);
 		if (promise == null) {
 			waiting = false;
 
@@ -309,11 +305,11 @@ export class Git {
 			}
 
 			promise = runSpawn<T>(await this.path(), runArgs, encoding ?? 'utf8', runOpts).finally(() => {
-				this.pendingCommands.delete(command);
+				this.pendingCommands.delete(cacheKey);
 				void disposeCancellation?.dispose();
 			});
 
-			this.pendingCommands.set(command, promise);
+			this.pendingCommands.set(cacheKey, promise);
 		} else {
 			waiting = true;
 			Logger.debug(`${getLoggableScopeBlockOverride('GIT')} ${gitCommand} ${GlyphChars.Dot} waiting...`);

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

@@ -26,7 +26,6 @@ import { createReference } from '../../../../git/utils/reference.utils';
 import { configuration } from '../../../../system/-webview/configuration';
 import { splitPath } from '../../../../system/-webview/path';
 import { gate } from '../../../../system/decorators/-webview/gate';
-import { defaultResolver } from '../../../../system/decorators/-webview/resolver';
 import { log } from '../../../../system/decorators/log';
 import { Logger } from '../../../../system/logger';
 import { getLogScope, setLogScopeExit } from '../../../../system/logger.scope';
@@ -565,7 +564,7 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 		}
 	}
 
-	@gate<StatusGitSubProvider['getStatus']>(rp => rp ?? '')
+	@gate()
 	@log()
 	async getStatus(repoPath: string | undefined, cancellation?: CancellationToken): Promise<GitStatus | undefined> {
 		if (repoPath == null) return undefined;
@@ -618,7 +617,7 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 		return this.getStatusForPathCore(repoPath, pathOrUri, { ...options, exact: false }, cancellation);
 	}
 
-	@gate<StatusGitSubProvider['getStatusForPathCore']>((...args) => defaultResolver(...args.slice(0, 3)))
+	@gate()
 	private async getStatusForPathCore(
 		repoPath: string,
 		pathOrUri: string | Uri,

src/git/models/commit.ts

@@ -309,9 +309,6 @@ export class GitCommit implements GitRevisionReference {
 					}
 
 					const pathspec = this.fileset?.filtered?.pathspec;
-					if (pathspec) {
-						debugger;
-					}
 					this.fileset = pathspec
 						? { files: undefined, filtered: { files: files, pathspec: pathspec } }
 						: { files: files };

src/plus/gk/subscriptionService.ts

@@ -1082,7 +1082,7 @@ export class SubscriptionService implements Disposable {
 		return result.value;
 	}
 
-	@gate<SubscriptionService['checkInAndValidateCore']>(s => s.account.id)
+	@gate<SubscriptionService['checkInAndValidateCore']>((s, _, orgId) => `${s.account.id}:${orgId}`)
 	@debug<SubscriptionService['checkInAndValidateCore']>({ args: { 0: s => s?.account?.label } })
 	private async checkInAndValidateCore(
 		session: AuthenticationSession,

src/plus/integrations/providers/github/sub-providers/status.ts

@@ -13,7 +13,7 @@ export class StatusGitSubProvider implements GitStatusSubProvider {
 		private readonly provider: GitHubGitProviderInternal,
 	) {}
 
-	@gate<StatusGitSubProvider['getStatus']>(rp => rp ?? '')
+	@gate()
 	@log()
 	async getStatus(repoPath: string | undefined, _cancellation?: CancellationToken): Promise<GitStatus | undefined> {
 		if (repoPath == null) return undefined;

src/plus/launchpad/launchpadProvider.ts

@@ -26,6 +26,7 @@ import {
 	getRepositoryIdentityForPullRequest,
 	isMaybeNonSpecificPullRequestSearchUrl,
 } from '../../git/utils/pullRequest.utils';
+import { getCancellationTokenId } from '../../system/-webview/cancellation';
 import { executeCommand, registerCommand } from '../../system/-webview/command';
 import { configuration } from '../../system/-webview/configuration';
 import { setContext } from '../../system/-webview/context';
@@ -648,10 +649,10 @@ export class LaunchpadProvider implements Disposable {
 	}
 
 	@gate<LaunchpadProvider['getCategorizedItems']>(
-		o =>
+		(o, c) =>
 			`${o?.force ?? false}|${
 				o?.search != null && typeof o.search !== 'string' ? o.search.map(pr => pr.url).join(',') : o?.search
-			}`,
+			}${getCancellationTokenId(c)}`,
 	)
 	@log<LaunchpadProvider['getCategorizedItems']>({ args: { 0: o => `force=${o?.force}`, 1: false } })
 	async getCategorizedItems(

src/system/-webview/cancellation.ts

@@ -1,5 +1,6 @@
 import type { CancellationToken, Disposable } from 'vscode';
 import { CancellationTokenSource } from 'vscode';
+import { getScopedCounter } from '../counter';
 
 export class TimedCancellationSource implements CancellationTokenSource, Disposable {
 	private readonly cancellation = new CancellationTokenSource();
@@ -23,3 +24,23 @@ export class TimedCancellationSource implements CancellationTokenSource, Disposa
 		return this.cancellation.token;
 	}
 }
+
+export function isCancellationToken(arg: unknown): arg is CancellationToken {
+	return (
+		typeof arg === 'object' && arg != null && 'isCancellationRequested' in arg && 'onCancellationRequested' in arg
+	);
+}
+
+const cancellationWeakmap = new WeakMap<CancellationToken, number>();
+const counter = getScopedCounter();
+
+export function getCancellationTokenId(cancellation: CancellationToken | undefined): string {
+	if (cancellation == null) return '';
+
+	let id = cancellationWeakmap.get(cancellation);
+	if (id == null) {
+		id = counter.next();
+		cancellationWeakmap.set(cancellation, id);
+	}
+	return String(id);
+}

src/system/decorators/-webview/resolver.ts

@@ -1,5 +1,6 @@
 import { Uri } from 'vscode';
 import { loggingJsonReplacer } from '@env/json';
+import { getCancellationTokenId, isCancellationToken } from '../../-webview/cancellation';
 import { isContainer } from '../../../container';
 import { isBranch } from '../../../git/models/branch';
 import { isCommit } from '../../../git/models/commit';
@@ -47,6 +48,7 @@ export function defaultResolver(...args: unknown[]): string {
 				return arg.toString();
 			}
 			if (isContainer(arg)) return '<container>';
+			if (isCancellationToken(arg)) return getCancellationTokenId(arg);
 
 			return JSON.stringify(arg, loggingJsonReplacer);
 	}