user/update: Add publish_notification field

This field can be used to un-/resubscribe to publish notifications. When a user unsubscribes they get an email notification.

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::{Email, NewEmail};
-use crate::schema::emails;
+use crate::schema::{emails, users};
 use crate::tasks::spawn_blocking;
 use crate::util::errors::{bad_request, server_error, AppResult};
 use axum::extract::Path;
@@ -23,6 +23,7 @@ pub struct UserUpdate {
 #[derive(Deserialize)]
 pub struct User {
     email: Option<String>,
+    publish_notifications: Option<bool>,
 }
 
 /// Handles the `PUT /users/:user_id` route.
@@ -44,6 +45,29 @@ pub async fn update_user(
             return Err(bad_request("current user does not match requested user"));
         }
 
+        if let Some(publish_notifications) = &user_update.user.publish_notifications {
+            if user.publish_notifications != *publish_notifications {
+                diesel::update(user)
+                    .set(users::publish_notifications.eq(*publish_notifications))
+                    .execute(conn)?;
+
+                if !publish_notifications {
+                    let email_address = user.verified_email(conn)?;
+
+                    if let Some(email_address) = email_address {
+                        let email = PublishNotificationsUnsubscribeEmail {
+                            user_name: &user.gh_login,
+                            domain: &state.emails.domain,
+                        };
+
+                        if let Err(error) = state.emails.send(&email_address, email) {
+                            warn!("Failed to send publish notifications unsubscribe email to {email_address}: {error}");
+                        }
+                    }
+                }
+            }
+        }
+
         if let Some(user_email) = &user_update.user.email {
             let user_email = user_email.trim();
 
@@ -153,3 +177,25 @@ https://{domain}/confirm/{token}",
         )
     }
 }
+
+pub struct PublishNotificationsUnsubscribeEmail<'a> {
+    pub user_name: &'a str,
+    pub domain: &'a str,
+}
+
+impl crate::email::Email for PublishNotificationsUnsubscribeEmail<'_> {
+    fn subject(&self) -> String {
+        "crates.io: Unsubscribed from publish notifications".into()
+    }
+
+    fn body(&self) -> String {
+        let Self { user_name, domain } = self;
+        format!(
+            "Hello {user_name}!
+
+You have been unsubscribed from publish notifications.
+
+If you would like to resubscribe, please visit https://{domain}/settings/profile",
+        )
+    }
+}

src/tests/routes/users/update.rs

@@ -2,6 +2,8 @@ use crate::util::{RequestHelper, Response, TestApp};
 use http::StatusCode;
 use insta::assert_snapshot;
 
