Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(config): reject unknown config options outright #228

Open
mmalenic opened this issue Feb 22, 2024 · 0 comments
Open

feat(config): reject unknown config options outright #228

mmalenic opened this issue Feb 22, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mmalenic
Copy link
Member

The htsget-rs server should reject any unknown config options outright when parsing the config. Because the config can be quite complex, it's easy to mistakenly apply a config option that is unknown, where the server accepts the configuration file and just defaults any missing values. This leads to confusion when the server doesn't behave in the way that the user intended.

For example, say TLS is desired on the ticket server, the cert and key options may accidentally not be put under the ticket_server_tls table:

ticket_server_addr = "0.0.0.0:8080"
ticket_server_cors_allow_origins = "All"
cert = "cert.pem"
key = "key.pem"
data_server_addr = "0.0.0.0:8081"

This results in a ticket server that performs no TLS, where the intended config would have been:

ticket_server_addr = "0.0.0.0:8080"
ticket_server_cors_allow_origins = "All"
ticket_server_tls.cert = "cert.pem"
ticket_server_tls.key = "key.pem"
data_server_addr = "0.0.0.0:8081"
@mmalenic mmalenic added the enhancement New feature or request label Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant