feat: find tokens expiring with couple days

Author: 0xPoe

src/models/token.rs

@@ -30,6 +30,8 @@ pub struct ApiToken {
     pub endpoint_scopes: Option<Vec<EndpointScope>>,
     #[serde(with = "rfc3339::option")]
     pub expired_at: Option<NaiveDateTime>,
+    #[serde(with = "rfc3339::option")]
+    pub expiry_notification_at: Option<NaiveDateTime>,
 }
 
 impl ApiToken {
@@ -95,6 +97,25 @@ impl ApiToken {
         .or_else(|_| tokens.select(ApiToken::as_select()).first(conn))
         .map_err(Into::into)
     }
+
+    /// Find all tokens that are not revoked and will expire within the specified number of days.
+    pub fn find_tokens_expiring_within_days(
+        conn: &mut PgConnection,
+        days_until_expiry: i64,
+    ) -> QueryResult<Vec<ApiToken>> {
+        use diesel::dsl::{now, IntervalDsl};
+
+        api_tokens::table
+            .filter(api_tokens::revoked.eq(false))
+            .filter(
+                api_tokens::expired_at
+                    .is_not_null()
+                    .and(api_tokens::expired_at.lt(now.nullable() + days_until_expiry.days())),
+            )
+            .filter(api_tokens::expiry_notification_at.is_null())
+            .select(ApiToken::as_select())
+            .get_results(conn)
+    }
 }
 
 #[derive(Debug)]
@@ -125,6 +146,7 @@ mod tests {
             crate_scopes: None,
             endpoint_scopes: None,
             expired_at: None,
+            expiry_notification_at: None,
         };
         let json = serde_json::to_string(&tok).unwrap();
         assert_some!(json

src/tests/routes/me/tokens/snapshots/all__routes__me__tokens__create__create_token_success.snap

@@ -1,13 +1,14 @@
 ---
 source: src/tests/routes/me/tokens/create.rs
-expression: response.into_json()
+expression: response.json()
 ---
 {
   "api_token": {
     "crate_scopes": null,
     "created_at": "[datetime]",
     "endpoint_scopes": null,
     "expired_at": null,
+    "expiry_notification_at": null,
     "id": "[id]",
     "last_used_at": "[datetime]",
     "name": "bar",

src/tests/routes/me/tokens/snapshots/all__routes__me__tokens__create__create_token_with_expiry_date.snap

@@ -1,13 +1,14 @@
 ---
 source: src/tests/routes/me/tokens/create.rs
-expression: response.into_json()
+expression: response.json()
 ---
 {
   "api_token": {
     "crate_scopes": null,
     "created_at": "[datetime]",
     "endpoint_scopes": null,
     "expired_at": "2024-12-24T07:34:56+00:00",
+    "expiry_notification_at": null,
     "id": "[id]",
     "last_used_at": "[datetime]",
     "name": "bar",

src/tests/routes/me/tokens/snapshots/all__routes__me__tokens__create__create_token_with_null_scopes.snap

@@ -1,13 +1,14 @@
 ---
 source: src/tests/routes/me/tokens/create.rs
-expression: response.into_json()
+expression: response.json()
 ---
 {
   "api_token": {
     "crate_scopes": null,
     "created_at": "[datetime]",
     "endpoint_scopes": null,
     "expired_at": null,
+    "expiry_notification_at": null,
     "id": "[id]",
     "last_used_at": "[datetime]",
     "name": "bar",

src/tests/routes/me/tokens/snapshots/all__routes__me__tokens__create__create_token_with_scopes.snap

@@ -1,6 +1,6 @@
 ---
 source: src/tests/routes/me/tokens/create.rs
-expression: response.into_json()
+expression: response.json()
 ---
 {
   "api_token": {
@@ -13,6 +13,7 @@ expression: response.into_json()
       "publish-update"
     ],
     "expired_at": null,
+    "expiry_notification_at": null,
     "id": "[id]",
     "last_used_at": "[datetime]",
     "name": "bar",

src/tests/routes/me/tokens/snapshots/all__routes__me__tokens__list__list_tokens.snap

@@ -1,6 +1,6 @@
 ---
 source: src/tests/routes/me/tokens/list.rs
-expression: response.into_json()
+expression: response.json()
 ---
 {
   "api_tokens": [
@@ -14,6 +14,7 @@ expression: response.into_json()
         "publish-update"
       ],
       "expired_at": null,
+      "expiry_notification_at": null,
       "id": "[id]",
       "last_used_at": "[datetime]",
       "name": "baz"
@@ -23,6 +24,7 @@ expression: response.into_json()
       "created_at": "[datetime]",
       "endpoint_scopes": null,
       "expired_at": null,
+      "expiry_notification_at": null,
       "id": "[id]",
       "last_used_at": "[datetime]",
       "name": "bar"

src/worker/jobs/expiry_notification.rs

@@ -1,9 +1,13 @@
 use std::sync::Arc;
+use diesel::{Connection, PgConnection};
 
 use crates_io_worker::BackgroundJob;
-
+use crate::Emails;
 use crate::worker::Environment;
 
+/// The threshold in days for the expiry notification.
+const EXPIRY_THRESHOLD: i64 = 3;
+
 /// A job responsible for monitoring the status of a token.
 /// It checks if the token is about to reach its expiry date.
 /// If the token is about to expire, the job triggers a notification.
@@ -17,8 +21,31 @@ impl BackgroundJob for CheckAboutToExpireToken {
 
     #[instrument(skip(env), err)]
     async fn run(&self, env: Self::Context) -> anyhow::Result<()> {
-        // Check if the token is about to expire
-        // If the token is about to expire, trigger a notification.
-        Ok(())
+        let conn = env.deadpool.get().await?;
+        conn.interact(move |conn| {
+            // Check if the token is about to expire
+            // If the token is about to expire, trigger a notification.
+            check(&env.emails, conn)
+        })
+        .await
+        .map_err(|err| anyhow!(err.to_string()))?
     }
 }
+// Check if the token is about to expire and send a notification if it is.
+fn check(emails: &Emails, conn: &mut PgConnection) -> anyhow::Result<()> {
+    info!("Checking if tokens are about to expire");
+    let expired_tokens =
+        crate::models::token::ApiToken::find_tokens_expiring_within_days(conn, EXPIRY_THRESHOLD)?;
+    // Batch send notifications in transactions.
+    const BATCH_SIZE: usize = 100;
+    for chunk in expired_tokens.chunks(BATCH_SIZE) {
+        conn.transaction(|conn| {
+            for token in chunk {
+                // Send notification.
+            }
+            Ok::<_, anyhow::Error>(())
+        })?;
+    }
+
+    Ok(())
+}