services/horizon: Properly validate the history archive URLs #4152
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
Because of the way strings.Split works, the returned array will *always* have at least one element. If the string is empty, the array will be [""], so we need to check [1] == "" instead of checking the length.
sreuland
reviewed
Dec 22, 2021
| @@ -555,7 +555,7 @@ func ApplyFlags(config *Config, flags support.ConfigOptions, options ApplyOption | |||
|
|
|||
| // config.HistoryArchiveURLs contains a single empty value when empty so using | |||
| // viper.GetString is easier. | |||
| if len(config.HistoryArchiveURLs) == 0 { | |||
| if len(config.HistoryArchiveURLs) == 1 && config.HistoryArchiveURLs[0] == "" { | |||
There was a problem hiding this comment.
since it's not really a value comparison for empty string, doing len(str) == 0 can be a bit more direct, but either way appears to be convention in go.
is there a unit test that hits this?
There was a problem hiding this comment.
Yeah both length and content checks are idiomatic; I think we use == "" most of the time.
We've started work on testing CLI parameters (see #3193 and its references), but there's a lot more to be done there. In general no, we don't have unit tests for flag parsing afaik.
bartekn
approved these changes
Jan 19, 2022
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.
PR Checklist
PR Structure
otherwise).
services/friendbot, orallordocif the changes are broad or impact manypackages.
Thoroughness
.mdfiles, etc... affected by this change). Take a look in the
docsfolder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Checks that the history archive URLs contain no meaningful values.
Specifically, because of the way
strings.Splitworks, the returned array will always have at least one element. If the string is empty, the array will be[""], so we need to checkurls[1] == ""instead of checking the length.Why
Currently, the error is not clear; closes #4141.
Known limitations
n/a