Closes #4724 adds search history to Commit Graph

 - Adds a persistent search history for the Commit Graph's search input
 - Allows navigating through past searches using arrow keys
 - Allows deleting history items with the Delete key

Author: eamodio

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Adds a new _Safe Hard Reset_ (`--keep`) option to Git _reset_ command
 - Adds support for reference or range commit searches on the _Commit Graph_, _Search & Compare_ view, and in the _Search Commits_ command ([#4723](https://github.com/gitkraken/vscode-gitlens/issues/4723))
   - Adds natural language support to allow for more powerful queries
+- Adds a navigable search history to the search box on the _Commit Graph_ ([#4724](https://github.com/gitkraken/vscode-gitlens/issues/4724))
 
 ### Changed
 

src/commands/git/search.ts

@@ -454,7 +454,7 @@ export class SearchGitCommand extends QuickCommand<State> {
 				// Simulate an extra step if we have a value
 				state.counter = value ? 3 : 2;
 
-				const operations = parseSearchQuery({
+				const { operations } = parseSearchQuery({
 					query: value,
 					matchAll: state.matchAll,
 					matchCase: state.matchCase,
@@ -539,7 +539,7 @@ async function updateSearchQuery(
 	state: SearchStepState,
 	context: Context,
 ) {
-	const ops = parseSearchQuery({
+	const { operations: ops } = parseSearchQuery({
 		query: quickpick.value,
 		matchAll: state.matchAll,
 		matchCase: state.matchCase,

src/constants.storage.ts

@@ -184,6 +184,8 @@ export type WorkspaceStorage = {
 	[key in IntegrationConnectedKey]: boolean;
 } & {
 	[key in `views:${TreeViewTypes}:repositoryFilter`]: string[] | undefined;
+} & {
+	[key in `graph:searchHistory:${string}`]: StoredGraphSearchHistory[];
 };
 
 export interface Stored<T, SchemaVersion extends number = 1> {
@@ -352,6 +354,17 @@ export interface StoredGraphFilters {
 
 export type StoredGraphRefType = 'head' | 'remote' | 'tag';
 
+export type StoredGraphSearchHistory = {
+	query: string;
+	matchAll: boolean | undefined;
+	matchCase: boolean | undefined;
+	matchRegex: boolean | undefined;
+	matchWholeWord: boolean | undefined;
+	naturalLanguage: boolean | undefined;
+	/** For NL queries, store the last known structured form to show in history */
+	nlStructuredQuery?: string;
+};
+
 export type StoredGraphSearchMode = 'normal' | 'filter';
 
 export interface StoredGraphExcludedRef {

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

@@ -41,7 +41,8 @@ import {
 } from '../../../../git/parsers/logParser';
 import { parseGitRefLog, parseGitRefLogDefaultFormat } from '../../../../git/parsers/reflogParser';
 import type { SearchQueryFilters } from '../../../../git/search';
-import { parseSearchQueryCommand, processNaturalLanguageToSearchQuery } from '../../../../git/search';
+import { parseSearchQueryCommand } from '../../../../git/search';
+import { processNaturalLanguageToSearchQuery } from '../../../../git/search.naturalLanguage';
 import { createUncommittedChangesCommit } from '../../../../git/utils/-webview/commit.utils';
 import { isRevisionRange, isSha, isUncommitted, isUncommittedStaged } from '../../../../git/utils/revision.utils';
 import { isUserMatch } from '../../../../git/utils/user.utils';
@@ -1010,9 +1011,9 @@ export class CommitsGitSubProvider implements GitCommitsSubProvider {
 	@log<CommitsGitSubProvider['searchCommits']>({
 		args: {
 			1: s =>
-				`[${s.matchAll ? 'A' : ''}${s.matchCase ? 'C' : ''}${s.matchRegex ? 'R' : ''}${s.matchWholeWord ? 'W' : ''}]: ${
-					s.query.length > 500 ? `${s.query.substring(0, 500)}...` : s.query
-				}`,
+				`[${s.matchAll ? 'A' : ''}${s.matchCase ? 'C' : ''}${s.matchRegex ? 'R' : ''}${
+					s.matchWholeWord ? 'W' : ''
+				}]: ${s.query.length > 500 ? `${s.query.substring(0, 500)}...` : s.query}`,
 		},
 	})
 	async searchCommits(

src/git/search.naturalLanguage.ts

@@ -0,0 +1,15 @@
+import type { SearchQuery } from '../constants.search';
+import type { Source } from '../constants.telemetry';
+import type { Container } from '../container';
+import type { NaturalLanguageSearchOptions } from '../plus/search/naturalLanguageSearchProcessor';
+import { NaturalLanguageSearchProcessor } from '../plus/search/naturalLanguageSearchProcessor';
+
+/** Converts natural language to a structured search query */
+export async function processNaturalLanguageToSearchQuery(
+	container: Container,
+	search: SearchQuery,
+	source: Source,
+	options?: NaturalLanguageSearchOptions,
+): Promise<SearchQuery> {
+	return new NaturalLanguageSearchProcessor(container).processNaturalLanguageToSearchQuery(search, source, options);
+}

src/git/search.ts

@@ -1,10 +1,6 @@
 import type { SearchOperators, SearchOperatorsLongForm, SearchQuery } from '../constants.search';
 import { searchOperators, searchOperatorsToLongFormMap } from '../constants.search';
 import type { StoredSearchQuery } from '../constants.storage';
-import type { Source } from '../constants.telemetry';
-import type { Container } from '../container';
-import type { NaturalLanguageSearchOptions } from '../plus/search/naturalLanguageSearchProcessor';
-import { NaturalLanguageSearchProcessor } from '../plus/search/naturalLanguageSearchProcessor';
 import { some } from '../system/iterable';
 import type { GitRevisionReference } from './models/reference';
 import type { GitUser } from './models/user';
@@ -68,6 +64,11 @@ export function getSearchQueryComparisonKey(search: SearchQuery | StoredSearchQu
 	}${search.matchRegex ? 'R' : ''}${search.matchWholeWord ? 'W' : ''}${search.naturalLanguage ? 'NL' : ''}`;
 }
 
+export interface ParsedSearchQuery {
+	operations: Map<SearchOperatorsLongForm, Set<string>>;
+	errors?: string[];
+}
+
 export function createSearchQueryForCommit(ref: string): string;
 export function createSearchQueryForCommit(commit: GitRevisionReference): string;
 export function createSearchQueryForCommit(refOrCommit: string | GitRevisionReference): string {
@@ -80,10 +81,11 @@ export function createSearchQueryForCommits(refsOrCommits: (string | GitRevision
 	return refsOrCommits.map(r => `#:${typeof r === 'string' ? shortenRevision(r) : r.name}`).join(' ');
 }
 
-export function parseSearchQuery(search: SearchQuery): Map<SearchOperatorsLongForm, Set<string>> {
+export function parseSearchQuery(search: SearchQuery, validate: boolean = false): ParsedSearchQuery {
 	const operations = new Map<SearchOperatorsLongForm, Set<string>>();
 	const query = search.query.trim();
 
+	let errors: string[] | undefined;
 	let pos = 0;
 
 	while (pos < query.length) {
@@ -164,6 +166,14 @@ export function parseSearchQuery(search: SearchQuery): Map<SearchOperatorsLongFo
 			value = text;
 		}
 
+		// Validate operator has a value
+		if (op && !value) {
+			if (!validate) continue;
+
+			errors ??= [];
+			errors.push(`'${op}' requires a value`);
+		}
+
 		// Add the discovered operation to our map
 		if (op && value) {
 			const longFormOp = searchOperatorsToLongFormMap.get(op);
@@ -178,7 +188,10 @@ export function parseSearchQuery(search: SearchQuery): Map<SearchOperatorsLongFo
 		}
 	}
 
-	return operations;
+	return {
+		operations: operations,
+		...(errors?.length && { errors: errors }),
+	};
 }
 
 export interface SearchQueryFilters {
@@ -202,7 +215,7 @@ export interface SearchQueryCommand {
 }
 
 export function parseSearchQueryCommand(search: SearchQuery, currentUser: GitUser | undefined): SearchQueryCommand {
-	const operations = parseSearchQuery(search);
+	const { operations } = parseSearchQuery(search);
 
 	const searchArgs = new Set<string>();
 	const files: string[] = [];
@@ -391,13 +404,3 @@ export function parseSearchQueryCommand(search: SearchQuery, currentUser: GitUse
 		filters: filters,
 	};
 }
-
-/** Converts natural language to a structured search query */
-export async function processNaturalLanguageToSearchQuery(
-	container: Container,
-	search: SearchQuery,
-	source: Source,
-	options?: NaturalLanguageSearchOptions,
-): Promise<SearchQuery> {
-	return new NaturalLanguageSearchProcessor(container).processNaturalLanguageToSearchQuery(search, source, options);
-}

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

@@ -22,7 +22,8 @@ import type { GitLog } from '../../../../../git/models/log';
 import type { GitRevisionRange } from '../../../../../git/models/revision';
 import { deletedOrMissing } from '../../../../../git/models/revision';
 import type { GitUser } from '../../../../../git/models/user';
-import { parseSearchQuery, processNaturalLanguageToSearchQuery } from '../../../../../git/search';
+import { parseSearchQuery } from '../../../../../git/search';
+import { processNaturalLanguageToSearchQuery } from '../../../../../git/search.naturalLanguage';
 import { createUncommittedChangesCommit } from '../../../../../git/utils/-webview/commit.utils';
 import { createRevisionRange, isUncommitted } from '../../../../../git/utils/revision.utils';
 import { log } from '../../../../../system/decorators/log';
@@ -891,9 +892,9 @@ export class CommitsGitSubProvider implements GitCommitsSubProvider {
 	@log<CommitsGitSubProvider['searchCommits']>({
 		args: {
 			1: s =>
-				`[${s.matchAll ? 'A' : ''}${s.matchCase ? 'C' : ''}${s.matchRegex ? 'R' : ''}${s.matchWholeWord ? 'W' : ''}]: ${
-					s.query.length > 500 ? `${s.query.substring(0, 500)}...` : s.query
-				}`,
+				`[${s.matchAll ? 'A' : ''}${s.matchCase ? 'C' : ''}${s.matchRegex ? 'R' : ''}${
+					s.matchWholeWord ? 'W' : ''
+				}]: ${s.query.length > 500 ? `${s.query.substring(0, 500)}...` : s.query}`,
 		},
 	})
 	async searchCommits(
@@ -915,7 +916,7 @@ export class CommitsGitSubProvider implements GitCommitsSubProvider {
 			search = await processNaturalLanguageToSearchQuery(this.container, search, source);
 		}
 
-		const operations = parseSearchQuery(search);
+		const { operations } = parseSearchQuery(search);
 
 		const values = operations.get('commit:');
 		if (values?.size) {

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

@@ -269,7 +269,9 @@ export class GraphGitSubProvider implements GitGraphSubProvider {
 						getRemoteIconUri(this.container, remote, asWebviewUri)
 					)?.toString(true);
 					context = {
-						webviewItem: `gitlens:branch+remote${isBranchStarred(this.container, remoteBranchId) ? '+starred' : ''}`,
+						webviewItem: `gitlens:branch+remote${
+							isBranchStarred(this.container, remoteBranchId) ? '+starred' : ''
+						}`,
 						webviewItemValue: {
 							type: 'branch',
 							ref: createReference(headBranch.name, repoPath, {
@@ -323,7 +325,9 @@ export class GraphGitSubProvider implements GitGraphSubProvider {
 							getRemoteIconUri(this.container, remote, asWebviewUri)
 						)?.toString(true);
 						context = {
-							webviewItem: `gitlens:branch+remote${isBranchStarred(this.container, remoteBranchId) ? '+starred' : ''}`,
+							webviewItem: `gitlens:branch+remote${
+								isBranchStarred(this.container, remoteBranchId) ? '+starred' : ''
+							}`,
 							webviewItemValue: {
 								type: 'branch',
 								ref: createReference(b, repoPath, {
@@ -489,9 +493,9 @@ export class GraphGitSubProvider implements GitGraphSubProvider {
 	@log<GraphGitSubProvider['searchGraph']>({
 		args: {
 			1: s =>
-				`[${s.matchAll ? 'A' : ''}${s.matchCase ? 'C' : ''}${s.matchRegex ? 'R' : ''}${s.matchWholeWord ? 'W' : ''}]: ${
-					s.query.length > 500 ? `${s.query.substring(0, 500)}...` : s.query
-				}`,
+				`[${s.matchAll ? 'A' : ''}${s.matchCase ? 'C' : ''}${s.matchRegex ? 'R' : ''}${
+					s.matchWholeWord ? 'W' : ''
+				}]: ${s.query.length > 500 ? `${s.query.substring(0, 500)}...` : s.query}`,
 			2: o => `limit=${o?.limit}, ordering=${o?.ordering}`,
 		},
 	})
@@ -511,7 +515,7 @@ export class GraphGitSubProvider implements GitGraphSubProvider {
 
 		try {
 			const results: GitGraphSearchResults = new Map<string, GitGraphSearchResultData>();
-			const operations = parseSearchQuery(search);
+			const { operations } = parseSearchQuery(search);
 
 			const values = operations.get('commit:');
 			if (values != null) {

src/webviews/apps/plus/graph/graph-header.ts

@@ -371,7 +371,8 @@ export class GlGraphHeader extends SignalWatcher(LitElement) {
 				search: this.searchValid ? { ...this.graphState.filter } : undefined /*limit: options?.limit*/,
 			});
 
-			if (rsp.search && rsp.results) {
+			// Only log successful searches with at least 1 result
+			if (rsp.search && rsp.results && !('error' in rsp.results) && rsp.results.count > 0) {
 				this.searchEl.logSearch(rsp.search);
 			}
 
@@ -905,7 +906,9 @@ export class GlGraphHeader extends SignalWatcher(LitElement) {
 									</sl-select>
 								</gl-tooltip>
 								<div
-									class=${`shrink ${!Object.values(this.graphState.excludeRefs ?? {}).length && 'hidden'}`}
+									class=${`shrink ${
+										!Object.values(this.graphState.excludeRefs ?? {}).length && 'hidden'
+									}`}
 								>
 									<gl-popover
 										class="popover"

src/webviews/apps/shared/components/search/search-box.ts

@@ -166,7 +166,7 @@ export class GlSearchBox extends GlElement {
 	}
 
 	logSearch(query: SearchQuery): void {
-		this.searchInput?.logSearch(query);
+		void this.searchInput?.logSearch(query);
 	}
 
 	setSearchQuery(query: string): void {