feat: add cron job to delete deprecated version

Author: timzaak

Cargo.lock

@@ -72,6 +72,14 @@ file_dir = "/data"
 //  # max file size allowed to be uploaded,
 //  # default is 30MB(30*1024*1024)
 //  max_upload_size = 31457280
+
+//  # delete deprecated version by cron
+//  deprecated_version_delete {
+//    # default value: every day at 3am.
+//    cron: "0 0 3 * * *",
+//    # default value is 2
+//    max_preserve: 2,
+//  }
 //}
 
 

config.release.conf

@@ -15,6 +15,7 @@ There is no real roadmap for v1.3.x now, need users firstly.
 - [ ] chore: spa-client command help doc
 - [ ] bench: add benchmark
 - [x] chore(break change): change server docker config and binary location
+- [x] feat: add cron job to delete deprecated version
 - [x] feat(with client): delete deprecated version to save storage
 - [x] feat: Support S3 by docker(backward: release docker image: timzaak/spa-server:1.2.5-s3)
 - [x] deps: bump hocon 0.9, fix size unit config parse

docs/develop/roadmap.md

@@ -81,6 +81,14 @@ file_dir = "/data"
 //  # max file size allowed to be uploaded,
 //  # default is 30MB(30*1024*1024)
 //  max_upload_size = 31457280
+
+//  # delete deprecated version by cron
+//  deprecated_version_delete {
+//    # default value: every day at 3am.
+//    cron: "0 0 3 * * *",
+//    # default value is 2
+//    max_preserve: 2,
+//  }
 //}
 
 

docs/guide/spa-server-configuration.md

@@ -41,6 +41,8 @@ flate2 = "1.0"
 # tokio trace and log
 tracing = "0.1"
 tracing-subscriber = "0.2"
+# tokio cron
+delay_timer="0.11"
 
 #config
 hocon = "0.9"

server/Cargo.toml

@@ -14,6 +14,8 @@ use std::sync::Arc;
 use warp::multipart::FormData;
 use warp::reply::Response;
 use warp::{Filter, Rejection};
+#[macro_use]
+use delay_timer::prelude::*;
 
 pub struct AdminServer {
     conf: AdminConfig,
@@ -55,6 +57,16 @@ impl AdminServer {
         let bind_address =
             SocketAddr::from_str(&format!("{}:{}", &self.conf.addr, &self.conf.port)).unwrap();
         warp::serve(self.routes()).run(bind_address).await;
+        if let Some(cron_config) = &self.conf.deprecated_version_delete {
+            let mut delay_timer = DelayTimerBuilder::default()
+                .tokio_runtime_by_default()
+                .build();
+            delay_timer.add_task(build_async_job(
+                self.domain_storage.clone(),
+                Some(cron_config.max_reserve),
+                &cron_config.cron,
+            )?)?;
+        }
         Ok(())
     }
 
@@ -451,6 +463,30 @@ pub mod request {
     }
 }
 
+fn build_async_job(
+    domain_storage: Arc<DomainStorage>,
+    max_reserve: Option<u32>,
+    cron: &str,
+) -> anyhow::Result<Task> {
+    let domain_storage = domain_storage.clone();
+
+    let body = move || {
+        service::remove_domain_version(
+            domain_storage.clone(),
+            DeleteDomainVersionOption {
+                domain: None,
+                max_reserve,
+            },
+        );
+        println!("tt");
+    };
+    let builder = TaskBuilder::default()
+        .set_frequency_repeated_by_cron_str(cron)
+        .set_task_id(1)
+        .set_maximum_parallel_runnable_num(1)
+        .spawn_routine(body)?;
+    Ok(builder)
+}
 // TODO: the code structure is not friendly with Unit Test, need refactor it.
 #[cfg(test)]
 mod test {

server/src/admin_server.rs

@@ -44,6 +44,7 @@ pub struct AdminConfig {
     pub token: String,
     #[serde(default = "default_max_upload_size")]
     pub max_upload_size: u64,
+    pub deprecated_version_delete: Option<DeprecatedVersionRemove>,
 }
 
 fn default_max_upload_size() -> u64 {
@@ -115,4 +116,17 @@ impl Default for CacheConfig {
             compression: false,
         }
     }
-}
+}
+#[derive(Deserialize, Debug, Clone, Eq, PartialEq)]
+pub struct DeprecatedVersionRemove {
+    #[serde(default = "default_cron")]
+    pub cron: String,
+    #[serde(default = "default_max_reserve")]
+    pub max_reserve: u32,
+}
+pub fn default_cron() -> String {
+    String::from("0 0 3 * * *")
+}
+pub fn default_max_reserve() -> u32 {
+    return 2;
+}

server/src/config.rs

@@ -9,9 +9,9 @@ pub mod file_cache;
 pub mod hot_reload;
 pub mod tls;
 
-pub mod static_file_filter;
-pub mod service;
 pub mod cors;
+pub mod service;
+pub mod static_file_filter;
 
 use crate::admin_server::AdminServer;
 use crate::config::{AdminConfig, Config};
@@ -44,7 +44,7 @@ fn load_config_and_cache() -> anyhow::Result<(Config, Arc<DomainStorage>)> {
     let config = Config::load()?;
     tracing::debug!("config load:{:?}", &config);
     let cache = FileCache::new(&config);
-    let domain_storage = Arc::new(DomainStorage::init(&config.file_dir,cache)?);
+    let domain_storage = Arc::new(DomainStorage::init(&config.file_dir, cache)?);
     Ok((config, domain_storage))
 }
 
@@ -58,7 +58,7 @@ pub async fn reload_server(
     let config = Config::load()?;
     if config.admin_config.as_ref() == Some(admin_config) {
         let cache = FileCache::new(&config);
-        let domain_storage = Arc::new(DomainStorage::init(&config.file_dir,cache)?);
+        let domain_storage = Arc::new(DomainStorage::init(&config.file_dir, cache)?);
         let (state, http_rx, https_rx) = HotReloadState::init(&config);
         let server = Server::new(config.clone(), domain_storage.clone());
         tokio::task::spawn(async move { server.run(http_rx, https_rx).await });
@@ -68,6 +68,7 @@ pub async fn reload_server(
     }
     Ok(())
 }
+
 pub async fn run_server() -> anyhow::Result<()> {
     let (config, domain_storage) = load_config_and_cache().expect("prepare config and cache file");
     if config.port <= 0 && config.https.is_none() {