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 RegisterNotifier to use a copy of the tables to prevent data races #14716

Merged

Conversation

GuptaManan100
Copy link
Member

Description

This PR fixes the bug reported in #14715

It was noticed that in RegisterNotifier we don't make a copy of the tables map before sending it to the notifier function.

This can cause a data race since the same table is copied over into the queryEngine which tries to read it, while the next reload of schema in the schema engine would try to overwrite it.

The fix is straightforward. We already make a copy of the map in broadcast. We should do the same in RegisterNotifier.

A test to make sure that altering the table in schema.Engine doesn't impact the notifiers has also been added.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Dec 7, 2023

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 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 Dec 7, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 7, 2023
@systay systay 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 labels Dec 7, 2023
@GuptaManan100 GuptaManan100 merged commit 5c2273a into vitessio:main Dec 7, 2023
116 checks passed
@GuptaManan100 GuptaManan100 deleted the engine-register-notifier-fix branch December 7, 2023 16:51
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
@arthurschreiber
Copy link
Contributor

@GuptaManan100 Can this be backported into v18? We just encountered this crash on v17 and looking into the code for v18 it looks like it's vulnerable to the same race condition.

@GuptaManan100
Copy link
Member Author

@arthurschreiber Here is the PR - #16490

GuptaManan100 added a commit that referenced this pull request Jul 29, 2024
andyedison pushed a commit to github/vitess-gh that referenced this pull request Jul 29, 2024
…rNotifier to use a copy of the tables to prevent data races (vitessio#3900)

* backport of 3891

* feat: fix build issues

Signed-off-by: Manan Gupta <[email protected]>

---------

Signed-off-by: Manan Gupta <[email protected]>
Co-authored-by: Manan Gupta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: Data race in writing to schema engine table
5 participants