modules/core/02-client/types: fix clientID validation regex to conform closer to spec #2270
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
…m closer to spec Rejects non-ASCII plus whitespaces and slashes to get it much closer to the specifications per https://github.com/cosmos/ibc/tree/main/spec/core/ics-024-host-requirements#paths-identifiers-separators while here added test vectors that were previously failing. However, we still need much better specifications for how long of values are accepted. Fixes cosmos#2269
odeke-em
requested review from
colin-axner,
AdityaSripal,
seantking and
damiannolan
as code owners
| {"with whitespace", " a-100", "tendermint", 0, false}, | ||
| {"leading hyphens", "-----a-100", "tendermint", 0, false}, | ||
| {"with slash", "tendermint/-100", "tendermint", 0, false}, | ||
| {"non-ASCII:: emoji", "🚨😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎😎-100", "tendermint", 0, false}, |
There was a problem hiding this comment.
Gotta love this test case :)
|
@colin-axner in what version do you think we should release this? And could it be back ported? |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2270 +/- ##
==========================================
- Coverage 79.52% 79.50% -0.03%
==========================================
Files 175 175
Lines 12069 12069
==========================================
- Hits 9598 9595 -3
- Misses 2047 2049 +2
- Partials 424 425 +1
|
|
@odeke-em Can you please add a changelog entry in the |
AdityaSripal
approved these changes
Sep 19, 2022
| @@ -34,7 +34,7 @@ func FormatClientIdentifier(clientType string, sequence uint64) string { | |||
|
|
|||
| // IsClientIDFormat checks if a clientID is in the format required on the SDK for | |||
| // parsing client identifiers. The client identifier must be in the form: `{client-type}-{N} | |||
| var IsClientIDFormat = regexp.MustCompile(`^.*[^\n-]-[0-9]{1,20}$`).MatchString | |||
| var IsClientIDFormat = regexp.MustCompile(`^\w+([\w-]+\w)?-[0-9]{1,20}$`).MatchString | |||
There was a problem hiding this comment.
Could you document what this regex is doing in the godocs? Thanks!
There was a problem hiding this comment.
I've updated it in the PR #2510, thank you for the request @AdityaSripal!
|
Superseded by PR #2510 which unfortunately Github closed when I tried to change base branches for. Please take a look @crodriguezvega @AdityaSripal @damiannolan at the new PR. Thank you! |
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.
Rejects non-ASCII plus whitespaces and slashes to get it much closer to the specifications per
https://github.com/cosmos/ibc/tree/main/spec/core/ics-024-host-requirements#paths-identifiers-separators
while here added test vectors that were previously failing. However, we still need much better specifications for how long of values are accepted.
Fixes #2269