Don't move the sitemap

Author: Nemo157

src/web/metrics.rs

@@ -130,7 +130,7 @@ mod tests {
             ),
             ("/releases/recent/1", "/releases/recent/:page"),
             ("/-/static/robots.txt", "static resource"),
-            ("/-/sitemap.xml", "static resource"),
+            ("/sitemap.xml", "static resource"),
             ("/-/static/style.css", "static resource"),
             ("/-/static/vendored.css", "static resource"),
             ("/rustdoc/rcc/0.0.0/rcc/index.html", "database"),

src/web/routes.rs

@@ -10,18 +10,21 @@ pub(super) const DOC_RUST_LANG_ORG_REDIRECTS: &[&str] =
 pub(super) fn build_routes() -> Routes {
     let mut routes = Routes::new();
 
+    // Well known resources, robots.txt and favicon.ico support redirection, the sitemap.xml
+    // must live at the site root:
+    //   https://developers.google.com/search/reference/robots_txt#handling-http-result-codes
+    //   https://support.google.com/webmasters/answer/183668?hl=en
     routes.static_resource("/robots.txt", PermanentRedirect("/-/static/robots.txt"));
     routes.static_resource("/favicon.ico", PermanentRedirect("/-/static/favicon.ico"));
+    routes.static_resource("/sitemap.xml", super::sitemap::sitemap_handler);
 
-    // These should not need to be served from the root as we reference the inner path in links,
+    // This should not need to be served from the root as we reference the inner path in links,
     // but clients might have cached the url and need to update it.
     routes.static_resource(
         "/opensearch.xml",
         PermanentRedirect("/-/static/opensearch.xml"),
     );
-    routes.static_resource("/sitemap.xml", PermanentRedirect("/-/sitemap.xml"));
 
-    routes.static_resource("/-/sitemap.xml", super::sitemap::sitemap_handler);
     routes.static_resource("/-/static/:file", super::statics::static_handler);
 
     routes.internal_page("/", super::releases::home_page);
@@ -330,19 +333,19 @@ mod tests {
     #[test]
     fn test_root_redirects() {
         wrapper(|env| {
-            // These are "well-known" resources that must be served from the root
+            // These are "well-known" resources that will be requested from the root, but support
+            // redirection
             assert_redirect("/favicon.ico", "/-/static/favicon.ico", env.frontend())?;
             assert_redirect("/robots.txt", "/-/static/robots.txt", env.frontend())?;
 
-            // These have previously been served with a url pointing to the root, it may be
+            // This has previously been served with a url pointing to the root, it may be
             // plausible to remove the redirects in the future, but for now we need to keep serving
-            // them.
+            // it.
             assert_redirect(
                 "/opensearch.xml",
                 "/-/static/opensearch.xml",
                 env.frontend(),
             )?;
-            assert_redirect("/sitemap.xml", "/-/sitemap.xml", env.frontend())?;
 
             Ok(())
         });

static/robots.txt

@@ -1 +1 @@
-Sitemap: https://docs.rs/-/sitemap.xml
+Sitemap: https://docs.rs/sitemap.xml