Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrap EOF error instead of replacing it #777

Conversation

jhump
Copy link
Member

@jhump jhump commented Sep 17, 2024

This achieves the same result as #776, except it does so by wrapping the error instead of replacing it.

If this looks good, I'll merge it into #776 and then merge that PR to main. If this does not look good, I'll close it without merging and then merge #776 to main as-is.

Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
// an abnormal end of the operation.
func wrapIfEOF(err error) error {
if errors.Is(err, io.EOF) {
return &unexpectedEOFError{err}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this needs to be a custom error. NewError(CodeUnavailable, err) seems fine.

Copy link
Member Author

@jhump jhump Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, that doesn't work at all. In fact, that's what the code already does. If you leave that wrapping in place and remove this one, the tests (added in #776) will fail with a mix of "unimplemented" and "unknown" error codes, instead of "unavailable".

I wrote long-ish comments trying to explain why this is needed. Were they unclear?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I meant to translate the error but still wrap as a connect-go:

NewError(CodeUnavailable, io.ErrUnexpectedEOF)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, that's basically what the other PR did -- it replaced the error instead of wrapping it.

I also now realize that this PR that "wraps" isn't really wrapping it, at least not properly since it doesn't provide an Unwrap() error method. And adding such a method causes the tests to fail... So I'll just stick with what was in #776.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, but for consistency with the other error handlers the wrap was meant purely to wrap it in a connect error code. All the other wrap... functions call NewError so this should wrap in one too. It avoids other wrappers looking at it as each one checks if its already wrapped before processing. It has nothing to do with the Unwrap() error interface (I mean NewError does implement it but thats not the point). My comments were only to enforce the consistency of the current error handling.

@jhump jhump closed this Sep 17, 2024
@jhump jhump deleted the jh/wrap-instead-of-replace branch September 17, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants