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

Ensure hexval and int don't share BindVar after Normalization #14451

Merged
merged 2 commits into from
Nov 6, 2023

Conversation

williammartin
Copy link
Contributor

@williammartin williammartin commented Nov 3, 2023

Description

This PR relates to #14450, adding a test and attempting to resolve what appears to be an incorrect sharing of a bind var between a HexVal e.g. x'31' and an Int e.g. 31. This occurs because the type is not considered as part of the key for the BindVar map.

There was some existing code that attempted to disambiguate literal values as map keys by prefixing a single quote. Since this proved to not be correctly handling all situations, I thought it appropriate to key by the Literal itself. This ensures that a literal's Type is also considered first class in disambiguation.

I chose to use the Literal rather than *Literal because literals with the same type and value are intended to share a BindVar.

There's now slightly more data in the key since it is a struct with a Type field of size Int, but since the key previously was an arbitrary length string, the difference should be negligible. Running the benchmarks didn't seem to indicate anything of concern. I ran them using go test -bench="BenchmarkNormalize" -run="^#" ./go/vt/sqlparser/.

That said, it's totally possible (likely even) that I don't have the full picture here. I just kind of stumbled across this yesterday and have no other experience with vitess so...take it all with a grain of salt! I'm also not at all opposed to doing another approach like the existing single-quote prefix. It just seemed like more edge cases waiting to happen.

I have no opinions on backporting because I'm not an operator and don't know anything about vitess' processes.

Related Issue(s)

Fixes #14450

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

Copy link
Contributor

vitess-bot bot commented Nov 3, 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 Nov 3, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 3, 2023
There was some existing code that attempted to disambiguate literal
values as map keys by prefixing a single quote. Since this proved
to not be correctly handling all situations, we thought it appropriate
to key by the Literal itself. This ensures that a literal type is also
considered first class in disambiguation.

We chose to use the Literal rather than *Literal because literals with
the same type and value are intended to share a BindVar.

There's now slightly more data in the key since it is a struct with
a Type field of Int, but since the key previously was an arbitrary length
string, the difference should be negligble. Running the benchmarks
didn't seem to indicate anything of concern.

Signed-off-by: William Martin <[email protected]>
@arthurschreiber arthurschreiber added Component: Query Serving Backport to: release-16.0 Type: Bug 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 labels Nov 4, 2023
Copy link
Collaborator

@vmg vmg left a comment

Choose a reason for hiding this comment

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

Good catch! I think by keying on Literal we're going to lose some deduplication in some corner cases... but the previous approach just wasn't correct at all. This is a strict improvement for now.

@harshit-gangal harshit-gangal added the Benchmark me Add label to PR to run benchmarks label Nov 6, 2023
Copy link
Contributor

vitess-bot bot commented Nov 6, 2023

Hello! 👋

This Pull Request is now handled by arewefastyet. The current HEAD and future commits will be benchmarked.

You can find the performance comparison on the arewefastyet website.

@williammartin
Copy link
Contributor Author

Yeh @vmg I wondered also if that might be the case. Even then it seems like an allow list of shareable values would be a better place to start than with the default assumption that all are shareable. If you have some ideas of which values are shareable, I'd be happy to explore an implementation in another PR.

Cheers all for the quick review and making me feel valued!

arthurschreiber pushed a commit that referenced this pull request Nov 11, 2023
deepthi pushed a commit that referenced this pull request Nov 11, 2023
…ization (#14451) (#14479)

Signed-off-by: William Martin <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
harshit-gangal pushed a commit that referenced this pull request Nov 13, 2023
…ization (#14451) (#14477)

Signed-off-by: William Martin <[email protected]>
Signed-off-by: Arthur Schreiber <[email protected]>
Co-authored-by: William Martin <[email protected]>
harshit-gangal pushed a commit that referenced this pull request Nov 13, 2023
…ization (#14451) (#14478)

Signed-off-by: William Martin <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: Hexval and Int can incorrectly share BindVar after Normalization
6 participants