cli: Improve config file handling (#2123)

Author: svix-jplatte

svix-cli/Cargo.lock

@@ -35,9 +35,10 @@ clap_complete = "4.5.38"
 colored_json = "5.0.0"
 concolor-clap = "0.1.0"
 dialoguer = "0.11.0"
+dirs = "6.0.0"
 figment = { version = "0.10.19", features = ["toml", "env"] }
+fs-err = "3.2.0"
 futures-util = "0.3.31"
-home = "0.5.11"
 http = "1.2.0"
 # Reduce compile times for idna (we don't need the fastest possible impl of UTS 46)
 # As per https://github.com/hsivonen/idna_adapter?tab=readme-ov-file#opting-to-use-unicode-rs

svix-cli/Cargo.toml

@@ -20,9 +20,9 @@ impl ListenArgs {
                 let cfg_path = get_config_file_path()?;
                 if let Err(e) = updated_cfg.save_to_disk(&cfg_path).context(format!(
                     "failed to save relay token to config file at `{}`",
-                    cfg_path.as_os_str().to_str().unwrap_or_default()
+                    cfg_path.display()
                 )) {
-                    eprintln!("{e}");
+                    eprintln!("{e:#}");
                 }
                 token
             }

svix-cli/src/cmds/listen.rs

@@ -43,7 +43,7 @@ pub async fn prompt(_cfg: &Config) -> Result<()> {
     cfg.auth_token = Some(auth_token);
     let fp = config::get_config_file_path()?;
     if let Err(e) = cfg.save_to_disk(&fp) {
-        eprintln!("\n{e}\n");
+        eprintln!("\n{e:#}\n");
         anyhow::bail!(
             "Failed to configure the Svix CLI, please try again or try setting your auth \
              token manually `SVIX_AUTH_TOKEN` environment variable."
@@ -52,7 +52,7 @@ pub async fn prompt(_cfg: &Config) -> Result<()> {
 
     println!(
         "All Set! Your config has been written to `{}`",
-        fp.as_os_str().to_str().unwrap_or_default()
+        fp.display()
     );
     println!(
         "Type `{} --help` to print the Svix CLI documentation!",

svix-cli/src/cmds/login.rs

@@ -1,14 +1,14 @@
 use std::{
-    fs::{File, OpenOptions},
     io::Write,
     path::{Path, PathBuf},
 };
 
-use anyhow::Result;
+use anyhow::{Context as _, Result};
 use figment::{
     providers::{Env, Format, Toml},
     Figment,
 };
+use fs_err::{self as fs, File};
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
@@ -30,29 +30,29 @@ pub struct Config {
     pub relay_disable_security: Option<bool>,
 }
 
-fn config_file_open_opts() -> OpenOptions {
-    OpenOptions::new()
-        .create(true)
-        .truncate(true)
-        .write(true)
-        .to_owned()
-}
+fn create_config_file(path: &Path) -> Result<File> {
+    let dir = path
+        .parent()
+        .context("config file path must not be empty")?;
+    fs::create_dir_all(dir)?;
 
-#[cfg(windows)]
-fn open_config_file(path: &Path) -> Result<File> {
-    Ok(config_file_open_opts().open(path)?)
-}
+    let mut opts = File::options();
+    opts.create(true).truncate(true).write(true);
+
+    #[cfg(unix)]
+    {
+        use std::os::unix::fs::OpenOptionsExt;
+
+        const FILE_MODE: u32 = 0o600;
+        opts.options_mut().mode(FILE_MODE);
+    }
 
-#[cfg(unix)]
-fn open_config_file(path: &Path) -> Result<File> {
-    use std::os::unix::fs::OpenOptionsExt;
-    const FILE_MODE: u32 = 0o600;
-    Ok(config_file_open_opts().mode(FILE_MODE).open(path)?)
+    Ok(opts.open(path)?)
 }
 
 impl Config {
     pub fn load() -> Result<Config> {
-        let cfg_file = get_folder()?.join(FILE_NAME);
+        let cfg_file = get_config_file_path()?;
         let config: Config = Figment::new()
             .merge(Toml::file(cfg_file))
             .merge(Env::prefixed("SVIX_"))
@@ -61,8 +61,7 @@ impl Config {
     }
 
     pub fn save_to_disk(&self, path: &Path) -> Result<()> {
-        let mut fh = open_config_file(path)?;
-
+        let mut fh = create_config_file(path)?;
         let source = &toml::to_string_pretty(self)?;
         fh.write_all(source.as_bytes())?;
         Ok(())
@@ -81,21 +80,9 @@ impl Config {
 const FILE_NAME: &str = "config.toml";
 
 fn get_folder() -> Result<PathBuf> {
-    let config_path = if cfg!(windows) {
-        std::env::var("APPDATA")
-    } else {
-        std::env::var("XDG_CONFIG_HOME")
-    };
-
-    let pb = match config_path {
-        Ok(path) => PathBuf::from(path),
-        Err(_e) => {
-            // N.b. per <https://github.com/rust-lang/cargo/blob/master/crates/home/README.md> the
-            // stdlib should be fixed as of Rust 1.86.
-            home::home_dir().ok_or_else(|| anyhow::anyhow!("unable to find config path"))?
-        }
-    };
-    Ok(pb.join(".config").join("svix"))
+    Ok(dirs::config_dir()
+        .context("unable to find config path")?
+        .join("svix"))
 }
 
 pub fn get_config_file_path() -> Result<PathBuf> {

svix-cli/src/config.rs

@@ -191,14 +191,14 @@ impl Client {
             async move {
                 read_from_ws_loop(ws_rx, remote_tx, local_url.clone(), http_client.clone())
                     .await
-                    .inspect_err(|e| eprintln!("read loop terminated: {e}"))
+                    .inspect_err(|e| eprintln!("read loop terminated: {e:#}"))
             }
         });
 
         set.spawn(async move {
             send_to_ws_loop(remote_rx, ws_tx)
                 .await
-                .inspect_err(|e| eprintln!("write loop terminated: {e}"))
+                .inspect_err(|e| eprintln!("write loop terminated: {e:#}"))
         });
 
         // If any task terminates, trash the rest so we can reconnect.
@@ -248,7 +248,7 @@ pub async fn listen(
         let show_welcome_message = attempt_count == 0 || orig_token != client.token;
 
         if let Err(e) = client.connect(show_welcome_message).await {
-            eprintln!("Failed to connect to Webhook Relay: {e}");
+            eprintln!("Failed to connect to Webhook Relay: {e:#}");
             if e.downcast_ref::<TokenInUse>().is_some() {
                 eprintln!("Generating a new token for this session.");
                 client.token = {
@@ -418,11 +418,11 @@ async fn handle_incoming_message(
             println!("<- Forwarding message id={msg_id} to: {local_url}");
             match make_local_request(client, local_url, data).await {
                 Err(err) => {
-                    eprintln!("Failed to make request to local server: \n{err}");
+                    eprintln!("Failed to make request to local server: \n{err:#}");
                 }
                 Ok(resp) => {
                     if let Err(err) = process_response(msg_id, resp, tx).await {
-                        eprintln!("Failed to read response from local server: \n{err}");
+                        eprintln!("Failed to read response from local server: \n{err:#}");
                     }
                 }
             }