Fixes #3914 clears annotations on split editors

Author: eamodio

CHANGELOG.md

@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ### Fixed
 
+- Fixes [#3914](https://github.com/gitkraken/vscode-gitlens/issues/#3914) - Attempting to clear a file annotation on a split file w/o the annotation no-ops
 - Fixes [#3911](https://github.com/gitkraken/vscode-gitlens/issues/#3911) - Avoid Home opening when first-install isn't reliable (e.g. GitPod)
 - Fixes [#3888](https://github.com/gitkraken/vscode-gitlens/issues/#3888) - Graph hover should disappear when right-clicking a row
 

src/annotations/annotationProvider.ts

@@ -18,9 +18,9 @@ export interface AnnotationState {
 	restoring?: boolean;
 }
 
-export type TextEditorCorrelationKey = string;
+export type TextEditorCorrelationKey = `${string}|${number}`;
 export function getEditorCorrelationKey(editor: TextEditor | undefined): TextEditorCorrelationKey {
-	return `${editor?.document.uri.toString()}|${editor?.viewColumn}`;
+	return `${editor?.document.uri.toString()}|${editor?.viewColumn ?? 0}`;
 }
 
 export type DidChangeStatusCallback = (e: { editor?: TextEditor; status?: AnnotationStatus }) => void;

src/annotations/fileAnnotationController.ts

@@ -273,8 +273,9 @@ export class FileAnnotationController implements Disposable {
 	}
 
 	@log<FileAnnotationController['clear']>({ args: { 0: e => e?.document.uri.toString(true) } })
-	clear(editor: TextEditor) {
+	clear(editor: TextEditor | undefined) {
 		if (this.isInWindowToggle()) return this.clearAll();
+		if (editor == null) return;
 
 		return this.clearCore(getEditorCorrelationKey(editor), true);
 	}

src/commands/toggleFileAnnotations.ts

@@ -6,7 +6,7 @@ import type { Container } from '../container';
 import { showGenericErrorMessage } from '../messages';
 import { Logger } from '../system/logger';
 import { command } from '../system/vscode/command';
-import { getEditorIfVisible, isTrackableTextEditor } from '../system/vscode/utils';
+import { getEditorIfVisible, getOtherVisibleTextEditors, isTrackableTextEditor } from '../system/vscode/utils';
 import { ActiveEditorCommand, EditorCommand } from './base';
 
 @command()
@@ -17,10 +17,17 @@ export class ClearFileAnnotationsCommand extends EditorCommand {
 
 	async execute(editor: TextEditor | undefined, _edit: TextEditorEdit, uri?: Uri): Promise<void> {
 		editor = getValidEditor(editor, uri);
-		if (editor == null) return;
 
 		try {
-			await this.container.fileAnnotations.clear(editor);
+			if (!editor || this.container.fileAnnotations.isInWindowToggle()) {
+				await this.container.fileAnnotations.clear(editor);
+				return;
+			}
+
+			// Clear split editors as though they were linked, because we can't handle the command states effectively
+			await Promise.allSettled(
+				[editor, ...getOtherVisibleTextEditors(editor)].map(e => this.container.fileAnnotations.clear(e)),
+			);
 		} catch (ex) {
 			Logger.error(ex, 'ClearFileAnnotationsCommand');
 			void showGenericErrorMessage('Unable to clear file annotations');
@@ -117,6 +124,35 @@ async function toggleFileAnnotations<TArgs extends ToggleFileAnnotationCommandAr
 			},
 			args.on,
 		));
+
+		// Should we link split editors together??
+		// if (!editor || container.fileAnnotations.isInWindowToggle()) {
+		// 	void (await container.fileAnnotations.toggle(
+		// 		editor,
+		// 		args.type,
+		// 		{
+		// 			selection: args.context?.selection ?? { line: editor?.selection.active.line },
+		// 			...args.context,
+		// 		},
+		// 		args.on,
+		// 	));
+
+		// 	return;
+		// }
+
+		// await Promise.allSettled(
+		// 	[editor, ...getOtherVisibleTextEditors(editor)].map(e =>
+		// 		container.fileAnnotations.toggle(
+		// 			e,
+		// 			args.type,
+		// 			{
+		// 				selection: args.context?.selection ?? { line: e?.selection.active.line },
+		// 				...args.context,
+		// 			},
+		// 			args.on,
+		// 		),
+		// 	),
+		// );
 	} catch (ex) {
 		Logger.error(ex, 'ToggleFileAnnotationsCommand');
 		void showGenericErrorMessage(`Unable to toggle file ${args.type} annotations`);

src/system/vscode/utils.ts

@@ -98,6 +98,12 @@ export function getEditorIfVisible(documentOrUri: TextDocument | Uri): TextEdito
 	return window.visibleTextEditors.find(e => e.document === documentOrUri);
 }
 
+export function getOtherVisibleTextEditors(editor: TextEditor): TextEditor[] {
+	return window.visibleTextEditors.filter(
+		e => e !== editor && e.document.uri.toString() === editor.document.uri.toString(),
+	);
+}
+
 export function getQuickPickIgnoreFocusOut() {
 	return !configuration.get('advanced.quickPick.closeOnFocusOut');
 }