Skip to content

fix(search): skip full buffer scan when term is incremental extension #5866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Poonam1216 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(search): skip full buffer scan when term is incremental extension #5866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 87 additions & 25 deletions addons/addon-search/src/SearchAddon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,22 @@
* @license MIT
*/

import type { Terminal, IDisposable, ITerminalAddon } from '@xterm/xterm';
import type { SearchAddon as ISearchApi, ISearchOptions, ISearchAddonOptions, ISearchResultChangeEvent, ISearchDecorationOptions } from '@xterm/addon-search';
import { Emitter, type IEvent } from 'common/Event';
import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
import { disposableTimeout } from 'common/Async';
import { SearchLineCache } from './SearchLineCache';
import { SearchState } from './SearchState';
import { SearchEngine, type ISearchResult } from './SearchEngine';
import { DecorationManager } from './DecorationManager';
import { SearchResultTracker } from './SearchResultTracker';
import type { Terminal, IDisposable, ITerminalAddon } from "@xterm/xterm";
import type {
SearchAddon as ISearchApi,
ISearchOptions,
ISearchAddonOptions,
ISearchResultChangeEvent,
ISearchDecorationOptions,
} from "@xterm/addon-search";
import { Emitter, type IEvent } from "common/Event";
import { Disposable, MutableDisposable, toDisposable } from "common/Lifecycle";
import { disposableTimeout } from "common/Async";
import { SearchLineCache } from "./SearchLineCache";
import { SearchState } from "./SearchState";
import { SearchEngine, type ISearchResult } from "./SearchEngine";
import { DecorationManager } from "./DecorationManager";
import { SearchResultTracker } from "./SearchResultTracker";

