Skip to content

Allow SpannerIO.readChangeStream() to query & union a list of change stream TVF's#38167

Open
tianz101 wants to merge 1 commit intoapache:masterfrom
tianz101:2.71-tvfs
Open

Allow SpannerIO.readChangeStream() to query & union a list of change stream TVF's#38167
tianz101 wants to merge 1 commit intoapache:masterfrom
tianz101:2.71-tvfs

Conversation

@tianz101
Copy link
Copy Markdown
Contributor

Please add a meaningful description for your change here


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 introduces functionality to allow SpannerIO to query and union multiple change stream TVFs. This change involves updating the partition metadata model to track TVF names, modifying the data access layer to handle composed partition tokens, and updating the SpannerIO read pipeline to support these new configurations. Additionally, necessary dependency updates were made to support the latest Spanner libraries.

Highlights

  • SpannerIO Change Stream TVF Support: Added support for querying and unioning a list of change stream Table-Valued Functions (TVFs) in SpannerIO.readChangeStream().
  • Partition Metadata Updates: Updated partition metadata to include TVF names, ensuring correct tracking and querying of partitions across multiple TVFs.
  • Dependency Management: Added google-cloud-spanner-bom to the project dependencies and updated the Gradle configuration to manage Spanner-related libraries.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

Footnotes

  1. 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.

@jiangzzhu
Copy link
Copy Markdown
Contributor

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces support for querying multiple Table Valued Functions (TVFs) within Spanner change streams, specifically for the MUTABLE_KEY_RANGE partition mode. Key changes include updating SpannerIO to accept a list of TVF names, modifying PartitionMetadata to store TVF associations, and adjusting the DAO and action layers to handle composed partition tokens that include TVF names. Review feedback focuses on critical security concerns regarding SQL injection risks when concatenating TVF names into queries and suggests using parameterized queries or more robust identifier escaping mechanisms.

Comment on lines +137 to +139
public static String escapeTvfName(String tvfName) {
return tvfName.replace("'", "").replace("\"", "");
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The escapeTvfName method is destructive as it removes all single and double quotes from the TVF name. This will cause validation and queries to fail if a TVF name legitimately contains these characters (e.g., delimited identifiers in Spanner). Instead of removing these characters, the code should handle them by using proper quoting when the name is used in SQL queries. Additionally, this simple replacement is not a robust way to prevent SQL injection.

@github-actions
Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants