chore: formatted the codebase

Author: Utilitycoder

src/authentication/middleware.rs

@@ -2,10 +2,12 @@ use crate::{
     session_state::TypedSession,
     utils::{e500, see_other},
 };
-use actix_web::body::MessageBody;
-use actix_web::dev::{ServiceRequest, ServiceResponse};
-use actix_web::error::InternalError;
-use actix_web::{FromRequest, HttpMessage};
+use actix_web::{
+    body::MessageBody,
+    dev::{ServiceRequest, ServiceResponse},
+    error::InternalError,
+    {FromRequest, HttpMessage},
+};
 use actix_web_lab::middleware::Next;
 use std::ops::Deref;
 use uuid::Uuid;
@@ -27,6 +29,7 @@ impl Deref for UserId {
     }
 }
 
+//
 pub async fn reject_anonymous_users(
     mut req: ServiceRequest,
     next: Next<impl MessageBody>,

src/authentication/mod.rs

@@ -1,5 +1,5 @@
 mod middleware;
 mod password;
-pub use middleware::reject_anonymous_users;
-pub use middleware::UserId;
+
+pub use middleware::{reject_anonymous_users, UserId};
 pub use password::{change_password, validate_credentials, AuthError, Credentials};

src/authentication/password.rs

@@ -1,6 +1,8 @@
 use anyhow::Context;
-use argon2::password_hash::SaltString;
-use argon2::{Algorithm, Argon2, Params, PasswordHash, PasswordHasher, PasswordVerifier, Version};
+use argon2::{
+    password_hash::SaltString, Algorithm, Argon2, Params, PasswordHash, PasswordHasher,
+    PasswordVerifier, Version,
+};
 use secrecy::{ExposeSecret, Secret};
 use sqlx::PgPool;
 
@@ -24,6 +26,7 @@ async fn get_stored_credentials(
     username: &str,
     pool: &PgPool,
 ) -> Result<Option<(uuid::Uuid, Secret<String>)>, anyhow::Error> {
+    // Retrieve the user's id and password hash from the database.
     let row = sqlx::query!(
         r#"
         SELECT user_id, password_hash
@@ -52,6 +55,7 @@ pub async fn validate_credentials(
             .to_string(),
     );
 
+    // conditionally assign stored_user_id and stored_password_hash
     if let Some((stored_user_id, stored_password_hash)) =
         get_stored_credentials(&credentials.username, pool).await?
     {

src/domain/new_subscriber.rs

@@ -1,5 +1,5 @@
-use crate::domain::subscriber_email::SubscriberEmail;
-use crate::domain::subscriber_name::SubscriberName;
+use crate::domain::{subscriber_email::SubscriberEmail, subscriber_name::SubscriberName};
+
 pub struct NewSubscriber {
     pub email: SubscriberEmail,
     pub name: SubscriberName,

src/domain/subscriber_email.rs

@@ -12,6 +12,7 @@ impl SubscriberEmail {
     }
 }
 
+// Gain access to the inner String by implementing AsRef<str>.
 impl AsRef<str> for SubscriberEmail {
     fn as_ref(&self) -> &str {
         &self.0

src/domain/subscriber_name.rs

@@ -13,9 +13,11 @@ impl SubscriberName {
         let is_empty_or_whitespace = name.trim().is_empty();
         let is_too_long = name.len() > 256;
         let forbidden_characters = ['/', '(', ')', '"', '<', '>', '\\', '{', '}'];
+        // Check if the name contains any of the forbidden characters.
         let contains_forbidden_characters = name
             .chars()
             .any(|char| forbidden_characters.contains(&char));
+        // If any of the above checks returns true, return an error.
         if is_empty_or_whitespace || is_too_long || contains_forbidden_characters {
             Err(format!(
                 "`{}` is not a valid subscriber name. Subscriber name cannot be empty, more than 256 characters long, or contain the following characters: {:?}",

src/idempotency/key.rs

@@ -11,7 +11,7 @@ impl TryFrom<String> for IdempotencyKey {
         if s.len() >= max_length {
             anyhow::bail!(
                 "The idempotency key must be shorter
-than {max_length} characters"
+                than {max_length} characters"
             );
         }
         Ok(Self(s))

src/idempotency/mod.rs

@@ -1,6 +1,4 @@
 mod key;
 mod persistence;
 pub use key::IdempotencyKey;
-pub use persistence::get_saved_response;
-pub use persistence::save_response;
-pub use persistence::{try_processing, NextAction};
+pub use persistence::{get_saved_response, save_response, try_processing, NextAction};

src/idempotency/persistence.rs

@@ -1,10 +1,6 @@
 use super::IdempotencyKey;
-use actix_web::body::to_bytes;
-use actix_web::http::StatusCode;
-use actix_web::HttpResponse;
-use sqlx::postgres::PgHasArrayType;
-use sqlx::PgPool;
-use sqlx::{Postgres, Transaction};
+use actix_web::{body::to_bytes, http::StatusCode, HttpResponse};
+use sqlx::{postgres::PgHasArrayType, PgPool, Postgres, Transaction};
 use uuid::Uuid;
 
 #[derive(Debug, sqlx::Type)]

src/lib.rs

@@ -1,3 +1,4 @@
+// Purpose: Main library file for the application.
 pub mod authentication;
 pub mod configuration;
 pub mod domain;

src/session_state.rs

@@ -3,23 +3,34 @@ use actix_web::dev::Payload;
 use actix_web::{FromRequest, HttpRequest};
 use std::future::{ready, Ready};
 use uuid::Uuid;
+
+// Purpose: A wrapper around `Session` that provides type-safe access to the
+// session data.
 pub struct TypedSession(Session);
 
+// Associated functions for `TypedSession`.
 impl TypedSession {
+    // The key used to store the user ID in the session.
     const USER_ID_KEY: &'static str = "user_id";
 
+    // Renews the session key, assigning existing session state to new key.
     pub fn renew(&self) {
         self.0.renew();
     }
 
+    // Inserts the user ID into the session.
+    // Returns an error if it fails to serialize value to JSON.
     pub fn insert_user_id(&self, user_id: Uuid) -> Result<(), SessionInsertError> {
         self.0.insert(Self::USER_ID_KEY, user_id)
     }
 
+    // Gets the user ID from the session.
+    // Returns an error if it fails to deserialize value from JSON.
     pub fn get_user_id(&self) -> Result<Option<Uuid>, SessionGetError> {
         self.0.get(Self::USER_ID_KEY)
     }
 
+    // Removes the user ID from the session.
     pub fn log_out(self) {
         self.0.purge()
     }