go prefixedwriter: fix short write error case#68
Open
ChenJesse wants to merge 1 commit intosamsarahq:masterfrom
Open
go prefixedwriter: fix short write error case#68ChenJesse wants to merge 1 commit intosamsarahq:masterfrom
ChenJesse wants to merge 1 commit intosamsarahq:masterfrom
Conversation
In certain cases, formatting as JSON actually reduces the number of bytes. This leads to the bufio.Writer that wraps this returning `short write` error because the number of bytes returned is less than expected. We just want to return the original number of bytes, since we know that we are doing some string manipulation and we are OK with that. See: https://pkg.go.dev/io#Writer ``` Write writes len(p) bytes from p to the underlying data stream. It returns the number of bytes written from p (0 <= n <= len(p)) and any error encountered that caused the write to stop early. Write must return a non-nil error if it returns n < len(p). ```
Author
|
i think technically we shouldn't be modifying p, but that seems like a much larger design decision, so I would like to patch this for now |
Contributor
|
Example before/after? Or at a minimum a "how did I test this"? |
Author
|
@er9781 Added a "how did I test this" section! |
This file contains hidden or 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
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.
In certain cases, formatting as JSON actually reduces the number of bytes.
This leads to the bufio.Writer that wraps this returning
short writeerrorbecause the number of bytes returned is less than expected.
We just want to return the original number of bytes, since we know that we are
doing some string manipulation and we are OK with that.
See: https://pkg.go.dev/io#Writer
how did I test this?
I noticed that sometimes log lines would get lost. with some investigation, i realized that if taskrunner invokes
"should get here" would not be reached because we do the special json formatting which somehow truncates the number of bytes, and we were getting this
short writeerror. This was not apparent because we swallow a lot ofWrite()errors and such, but I don't want to blow up this PR scope with fixing + testing all of those.which lead me down to this investigation path.
after this fix, the log lines get printed properly.