Documented vendored files, moved *.js and *.css files under /-/static and made fetching content from vendored directories automatic

Author: Kixiron

README.md

@@ -210,6 +210,21 @@ cargo run -- daemon --registry-watcher=disabled
 cargo run -- queue add <CRATE> <VERSION>
 ```
 
+### Updating vendored sources
+
+The instructions & links for updating Font Awesome can be found [on their website](https://fontawesome.com/how-to-use/on-the-web/using-with/sass). Similarly, Pure-CSS also [explains on theirs](https://purecss.io/start/).
+
+When updating Font Awesome, make sure to change `$fa-font-path` in `scss/_variables.scss` (it should be at the top of the file) to `../-/static`. This will point font awesome at the correct path from which to request font and icon resources.
+<!--
+    TODO: Whenever scss modules are avaliable, use [scss modules](https://sass-lang.com/documentation/at-rules/use#configuration)
+    instead of manually editing the `_variables.scss` file. Something like this should work:
+    ```scss
+    @use "fontawesome" with (
+        $fa-font-path: "../-/static"
+    );
+    ```
+-->
+
 ### Contact
 
 Docs.rs is run and maintained by the [docs.rs team](https://www.rust-lang.org/governance/teams/dev-tools#docs-rs).

build.rs

@@ -67,7 +67,7 @@ fn compile_sass() -> Result<(), Box<dyn Error>> {
         include_paths: vec![
             STYLE_DIR.to_owned(),
             concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/fontawesome/scss").to_owned(),
-            concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/pure-css").to_owned(),
+            concat!(env!("CARGO_MANIFEST_DIR"), "/vendor/pure-css/css").to_owned(),
         ],
         ..Default::default()
     });

dockerfiles/Dockerfile

@@ -50,6 +50,7 @@ RUN find src -name "*.rs" -exec touch {} \;
 COPY templates/style templates/style
 COPY templates/index.js templates/
 COPY templates/menu.js templates/
+COPY vendor vendor/
 
 RUN cargo build --release
 

src/web/metrics.rs

@@ -117,8 +117,8 @@ mod tests {
             ("/", "/"),
             ("/crate/hexponent/0.2.0", "/crate/:name/:version"),
             ("/crate/rcc/0.0.0", "/crate/:name/:version"),
-            ("/index.js", "static resource"),
-            ("/menu.js", "static resource"),
+            ("/-/static/index.js", "static resource"),
+            ("/-/static/menu.js", "static resource"),
             ("/opensearch.xml", "static resource"),
             ("/releases", "/releases"),
             ("/releases/feed", "static resource"),
@@ -131,7 +131,7 @@ mod tests {
             ("/releases/recent/1", "/releases/recent/:page"),
             ("/robots.txt", "static resource"),
             ("/sitemap.xml", "static resource"),
-            ("/style.css", "static resource"),
+            ("/-/static/style.css", "static resource"),
         ];
 
         wrapper(|env| {

src/web/mod.rs

@@ -111,9 +111,6 @@ use std::{borrow::Cow, env, fmt, net::SocketAddr, path::PathBuf, sync::Arc, time
 
 /// Duration of static files for staticfile and DatabaseFileHandler (in seconds)
 const STATIC_FILE_CACHE_DURATION: u64 = 60 * 60 * 24 * 30 * 12; // 12 months
-const STYLE_CSS: &str = include_str!(concat!(env!("OUT_DIR"), "/style.css"));
-const MENU_JS: &str = include_str!(concat!(env!("OUT_DIR"), "/menu.js"));
-const INDEX_JS: &str = include_str!(concat!(env!("OUT_DIR"), "/index.js"));
 const OPENSEARCH_XML: &[u8] = include_bytes!("opensearch.xml");
 
 const DEFAULT_BIND: &str = "0.0.0.0:3000";
@@ -496,35 +493,6 @@ fn redirect_base(req: &Request) -> String {
     }
 }
 
-fn style_css_handler(_: &mut Request) -> IronResult<Response> {
-    let mut response = Response::with((status::Ok, STYLE_CSS));
-    let cache = vec![
-        CacheDirective::Public,
-        CacheDirective::MaxAge(STATIC_FILE_CACHE_DURATION as u32),
-    ];
-
-    response
-        .headers
-        .set(ContentType("text/css".parse().unwrap()));
-    response.headers.set(CacheControl(cache));
-
-    Ok(response)
-}
-
-fn load_js(file_path_str: &'static str) -> IronResult<Response> {
-    let mut response = Response::with((status::Ok, file_path_str));
-    let cache = vec![
-        CacheDirective::Public,
-        CacheDirective::MaxAge(STATIC_FILE_CACHE_DURATION as u32),
-    ];
-    response
-        .headers
-        .set(ContentType("application/javascript".parse().unwrap()));
-    response.headers.set(CacheControl(cache));
-
-    Ok(response)
-}
-
 fn opensearch_xml_handler(_: &mut Request) -> IronResult<Response> {
     let mut response = Response::with((status::Ok, OPENSEARCH_XML));
     let cache = vec![
@@ -540,26 +508,6 @@ fn opensearch_xml_handler(_: &mut Request) -> IronResult<Response> {
     Ok(response)
 }
 
-fn ico_handler(req: &mut Request) -> IronResult<Response> {
-    if let Some(&"favicon.ico") = req.url.path().last() {
-        // if we're looking for exactly "favicon.ico", we need to defer to the handler that loads
-        // from `public_html`, so return a 404 here to make the main handler carry on
-        Err(IronError::new(
-            error::Nope::ResourceNotFound,
-            status::NotFound,
-        ))
-    } else {
-        // if we're looking for something like "favicon-20190317-1.35.0-nightly-c82834e2b.ico",
-        // redirect to the plain one so that the above branch can trigger with the correct filename
-        let url = ctry!(
-            req,
-            Url::parse(&format!("{}/favicon.ico", redirect_base(req))),
-        );
-
-        Ok(redirect(url))
-    }
-}
-
 /// MetaData used in header
 #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
 pub(crate) struct MetaData {

src/web/routes.rs

@@ -1,7 +1,5 @@
 use super::metrics::RequestRecorder;
-use crate::web::{INDEX_JS, MENU_JS};
 use iron::middleware::Handler;
-use iron::Request;
 use router::Router;
 use std::collections::HashSet;
 
@@ -12,9 +10,6 @@ pub(super) const DOC_RUST_LANG_ORG_REDIRECTS: &[&str] =
 pub(super) fn build_routes() -> Routes {
     let mut routes = Routes::new();
 
-    routes.static_resource("/style.css", super::style_css_handler);
-    routes.static_resource("/index.js", |_: &mut Request| super::load_js(INDEX_JS));
-    routes.static_resource("/menu.js", |_: &mut Request| super::load_js(MENU_JS));
     routes.static_resource("/robots.txt", super::sitemap::robots_txt_handler);
     routes.static_resource("/sitemap.xml", super::sitemap::sitemap_handler);
     routes.static_resource("/opensearch.xml", super::opensearch_xml_handler);

src/web/rustdoc.rs

@@ -125,7 +125,7 @@ pub fn rustdoc_redirector_handler(req: &mut Request) -> IronResult<Response> {
     {
         // route .ico files into their dedicated handler so that docs.rs's favicon is always
         // displayed
-        return super::ico_handler(req);
+        return super::statics::ico_handler(req);
     }
 
     let router = extension!(req, Router);