Add context to error handler's HandleError and HandlePanic
#13
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
bgentry
approved these changes
Nov 12, 2023
As I was writing the documentation for `ErrorHandler` I realized that it'd probably be desirable for its `HandleError` and `HandlePanic` functions to take a context. The user might, for example, have a logger embedded in context which they'd extract and use the log the error or panic. This could also be done with a member field on implementing struct of course, but it feels like making context available doesn't really have a downside and its presence would likely be expected by some users. Another benefit is that in case someone is doing some heavy lifting in one of these (they probably shouldn't be, but just in case), their handlers could respond to the context cancellation caused by a client `StopAndCancel` shutdown. Currently, the handlers are immune to cancellation and could conceivably cause a shutdown to be stuck.
brandur
force-pushed
the
brandur-error-handler-context
branch
from
34d4dcc
to
e2a00fc
Compare
|
Thanks! And yeah, also surprised I didn't catch this at the time. |
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.
As I was writing the documentation for
ErrorHandlerI realized thatit'd probably be desirable for its
HandleErrorandHandlePanicfunctions to take a context. The user might, for example, have a logger
embedded in context which they'd extract and use the log the error or
panic. This could also be done with a member field on implementing
struct of course, but it feels like making context available doesn't
really have a downside and its presence would likely be expected by some
users.
Another benefit is that in case someone is doing some heavy lifting in
one of these (they probably shouldn't be, but just in case), their
handlers could respond to the context cancellation caused by a client
StopAndCancelshutdown. Currently, the handlers are immune tocancellation and could conceivably cause a shutdown to be stuck.