Chore: Update max bytes reader middleware error message #1072
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
itsmylife
commented
Sep 6, 2024
Comment on lines
+16
to
+17
| expectedBodyLength int | ||
| expectedBody string |
There was a problem hiding this comment.
Helps me to create a mental model when I read the tests
| require.Len(t, bodyBytes, tc.bodyLength) | ||
| require.Equal(t, string(bodyBytes), tc.body) | ||
| require.Len(t, bodyBytes, tc.expectedBodyLength) | ||
| require.Equal(t, tc.expectedBody, string(bodyBytes)) |
There was a problem hiding this comment.
I replaced the expected and the actual values so the failed test message can help me with what's expected and what's actual value.
itsmylife
requested review from
wbrowne,
andresmgot,
xnyo and
marefr
and removed request for
a team
marefr
approved these changes
Sep 6, 2024
| } | ||
|
|
||
| type maxBytesReader struct { | ||
| r io.ReadCloser // underlying reader | ||
| n int64 // max bytes remaining | ||
| a int64 // the actual limit |
There was a problem hiding this comment.
Nit. Naming could be improved for these fields :)
andresmgot
approved these changes
Sep 6, 2024
andresmgot
approved these changes
Sep 6, 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.
What this PR does / why we need it:
We return the remaining bytes that need to be read when we hit the limit in the error message. That is confusing and misleading. Here I am making the change to return the actual response limit value when we hit the limit.
Also, I did some small tweaks in test files to make it more understandable.