Skip to content

Remove direct search index reference from searcher #2742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2025
Merged

Remove direct search index reference from searcher #2742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/front-end/searcher/searcher.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ window.search = window.search || {};

function showSearch(yes) {
if (yes) {
loadSearchScript(path_to_root + '{{ resource "searchindex.js" }}', 'search-index');
loadSearchScript(window.path_to_searchindex_js, 'search-index');
search_wrap.classList.remove('hidden');
searchicon.setAttribute('aria-expanded', 'true');
} else {
Expand Down
3 changes: 3 additions & 0 deletions src/front-end/templates/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@
const path_to_root = "{{ path_to_root }}";
const default_light_theme = "{{ default_theme }}";
const default_dark_theme = "{{ preferred_dark_theme }}";
{{#if search_js}}
window.path_to_searchindex_js = "{{ resource "searchindex.js" }}";
{{/if}}
Comment on lines +61 to +63
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to be careful with changes like this, since it looks like it will break anyone who has overridden index.hbs. Is there any way to avoid that breakage?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have an official policy for breaking changes in *.hbs files?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally we try to avoid any breaking changes (except across major releases).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted but that is a big brake on any changes in this file or even for this format. Is it an official feature and mentioned as such or just something we provide as a best effort?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can avoid breaking change by re-hash the searcher URL, though I understand it takes much higher effort than this approach.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are referring to index.hbs being customizable, yes it is documented here: https://rust-lang.github.io/mdBook/format/theme/index-hbs.html#indexhbs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would adjusting the searcher.js script to use the old way, if index.hbs hasn't been updated, be an acceptable solution?

diff --git a/src/front-end/searcher/searcher.js b/src/front-end/searcher/searcher.js
index e92c1c854a..17af071aec 100644
--- a/src/front-end/searcher/searcher.js
+++ b/src/front-end/searcher/searcher.js
@@ -434,7 +434,7 @@ window.search = window.search || {};
 
     function showSearch(yes) {
         if (yes) {
-            loadSearchScript(window.path_to_searchindex_js, 'search-index');
+            loadSearchScript(window.path_to_searchindex_js || (path_to_root + '{{ resource "searchindex.js" }}'), 'search-index');
             search_wrap.classList.remove('hidden');
             searchicon.setAttribute('aria-expanded', 'true');
         } else {

This means updating mdbook won't fix the bug on its own, if you haven't also updated your theme, but it still solves the problem for @tuyen-at-work (and we can remove this hack next time a breaking release goes out).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before this PR was created, I used a hacky way, that is append the searchindex hash into searcher's URL:

image

Live example can be found here.

I used Bash script to achieve it, not very nice but does solve the cache issue.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That diff looks like it should work to me, thanks!

</script>
<!-- Start loading toc.js asap -->
<script src="{{ resource "toc.js" }}"></script>
Expand Down