Fixes #2663 better debouncing of text change events

Author: eamodio

CHANGELOG.md

@@ -42,6 +42,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ### Fixed
 
+- Fixes [#2663](https://github.com/gitkraken/vscode-gitlens/issues/2663) - Debounce bug: file blame isn't cleared when editing document while text in output window changes
 - Fixes [#3050](https://github.com/gitkraken/vscode-gitlens/issues/3050) - Opening revision of a renamed file is broken
 - Fixes [#3019](https://github.com/gitkraken/vscode-gitlens/issues/3019) - Commits Views not working
 - Fixes [#3026](https://github.com/gitkraken/vscode-gitlens/issues/3026) - Gitlens stopped working in sub-repositories

src/system/function.ts

@@ -12,7 +12,11 @@ interface PropOfValue {
 	value: string | undefined;
 }
 
-export function debounce<T extends (...args: any[]) => ReturnType<T>>(fn: T, wait: number): Deferrable<T> {
+export function debounce<T extends (...args: any[]) => ReturnType<T>>(
+	fn: T,
+	wait: number,
+	aggregator?: (prevArgs: Parameters<T>, nextArgs: Parameters<T>) => Parameters<T>,
+): Deferrable<T> {
 	let lastArgs: Parameters<T>;
 	let lastCallTime: number | undefined;
 	let lastThis: ThisType<T>;
@@ -77,7 +81,12 @@ export function debounce<T extends (...args: any[]) => ReturnType<T>>(fn: T, wai
 		const time = Date.now();
 		const isInvoking = shouldInvoke(time);
 
-		lastArgs = args;
+		if (aggregator != null && lastArgs) {
+			lastArgs = aggregator(lastArgs, args);
+		} else {
+			lastArgs = args;
+		}
+
 		// eslint-disable-next-line @typescript-eslint/no-this-alias
 		lastThis = this;
 		lastCallTime = time;

src/trackers/documentTracker.ts

@@ -77,8 +77,7 @@ export class DocumentTracker<T> implements Disposable {
 			once(container.onReady)(this.onReady, this),
 			configuration.onDidChange(this.onConfigurationChanged, this),
 			window.onDidChangeActiveTextEditor(this.onActiveTextEditorChanged, this),
-			// window.onDidChangeVisibleTextEditors(debounce(this.onVisibleEditorsChanged, 5000), this),
-			workspace.onDidChangeTextDocument(debounce(this.onTextDocumentChanged, 50), this),
+			workspace.onDidChangeTextDocument(this.onTextDocumentChanged, this),
 			workspace.onDidCloseTextDocument(this.onTextDocumentClosed, this),
 			workspace.onDidSaveTextDocument(this.onTextDocumentSaved, this),
 			this.container.git.onDidChangeRepositories(this.onRepositoriesChanged, this),
@@ -170,10 +169,39 @@ export class DocumentTracker<T> implements Disposable {
 		}
 	}
 
-	private async onTextDocumentChanged(e: TextDocumentChangeEvent) {
+	private debouncedTextDocumentChanges = new WeakMap<
+		TextDocument,
+		Deferrable<Parameters<typeof workspace.onDidChangeTextDocument>[0]>
+	>();
+
+	private onTextDocumentChanged(e: TextDocumentChangeEvent) {
 		const { scheme } = e.document.uri;
 		if (!this.container.git.supportedSchemes.has(scheme)) return;
 
+		let debouncedChange = this.debouncedTextDocumentChanges.get(e.document);
+		if (debouncedChange == null) {
+			debouncedChange = debounce(
+				e => this.onTextDocumentChangedCore(e),
+				50,
+				([prev]: [TextDocumentChangeEvent], [next]: [TextDocumentChangeEvent]) => {
+					return [
+						{
+							...next,
+							// Aggregate content changes
+							contentChanges: [...prev.contentChanges, ...next.contentChanges],
+						} satisfies TextDocumentChangeEvent,
+					];
+				},
+			);
+			this.debouncedTextDocumentChanges.set(e.document, debouncedChange);
+		}
+
+		debouncedChange(e);
+	}
+
+	private async onTextDocumentChangedCore(e: TextDocumentChangeEvent) {
+		this.debouncedTextDocumentChanges.delete(e.document);
+
 		const doc = await (this._documentMap.get(e.document) ?? this.addCore(e.document));
 		doc.refresh('doc-changed');