feat: Add configuration deprecation warning logs#533
Merged
Conversation
cbuto
force-pushed
the
log-deprecation-warning
branch
from
January 28, 2022 15:58
87d590f to
f438a44
Compare
jdolitsky
requested changes
Jan 28, 2022
| ChartPostFormFieldName: conf.GetString("chartpostformfieldname"), | ||
| ProvPostFormFieldName: conf.GetString("provpostformfieldname"), | ||
| ContextPath: conf.GetString("contextpath"), | ||
| LogJSON: conf.GetBool("logjson"), |
Contributor
There was a problem hiding this comment.
If LogJSON and Debug fields are no longer effective can you add a comment in ServerOptions prefixed with // Deprecated: <reason>?
Signed-off-by: Casey Buto <[email protected]>
Signed-off-by: Casey Buto <[email protected]>
cbuto
force-pushed
the
log-deprecation-warning
branch
from
January 28, 2022 16:25
7481306 to
d84441b
Compare
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
3 participants
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.
A follow up on #522 to print warnings if deprecated options are being set.
Admittedly, I haven't added unit tests around this yet as that required some refactors around how the configuration code works right now (a lot of the configuration relies on variables that aren't easily overridden). I can come back and handle that if this approach seems good!
It seemed the best way to approach this was to create the logger earlier on, though I didn't pull
DebugandLogJSONout of theServerOptionsstruct just in case for some reason these are being used by someone (seems unlikely).