Fix JS search scripts path #145650

GuillaumeGomez · 2025-08-20T10:16:49Z

rootPath always end with a / so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/).

Follow-up of #144476.
Fixes #145646.

cc @notriddle
r? @fmease

rustbot · 2025-08-20T10:16:54Z

fmease is not on the review rotation at the moment.
They may take a while to respond.

rustbot · 2025-08-20T10:16:57Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha, @lolbinarycat

src/librustdoc/html/static/js/search.js

fmease · 2025-08-20T12:18:09Z

Interestingly enough, it only triggers the bug on a website

Locally, if we're dealing with file://, the URL also contains double slashes (e.g, file:///home/fmease/programming/rust/rustc3/doc//search.index/path/d30b089bc95f.js) but at least on Linux consecutive slashes get normalized to a single one, so it ends up resolving.

fmease

Thanks!

I've manually gone through all references of ROOT_PATH and "DocSearch#rootPath" (set to ROOT_PATH in the ctor) and all other sites seem to append path segments correctly (i.e., without an extra slash).

fmease · 2025-08-20T12:25:17Z

@bors r+ rollup

bors · 2025-08-20T12:25:19Z

📌 Commit e1045c2 has been approved by fmease

It is now in the queue for this repository.

…ts-path, r=fmease Fix JS search scripts path `rootPath` always end with a `/` so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/). Follow-up of rust-lang#144476. Fixes rust-lang#145646. cc `@notriddle` r? `@fmease`

Zalathar · 2025-08-20T12:43:31Z

I've taken the liberty of rolling this up (despite the backlog) because I think it's worthwhile to get doc search working again ASAP.

Rollup of 5 pull requests Successful merges: - #144915 (Defer tail call ret ty equality to check_tail_calls) - #145256 (Add new `--test-codegen-backend` bootstrap option) - #145415 (std_detect: RISC-V: implement implication to "C") - #145647 (miri subtree update) - #145650 (Fix JS search scripts path) r? `@ghost` `@rustbot` modify labels: rollup

lolbinarycat · 2025-08-20T15:29:36Z

Locally, if we're dealing with file://, the URL also contains double slashes (e.g, file:///home/fmease/programming/rust/rustc3/doc//search.index/path/d30b089bc95f.js) but at least on Linux consecutive slashes get normalized to a single one, so it ends up resolving.

most http servers also deduplicate consecutive slashes, but apparently not the one that rust documentation is hosted on.

blyxyas · 2025-08-20T15:35:07Z

It also affected docs.rs, so Axum doesn't deduplicate slashes it seems.
tokio-rs/axum#714 might be related?

fmease · 2025-08-20T15:50:54Z

That just means that rustdoc can't assume that consecutive slashes get normalized away by whomever ends up interpreting the path.

lolbinarycat · 2025-08-20T15:54:42Z

That just means that rustdoc can't assume that consecutive slashes get normalized away by whomever ends up interpreting the path.

Is there a way we can modify the gui testing framework to error if there are ever duplicated slashes in the URL path? that seems desirable to stop this from happening again.

fmease · 2025-08-20T15:56:17Z

CC https://en.wikipedia.org/wiki/URI_normalization which classifies "slash collapsing" to not necessarily be semantics-preserving.

notriddle · 2025-08-20T15:57:51Z

Yes. I'll have a PR open that tests this in a few minutes.

…ts-path, r=fmease Fix JS search scripts path `rootPath` always end with a `/` so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/). Follow-up of rust-lang#144476. Fixes rust-lang#145646. cc `@notriddle` r? `@fmease`

Rollup of 12 pull requests Successful merges: - #143383 (stabilize `const_array_each_ref`) - #144443 (Make target pointer width in target json an integer) - #144758 ([Doc] Add links to the various collections) - #144915 (Defer tail call ret ty equality to check_tail_calls) - #145256 (Add new `--test-codegen-backend` bootstrap option) - #145415 (std_detect: RISC-V: implement implication to "C") - #145573 (Add an experimental unsafe(force_target_feature) attribute.) - #145642 (Do not use effective_visibilities query for Adt types of a local trait while proving a where-clause) - #145650 (Fix JS search scripts path) - #145654 (Download CI GCC into the correct directory) - #145662 (Enforce correct number of arguments for `"x86-interrupt"` functions) - #145674 (Enable triagebot `[review-changes-since]` feature) Failed merges: - #145647 (miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup

…ts-path, r=fmease Fix JS search scripts path `rootPath` always end with a `/` so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/). Follow-up of rust-lang#144476. Fixes rust-lang#145646. cc ``@notriddle`` r? ``@fmease``

