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

VReplication: Move ENUM and SET mappings from vplayer to vstreamer #15723

Merged
merged 43 commits into from
May 9, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Apr 15, 2024

Description

This addresses the issues noted #15750. You can see how to perform a manual test there as well.

It does this by removing the existing ENUM and SET field integer to string value mapping from the vplayer (consumer — where it was relying on OnlineDDL specific code that I think can be at least partially removed after this) and moving this work to the vstreamer (producer) so that Vitess provides uniform and intuitive vstream vevent behavior for ENUM and SET fields regardless of what phase the stream or workflow may be in.

In discussing this issue with the Debezium Vitess connector community they had asked if we could add something to the stream which would indicate that they do NOT need to do the string mappings in order to make it easier for them to transition from <= v19 to v20+ of Vitess. To support this I added a new flag to the FieldEvent type which will indicate when the ENUM and SET values are already strings. We always set that in FieldEvents during the copy phase as 1) we've always provided those values as strings in the copy phase and 2) we have one field event per row event batch (vstream_packet) so that extra byte is negligible and is cheaper than always searching the columns to see if there are any SET or ENUM columns. During the running phase, however, we know when we're managing the string mappings for a table and we only set this field when the table we're streaming events for contains a SET or ENUM column.

This PR also fixes #15598 after the evalengine portion of it was fixed in #15783.

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 15, 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 15, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 15, 2024
@mattlord mattlord force-pushed the vstream_enum_strings branch 2 times, most recently from 640fec5 to 8385a0c Compare April 16, 2024 01:46
@mattlord mattlord force-pushed the vstream_enum_strings branch from 8385a0c to 2200fcc Compare April 16, 2024 01:51
@mattlord mattlord force-pushed the vstream_enum_strings branch from 6b521d4 to 0fee7d4 Compare April 16, 2024 04:14
@shlomi-noach
Copy link
Contributor

shlomi-noach commented Apr 16, 2024

Cross reference for convenience: Online DDL/VReplication test suite: support ENUM as part of PRIMARY KEY

Copy link

codecov bot commented Apr 16, 2024

Codecov Report

Attention: Patch coverage is 75.64103% with 19 lines in your changes are missing coverage. Please review.

Project coverage is 68.42%. Comparing base (4c2df48) to head (1584903).
Report is 52 commits behind head on main.

Files Patch % Lines
go/vt/vttablet/tabletserver/vstreamer/vstreamer.go 73.23% 19 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15723      +/-   ##
==========================================
- Coverage   68.44%   68.42%   -0.02%     
==========================================
  Files        1558     1559       +1     
  Lines      195822   196825    +1003     
==========================================
+ Hits       134025   134685     +660     
- Misses      61797    62140     +343     

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

@mattlord mattlord force-pushed the vstream_enum_strings branch from ee27c2a to c12a878 Compare April 16, 2024 18:33
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
And remove some noisy debug logging.
And remove any OnlineDDL changes for now. Those changes were
premature.

Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vstream_enum_strings branch from 2133974 to 1f10e2a Compare April 17, 2024 01:18
@mattlord mattlord added Component: VReplication Type: Enhancement Logical improvement (somewhere between a bug and feature) Type: Bug and removed NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 17, 2024
@mattlord mattlord force-pushed the vstream_enum_strings branch from 57932f8 to d2fed3c Compare April 18, 2024 01:05
@shlomi-noach
Copy link
Contributor

Yes, it does look to have been d2bfdae ! I reverted and pushed.

@mattlord
Copy link
Contributor Author

mattlord commented May 1, 2024

Thank you for the reviews, @shlomi-noach and @rohit-nayak-ps ! I believe that I have addressed all of your comments now.

Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

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

minor styling comment.

go/vt/vttablet/tabletserver/vstreamer/vstreamer.go Outdated Show resolved Hide resolved
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vstream_enum_strings branch from fc19138 to 02b6642 Compare May 8, 2024 02:04
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord requested a review from twthorn May 8, 2024 16:56
@mattlord mattlord removed the release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) label May 9, 2024
mattlord added 2 commits May 9, 2024 12:57
@mattlord mattlord merged commit 0353ad4 into vitessio:main May 9, 2024
96 checks passed
@mattlord mattlord deleted the vstream_enum_strings branch May 9, 2024 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VReplication Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
Status: Done
5 participants