Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
feat(search): highlight the word a fuzzy body match actually matched
Elian Dorana233d554d751
diff --git a/packages/trilium-core/src/services/search/expressions/note_content_fulltext.ts b/packages/trilium-core/src/services/search/expressions/note_content_fulltext.tsindex 073f9fd335..5386617d15 100644--- a/packages/trilium-core/src/services/search/expressions/note_content_fulltext.ts+++ b/packages/trilium-core/src/services/search/expressions/note_content_fulltext.ts@@ -8,7 +8,7 @@ import NoteSet from "../note_set.js";import type SearchContext from "../search_context.js";import {FUZZY_SEARCH_CONFIG,- fuzzyMatchWord,+ fuzzyMatchWordWithResult,getAutoMaxEditDistance,normalizeSearchText,stripWordPunctuation,@@ -256,17 +256,19 @@ class NoteContentFulltextExp extends Expression {// A4: progressive phase-2 fuzzy fallback for plain-query body content. Only// runs for notes that failed the cheap match above, and only when this is the// default *=* content expression (fuzzyFallback) with fuzzy matching enabled.- const fuzzyMatched = !matched && !negation && this.fuzzyFallback && searchContext.enableFuzzyMatching- && this.allTokensFuzzyMatchContent(content);+ const fuzzyMatchedWords = !matched && !negation && this.fuzzyFallback && searchContext.enableFuzzyMatching+ ? this.allTokensFuzzyMatchContent(content)+ : null;- if (matched || fuzzyMatched) {+ if (matched || fuzzyMatchedWords) {resultNoteSet.add(becca.notes[noteId]);- if (fuzzyMatched) {+ if (fuzzyMatchedWords) {searchContext.recordContentMatch(noteId, {tier: "fuzzy",matchedTokenCount: new Set(this.tokens.flatMap((token) => tokenizeIntoWords(token))).size,- inOrder: false+ inOrder: false,+ matchedWords: fuzzyMatchedWords});} else if (!negation) {// Record how well the content matched so scoring can rank body matches.@@ -280,17 +282,31 @@ class NoteContentFulltextExp extends Expression {}/**- * True when every query token fuzzy-matches (or is a substring of) some word in- * the content. Used only by the phase-2 fuzzy fallback; per-word work is bounded- * by the length-difference early-skip and AUTO edit distances.+ * Returns the content words that stood in for each query token when every token+ * fuzzy-matches (or is a substring of) some word in the content, else null. The returned+ * words are what the result card highlights, so a fuzzy hit can show why it matched.+ * Used only by the phase-2 fuzzy fallback; per-word work is bounded by the+ * length-difference early-skip and AUTO edit distances.*/- private allTokensFuzzyMatchContent(content: string): boolean {+ private allTokensFuzzyMatchContent(content: string): string[] | null {const normalizedContent = normalizeSearchText(content);+ const matchedWords: string[] = [];- return this.tokens.every((token) => {+ for (const token of this.tokens) {const normalizedToken = normalizeSearchText(token);- return normalizedContent.includes(normalizedToken) || this.fuzzyMatchToken(normalizedToken, normalizedContent);- });+ if (normalizedContent.includes(normalizedToken)) {+ continue;+ }++ const matchedWord = this.fuzzyMatchToken(normalizedToken, normalizedContent);+ if (!matchedWord) {+ return null;+ }++ matchedWords.push(matchedWord);+ }++ return matchedWords;}/**@@ -415,8 +431,8 @@ class NoteContentFulltextExp extends Expression {// Single token fuzzy matchingconst token = normalizeSearchText(this.tokens[0]);- return this.fuzzyMatchToken(token, normalizedContent) ||- (this.flatText && this.fuzzyMatchToken(token, flatText));+ return this.fuzzyMatchToken(token, normalizedContent) !== null ||+ (this.flatText && this.fuzzyMatchToken(token, flatText) !== null);} catch (error) {getLog().error(`Error in fuzzy matching for note ${noteId}: ${error}`);return false;@@ -497,12 +513,13 @@ class NoteContentFulltextExp extends Expression {}/**- * Performs fuzzy matching for a single token against content+ * Performs fuzzy matching for a single token against content, returning the content word+ * it matched so callers can highlight it, or null when nothing matched.*/- private fuzzyMatchToken(token: string, content: string): boolean {+ private fuzzyMatchToken(token: string, content: string): string | null {if (token.length < FUZZY_SEARCH_CONFIG.MIN_FUZZY_TOKEN_LENGTH) {// For short tokens, require exact match to avoid too many false positives- return content.includes(token);+ return content.includes(token) ? token : null;}const words = content.split(/\s+/);@@ -510,7 +527,14 @@ class NoteContentFulltextExp extends Expression {// Only limit word processing for truly extreme cases to prevent system instabilityconst limitedWords = words.slice(0, FUZZY_SEARCH_CONFIG.ABSOLUTE_MAX_WORD_COUNT);- return limitedWords.some(word => this.fuzzyMatchSingle(token, word));+ for (const word of limitedWords) {+ const matchedWord = this.fuzzyMatchSingle(token, word);+ if (matchedWord) {+ return matchedWord;+ }+ }++ return null;}/**@@ -520,16 +544,16 @@ class NoteContentFulltextExp extends Expression {* (fuzzy equals, word-level via fuzzyMatchToken) unaffected.*/private fuzzyContainsToken(token: string, content: string): boolean {- return content.includes(token) || this.fuzzyMatchToken(token, content);+ return content.includes(token) || this.fuzzyMatchToken(token, content) !== null;}/**- * Fuzzy matches a single token against a single word+ * Fuzzy matches a single token against a single word, returning the word it matched so+ * callers can highlight it. The edit-distance bound is length-scaled (AUTO), so short+ * tokens do not produce false positives.*/- private fuzzyMatchSingle(token: string, word: string): boolean {- // Use shared optimized fuzzy matching logic with a length-scaled (AUTO)- // edit-distance bound so short tokens don't produce false positives.- return fuzzyMatchWord(token, word, getAutoMaxEditDistance(token.length));+ private fuzzyMatchSingle(token: string, word: string): string | null {+ return fuzzyMatchWordWithResult(token, word, getAutoMaxEditDistance(token.length));}}diff --git a/packages/trilium-core/src/services/search/match_quality.ts b/packages/trilium-core/src/services/search/match_quality.tsindex bfbe01c7ba..8508cd1cb3 100644--- a/packages/trilium-core/src/services/search/match_quality.ts+++ b/packages/trilium-core/src/services/search/match_quality.ts@@ -15,6 +15,11 @@ export interface ContentMatchQuality {matchedTokenCount: number;/** Proximity only: whether the tokens appeared in query order within the window. */inOrder: boolean;+ /**+ * Fuzzy tier only: the content words that stood in for the query tokens. The result card+ * highlights these, so an approximate hit shows the word it actually matched.+ */+ matchedWords?: string[];}const TIER_RANK: Record<ContentMatchTier, number> = {diff --git a/packages/trilium-core/src/services/search/services/search.spec.ts b/packages/trilium-core/src/services/search/services/search.spec.tsindex 492140f95a..395adad233 100644--- a/packages/trilium-core/src/services/search/services/search.spec.ts+++ b/packages/trilium-core/src/services/search/services/search.spec.ts@@ -995,6 +995,51 @@ describe("Search", () => {});});+ describe("fuzzy content match highlighting", () => {+ function contentNote(title: string, content: string) {+ return getContext().init(() => noteService.createNewNote({+ parentNoteId: "root",+ title,+ content,+ type: "text"+ }).note);+ }++ function detailsFor(query: string) {+ const searchContext = new SearchContext();+ const results = searchService.findResultsWithQuery(query, searchContext);+ return searchService.buildSearchResultDetails(results, searchContext);+ }++ it("highlights the word a fuzzy body match actually matched", () => {+ // "writer" is two edits from "orbiter", which AUTO allows for a 7-character token, so+ // this note is a result even though the word the user typed appears nowhere in it.+ // The padding pushes the match past the snippet window, so the excerpt only reaches it+ // by centering on the matched word rather than starting at the top of the note.+ const asimov = contentNote("Asimov", `<p>${"padding ".repeat(60)}by American writer Isaac Asimov</p>`);++ const detail = detailsFor("orbiter").find((d) => d.noteId === asimov.noteId);++ expect(detail?.contentSnippet).toContain("writer");+ expect(detail?.highlightedContentSnippet).toContain("<b>writer</b>");+ });++ it("keeps one note's fuzzy word out of another note's highlighting", () => {+ const shuttle = contentNote("Shuttle", "<p>The Orbiter met the writer yesterday.</p>");+ const asimov = contentNote("Asimov", "<p>a short story by American writer Isaac Asimov</p>");++ const details = detailsFor("orbiter");+ const exact = details.find((d) => d.noteId === shuttle.noteId);+ const fuzzy = details.find((d) => d.noteId === asimov.noteId);++ // The exact match highlights only what was typed, even though "writer" is the word+ // that pulled the other note in and appears here too.+ expect(exact?.highlightedContentSnippet).toContain("<b>Orbiter</b>");+ expect(exact?.highlightedContentSnippet).not.toContain("<b>writer</b>");+ expect(fuzzy?.highlightedContentSnippet).toContain("<b>writer</b>");+ });+ });+it("breaks a collapsible summary onto its own line in the quick-search snippet", () => {// striptags concatenates block text with no separator, which would merge adiff --git a/packages/trilium-core/src/services/search/services/search.ts b/packages/trilium-core/src/services/search/services/search.tsindex df26df0711..81aa4422ad 100644--- a/packages/trilium-core/src/services/search/services/search.ts+++ b/packages/trilium-core/src/services/search/services/search.ts@@ -748,11 +748,17 @@ function buildSearchResultDetails(results: SearchResult[], searchContext: Searchconst tokenInfos = searchContext.getHighlightedTokenInfos();for (const result of results) {- result.contentSnippet = extractContentSnippet(result.noteId, tokenInfos);- result.attributeSnippet = extractAttributeSnippet(result.noteId, tokenInfos);- }+ // A fuzzy hit matched a word the user did not type, so highlight that word for this note+ // alone. Without it the card carries no visible reason for being in the results at all.+ const matchedWords = searchContext.contentMatches.get(result.noteId)?.matchedWords ?? [];+ const noteTokenInfos: HighlightedTokenInfo[] = matchedWords.length+ ? [ ...tokenInfos, ...matchedWords.map((token) => ({ token, type: "plain" as const })) ]+ : tokenInfos;- highlightSearchResults(results, tokenInfos, searchContext.ignoreInternalAttributes);+ result.contentSnippet = extractContentSnippet(result.noteId, noteTokenInfos);+ result.attributeSnippet = extractAttributeSnippet(result.noteId, noteTokenInfos);+ highlightSearchResults([ result ], noteTokenInfos, searchContext.ignoreInternalAttributes);+ }return results.map((result) => {const { title, icon } = becca_service.getNoteTitleAndIcon(result.noteId);