fix(config): print file path on file read error (#354)

* Display file path that failed to be read * Fix some docs in the config template
iotaledger · Jun 28, 2022 · 09849bc · 09849bc
1 parent dbef5f1
commit 09849bc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/bin/inx-chronicle/config.template.toml b/bin/inx-chronicle/config.template.toml
@@ -14,7 +14,7 @@ database_name = "chronicle"
 ### API listening port. 
 port = 8042
 
-### CORS
+### CORS.
 allow_origins = "0.0.0.0"
 
 ### JsonWebToken (JWT) credentials.
@@ -44,5 +44,5 @@ sync_start_milestone = 1
 ### Bind address of the metrics server.
 address = "0.0.0.0"
 
-### Port
+### Bind port of the metrics server.
 port = 9100
diff --git a/bin/inx-chronicle/src/config.rs b/bin/inx-chronicle/src/config.rs
@@ -12,8 +12,8 @@ pub enum ConfigError {
     #[cfg(feature = "api")]
     #[error(transparent)]
     Api(#[from] crate::api::ConfigError),
-    #[error("failed to read file: {0}")]
-    FileRead(std::io::Error),
+    #[error("failed to read config at '{0}': {1}")]
+    FileRead(String, std::io::Error),
     #[error("toml deserialization failed: {0}")]
     TomlDeserialization(toml::de::Error),
 }
@@ -34,7 +34,7 @@ pub struct ChronicleConfig {
 impl ChronicleConfig {
     pub fn from_file(path: impl AsRef<Path>) -> Result<Self, ConfigError> {
         fs::read_to_string(&path)
-            .map_err(ConfigError::FileRead)
+            .map_err(|e| ConfigError::FileRead(path.as_ref().display().to_string(), e))
             .and_then(|contents| toml::from_str::<Self>(&contents).map_err(ConfigError::TomlDeserialization))
     }