Search index file not found when turn on `hash-files` flag

[tuyen-at-work]

Problem

Search index not being found when turn on hash-files flag:

When I list the files in the build step, I see the file has different hash:

Steps

1. Add this to book.toml:

   [output.html]
   hash-files = true

2. Build the book:

   bin/mdbook build --dest-dir ./docs
   echo "Files:"
   ls -l docs

3. Notice the index file has different hash compared to the one used in the searcher.js:

   

Possible Solution(s)

Maybe ensure that the generation of index file must be finished before the searcher file.

Notes

Live example:

https://cli.eshn.dev/epi-deployment-start-command.html

Version

mdbook v0.4.51

[ehuss]

@notriddle Do you have any ideas why this might be happening? AFAIK we have not been having any issues with rust-lang's doc generation.

@tuyen-at-work Does this reproduce on a new, empty project? If not, is the source to your book publicly available?

[tuyen-at-work]

@ehuss the root cause is something completely different: when the book content changes, the searchindex file name also change, but the searcher file name does not change.

Since I use caching for all JS files - it makes sense if you add hashes to file names like this case - thus the browser still load the old content of searcher.
If we don't turn on cache, the brower ends up loading the fresh version of those JS files every time, defeat the point of including their hashes in the URLs.

I created a very simple demo in a test repository. It contains only 2 commits:

Changes between the 2 commit: changes

GitHub workflow

You can see in the following sample, when the searchindex file name change, the searcher file name doesn't change, thus will cause issue with CDN/browser caching:

First commit:

Second commit:

Suggestion

When the searchindex filename change, re-hash the searcher file to have updated file name, and avoid the caching issue.

[tuyen-at-work]

@ehuss I see the offical mdBook's book only cache the JS for 10 mins, so the issue - if occurs - only happen during 10 mins after deployment, maybe too short for maintainer to notice. I cache those files for 1 year, so the error persist for very long time. You can try change something from your local machine, and see if both seacher and searchindex file change the hashes at the same time. I can reproduce from my end where searchindex file name change but the searcher doesn't.