Panic when a config file is incomplete about binserve HOT 4 CLOSED

As a user I wouldn't like to have a tool rewriting my config unless I explicitly ask it to do it. I consider configs an addition to a default configuration, something that allows me to personalise the experience. I shouldn't be forced to fill all the fields of a config file. In general in config files you put only things that you want to change so if the config is a valid JSON, but empty or with some fields missing, it should be fine.

from binserve.

Thank You @danmx for raising this issue. The bug is valid but why would a user empty/break their configuration file? If the configuration file isn't valid, binserve shouldn't run but I definitely agree that it must respond with an error message rather than panicking.

I will implement a feature where it will rewrite the configuration to secure defaults when it's malformed and exit with a non-zero status code in the next release. 👍

Also, if anybody else wants to get it done sooner:

Write a default JSON schema for the configuration file and compare the input JSON if it matches the scheme or not. You can achieve this with valico.

All the configuration related functions and features are in the config.rs file.

📚 Resources:

• https://stackoverflow.com/questions/44733603/how-do-i-validate-json-using-an-existing-schema-file-in-rust
• https://github.com/serde-rs/json
• https://github.com/s-panferov/valico

from binserve.

Yeah, I agree, that seems like the ideal implementation! This would require some work but I will definitely implement this in the next release. 👍

There is a required fields option in the valico library:

"required": [ ]

I will put the required fields in that and omit the optional ones and proceed to serve. Thank You for the suggestion! ❤️👍

from binserve.

This has been fixed!

v0.2.0 Released! 🎉

from binserve.