chore: Started working on idempotency

Utilitycoder · Utilitycoder · commit 00d24f8e3663 · 2023-07-14T18:23:08.000+01:00
diff --git a/src/routes/admin/dashboard.rs b/src/routes/admin/dashboard.rs
@@ -33,6 +33,7 @@ pub async fn admin_dashboard(
             <p>Available actions:</p>
             <ol>
             <li><a href="/admin/password">Change password</a></li>
+            <li><a href="/admin/newsletters">Send Newsletter</a></li>
             <li>
                 <form name="logoutForm" action="/admin/logout" method="post">
                     <input type="submit" value="Logout">
diff --git a/src/routes/admin/mod.rs b/src/routes/admin/mod.rs
@@ -1,9 +1,9 @@
 mod dashboard;
 mod logout;
-mod password;
 mod newsletters;
+mod password;
 
 pub use dashboard::admin_dashboard;
 pub use logout::log_out;
-pub use password::*;
 pub use newsletters::*;
+pub use password::*;
diff --git a/src/routes/admin/newsletters/get.rs b/src/routes/admin/newsletters/get.rs
@@ -3,15 +3,17 @@ use actix_web::HttpResponse;
 use actix_web_flash_messages::IncomingFlashMessages;
 use std::fmt::Write;
 
-pub async fn publish_newsletter_form(flash_messages: IncomingFlashMessages) -> Result<HttpResponse, actix_web::Error> {
+pub async fn publish_newsletter_form(
+    flash_messages: IncomingFlashMessages,
+) -> Result<HttpResponse, actix_web::Error> {
     let mut incoming_flash = String::new();
     for message in flash_messages.iter() {
         writeln!(incoming_flash, "<p><i>{}</i></p>", message.content()).unwrap();
     }
     Ok(HttpResponse::Ok()
         .content_type(ContentType::html())
         .body(format!(
-                r#"<!DOCTYPE html>
+            r#"<!DOCTYPE html>
                 <html lang="en">
                 <head>
                     <meta http-equiv="content-type" content="text/html; charset=utf-8">
@@ -52,4 +54,4 @@ pub async fn publish_newsletter_form(flash_messages: IncomingFlashMessages) -> R
                 </body>
                 </html>"#,
         )))
-}
+}
diff --git a/src/routes/admin/newsletters/mod.rs b/src/routes/admin/newsletters/mod.rs
@@ -2,4 +2,4 @@ mod get;
 mod post;
 
 pub use get::*;
-pub use post::*;
+pub use post::*;
diff --git a/src/routes/admin/newsletters/post.rs b/src/routes/admin/newsletters/post.rs
@@ -11,13 +11,8 @@ use sqlx::PgPool;
 #[derive(serde::Deserialize)]
 pub struct BodyData {
     title: String,
-    content: Content,
-}
-
-#[derive(serde::Deserialize)]
-pub struct Content {
-    html: String,
-    text: String,
+    text_content: String,
+    html_content: String,
 }
 
 #[tracing::instrument(
@@ -39,14 +34,16 @@ pub async fn publish_newsletter(
                     .send_email(
                         &subscriber.email,
                         &body.title,
-                        &body.content.html,
-                        &body.content.text,
+                        &body.html_content,
+                        &body.text_content,
                     )
                     .await
                     .with_context(|| {
                         format!("Failed to send newsletter issue to {}", subscriber.email)
-                    }).map_err(e500)?;
+                    })
+                    .map_err(e500)?;
             }
+
             Err(error) => {
                 tracing::warn!(
                     error.cause_chain = ?error,
diff --git a/src/startup.rs b/src/startup.rs
@@ -4,20 +4,20 @@ use crate::{
     email_client::EmailClient,
     routes::{
         admin_dashboard, change_password, change_password_form, confirm, health_check, home,
-        log_out, login, login_form, publish_newsletter, subscribe,
+        log_out, login, login_form, publish_newsletter, publish_newsletter_form, subscribe,
     },
 };
 use actix_session::storage::RedisSessionStore;
 use actix_session::SessionMiddleware;
 use actix_web::{cookie::Key, dev::Server, web, App, HttpServer};
 use actix_web_flash_messages::storage::CookieMessageStore;
 use actix_web_flash_messages::FlashMessagesFramework;
+use actix_web_lab::middleware::from_fn;
 use secrecy::{ExposeSecret, Secret};
 use sqlx::postgres::PgPoolOptions;
 use sqlx::PgPool;
 use std::net::TcpListener;
 use tracing_actix_web::TracingLogger;
-use actix_web_lab::middleware::from_fn;
 
 pub struct Application {
     port: u16,
@@ -104,7 +104,6 @@ async fn run(
             .route("/health_check", web::get().to(health_check))
             .route("/subscriptions", web::post().to(subscribe))
             .route("/subscriptions/confirm", web::get().to(confirm))
-            .route("/newsletters", web::post().to(publish_newsletter))
             .route("/", web::get().to(home))
             .route("/login", web::get().to(login_form))
             .route("/login", web::post().to(login))
@@ -114,7 +113,9 @@ async fn run(
                     .route("/dashboard", web::get().to(admin_dashboard))
                     .route("/password", web::get().to(change_password_form))
                     .route("/password", web::post().to(change_password))
-                    .route("/logout", web::post().to(log_out)),
+                    .route("/logout", web::post().to(log_out))
+                    .route("/newsletters", web::post().to(publish_newsletter))
+                    .route("/newsletters", web::get().to(publish_newsletter_form)),
             )
             .app_data(db_pool.clone())
             .app_data(email_client.clone())
diff --git a/tests/api/newsletter.rs b/tests/api/newsletter.rs
@@ -205,3 +205,40 @@ async fn invalid_password_is_rejected() {
         response.headers()["WWW-Authenticate"]
     );
 }
+
+#[tokio::test]
+async fn newsletter_creation_is_idempotent() {
+    // Arrange
+    let app = spawn_app().await;
+    create_confirmed_subscriber(&app).await;
+    app.test_user.login(&app).await;
+    
+    // We create a mock server that will intercept the request
+    Mock::given(path("/email"))
+        .and(method("POST"))
+        .respond_with(ResponseTemplate::new(200))
+        .expect(1)
+        .mount(&app.email_server)
+        .await;
+    // Act - Part 1 - Submit newsletter form
+    let newsletter_request_body = serde_json::json!({
+    "title": "Newsletter title",
+    "text_content": "Newsletter body as plain text",
+    "html_content": "<p>Newsletter body as HTML</p>",
+    // We expect the idempotency key as part of the
+    // form data, not as an header
+    "idempotency_key": uuid::Uuid::new_v4().to_string()
+    });
+    let response = app.post_publish_newsletter(&newsletter_request_body).await;
+    assert_is_redirect_to(&response, "/admin/newsletters");
+    // Act - Part 2 - Follow the redirect
+    let html_page = app.get_publish_newsletter_html().await;
+    assert!(html_page.contains("<p><i>The newsletter issue has been published!</i></p>"));
+    // Act - Part 3 - Submit newsletter form **again**
+    let response = app.post_publish_newsletter(&newsletter_request_body).await;
+    assert_is_redirect_to(&response, "/admin/newsletters");
+    // Act - Part 4 - Follow the redirect
+    let html_page = app.get_publish_newsletter_html().await;
+    assert!(html_page.contains("<p><i>The newsletter issue has been published!</i></p>"));
+    // Mock verifies on Drop that we have sent the newsletter email **once**
+}
