Merge pull request #10566 from Turbo87/new-email

models/email: Improve `NewEmail` struct

Author: Turbo87

src/controllers/user/update.rs

@@ -2,7 +2,7 @@ use crate::app::AppState;
 use crate::auth::AuthCheck;
 use crate::controllers::helpers::ok_true;
 use crate::models::NewEmail;
-use crate::schema::{emails, users};
+use crate::schema::users;
 use crate::util::errors::{bad_request, server_error, AppResult};
 use axum::extract::Path;
 use axum::response::Response;
@@ -93,21 +93,13 @@ pub async fn update_user(
             .parse::<Address>()
             .map_err(|_| bad_request("invalid email address"))?;
 
-        let new_email = NewEmail {
-            user_id: user.id,
-            email: user_email,
-        };
+        let new_email = NewEmail::builder()
+            .user_id(user.id)
+            .email(user_email)
+            .build();
 
-        let token = diesel::insert_into(emails::table)
-            .values(&new_email)
-            .on_conflict(emails::user_id)
-            .do_update()
-            .set(&new_email)
-            .returning(emails::token)
-            .get_result::<String>(&mut conn)
-            .await
-            .map(SecretString::from)
-            .map_err(|_| server_error("Error in creating token"))?;
+        let token = new_email.insert_or_update(&mut conn).await;
+        let token = token.map_err(|_| server_error("Error in creating token"))?;
 
         // This swallows any errors that occur while attempting to send the email. Some users have
         // an invalid email set in their GitHub profile, and we should let them sign in even though

src/models/email.rs

@@ -1,4 +1,7 @@
+use bon::Builder;
 use chrono::NaiveDateTime;
+use diesel::{OptionalExtension, QueryResult};
+use diesel_async::{AsyncPgConnection, RunQueryDsl};
 use secrecy::SecretString;
 
 use crate::models::User;
@@ -16,9 +19,53 @@ pub struct Email {
     pub token_generated_at: Option<NaiveDateTime>,
 }
 
-#[derive(Debug, Insertable, AsChangeset)]
+#[derive(Debug, Insertable, AsChangeset, Builder)]
 #[diesel(table_name = emails, check_for_backend(diesel::pg::Pg))]
 pub struct NewEmail<'a> {
     pub user_id: i32,
     pub email: &'a str,
+    #[builder(default = false)]
+    pub verified: bool,
+}
+
+impl NewEmail<'_> {
+    pub async fn insert(&self, conn: &mut AsyncPgConnection) -> QueryResult<()> {
+        diesel::insert_into(emails::table)
+            .values(self)
+            .execute(conn)
+            .await?;
+
+        Ok(())
+    }
+
+    /// Inserts the email into the database and returns the confirmation token,
+    /// or does nothing if it already exists and returns `None`.
+    pub async fn insert_if_missing(
+        &self,
+        conn: &mut AsyncPgConnection,
+    ) -> QueryResult<Option<SecretString>> {
+        diesel::insert_into(emails::table)
+            .values(self)
+            .on_conflict_do_nothing()
+            .returning(emails::token)
+            .get_result::<String>(conn)
+            .await
+            .map(Into::into)
+            .optional()
+    }
+
+    pub async fn insert_or_update(
+        &self,
+        conn: &mut AsyncPgConnection,
+    ) -> QueryResult<SecretString> {
+        diesel::insert_into(emails::table)
+            .values(self)
+            .on_conflict(emails::user_id)
+            .do_update()
+            .set(self)
+            .returning(emails::token)
+            .get_result::<String>(conn)
+            .await
+            .map(Into::into)
+    }
 }

src/models/user.rs

@@ -2,7 +2,6 @@ use chrono::NaiveDateTime;
 use diesel::prelude::*;
 use diesel_async::scoped_futures::ScopedFutureExt;
 use diesel_async::{AsyncConnection, AsyncPgConnection, RunQueryDsl};
-use secrecy::SecretString;
 
 use crate::app::App;
 use crate::controllers::user::update::UserConfirmEmail;
@@ -171,21 +170,12 @@ impl<'a> NewUser<'a> {
 
                 // To send the user an account verification email
                 if let Some(user_email) = email {
-                    let new_email = NewEmail {
-                        user_id: user.id,
-                        email: user_email,
-                    };
-
-                    let token = insert_into(emails::table)
-                        .values(&new_email)
-                        .on_conflict_do_nothing()
-                        .returning(emails::token)
-                        .get_result::<String>(conn)
-                        .await
-                        .optional()?
-                        .map(SecretString::from);
-
-                    if let Some(token) = token {
+                    let new_email = NewEmail::builder()
+                        .user_id(user.id)
+                        .email(user_email)
+                        .build();
+
+                    if let Some(token) = new_email.insert_if_missing(conn).await? {
                         // Swallows any error. Some users might insert an invalid email address here.
                         let email = UserConfirmEmail {
                             user_name: &user.gh_login,

src/tests/util/test_app.rs

@@ -4,7 +4,7 @@ use crate::config::{
 };
 use crate::middleware::cargo_compat::StatusCodeConfig;
 use crate::models::token::{CrateScope, EndpointScope};
-use crate::models::User;
+use crate::models::{NewEmail, User};
 use crate::rate_limiter::{LimitedAction, RateLimiterConfig};
 use crate::schema::users;
 use crate::storage::StorageConfig;
@@ -120,8 +120,6 @@ impl TestApp {
     ///
     /// This method updates the database directly
     pub async fn db_new_user(&self, username: &str) -> MockCookieUser {
-        use crate::schema::emails;
-        use diesel::prelude::*;
         use diesel_async::RunQueryDsl;
 
         let mut conn = self.db_conn().await;
@@ -134,15 +132,13 @@ impl TestApp {
             .await
             .unwrap();
 
-        diesel::insert_into(emails::table)
-            .values((
-                emails::user_id.eq(user.id),
-                emails::email.eq(email),
-                emails::verified.eq(true),
-            ))
-            .execute(&mut conn)
-            .await
-            .unwrap();
+        let new_email = NewEmail::builder()
+            .user_id(user.id)
+            .email(&email)
+            .verified(true)
+            .build();
+
+        new_email.insert(&mut conn).await.unwrap();
 
         MockCookieUser {
             app: self.clone(),