Merge branch 'feature/update' into development

Author: keypair34

crates/cli/README.md

@@ -22,7 +22,7 @@
 
 ## Installation
 
-One can install this program in different ways.
+You can install the CLI a few different ways.
 
 ### With Cargo
 
@@ -51,7 +51,7 @@ pip install smbcloud-cli
 
 ## Update
 
-Simply rerun the installation command.
+To update the CLI, run the same install command again.
 
 ## Uninstall
 
@@ -78,16 +78,16 @@ smb --help
 
 ## Contribution
 
-- Setup your Rust tooling.
+- Set up your Rust tooling.
 - Clone the repo.
-- Provide the environment variables in the .env.local.
+- Add the required environment variables to `.env.local`.
 - Run `cargo run`.
 
 ## Credits
 
-This repo is inspired by [Sugar](https://github.com/metaplex-foundation/sugar).
+This repo draws inspiration from [Sugar](https://github.com/metaplex-foundation/sugar).
 
-This repo tries to follow [the 12 factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46) principles by
+It also borrows ideas from [the 12 factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46).
 
 > Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
 

crates/cli/src/account/cli.rs

@@ -2,12 +2,12 @@ use clap::Subcommand;
 
 #[derive(Subcommand)]
 pub enum Commands {
-    #[clap(about = "Create an account. Use your email as your username.")]
+    #[clap(about = "Create an account with your email address.")]
     Signup {},
-    #[clap(about = "Login to your account. To create an account, use smb signup.")]
+    #[clap(about = "Log in to your account. If you need one first, run `smb signup`.")]
     Login {},
-    #[clap(about = "Logout all session.")]
+    #[clap(about = "Log out of your current session.")]
     Logout {},
-    #[clap(about = "Forgot email? Use this command to reset your password.")]
+    #[clap(about = "Start the password reset flow.")]
     Forgot {},
 }

crates/cli/src/account/forgot/mod.rs

@@ -13,7 +13,7 @@ use smbcloud_utils::email_validation;
 use spinners::Spinner;
 
 pub async fn process_forgot(env: Environment) -> Result<CommandResult> {
-    println!("Provide your login credentials.");
+    println!("Enter your email address.");
     let email = Input::<String>::with_theme(&ColorfulTheme::default())
         .with_prompt("Email")
         .validate_with(|email: &String| email_validation(email))

crates/cli/src/account/lib.rs

@@ -25,9 +25,7 @@ use {
 };
 
 pub async fn authorize_github(env: &Environment) -> Result<SmbAuthorization> {
-    // Spin up a simple localhost server to listen for the GitHub OAuth callback
-    // setup_oauth_callback_server();
-    // Open the GitHub OAuth URL in the user's browser
+    // Listen for the GitHub OAuth callback on localhost, then open the browser.
     let mut spinner = Spinner::new(
         spinners::Spinners::BouncingBall,
         style("🚀 Getting your GitHub information...")
@@ -61,7 +59,6 @@ pub async fn authorize_github(env: &Environment) -> Result<SmbAuthorization> {
     match rx.recv() {
         Ok(code) => {
             debug!("Got code from channel: {:#?}", &code);
-            //Err(anyhow!("Failed to get code from channel."))
             process_connect_github(*env, code).await
         }
         Err(e) => {
@@ -144,7 +141,6 @@ fn handle_connection(mut stream: TcpStream, tx: Sender<String>) {
     stream.flush().unwrap();
 }
 
-// Get access token
 pub async fn process_connect_github(env: Environment, code: String) -> Result<SmbAuthorization> {
     let response = Client::new()
         .post(build_authorize_smb_url(env))
@@ -160,32 +156,25 @@ pub async fn process_connect_github(env: Environment, code: String) -> Result<Sm
             .bold()
             .to_string(),
     );
-    // println!("Response: {:#?}", &response);
     match response.status() {
         StatusCode::OK => {
-            // Account authorized and token received
             spinner.stop_and_persist("✅", "You are logged in with your GitHub account!".into());
             save_token(env, &response).await?;
             let result = response.json().await?;
             // println!("Result: {:#?}", &result);
             Ok(result)
         }
         StatusCode::NOT_FOUND => {
-            // Account not found and we show signup option
-            spinner.stop_and_persist("🥲", "Account not found. Please signup!".into());
+            spinner.stop_and_persist("🥲", "Account not found. Please sign up.".into());
             let result = response.json().await?;
-            // println!("Result: {:#?}", &result);
             Ok(result)
         }
         StatusCode::UNPROCESSABLE_ENTITY => {
-            // Account found but email not verified
-            spinner.stop_and_persist("🥹", "Unverified email!".into());
+            spinner.stop_and_persist("🥹", "Please verify your email address.".into());
             let result = response.json().await?;
-            // println!("Result: {:#?}", &result);
             Ok(result)
         }
         _ => {
-            // Other errors
             let error = anyhow!("Error while authorizing with GitHub.");
             Err(error)
         }
@@ -222,13 +211,14 @@ fn github_base_url_builder() -> URLBuilder {
 
 pub async fn save_token(env: Environment, response: &Response) -> Result<()> {
     let headers = response.headers();
-    // println!("Headers: {:#?}", &headers);
     match headers.get("Authorization") {
         Some(token) => {
             debug!("{}", token.to_str()?);
             store_token(env, token.to_str()?.to_string()).await
         }
-        None => Err(anyhow!("Failed to get token. Probably a backend issue.")),
+        None => Err(anyhow!(
+            "Failed to get the access token from the server response."
+        )),
     }
 }
 

crates/cli/src/account/login/process.rs

@@ -78,8 +78,6 @@ pub async fn process_login(env: Environment, is_logged_in: Option<bool>) -> Resu
     }
 }
 
-// Private functions
-
 async fn login_with_github(env: Environment) -> Result<CommandResult> {
     match authorize_github(&env).await {
         Ok(result) => process_authorization(env, result).await,
@@ -91,30 +89,26 @@ async fn login_with_github(env: Environment) -> Result<CommandResult> {
 }
 
 async fn process_authorization(env: Environment, auth: SmbAuthorization) -> Result<CommandResult> {
-    // What to do if not logged in with GitHub?
-    // Check error_code first
+    // Handle the account state returned by the OAuth flow before treating it as a login.
     if let Some(error_code) = auth.error_code {
         debug!("{}", error_code);
         match error_code {
             EmailNotFound => return create_new_account(env, auth.user_email, auth.user_info).await,
             EmailUnverified => return send_email_verification(env, auth.user).await,
             PasswordNotSet => {
-                // Only for email and password login
                 let error = anyhow!("Password not set.");
                 return Err(error);
             }
             GithubNotLinked => return connect_github_account(env, auth).await,
         }
     }
 
-    // Logged in with GitHub!
-    // Token handling is in the lib.rs account module.
+    // Token handling lives in the account module.
     if let Some(user) = auth.user {
         let spinner = Spinner::new(
             spinners::Spinners::SimpleDotsScrolling,
             style("Logging you in...").green().bold().to_string(),
         );
-        // We're logged in with GitHub.
         return Ok(CommandResult {
             spinner,
             symbol: "✅".to_owned(),
@@ -142,7 +136,6 @@ async fn create_new_account(
         }
     };
 
-    // Create account if user confirms
     if !confirm {
         let spinner = Spinner::new(
             spinners::Spinners::SimpleDotsScrolling,
@@ -169,11 +162,10 @@ async fn create_new_account(
         return do_signup(env, &params).await;
     }
 
-    Err(anyhow!("Shouldn't be here."))
+    Err(anyhow!("GitHub returned incomplete account details."))
 }
 
 async fn send_email_verification(env: Environment, user: Option<User>) -> Result<CommandResult> {
-    // Return early if user is null
     if let Some(user) = user {
         let confirm = match Confirm::with_theme(&ColorfulTheme::default())
             .with_prompt("Do you want to send a new verification email?")
@@ -186,16 +178,15 @@ async fn send_email_verification(env: Environment, user: Option<User>) -> Result
             }
         };
 
-        // Send verification email if user confirms
         if !confirm {
             let spinner = Spinner::new(
                 spinners::Spinners::SimpleDotsScrolling,
-                style("Cancel operation.").green().bold().to_string(),
+                style("Cancelled.").green().bold().to_string(),
             );
             return Ok(CommandResult {
                 spinner,
                 symbol: succeed_symbol(),
-                msg: succeed_message("Doing nothing."),
+                msg: succeed_message("Cancelled."),
             });
         }
         resend_email_verification(env, user).await
@@ -238,16 +229,15 @@ async fn connect_github_account(env: Environment, auth: SmbAuthorization) -> Res
         }
     };
 
-    // Link GitHub account if user confirms
     if !confirm {
         let spinner = Spinner::new(
             spinners::Spinners::SimpleDotsScrolling,
-            succeed_message("Cancel operation."),
+            succeed_message("Cancelled."),
         );
         return Ok(CommandResult {
             spinner,
             symbol: succeed_symbol(),
-            msg: succeed_message("Doing nothing."),
+            msg: succeed_message("Cancelled."),
         });
     }
 
@@ -278,7 +268,7 @@ async fn connect_github_account(env: Environment, auth: SmbAuthorization) -> Res
 }
 
 async fn login_with_email(env: Environment) -> Result<CommandResult> {
-    println!("Provide your login credentials.");
+    println!("Enter your login details.");
     let username = match Input::<String>::with_theme(&ColorfulTheme::default())
         .with_prompt("Email")
         .validate_with(|email: &String| email_validation(email))
@@ -293,9 +283,7 @@ async fn login_with_email(env: Environment) -> Result<CommandResult> {
 
     match check_email(env, client(), &username).await {
         Ok(auth) => {
-            // Only continue with password input if email is found and confirmed.
             if auth.error_code.is_some() {
-                // Check if email is in the database, unconfirmed. Only presents password input if email is found and confirmed.
                 let spinner = Spinner::new(
                     spinners::Spinners::SimpleDotsScrolling,
                     succeed_message("Checking email"),
@@ -382,11 +370,11 @@ async fn after_checking_email_step(
                 }
                 _ => {
                     spinner.stop_and_persist(&fail_symbol(), fail_message("An error occurred."));
-                    Err(anyhow!("Idk what happened."))
+                    Err(anyhow!("The server returned an unexpected account state."))
                 }
             }
         }
-        None => Err(anyhow!("Shouldn't be here.")),
+        None => Err(anyhow!("The server did not return an account state.")),
     }
 }
 
@@ -421,13 +409,12 @@ async fn action_on_account_status(
         }
         _ => {
             spinner.stop_and_persist(&fail_symbol(), fail_message("An error occurred."));
-            Err(anyhow!("Idk what happened."))
+            Err(anyhow!("The server returned an unexpected account state."))
         }
     }
 }
 
 async fn send_reset_password(env: Environment, user: Option<User>) -> Result<CommandResult> {
-    // Return early if user is null
     if let Some(user) = user {
         let confirm = match Confirm::with_theme(&ColorfulTheme::default())
             .with_prompt("Do you want to reset your password?")
@@ -440,16 +427,15 @@ async fn send_reset_password(env: Environment, user: Option<User>) -> Result<Com
             }
         };
 
-        // Send verification email if user confirms
         if !confirm {
             let spinner = Spinner::new(
                 spinners::Spinners::SimpleDotsScrolling,
-                style("Cancel operation.").green().bold().to_string(),
+                style("Cancelled.").green().bold().to_string(),
             );
             return Ok(CommandResult {
                 spinner,
                 symbol: succeed_symbol(),
-                msg: succeed_message("Doing nothing."),
+                msg: succeed_message("Cancelled."),
             });
         }
         resend_reset_password_instruction(env, user).await

crates/cli/src/account/logout/mod.rs

@@ -14,7 +14,6 @@ use {
 };
 
 pub async fn process_logout(env: Environment) -> Result<CommandResult> {
-    // Logout if user confirms
     if let Some(token_path) = smb_token_file_path(env) {
         let confirm = match Confirm::with_theme(&ColorfulTheme::default())
             .with_prompt("Do you want to logout? y/n")
@@ -30,10 +29,10 @@ pub async fn process_logout(env: Environment) -> Result<CommandResult> {
             return Ok(CommandResult {
                 spinner: Spinner::new(
                     spinners::Spinners::SimpleDotsScrolling,
-                    succeed_message("Cancel operation"),
+                    succeed_message("Cancelled."),
                 ),
                 symbol: succeed_symbol(),
-                msg: succeed_message("Doing nothing."),
+                msg: succeed_message("Cancelled."),
             });
         }
 
@@ -42,7 +41,6 @@ pub async fn process_logout(env: Environment) -> Result<CommandResult> {
             succeed_message("Logging you out"),
         );
 
-        // Call backend
         match do_process_logout(env).await {
             Ok(_) => {
                 fs::remove_file(token_path)?;

crates/smbcloud-model/src/error_codes.rs

@@ -39,7 +39,7 @@ pub enum ErrorCode {
     MissingConfig = 4,
     // #[error("Missing id in repository. Please regenerate with 'smb init'.")]
     // MissingId,
-    #[error("Cancel operation.")]
+    #[error("Cancelled.")]
     Cancel = 5,
     // Account
     #[error("Unauthorized access.")]
@@ -122,7 +122,7 @@ impl ErrorCode {
             // CLI Generic errors
             ErrorCode::InputError => "Input error.",
             ErrorCode::MissingConfig => "Missing config.",
-            ErrorCode::Cancel => "Cancelled operation.",
+            ErrorCode::Cancel => "Cancelled.",
             // Projects
             ErrorCode::ProjectNotFound => "Project not found.",
             ErrorCode::UnsupportedRunner => "Unsupported runner.",

crates/smbcloud-networking/README.md

@@ -2,7 +2,7 @@
 
 Low-level HTTP client helpers for smbCloud services.
 
-This crate was inspired by this excellent blog post: [Designing a Web API client in Rust](https://nullderef.com/blog/web-api-client/).
+This crate takes a few cues from [Designing a Web API client in Rust](https://nullderef.com/blog/web-api-client/).
 
 > Explore more on the [smbCloud Services](https://smbcloud.xyz/services) page.
 

npm/smbcloud-cli/src/index.ts

@@ -20,22 +20,24 @@ function getExePath() {
     }
 
     try {
-        // Since the binary will be located inside `node_modules`, we can simply call `require.resolve`
-        return require.resolve(`@smbcloud/cli-${os}-${arch}/bin/smb${extension}`);
+        // The binary lives in `node_modules`, so `require.resolve` gives us the installed path.
+        return require.resolve(
+            `@smbcloud/cli-${os}-${arch}/bin/smb${extension}`,
+        );
     } catch (e) {
         throw new Error(
-            `Couldn't find application binary inside node_modules for ${os}-${arch}`
+            `Couldn't find application binary inside node_modules for ${os}-${arch}`,
         );
     }
 }
 
 /**
- * Runs the application with args using nodejs spawn
+ * Runs the native CLI with the current process arguments.
  */
 function run() {
     const args = process.argv.slice(2);
     const processResult = spawnSync(getExePath(), args, { stdio: "inherit" });
     process.exit(processResult.status ?? 0);
 }
 
-run();
+run();