Stricter validation for required checkin API attributes #3233
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
michel-laterman
added
bug
nchaulet
approved these changes
Jan 23, 2024
jsoriano
reviewed
Jan 23, 2024
| } | ||
| if len(req.Message) == 0 { | ||
| return val, fmt.Errorf("checkin message missing") | ||
| } |
There was a problem hiding this comment.
On what cases these fields were empty? Is it possible that we are breaking checkin in some case?
There was a problem hiding this comment.
@cmacknz, would the agent ever try to check in with an empty message?
There was a problem hiding this comment.
It shouldn't, but if there were a bug that caused this, would it be better to accept the checkin instead of marking the agent offline and updating the component information?
There was a problem hiding this comment.
I've changed this to log a warning instead
|
buildkite test this |
|
50.0% Coverage on New Code
0.0% Duplication on New Code
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.
What is the problem this PR solves?
Checkin endpoint does not check for required attributes
How does this PR solve the problem?
Add validation to make sure that status and message are present in the checkin request body.
Design Checklist
I have or intend to scale test my changes, ensuring it will work reliably with 100K+ agents connected.I have included fail safe mechanisms to limit the load on fleet-server: rate limiting, circuit breakers, caching, load shedding, etc.Checklist
I have made corresponding changes to the documentationI have made corresponding change to the default configuration files./changelog/fragmentsusing the changelog toolRelated issues