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 panic in schema tracker in presence of keyspace routing rules #16383

Merged

Conversation

GuptaManan100
Copy link
Member

Description

This PR fixes the panic found in #16382.

This PR reproduced the panic as a unit test and then it fixes it. The problem is that we are using FindRoutedTable function to find the table which can fail to find the table if keyspace routing rules are present.

The fix is to not go through the FindRoutedTable function at all. In the updateTableInfo function, we already go over all the tables and add them to the keyspace map if the table doesn't exist when we populate the columns in setColumns.
We should use this table map directly.

The use of FindRoutedTable would be justified if we were supporting cross-keyspace foreign keys. Since we don't support them, all the foreign key references are guaranteed to be to tables that exist in the tables of the same keyspace. So it is safe to find both the table and the table it is foreign key related to in the table map that we populate right before this loop.

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

Signed-off-by: Manan Gupta <manan@planetscale.com>
…cause issues

Signed-off-by: Manan Gupta <manan@planetscale.com>
Copy link
Contributor

vitess-bot bot commented Jul 15, 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 Jul 15, 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 Jul 15, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Jul 15, 2024
@harshit-gangal
Copy link
Member

The use of FindRoutedTable would be justified if we were supporting cross-keyspace foreign keys. Since we don't support them, all the foreign key references are guaranteed to be to tables that exist in the tables of the same keyspace. So it is safe to find both the table and the table it is foreign key related to in the table map that we populate right before this loop.

I do not agree with this completely. The decision to not support cross-shard foreign key is taken at the planning level, it should not be restricted for schema tracking.

Copy link

codecov bot commented Jul 15, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 68.67%. Comparing base (fd6411d) to head (bed5869).
Report is 5 commits behind head on main.

Files Patch % Lines
go/vt/vtgate/vschema_manager.go 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16383      +/-   ##
==========================================
- Coverage   68.68%   68.67%   -0.01%     
==========================================
  Files        1548     1548              
  Lines      199063   199084      +21     
==========================================
- Hits       136721   136717       -4     
- Misses      62342    62367      +25     

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

Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
Copy link
Member Author

We're split on how to handle foreign keys for tables that have routing rules on it. We'll discuss this further and do a separate PR for the fix. For now, we're just going to fix the panic for them.

@harshit-gangal harshit-gangal merged commit 66bf89b into vitessio:main Jul 16, 2024
127 checks passed
@harshit-gangal harshit-gangal deleted the schema-tracker-routing-rules branch July 16, 2024 06:33
GuptaManan100 added a commit to planetscale/vitess that referenced this pull request Jul 16, 2024
GuptaManan100 added a commit to planetscale/vitess that referenced this pull request Jul 16, 2024
@GuptaManan100
Copy link
Member Author

i have backported the changes to v20 and v19. it is not needed in v18 because we don't set the primary key values in that release.

