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

Handle single sharded keyspaces for analysis #16068

Conversation

dbussink
Copy link
Contributor

@dbussink dbussink commented Jun 5, 2024

This fixes the problem where we would throw an error for a query on a single unsharded keyspace, even though the limitation only exists for sharded queries.

The issue here was that the previous singleUnshardedKeyspace field was really the field indicating if we could short circuit analysis. schemadiff doesn't want to short cut full analysis though, since it does want to know table & column dependencies etc. which would not be computed if analysis can be shortcutted.

Since the singleUnshardedKeyspace field was overloaded and really was "can we shortcut" (either because of being in a single sharded keyspace or because of non-strict analysis being requested), we couldn't use that field as a fix to guard the error thrown.

Instead, we now have a proper explicit field canShortcut that we use to handle existing shortcut logic.

singleUnshardedKeyspace still exists, but now means what it actually implies, which is if this query runs against a single unsharded keyspace, irrespective of whether we can shortcut or not and is correctly set when doing full analysis.

With those changes, we can use singleUnshardedKeyspace to guard the error throw for unsupported sharded queries and schemadiff works properly as well.

Related Issue(s)

Fixes #16067

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

Copy link
Contributor

vitess-bot bot commented Jun 5, 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 Jun 5, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Jun 5, 2024
@@ -1050,7 +1060,7 @@ func TestSchemaDiff(t *testing.T) {
return
}
if tc.conflictingDiffs > 0 {
assert.Error(t, err)
require.Error(t, err)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed this, since without this we'd segfault on checks after this if we have no error at all.

@dbussink dbussink added Type: Bug Component: Query Serving and 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 Jun 5, 2024
@shlomi-noach shlomi-noach added 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 and 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 Jun 5, 2024
Copy link
Collaborator

@systay systay left a comment

Choose a reason for hiding this comment

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

LGTM

This fixes the problem where we would throw an error for a query on a
single unsharded keyspace, even though the limitation only exists for
sharded queries.

The issue here was that the previous `singleUnshardedKeyspace` field was
really the field indicating if we could short circuit analysis.
`schemadiff` doesn't want to short cut full analysis though, since it
does want to know table & column dependencies etc. which would not be
computed if analysis can be shortcutted.

Since the `singleUnshardedKeyspace` field was overloaded and really was
"can we shortcut" (either because of being in a single sharded keyspace
or because of non-strict analysis being requested), we couldn't use that
field as a fix to guard the error thrown.

Instead, we now have a proper explicit field `canShortcut` that we use
to handle existing shortcut logic.

`singleUnshardedKeyspace` still exists, but now means what it actually
implies, which is if this query runs against a single unsharded
keyspace, irrespective of whether we can shortcut or not and is
correctly set when doing full analysis.

With those changes, we can use `singleUnshardedKeyspace` to guard the
error throw for unsupported sharded queries and `schemadiff` works
properly as well.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink dbussink force-pushed the dbussink/fix-single-unsharded-keyspace-semantic-analysis branch from 3926bec to fc286e9 Compare June 5, 2024 08:23
Copy link

codecov bot commented Jun 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.21%. Comparing base (2df3545) to head (fc286e9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #16068   +/-   ##
=======================================
  Coverage   68.21%   68.21%           
=======================================
  Files        1541     1541           
  Lines      197330   197332    +2     
=======================================
+ Hits       134599   134604    +5     
+ Misses      62731    62728    -3     

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

@shlomi-noach shlomi-noach merged commit 6def783 into vitessio:main Jun 5, 2024
94 checks passed
@shlomi-noach shlomi-noach deleted the dbussink/fix-single-unsharded-keyspace-semantic-analysis branch June 5, 2024 09:08
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: Strict semantic analysis does not handle unsharded queries correctly
3 participants