feat(targets): add -rrs to refresh items + rewrite support (#174)

Author: dan-online

.vscode/settings.json

@@ -13,5 +13,6 @@
     "editor.codeActionsOnSave": {
         "source.fixAll.ts": "explicit",
         "source.organizeImports": "explicit",
-    }
+    },
+    "rust-analyzer.check.command": "clippy"
 }

Cargo.toml

@@ -101,3 +101,7 @@ futures-util = "0.3.31"
 # [dev-dependencies]
 # # Standardize logging output
 # tracing-test = "0.2.5"
+
+[profile.dev]
+opt-level = 1
+incremental = true

README.md

@@ -51,6 +51,8 @@ We use the following terminology:
   - Jellyfin
   - Emby
   - Command
+  - Sonarr
+  - Radarr
   - Tdarr
   - FileFlows
   - Another autopulse instance
@@ -167,17 +169,11 @@ triggers:
       from: "/downloads"
       to: "/movies"
 
-  my_lidarr:
-    type: "lidarr"
-    rewrite:
-      from: "/downloads"
-      to: "/music"
-  
-  my_readarr:
-    type: "readarr"
+  my_manual:
+    type: "manual"
     rewrite:
       from: "/downloads"
-      to: "/books"
+      to: "/"
   
   my_notify:
     type: "notify"
@@ -198,6 +194,14 @@ targets:
     url: "http://plex:32400"
     token: "<your_token>"
 
+  my_different_plex:
+    type: "plex"
+    url: "http://plex:32401"
+    token: "<your_token>"
+    rewrite:
+      from: "/media"
+      to: "/plex"
+
   my_jellyfin:
     type: "jellyfin"
     url: "http://jellyfin:8096"

src/build.rs

@@ -4,7 +4,8 @@ fn main() {
     let postgres_enabled = env::var("CARGO_FEATURE_POSTGRES").is_ok();
     let sqlite_enabled = env::var("CARGO_FEATURE_SQLITE").is_ok();
 
-    if !postgres_enabled && !sqlite_enabled {
-        panic!("You must enable at least one of the `postgres` or `sqlite` features.");
-    }
+    assert!(
+        !(!postgres_enabled && !sqlite_enabled),
+        "You must enable at least one of the `postgres` or `sqlite` features."
+    )
 }

src/db/conn.rs

