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

Fix deadlock between health check and topology watcher #16995

Merged
merged 2 commits into from
Oct 18, 2024

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Oct 18, 2024

Description

This PR fixes the deadlock described in #16994.
The problem was that the sending on the channel loadTabletsTrigger in updateHealth was a blocking call. So, in this PR, I've changed the channel from being an unbuffered channel to a buffered channel of a single capacity. I have also updated the sending on the channel loadTabletsTrigger in updateHealth to be unblocking.

This fix has 2 advantages -

  1. It fixes the deadlock, since now updateHealth cannot block on sending on the channel. It will either succeed in sending, or just move ahead since the channel would already be full.
  2. Not super important, but still, if multiple updateHealth calls happen really quickly, we won't trigger multiple runs of loadTablet since we won't send on an already full channel.

Since this is a fix for a deadlock, it needs to be backported to all release branches since all of them have this issue.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@GuptaManan100 GuptaManan100 added Type: Bug Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 Component: VTGate Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 labels Oct 18, 2024
Copy link
Contributor

vitess-bot bot commented Oct 18, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 18, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 18, 2024
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Oct 18, 2024
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.02%. Comparing base (0fa7e58) to head (944c637).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16995      +/-   ##
==========================================
- Coverage   69.34%   67.02%   -2.32%     
==========================================
  Files        1571     1571              
  Lines      204180   251681   +47501     
==========================================
+ Hits       141582   168688   +27106     
- Misses      62598    82993   +20395     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

LGTM

@deepthi deepthi merged commit c1603c0 into vitessio:main Oct 18, 2024
107 of 114 checks passed
@deepthi deepthi deleted the deadlock-tw-hc-fix branch October 18, 2024 14:27
vitess-bot pushed a commit that referenced this pull request Oct 18, 2024
vitess-bot pushed a commit that referenced this pull request Oct 18, 2024
vitess-bot pushed a commit that referenced this pull request Oct 18, 2024
frouioui pushed a commit that referenced this pull request Oct 18, 2024
frouioui pushed a commit that referenced this pull request Oct 18, 2024
…#16995) (#17009)

Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
frouioui pushed a commit that referenced this pull request Oct 18, 2024
…#16995) (#17008)

Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
frouioui pushed a commit that referenced this pull request Oct 18, 2024
…#16995) (#17007)

Signed-off-by: Manan Gupta <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>
Co-authored-by: Manan Gupta <[email protected]>
rohit-nayak-ps pushed a commit that referenced this pull request Oct 18, 2024
…#16995) (#17010)

Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 Component: VTGate Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: Deadlock in health check and topology watcher
5 participants