-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
release-22.1: sql: do not close stmt buffer of internal executor in errCallback #80569
Conversation
Previously, we would close the stmt buffer of the internal executor in `errCallback`, "just to be safe" since it was assumed that the buffer is already closed when the callback is executed. The callback runs whenever `run()` loop of connExecutor exits with an error. However, it is possible for the following sequence of events to happen: - The new goroutine is spun up for the internal executor before any commands are pushed into the stmt buffer. - The context is canceled before the new goroutine blocks waiting for the command to execute, i.e. `run()` loop is exited before any commands are executed. - The `errCallback` with the context cancellation error is evaluated. This closes the stmt buffer. The goroutine exits. - The main goroutine tries to push some commands into the buffer only to find that it was already closed. An assertion error is returned, and a sentry event is created. I think we should just not close the stmt buffer in the `errCallback` since this was never necessary and can lead to the scenario described above where no sentry event should be emitted. Release note: None
e033156
to
04080a6
Compare
Thanks for opening a backport. Please check the backport criteria before merging:
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
Add a brief release justification to the body of your PR to justify this backport. Some other things to consider:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want to backport this to 22.1.0 or can it wait until 22.1.1?
Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: complete! 1 of 0 LGTMs obtained (waiting on @jordanlewis and @yuzefovich)
It can definitely wait - the downside of not merging this are rare cases when the user will see an internal error (instead of user-friendly "query canceled" error) and we get a sentry report. |
Backport 1/1 commits from #80070 on behalf of @yuzefovich.
/cc @cockroachdb/release
Previously, we would close the stmt buffer of the internal executor in
errCallback
, "just to be safe" since it was assumed that the buffer isalready closed when the callback is executed. The callback runs whenever
run()
loop of connExecutor exits with an error.However, it is possible for the following sequence of events to happen:
commands are pushed into the stmt buffer.
the command to execute, i.e.
run()
loop is exited before any commandsare executed.
errCallback
with the context cancellation error is evaluated.This closes the stmt buffer. The goroutine exits.
find that it was already closed. An assertion error is returned, and
a sentry event is created.
I think we should just not close the stmt buffer in the
errCallback
since this was never necessary and can lead to the scenario described
above where no sentry event should be emitted.
Fixes: #79746.
Release note: None
Release justification: low risk bug fix.