Actually serve pages without giving a 404

Author: jyn514

src/web/page/mod.rs

@@ -2,7 +2,7 @@ mod templates;
 mod web_page;
 
 pub(crate) use templates::TemplateData;
-pub(crate) use web_page::WebPage;
+pub(super) use web_page::{respond, WebPage};
 
 use serde::Serialize;
 

src/web/page/web_page.rs

@@ -26,26 +26,41 @@ macro_rules! impl_webpage {
     };
 }
 
+pub(in crate::web) fn respond(
+    template: &str,
+    ctx: Context,
+    content_type: ContentType,
+    status: Status,
+    req: &Request,
+) -> IronResult<Response> {
+    let rendered = req
+        .extensions
+        .get::<TemplateData>()
+        .expect("missing TemplateData from the request extensions")
+        .templates
+        .load()
+        .render(template, &ctx)
+        .unwrap();
+
+    let mut response = Response::with((status, rendered));
+    response.headers.set(content_type);
+
+    Ok(response)
+}
+
 /// The central trait that rendering pages revolves around, it handles selecting and rendering the template
 pub trait WebPage: Serialize + Sized {
     /// Turn the current instance into a `Response`, ready to be served
     // TODO: We could cache similar pages using the `&Context`
     fn into_response(self, req: &Request) -> IronResult<Response> {
         let ctx = Context::from_serialize(&self).unwrap();
-
-        let rendered = req
-            .extensions
-            .get::<TemplateData>()
-            .expect("missing TemplateData from the request extensions")
-            .templates
-            .load()
-            .render(Self::TEMPLATE, &ctx)
-            .unwrap();
-
-        let mut response = Response::with((self.get_status(), rendered));
-        response.headers.set(Self::content_type());
-
-        Ok(response)
+        respond(
+            Self::TEMPLATE,
+            ctx,
+            Self::content_type(),
+            self.get_status(),
+            req,
+        )
     }
 
     /// The name of the template to be rendered

src/web/routes.rs

@@ -23,6 +23,8 @@ pub(super) fn build_routes() -> Routes {
 
     routes.internal_page("/about", super::sitemap::about_handler);
     routes.internal_page("/about/metrics", super::metrics::metrics_handler);
+    routes.internal_page("/about/builds", super::sitemap::about_builds_handler);
+    routes.internal_page("/about/:subpage", super::sitemap::about_handler);
 
     routes.internal_page("/releases", super::releases::recent_releases_handler);
     routes.static_resource("/releases/feed", super::releases::releases_feed_handler);

src/web/sitemap.rs

@@ -56,16 +56,16 @@ pub fn robots_txt_handler(_: &mut Request) -> IronResult<Response> {
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
-struct About {
+struct AboutBuilds {
     /// The current version of rustc that docs.rs is using to build crates
     rustc_version: Option<String>,
     /// The default crate build limits
     limits: Limits,
 }
 
-impl_webpage!(About = "core/about/index.html");
+impl_webpage!(AboutBuilds = "core/about/builds.html");
 
-pub fn about_handler(req: &mut Request) -> IronResult<Response> {
+pub fn about_builds_handler(req: &mut Request) -> IronResult<Response> {
     let conn = extension!(req, Pool).get()?;
     let res = ctry!(
         req,
@@ -80,13 +80,44 @@ pub fn about_handler(req: &mut Request) -> IronResult<Response> {
         }
     });
 
-    About {
+    AboutBuilds {
         rustc_version,
         limits: Limits::default(),
     }
     .into_response(req)
 }
 
+pub fn about_handler(req: &mut Request) -> IronResult<Response> {
+    use super::page::respond;
+    use super::ErrorPage;
+    use iron::status::Status;
+
+    let template = match *req.url.path().last().expect("iron is broken") {
+        "about" | "index.html" => "index.html",
+        "badges" => "badges.html",
+        "metadata" => "metadata.html",
+        "redirections" => "redirections.html",
+        _ => {
+            let msg = "This /about page does not exist. \
+                Perhaps you are interested in <a href=\"https://github.com/rust-lang/docs.rs/tree/master/templates/core/about\">creating</a> it?";
+            let page = ErrorPage {
+                title: "The requested page does not exist",
+                message: Some(msg.into()),
+                status: Status::NotFound,
+            };
+            return page.into_response(req);
+        }
+    };
+    let template = format!("core/about/{}", template);
+    respond(
+        &template,
+        tera::Context::new(),
+        ContentType::html(),
+        Status::Ok,
+        req,
+    )
+}
+
 #[cfg(test)]
 mod tests {
     use crate::test::{assert_success, wrapper};
@@ -110,6 +141,9 @@ mod tests {
     fn about_page() {
         wrapper(|env| {
             let web = env.frontend();
+            for file in std::fs::read_dir("templates/core/about")? {
+                assert_success(path?, web)?;
+            }
             assert_success("/about", web)
         })
     }

templates/core/about/badges.html

@@ -1,4 +1,9 @@
-<h2>Badges</h2>
+{% extends "base.html" -%}
+
+{%- block title -%} Badges {%- endblock title -%}
+
+{%- block body -%}
+<h1>Badges</h1>
 
 <p>
 	You can use badges to show state of your documentation to your users.
@@ -43,3 +48,4 @@ <h2>Badges</h2>
 	</tr>
 	</tbody>
 </table>
+{%- endblock body %}

templates/core/about/builds.html

@@ -1,4 +1,10 @@
-<h2>Builds</h2>
+{% extends "base.html" -%}
+
+{%- block title -%} Builds {%- endblock title -%}
+
+{%- block body -%}
+{%- set docsrs_repo = "https://github.com/rust-lang/docs.rs" -%}
+<h1>Builds</h1>
         <p>
             Docs.rs automatically builds crates' documentation released on
             <a href="https://crates.io/">crates.io</a>
@@ -42,7 +48,7 @@ <h4>Detecting Docs.rs from <code>build.rs</code></h4>
 <h4>Detecting Docs.rs from <code>#[cfg]</code> attributes</h4>
 <p>
 	You can detect Docs.rs by having a <a href="https://doc.rust-lang.org/cargo/reference/features.html">feature</a>
-	which is only set by Docs.rs. See <a href="metadata.html">Metadata</a> for more information.
+	which is only set by Docs.rs. See <a href="metadata">Metadata</a> for more information.
 </p>
 
 <h4>Global sandbox limits</h4>
@@ -68,4 +74,12 @@ <h4>Test crate documentation build locally</h4>
 	unpublished crate's documentation locally using the same build environment as the build agent.
 </p>
 
-<h4></h4>
+{%- endblock body %}
+
+{% block css -%}
+    {{ macros::highlight_css() }}
+{%- endblock css %}
+
+{% block javascript -%}
+    {{ macros::highlight_js(languages=["ini"]) }}
+{%- endblock javascript %}

templates/core/about/index.html

@@ -27,10 +27,10 @@ <h1 id="crate-title">About Docs.rs</h1>
 
         <h2>More about Docs.rs</h2>
         <ol>
-            <li><a href="builds.html">Builds</a>: How Docs.rs builds documentation for a crate</li>
-            <li><a href="metadata.html">Metadata</a>: How you can configure a build</li>
-            <li><a href="badges.html">Badges</a>: How to use badges generated by Docs.rs</li>
-            <li><a href="redirections.html">Redirections</a>: How Docs.rs uses semantic versioning in URLs</li>
+            <li><a href="/about/builds">Builds</a>: How Docs.rs builds documentation for a crate</li>
+            <li><a href="/about/metadata">Metadata</a>: How you can configure a build</li>
+            <li><a href="/about/badges">Badges</a>: How to use badges generated by Docs.rs</li>
+            <li><a href="/about/redirections">Redirections</a>: How Docs.rs uses semantic versioning in URLs</li>
         </ol>
 
         <h3>Version</h3>
@@ -45,11 +45,3 @@ <h3>Contact</h3>
 
     </div>
 {%- endblock body %}
-
-{% block css -%}
-    {{ macros::highlight_css() }}
-{%- endblock css %}
-
-{% block javascript -%}
-    {{ macros::highlight_js(languages=["ini"]) }}
-{%- endblock javascript %}

templates/core/about/metadata.html

@@ -1,4 +1,9 @@
-<h2 id="metadata"><a href="#metadata">Metadata for custom builds</a></h2>
+{% extends "base.html" -%}
+
+{%- block title -%} Metadata {%- endblock title -%}
+
+{%- block body -%}
+<h1>Metadata for custom builds</h1>
 
 <p>
 	You can customize docs.rs builds by defining <code>[package.metadata.docs.rs]</code>
@@ -8,3 +13,4 @@ <h2 id="metadata"><a href="#metadata">Metadata for custom builds</a></h2>
 <p>The available configuration flags you can customize are:</p>
 
 <pre><code>{%- include "core/Cargo.toml.example" -%}</code></pre>
+{%- endblock body %}

templates/core/about/redirections.html

@@ -1,4 +1,9 @@
-<h2>Redirections</h2>
+{% extends "base.html" -%}
+
+{%- block title -%} Redirections {%- endblock title -%}
+
+{%- block body -%}
+<h1>Redirections</h1>
 
 <p>
     Docs.rs uses semver to parse URLs. You can use this feature to access
@@ -50,3 +55,4 @@ <h2>Redirections</h2>
 	</tr>
     </tbody>
 </table>
+{%- endblock body %}