Skip to content

fix(mysql): set stringifyObjects implicitly #11574

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.

Sign up for GitHub

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

Jump to bottom
Merged
alumni merged 1 commit into from
Jul 20, 2025
Merged

fix(mysql): set stringifyObjects implicitly #11574

alumni merged 1 commit into from
Jul 20, 2025

Conversation

@alumni
Copy link
Collaborator

@alumni alumni commented Jul 20, 2025 •
edited
Loading

Description of change

Pass stringifyObjects: true to the mysql2 client to avoid any unexpected behavior.

It should not really affect the users though, as they should send valid data to TypeORM in most scenarios, but it can be disabled by passing stringifyObjects: false in the extra connection options if needed.

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • This pull request links relevant issues as Fixes #00000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change

Summary by CodeRabbit

  • Chores
    • Updated MySQL connection configuration to improve connection pooling and object handling. No changes to user-facing features.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 20, 2025 •
edited
Loading

Walkthrough

The update modifies the internal construction of MySQL connection options in the MysqlDriver class. It adds stringifyObjects: true and consolidates the connectionLimit property into the credentials options, removing its previous separate assignment. No public interfaces or method signatures are affected.

Changes

File(s) Change Summary
src/driver/mysql/MysqlDriver.ts Updated createConnectionOptions to add stringifyObjects: true and move connectionLimit into credentials options. Removed separate { connectionLimit: options.poolSize }.

Suggested reviewers

  • mguida22
  • gioboa

Poem

In the warren of code, a change hops through,
Stringify objects, and limits anew!
MySQL connections now neatly combined,
With options and limits perfectly aligned.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-20T11_03_43_283Z-debug-0.log

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f351757 and 8661a9a.

📒 Files selected for processing (1)
  • src/driver/mysql/MysqlDriver.ts (2 hunks)
🔇 Additional comments (2)
src/driver/mysql/MysqlDriver.ts (2)

1236-1236: LGTM! Correctly implements the implicit stringifyObjects default.

The addition of stringifyObjects: true as a default option aligns perfectly with the PR objective. The placement ensures it can be overridden via options.extra if users explicitly need to disable it.

1246-1246: LGTM! Logical consolidation of connection properties.

Moving connectionLimit into the credentials object consolidates related connection properties and reduces the number of objects in the merge chain without affecting functionality.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Jul 20, 2025

typeorm-sql-js-example

npm i https://pkg.pr.new/typeorm/typeorm@11574

commit: 8661a9a

@coveralls
Copy link

coveralls commented Jul 20, 2025

Coverage Status

coverage: 76.44%. remained the same
when pulling 8661a9a on alumni:fix/mysql-stringify-objects
into f351757 on typeorm:master.

@alumni alumni merged commit d57fe3b into typeorm:master Jul 20, 2025
85 of 86 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Aug 16, 2025
Merged
@Delta843 Delta843 mentioned this pull request Aug 30, 2025
Closed
18 tasks
@renovate renovate bot mentioned this pull request Oct 30, 2025
Open
ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
@alumni @ThbltLmr
fix(mysql): set stringifyObjects implicitly (typeorm#11574)
bd543d2
@github-actions github-actions bot mentioned this pull request Jan 3, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OSA413 OSA413 OSA413 approved these changes

@gioboa gioboa gioboa approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@alumni @coveralls @OSA413 @gioboa