Show toml file location in Figment errors#860
Merged
josecelano merged 2 commits intotorrust:developfrom May 14, 2024
Merged
Conversation
Before this commit we loaded configuration in Figment always using a
Toml string even if the configuration cames from a toml file. WHen there
is an error Figment does not show the file location and that's one of
the main advantages of using Figment. All errors point to the primary
source of the configuration option.
This commit fixes that problem leting Figment to load the configuration
from the file when the user provides a file.
Sample error:
```
Loading configuration from default configuration file: `./share/default/config/tracker.development.sqlite3.toml` ...
thread 'main' panicked at src/bootstrap/config.rs:45:32:
called `Result::unwrap()` on an `Err` value: ConfigError { source: LocatedError { source: Error { tag: Tag(Default, 2), profile: Some(Profile(Uncased { string: "default" })), metadata: Some(Metadata { name: "TOML file", source: Some(File("/home/developer/torrust/torrust-tracker/./share/default/config/tracker.development.sqlite3.toml")), provide_location: Some(Location { file: "packages/configuration/src/v1/mod.rs", line: 330, col: 18 }), interpolater: }), path: [], kind: Message("TOML parse error at line 2, column 15\n |\n2 | enabled = truee\n | ^\nexpected newline, `#`\n"), prev: None }, location: Location { file: "packages/configuration/src/v1/mod.rs", line: 334, col: 41 } } }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
```
Notice how the file path is included is the error: `/home/developer/torrust/torrust-tracker/./share/default/config/tracker.development.sqlite3.toml`
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #860 +/- ##
===========================================
+ Coverage 78.74% 78.82% +0.08%
===========================================
Files 169 169
Lines 9304 9325 +21
===========================================
+ Hits 7326 7350 +24
+ Misses 1978 1975 -3 ☔ View full report in Codecov by Sentry. |
Member
Author
|
ACK 4de5e7d |
josecelano
added
Code Cleanup / Refactoring
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before this PR, we loaded the configuration in Figment, always using a Toml string, even if the configuration came from a Toml file. When there is an error, Figment does not show the file location, and that's one of the main advantages of using Figment. All errors point to the primary source of the configuration option.
This commit fixes the problem of Figment not showing the file location when the user provides a file and there is an error.
Sample error:
Notice how the file path is included is the error:
/home/developer/torrust/torrust-tracker/./share/default/config/tracker.development.sqlite3.toml