@easyops-cn/docusaurus-search-local 0.45.0 → 0.46.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.46.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.45.0...v0.46.0) (2024-11-27)
+
+
+### Features
+
+* move search to Web Worker ([15b7fba](https://github.com/easyops-cn/docusaurus-search-local/commit/15b7fba2537d12eb1674611948e363723dcedae4))
+
 ## [0.45.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.44.6...v0.45.0) (2024-10-09)
 
 

package/dist/client/client/theme/SearchBar/SearchBar.jsx

@@ -6,11 +6,10 @@ import { useHistory, useLocation } from "@docusaurus/router";
 import { translate } from "@docusaurus/Translate";
 import { ReactContextError, useDocsPreferredVersion, } from "@docusaurus/theme-common";
 import { useActivePlugin } from "@docusaurus/plugin-content-docs/client";
-import { fetchIndexes } from "./fetchIndexes";
-import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
+import { fetchIndexesByWorker, searchByWorker } from "../searchByWorker";
 import { SuggestionTemplate } from "./SuggestionTemplate";
 import { EmptyTemplate } from "./EmptyTemplate";
-import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } from "../../utils/proxiedGenerated";
+import { Mark, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import styles from "./SearchBar.module.css";
 import { normalizeContextByPath } from "../../utils/normalizeContextByPath";
@@ -107,9 +106,9 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         indexStateMap.current.set(searchContext, "loading");
         search.current?.autocomplete.destroy();
         setLoading(true);
-        const [{ wrappedIndexes, zhDictionary }, autoComplete] = await Promise.all([
-            fetchIndexes(versionUrl, searchContext),
+        const [autoComplete] = await Promise.all([
             fetchAutoCompleteJS(),
+            fetchIndexesByWorker(versionUrl, searchContext),
         ]);
         const searchFooterLinkElement = ({ query, isEmpty, }) => {
             const a = document.createElement("a");
@@ -187,7 +186,10 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             },
         }, [
             {
-                source: SearchSourceFactory(wrappedIndexes, zhDictionary, searchResultLimits),
+                source: async (input, callback) => {
+                    const result = await searchByWorker(versionUrl, searchContext, input);
+                    callback(result);
+                },
                 templates: {
                     suggestion: SuggestionTemplate,
                     empty: EmptyTemplate,

package/dist/client/client/theme/SearchPage/SearchPage.jsx

@@ -7,8 +7,7 @@ import { translate } from "@docusaurus/Translate";
 import { usePluralForm } from "@docusaurus/theme-common";
 import clsx from "clsx";
 import useSearchQuery from "../hooks/useSearchQuery";
-import { fetchIndexes } from "../SearchBar/fetchIndexes";
-import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
+import { fetchIndexesByWorker, searchByWorker } from "../searchByWorker";
 import { SearchDocumentType, } from "../../../shared/interfaces";
 import { highlight } from "../../utils/highlight";
 import { highlightStemmed } from "../../utils/highlightStemmed";
@@ -28,7 +27,6 @@ function SearchPageContent() {
     const { selectMessage } = usePluralForm();
     const { searchValue, searchContext, searchVersion, updateSearchPath, updateSearchContext, } = useSearchQuery();
     const [searchQuery, setSearchQuery] = useState(searchValue);
-    const [searchSource, setSearchSource] = useState();
     const [searchResults, setSearchResults] = useState();
     const versionUrl = `${baseUrl}${searchVersion}`;
     const pageTitle = useMemo(() => searchQuery
@@ -46,19 +44,18 @@ function SearchPageContent() {
         }), [searchQuery]);
     useEffect(() => {
         updateSearchPath(searchQuery);
-        if (searchSource) {
-            if (searchQuery) {
-                searchSource(searchQuery, (results) => {
-                    setSearchResults(results);
-                });
-            }
-            else {
-                setSearchResults(undefined);
-            }
+        if (searchQuery) {
+            (async () => {
+                const results = await searchByWorker(versionUrl, searchContext, searchQuery);
+                setSearchResults(results);
+            })();
+        }
+        else {
+            setSearchResults(undefined);
         }
         // `updateSearchPath` should not be in the deps,
         // otherwise will cause call stack overflow.
-    }, [searchQuery, searchSource]);
+    }, [searchQuery, versionUrl, searchContext]);
     const handleSearchInputChange = useCallback((e) => {
         setSearchQuery(e.target.value);
     }, []);
@@ -67,14 +64,15 @@ function SearchPageContent() {
             setSearchQuery(searchValue);
         }
     }, [searchValue]);
+    const [searchWorkerReady, setSearchWorkerReady] = useState(false);
     useEffect(() => {
         async function doFetchIndexes() {
-            const { wrappedIndexes, zhDictionary } = !Array.isArray(searchContextByPaths) ||
+            if (!Array.isArray(searchContextByPaths) ||
                 searchContext ||
-                useAllContextsWithNoSearchContext
-                ? await fetchIndexes(versionUrl, searchContext)
-                : { wrappedIndexes: [], zhDictionary: [] };
-            setSearchSource(() => SearchSourceFactory(wrappedIndexes, zhDictionary, 100));
+                useAllContextsWithNoSearchContext) {
+                await fetchIndexesByWorker(versionUrl, searchContext);
+            }
+            setSearchWorkerReady(true);
         }
         doFetchIndexes();
     }, [searchContext, versionUrl]);
@@ -117,7 +115,7 @@ function SearchPageContent() {
             </div>) : null}
         </div>
 
-        {!searchSource && searchQuery && (<div>
+        {!searchWorkerReady && searchQuery && (<div>
             <LoadingRing />
           </div>)}
 

package/dist/client/client/theme/searchByWorker.js

@@ -0,0 +1,24 @@
+import * as Comlink from "comlink";
+let remoteWorkerPromise;
+function getRemoteWorker() {
+    if (!remoteWorkerPromise) {
+        remoteWorkerPromise = (async () => {
+            const Remote = Comlink.wrap(new Worker(new URL("./worker.js", import.meta.url)));
+            return await new Remote();
+        })();
+    }
+    return remoteWorkerPromise;
+}
+export async function fetchIndexesByWorker(baseUrl, searchContext) {
+    if (process.env.NODE_ENV === "production") {
+        const remoteWorker = await getRemoteWorker();
+        await remoteWorker.fetchIndexes(baseUrl, searchContext);
+    }
+}
+export async function searchByWorker(baseUrl, searchContext, input) {
+    if (process.env.NODE_ENV === "production") {
+        const remoteWorker = await getRemoteWorker();
+        return remoteWorker.search(baseUrl, searchContext, input);
+    }
+    return [];
+}

package/dist/client/client/theme/worker.js

@@ -0,0 +1,95 @@
+import * as Comlink from "comlink";
+import lunr from "lunr";
+import { searchIndexUrl, searchResultLimits } from "../utils/proxiedGenerated";
+import { tokenize } from "../utils/tokenize";
+import { smartQueries } from "../utils/smartQueries";
+import { SearchDocumentType, } from "../../shared/interfaces";
+import { sortSearchResults } from "../utils/sortSearchResults";
+import { processTreeStatusOfSearchResults } from "../utils/processTreeStatusOfSearchResults";
+import { language } from "../utils/proxiedGenerated";
+const cache = new Map();
+export class SearchWorker {
+    async fetchIndexes(baseUrl, searchContext) {
+        await this.lowLevelFetchIndexes(baseUrl, searchContext);
+    }
+    async lowLevelFetchIndexes(baseUrl, searchContext) {
+        const cacheKey = `${baseUrl}${searchContext}`;
+        let promise = cache.get(cacheKey);
+        if (!promise) {
+            promise = legacyFetchIndexes(baseUrl, searchContext);
+            cache.set(cacheKey, promise);
+        }
+        return promise;
+    }
+    async search(baseUrl, searchContext, input) {
+        const rawTokens = tokenize(input, language);
+        if (rawTokens.length === 0) {
+            return [];
+        }
+        const { wrappedIndexes, zhDictionary } = await this.lowLevelFetchIndexes(baseUrl, searchContext);
+        const queries = smartQueries(rawTokens, zhDictionary);
+        const results = [];
+        search: for (const { term, tokens } of queries) {
+            for (const { documents, index, type } of wrappedIndexes) {
+                results.push(...index
+                    .query((query) => {
+                    for (const item of term) {
+                        query.term(item.value, {
+                            wildcard: item.wildcard,
+                            presence: item.presence,
+                        });
+                    }
+                })
+                    .slice(0, searchResultLimits)
+                    // Remove duplicated results.
+                    .filter((result) => !results.some((item) => item.document.i.toString() === result.ref))
+                    .slice(0, searchResultLimits - results.length)
+                    .map((result) => {
+                    const document = documents.find((doc) => doc.i.toString() === result.ref);
+                    return {
+                        document,
+                        type,
+                        page: type !== SearchDocumentType.Title &&
+                            wrappedIndexes[0].documents.find((doc) => doc.i === document.p),
+                        metadata: result.matchData.metadata,
+                        tokens,
+                        score: result.score,
+                    };
+                }));
+                if (results.length >= searchResultLimits) {
+                    break search;
+                }
+            }
+        }
+        sortSearchResults(results);
+        processTreeStatusOfSearchResults(results);
+        return results;
+    }
+}
+async function legacyFetchIndexes(baseUrl, searchContext) {
+    const url = `${baseUrl}${searchIndexUrl.replace("{dir}", searchContext ? `-${searchContext.replace(/\//g, "-")}` : "")}`;
+    // Catch potential attacks.
+    const fullUrl = new URL(url, location.origin);
+    if (fullUrl.origin !== location.origin) {
+        throw new Error("Unexpected version url");
+    }
+    const json = (await (await fetch(url)).json());
+    const wrappedIndexes = json.map(({ documents, index }, type) => ({
+        type: type,
+        documents,
+        index: lunr.Index.load(index),
+    }));
+    const zhDictionary = json.reduce((acc, item) => {
+        for (const tuple of item.index.invertedIndex) {
+            if (/\p{Unified_Ideograph}/u.test(tuple[0][0])) {
+                acc.add(tuple[0]);
+            }
+        }
+        return acc;
+    }, new Set());
+    return {
+        wrappedIndexes,
+        zhDictionary: Array.from(zhDictionary),
+    };
+}
+Comlink.expose(SearchWorker);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.45.0",
+  "version": "0.46.0",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": {
     "type": "git",
@@ -39,6 +39,7 @@
     "@node-rs/jieba": "^1.6.0",
     "cheerio": "^1.0.0",
     "clsx": "^1.1.1",
+    "comlink": "^4.4.2",
     "debug": "^4.2.0",
     "fs-extra": "^10.0.0",
     "klaw-sync": "^6.0.0",

package/dist/client/client/theme/SearchBar/fetchIndexes.js

@@ -1,45 +0,0 @@
-import lunr from "lunr";
-import { searchIndexUrl } from "../../utils/proxiedGenerated";
-const cache = new Map();
-export function fetchIndexes(baseUrl, searchContext) {
-    const cacheKey = `${baseUrl}${searchContext}`;
-    let promise = cache.get(cacheKey);
-    if (!promise) {
-        promise = legacyFetchIndexes(baseUrl, searchContext);
-        cache.set(cacheKey, promise);
-    }
-    return promise;
-}
-export async function legacyFetchIndexes(baseUrl, searchContext) {
-    if (process.env.NODE_ENV === "production") {
-        const url = `${baseUrl}${searchIndexUrl.replace("{dir}", searchContext ? `-${searchContext.replace(/\//g, "-")}` : "")}`;
-        // Catch potential attacks.
-        const fullUrl = new URL(url, location.origin);
-        if (fullUrl.origin !== location.origin) {
-            throw new Error("Unexpected version url");
-        }
-        const json = (await (await fetch(url)).json());
-        const wrappedIndexes = json.map(({ documents, index }, type) => ({
-            type: type,
-            documents,
-            index: lunr.Index.load(index),
-        }));
-        const zhDictionary = json.reduce((acc, item) => {
-            for (const tuple of item.index.invertedIndex) {
-                if (/\p{Unified_Ideograph}/u.test(tuple[0][0])) {
-                    acc.add(tuple[0]);
-                }
-            }
-            return acc;
-        }, new Set());
-        return {
-            wrappedIndexes,
-            zhDictionary: Array.from(zhDictionary),
-        };
-    }
-    // The index does not exist in development, therefore load a dummy index here.
-    return {
-        wrappedIndexes: [],
-        zhDictionary: [],
-    };
-}