Add type alias for caches

Author: senekor

src/cache.rs

@@ -4,19 +4,22 @@ use std::time::Instant;
 
 use rocket::tokio::sync::RwLock;
 use rocket::tokio::task;
+use rocket::State;
 
 const CACHE_TTL_SECS: u64 = 120;
 
+pub type Cache<T> = State<Arc<RwLock<T>>>;
+
 #[async_trait]
-pub trait Cache: Send + Sync + Clone + 'static {
+pub trait Cached: Send + Sync + Clone + 'static {
     fn get_timestamp(&self) -> Instant;
     async fn fetch() -> Result<Self, Box<dyn Error + Send + Sync>>;
-    async fn get(cache: &Arc<RwLock<Self>>) -> Self {
+    async fn get(cache: &Cache<Self>) -> Self {
         let cached = cache.read().await.clone();
         let timestamp = cached.get_timestamp();
         if timestamp.elapsed().as_secs() > CACHE_TTL_SECS {
             // Update the cache in the background
-            let cache: Arc<_> = cache.clone();
+            let cache: Arc<_> = cache.inner().clone();
             task::spawn(async move {
                 match Self::fetch().await {
                     Ok(data) => *cache.write().await = data,

src/main.rs

@@ -31,9 +31,9 @@ mod rust_version;
 mod teams;
 
 use cache::Cache;
+use cache::Cached;
 use production::User;
 use rocket::tokio::sync::RwLock;
-use rocket::State;
 use rust_version::RustReleasePost;
 use rust_version::RustVersion;
 use teams::encode_zulip_stream;
@@ -190,17 +190,17 @@ fn robots_txt() -> Option<content::RawText<&'static str>> {
 
 #[get("/")]
 async fn index(
-    version_cache: &State<Arc<RwLock<RustVersion>>>,
-    release_post_cache: &State<Arc<RwLock<RustReleasePost>>>,
+    version_cache: &Cache<RustVersion>,
+    release_post_cache: &Cache<RustReleasePost>,
 ) -> Template {
     render_index(ENGLISH.into(), version_cache, release_post_cache).await
 }
 
 #[get("/<locale>", rank = 3)]
 async fn index_locale(
     locale: SupportedLocale,
-    version_cache: &State<Arc<RwLock<RustVersion>>>,
-    release_post_cache: &State<Arc<RwLock<RustReleasePost>>>,
+    version_cache: &Cache<RustVersion>,
+    release_post_cache: &Cache<RustReleasePost>,
 ) -> Template {
     render_index(locale.0, version_cache, release_post_cache).await
 }
@@ -216,23 +216,23 @@ fn category_locale(category: Category, locale: SupportedLocale) -> Template {
 }
 
 #[get("/governance")]
-async fn governance(teams_cache: &State<Arc<RwLock<RustTeams>>>) -> Result<Template, Status> {
+async fn governance(teams_cache: &Cache<RustTeams>) -> Result<Template, Status> {
     render_governance(ENGLISH.into(), teams_cache).await
 }
 
 #[get("/governance/<section>/<team>", rank = 2)]
 async fn team(
     section: String,
     team: String,
-    teams_cache: &State<Arc<RwLock<RustTeams>>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<Template, Result<Redirect, Status>> {
     render_team(section, team, ENGLISH.into(), teams_cache).await
 }
 
 #[get("/<locale>/governance", rank = 8)]
 async fn governance_locale(
     locale: SupportedLocale,
-    teams_cache: &State<Arc<RwLock<RustTeams>>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<Template, Status> {
     render_governance(locale.0, teams_cache).await
 }
@@ -242,7 +242,7 @@ async fn team_locale(
     section: String,
     team: String,
     locale: SupportedLocale,
-    teams_cache: &State<Arc<RwLock<RustTeams>>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<Template, Result<Redirect, Status>> {
     render_team(section, team, locale.0, teams_cache).await
 }
@@ -368,8 +368,8 @@ fn concat_app_js(files: Vec<&str>) -> String {
 
 async fn render_index(
     lang: String,
-    version_cache: &State<Arc<RwLock<RustVersion>>>,
-    release_post_cache: &State<Arc<RwLock<RustReleasePost>>>,
+    version_cache: &Cache<RustVersion>,
+    release_post_cache: &Cache<RustReleasePost>,
 ) -> Template {
     #[derive(Serialize)]
     struct IndexData {
@@ -414,7 +414,7 @@ fn render_production(lang: String) -> Template {
 
 async fn render_governance(
     lang: String,
-    teams_cache: &State<Arc<RwLock<RustTeams>>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<Template, Status> {
     match teams::index_data(teams_cache).await {
         Ok(data) => {
@@ -434,7 +434,7 @@ async fn render_team(
     section: String,
     team: String,
     lang: String,
-    teams_cache: &State<Arc<RwLock<RustTeams>>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<Template, Result<Redirect, Status>> {
     match teams::page_data(&section, &team, teams_cache).await {
         Ok(data) => {

src/rust_version.rs

@@ -1,12 +1,8 @@
 use std::env;
 use std::error::Error;
-use std::sync::Arc;
 use std::time::Instant;
 
-use rocket::tokio::sync::RwLock;
-use rocket::State;
-
-use crate::cache::Cache;
+use crate::cache::{Cache, Cached};
 
 static MANIFEST_URL: &str = "https://static.rust-lang.org/dist/channel-rust-stable.toml";
 static RELEASES_FEED_URL: &str = "https://blog.rust-lang.org/releases.json";
@@ -47,7 +43,7 @@ impl Default for RustVersion {
 }
 
 #[async_trait]
-impl Cache for RustVersion {
+impl Cached for RustVersion {
     fn get_timestamp(&self) -> Instant {
         self.1
     }
@@ -73,7 +69,7 @@ impl Default for RustReleasePost {
 }
 
 #[async_trait]
-impl Cache for RustReleasePost {
+impl Cached for RustReleasePost {
     fn get_timestamp(&self) -> Instant {
         self.1
     }
@@ -88,10 +84,10 @@ impl Cache for RustReleasePost {
     }
 }
 
-pub async fn rust_version(version_cache: &State<Arc<RwLock<RustVersion>>>) -> String {
+pub async fn rust_version(version_cache: &Cache<RustVersion>) -> String {
     RustVersion::get(version_cache).await.0
 }
 
-pub async fn rust_release_post(release_post_cache: &State<Arc<RwLock<RustReleasePost>>>) -> String {
+pub async fn rust_release_post(release_post_cache: &Cache<RustReleasePost>) -> String {
     RustReleasePost::get(release_post_cache).await.0
 }

src/teams.rs

@@ -1,14 +1,12 @@
 use handlebars::{Context, Handlebars, Helper, HelperResult, Output, RenderContext, RenderError};
 use percent_encoding::{utf8_percent_encode, AsciiSet, NON_ALPHANUMERIC};
-use rocket::tokio::sync::RwLock;
 use rust_team_data::v1::{Team, TeamKind, Teams, BASE_URL};
 use std::cmp::Reverse;
 use std::error::Error;
 use std::fmt;
-use std::sync::Arc;
 use std::time::Instant;
 
-use crate::cache::Cache;
+use crate::cache::{Cache, Cached};
 
 #[derive(Default, Serialize)]
 pub struct IndexData {
@@ -40,9 +38,7 @@ struct Data {
 const ENCODING_SET: AsciiSet = NON_ALPHANUMERIC.remove(b'-').remove(b'_');
 
 impl Data {
-    async fn load(
-        teams_cache: &Arc<RwLock<RustTeams>>,
-    ) -> Result<Self, Box<dyn Error + Send + Sync>> {
+    async fn load(teams_cache: &Cache<RustTeams>) -> Result<Self, Box<dyn Error + Send + Sync>> {
         Ok(Data {
             teams: RustTeams::get(teams_cache)
                 .await
@@ -166,15 +162,15 @@ pub fn encode_zulip_stream(
 }
 
 pub async fn index_data(
-    teams_cache: &Arc<RwLock<RustTeams>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<IndexData, Box<dyn Error + Send + Sync>> {
     Data::load(teams_cache).await?.index_data()
 }
 
 pub async fn page_data(
     section: &str,
     team_name: &str,
-    teams_cache: &Arc<RwLock<RustTeams>>,
+    teams_cache: &Cache<RustTeams>,
 ) -> Result<PageData, Box<dyn Error + Send + Sync>> {
     Data::load(teams_cache).await?.page_data(section, team_name)
 }
@@ -189,7 +185,7 @@ impl Default for RustTeams {
 }
 
 #[async_trait]
-impl Cache for RustTeams {
+impl Cached for RustTeams {
     fn get_timestamp(&self) -> Instant {
         self.1
     }