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.

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

Set X-Robots-Tag: noindex for nonlatest rustdoc #2023

Merged
merged 5 commits into from
Feb 4, 2023
Merged

Set X-Robots-Tag: noindex for nonlatest rustdoc #2023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4813184
Set X-Robots-Tag: noindex for nonlatest rustdoc
jsha Feb 2, 2023
551962f
Use a plain array
jsha Feb 2, 2023
b43d826
Use Some([header])
jsha Feb 2, 2023
84d979e
Fix test
jsha Feb 2, 2023
82b1bd5
Fix test
jsha Feb 2, 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
5 changes: 0 additions & 5 deletions src/test/fakes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,11 +246,6 @@ impl<'a> FakeRelease<'a> {
self
}

pub(crate) fn documentation_url(mut self, documentation: Option<String>) -> Self {
self.package.documentation = documentation;
self
}

/// Returns the release_id
pub(crate) fn create(mut self) -> Result<i32> {
use std::fs;
Expand Down
95 changes: 10 additions & 85 deletions src/web/rustdoc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ use crate::{
encode_url_path,
error::{AxumNope, AxumResult},
file::File,
headers::CanonicalUrl,
match_version_axum,
metrics::RenderingTimesRecorder,
page::TemplateData,
Expand All @@ -26,7 +25,6 @@ use axum::{
extract::{Extension, Path, Query},
http::{StatusCode, Uri},
response::{Html, IntoResponse, Response as AxumResponse},
TypedHeader,
};
use lol_html::errors::RewritingError;
use once_cell::sync::Lazy;
Expand Down Expand Up @@ -289,7 +287,6 @@ pub(crate) async fn rustdoc_redirector_handler(
#[derive(Debug, Clone, Serialize)]
struct RustdocPage {
latest_path: String,
canonical_url: CanonicalUrl,
permalink_path: String,
latest_version: String,
target: String,
Expand All @@ -315,7 +312,6 @@ impl RustdocPage {
file_path: &str,
) -> AxumResult<AxumResponse> {
let is_latest_url = self.is_latest_url;
let canonical_url = self.canonical_url.clone();

// Build the page of documentation
let ctx = tera::Context::from_serialize(self).context("error creating tera context")?;
Expand All @@ -338,7 +334,7 @@ impl RustdocPage {

Ok((
StatusCode::OK,
TypedHeader(canonical_url),
(!is_latest_url).then_some([("X-Robots-Tag", "noindex")]),
Extension(if is_latest_url {
CachePolicy::ForeverInCdn
} else {
Expand Down Expand Up @@ -640,18 +636,6 @@ pub(crate) async fn rustdoc_html_server_handler(
params.name, target_redirect, query_string
);

// Set the canonical URL for search engines to the `/latest/` page on docs.rs.
// Note: The URL this points to may not exist. For instance, if we're rendering
// `struct Foo` in version 0.1.0 of a crate, and version 0.2.0 of that crate removes
// `struct Foo`, this will point at a 404. That's fine: search engines will crawl
// the target and will not canonicalize to a URL that doesn't exist.
// Don't include index.html in the canonical URL.
let canonical_url = CanonicalUrl::from_path(format!(
"/{}/latest/{}",
params.name,
inner_path.replace("index.html", ""),
));

metrics
.recently_accessed_releases
.record(krate.crate_id, krate.release_id, target);
Expand All @@ -671,7 +655,6 @@ pub(crate) async fn rustdoc_html_server_handler(
move || {
Ok(RustdocPage {
latest_path,
canonical_url,
permalink_path,
latest_version,
target,
Expand Down Expand Up @@ -2394,90 +2377,32 @@ mod test {
}

#[test]
fn canonical_url() {
fn noindex_nonlatest() {
wrapper(|env| {
env.fake_release()
.name("dummy-dash")
.version("0.1.0")
.documentation_url(Some("http://example.com".to_string()))
.rustdoc_file("dummy_dash/index.html")
.create()?;

let utf8_filename = "序.html";
env.fake_release()
.name("dummy-docs")
.version("0.1.0")
.documentation_url(Some("https://docs.rs/foo".to_string()))
.rustdoc_file("dummy_docs/index.html")
.rustdoc_file(&format!("dummy_docs/{utf8_filename}"))
.create()?;

env.fake_release()
.name("dummy-nodocs")
.name("dummy")
.version("0.1.0")
.documentation_url(None)
.rustdoc_file("dummy_nodocs/index.html")
.rustdoc_file("dummy_nodocs/struct.Foo.html")
.rustdoc_file("dummy/index.html")
.create()?;

let web = env.frontend();

assert!(web
.get("/dummy-dash/0.1.0/dummy_dash/")
.get("/dummy/0.1.0/dummy/")
.send()?
.headers()
.get("link")
.get("x-robots-tag")
.unwrap()
.to_str()
.unwrap()
.contains("rel=\"canonical\""),);

assert_eq!(
web.get("/dummy-docs/0.1.0/dummy_docs/")
.send()?
.headers()
.get("link")
.unwrap()
.to_str()
.unwrap(),
"<https://docs.rs/dummy-docs/latest/dummy_docs/>; rel=\"canonical\""
);

assert_eq!(
web.get(&format!("/dummy-docs/0.1.0/dummy_docs/{utf8_filename}"))
.send()?
.headers()
.get("link")
.unwrap()
.to_str()
.unwrap(),
"<https://docs.rs/dummy-docs/latest/dummy_docs/%E5%BA%8F.html>; rel=\"canonical\"",
);
.contains("noindex"));

assert!(web
.get("/dummy-nodocs/0.1.0/dummy_nodocs/")
.get("/dummy/latest/dummy/")
.send()?
.headers()
.get("link")
.unwrap()
.to_str()
.unwrap()
.contains(
"<https://docs.rs/dummy-nodocs/latest/dummy_nodocs/>; rel=\"canonical\""
),);

assert_eq!(
web
.get("/dummy-nodocs/0.1.0/dummy_nodocs/struct.Foo.html")
.send()?
.headers()
.get("link")
.unwrap()
.to_str()
.unwrap(),
"<https://docs.rs/dummy-nodocs/latest/dummy_nodocs/struct.Foo.html>; rel=\"canonical\"",
);

.get("x-robots-tag")
.is_none());
Ok(())
})
}
Expand Down