Replace tera with rinja

rust-lang · Jul 5, 2024 · 0683a5d · 0683a5d
1 parent 55314a2
commit 0683a5d
Show file tree

Hide file tree

Showing 56 changed files with 1,574 additions and 1,320 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -100,7 +100,7 @@ tempfile = "3.1.0"
 fn-error-context = "0.2.0"
 
 # Templating
-tera = { version = "1.5.0", features = ["builtins"] }
+rinja = { git = "https://github.com/rinja-rs/rinja" }
 walkdir = "2"
 
 # Date and Time utilities

diff --git a/src/db/types.rs b/src/db/types.rs
@@ -45,6 +45,16 @@ impl sqlx::postgres::PgHasArrayType for BuildStatus {
     }
 }
 
+impl<'a> PartialEq<&'a str> for BuildStatus {
+    fn eq(&self, other: &&str) -> bool {
+        match self {
+            Self::Success => *other == "success",
+            Self::Failure => *other == "failure",
+            Self::InProgress => *other == "in_progress",
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

diff --git a/src/docbuilder/limits.rs b/src/docbuilder/limits.rs
@@ -6,11 +6,11 @@ const GB: usize = 1024 * 1024 * 1024;
 
 #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
 pub(crate) struct Limits {
-    memory: usize,
-    targets: usize,
-    timeout: Duration,
-    networking: bool,
-    max_log_size: usize,
+    pub memory: usize,
+    pub targets: usize,
+    pub timeout: Duration,
+    pub networking: bool,
+    pub max_log_size: usize,
 }
 
 impl Limits {

diff --git a/src/registry_api.rs b/src/registry_api.rs
@@ -4,6 +4,7 @@ use chrono::{DateTime, Utc};
 use reqwest::header::{HeaderValue, ACCEPT, USER_AGENT};
 use semver::Version;
 use serde::{Deserialize, Serialize};
+use std::fmt;
 use tracing::instrument;
 use url::Url;
 
@@ -59,6 +60,15 @@ pub enum OwnerKind {
     Team,
 }
 
+impl fmt::Display for OwnerKind {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::User => f.write_str("user"),
+            Self::Team => f.write_str("team"),
+        }
+    }
+}
+
 impl RegistryApi {
     pub fn new(api_base: Url, max_retries: u32) -> Result<Self> {
         let headers = vec![

diff --git a/src/utils/html.rs b/src/utils/html.rs
@@ -1,7 +1,8 @@
-use crate::web::page::TemplateData;
+use crate::web::page::templates::{Body, Head, Topbar, Vendored};
+use crate::web::rustdoc::RustdocPage;
 use lol_html::element;
 use lol_html::errors::RewritingError;
-use tera::Context;
+use rinja::Template;
 
 /// Rewrite a rustdoc page to have the docs.rs topbar
 ///
@@ -12,17 +13,15 @@ use tera::Context;
 pub(crate) fn rewrite_lol(
     html: &[u8],
     max_allowed_memory_usage: usize,
-    ctx: Context,
-    templates: &TemplateData,
+    data: &RustdocPage,
 ) -> Result<Vec<u8>, RewritingError> {
     use lol_html::html_content::{ContentType, Element};
     use lol_html::{HtmlRewriter, MemorySettings, Settings};
 
-    let templates = &templates.templates;
-    let tera_head = templates.render("rustdoc/head.html", &ctx).unwrap();
-    let tera_vendored_css = templates.render("rustdoc/vendored.html", &ctx).unwrap();
-    let tera_body = templates.render("rustdoc/body.html", &ctx).unwrap();
-    let tera_rustdoc_topbar = templates.render("rustdoc/topbar.html", &ctx).unwrap();
+    let head_html = Head::new(data).render().unwrap();
+    let vendored_html = Vendored::new(data).render().unwrap();
+    let body_html = Body::new(data).render().unwrap();
+    let topbar_html = Topbar::new(data).render().unwrap();
 
     // Before: <body> ... rustdoc content ... </body>
     // After:
@@ -46,12 +45,12 @@ pub(crate) fn rewrite_lol(
         rustdoc_body_class.set_attribute("tabindex", "-1")?;
         // Change the `body` to a `div`
         rustdoc_body_class.set_tag_name("div")?;
-        // Prepend the tera content
-        rustdoc_body_class.prepend(&tera_body, ContentType::Html);
+        // Prepend the rinja content
+        rustdoc_body_class.prepend(&body_html, ContentType::Html);
         // Wrap the transformed body and topbar into a <body> element
         rustdoc_body_class.before(r#"<body class="rustdoc-page">"#, ContentType::Html);
         // Insert the topbar outside of the rustdoc div
-        rustdoc_body_class.before(&tera_rustdoc_topbar, ContentType::Html);
+        rustdoc_body_class.before(&topbar_html, ContentType::Html);
         // Finalize body with </body>
         rustdoc_body_class.after("</body>", ContentType::Html);
 
@@ -62,7 +61,7 @@ pub(crate) fn rewrite_lol(
         element_content_handlers: vec![
             // Append `style.css` stylesheet after all head elements.
             element!("head", |head: &mut Element| {
-                head.append(&tera_head, ContentType::Html);
+                head.append(&head_html, ContentType::Html);
                 Ok(())
             }),
             element!("body", body_handler),
@@ -81,7 +80,7 @@ pub(crate) fn rewrite_lol(
             element!(
                 "link[rel='stylesheet'][href*='rustdoc-']",
                 |rustdoc_css: &mut Element| {
-                    rustdoc_css.before(&tera_vendored_css, ContentType::Html);
+                    rustdoc_css.before(&vendored_html, ContentType::Html);
                     Ok(())
                 }
             ),

diff --git a/src/web/build_details.rs b/src/web/build_details.rs
@@ -2,17 +2,19 @@ use crate::{
     db::types::BuildStatus,
     impl_axum_webpage,
     web::{
+        crate_details::CrateDetails,
         error::{AxumNope, AxumResult},
         extractors::{DbConnection, Path},
         file::File,
-        MetaData,
+        filters, MetaData,
     },
     AsyncStorage, Config,
 };
 use anyhow::Context as _;
 use axum::{extract::Extension, response::IntoResponse};
 use chrono::{DateTime, Utc};
 use futures_util::TryStreamExt;
+use rinja::Template;
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use std::sync::Arc;
@@ -28,17 +30,33 @@ pub(crate) struct BuildDetails {
     errors: Option<String>,
 }
 
+#[derive(Template)]
+#[template(path = "crate/build_details.html")]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize)]
 struct BuildDetailsPage {
     metadata: MetaData,
     build_details: BuildDetails,
     use_direct_platform_links: bool,
     all_log_filenames: Vec<String>,
     current_filename: Option<String>,
+    csp_nonce: String,
 }
 
-impl_axum_webpage! {
-    BuildDetailsPage = "crate/build_details.html",
+impl_axum_webpage! { BuildDetailsPage }
+
+// Used for template rendering.
+impl BuildDetailsPage {
+    pub(crate) fn krate(&self) -> Option<&CrateDetails> {
+        None
+    }
+
+    pub(crate) fn permalink_path(&self) -> &str {
+        ""
+    }
+
+    pub(crate) fn get_metadata(&self) -> Option<&MetaData> {
+        Some(&self.metadata)
+    }
 }
 
 #[derive(Clone, Deserialize, Debug)]
@@ -126,6 +144,7 @@ pub(crate) async fn build_details_handler(
         use_direct_platform_links: true,
         all_log_filenames,
         current_filename,
+        csp_nonce: String::new(),
     }
     .into_response())
 }

diff --git a/src/web/builds.rs b/src/web/builds.rs
@@ -4,9 +4,10 @@ use crate::{
     docbuilder::Limits,
     impl_axum_webpage,
     web::{
+        crate_details::CrateDetails,
         error::AxumResult,
         extractors::{DbConnection, Path},
-        match_version, MetaData, ReqVersion,
+        filters, match_version, MetaData, ReqVersion,
     },
     Config,
 };
@@ -15,6 +16,7 @@ use axum::{
     extract::Extension, http::header::ACCESS_CONTROL_ALLOW_ORIGIN, response::IntoResponse, Json,
 };
 use chrono::{DateTime, Utc};
+use rinja::Template;
 use semver::Version;
 use serde::Serialize;
 use std::sync::Arc;
@@ -29,17 +31,32 @@ pub(crate) struct Build {
     errors: Option<String>,
 }
 
+#[derive(Template)]
+#[template(path = "crate/builds.html")]
 #[derive(Debug, Clone, Serialize)]
 struct BuildsPage {
     metadata: MetaData,
     builds: Vec<Build>,
     limits: Limits,
     canonical_url: CanonicalUrl,
     use_direct_platform_links: bool,
+    csp_nonce: String,
 }
 
-impl_axum_webpage! {
-    BuildsPage = "crate/builds.html",
+impl_axum_webpage! { BuildsPage }
+
+impl BuildsPage {
+    pub(crate) fn krate(&self) -> Option<&CrateDetails> {
+        None
+    }
+
+    pub(crate) fn permalink_path(&self) -> &str {
+        ""
+    }
+
+    pub(crate) fn get_metadata(&self) -> Option<&MetaData> {
+        Some(&self.metadata)
+    }
 }
 
 pub(crate) async fn build_list_handler(
@@ -64,6 +81,7 @@ pub(crate) async fn build_list_handler(
         limits: Limits::for_crate(&config, &mut conn, &name).await?,
         canonical_url: CanonicalUrl::from_path(format!("/crate/{name}/latest/builds")),
         use_direct_platform_links: true,
+        csp_nonce: String::new(),
     }
     .into_response())
 }