sink(ticdc): check virtual columns in column dispatcher (#12254) #12322
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot
added
do-not-merge/hold
|
This cherry pick PR is for a release branch and has not yet been approved by triage owners. To merge this cherry pick:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@wk989898 This PR has conflicts, I have hold it. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository. |
ti-chi-bot
bot
added
size/L
![gemini-code-assist[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the robustness of the column dispatcher by introducing explicit validation for column types. It resolves an issue where configuring the dispatcher with virtual generated columns could lead to panics. The changes ensure that the system gracefully handles invalid column configurations by returning detailed errors, thereby improving stability and preventing unexpected failures.
Highlights
- Enhanced Error Handling for Column Dispatcher: The
OffsetsByNamesfunction inTableInfonow returns an error instead of a boolean, providing more specific context for failures during column lookup. - Prevention of Virtual Column Usage: The column dispatcher explicitly checks for virtual generated columns and returns an
ErrDispatcherFailedif they are specified, preventing potential panics. - Improved Error Messages: More descriptive error messages are now provided when columns are not found or virtual generated columns are detected during event dispatching.
- Expanded Unit Tests: Unit tests have been updated and expanded to cover the new error handling for both non-existent and virtual generated columns, ensuring robustness.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request correctly identifies and handles virtual columns in the column dispatcher to prevent a panic. The changes in cdc/model/schema_storage.go and its corresponding test are well-implemented. However, the pull request contains unresolved merge conflicts in cdc/sink/dmlsink/mq/dispatcher/partition/columns.go and cdc/sink/dmlsink/mq/dispatcher/partition/columns_test.go. These are critical issues that will prevent the code from compiling and must be resolved. Additionally, the test for virtual columns in columns_test.go is broken and needs to be fixed to ensure the changes are properly validated.
| <<<<<<< HEAD | ||
| offsets, ok := row.TableInfo.OffsetsByNames(r.Columns) | ||
| if !ok { | ||
| log.Error("columns not found when dispatch event", | ||
| zap.Any("tableName", row.Table), | ||
| zap.Strings("columns", r.Columns)) | ||
| return 0, "", errors.ErrDispatcherFailed.GenWithStack( | ||
| "columns not found when dispatch event, table: %v, columns: %v", row.Table, r.Columns) | ||
| ======= | ||
| offsets, err := row.TableInfo.OffsetsByNames(r.Columns) | ||
| if err != nil { | ||
| log.Error("dispatch event failed", zap.Error(err)) | ||
| return 0, "", err | ||
| >>>>>>> 35ff0a22ec (sink(ticdc): check virtual columns in column dispatcher (#12254)) | ||
| } |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers. This will cause a compilation failure and must be resolved. The correct implementation appears to be the one that uses the error return from OffsetsByNames.
offsets, err := row.TableInfo.OffsetsByNames(r.Columns)
if err != nil {
log.Error("dispatch event failed", zap.Error(err))
return 0, "", err
}| <<<<<<< HEAD | ||
| ======= | ||
| tidbTableInfo := &timodel.TableInfo{ | ||
| ID: 100, | ||
| Name: pmodel.NewCIStr("t1"), | ||
| Columns: []*timodel.ColumnInfo{ | ||
| {ID: 1, Name: pmodel.NewCIStr("col2"), Offset: 1, FieldType: *types.NewFieldType(mysql.TypeLong)}, | ||
| {ID: 2, Name: pmodel.NewCIStr("col1"), Offset: 0, FieldType: *types.NewFieldType(mysql.TypeLong)}, | ||
| {ID: 3, Name: pmodel.NewCIStr("col3"), Offset: 2, FieldType: *types.NewFieldType(mysql.TypeLong)}, | ||
| {ID: 4, Name: pmodel.NewCIStr("col4"), Offset: 3, FieldType: *types.NewFieldType(mysql.TypeLong), GeneratedExprString: "generated"}, | ||
| }, | ||
| } | ||
| tableInfo := model.WrapTableInfo(100, "test", 33, tidbTableInfo) | ||
| >>>>>>> 35ff0a22ec (sink(ticdc): check virtual columns in column dispatcher (#12254)) |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers which will cause a compilation failure. Please resolve them. The code inside the markers seems to be an incomplete and unused attempt to set up a test table with a virtual column.
|
@ti-chi-bot: The following tests failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
2 participants
This is an automated cherry-pick of #12254
What problem does this PR solve?
Issue Number: close #12241
What is changed and how it works?
Since column values don't include virtual generated columns, we also filter the virtual generated columns in the column dispatcher.
The column dispatcher now explicitly checks for and prevents the use of virtual generated columns, returning an ErrDispatcherFailed error if such columns are specified. This prevents potential panics when configuring the dispatcher.
Check List
Tests
Questions
Will it cause performance regression or break compatibility?
Do you need to update user documentation, design documentation or monitoring documentation?
Release note