Skip to content
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.

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

[rustdoc] Fix invalid handling of "going back in history" when "go to only search result" setting is enabled #112707

Merged
merged 3 commits into from
Jun 17, 2023

Conversation

GuillaumeGomez
Copy link
Member

You can test the fix here. Enable "Directly go to item in search if there is only one result", then search for HasALongTraitWithParams and finally go back to previous page. It should be back on the index.html page.

The reason for this bug is that the JS state is cached as is, so when we go back to the page, it resumes where it was left, somewhat (very weird), meaning the search is run again etc. The best way to handle this is to force the JS re-execution in this case so that it doesn't try to resume from where it left and then lead us back to the current page.

r? @notriddle

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 16, 2023
@rustbot
Copy link
Collaborator

rustbot commented Jun 16, 2023

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @Folyd, @jsha

src/librustdoc/html/static/js/search.js Outdated Show resolved Hide resolved
tests/rustdoc-gui/go-to-only-result-back-history.goml Outdated Show resolved Hide resolved
@GuillaumeGomez
Copy link
Member Author

Moved the regression test into the existing test file and fixed the typo.

@notriddle
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 16, 2023

📌 Commit ea55d25 has been approved by notriddle

It is now in the queue for this repository.

@bors 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 Jun 16, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 17, 2023
…, r=notriddle

[rustdoc] Fix invalid handling of "going back in history" when "go to only search result" setting is enabled

You can test the fix [here](https://rustdoc.crud.net/imperio/back-in-history-fix/lib2/index.html). Enable "Directly go to item in search if there is only one result", then search for `HasALongTraitWithParams` and finally go back to previous page. It should be back on the `index.html` page.

The reason for this bug is that the JS state is cached as is, so when we go back to the page, it resumes where it was left, somewhat (very weird), meaning the search is run again etc. The best way to handle this is to force the JS re-execution in this case so that it doesn't try to resume from where it left and then lead us back to the current page.

r? `@notriddle`
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 17, 2023
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#112352 (Fix documentation build on FreeBSD)
 - rust-lang#112644 (Correct types in method descriptions of `NonZero*` types)
 - rust-lang#112683 (fix ICE on specific malformed asm clobber_abi)
 - rust-lang#112707 ([rustdoc] Fix invalid handling of "going back in history" when "go to only search result" setting is enabled)
 - rust-lang#112719 (Replace fvdl with ffx, allow test without install)
 - rust-lang#112728 (Add `<meta charset="utf-8">` to `-Zdump-mir-spanview` output)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 63799ba into rust-lang:master Jun 17, 2023
@rustbot rustbot added this to the 1.72.0 milestone Jun 17, 2023
@GuillaumeGomez GuillaumeGomez deleted the back-in-history-fix branch June 17, 2023 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants