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 unescape keyspace name in FindAllShardsInKeyspace #15765

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Apr 21, 2024

Description

This is needed because the input to this function comes from e.g. the vschema, where a keyspace name that contains special characters such as a dash needs to be SQL escaped with backticks.

I think that we should backport this to v19 as that's when we started making heavier use of this function via #15047 (and #15117).

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

Copy link
Contributor

vitess-bot bot commented Apr 21, 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 Apr 21, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 21, 2024
@mattlord mattlord force-pushed the findallshards_backticks branch from cce268b to f3912ce Compare April 21, 2024 02:17
@mattlord mattlord added Type: Bug Component: General Changes throughout the code base and removed NeedsWebsiteDocsUpdate What it says labels Apr 21, 2024
This is needed because the input to this function comes from
e.g. the vschema, where a keyspace name that contains special
characters such as a dash needs to be escaped with backticks.

Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the findallshards_backticks branch from f3912ce to 407c841 Compare April 21, 2024 02:23
@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work 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 Apr 21, 2024
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord marked this pull request as ready for review April 21, 2024 02:42
Copy link

codecov bot commented Apr 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.40%. Comparing base (14b36d0) to head (e9521bc).
Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #15765   +/-   ##
=======================================
  Coverage   68.39%   68.40%           
=======================================
  Files        1556     1556           
  Lines      195422   195425    +3     
=======================================
+ Hits       133666   133672    +6     
+ Misses      61756    61753    -3     

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

@GrahamCampbell
Copy link
Contributor

I believe this affects us on v19.

@mattlord mattlord added the Backport to: release-19.0 Needs to be back ported to release-19.0 label Apr 23, 2024
@mattlord mattlord merged commit 5f47800 into vitessio:main Apr 24, 2024
105 checks passed
@mattlord mattlord deleted the findallshards_backticks branch April 24, 2024 03:17
vitess-bot pushed a commit that referenced this pull request Apr 24, 2024
dbussink pushed a commit that referenced this pull request Apr 24, 2024
…pace (#15765) (#15786)

Signed-off-by: Matt Lord <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-19.0 Needs to be back ported to release-19.0 Component: General Changes throughout the code base Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: Errors encountered with database/keyspace name that contains special chars
4 participants