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

release-22.1: sql: do not close stmt buffer of internal executor in errCallback #80569

Merged
merged 1 commit into from
Apr 27, 2022

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Apr 26, 2022

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 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.

Fixes: #79746.

Release note: None


Release justification: low risk bug fix.

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
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-22.1-80070 branch from e033156 to 04080a6 Compare April 26, 2022 18:05
@blathers-crl
Copy link
Author

blathers-crl bot commented Apr 26, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Apr 26, 2022
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Contributor

@cucaroach cucaroach left a comment

Choose a reason for hiding this comment

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

:lgtm:

Copy link
Collaborator

@mgartner mgartner left a 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: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @jordanlewis and @yuzefovich)

@yuzefovich
Copy link
Member

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.

@yuzefovich yuzefovich merged commit 3491e61 into release-22.1 Apr 27, 2022
@yuzefovich yuzefovich deleted the blathers/backport-release-22.1-80070 branch April 27, 2022 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants