refactor: util config/data paths return Results

Author: b5

iroh-ctl/src/main.rs

@@ -53,7 +53,8 @@ enum Commands {
 async fn main() -> anyhow::Result<()> {
     let cli = Cli::parse();
 
-    let sources = vec![iroh_config_path(CONFIG_FILE_NAME), cli.cfg.clone()];
+    let cfg_path = iroh_config_path(CONFIG_FILE_NAME)?;
+    let sources = vec![Some(cfg_path), cli.cfg.clone()];
     let config = make_config(
         // default
         Config::default(),

iroh-gateway/src/main.rs

@@ -17,7 +17,8 @@ use tracing::{debug, error};
 async fn main() -> Result<()> {
     let args = Args::parse();
 
-    let sources = vec![iroh_config_path(CONFIG_FILE_NAME), args.cfg.clone()];
+    let cfg_path = iroh_config_path(CONFIG_FILE_NAME)?;
+    let sources = vec![Some(cfg_path), args.cfg.clone()];
     let mut config = make_config(
         // default
         Config::default(),

iroh-one/src/main.rs

@@ -21,7 +21,8 @@ use tracing::{debug, error};
 async fn main() -> Result<()> {
     let args = Args::parse();
 
-    let sources = vec![iroh_config_path(CONFIG_FILE_NAME), args.cfg.clone()];
+    let cfg_path = iroh_config_path(CONFIG_FILE_NAME)?;
+    let sources = vec![Some(cfg_path), args.cfg.clone()];
     let mut config = make_config(
         // default
         Config::default(),

iroh-p2p/src/keys.rs

@@ -115,7 +115,7 @@ impl Keychain<MemoryStorage> {
 impl Keychain<DiskStorage> {
     /// Creates a new on disk keychain, with the root defaulting to the iroh config directory
     pub async fn new() -> Result<Self> {
-        let root = iroh_config_root().ok_or_else(|| anyhow!("missing iroh configuration path"))?;
+        let root = iroh_config_root()?;
         Self::with_root(root).await
     }
 

iroh-p2p/src/main.rs

@@ -15,7 +15,8 @@ async fn main() -> anyhow::Result<()> {
     let args = Args::parse();
 
     // TODO: configurable network
-    let sources = vec![iroh_config_path(CONFIG_FILE_NAME), args.cfg.clone()];
+    let cfg_path = iroh_config_path(CONFIG_FILE_NAME)?;
+    let sources = vec![Some(cfg_path), args.cfg.clone()];
     let network_config = make_config(
         // default
         Config::default_grpc(),

iroh-store/src/config.rs

@@ -19,10 +19,11 @@ pub const ENV_PREFIX: &str = "IROH_STORE";
 
 /// the path to data directory. If arg_path is `None`, the default iroh_data_path()/store is used
 /// iroh_data_path() returns an operating system-specific directory
-/// falls back to an empty path in the unlikely scenario where iroh_data_path() is `None`
-/// likely b/c iroh is not running on a Linux/Windows/MacOS system
-pub fn config_data_path(arg_path: Option<PathBuf>) -> PathBuf {
-    arg_path.unwrap_or_else(|| iroh_data_path("store").unwrap_or_else(|| PathBuf::from("")))
+pub fn config_data_path(arg_path: Option<PathBuf>) -> Result<PathBuf> {
+    match arg_path {
+        Some(p) => Ok(p),
+        None => iroh_data_path("store"),
+    }
 }
 
 /// The configuration for the store.
@@ -141,10 +142,13 @@ mod tests {
     #[test]
     fn test_config_data_path() {
         let path = PathBuf::new().join("arg_path");
-        let path_given = config_data_path(Some(path.clone()));
+        let path_given = config_data_path(Some(path.clone())).expect("config data path error");
         assert_eq!(path_given.display().to_string(), path.display().to_string());
 
-        let no_path_given = config_data_path(None).display().to_string();
+        let no_path_given = config_data_path(None)
+            .expect("config data path error")
+            .display()
+            .to_string();
         assert!(no_path_given.ends_with("store"));
     }
 }

iroh-store/src/main.rs

@@ -15,10 +15,12 @@ async fn main() -> anyhow::Result<()> {
     let version = env!("CARGO_PKG_VERSION");
     println!("Starting iroh-store, version {version}");
 
-    let sources = vec![iroh_config_path(CONFIG_FILE_NAME), args.cfg.clone()];
+    let config_path = iroh_config_path(CONFIG_FILE_NAME)?;
+    let sources = vec![Some(config_path), args.cfg.clone()];
+    let config_data_path = config_data_path(args.path.clone())?;
     let config = make_config(
         // default
-        Config::new_grpc(config_data_path(args.path.clone())),
+        Config::new_grpc(config_data_path),
         // potential config files
         sources,
         // env var prefix for this config

iroh-util/Cargo.toml

@@ -14,7 +14,6 @@ futures = "0.3.21"
 anyhow = "1.0.57"
 toml = "0.5.9"
 serde = { version = "1.0", features = ["derive"] }
-dirs = "4.0.0"
 config = "0.13.1"
 tracing = "0.1.34"
 temp-env = "0.2.0"

iroh-util/src/lib.rs

@@ -8,7 +8,7 @@ use std::{
     },
 };
 
-use anyhow::Result;
+use anyhow::{anyhow, Result};
 use cid::{
     multihash::{Code, MultihashDigest},
     Cid,
@@ -53,15 +53,16 @@ pub async fn block_until_sigint() {
 /// | Linux    | `$XDG_CONFIG_HOME` or `$HOME`/.config/iroh | /home/alice/.config/iroh              |
 /// | macOS    | `$HOME`/Library/Application Support/iroh   | /Users/Alice/Library/Application Support/iroh |
 /// | Windows  | `{FOLDERID_RoamingAppData}`/iroh           | C:\Users\Alice\AppData\Roaming\iroh   |
-pub fn iroh_config_root() -> Option<PathBuf> {
-    let cfg = dirs_next::config_dir()?;
-    Some(cfg.join(&IROH_DIR))
+pub fn iroh_config_root() -> Result<PathBuf> {
+    let cfg = dirs_next::config_dir()
+        .ok_or_else(|| anyhow!("operating environment provides no directory for configuration"))?;
+    Ok(cfg.join(&IROH_DIR))
 }
 
 // Path that leads to a file in the iroh config directory.
-pub fn iroh_config_path(file_name: &str) -> Option<PathBuf> {
+pub fn iroh_config_path(file_name: &str) -> Result<PathBuf> {
     let path = iroh_config_root()?.join(file_name);
-    Some(path)
+    Ok(path)
 }
 
 /// Returns the path to the user's iroh data directory.
@@ -73,15 +74,17 @@ pub fn iroh_config_path(file_name: &str) -> Option<PathBuf> {
 /// | Linux    | `$XDG_DATA_HOME`/iroh or `$HOME`/.local/share/iroh | /home/alice/.local/share/iroh                 |
 /// | macOS    | `$HOME`/Library/Application Support/iroh      | /Users/Alice/Library/Application Support/iroh |
 /// | Windows  | `{FOLDERID_RoamingAppData}/iroh`              | C:\Users\Alice\AppData\Roaming\iroh           |
-pub fn iroh_data_root() -> Option<PathBuf> {
-    let path = dirs_next::data_dir()?;
-    Some(path.join(&IROH_DIR))
+pub fn iroh_data_root() -> Result<PathBuf> {
+    let path = dirs_next::data_dir().ok_or_else(|| {
+        anyhow!("operating environment provides no directory for application data")
+    })?;
+    Ok(path.join(&IROH_DIR))
 }
 
-// Path that leads to a file in the iroh data directory.
-pub fn iroh_data_path(file_name: &str) -> Option<PathBuf> {
+/// Path that leads to a file in the iroh data directory.
+pub fn iroh_data_path(file_name: &str) -> Result<PathBuf> {
     let path = iroh_data_root()?.join(file_name);
-    Some(path)
+    Ok(path)
 }
 
 /// insert a value into a `config::Map`