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.

Sign up for GitHub

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

Jump to bottom

Add cycle detection for foreign keys #14339

Merged
merged 8 commits into from
Nov 1, 2023
Merged

Add cycle detection for foreign keys #14339

merged 8 commits into from
Nov 1, 2023

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Oct 23, 2023 •
edited
Loading

Description

This PR adds cycle detection logic in foreign keys. This is required because otherwise, vtgate planning goes into an infinite loop which eventually leads to a stack smash.
So, when we augment the vschema with schema-tracking information, we also check if the foreign key constraints form a cycle or not. If they do, then we mark the keyspace as having an error. This error is then checked for in the semantic analysis phase for all keyspaces that have foreign keys managed at Vitess. We use this error to fail the query planning in vtgate.

Associated tests have also been added in this PR.

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

@GuptaManan100
feat: add cycle detection for foreign keys
dbaaa4b 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 23, 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 Oct 23, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Oct 23, 2023
@GuptaManan100
feat: mark a fk-managed keyspace with cyclic foreign keyspaces to hav…
d0225c7 
…e errors

Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
feat: make sure we fail planning for foreign keys if the keyspace has…
c7b570a 
… errors

Signed-off-by: Manan Gupta <manan@planetscale.com>
@vitess-bot vitess-bot bot mentioned this pull request Oct 26, 2023
Merged
@GuptaManan100 GuptaManan100 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving and removed NeedsWebsiteDocsUpdate What it says labels Oct 26, 2023
@GuptaManan100
test: fix test files
fe0ebf9 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request labels Oct 27, 2023
@GuptaManan100 GuptaManan100 marked this pull request as ready for review October 27, 2023 04:39
GuptaManan100
GuptaManan100 commented Oct 27, 2023
View reviewed changes
go/vt/vterrors/code.go
@@ -79,7 +79,8 @@ var (
VT09015 = errorWithoutState("VT09015", vtrpcpb.Code_FAILED_PRECONDITION, "schema tracking required", "This query cannot be planned without more information on the SQL schema. Please turn on schema tracking or add authoritative columns information to your VSchema.")
VT09016 = errorWithState("VT09016", vtrpcpb.Code_FAILED_PRECONDITION, RowIsReferenced2, "Cannot delete or update a parent row: a foreign key constraint fails", "SET DEFAULT is not supported by InnoDB")
VT09017 = errorWithoutState("VT09017", vtrpcpb.Code_FAILED_PRECONDITION, "%s", "Invalid syntax for the statement type.")
VT09018 = errorWithoutState("VT09017", vtrpcpb.Code_FAILED_PRECONDITION, "%s", "Invalid syntax for the vindex function statement.")
VT09018 = errorWithoutState("VT09018", vtrpcpb.Code_FAILED_PRECONDITION, "%s", "Invalid syntax for the vindex function statement.")
Copy link
Member Author

Choose a reason for hiding this comment

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

This is just changing the error code which i presume was a typing error since the error is called VT09018.

Copy link
Member

Choose a reason for hiding this comment

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

Thank you for finding and fixing it.

@GuptaManan100
Merge remote-tracking branch 'upstream/main' into circular-fk-prevention
ecfaaaa 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
feat: fix serializability of foreign keys
cceaa65 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
feat: create own graph implementation instead of using an external pa…
cc90201 
…ckage

Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
feat: go mod tidy
ef3ff9d 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@vitess-bot vitess-bot bot mentioned this pull request Nov 1, 2023
Closed
@GuptaManan100
Copy link
Member Author

@dbussink As discussed I have changed the PR to use an internal Graph implementation instead of relying on an external one. As an added advantage, my implementation seems faster -

pkg: vitess.io/vitess/go/vt/vtgate
                           │      old.txt      │               new.txt               │
                           │      sec/op       │      sec/op        vs base          │
FkHasCycles/Has_a_cycle-10    0.00001920n ± 2%    0.00001270n ± 2%  -33.85% (n=1000)
FkHasCycles/No_cycle-10      0.000012400n ± 2%   0.000006800n ± 4%  -45.16% (n=1000)
geomean                       0.00001543n        0.000009293n       -39.77%

@GuptaManan100 GuptaManan100 merged commit e802cff into vitessio:main Nov 1, 2023
115 checks passed
@GuptaManan100 GuptaManan100 deleted the circular-fk-prevention branch November 1, 2023 16:47
frouioui
frouioui reviewed Nov 14, 2023
View reviewed changes
go/vt/vterrors/code.go
@@ -79,7 +79,8 @@ var (
VT09015 = errorWithoutState("VT09015", vtrpcpb.Code_FAILED_PRECONDITION, "schema tracking required", "This query cannot be planned without more information on the SQL schema. Please turn on schema tracking or add authoritative columns information to your VSchema.")
VT09016 = errorWithState("VT09016", vtrpcpb.Code_FAILED_PRECONDITION, RowIsReferenced2, "Cannot delete or update a parent row: a foreign key constraint fails", "SET DEFAULT is not supported by InnoDB")
VT09017 = errorWithoutState("VT09017", vtrpcpb.Code_FAILED_PRECONDITION, "%s", "Invalid syntax for the statement type.")
VT09018 = errorWithoutState("VT09017", vtrpcpb.Code_FAILED_PRECONDITION, "%s", "Invalid syntax for the vindex function statement.")
VT09018 = errorWithoutState("VT09018", vtrpcpb.Code_FAILED_PRECONDITION, "%s", "Invalid syntax for the vindex function statement.")
VT09019 = errorWithoutState("VT09019", vtrpcpb.Code_FAILED_PRECONDITION, "%s has cyclic foreign keys", "Vitess doesn't support cyclic foreign keys.")
Copy link
Member

Choose a reason for hiding this comment

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

VT09019 has to be added to the Errors slice below in order to auto-document the errors

Copy link
Member

Choose a reason for hiding this comment

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

I will open a PR shortly to fix this.

@frouioui frouioui mentioned this pull request Nov 14, 2023
Merged
@GuptaManan100 GuptaManan100 mentioned this pull request Nov 24, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouioui frouioui frouioui left review comments

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@dbussink dbussink dbussink approved these changes

@systay systay Awaiting requested review from systay systay is a code owner

@arthurschreiber arthurschreiber Awaiting requested review from arthurschreiber arthurschreiber is a code owner

@ajm188 ajm188 Awaiting requested review from ajm188

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps

Assignees
No one assigned
Labels
Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@GuptaManan100 @dbussink @harshit-gangal @frouioui