Closes #3313 adds first parent toggle to Graph (#3345)

Author: eamodio

package.json

@@ -2824,6 +2824,12 @@
 						"scope": "window",
 						"order": 30
 					},
+					"gitlens.graph.onlyFollowFirstParent": {
+						"type": "boolean",
+						"default": false,
+						"markdownDescription": "Specifies whether to only follow the first parent when showing commits on the _Commit Graph_",
+						"order": 31
+					},
 					"gitlens.graph.dateStyle": {
 						"type": [
 							"string",

src/config.ts

@@ -377,27 +377,28 @@ export interface GraphConfig {
 	readonly dateStyle: DateStyle | null;
 	readonly defaultItemLimit: number;
 	readonly dimMergeCommits: boolean;
+	readonly highlightRowsOnRefHover: boolean;
+	readonly layout: 'editor' | 'panel';
 	readonly minimap: {
 		readonly enabled: boolean;
 		readonly dataType: 'commits' | 'lines';
 		readonly additionalTypes: GraphMinimapMarkersAdditionalTypes[];
 	};
-	readonly highlightRowsOnRefHover: boolean;
-	readonly layout: 'editor' | 'panel';
-	readonly scrollRowPadding: number;
-	readonly showDetailsView: 'open' | 'selection' | false;
-	readonly showGhostRefsOnRowHover: boolean;
-	readonly scrollMarkers: {
+	readonly onlyFollowFirstParent: boolean;
+	readonly pageItemLimit: number;
+	readonly pullRequests: {
 		readonly enabled: boolean;
-		readonly additionalTypes: GraphScrollMarkersAdditionalTypes[];
 	};
-	readonly pullRequests: {
+	readonly scrollMarkers: {
 		readonly enabled: boolean;
+		readonly additionalTypes: GraphScrollMarkersAdditionalTypes[];
 	};
+	readonly scrollRowPadding: number;
+	readonly searchItemLimit: number;
+	readonly showDetailsView: 'open' | 'selection' | false;
+	readonly showGhostRefsOnRowHover: boolean;
 	readonly showRemoteNames: boolean;
 	readonly showUpstreamStatus: boolean;
-	readonly pageItemLimit: number;
-	readonly searchItemLimit: number;
 	readonly statusBar: {
 		readonly enabled: boolean;
 	};

src/env/node/git/localGitProvider.ts

@@ -2306,6 +2306,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 		const defaultLimit = options?.limit ?? configuration.get('graph.defaultItemLimit') ?? 5000;
 		const defaultPageLimit = configuration.get('graph.pageItemLimit') ?? 1000;
 		const ordering = configuration.get('graph.commitOrdering', undefined, 'date');
+		const onlyFollowFirstParent = configuration.get('graph.onlyFollowFirstParent', undefined, false);
 
 		const deferStats = options?.include?.stats; // && defaultLimit > 1000;
 
@@ -2370,6 +2371,9 @@ export class LocalGitProvider implements GitProvider, Disposable {
 
 			do {
 				const args = [...parser.arguments, `--${ordering}-order`, '--all'];
+				if (onlyFollowFirstParent) {
+					args.push('--first-parent');
+				}
 				if (cursor?.skip) {
 					args.push(`--skip=${cursor.skip}`);
 				}
@@ -2724,7 +2728,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 
 				rows.push({
 					sha: commit.sha,
-					parents: parents,
+					parents: onlyFollowFirstParent ? [parents[0]] : parents,
 					author: isCurrentUser ? 'You' : commit.author,
 					email: commit.authorEmail,
 					date: Number(ordering === 'author-date' ? commit.authorDate : commit.committerDate) * 1000,

src/plus/webviews/graph/graphWebview.ts

@@ -131,7 +131,6 @@ import type {
 	SearchParams,
 	State,
 	UpdateColumnsParams,
-	UpdateDimMergeCommitsParams,
 	UpdateExcludeTypeParams,
 	UpdateGraphConfigurationParams,
 	UpdateRefsVisibilityParams,
@@ -163,7 +162,6 @@ import {
 	SearchRequest,
 	supportedRefMetadataTypes,
 	UpdateColumnsCommand,
-	UpdateDimMergeCommitsCommand,
 	UpdateExcludeTypeCommand,
 	UpdateGraphConfigurationCommand,
 	UpdateIncludeOnlyRefsCommand,
@@ -616,9 +614,6 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 			case ChooseRepositoryCommand.is(e):
 				void this.onChooseRepository();
 				break;
-			case UpdateDimMergeCommitsCommand.is(e):
-				this.dimMergeCommits(e.params);
-				break;
 			case DoubleClickedCommandType.is(e):
 				void this.onDoubleClick(e.params);
 				break;
@@ -694,6 +689,12 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 						void configuration.updateEffective('graph.minimap.additionalTypes', additionalTypes);
 						break;
 					}
+					case 'dimMergeCommits':
+						void configuration.updateEffective('graph.dimMergeCommits', params.changes[key]);
+						break;
+					case 'onlyFollowFirstParent':
+						void configuration.updateEffective('graph.onlyFollowFirstParent', params.changes[key]);
+						break;
 					default:
 						// TODO:@eamodio add more config options as needed
 						debugger;
@@ -748,30 +749,17 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 			configuration.changed(e, 'defaultDateFormat') ||
 			configuration.changed(e, 'defaultDateStyle') ||
 			configuration.changed(e, 'advanced.abbreviatedShaLength') ||
-			configuration.changed(e, 'graph.avatars') ||
-			configuration.changed(e, 'graph.dateFormat') ||
-			configuration.changed(e, 'graph.dateStyle') ||
-			configuration.changed(e, 'graph.dimMergeCommits') ||
-			configuration.changed(e, 'graph.highlightRowsOnRefHover') ||
-			configuration.changed(e, 'graph.scrollRowPadding') ||
-			configuration.changed(e, 'graph.scrollMarkers.enabled') ||
-			configuration.changed(e, 'graph.scrollMarkers.additionalTypes') ||
-			configuration.changed(e, 'graph.showGhostRefsOnRowHover') ||
-			configuration.changed(e, 'graph.pullRequests.enabled') ||
-			configuration.changed(e, 'graph.showRemoteNames') ||
-			configuration.changed(e, 'graph.showUpstreamStatus') ||
-			configuration.changed(e, 'graph.minimap.enabled') ||
-			configuration.changed(e, 'graph.minimap.dataType') ||
-			configuration.changed(e, 'graph.minimap.additionalTypes')
+			configuration.changed(e, 'graph')
 		) {
 			void this.notifyDidChangeConfiguration();
 
 			if (
-				(configuration.changed(e, 'graph.minimap.enabled') ||
+				configuration.changed(e, 'graph.onlyFollowFirstParent') ||
+				((configuration.changed(e, 'graph.minimap.enabled') ||
 					configuration.changed(e, 'graph.minimap.dataType')) &&
-				configuration.get('graph.minimap.enabled') &&
-				configuration.get('graph.minimap.dataType') === 'lines' &&
-				!this._graph?.includes?.stats
+					configuration.get('graph.minimap.enabled') &&
+					configuration.get('graph.minimap.dataType') === 'lines' &&
+					!this._graph?.includes?.stats)
 			) {
 				this.updateState();
 			}
@@ -833,10 +821,6 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 		this.updateState();
 	}
 
-	private dimMergeCommits(e: UpdateDimMergeCommitsParams) {
-		void configuration.updateEffective('graph.dimMergeCommits', e.dim);
-	}
-
 	private onColumnsChanged(e: UpdateColumnsParams) {
 		this.updateColumns(e.config);
 	}
@@ -1846,6 +1830,7 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 			minimap: configuration.get('graph.minimap.enabled'),
 			minimapDataType: configuration.get('graph.minimap.dataType'),
 			minimapMarkerTypes: this.getMinimapMarkerTypes(),
+			onlyFollowFirstParent: configuration.get('graph.onlyFollowFirstParent'),
 			scrollRowPadding: configuration.get('graph.scrollRowPadding'),
 			scrollMarkerTypes: this.getScrollMarkerTypes(),
 			showGhostRefsOnRowHover: configuration.get('graph.showGhostRefsOnRowHover'),

src/plus/webviews/graph/protocol.ts

@@ -179,6 +179,7 @@ export interface GraphComponentConfig {
 	minimap?: boolean;
 	minimapDataType?: Config['graph']['minimap']['dataType'];
 	minimapMarkerTypes?: GraphMinimapMarkerTypes[];
+	onlyFollowFirstParent?: boolean;
 	scrollMarkerTypes?: GraphScrollMarkerTypes[];
 	scrollRowPadding?: number;
 	showGhostRefsOnRowHover?: boolean;
@@ -262,11 +263,6 @@ export interface UpdateColumnsParams {
 }
 export const UpdateColumnsCommand = new IpcCommand<UpdateColumnsParams>(scope, 'columns/update');
 
-export interface UpdateDimMergeCommitsParams {
-	dim: boolean;
-}
-export const UpdateDimMergeCommitsCommand = new IpcCommand<UpdateDimMergeCommitsParams>(scope, 'dimMergeCommits');
-
 export interface UpdateRefsVisibilityParams {
 	refs: GraphExcludedRef[];
 	visible: boolean;

src/webviews/apps/plus/graph/GraphWrapper.tsx

@@ -81,7 +81,6 @@ export interface GraphWrapperProps {
 	subscriber: (callback: UpdateStateCallback) => () => void;
 	onChooseRepository?: () => void;
 	onColumnsChange?: (colsSettings: GraphColumnsConfig) => void;
-	onDimMergeCommits?: (dim: boolean) => void;
 	onDoubleClickRef?: (ref: GraphRef, metadata?: GraphRefMetadataItem) => void;
 	onDoubleClickRow?: (row: GraphRow, preserveFocus?: boolean) => void;
 	onMissingAvatars?: (emails: Record<string, string>) => void;
@@ -204,7 +203,6 @@ export function GraphWrapper({
 	state,
 	onChooseRepository,
 	onColumnsChange,
-	onDimMergeCommits,
 	onDoubleClickRef,
 	onDoubleClickRow,
 	onEnsureRowPromise,
@@ -503,10 +501,11 @@ export function GraphWrapper({
 	}, [includeOnlyRefsById]);
 
 	const hasFilters = useMemo(() => {
-		if (!isAllBranches) return true;
+		if (!isAllBranches || graphConfig?.onlyFollowFirstParent) return true;
 		if (excludeTypes == null) return false;
+
 		return Object.values(excludeTypes).includes(true);
-	}, [excludeTypes, isAllBranches, graphConfig?.dimMergeCommits]);
+	}, [excludeTypes, isAllBranches, graphConfig?.onlyFollowFirstParent]);
 
 	const hasSpecialFilters = useMemo(() => {
 		return !isAllBranches;
@@ -651,15 +650,27 @@ export function GraphWrapper({
 		onChooseRepository?.();
 	};
 
-	const handleExcludeTypeChange = (e: Event | FormEvent<HTMLElement>) => {
+	const handleFilterChange = (e: Event | FormEvent<HTMLElement>) => {
 		const $el = e.target as HTMLInputElement;
 
 		const value = $el.value;
-		const isLocalBranches = ['branch-all', 'branch-current'].includes(value);
-		if (!isLocalBranches && !['remotes', 'stashes', 'tags', 'mergeCommits'].includes(value)) return;
 		const isChecked = $el.checked;
-		if (value === 'mergeCommits') {
-			onDimMergeCommits?.(isChecked);
+
+		switch (value) {
+			case 'mergeCommits':
+				onUpdateGraphConfiguration?.({ dimMergeCommits: isChecked });
+				return;
+
+			case 'onlyFollowFirstParent':
+				onUpdateGraphConfiguration?.({ onlyFollowFirstParent: isChecked });
+				return;
+		}
+
+		const isLocalBranches = ['branch-all', 'branch-current'].includes(value);
+		if (
+			!isLocalBranches &&
+			!['remotes', 'stashes', 'tags', 'mergeCommits', 'onlyFollowFirstParent'].includes(value)
+		) {
 			return;
 		}
 
@@ -1217,7 +1228,7 @@ export function GraphWrapper({
 												<MenuItem role="none">
 													<VSCodeCheckbox
 														value="remotes"
-														onChange={handleExcludeTypeChange}
+														onChange={handleFilterChange}
 														defaultChecked={excludeTypes?.remotes ?? false}
 													>
 														Hide Remote-only Branches
@@ -1226,7 +1237,7 @@ export function GraphWrapper({
 												<MenuItem role="none">
 													<VSCodeCheckbox
 														value="stashes"
-														onChange={handleExcludeTypeChange}
+														onChange={handleFilterChange}
 														defaultChecked={excludeTypes?.stashes ?? false}
 													>
 														Hide Stashes
@@ -1237,17 +1248,33 @@ export function GraphWrapper({
 										<MenuItem role="none">
 											<VSCodeCheckbox
 												value="tags"
-												onChange={handleExcludeTypeChange}
+												onChange={handleFilterChange}
 												defaultChecked={excludeTypes?.tags ?? false}
 											>
 												Hide Tags
 											</VSCodeCheckbox>
 										</MenuItem>
 										<MenuDivider></MenuDivider>
+										{repo?.isVirtual !== true && (
+											<MenuItem role="none">
+												<GlTooltip
+													placement="right"
+													content="Only follow the first parent of merge commits to provide a more linear history"
+												>
+													<VSCodeCheckbox
+														value="onlyFollowFirstParent"
+														onChange={handleFilterChange}
+														defaultChecked={graphConfig?.onlyFollowFirstParent ?? false}
+													>
+														Simplify Merge History
+													</VSCodeCheckbox>
+												</GlTooltip>
+											</MenuItem>
+										)}
 										<MenuItem role="none">
 											<VSCodeCheckbox
 												value="mergeCommits"
-												onChange={handleExcludeTypeChange}
+												onChange={handleFilterChange}
 												defaultChecked={graphConfig?.dimMergeCommits ?? false}
 											>
 												Dim Merge Commit Rows

src/webviews/apps/plus/graph/graph.tsx

@@ -42,7 +42,6 @@ import {
 	SearchOpenInViewCommand,
 	SearchRequest,
 	UpdateColumnsCommand,
-	UpdateDimMergeCommitsCommand,
 	UpdateExcludeTypeCommand,
 	UpdateGraphConfigurationCommand,
 	UpdateIncludeOnlyRefsCommand,
@@ -99,7 +98,6 @@ export class GraphApp extends App<State> {
 						settings => this.onColumnsChanged(settings),
 						250,
 					)}
-					onDimMergeCommits={dim => this.onDimMergeCommits(dim)}
 					onRefsVisibilityChange={(refs: GraphExcludedRef[], visible: boolean) =>
 						this.onRefsVisibilityChanged(refs, visible)
 					}
@@ -529,12 +527,6 @@ export class GraphApp extends App<State> {
 		this.sendCommand(ChooseRepositoryCommand, undefined);
 	}
 
-	private onDimMergeCommits(dim: boolean) {
-		this.sendCommand(UpdateDimMergeCommitsCommand, {
-			dim: dim,
-		});
-	}
-
 	private onDoubleClickRef(ref: GraphRef, metadata?: GraphRefMetadataItem) {
 		this.sendCommand(DoubleClickedCommandType, {
 			type: 'ref',