harshit-gangal pushed a commit that referenced this pull request Jul 17, 2024
…uting rules (#16383) (#16406)

Signed-off-by: Manan Gupta <manan@planetscale.com>
harshit-gangal pushed a commit that referenced this pull request Jul 17, 2024
…uting rules (#16383) (#16405)

Signed-off-by: Manan Gupta <manan@planetscale.com>
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Aug 7, 2024
* [release-19.0] Bump to `v19.0.5-SNAPSHOT` after the `v19.0.4` release (vitessio#15889)

Signed-off-by: Andres Taylor <andres@planetscale.com>

* [release-19.0] fix: handle info_schema routing (vitessio#15899) (vitessio#15906)

Signed-off-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Update VTAdmin build script (vitessio#15839) (vitessio#15850)

Signed-off-by: notfelineit <notfelineit@gmail.com>
Signed-off-by: <>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Frances Thai <francesthai@Francess-MacBook-Pro.local>

* [release-19.0] Update env.sh so that is does not error when running on Mac (vitessio#15835) (vitessio#15915)

Signed-off-by: bddicken <bddicken@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] fix: derived table join column expression to be part of add join predicate on rewrite (vitessio#15956) (vitessio#15960)

Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Andres Taylor <andres@planetscale.com>

* [release-19.0] fix: insert on duplicate update to add list argument in the bind variables map (vitessio#15961) (vitessio#15967)

Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>

* [release-19.0] test: Cleaner plan tests output (vitessio#15922) (vitessio#15964)

Signed-off-by: Andres Taylor <andres@planetscale.com>

* [release-19.0] connpool: Allow time out during shutdown (vitessio#15979) (vitessio#16003)

Signed-off-by: Vicent Marti <vmg@strn.cat>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] fix: remove keyspace when merging subqueries (vitessio#16019) (vitessio#16027)

Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Add DCO workflow (vitessio#16052) (vitessio#16056)

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Upgrade the Golang version to `go1.22.4` (vitessio#16061)

Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: frouioui <frouioui@users.noreply.github.com>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>

* [release-19.0] Remove DCO workaround (vitessio#16087) (vitessio#16091)

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Do not load table stats when booting `vttablet`. (vitessio#15715) (vitessio#16100)

Signed-off-by: Arthur Schreiber <arthurschreiber@github.com>
Co-authored-by: Arthur Schreiber <arthurschreiber@github.com>

* [release-19.0] Add timeout to all the contexts used for RPC calls in vtorc (vitessio#15991) (vitessio#16103)

Signed-off-by: Manan Gupta <manan@planetscale.com>

* [release-19.0] Update braces package (vitessio#16115) (vitessio#16118)

Signed-off-by: Frances Thai <notfelineit@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] fix: order by subquery planning (vitessio#16049) (vitessio#16132)

Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>

* [release-19.0] Fix `vtexplain` not handling `UNION` queries with `weight_string` results correctly. (vitessio#16129) (vitessio#16157)

Signed-off-by: Arthur Schreiber <arthurschreiber@github.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Arthur Schreiber <arthurschreiber@github.com>

* Run more test on release-19 branch (vitessio#16152)

Signed-off-by: Harshit Gangal <harshit@planetscale.com>

* [release-19.0] Fix flakiness in `vtexplain` unit test case. (vitessio#16159) (vitessio#16167)

Signed-off-by: Arthur Schreiber <arthurschreiber@github.com>
Co-authored-by: Arthur Schreiber <arthurschreiber@github.com>

* [release-19.0] Online DDL shadow table: rename referenced table name in self referencing FK (vitessio#16205) (vitessio#16207)

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Fix flaky tests that use vtcombo (vitessio#16178) (vitessio#16212)

Signed-off-by: Manan Gupta <manan@planetscale.com>
Co-authored-by: Manan Gupta <35839558+GuptaManan100@users.noreply.github.com>
Co-authored-by: Manan Gupta <manan@planetscale.com>

* [release-19.0] Handle Nullability for Columns from Outer Tables (vitessio#16174) (vitessio#16185)

Co-authored-by: Andrés Taylor <andres@planetscale.com>

* [release-19.0] VDiff CLI: Fix VDiff `show` bug (vitessio#16177) (vitessio#16198)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] VReplication Workflow: set state correctly when restarting workflow streams in the copy phase (vitessio#16217) (vitessio#16222)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>

* [release-19.0] vtctldclient: Apply (Shard | Keyspace| Table) Routing Rules commands don't work (vitessio#16096) (vitessio#16124)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>

* [release-19.0] Fix vtgate crash in group concat (vitessio#16254)

Signed-off-by: Manan Gupta <manan@planetscale.com>

* [release-19.0] Fix Incorrect Optimization with LIMIT and GROUP BY (vitessio#16263) (vitessio#16267)

Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Co-authored-by: Andres Taylor <andres@planetscale.com>

* [release-19.0] Fix the `v19.0.0` release notes and use the `vitess/lite` image for the MySQL container (vitessio#16282) (vitessio#16285)

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>

* [release-19.0] VReplication: Properly handle target shards w/o a primary in Reshard (vitessio#16283) (vitessio#16291)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>

* [release-19.0] CI: Fix for xtrabackup install failures (vitessio#16329) (vitessio#16332)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>

* [release-19.0] Upgrade the Golang version to `go1.22.5` (vitessio#16322)

Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: frouioui <frouioui@users.noreply.github.com>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>

* [release-19.0] Fix the install dependencies script in Docker (vitessio#16340) (vitessio#16346)

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] planner: Handle ORDER BY inside derived tables (vitessio#16353) (vitessio#16359)

Signed-off-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Andres Taylor <andres@planetscale.com>

* [release-19.0] Fix Join Predicate Cleanup Bug in Route Merging (vitessio#16386) (vitessio#16389)

Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>

* [release-19.0] fix issue with aggregation inside of derived tables (vitessio#16366) (vitessio#16384)

Signed-off-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Andrés Taylor <andres@planetscale.com>

* [release-19.0] Use default schema reload config values when config file is empty (vitessio#16393) (vitessio#16410)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Fix subquery planning having an aggregation that is used in order by as long as we can merge it all into a single route (vitessio#16402) (vitessio#16407)

Signed-off-by: Manan Gupta <manan@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>

* [release-19.0] Fix panic in schema tracker in presence of keyspace routing rules (vitessio#16383) (vitessio#16406)

Signed-off-by: Manan Gupta <manan@planetscale.com>

* [release-19] Vitess tester workflow (vitessio#16127) (vitessio#16418)

Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>

* [release-19.0] feat: add a LIMIT 1 on EXISTS subqueries to limit network overhead (vitessio#16153) (vitessio#16191)

Signed-off-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Andrés Taylor <andres@planetscale.com>

* [release-19.0] Code Freeze for `v19.0.5` (vitessio#16448)

Signed-off-by: Andres Taylor <andres@planetscale.com>

* [release-19.0] Release of `v19.0.5` (vitessio#16450)

Signed-off-by: Andres Taylor <andres@planetscale.com>

* Fix new test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: notfelineit <notfelineit@gmail.com>
Signed-off-by: <>
Signed-off-by: bddicken <bddicken@gmail.com>
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Signed-off-by: Vicent Marti <vmg@strn.cat>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Arthur Schreiber <arthurschreiber@github.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Frances Thai <notfelineit@gmail.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Andrés Taylor <andres@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Frances Thai <francesthai@Francess-MacBook-Pro.local>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: vitess-bot <139342327+vitess-bot@users.noreply.github.com>
Co-authored-by: frouioui <frouioui@users.noreply.github.com>
Co-authored-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Arthur Schreiber <arthurschreiber@github.com>
Co-authored-by: Manan Gupta <35839558+GuptaManan100@users.noreply.github.com>
Co-authored-by: Manan Gupta <manan@planetscale.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Florent Poinsard <35779988+frouioui@users.noreply.github.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>
venkatraju pushed a commit to slackhq/vitess that referenced this pull request Aug 29, 2024
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: Panic in vtgate schema manager because of keyspace rules
3 participants