fix: fix mysql2 invalid configuration option poolWaitTimeout

[ShadyZOZ]

Unpicked options will become mysqlOptions and pass to mysql2, mean while mysql2 will console.error a message, causing egg fail to start.

Summary by CodeRabbit

• New Features
  • Enhanced configurability of the RDSClient by adding a poolWaitTimeout option for improved connection management.

[coderabbitai]

Walkthrough

The changes involve the RDSClient class in src/client.ts, specifically updating the constructor to include a new poolWaitTimeout property in the destructured options. This modification allows users to customize the connection pool wait timeout, enhancing the configurability of the RDSClient.

Changes

Files	Change Summary
src/client.ts	Updated RDSClient constructor to include poolWaitTimeout in destructured options.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RDSClient
    User->>RDSClient: Initialize with options
    RDSClient->>RDSClient: Destructure options
    RDSClient->>RDSClient: Set #poolWaitTimeout

Loading

Poem

In the meadow where I play,
A change has come to brighten the day.
With a timeout for my pool,
Connection waits, oh so cool!
Hops of joy, I leap and sway,
Thank you, dear coder, hooray! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.

[killagu]

LGTM

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

src/client.ts (1)

Line range hint 70-86: Constructor changes are well-implemented with a minor suggestion.

The addition of poolWaitTimeout to the destructured options is correctly implemented, and the default value handling is appropriate. This change should effectively resolve the configuration issue with mysql2.

Suggestion:
Consider adding a comment explaining the default value for poolWaitTimeout to improve code readability and maintainability.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b359064 and fb8e194.

Files selected for processing (1)

• src/client.ts (2 hunks)

Additional comments not posted (3)

src/client.ts (3)

Line range hint 98-118: Query method handles connections effectively.

The method correctly manages database connections and transaction contexts, ensuring that connections are released appropriately. This is crucial for preventing connection leaks and maintaining database performance.

---

Line range hint 149-165: Robust implementation of connection timeout handling.

The getConnectionWithTimeout method effectively uses Promise.race to handle connection timeouts, ensuring that the system can gracefully handle situations where the database is unresponsive. This addition enhances the robustness of the connection management.

---

Line range hint 183-262: Transaction management methods are well-structured and robust.

The beginTransactionScope and beginDoomedTransactionScope methods effectively manage transaction scopes, handling nesting and rollback scenarios appropriately. These methods are crucial for ensuring data consistency and handling errors gracefully.