Fixes #4831 refines rebase editor reveal behavior

 - Replaces `never` and `onOpen` reveal behaviors with a new `onDoubleClick` default to reduce automatic UI jumps
 - Ensures the commit graph or details view opens beside the rebase editor for a better side-by-side experience
 - Updates selection logic to properly notify the host when interacting with commit entries
 - Improves graph command handling to better manage view columns and existing panel visibility

Author: eamodio

docs/telemetry-events.md

@@ -2985,7 +2985,7 @@ void
   'context.ascending': boolean,
   'context.config.openOnPausedRebase': boolean | 'interactive',
   'context.config.ordering': 'asc' | 'desc',
-  'context.config.revealBehavior': 'never' | 'onOpen' | 'onSelection',
+  'context.config.revealBehavior': 'onDoubleClick' | 'onSelection',
   'context.config.revealLocation': 'graph' | 'inspect',
   'context.webview.host': 'view' | 'editor',
   'context.webview.id': string,

package.json

@@ -3757,18 +3757,16 @@
 					},
 					"gitlens.rebaseEditor.revealBehavior": {
 						"type": "string",
-						"default": "onOpen",
+						"default": "onDoubleClick",
 						"enum": [
-							"never",
-							"onOpen",
+							"onDoubleClick",
 							"onSelection"
 						],
 						"enumDescriptions": [
-							"Never automatically reveals commits",
-							"Automatically reveals commits only when opening the editor",
-							"Automatically reveals commits when selection changes"
+							"Automatically reveals commits when double-clicking on a row",
+							"Automatically reveals commits when selection changes or when double-clicking on a row"
 						],
-						"markdownDescription": "Specifies when to automatically reveal commits in the preferred location",
+						"markdownDescription": "Specifies when to automatically reveal commits in the `#gitlens.rebaseEditor.revealLocation#` location",
 						"scope": "window",
 						"order": 20
 					}

src/config.ts

@@ -668,7 +668,7 @@ interface RebaseEditorConfig {
 	readonly openOnPausedRebase: boolean | 'interactive';
 	readonly ordering: 'asc' | 'desc';
 	readonly revealLocation: 'graph' | 'inspect';
-	readonly revealBehavior: 'never' | 'onOpen' | 'onSelection';
+	readonly revealBehavior: 'onDoubleClick' | 'onSelection';
 }
 
 export type RemotesConfig =

src/webviews/apps/rebase/rebase.ts

@@ -209,6 +209,15 @@ export class GlRebaseEditor extends GlAppHost<State, RebaseStateProvider> {
 			if (!this.selectedIds.has(id)) {
 				this.selectedIds = new Set([id]);
 				this.anchoredEntryId = id;
+
+				// Notify host of selection change (only for commit entries)
+				const sortedIndex = this._idToSortedIndex.get(id) ?? -1;
+				if (sortedIndex !== -1) {
+					const entry = this._sortedEntries[sortedIndex];
+					if (isCommitEntry(entry)) {
+						this._ipc.sendCommand(UpdateSelectionCommand, { sha: entry.sha });
+					}
+				}
 				return;
 			}
 

src/webviews/plus/graph/registration.ts

@@ -30,8 +30,8 @@ export type GraphWebviewShowingArgs = [
 ];
 
 export type ShowInCommitGraphCommandArgs =
-	| { ref: GitReference; preserveFocus?: boolean; source?: Source }
-	| { repository: Repository; search: SearchQuery; preserveFocus?: boolean }
+	| { ref: GitReference; preserveFocus?: boolean; source?: Source; viewColumn?: ViewColumn }
+	| { repository: Repository; search: SearchQuery; preserveFocus?: boolean; viewColumn?: ViewColumn }
 	| Repository
 	| BranchNode
 	| CommitNode
@@ -103,18 +103,30 @@ export function registerGraphWebviewCommands<T>(
 		}
 
 		const preserveFocus = 'preserveFocus' in args ? (args.preserveFocus ?? false) : false;
+		const column = 'viewColumn' in args ? args.viewColumn : undefined;
 		if (configuration.get('graph.layout') === 'panel') {
 			if (!container.views.graph.visible) {
 				const instance = panels.getBestInstance({ preserveFocus: preserveFocus }, args);
 				if (instance != null) {
-					void instance.show({ preserveFocus: preserveFocus }, args);
+					void instance.show({ preserveFocus: preserveFocus, column: column }, args);
 					return;
 				}
 			}
 
 			void container.views.graph.show({ preserveFocus: preserveFocus }, args);
 		} else {
-			void panels.show({ preserveFocus: preserveFocus }, args);
+			const instance = panels.getBestInstance({ preserveFocus: preserveFocus }, args);
+			if (instance != null) {
+				void instance.show({ preserveFocus: preserveFocus, column: column }, args);
+				return;
+			}
+
+			if (container.views.graph.visible) {
+				void container.views.graph.show({ preserveFocus: preserveFocus }, args);
+				return;
+			}
+
+			void panels.show({ preserveFocus: preserveFocus, column: column }, args);
 		}
 	}
 

src/webviews/rebase/protocol.ts

@@ -1,3 +1,4 @@
+import type { Config } from '../../config';
 import type { MergeConflict } from '../../git/models/mergeConflict';
 import type {
 	ProcessedRebaseCommitEntry as _RebaseCommitEntry,
@@ -33,9 +34,9 @@ export interface State extends WebviewState<'gitlens.rebase'> {
 	isReadOnly?: boolean;
 
 	/** Where to reveal commits when clicking on links or double-clicking rows */
-	revealLocation: 'graph' | 'inspect';
+	revealLocation: Config['rebaseEditor']['revealLocation'];
 	/** When to automatically reveal commits */
-	revealBehavior: 'never' | 'onOpen' | 'onSelection';
+	revealBehavior: Config['rebaseEditor']['revealBehavior'];
 
 	/** Active rebase status - undefined if starting a new rebase */
 	rebaseStatus?: RebaseActiveStatus;

src/webviews/rebase/rebaseWebviewProvider.ts

@@ -1,5 +1,5 @@
 import type { Disposable, TextDocument } from 'vscode';
-import { workspace } from 'vscode';
+import { ViewColumn, workspace } from 'vscode';
 import { getAvatarUri, getAvatarUriFromGravatarEmail } from '../../avatars';
 import type { RebaseEditorTelemetryContext } from '../../constants.telemetry';
 import type { Container } from '../../container';
@@ -30,7 +30,7 @@ import type { ComposerWebviewShowingArgs } from '../plus/composer/registration';
 import type { ShowInCommitGraphCommandArgs } from '../plus/graph/registration';
 import type { IpcMessage } from '../protocol';
 import type { WebviewHost } from '../webviewProvider';
-import type { WebviewPanelShowCommandArgs, WebviewShowOptions } from '../webviewsController';
+import type { WebviewPanelShowCommandArgs } from '../webviewsController';
 import type {
 	Author,
 	ChangeEntriesParams,
@@ -197,14 +197,6 @@ export class RebaseWebviewProvider implements Disposable {
 		];
 	}
 
-	onShowing(loading: boolean, _options: WebviewShowOptions): [boolean, undefined] {
-		// Reveal branch tip on initial load if behavior is 'onOpen'
-		if (loading) {
-			void this.revealBranchTipOnOpen();
-		}
-		return [true, undefined];
-	}
-
 	onMessageReceived(e: IpcMessage): void {
 		switch (true) {
 			case AbortCommand.is(e):
@@ -525,13 +517,21 @@ export class RebaseWebviewProvider implements Disposable {
 				name: params.ref,
 				remote: false,
 			});
-			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', { ref: ref });
+			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', {
+				ref: ref,
+				preserveFocus: true,
+				viewColumn: ViewColumn.Beside,
+			});
 			return;
 		}
 
 		const ref = createReference(params.ref, this.repoPath, { refType: 'revision' });
 		if (revealIn === 'graph') {
-			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', { ref: ref });
+			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', {
+				ref: ref,
+				preserveFocus: true,
+				viewColumn: ViewColumn.Beside,
+			});
 		} else {
 			await this.container.views.commitDetails.show({ preserveFocus: true }, { commit: ref });
 		}
@@ -543,8 +543,18 @@ export class RebaseWebviewProvider implements Disposable {
 		void this.fireSelectionChangedDebounced(params);
 	}
 
-	private async fireSelectionChanged(params: UpdateSelectionParams): Promise<void> {
+	private getRevealBehavior() {
 		const revealBehavior = configuration.get('rebaseEditor.revealBehavior');
+		// Handle deprecated 'never' and 'onOpen' behavior
+		if ((revealBehavior as string) === 'onOpen' || (revealBehavior as string) === 'never') {
+			return 'onDoubleClick';
+		}
+
+		return revealBehavior;
+	}
+
+	private async fireSelectionChanged(params: UpdateSelectionParams): Promise<void> {
+		const revealBehavior = this.getRevealBehavior();
 		// Only auto-reveal on selection if behavior is 'onSelection'
 		if (revealBehavior !== 'onSelection') return;
 
@@ -565,7 +575,11 @@ export class RebaseWebviewProvider implements Disposable {
 		const revealLocation = configuration.get('rebaseEditor.revealLocation');
 		if (revealLocation === 'graph') {
 			const ref = createReference(commit.sha, this.repoPath, { refType: 'revision' });
-			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', { ref: ref });
+			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', {
+				ref: ref,
+				preserveFocus: true,
+				viewColumn: ViewColumn.Beside,
+			});
 		} else {
 			// Fire event for commit details view to pick up
 			this.container.events.fire(
@@ -637,7 +651,7 @@ export class RebaseWebviewProvider implements Disposable {
 			ascending: this.ascending,
 			isReadOnly: processed.preservesMerges,
 			revealLocation: configuration.get('rebaseEditor.revealLocation'),
-			revealBehavior: configuration.get('rebaseEditor.revealBehavior'),
+			revealBehavior: this.getRevealBehavior(),
 			rebaseStatus: rebaseStatus,
 			repoPath: this.repoPath,
 			subscription: subscription,
@@ -736,34 +750,6 @@ export class RebaseWebviewProvider implements Disposable {
 		};
 	}
 
-	private async revealBranchTipOnOpen(): Promise<void> {
-		const revealBehavior = configuration.get('rebaseEditor.revealBehavior');
-		if (revealBehavior !== 'onOpen') return;
-
-		const revealLocation = configuration.get('rebaseEditor.revealLocation');
-		const branchName =
-			this._branchName ??
-			(await this.container.git.getRepositoryService(this.repoPath).branches.getBranch())?.name;
-		if (branchName == null) return;
-
-		const ref = createReference(branchName, this.repoPath, { refType: 'branch', name: branchName, remote: false });
-
-		if (revealLocation === 'graph') {
-			await executeCommand<ShowInCommitGraphCommandArgs>('gitlens.showInCommitGraph', { ref: ref });
-		} else {
-			// For inspect view, get the branch tip commit
-			const branch = await this.container.git.getRepositoryService(this.repoPath).branches.getBranch(branchName);
-			if (branch?.sha != null) {
-				const commit = await this.container.git
-					.getRepositoryService(this.repoPath)
-					.commits.getCommit(branch.sha);
-				if (commit != null) {
-					await this.container.views.commitDetails.show({ preserveFocus: true }, { commit: commit });
-				}
-			}
-		}
-	}
-
 	private notifyDidChangeAvatars(): void {
 		if (!this._enrichment?.authors.size || !this.host.visible) return;