Files
openchamber/packages/ui/src/lib/search/fuzzySearch.ts
T
Bohdan Triapitsyn b8716fe808 refactor(search): unify dropdown filtering on the shared ranked matcher
Branch, project, agent, model, provider, stash, SSH-host, skill-catalog
and archive filters each had their own toLowerCase().includes (or no
ordering at all); the git branch and gitmoji pickers also let cmdk
re-filter and reorder on top of the manual filter, silently dropping
rows. All of them now go through rankByQuery/matchesRankQuery: results
are relevance-ordered, multi-word queries match in any order, matching
ignores punctuation, and cmdk filtering is disabled where the ranked
list is already final. rankBranchesForQuery keeps relevance order
instead of re-sorting matches alphabetically; the model picker now also
matches model ids.
2026-08-24 15:00:52 +03:00

226 lines
7.1 KiB
TypeScript

import Fuse from "fuse.js";
export interface FuzzySearchOptions {
threshold?: number;
distance?: number;
ignoreLocation?: boolean;
preferSubstring?: boolean;
}
const DEFAULT_FUZZY_OPTIONS: Required<FuzzySearchOptions> = {
threshold: 0.4,
distance: 100,
ignoreLocation: true,
preferSubstring: true,
};
export function matchesFuzzyQuery(
target: string,
query: string,
options?: FuzzySearchOptions
): boolean {
if (!query) {
return true;
}
if (!target) {
return false;
}
const mergedOptions = { ...DEFAULT_FUZZY_OPTIONS, ...options };
if (mergedOptions.preferSubstring && target.toLowerCase().includes(query.toLowerCase())) {
return true;
}
const fuse = new Fuse([target], {
threshold: mergedOptions.threshold,
distance: mergedOptions.distance,
ignoreLocation: mergedOptions.ignoreLocation,
});
return fuse.search(query).length > 0;
}
/**
* Score-sorted fuzzy ranking. Strict (low threshold), prioritizes substring
* matches (especially prefix matches), and returns the top N.
*
* Use this for command-palette-style result ranking where order matters more
* than recall.
*/
export function scoreByFuzzyQuery<T>(
items: T[],
query: string,
getText: (item: T) => string,
options?: { limit?: number; threshold?: number; noFuzzy?: boolean },
): { item: T; score: number }[] {
if (!query) return items.map((item) => ({ item, score: 0 }));
const limit = options?.limit ?? items.length;
const threshold = options?.threshold ?? 0.3;
const noFuzzy = options?.noFuzzy ?? false;
const queryLower = query.toLowerCase();
const scored: { item: T; score: number }[] = [];
const fuzzyCandidates: { item: T; text: string }[] = [];
for (const item of items) {
const text = getText(item);
if (!text) continue;
const lower = text.toLowerCase();
const idx = lower.indexOf(queryLower);
if (idx === 0) {
scored.push({ item, score: -1 });
continue;
}
if (idx > 0) {
scored.push({ item, score: idx / 1000 });
continue;
}
if (!noFuzzy) fuzzyCandidates.push({ item, text });
}
if (fuzzyCandidates.length > 0) {
const fuse = new Fuse(
fuzzyCandidates.map((c) => c.text),
{ threshold, ignoreLocation: true, distance: 100, includeScore: true, minMatchCharLength: 2 },
);
for (const result of fuse.search(query)) {
scored.push({ item: fuzzyCandidates[result.refIndex].item, score: result.score ?? 1 });
}
}
scored.sort((a, b) => a.score - b.score);
return scored.slice(0, limit);
}
const RANK_TOKEN_MISS = Number.POSITIVE_INFINITY;
const tokenizeRankQuery = (query: string): string[] =>
query.trim().toLowerCase().split(/\s+/).filter(Boolean);
const compactText = (value: string): string => value.replace(/[^a-z0-9]+/g, '');
type RankFields = { fields: string[]; compact: string[] };
const buildRankFields = (texts: ReadonlyArray<string | null | undefined>): RankFields => {
const fields: string[] = [];
const compact: string[] = [];
for (const text of texts) {
if (!text) continue;
const lower = text.toLowerCase();
fields.push(lower);
compact.push(compactText(lower));
}
return { fields, compact };
};
/**
* Score one query token against an item's fields. Lower is better:
* field prefix < word-boundary substring < mid-word substring <
* punctuation-insensitive ("compact") substring. Earlier fields win ties, so
* callers should order `getTexts` by importance (name before path/description).
*/
const scoreRankToken = (token: string, { fields, compact }: RankFields): number => {
let best = RANK_TOKEN_MISS;
for (let fieldIndex = 0; fieldIndex < fields.length; fieldIndex++) {
const field = fields[fieldIndex];
const fieldPenalty = fieldIndex * 0.01;
const idx = field.indexOf(token);
let score = RANK_TOKEN_MISS;
if (idx === 0) {
score = fieldPenalty;
} else if (idx > 0) {
const boundary = !/[a-z0-9]/.test(field[idx - 1]);
score = (boundary ? 0.1 : 0.2) + idx / 1000 + fieldPenalty;
} else {
const compactIdx = compact[fieldIndex].indexOf(compactText(token));
if (compactIdx >= 0 && token.length > 1) {
score = 0.4 + compactIdx / 1000 + fieldPenalty;
}
}
if (score < best) best = score;
}
return best;
};
export interface RankByQueryOptions {
limit?: number;
/** Typo-tolerant Fuse fallback for single-token queries (default true). */
fuzzy?: boolean;
}
/**
* The canonical dropdown matcher: every whitespace-separated query token must
* match somewhere in the item's fields (any order, punctuation-insensitive),
* and results come back ordered by relevance — exact/prefix matches first,
* then word-boundary and substring matches, original order breaking ties.
* Single-token queries additionally fall back to typo-tolerant fuzzy matching.
*
* Use this for every searchable dropdown (projects, agents, branches, models)
* instead of ad hoc `toLowerCase().includes` filters, so matching quality and
* ordering stay consistent across pickers.
*/
export function rankByQuery<T>(
items: readonly T[],
query: string,
getTexts: (item: T) => ReadonlyArray<string | null | undefined>,
options?: RankByQueryOptions,
): T[] {
const tokens = tokenizeRankQuery(query);
const limit = options?.limit ?? items.length;
if (tokens.length === 0) return items.slice(0, limit);
const scored: { item: T; score: number; order: number }[] = [];
const missed: { item: T; joined: string; order: number }[] = [];
for (let order = 0; order < items.length; order++) {
const item = items[order];
const rankFields = buildRankFields(getTexts(item));
let total = 0;
for (const token of tokens) {
const tokenScore = scoreRankToken(token, rankFields);
if (tokenScore === RANK_TOKEN_MISS) {
total = RANK_TOKEN_MISS;
break;
}
total += tokenScore;
}
if (total === RANK_TOKEN_MISS) {
missed.push({ item, joined: rankFields.fields.join(' '), order });
} else {
scored.push({ item, score: total, order });
}
}
const fuzzyEnabled = options?.fuzzy ?? true;
if (fuzzyEnabled && tokens.length === 1 && tokens[0].length >= 3 && missed.length > 0) {
const fuse = new Fuse(
missed.map((entry) => entry.joined),
{ threshold: 0.35, ignoreLocation: true, distance: 100, includeScore: true, minMatchCharLength: 2 },
);
for (const result of fuse.search(tokens[0])) {
const entry = missed[result.refIndex];
scored.push({ item: entry.item, score: 1 + (result.score ?? 1), order: entry.order });
}
}
scored.sort((a, b) => (a.score - b.score) || (a.order - b.order));
return scored.slice(0, limit).map((entry) => entry.item);
}
/**
* Boolean companion to `rankByQuery` for lists that keep their own grouping or
* order: every token must match one of the fields, punctuation-insensitive,
* without the fuzzy fallback.
*/
export function matchesRankQuery(
texts: ReadonlyArray<string | null | undefined>,
query: string,
): boolean {
const tokens = tokenizeRankQuery(query);
if (tokens.length === 0) return true;
const rankFields = buildRankFields(texts);
return tokens.every((token) => scoreRankToken(token, rankFields) !== RANK_TOKEN_MISS);
}