fix(mysql): support AnalyticDB returning version() column name in getVersion() #11555

rhydian0x · 2025-07-02T01:30:42Z

Description of change

When using Alibaba Cloud AnalyticDB for MySQL (ADS), running SELECT VERSION() AS version returns a column named version() instead of version, which causes TypeORM to throw a TypeError in MysqlQueryRunner.getVersion().

This change updates getVersion() to support both version and version() column keys, making it compatible with ADS while keeping compatibility with standard MySQL and MariaDB.

Verified locally using ADS instance, and also tested on standard MySQL.

Related issue: #11553

Pull-Request Checklist

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

🎉 Thank you for reviewing this PR!

Summary by CodeRabbit

Bug Fixes
- Improved compatibility when retrieving MySQL version information, ensuring the version is correctly detected regardless of how the database returns the version string.

…tVersion

coderabbitai · 2025-07-02T01:30:50Z

"""

Walkthrough

The getVersion method in MysqlQueryRunner was updated to support both version and version() property keys in the query result, ensuring compatibility with AnalyticDB MySQL and similar variants. The method now checks both keys and normalizes the extracted version string, without altering any public API or method signatures.

Changes

File(s)	Change Summary
src/driver/mysql/MysqlQueryRunner.ts	Modified `getVersion` to handle query results with either `version` or `version()` property keys; improved version string extraction and normalization.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant MysqlQueryRunner
    participant MySQL/ADS DB

    App->>MysqlQueryRunner: call getVersion()
    MysqlQueryRunner->>MySQL/ADS DB: SELECT VERSION()
    MySQL/ADS DB-->>MysqlQueryRunner: returns [{version: "x.y.z"}] or [{"version()": "x.y.z"}]
    MysqlQueryRunner->>MysqlQueryRunner: Extract version from 'version' or 'version()'
    MysqlQueryRunner-->>App: Return normalized version string

Assessment against linked issues

Objective	Addressed	Explanation
Support `getVersion()` parsing for both `version` and `version()` keys in AnalyticDB MySQL (#11553)	✅
Prevent TypeError when version property is missing in result (#11553)	✅
Normalize and return the version string as before (#11553)	✅

Poem

In the warren of code, a bug did appear,
"version()" or "version"?—the answer unclear!
Now rabbits can cheer, for the fix is in sight,
No more TypeErrors to give us a fright.
With paws on the keyboard and whiskers held high,
Our queries return versions—oh my!
🐇✨
"""

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-07T10_00_14_272Z-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 77a5912 and c2c7856.

📒 Files selected for processing (1)

src/driver/mysql/MysqlQueryRunner.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/driver/mysql/MysqlQueryRunner.ts

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/driver/mysql/MysqlQueryRunner.ts (1)
3373-3391: Excellent implementation with minor error handling consideration.

The changes correctly address the AnalyticDB compatibility issue by supporting both column name variants. The use of nullish coalescing operator and proper TypeScript typing is well done.

However, consider adding error handling for the edge case where both version and version() properties are undefined:
 const versionString = row.version ?? row["version()"];
+
+if (!versionString) {
+    throw new TypeORMError("Unable to determine database version: neither 'version' nor 'version()' property found in query result");
+}

 return versionString.replace(/^([\d.]+).*$/, "$1")
This would prevent a potential runtime error if the query result doesn't contain either expected property.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aebc7eb and debec7c.

📒 Files selected for processing (1)

src/driver/mysql/MysqlQueryRunner.ts (1 hunks)

…sion field in ADS typeorm#11553

rhydian0x · 2025-07-02T01:43:49Z

Hi @alumni , could you please help review this PR when you have time? Thanks!

src/driver/mysql/MysqlQueryRunner.ts

…tVersion()

rhydian0x · 2025-07-07T09:09:11Z

@alumni
Thanks! Updated the code as suggested. Please take another look when you have time 🙏

alumni · 2025-07-07T09:11:12Z

@Minglu-Huo the format check will fail if I will start the workflow :) Could you fix the formatting? Thanks :)

npm run format if your editor is not set up to use prettier.

rhydian0x · 2025-07-07T09:41:00Z

