BUG: Fix bug with prebuilt Lunr.js index by including the crucial part

Ref: ccc3658 ENH: Prebuild Lunr.js search index
pdoc3 · Dec 13, 2024 · 6330d7e · 6330d7e
1 parent aab629c
commit 6330d7e
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 8 deletions.
diff --git a/pdoc/build-index.js b/pdoc/build-index.js
@@ -90,5 +90,5 @@ stdin.on('end', function () {
 
     let out = idx.toJSON();
     compact(out);
-    stdout.write(JSON.stringify(out));
+    stdout.write(JSON.stringify([out, documents]));
 })
diff --git a/pdoc/cli.py b/pdoc/cli.py
@@ -417,12 +417,12 @@ def to_url_id(module):
         recursive_add_to_index(top_module)
     urls = sorted(url_cache.keys(), key=url_cache.__getitem__)
 
-    json_values = [dict(obj, url=urls[obj['url']]) for obj in index]
     cmd = ['node', str(Path(__file__).with_name('build-index.js'))]
     proc = None
     try:
-        proc = subprocess.Popen(cmd, text=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE)
-        stdout, stderr = proc.communicate(json.dumps(json_values))
+        proc = subprocess.Popen(cmd, text=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
+                                stderr=subprocess.PIPE)
+        stdout, stderr = proc.communicate(json.dumps(index))
         assert proc.poll() == 0, proc.poll()
     except Exception as ex:
         stderr = proc and proc.stderr and proc.stderr.read()  # type: ignore
@@ -435,7 +435,8 @@ def to_url_id(module):
         stdout = ('URLS=' + json.dumps(urls, indent=0, separators=(',', ':')) +
                   ';\nINDEX=' + json.dumps(index, indent=0, separators=(',', ':')))
     else:
-        stdout = 'INDEX=' + stdout
+        stdout = (f'let [INDEX, DOCS] = {stdout}; '
+                  f'let URLS={json.dumps(urls, indent=0, separators=(",", ":"))}')
     main_path = args.output_dir
     index_path = Path(main_path).joinpath('index.js')
     index_path.write_text(stdout)

diff --git a/pdoc/templates/search.mako b/pdoc/templates/search.mako
@@ -55,6 +55,7 @@
         try {
             return lunr.Index.load(_expand(INDEX));  // Prebuilt index
         } catch {
+            window.DOCS = INDEX;
             return lunr(function () {
             this.ref('i');
             this.field('name', {boost: 10});
@@ -152,11 +153,11 @@
         }
 
         set_status(
-            'Search for "' + encodeURIComponent(query) + '" yielded ' + results.length + ' ' +
+            'Search for "' + encodeURIComponent(query).replace('%20', ' ') + '" yielded ' + results.length + ' ' +
             (results.length === 1 ? 'result' : 'results') + ':');
 
         results.forEach(function (result) {
-            const dobj = INDEX[parseInt(result.ref)];
+            const dobj = DOCS[parseInt(result.ref)];
             const docstring = dobj.doc;
             const url = URLS[dobj.url] + '#' + dobj.ref;
             const pretty_name = dobj.ref + (dobj.func ? '()' : '');

diff --git a/pdoc/test/__init__.py b/pdoc/test/__init__.py
@@ -274,7 +274,7 @@ def test_lunr_search(self):
             self._basic_html_assertions(expected_files=files)
             self._check_files(exclude_patterns=['class="gcse-search"'])
             if shutil.which('node'):
-                self._check_files(include_patterns=['INDEX={"version"'],
+                self._check_files(include_patterns=['{"version"', 'pdoc.Doc'],
                                   file_pattern='index.js')
             else:
                 self._check_files(