interface IInternalSearchOptions {
noScroll: boolean;
Expand All @@ -27,7 +33,7 @@ const enum Constants {
* performance degradation when searching for very common terms that would result in excessive
* highlighting decorations.
*/
DEFAULT_HIGHLIGHT_LIMIT = 1000
DEFAULT_HIGHLIGHT_LIMIT = 1000,
}

export class SearchAddon extends Disposable implements ITerminalAddon, ISearchApi {
Expand Down Expand Up @@ -73,7 +79,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
this._highlightTimeout.value = disposableTimeout(() => {
const term = this._state.cachedSearchTerm;
this._state.clearCachedTerm();
this.findPrevious(term!, { ...this._state.lastSearchOptions, incremental: true }, { noScroll: true });
this.findPrevious(
term!,
{ ...this._state.lastSearchOptions, incremental: true },
{ noScroll: true }
);
}, 200);
}
}
Expand All @@ -98,9 +108,13 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
* @param searchOptions Search options.
* @returns Whether a result was found.
*/
public findNext(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
public findNext(
term: string,
searchOptions?: ISearchOptions,
internalSearchOptions?: IInternalSearchOptions
): boolean {
if (!this._terminal || !this._engine) {
throw new Error('Cannot use addon until it has been loaded');
throw new Error("Cannot use addon until it has been loaded");
}

this._onBeforeSearch.fire();
Expand All @@ -122,14 +136,33 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp

private _highlightAllMatches(term: string, searchOptions: ISearchOptions): void {
if (!this._terminal || !this._engine || !this._decorationManager) {
throw new Error('Cannot use addon until it has been loaded');
throw new Error("Cannot use addon until it has been loaded");
}
if (!this._state.isValidSearchTerm(term)) {
this.clearDecorations();
return;
}

// new search, clear out the old decorations
// If the new term is just an extension of the previous term (e.g. "hel" → "hell"),
// filter the existing results instead of scanning the entire buffer again.
const existingResults = this._resultTracker.searchResults;
if (this._state.isIncrementalExtension(term, searchOptions) && existingResults.length > 0) {
const compare = searchOptions?.caseSensitive
? (s: string) => s
: (s: string) => s.toLowerCase();
const needle = compare(term);
const filtered = (existingResults as ISearchResult[]).filter(
(r) => compare(r.term) === needle
);
this.clearDecorations(true);
this._resultTracker.updateResults(filtered, this._highlightLimit);
if (searchOptions.decorations) {
this._decorationManager.createHighlightDecorations(filtered, searchOptions.decorations);
}
return;
}

// Full search — original behavior
this.clearDecorations(true);

const results: ISearchResult[] = [];
Expand All @@ -144,7 +177,9 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
results.push(prevResult);
result = this._engine.find(
term,
prevResult.col + prevResult.term.length >= this._terminal.cols ? prevResult.row + 1 : prevResult.row,
prevResult.col + prevResult.term.length >= this._terminal.cols
? prevResult.row + 1
: prevResult.row,
prevResult.col + prevResult.term.length >= this._terminal.cols ? 0 : prevResult.col + 1,
searchOptions
);
Expand All @@ -156,7 +191,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
}
}

private _findNextAndSelect(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
private _findNextAndSelect(
term: string,
searchOptions?: ISearchOptions,
internalSearchOptions?: IInternalSearchOptions
): boolean {
if (!this._terminal || !this._engine) {
return false;
}
Expand All @@ -166,7 +205,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
return false;
}

const result = this._engine.findNextWithSelection(term, searchOptions, this._state.cachedSearchTerm);
const result = this._engine.findNextWithSelection(
term,
searchOptions,
this._state.cachedSearchTerm
);
return this._selectResult(result, searchOptions?.decorations, internalSearchOptions?.noScroll);
}

Expand All @@ -177,9 +220,13 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
* @param searchOptions Search options.
* @returns Whether a result was found.
*/
public findPrevious(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
public findPrevious(
term: string,
searchOptions?: ISearchOptions,
internalSearchOptions?: IInternalSearchOptions
): boolean {
if (!this._terminal || !this._engine) {
throw new Error('Cannot use addon until it has been loaded');
throw new Error("Cannot use addon until it has been loaded");
}

this._onBeforeSearch.fire();
Expand All @@ -203,7 +250,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
this._resultTracker.fireResultsChanged(!!searchOptions?.decorations);
}

private _findPreviousAndSelect(term: string, searchOptions?: ISearchOptions, internalSearchOptions?: IInternalSearchOptions): boolean {
private _findPreviousAndSelect(
term: string,
searchOptions?: ISearchOptions,
internalSearchOptions?: IInternalSearchOptions
): boolean {
if (!this._terminal || !this._engine) {
return false;
}
Expand All @@ -213,7 +264,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
return false;
}

const result = this._engine.findPreviousWithSelection(term, searchOptions, this._state.cachedSearchTerm);
const result = this._engine.findPreviousWithSelection(
term,
searchOptions,
this._state.cachedSearchTerm
);
return this._selectResult(result, searchOptions?.decorations, internalSearchOptions?.noScroll);
}

Expand All @@ -222,7 +277,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
* @param result The result to select.
* @returns Whether a result was selected.
*/
private _selectResult(result: ISearchResult | undefined, options?: ISearchDecorationOptions, noScroll?: boolean): boolean {
private _selectResult(
result: ISearchResult | undefined,
options?: ISearchDecorationOptions,
noScroll?: boolean
): boolean {
if (!this._terminal || !this._decorationManager) {
return false;
}
Expand All @@ -243,7 +302,10 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp

if (!noScroll) {
// If it is not in the viewport then we scroll else it just gets selected
if (result.row >= (this._terminal.buffer.active.viewportY + this._terminal.rows) || result.row < this._terminal.buffer.active.viewportY) {
if (
result.row >= this._terminal.buffer.active.viewportY + this._terminal.rows ||
result.row < this._terminal.buffer.active.viewportY
) {
let scroll = result.row - this._terminal.buffer.active.viewportY;
scroll -= Math.floor(this._terminal.rows / 2);
this._terminal.scrollLines(scroll);
Expand Down
32 changes: 28 additions & 4 deletions addons/addon-search/src/SearchState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* @license MIT
*/

import type { ISearchOptions } from '@xterm/addon-search';
import type { ISearchOptions } from "@xterm/addon-search";

/**
* Manages search state including cached search terms, options tracking, and validation.
Expand Down Expand Up @@ -73,6 +73,28 @@ export class SearchState {
}
return false;
}
/**
* Determines if the new term is an incremental extension of the cached term
* (e.g. "hel" → "hell"), meaning we can filter existing results instead of
* re-scanning the entire buffer.
* Only applies to plain text searches (not regex or wholeWord).
* @param term The new search term.
* @param options The search options.
* @returns true if the new term starts with the cached term.
*/
public isIncrementalExtension(term: string, options?: ISearchOptions): boolean {
if (!this._cachedSearchTerm) {
return false;
}
if (options?.regex || options?.wholeWord) {
return false;
}
const cached = options?.caseSensitive
? this._cachedSearchTerm
: this._cachedSearchTerm.toLowerCase();
const newTerm = options?.caseSensitive ? term : term.toLowerCase();
return newTerm.startsWith(cached) && newTerm !== cached;
}

/**
* Determines if a new search should trigger highlighting updates.
Expand All @@ -84,9 +106,11 @@ export class SearchState {
if (!options?.decorations) {
return false;
}
return this._cachedSearchTerm === undefined ||
term !== this._cachedSearchTerm ||
this.didOptionsChange(options);
return (
this._cachedSearchTerm === undefined ||
term !== this._cachedSearchTerm ||
this.didOptionsChange(options)
);
}

/**
Expand Down