Rollup of 14 pull requests Successful merges: - #143383 (stabilize `const_array_each_ref`) - #144443 (Make target pointer width in target json an integer) - #144758 ([Doc] Add links to the various collections) - #144915 (Defer tail call ret ty equality to check_tail_calls) - #145137 (Consolidate panicking functions in `slice/index.rs`) - #145256 (Add new `--test-codegen-backend` bootstrap option) - #145297 (fix(debuginfo): handle false positives in overflow check) - #145415 (std_detect: RISC-V: implement implication to "C") - #145642 (Do not use effective_visibilities query for Adt types of a local trait while proving a where-clause) - #145650 (Fix JS search scripts path) - #145654 (Download CI GCC into the correct directory) - #145662 (Enforce correct number of arguments for `"x86-interrupt"` functions) - #145674 (Enable triagebot `[review-changes-since]` feature) - #145678 (Fix typo in docstring) r? `@ghost` `@rustbot` modify labels: rollup

…ts-path, r=fmease Fix JS search scripts path `rootPath` always end with a `/` so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/). Follow-up of rust-lang#144476. Fixes rust-lang#145646. cc ```@notriddle``` r? ```@fmease```

Rollup of 15 pull requests Successful merges: - #143383 (stabilize `const_array_each_ref`) - #144758 ([Doc] Add links to the various collections) - #144915 (Defer tail call ret ty equality to check_tail_calls) - #145137 (Consolidate panicking functions in `slice/index.rs`) - #145256 (Add new `--test-codegen-backend` bootstrap option) - #145297 (fix(debuginfo): handle false positives in overflow check) - #145415 (std_detect: RISC-V: implement implication to "C") - #145590 (Prevent impossible combinations in `ast::ModKind`.) - #145621 (Fix some doc typos) - #145642 (Do not use effective_visibilities query for Adt types of a local trait while proving a where-clause) - #145650 (Fix JS search scripts path) - #145654 (Download CI GCC into the correct directory) - #145662 (Enforce correct number of arguments for `"x86-interrupt"` functions) - #145674 (Enable triagebot `[review-changes-since]` feature) - #145678 (Fix typo in docstring) r? `@ghost` `@rustbot` modify labels: rollup

…ts-path, r=fmease Fix JS search scripts path `rootPath` always end with a `/` so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/). Follow-up of rust-lang#144476. Fixes rust-lang#145646. cc ````@notriddle```` r? ````@fmease````

Rollup of 19 pull requests Successful merges: - #143383 (stabilize `const_array_each_ref`) - #144758 ([Doc] Add links to the various collections) - #144915 (Defer tail call ret ty equality to check_tail_calls) - #145256 (Add new `--test-codegen-backend` bootstrap option) - #145297 (fix(debuginfo): handle false positives in overflow check) - #145390 (Shorten some dependency chains in the compiler) - #145415 (std_detect: RISC-V: implement implication to "C") - #145525 (stdlib: Replace typedef -> type alias in doc comment) - #145590 (Prevent impossible combinations in `ast::ModKind`.) - #145593 (UnsafePinned::raw_get: sync signature with get) - #145621 (Fix some doc typos) - #145627 (Unconditionally-const supertraits are considered not dyn compatible) - #145642 (Do not use effective_visibilities query for Adt types of a local trait while proving a where-clause) - #145650 (Fix JS search scripts path) - #145654 (Download CI GCC into the correct directory) - #145662 (Enforce correct number of arguments for `"x86-interrupt"` functions) - #145673 (Add flock support for cygwin) - #145674 (Enable triagebot `[review-changes-since]` feature) - #145678 (Fix typo in docstring) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #145650 - GuillaumeGomez:fix-js-search-scripts-path, r=fmease Fix JS search scripts path `rootPath` always end with a `/` so we should not add one. Interestingly enough, it only triggers the bug on a website (like https://doc.rust-lang.org/nightly/std/). Follow-up of #144476. Fixes #145646. cc `````@notriddle````` r? `````@fmease`````

BergmannAtmet · 2025-08-21T22:38:50Z

A safer way to construct paths needs to be used in my humble opinion, so this doesn't keep happening.

That crates.io issue was Rust code which should have just used Url::join() or whatever. And I'm sure similar solutions exist for JS too.

GuillaumeGomez · 2025-08-21T23:01:27Z

Thank you unknown person from the internet. I'm sure you commented with good intentions but sadly, there are some issues with your comment:

crates.io codebase and rustdoc codebase are completely separate, and one issue impacting a side might have a very different cause than on the other (which is actually exactly the case here).
There doesn't seem to have a provided way to do that in web browsers directly, otherwise it would be much simpler to handle that.
// is valid in URLs, and sometimes the web server replaces them with one slash, sometimes it doesn't, hence why we didn't realize until we actually ended up generating docs on a server which actually keeps the double slash.

