feat: validate commit SHAs #231
Merged
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
This was motivated by the fact that api returns 404 if your label-analysis request doesn't include a `base_commit` or a `head_commit`. I don't mean the key must be there, the value needs to be an accurate value, or it will return a puzzling 404 "Not Found". That is terrible user experience, and even I needed quite some time to figure it out. So the best thing (I think) is cutting the evil in its root and making sure the user gives us a valid SHA. These changes introduce `validate_commit_sha` to `static-analysis` and `label-analysis` commands. They make sure the user gives us a string that is 40 chars long and consists of only letters and numbers. So should at least look like a SHA1 string.
Codecov Report
@@ Coverage Diff @@
## master #231 +/- ##
==========================================
+ Coverage 95.18% 95.20% +0.02%
==========================================
Files 73 74 +1
Lines 2573 2585 +12
==========================================
+ Hits 2449 2461 +12
Misses 124 124
Flags with carried forward coverage won't be shown. Click here to find out more.
|
dana-yaish
approved these changes
Aug 14, 2023
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.
This was motivated by the fact that api returns 404 if your label-analysis request
doesn't include a
base_commitor ahead_commit. I don't mean the key must be there,the value needs to be an accurate value, or it will return a puzzling 404 "Not Found".
That is terrible user experience, and even I needed quite some time to figure it out.
So the best thing (I think) is cutting the evil in its root and making sure the user
gives us a valid SHA.
These changes introduce
validate_commit_shatostatic-analysisandlabel-analysiscommands.They make sure the user gives us a string that is 40 chars long and consists of only letters and
numbers. So should at least look like a SHA1 string.