feat: error if configuration file has unknown properties #1249
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1249 +/- ##
==========================================
+ Coverage 68.31% 68.36% +0.05%
==========================================
Files 175 175
Lines 16764 16772 +8
==========================================
+ Hits 11452 11467 +15
+ Misses 4680 4675 -5
+ Partials 632 630 -2 ☔ View full report in Codecov by Sentry. |
G-Rath
force-pushed
the
config/error-on-unknown
branch
from
6307cad to
6a18784
Compare
G-Rath
force-pushed
the
config/error-on-unknown
branch
4 times, most recently
from
a601dc5 to
ed9fc4a
Compare
another-rex
approved these changes
Sep 18, 2024
G-Rath
force-pushed
the
config/error-on-unknown
branch
from
ed9fc4a to
72f897a
Compare
cuixq
approved these changes
Sep 23, 2024
another-rex
pushed a commit
that referenced
this pull request
Sep 24, 2024
This behaviour changed as a result of both #1252 (which makes `LoadPath` no longer a recognized config key) and #1249 (which causes the scanner to error when a config has an unknown key), but they didn't directly conflict with each other so got landed on `main` without this being picked up (fwiw I'm not worried about this being a reoccurring thing that's worth guarding or preventing somehow as its usually pretty rare 🤷)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently the scanner does not check if there were unrecognized properties when loading configuration files, meaning that typos can easily slip through; to help avoid this, I've modified
tryLoadConfigto return an error if there are any undecoded keys in the metadata.While this could cause existing configs to start erroring, I don't think this should be considered a breaking change as such configurations would inherently causing different behaviour than what was desired and thus be a downstream bug themselves.
This will also mean that old versions of the scanner going forward would not be compatible with configs for even newer versions of the scanner that introduce new config properties, which is could be a little annoying but I don't think outweighs the benefit of this validation especially given such configurations likewise would result in different behaviour since the old scanner version would not know what to do with the new configuration option.
Resolves #1098