@@ -18,12 +18,12 @@ const POSTGRES_MIGRATIONS: EmbeddedMigrations = embed_migrations!("migrations/po
 #[cfg(feature = "sqlite")]
 const SQLITE_MIGRATIONS: EmbeddedMigrations = embed_migrations!("migrations/sqlite");
 
-/// Represents a connection to either a PostgreSQL or SQLite database.
+/// Represents a connection to either a `PostgreSQL` or `SQLite` database.
 #[derive(diesel::MultiConnection)]
 pub enum AnyConnection {
-    /// A connection to a PostgreSQL database.
+    /// A connection to a `PostgreSQL` database.
     ///
-    /// This is used when the `database_url` is a PostgreSQL URL.
+    /// This is used when the `database_url` is a `PostgreSQL` URL.
     ///
     /// # Example
     ///
@@ -33,9 +33,9 @@ pub enum AnyConnection {
     #[cfg(feature = "postgres")]
     Postgresql(diesel::PgConnection),
     // Mysql(diesel::MysqlConnection),
-    /// A connection to a SQLite database.
+    /// A connection to a `SQLite` database.
     ///
-    /// This is used when the `database_url` is a SQLite URL.
+    /// This is used when the `database_url` is a `SQLite` URL.
     ///
     /// Note: The directory where the database is stored will also be populated with a WAL file and a journal file.
     ///

src/db/models.rs

@@ -1,10 +1,9 @@
+use crate::{settings::rewrite::Rewrite, utils::generate_uuid::generate_uuid};
 use chrono::NaiveDateTime;
 use diesel::prelude::*;
 use serde::Serialize;
 use std::fmt::Display;
 
-use crate::utils::generate_uuid::generate_uuid;
-
 /// The status of a scan event being proccessed by [Targets](crate::service::targets).
 #[derive(Serialize)]
 pub enum ProcessStatus {
@@ -16,7 +15,7 @@ pub enum ProcessStatus {
 
 /// Whether a file was found or not.
 ///
-/// Note: only used if [opts.check_path](crate::settings::opts::Opts::check_path) is set.
+/// Note: only used if [`opts.check_path`](crate::settings::opts::Opts::check_path) is set.
 #[derive(Serialize)]
 pub enum FoundStatus {
     Found,
@@ -79,7 +78,7 @@ pub struct ScanEvent {
     /// The status of the file being found.
     pub found_status: String,
 
-    /// The number of times the scan event has failed. Used for retries and is limited to [opts.max_retries](crate::settings::opts::Opts::max_retries).
+    /// The number of times the scan event has failed. Used for retries and is limited to [`opts.max_retries`](crate::settings::opts::Opts::max_retries).
     pub failed_times: i32,
     /// The time the scan event will be retried.
     pub next_retry_at: Option<chrono::NaiveDateTime>,
@@ -117,6 +116,13 @@ impl ScanEvent {
         targets.dedup();
         self.targets_hit = targets.join(",");
     }
+
+    pub fn get_path(&self, rewrite: &Option<Rewrite>) -> String {
+        rewrite.as_ref().map_or_else(
+            || self.file_path.clone(),
+            |rewrite| rewrite.rewrite_path(self.file_path.clone()),
+        )
+    }
 }
 
 #[derive(Insertable)]

src/main.rs

@@ -10,6 +10,7 @@
 //!
 //! ## About
 #![doc = include_str!("../README.md")]
+#![cfg_attr(debug_assertions, warn(clippy::nursery))]
 
 use actix_web::{middleware::Logger, web::Data, App, HttpServer};
 use actix_web_httpauth::extractors::basic;

src/routes/mod.rs

@@ -36,7 +36,7 @@ pub mod status;
 ///
 /// # Responses
 ///
-/// - **200 OK**: Returns a [StatsResponse](stats::StatsResponse) object containing the service statistics and response time.
+/// - **200 OK**: Returns a [`StatsResponse`](stats::StatsResponse) object containing the service statistics and response time.
 pub mod stats;
 
 /// GET `/list?status={status}&page={page}&limit={limit}&sort={sort}`
@@ -50,11 +50,11 @@ pub mod stats;
 /// - `limit`: The number of items to retrieve per page.
 /// - `sort`: The field to sort the results by. Can be one of `id`, `file_path`, `process_status`, `event_source`, `created_at`, or `updated_at`.
 ///
-/// See [list::ListQuery] for more information.
+/// See [`list::ListQuery`] for more information.
 ///
 /// # Responses
 ///
-/// - **200 OK**: Returns a list of [ScanEvent](crate::db::models::ScanEvent) objects.
+/// - **200 OK**: Returns a list of [`ScanEvent`](crate::db::models::ScanEvent) objects.
 /// - **401 Unauthorized**: Returned if the request is not authenticated.
 pub mod list;
 
@@ -78,7 +78,7 @@ pub mod login;
 ///
 /// # Responses
 ///
-/// - **200 OK**: Returns a [ScanEvent](crate::db::models::ScanEvent) object containing the scan event.
+/// - **200 OK**: Returns a [`ScanEvent`](crate::db::models::ScanEvent) object containing the scan event.
 /// - **401 Unauthorized**: Returned if the request is not authenticated.
 /// - **404 Not Found**: Returned if the trigger does not exist.
 /// - **400 Bad Request**: Returned if the request is invalid.

src/service/manager.rs

@@ -133,7 +133,7 @@ impl PulseManager {
         if let Some(mut sort) = sort {
             let mut direction = "desc";
 
-            if sort.starts_with("-") {
+            if sort.starts_with('-') {
                 direction = "asc";
                 sort = sort[1..].to_string();
             }
@@ -168,12 +168,12 @@ impl PulseManager {
         }
 
         if let Some(search) = search {
-            query = query.filter(file_path.like(format!("%{}%", search)));
+            query = query.filter(file_path.like(format!("%{search}%")));
         }
 
         query
             .limit(limit.into())
-            .offset(((page - 1) * (limit as u64)) as i64)
+            .offset(((page - 1) * u64::from(limit)) as i64)
             .load::<ScanEvent>(&mut get_conn(&self.pool)?)
             .map_err(Into::into)
     }
@@ -238,7 +238,7 @@ impl PulseManager {
                         service
                             .watcher(tx)
                             .await
-                            .context(format!("failed to start notify service '{}'", cloned_name))
+                            .context(format!("failed to start notify service '{cloned_name}'"))
                     })
                     .await;
 

src/service/runner.rs

@@ -168,7 +168,7 @@ impl PulseRunner {
 
         let trigger_settings = &self.settings.triggers;
 
-        for (name, target) in self.settings.targets.iter() {
+        for (name, target) in &self.settings.targets {
             let evs = evs
                 .iter_mut()
                 .filter(|x| !x.get_targets_hit().contains(name))
@@ -242,7 +242,7 @@ impl PulseRunner {
         Ok((succeeded, retrying, failed))
     }
 
-    async fn cleanup(&self) -> anyhow::Result<()> {
+    fn cleanup(&self) -> anyhow::Result<()> {
         let time_before_cleanup = chrono::Utc::now().naive_utc()
             - chrono::Duration::days(self.settings.opts.cleanup_days as i64);
 
@@ -290,7 +290,7 @@ impl PulseRunner {
 
         self.update_found_status().await?;
         self.update_process_status().await?;
-        self.cleanup().await?;
+        self.cleanup()?;
 
         Ok(())
     }