api: add ineligibleTables/eligible tables info when creating/updating changefeed #3932
Conversation
ti-chi-bot
bot
added
the
release-note
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
size/M
Summary of ChangesHello @wk989898, 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 significantly improves the transparency and user experience when managing changefeeds. It introduces the capability to identify and report tables that are ineligible for replication during both creation and update operations. This is achieved by enhancing the API to return detailed table eligibility information and by integrating a verification and warning system into the CLI, allowing users to make informed decisions about replicating tables without primary keys. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds information about eligible and ineligible tables to the logs and CLI output when creating or updating a changefeed. The changes in the API handlers look good. However, I've found a critical bug in the CLI output where table counts are printed incorrectly. Additionally, there's significant code duplication between the create and update changefeed CLI commands that should be refactored.
| return err | ||
| } | ||
| cmd.Printf("Create changefeed successfully!\nID: %s\nInfo: %s\n", info.ID, infoStr) | ||
| cmd.Printf("Create changefeed successfully!\nID: %s\nInfo: %s\nIneligibleTablesCount: %d\nEligibleTablesCount: %d\n", info.ID, infoStr, tables.IneligibleTables, tables.EligibleTables) |
There was a problem hiding this comment.
The Printf call incorrectly uses tables.IneligibleTables and tables.EligibleTables with the %d format specifier. These variables are slices, not integers. To print the count of tables, you should use len().
| cmd.Printf("Create changefeed successfully!\nID: %s\nInfo: %s\nIneligibleTablesCount: %d\nEligibleTablesCount: %d\n", info.ID, infoStr, tables.IneligibleTables, tables.EligibleTables) | |
| cmd.Printf("Create changefeed successfully!\nID: %s\nInfo: %s\nIneligibleTablesCount: %d\nEligibleTablesCount: %d\n", info.ID, infoStr, len(tables.IneligibleTables), len(tables.EligibleTables)) |
| cmd.Printf("Update changefeed config successfully! "+ | ||
| "\nID: %s\nInfo: %s\n", o.changefeedID, infoStr) | ||
| "\nID: %s\nInfo: %s\nIneligibleTablesCount: %d\nEligibleTablesCount: %d\n", o.changefeedID, infoStr, tables.IneligibleTables, tables.EligibleTables) |
There was a problem hiding this comment.
The Printf call incorrectly uses tables.IneligibleTables and tables.EligibleTables with the %d format specifier. These variables are slices, not integers. To print the count of tables, you should use len().
| cmd.Printf("Update changefeed config successfully! "+ | |
| "\nID: %s\nInfo: %s\n", o.changefeedID, infoStr) | |
| "\nID: %s\nInfo: %s\nIneligibleTablesCount: %d\nEligibleTablesCount: %d\n", o.changefeedID, infoStr, tables.IneligibleTables, tables.EligibleTables) | |
| cmd.Printf("Update changefeed config successfully! "+ | |
| "\nID: %s\nInfo: %s\nIneligibleTablesCount: %d\nEligibleTablesCount: %d\n", o.changefeedID, infoStr, len(tables.IneligibleTables), len(tables.EligibleTables)) |
| verifyTableConfig := &v2.VerifyTableConfig{ | ||
| PDConfig: v2.PDConfig{ | ||
| PDAddrs: changefeedConfig.PDAddrs, | ||
| CAPath: changefeedConfig.CAPath, | ||
| CertPath: changefeedConfig.CertPath, | ||
| KeyPath: changefeedConfig.KeyPath, | ||
| CertAllowedCN: changefeedConfig.CertAllowedCN, | ||
| }, | ||
| ReplicaConfig: changefeedConfig.ReplicaConfig, | ||
| StartTs: changefeedConfig.StartTs, | ||
| SinkURI: changefeedConfig.SinkURI, | ||
| } | ||
|
|
||
| tables, err := o.apiV2Client.Changefeeds().VerifyTable(ctx, verifyTableConfig, o.keyspace) | ||
| if err != nil { | ||
| if strings.Contains(err.Error(), "ErrInvalidIgnoreEventType") { | ||
| supportedEventTypes := filter.SupportedEventTypes() | ||
| eventTypesStr := make([]string, 0, len(supportedEventTypes)) | ||
| for _, eventType := range supportedEventTypes { | ||
| eventTypesStr = append(eventTypesStr, string(eventType)) | ||
| } | ||
| cmd.Println(fmt.Sprintf("Invalid input, 'ignore-event' parameters can only accept [%s]", | ||
| strings.Join(eventTypesStr, ", "))) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| ignoreIneligibleTables := false | ||
| if len(tables.IneligibleTables) != 0 { | ||
| if putil.GetOrZero(newInfo.Config.ForceReplicate) { | ||
| cmd.Printf("[WARN] Force to replicate some ineligible tables, "+ | ||
| "these tables do not have a primary key or a not-null unique key: %#v\n"+ | ||
| "[WARN] This may cause data redundancy, "+ | ||
| "please refer to the official documentation for details.\n", | ||
| tables.IneligibleTables) | ||
| } else { | ||
| cmd.Printf("[WARN] Some tables are not eligible to replicate, "+ | ||
| "because they do not have a primary key or a not-null unique key: %#v\n", | ||
| tables.IneligibleTables) | ||
| if !o.commonChangefeedOptions.noConfirm { | ||
| ignoreIneligibleTables, err = confirmIgnoreIneligibleTables(cmd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if o.commonChangefeedOptions.noConfirm { | ||
| ignoreIneligibleTables = true | ||
| } | ||
|
|
||
| changefeedConfig.ReplicaConfig.IgnoreIneligibleTable = putil.AddressOf(ignoreIneligibleTables) |
There was a problem hiding this comment.
This block of code for verifying tables and handling ineligible tables is nearly identical to the logic in cmd/cdc/cli/cli_changefeed_create.go (lines 269-321). To improve maintainability and reduce code duplication, consider extracting this logic into a shared helper function. This function could be a method on commonChangefeedOptions or a standalone utility function.
|
@wk989898: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
| return | ||
| } | ||
|
|
||
| log.Info("Update changefeed successfully!", |
There was a problem hiding this comment.
Please also add cost time in this log.
2 participants
What problem does this PR solve?
Issue Number: ref #3888
What is changed and how it works?
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