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

Fix Grammar::substituteBindingsIntoRawSql fails during unnesting #246

Merged
merged 4 commits into from
Jan 7, 2025

Conversation

zeriyoshi
Copy link
Contributor

@zeriyoshi zeriyoshi commented Jan 6, 2025

change #226 it possible for instances of Colopl\Spanner\Query\Nested objects to be included in the bindings of Connection::getQueryLog() when using UNNEST capable methods like whereIn. However, the Grammar was not compatible with this change.

This PR fixes object handling.

Summary by CodeRabbit

  • New Features

    • Enhanced parameter handling in query methods
    • Improved support for nested data structures in database connections
  • Tests

    • Added new test for SQL binding substitution
    • Introduced constant for parameter limit testing
  • Improvements

    • Updated method signatures to support more flexible input types

Copy link

coderabbitai bot commented Jan 6, 2025

Warning

Rate limit exceeded

@zeriyoshi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 954c12e and 858e6ad.

📒 Files selected for processing (2)
  • tests/ConnectionTest.php (2 hunks)
  • tests/Query/UnnestTest.php (2 hunks)

Walkthrough

The pull request introduces changes to the UnnestTest class in the test suite and the Connection class in the source code. In the test file, a new constant SPANNER_PARAMETERS_LIMIT is added and used to generate test data. A new test method test_substituteBindingsIntoRawSql is implemented to validate SQL binding substitutions. In the Connection class, the escape method is modified to handle Nested instances, expanding its type handling capabilities.

Changes

File Change Summary
tests/Query/UnnestTest.php - Added constant SPANNER_PARAMETERS_LIMIT = 950
- Added test method test_substituteBindingsIntoRawSql() to validate SQL binding substitutions
src/Connection.php - Updated escape method to handle Nested instances
- Modified method signature to accept Nested type

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • dkkoma
  • halnique
  • Uyan712
  • t-matsuno-777

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
tests/Query/UnnestTest.php (2)

24-24: Encourage inline documentation for magic number usage

Declaring public const SPANNER_PARAMETERS_LIMIT = 950 is a welcome improvement over using a raw numeric literal. It might be helpful to add a short comment explaining why 950 is used or where it comes from, to assist future maintainers.


103-139: Expand coverage for edge cases in raw SQL substitutions

The test coverage looks good for typical scenarios. You may want to include additional edge-case checks, such as special characters or escaped quotes in the bindings, to ensure robust handling of all string values in substituted SQL statements.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c21ad52 and 161bcb2.

📒 Files selected for processing (2)
  • src/Query/Grammar.php (1 hunks)
  • tests/Query/UnnestTest.php (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run-PHPUnit
🔇 Additional comments (2)
tests/Query/UnnestTest.php (1)

70-70: Ensure compatibility with partial function usage

array_map($this->generateUuid(...), range(0, self::SPANNER_PARAMETERS_LIMIT)) leverages partial application, which requires PHP 8.0 or higher. Confirm the minimum PHP version constraint in your project to avoid potential compatibility issues.

src/Query/Grammar.php (1)

198-210: Validate typed parameters and fallback logic

The override for substituteBindingsIntoRawSql correctly converts Nested instances to arrays before delegating. Confirm that the parent method handles all other binding types as expected. Also, note that using mixed and arrow functions requires PHP 8.0 or later—verify your project's PHP version requirement.

/**
* @inheritDoc
*/
public function substituteBindingsIntoRawSql($sql, $bindings)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is the wrong place to fix this. You should fix it in Connection::escape()

public function escape($value, $binary = false)
.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, fixed it

@taka-oyama
Copy link
Collaborator

Test can be simplified to just testing the escape method.

@taka-oyama taka-oyama merged commit f9c797a into colopl:master Jan 7, 2025
1 check passed
@zeriyoshi zeriyoshi deleted the unnest_grammar branch January 7, 2025 00:30
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