Skip to content

Fix error-index redirect to work with the back button. #106491

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 2 commits into from
Jan 6, 2023
Merged

Fix error-index redirect to work with the back button. #106491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2ad85a
Fix error-index redirect to work with back button.
ehuss Jan 5, 2023
72c3082
error-index: Don't generate 404 instead of removing it.
ehuss Jan 5, 2023
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
1 change: 1 addition & 0 deletions src/tools/error_index_generator/book_config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ src = ""
git-repository-url = "https://github.com/rust-lang/rust/"
additional-css = ["error-index.css"]
additional-js = ["error-index.js"]
input-404 = ""
Copy link
Member

Choose a reason for hiding this comment

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

Nice improvement!


[output.html.search]
enable = true
Expand Down
14 changes: 7 additions & 7 deletions src/tools/error_index_generator/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@ fn add_rust_attribute_on_codeblock(explanation: &str) -> String {

fn render_html(output_path: &Path) -> Result<(), Box<dyn Error>> {
let mut introduction = format!(
"<script src='redirect.js'></script>
# Rust error codes index
"# Rust error codes index

This page lists all the error codes emitted by the Rust compiler.

Expand Down Expand Up @@ -149,7 +148,12 @@ This page lists all the error codes emitted by the Rust compiler.
book.book.sections.push(BookItem::Chapter(chapter));
book.build()?;

// We can't put this content into another file, otherwise `mbdbook` will also put it into the
// The error-index used to be generated manually (without mdbook), and the
// index was located at the top level. Now that it is generated with
// mdbook, error-index.html has moved to error_codes/error-index.html.
// This adds a redirect so that old links go to the new location.
//
// We can't put this content into another file, otherwise `mdbook` will also put it into the
// output directory, making a duplicate.
fs::write(
output_path.join("error-index.html"),
Expand All @@ -163,14 +167,10 @@ This page lists all the error codes emitted by the Rust compiler.
</head>
<body>
<div>If you are not automatically redirected to the error code index, please <a id="index-link" href="./error_codes/error-index.html">here</a>.
<script>document.getElementById("index-link").click()</script>
</body>
</html>"#,
)?;

// No need for a 404 file, it's already handled by the server.
fs::remove_file(output_path.join("error_codes/404.html"))?;

Ok(())
}

Expand Down
10 changes: 3 additions & 7 deletions src/tools/error_index_generator/redirect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,10 @@
let code = window.location.hash.replace(/^#/, '');
// We have to make sure this pattern matches to avoid inadvertently creating an
// open redirect.
if (!/^E[0-9]+$/.test(code)) {
if (/^E[0-9]+$/.test(code)) {
window.location.replace('./error_codes/' + code + '.html');
return;
}
if (window.location.pathname.indexOf("/error_codes/") !== -1) {
// We're not at the top level, so we don't prepend with "./error_codes/".
window.location = './' + code + '.html';
} else {
window.location = './error_codes/' + code + '.html';
}
}
window.location.replace('./error_codes/error-index.html');
})()