Reserved word check should be post canonical conversion #2161
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
wilwade
commented
Sep 24, 2024
| @@ -35,7 +35,7 @@ pub fn convert_to_canonical(input_str: &str) -> alloc::string::String { | |||
| let white_space_stripped = strip_unicode_whitespace(input_str); | |||
| let diacriticals_stripped = strip_diacriticals(&white_space_stripped); | |||
| let confusables_removed = replace_confusables(&diacriticals_stripped); | |||
| confusables_removed.to_ascii_lowercase() | |||
| confusables_removed.to_lowercase() | |||
There was a problem hiding this comment.
Not sure why we didn't use this before, but we should have.
wilwade
commented
Sep 24, 2024
wilwade
commented
Sep 24, 2024
| )?; | ||
|
|
||
| Self::validate_canonical_handle_length(&canonical_handle_str)?; | ||
| Self::validate_canonical_handle(&canonical_handle_str)?; |
There was a problem hiding this comment.
Having more than one of these was nice, but getting confusing as we now had 3 checks to make on canonical handles
wilwade
commented
Sep 24, 2024
| @@ -668,33 +664,36 @@ pub mod pallet { | |||
| Error::<T>::InvalidHandleCharacterLength | |||
| ); | |||
|
|
|||
| ensure!(!is_reserved_handle(&base_handle_str), Error::<T>::HandleIsNotAllowed); | |||
There was a problem hiding this comment.
This is no longer a check done on the base_handle pre-canonicalization
wilwade
commented
Sep 24, 2024
| &canonical_handle_str, | ||
| ) | ||
| .is_ok(); | ||
| return Self::validate_canonical_handle(&canonical_handle_str).is_ok(); |
There was a problem hiding this comment.
Not sure why this wasn't doing all the other canonical checks, but it should have been.
wilwade
requested review from
a team,
shannonwells,
mattheworris,
enddynayn,
aramikm,
claireolmstead and
JoeCap08055
and removed request for
a team
Codecov ReportAttention: Patch coverage is
|
mattheworris
approved these changes
Sep 24, 2024
github-actions
bot
added
the
metadata-changed
JoeCap08055
reviewed
Sep 24, 2024
Comment on lines
+14
to
+27
|
|
||
| // We MUST have the RESERVED_WORDS constant as canonical. | ||
| // Cannot easily be canonicalized at compile time currently | ||
| #[test] | ||
| fn ensure_reserved_words_canonical() { | ||
| for &word in &RESERVED_WORDS { | ||
| let canonical = crate::convert_to_canonical(word); | ||
| assert_eq!( | ||
| word, canonical, | ||
| "The reserved word '{}' MUST match canonical form: '{}'", | ||
| word, canonical | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
not sure if this would be a better test or not; otherwise technically the test passes if even if convert_to_canonical is a no-op
Suggested change
| // We MUST have the RESERVED_WORDS constant as canonical. | |
| // Cannot easily be canonicalized at compile time currently | |
| #[test] | |
| fn ensure_reserved_words_canonical() { | |
| for &word in &RESERVED_WORDS { | |
| let canonical = crate::convert_to_canonical(word); | |
| assert_eq!( | |
| word, canonical, | |
| "The reserved word '{}' MUST match canonical form: '{}'", | |
| word, canonical | |
| ); | |
| } | |
| } | |
| // We MUST have the RESERVED_WORDS constant as canonical. | |
| // Cannot easily be canonicalized at compile time currently | |
| #[test] | |
| fn ensure_reserved_words_canonical() { | |
| const TEST_WORDS: [&str; 8] = | |
| ["admin", "everyone", "all", "administrator", "mod", "moderator", "here", "channel"]; | |
| for (i, &word) in TEST_WORDS.iter().enumerate() { | |
| let canonical = crate::convert_to_canonical(word); | |
| assert_eq!( | |
| RESERVED_WORDS[i], canonical, | |
| "The reserved word '{}' MUST match canonical form: '{}'", | |
| word, canonical | |
| ); | |
| } | |
| } |
There was a problem hiding this comment.
True. This is just a check to make sure that convert_to_canonical does NOT change the output of RESERVED_WORDS. Other test (`test_is_reserved_canonical_handle_happy_path) make sure that reserved words are rejected.
aramikm
approved these changes
Sep 24, 2024
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.
Goal
The goal of this PR is to make sure that reserved words cannot be used in different forms.
Closes #2147
Discussion
to_lowercaseinstead ofto_ascii_lowercasefor better handlingChecklist