This PR fixes the issue and and most importantly: a follow-up (#145669) will add a regression test to ensure it doesn't happen again.

So now comes the "wise man talk": comments are very welcome, but considering how stressful this has been for the people involved, if you just come in saying "why are you so bad at doing this thing?", it's just annoying and counter-productive. However if you came with a useful information like "you could use this vanilla JS method to handle paths", then we'd be very happy.

BergmannAtmet · 2025-08-22T16:48:59Z

@GuillaumeGomez

I don't do JS, so I assumed people familiar with it would know better.

Having said that, this seems to work.

(I wrote a silly and technically wrong comment earlier which I promptly deleted.)

notriddle · 2025-08-22T18:59:20Z

I think it would make more sense to use the URL interface from the DOM. The Rustdoc frontend has no build step, and I'd prefer not to add one.

…ath, r=GuillaumeGomez rustdoc-search: GUI tests check for `//` in URL Follow up rust-lang#145650 When this fails, you get output that looks like: /home/user/rust/tests/rustdoc-gui/search-result-impl-disambiguation.goml search-result-impl-disambiguation... FAILED [ERROR] `tests/rustdoc-gui/utils.goml` around line 49 from `tests/rustdoc-gui/search-result-impl-disambiguation.goml` line 25: JS errors occurred: Event: Event Making the error message more informative requires patching browser-ui-test.

Rollup merge of #145669 - notriddle:test-js-search-scripts-path, r=GuillaumeGomez rustdoc-search: GUI tests check for `//` in URL Follow up #145650 When this fails, you get output that looks like: /home/user/rust/tests/rustdoc-gui/search-result-impl-disambiguation.goml search-result-impl-disambiguation... FAILED [ERROR] `tests/rustdoc-gui/utils.goml` around line 49 from `tests/rustdoc-gui/search-result-impl-disambiguation.goml` line 25: JS errors occurred: Event: Event Making the error message more informative requires patching browser-ui-test.

…illaumeGomez rustdoc-search: GUI tests check for `//` in URL Follow up rust-lang/rust#145650 When this fails, you get output that looks like: /home/user/rust/tests/rustdoc-gui/search-result-impl-disambiguation.goml search-result-impl-disambiguation... FAILED [ERROR] `tests/rustdoc-gui/utils.goml` around line 49 from `tests/rustdoc-gui/search-result-impl-disambiguation.goml` line 25: JS errors occurred: Event: Event Making the error message more informative requires patching browser-ui-test.

rustbot assigned fmease Aug 20, 2025

This comment has been minimized.

Sign in to view

lqd reviewed Aug 20, 2025

View reviewed changes

src/librustdoc/html/static/js/search.js Outdated Show resolved Hide resolved

Fix JS search scripts path

e1045c2

GuillaumeGomez force-pushed the fix-js-search-scripts-path branch from d15d582 to e1045c2 Compare August 20, 2025 10:57

fmease approved these changes Aug 20, 2025

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 20, 2025

Zalathar mentioned this pull request Aug 20, 2025

Rollup of 5 pull requests #145658

Closed

notriddle mentioned this pull request Aug 20, 2025

rustdoc-search: GUI tests check for // in URL #145669

Merged

jhpratt mentioned this pull request Aug 20, 2025

Rollup of 12 pull requests #145680

Closed

jhpratt mentioned this pull request Aug 20, 2025

Rollup of 14 pull requests #145681

Closed

jhpratt mentioned this pull request Aug 21, 2025

Rollup of 15 pull requests #145691

Closed

This was referenced Aug 21, 2025

Rollup of 20 pull requests #145697

Closed

Rollup of 19 pull requests #145701

Merged

bors merged commit 5ea203a into rust-lang:master Aug 21, 2025
10 checks passed

rustbot added this to the 1.91.0 milestone Aug 21, 2025

GuillaumeGomez deleted the fix-js-search-scripts-path branch August 21, 2025 10:22

GuillaumeGomez mentioned this pull request Aug 21, 2025

rustdoc search not working on nightly #145715

Closed

Fix JS search scripts path #145650

Fix JS search scripts path #145650

Conversation

GuillaumeGomez commented Aug 20, 2025 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Aug 20, 2025

Uh oh!

rustbot commented Aug 20, 2025

Uh oh!

This comment has been minimized.

Uh oh!

fmease commented Aug 20, 2025

Uh oh!

fmease left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fmease commented Aug 20, 2025

Uh oh!

bors commented Aug 20, 2025

Uh oh!

Zalathar commented Aug 20, 2025

Uh oh!

lolbinarycat commented Aug 20, 2025

Uh oh!

blyxyas commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fmease commented Aug 20, 2025

Uh oh!

lolbinarycat commented Aug 20, 2025

Uh oh!

fmease commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

notriddle commented Aug 20, 2025

Uh oh!

Uh oh!

BergmannAtmet commented Aug 21, 2025

Uh oh!

GuillaumeGomez commented Aug 21, 2025

Uh oh!

BergmannAtmet commented Aug 22, 2025

Uh oh!

notriddle commented Aug 22, 2025

Uh oh!

Uh oh!

GuillaumeGomez commented Aug 20, 2025 •

edited by rustbot

Loading

fmease left a comment •

edited

Loading

blyxyas commented Aug 20, 2025 •

edited

Loading

fmease commented Aug 20, 2025 •

edited

Loading