Open
Conversation
The Go convention requires callers to test for io.EOF using ==, not errors.Is. Wrapping io.EOF breaks this contract and causes callers (e.g. io.Copy, bufio.Scanner) to fail to detect EOF. The errd.Wrap helper is used with defer in several methods (Conn.reader, etc.), causing io.EOF to be wrapped into errors like 'failed to get reader: EOF'. These wrapped errors no longer compare equal to io.EOF. Skip wrapping when the error is exactly io.EOF. Fixes coder#561
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.
Fixes #561
Problem
The
errd.Wraphelper wraps all non-nil errors usingfmt.Errorf("%w"). Whenio.EOFis returned (e.g. fromConn.reader), it becomes"failed to get reader: EOF". Per Go convention,io.EOFmust never be wrapped:This breaks callers like
io.Copyandbufio.Scannerthat testerr == io.EOF.Fix
Skip wrapping in
errd.Wrapwhen the error is exactlyio.EOF: