[Java] Fix CassandraIO ReadFn to quote column names for reserved keywords #36459
Conversation
Summary of ChangesHello @Suvrat1629, 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 addresses a critical bug in the CassandraIO connector that prevented successful data reads from Cassandra tables where column names conflicted with CQL reserved keywords. By introducing a robust identifier quoting mechanism, the connector now correctly generates CQL queries, ensuring compatibility and reliable data extraction from such tables. The change significantly enhances the connector's resilience and broadens its applicability to a wider range of Cassandra schema designs. Highlights
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
|
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
|
Assigning reviewers: R: @Abacn for label java. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
|
Reminder, please take a look at this pr: @Abacn |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @kennknowles for label java. Available commands:
|
|
/gemini review |
![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 correctly addresses an issue where CassandraIO's ReadFn would fail on tables with reserved keywords as column names. The fix, which involves quoting identifiers, is sound and well-implemented. The addition of a new quoteIdentifier utility method is appropriate. I'm particularly impressed with the comprehensive set of unit and integration tests that have been added, which cover various scenarios including reserved keywords in partition keys, custom queries, and also include regression tests to ensure existing functionality remains unaffected. Overall, this is a high-quality contribution. I have one suggestion to improve the readability of one of the new tests.
| PAssert.that(output) | ||
| .satisfies( | ||
| input -> { | ||
| List<ReservedKeywordEntity> entities = new ArrayList<>(); | ||
| input.forEach(entities::add); | ||
|
|
||
| assertEquals(2, entities.size()); | ||
|
|
||
| // Check that data was read correctly | ||
| boolean foundFirst = false, foundSecond = false; | ||
| for (ReservedKeywordEntity entity : entities) { | ||
| if ("true_value_1".equals(entity.trueColumn)) { | ||
| assertEquals("key_value_1", entity.keyColumn); | ||
| assertEquals("select_value_1", entity.selectColumn); | ||
| assertEquals("normal_value_1", entity.normalColumn); | ||
| foundFirst = true; | ||
| } else if ("true_value_2".equals(entity.trueColumn)) { | ||
| assertEquals("key_value_2", entity.keyColumn); | ||
| assertEquals("select_value_2", entity.selectColumn); | ||
| assertEquals("normal_value_2", entity.normalColumn); | ||
| foundSecond = true; | ||
| } | ||
| } | ||
|
|
||
| assertTrue("Should find first test record", foundFirst); | ||
| assertTrue("Should find second test record", foundSecond); | ||
| return null; | ||
| }); |
There was a problem hiding this comment.
The assertions for this test can be simplified and made more readable by using PAssert.that(output).containsInAnyOrder(...). This avoids manual iteration and flag-checking, making the test's intent clearer and easier to maintain. Since ReservedKeywordEntity has equals and hashCode implemented, this assertion will work as expected.
ReservedKeywordEntity entity1 = new ReservedKeywordEntity();
entity1.trueColumn = "true_value_1";
entity1.keyColumn = "key_value_1";
entity1.selectColumn = "select_value_1";
entity1.normalColumn = "normal_value_1";
ReservedKeywordEntity entity2 = new ReservedKeywordEntity();
entity2.trueColumn = "true_value_2";
entity2.keyColumn = "key_value_2";
entity2.selectColumn = "select_value_2";
entity2.normalColumn = "normal_value_2";
PAssert.that(output).containsInAnyOrder(entity1, entity2);
There was a problem hiding this comment.
[nit]
Agree here that PAssert.that with containsInAnyOrder is more idomatic in this context than the satisfies clause.
You can ignore the gemini suggestion. Your PR looks good to me. I will let @Abacn do the final check. |
|
Reminder, please take a look at this pr: @kennknowles |
|
@Abacn gentle nudge please take a look. |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @Abacn for label java. Available commands:
|
|
We currently short of active CassandraIO maintainers. @VardhanThigle would you mind taking a look? |
|
Reminder, please take a look at this pr: @Abacn |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @chamikaramj for label java. Available commands:
|
|
Reminder, please take a look at this pr: @chamikaramj |
Looks Good to me, just an optional nit - as discussed on the thread with @liferoad that could be ignored as well. |
@Abacn Then I assume we are good to merge :) |
|
re-open to re-trigger tests, will merge after tests finished |
4 participants
Please add a meaningful description for your change here
Fixes #36272
CassandraIO's
ReadFnwas failing when reading from tables with reserved keyword column names (like "true", "key", "select") because column names weren't properly quoted in generated CQL queries. This fix adds proper identifier quoting with double quotes and includes comprehensive tests for reserved keyword scenarios.Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.