Stop logging EOFs and exit(1)s in ssh handler (#20476) #20529
Merged
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
Backport go-gitea#20476 The code in modules/ssh/ssh.go:sessionHandler() currently cause an error to be logged if `gitea serv` exits with a exit(1). This logging is useless because the accompanying stderr is not provided and in any case the exit(1) is most likely due to permissions errors. Further it then causes the EOF to be logged - even though this is not helpful. This PR simply checks the errors returned and stops logging them. In the case of misconfigurations causing `gitea serv` to fail with exit(1) the current logging is not helpful at determining this and users should simply review the message passed over the ssh connection. Fix go-gitea#20473 Signed-off-by: Andrew Thornton <[email protected]>
jolheiser
approved these changes
Jul 28, 2022
GiteaBot
added
the
lgtm/need 1
Gusted
reviewed
Jul 28, 2022
| } | ||
|
|
||
| if err := session.Exit(getExitStatusFromError(err)); err != nil { | ||
| if err := session.Exit(getExitStatusFromError(err)); err != nil && !errors.Is(err, io.EOF) { |
There was a problem hiding this comment.
Is using error.Is correct here? golang/go#39155 suggests that io.EOF never should be wrapped(and currently standard library shouldn't do that)
There was a problem hiding this comment.
Just because io.EOF shouldn't be wrapped does not mean that it cannot be wrapped and errors.Is will still work on it.
We don't care about io.EOF. we don't care about errors that accidentally wrap io.EOF.
Therefore we should ignore them.
Therefore errors.Is is correct
Gusted
approved these changes
Jul 28, 2022
GiteaBot
added
lgtm/done
|
🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Backport #20476
The code in modules/ssh/ssh.go:sessionHandler() currently cause an error to be
logged if
gitea servexits with a exit(1). This logging is useless because theaccompanying stderr is not provided and in any case the exit(1) is most likely due
to permissions errors.
Further it then causes the EOF to be logged - even though this is not helpful.
This PR simply checks the errors returned and stops logging them.
In the case of misconfigurations causing
gitea servto fail with exit(1)the current logging is not helpful at determining this and users should simply
review the message passed over the ssh connection.
Fix #20473
Signed-off-by: Andrew Thornton [email protected]