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

Properly treat general tablespace names as case sensitive #13890

Closed
wants to merge 1 commit into from

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Aug 29, 2023

Description

MySQL General Tablespace names are case sensitive: https://dev.mysql.com/doc/refman/8.0/en/general-tablespaces.html

In the Vitess parser, however, we were treating them as case-insensitive. This could lead to query failures handling SQL statements containing a TABLESPACE clause in any path where we call SetUpperCase(true) on a sqlparser.TrackedBuffer such as indirectly anywhere that calls sqlparser.CanonicalString().

Note
PARTITION clauses can contain their own independent TABLESPACE definition and in that case it IS handled properly today via astPrintf formatting here:

if node.TableSpace != "" {
buf.astPrintf(node, " tablespace %#s", node.TableSpace)
}

The newly added unit test case fails on main:

go test -timeout 30s -run ^TestCanonicalOutput$ vitess.io/vitess/go/vt/sqlparser

--- FAIL: TestCanonicalOutput (0.00s)
    --- FAIL: TestCanonicalOutput/create_table_a_(v_varchar(32))_engine=InnoDB_tablespace=innodb_system (0.00s)
        /Users/matt/git/vitess/go/vt/sqlparser/tracked_buffer_test.go:287: 
            	Error Trace:	/Users/matt/git/vitess/go/vt/sqlparser/tracked_buffer_test.go:287
            	Error:      	Not equal: 
            	            	expected: "CREATE TABLE `a` (\n\t`v` varchar(32)\n) ENGINE InnoDB,\n  TABLESPACE innodb_system"
            	            	actual  : "CREATE TABLE `a` (\n\t`v` varchar(32)\n) ENGINE InnoDB,\n  TABLESPACE INNODB_SYSTEM"
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -3,2 +3,2 @@
            	            	 ) ENGINE InnoDB,
            	            	-  TABLESPACE innodb_system
            	            	+  TABLESPACE INNODB_SYSTEM
            	Test:       	TestCanonicalOutput/create_table_a_(v_varchar(32))_engine=InnoDB_tablespace=innodb_system
            	Messages:   	bad serialization
FAIL
FAIL	vitess.io/vitess/go/vt/sqlparser	0.449s
FAIL

Related Issue(s)

Checklist

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

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

vitess-bot bot commented Aug 29, 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 Aug 29, 2023
@mattlord mattlord 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 Aug 29, 2023
@mattlord mattlord requested review from vmg and shlomi-noach and removed request for vmg August 29, 2023 21:20
@mattlord mattlord marked this pull request as ready for review August 29, 2023 21:23
@shlomi-noach
Copy link
Contributor

Made redundant by #13884

@shlomi-noach shlomi-noach deleted the tablespace_ci_fix branch August 30, 2023 05:02
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: General Tablespace Names Are Not Treated As Case Sensitive
2 participants