+mod publish_notifications;
+
 pub trait MockEmailHelper: RequestHelper {
     // TODO: I don't like the name of this method or `update_email` on the `MockCookieUser` impl;
     // this is starting to look like a builder might help?

src/tests/routes/users/update/publish_notifications.rs

@@ -0,0 +1,50 @@
+use crate::builders::PublishBuilder;
+use crate::util::{RequestHelper, TestApp};
+use http::StatusCode;
+use insta::assert_snapshot;
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_unsubscribe_and_resubscribe() {
+    let (app, _anon, cookie, token) = TestApp::full().with_token();
+
+    let user_url = format!("/api/v1/users/{}", cookie.as_model().id);
+
+    // Publish a crate to trigger an initial publish email
+    let pb = PublishBuilder::new("foo", "1.0.0");
+    let response = token.publish_crate(pb).await;
+    assert_eq!(response.status(), StatusCode::OK);
+
+    // Assert that the user gets an initial publish email
+    assert_snapshot!(app.emails_snapshot());
+
+    // Unsubscribe from publish notifications
+    let payload = json!({"user": { "publish_notifications": false }});
+    let response = cookie.put::<()>(&user_url, payload.to_string()).await;
+    assert_eq!(response.status(), StatusCode::OK);
+    assert_snapshot!(response.text(), @r###"{"ok":true}"###);
+
+    // Assert that the user gets an unsubscribe email
+    assert_snapshot!(app.emails_snapshot());
+
+    // Publish the same crate again to check that the user doesn't get a publish email
+    let pb = PublishBuilder::new("foo", "1.1.0");
+    let response = token.publish_crate(pb).await;
+    assert_eq!(response.status(), StatusCode::OK);
+
+    // Assert that the user did not get a publish email this time
+    assert_snapshot!(app.emails_snapshot());
+
+    // Resubscribe to publish notifications
+    let payload = json!({"user": { "publish_notifications": true }});
+    let response = cookie.put::<()>(&user_url, payload.to_string()).await;
+    assert_eq!(response.status(), StatusCode::OK);
+    assert_snapshot!(response.text(), @r###"{"ok":true}"###);
+
+    // Publish the same crate again to check that the user doesn't get a publish email
+    let pb = PublishBuilder::new("foo", "1.2.0");
+    let response = token.publish_crate(pb).await;
+    assert_eq!(response.status(), StatusCode::OK);
+
+    // Assert that the user got a publish email again
+    assert_snapshot!(app.emails_snapshot());
+}

src/tests/routes/users/update/snapshots/all__routes__users__update__publish_notifications__unsubscribe_and_resubscribe-3.snap

@@ -0,0 +1,31 @@
+---
+source: src/tests/routes/users/update/publish_notifications.rs
+expression: app.emails_snapshot()
+---
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Successfully published foo@1.0.0
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+A new version of the package foo (1.0.0) was published by your account (htt=
+ps://crates.io/users/foo) at [0000-00-00T00:00:00Z].
+
+If you have questions or security concerns, you can contact us at help@crat=
+es.io.
+----------------------------------------
+
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Unsubscribed from publish notifications
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+You have been unsubscribed from publish notifications.
+
+If you would like to resubscribe, please visit https://crates.io/settings/p=
+rofile

src/tests/routes/users/update/snapshots/all__routes__users__update__publish_notifications__unsubscribe_and_resubscribe-4.snap

@@ -0,0 +1,31 @@
+---
+source: src/tests/routes/users/update/publish_notifications.rs
+expression: app.emails_snapshot()
+---
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Successfully published foo@1.0.0
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+A new version of the package foo (1.0.0) was published by your account (htt=
+ps://crates.io/users/foo) at [0000-00-00T00:00:00Z].
+
+If you have questions or security concerns, you can contact us at help@crat=
+es.io.
+----------------------------------------
+
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Unsubscribed from publish notifications
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+You have been unsubscribed from publish notifications.
+
+If you would like to resubscribe, please visit https://crates.io/settings/p=
+rofile

src/tests/routes/users/update/snapshots/all__routes__users__update__publish_notifications__unsubscribe_and_resubscribe-6.snap

@@ -0,0 +1,46 @@
+---
+source: src/tests/routes/users/update/publish_notifications.rs
+expression: app.emails_snapshot()
+---
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Successfully published foo@1.0.0
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+A new version of the package foo (1.0.0) was published by your account (htt=
+ps://crates.io/users/foo) at [0000-00-00T00:00:00Z].
+
+If you have questions or security concerns, you can contact us at help@crat=
+es.io.
+----------------------------------------
+
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Unsubscribed from publish notifications
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+You have been unsubscribed from publish notifications.
+
+If you would like to resubscribe, please visit https://crates.io/settings/p=
+rofile
+----------------------------------------
+
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Successfully published foo@1.2.0
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+A new version of the package foo (1.2.0) was published by your account (htt=
+ps://crates.io/users/foo) at [0000-00-00T00:00:00Z].
+
+If you have questions or security concerns, you can contact us at help@crat=
+es.io.

src/tests/routes/users/update/snapshots/all__routes__users__update__publish_notifications__unsubscribe_and_resubscribe.snap

@@ -0,0 +1,17 @@
+---
+source: src/tests/routes/users/update/publish_notifications.rs
+expression: app.emails_snapshot()
+---
+To: foo@example.com
+From: crates.io <noreply@crates.io>
+Subject: crates.io: Successfully published foo@1.0.0
+Content-Type: text/plain; charset=utf-8
+Content-Transfer-Encoding: quoted-printable
+
+Hello foo!
+
+A new version of the package foo (1.0.0) was published by your account (htt=
+ps://crates.io/users/foo) at [0000-00-00T00:00:00Z].
+
+If you have questions or security concerns, you can contact us at help@crat=
+es.io.