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

SidecarDB: Don't ignore table charset and collation #16670

Merged
merged 5 commits into from
Sep 8, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Aug 28, 2024

Description

Any table level character set and collation changes that we wanted to make were previously ignored during tablet init. That caused issues, in particular, with Vitess clusters that have been around for some time or that had modified defaults and e.g. may then be using a mix of utf8mb3 and utf8mb4. This can then lead to a host of unexpected failures when Vitess queries these internal tables, often times joining them with MySQL system tables e.g. in information_schema. In order to ensure consistent expected behavior we should be prescriptive and explicit about the character set and collations we want/expect on the sidecar (internal vitess) tables.

This PR explicitly adds a character set for each sidecar table and modifies the settings used with schemadiff during the sidecar DB init process so that we apply any future changes to these within the code.

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

Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link
Contributor

vitess-bot bot commented Aug 28, 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 Aug 28, 2024
@mattlord mattlord removed NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Aug 28, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Aug 28, 2024
Copy link

codecov bot commented Aug 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.90%. Comparing base (a54d5ec) to head (8fb0607).
Report is 42 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16670      +/-   ##
==========================================
- Coverage   68.93%   68.90%   -0.03%     
==========================================
  Files        1562     1562              
  Lines      200767   200941     +174     
==========================================
+ Hits       138407   138468      +61     
- Misses      62360    62473     +113     

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

Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
And then ignore charset/collation when either is empty

Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: schema management schemadiff and schema changes and removed 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 labels Aug 28, 2024
@mattlord mattlord marked this pull request as ready for review August 28, 2024 15:55
@mattlord mattlord requested a review from deepthi as a code owner August 28, 2024 15:55
@mattlord mattlord requested review from shlomi-noach and rohit-nayak-ps and removed request for deepthi August 28, 2024 15:55
@@ -396,7 +396,7 @@ func (si *schemaInit) getCurrentSchema(tableName string) (string, error) {
// or an ALTER if the table exists but has a different schema.
func (si *schemaInit) findTableSchemaDiff(tableName, current, desired string) (string, error) {
hints := &schemadiff.DiffHints{
TableCharsetCollateStrategy: schemadiff.TableCharsetCollateIgnoreAlways,
TableCharsetCollateStrategy: schemadiff.TableCharsetCollateIgnoreEmpty,
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM and good catch. We might also just as well "upgrade" to TableCharsetCollateStrict - but as this works then that's fine.

@mattlord mattlord merged commit 0ccf2ce into vitessio:main Sep 8, 2024
129 of 133 checks passed
@mattlord mattlord deleted the sidecar_table_options branch September 8, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: schema management schemadiff and schema changes Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: SidecarDB init does not apply table level changes
3 participants