@alumni
✅ Done. I’ve run npm run format and pushed the changes.

pkg-pr-new · 2025-07-07T09:42:53Z

typeorm-sql-js-example

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

commit: c2c7856

src/driver/mysql/MysqlQueryRunner.ts

…suggestion

rhydian0x · 2025-07-07T09:59:10Z

Thanks @alumni for the feedback! I've updated the query to use lowercase version() as suggested to avoid the exception.

coveralls · 2025-07-07T10:27:13Z

coverage: 76.387%. remained the same
when pulling c2c7856 on Minglu-Huo:feat/mysql-getVersion-ads
into a4c9dd8 on typeorm:master.

alumni · 2025-07-07T10:31:38Z

Thanks for the fix 😀

gioboa

Thanks for your help @Minglu-Huo 👍

rhydian0x · 2025-07-14T03:21:11Z

@alumni
Hi, thanks for merging the PR! I was wondering when this change will be published in a release?

…e in getVersion() (typeorm#11555)

feat(mysql): support AnalyticDB returning version() column name in ge…

debec7c

…tVersion

coderabbitai bot reviewed Jul 2, 2025

View reviewed changes

feat(mysql): add error handling for getVersion() to cover missing ver…

c7a02a7

…sion field in ADS typeorm#11553

alumni changed the title ~~feat(mysql): support AnalyticDB returning version() column name in geVersion()~~ feat(mysql): support AnalyticDB returning version() column name in getVersion() Jul 3, 2025

alumni requested changes Jul 3, 2025

View reviewed changes

src/driver/mysql/MysqlQueryRunner.ts Outdated Show resolved Hide resolved

src/driver/mysql/MysqlQueryRunner.ts Outdated Show resolved Hide resolved

fire-taikonaut and others added 2 commits July 7, 2025 15:10

feat(mysql): support AnalyticDB returning version() column name in ge…

5abb8d1

…tVersion()

Merge branch 'typeorm:master' into feat/mysql-getVersion-ads

af7cc60

fix(mysql): run npm run format and pushed the changes

77a5912

alumni reviewed Jul 7, 2025

View reviewed changes

src/driver/mysql/MysqlQueryRunner.ts Outdated Show resolved Hide resolved

fix(mysql): use lowercase version() to avoid exception as per review …

c2c7856

…suggestion

alumni approved these changes Jul 7, 2025

View reviewed changes

alumni changed the title ~~feat(mysql): support AnalyticDB returning version() column name in getVersion()~~ fix(mysql): support AnalyticDB returning version() column name in getVersion() Jul 7, 2025

alumni requested a review from gioboa July 8, 2025 12:37

gioboa approved these changes Jul 8, 2025

View reviewed changes

alumni merged commit 1737e97 into typeorm:master Jul 8, 2025
58 checks passed

alumni mentioned this pull request Jul 20, 2025

Bug: getVersion() fails with AnalyticDB MySQL due to non-standard field name version() #11553

Closed

18 tasks

ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025

fix(mysql): support Alibaba AnalyticDB returning version() column nam…

07a694f

…e in getVersion() (typeorm#11555)

alumni mentioned this pull request Jan 8, 2026

fix(mysql): getVersion returning undefined for PolarDB-X 2.0 #11837

Merged

4 tasks

Uh oh!

fix(mysql): support AnalyticDB returning version() column name in getVersion() #11555

fix(mysql): support AnalyticDB returning version() column name in getVersion() #11555

Uh oh!

Conversation

rhydian0x commented Jul 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of change

Pull-Request Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

rhydian0x commented Jul 2, 2025

Uh oh!

Uh oh!

Uh oh!

rhydian0x commented Jul 7, 2025

Uh oh!

alumni commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rhydian0x commented Jul 7, 2025

Uh oh!

pkg-pr-new bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

rhydian0x commented Jul 7, 2025

Uh oh!

coveralls commented Jul 7, 2025

Uh oh!

alumni commented Jul 7, 2025

Uh oh!

gioboa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rhydian0x commented Jul 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rhydian0x commented Jul 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

alumni commented Jul 7, 2025 •

edited

Loading

pkg-pr-new bot commented Jul 7, 2025 •

edited

Loading