enhance(search): replace fuse with obsidian search

Author: ycnmhd

package-lock.json

@@ -49,7 +49,6 @@
     "dependencies": {
         "classnames": "2.5.1",
         "diff": "5.2.0",
-        "fuse.js": "7.0.0",
         "lucide-svelte": "0.344.0",
         "monkey-around": "3.0.0",
         "nanoid": "5.0.6",

package.json

@@ -3,10 +3,10 @@ import { ViewState } from 'src/stores/view/view-state-type';
 export const defaultViewState = (): ViewState => ({
     search: {
         query: '',
-        results: new Set(),
+        results: new Map(),
         searching: false,
         showInput: false,
-        fuzzySearch: false,
+        fuzzySearch: true,
         showAllNodes: true,
     },
     ui: {

src/stores/view/default-view-state.ts

@@ -9,7 +9,7 @@ export type SetSearchQueryAction = {
 
 export const setSearchQuery = (state: ViewState, query: string) => {
     state.search.query = query;
-    if (!query) state.search.results = new Set();
+    if (!query) state.search.results = new Map();
     state.search.searching = query.length > 0;
     state.search = { ...state.search };
 };

src/stores/view/reducers/search/set-search-query.ts

@@ -1,15 +1,18 @@
-import { NodeId } from 'src/stores/document/document-state-type';
 import { ViewState } from 'src/stores/view/view-state-type';
+import { NodeSearchResult } from 'src/stores/view/subscriptions/effects/document-search/document-search';
 
 export type SetSearchResultsAction = {
     type: 'SEARCH/SET_RESULTS';
     payload: {
-        results: NodeId[];
+        results: Map<string, NodeSearchResult>;
     };
 };
 
-export const setSearchResults = (state: ViewState, results: NodeId[]) => {
-    state.search.results = new Set(results);
+export const setSearchResults = (
+    state: ViewState,
+    results: Map<string, NodeSearchResult>,
+) => {
+    state.search.results = new Map(results);
     state.search.searching = false;
     state.search = { ...state.search };
 };

src/stores/view/reducers/search/set-search-results.ts

@@ -1,45 +1,41 @@
 import { LineageView } from 'src/view/view';
-import { FuseResult } from 'fuse.js';
+import { debounce } from 'obsidian';
 
-const updateActiveNodeAfterSearch = (
+export const updateActiveNodeAfterSearch = (
     view: LineageView,
-    results: FuseResult<{ id: string; content: string }>[],
+    results: string[],
 ) => {
+    const activeNode = view.viewStore.getValue().document.activeNode;
     const shouldUpdateActiveNode =
-        results.length > 0 &&
-        !results.find(
-            (r) => r.item.id === view.viewStore.getValue().document.activeNode,
-        );
+        results.length > 0 && !results.find((r) => r === activeNode);
     if (shouldUpdateActiveNode) {
         view.viewStore.dispatch({
             type: 'view/set-active-node/search',
             payload: {
-                id: results[0].item.id,
+                id: results[0],
             },
         });
     }
 };
 
-export const updateSearchResults = (view: LineageView) => {
+export const updateSearchResults = debounce((view: LineageView) => {
     const viewState = view.viewStore.getValue();
 
     const query = viewState.search.query;
     if (!query) return;
-    const search = view.documentSearch.search(query);
-    const results = search.map((r) => r.item.id);
+    const results = view.documentSearch.search(query);
     view.viewStore.dispatch({
         type: 'SEARCH/SET_RESULTS',
         payload: {
             results: results,
         },
     });
-    // needed in cases where the structure of the document is updated while showing search results (dnd/moving branches)
-    // in these cases, unless search results have changed, active node should be maintained
+
     const newSearchResults = Array.from(results).sort().join('');
-    const previousSearchResults = Array.from(viewState.search.results)
+    const previousSearchResults = Array.from(viewState.search.results.keys())
         .sort()
         .join('');
     if (previousSearchResults !== newSearchResults) {
-        updateActiveNodeAfterSearch(view, search);
+        updateActiveNodeAfterSearch(view, Array.from(results.keys()));
     }
-};
+}, 350);

src/stores/view/subscriptions/actions/update-search-results.ts

@@ -1,42 +1,52 @@
-import Fuse from 'fuse.js';
 import { LineageView } from 'src/view/view';
+import {
+    prepareFuzzySearch,
+    prepareSimpleSearch,
+    SearchResult,
+} from 'obsidian';
+
+type SearchItem = { id: string; content: string };
+
+export type NodeSearchResult = SearchResult;
 
 export class DocumentSearch {
     constructor(private view: LineageView) {}
-    private fuse: Fuse<{ id: string; content: string }> | null;
     #searchTriggeredMinimap: boolean;
-
+    private index: SearchItem[] | null = null;
     private updateIndex = () => {
         const documentState = this.view.documentStore.getValue();
-        const viewState = this.view.viewStore.getValue();
-        const items: { id: string; content: string }[] = [];
+        this.index = [];
         for (const id of Object.keys(documentState.document.content)) {
             const content = documentState.document.content[id]?.content;
             if (content) {
-                items.push({
+                this.index.push({
                     id,
                     content,
                 });
             }
         }
-        this.fuse = new Fuse(items, {
-            keys: ['content'],
-            threshold: viewState.search.fuzzySearch ? 0.4 : 0.1,
-            shouldSort: true,
-            isCaseSensitive: false,
-            ignoreLocation: true,
-        });
     };
 
     resetIndex = () => {
-        this.fuse = null;
+        this.index = null;
     };
 
     search = (query: string) => {
-        if (!this.fuse) {
+        if (!this.index || this.index.length === 0) {
             this.updateIndex();
         }
-        return this.fuse!.search(query);
+        const viewState = this.view.viewStore.getValue();
+        const searchUtil = viewState.search.fuzzySearch
+            ? prepareFuzzySearch
+            : prepareSimpleSearch;
+        const results: Map<string, NodeSearchResult> = new Map();
+        for (const item of this.index!) {
+            const result = searchUtil(query)(item.content);
+            if (result) {
+                results.set(item.id, result);
+            }
+        }
+        return results;
     };
 
     get searchTriggeredMinimap() {

src/view/helpers/document-search.ts …fects/document-search/document-search.tssrc/view/helpers/document-search.ts renamed to src/stores/view/subscriptions/effects/document-search/document-search.ts src/view/helpers/document-search.ts renamed to src/stores/view/subscriptions/effects/document-search/document-search.ts

@@ -1,14 +1,12 @@
-import {
-    NavigationHistory,
-    NodeId,
-} from 'src/stores/document/document-state-type';
+import { NavigationHistory } from 'src/stores/document/document-state-type';
 import {
     ActiveBranch,
     DNDState,
     EditingState,
 } from 'src/stores/view/default-view-state';
 import { ConflictingHotkeys } from 'src/obsidian/helpers/get-used-hotkeys';
 import { NodeStyle } from 'src/stores/settings/types/style-rules-types';
+import { NodeSearchResult } from 'src/stores/view/subscriptions/effects/document-search/document-search';
 
 export type ActiveNodesOfColumn = {
     [columnId: string]: {
@@ -39,7 +37,7 @@ export type RecentNodes = {
 export type ViewState = {
     search: {
         query: string;
-        results: Set<NodeId>;
+        results: Map<string, NodeSearchResult>;
         searching: boolean;
         showInput: boolean;
         fuzzySearch: boolean;

src/stores/view/view-state-type.ts

@@ -5,6 +5,7 @@
     import { EditingState } from 'src/stores/view/default-view-state';
     import { PendingDocumentConfirmation } from 'src/stores/view/view-state-type';
     import { NodeStyle } from 'src/stores/settings/types/style-rules-types';
+    import { NodeSearchResult } from 'src/stores/view/subscriptions/effects/document-search/document-search';
 
     export let columnId: string;
     export let activeChildGroups: Set<string>;
@@ -17,7 +18,7 @@
     export let pendingConfirmation: PendingDocumentConfirmation;
     export let showAllNodes: boolean;
     export let searchQuery: string;
-    export let searchResults: Set<string>;
+    export let searchResults: Map<string,NodeSearchResult>;
     export let pinnedNodes: Set<string>;
     export let allDndNodes: Set<string>;
     export let groupParentIds: Set<string>;

src/view/components/container/column/column.svelte

@@ -7,6 +7,7 @@
     import { PendingDocumentConfirmation } from 'src/stores/view/view-state-type';
     import { nodesStore, singleColumnNodesStore } from 'src/stores/document/derived/nodes-store';
     import { NodeStyle } from 'src/stores/settings/types/style-rules-types';
+    import { NodeSearchResult } from 'src/stores/view/subscriptions/effects/document-search/document-search';
 
     export let groupId: string;
     export let columnId: string;
@@ -18,7 +19,7 @@
     export let editedNodeState: EditingState;
     export let pendingConfirmation: PendingDocumentConfirmation;
     export let searchQuery: string;
-    export let searchResults: Set<string>;
+    export let searchResults: Map<string,NodeSearchResult>;
     export let showAllNodes: boolean;
     export let pinnedNodes: Set<string>;
     export let searching: boolean;