Add warning for pattern traits missing ^ or $ anchors #1141
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
gosar
commented
Mar 18, 2022
smithy-aws-protocol-tests/model/awsJson1_1/services/machinelearning.smithy
Show resolved
Hide resolved
.../src/main/java/software/amazon/smithy/model/validation/validators/PatternTraitValidator.java
Outdated
Show resolved
Hide resolved
smithy-model/src/test/resources/software/amazon/smithy/model/validation/node-validator.json
Show resolved
Hide resolved
...ources/software/amazon/smithy/model/errorfiles/validators/http-uri-conflict-validator.errors
Outdated
Show resolved
Hide resolved
...esources/software/amazon/smithy/model/errorfiles/validators/http-uri-conflict-validator.json
Outdated
Show resolved
Hide resolved
...esources/software/amazon/smithy/model/errorfiles/validators/http-uri-conflict-validator.json
Outdated
Show resolved
Hide resolved
gosar
force-pushed
the
pattern-anchor
branch
3 times, most recently
from
25766d2 to
3dd2706
Compare
mtdowling
requested changes
Mar 22, 2022
.../src/main/java/software/amazon/smithy/model/validation/validators/PatternTraitValidator.java
Outdated
Show resolved
Hide resolved
.../src/main/java/software/amazon/smithy/model/validation/validators/PatternTraitValidator.java
Outdated
Show resolved
Hide resolved
...esources/software/amazon/smithy/model/errorfiles/validators/http-uri-conflict-validator.json
Outdated
Show resolved
Hide resolved
mtdowling
reviewed
Mar 22, 2022
There was a problem hiding this comment.
It might be nice to elaborate on the warning more with why they should anchor expressions. For example:
[WARNING] ns.foo#Structure$WithoutAnchorsMember: A pattern trait is applied without a leading '^' and trailing '$', meaning only part of the string must match the regular expression. Explicitly anchoring regular expressions is preferable because it is more restrictive by default and does not require modelers to understand that Smithy patterns are not automatically anchored. | PatternTrait
The pattern trait does not implicitly add a leading ^ or trailing $ to match an entire string. If customer thinks the anchors are implicitly added they may allow more values than expected. This WARNING will help customers identify if they unintentionally forgot the anchors.
mtdowling
approved these changes
Mar 22, 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.
The pattern trait does not implicitly add a leading ^ or trailing $ to
match an entire string. If customer thinks the anchors are implicitly
added they may allow more values than expected. This WARNING will help
customers identify if they unintentionally forgot the anchors.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.