Add error 1290/ER_READ_ONLY_MODE to rejectReadOnly handling #1660

kolbe · 2025-01-17T04:48:52Z

Description

Please explain the changes you made here.

Checklist

Code compiles correctly
Created tests which fail without the change (if possible)
All tests passing
Extended the README / documentation, if necessary
Added myself / the copyright holder to the AUTHORS file

Summary by CodeRabbit

Bug Fixes
- Enhanced error handling for read-only database connections by expanding the range of error conditions that trigger connection closure.

coderabbitai · 2025-01-17T04:49:00Z

Walkthrough

The pull request modifies the error handling logic in the handleErrorPacket method of the mysqlConn struct within the packets.go file. The change expands the error number conditions that trigger connection closure when the RejectReadOnly configuration is active. Specifically, a third error number (1836) representing "ER_READ_ONLY_MODE" is added to the existing checks, enhancing the robustness of error handling for read-only connection scenarios.

Changes

File	Change Summary
`packets.go`	Extended error handling conditions in `handleErrorPacket` method by adding error number 1836 to the existing checks for read-only transaction errors

Possibly related PRs

improve error handling in writePacket #1601: Restructuring error handling in the writePacket function
Check if MySQL supports CLIENT_CONNECT_ATTRS before sending client attributes. #1640: Enhancing error handling for MySQL connection packets

Suggested reviewers

shogo82148

Poem

🐰 In the realm of packets and code so bright,
A rabbit hops through errors with might!
One more number, three-six now in sight,
Read-only mode gets a clearer light,
Connection handling, now error-tight! 🔍

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packets.go (1)

577-578: LGTM! Good addition to handle read-only mode errors.

The addition of error code 1836 (ER_READ_ONLY_MODE) enhances the robustness of read-only error handling, particularly during failover scenarios. This complements the existing handling of ER_CANT_EXECUTE_IN_READ_ONLY_TRANSACTION (1792) and ER_OPTION_PREVENTS_STATEMENT (1290) errors.

This change improves reliability during database failovers by ensuring that connections are properly recycled when they become read-only, which is particularly important for applications using Aurora or other managed MySQL services with automatic failover capabilities.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7403860 and 5699a68.

📒 Files selected for processing (1)

packets.go (1 hunks)

methane · 2025-01-22T07:50:49Z

Would you explain when the ER_READ_ONLY_MODE is returned by MySQL/MariaDB?

kolbe · 2025-01-22T19:29:51Z

There are a number of situations where InnoDB will issue a ER_READ_ONLY_MODE error when innodb_read_only is enabled.

mysql> select @@read_only, @@innodb_read_only;
+-------------+--------------------+
| @@read_only | @@innodb_read_only |
+-------------+--------------------+
|           0 |                  1 |
+-------------+--------------------+
1 row in set (0.00 sec)

mysql> create table t2 (id int);
ERROR 1836 (HY000): Running in read-only mode

mysql> alter table t1 add column (x int);
ERROR 1836 (HY000): Running in read-only mode

storage/innobase/handler/handler0alter.cc
976:      my_error(ER_READ_ONLY_MODE, MYF(0));
10892:    my_error(ER_READ_ONLY_MODE, MYF(0));

storage/innobase/handler/ha_innodb.cc
4243:    my_error(ER_READ_ONLY_MODE, MYF(0));
4244:    return ER_READ_ONLY_MODE;
4261:    my_error(ER_READ_ONLY_MODE, MYF(0));
4262:    return ER_READ_ONLY_MODE;
4280:    my_error(ER_READ_ONLY_MODE, MYF(0));
4281:    return ER_READ_ONLY_MODE;
4311:    my_error(ER_READ_ONLY_MODE, MYF(0));
4312:    return ER_READ_ONLY_MODE;
4344:    my_error(ER_READ_ONLY_MODE, MYF(0));
4345:    return ER_READ_ONLY_MODE;
4364:    my_error(ER_READ_ONLY_MODE, MYF(0));
9287:    ib_senderrf(ha_thd(), IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);
10025:    ib_senderrf(ha_thd(), IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);
10189:    ib_senderrf(ha_thd(), IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);
16827:    ib_senderrf(thd, IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);
18933:      ib_senderrf(thd, IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);
19750:    ib_senderrf(trx->mysql_thd, IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);

storage/innobase/handler/ha_innopart.cc
2705:    ib_senderrf(thd, IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);

storage/innobase/row/row0quiesce.cc
1047:    ib_senderrf(trx->mysql_thd, IB_LOG_LEVEL_WARN, ER_READ_ONLY_MODE);

sql/dd/impl/cache/storage_adapter.cc
304:      my_error(ER_READ_ONLY_MODE, MYF(0));

methane · 2025-01-23T02:05:48Z

Is it relating to fail over?
This option is for supporting fail over.

kolbe · 2025-01-23T04:47:12Z

Yeah, we're using Aurora and we've seen some cases (not reproducible) where the server is sending ER_READ_ONLY_MODE to the client. We want to reject the read-only connection in those cases and force a reconnect to the writer endpoint.

methane · 2025-01-23T09:32:20Z

I have not checked aurora behavior. But aurora replica sets innodb_read_only=On.
So handling the error seems OK.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) | require | minor | `v1.8.1` -> `v1.9.1` | --- ### Release Notes <details> <summary>go-sql-driver/mysql (github.com/go-sql-driver/mysql)</summary> ### [`v1.9.1`](https://github.com/go-sql-driver/mysql/blob/HEAD/CHANGELOG.md#v191-2025-03-21) [Compare Source](go-sql-driver/mysql@v1.9.0...v1.9.1) ##### Major Changes - Add Charset() option. ([#1679](go-sql-driver/mysql#1679)) ##### Bugfixes - go.mod: fix go version format ([#1682](go-sql-driver/mysql#1682)) - Fix FormatDSN missing ConnectionAttributes ([#1619](go-sql-driver/mysql#1619)) ### [`v1.9.0`](https://github.com/go-sql-driver/mysql/blob/HEAD/CHANGELOG.md#v190-2025-02-18) [Compare Source](go-sql-driver/mysql@v1.8.1...v1.9.0) ##### Major Changes - Implement zlib compression. ([#1487](go-sql-driver/mysql#1487)) - Supported Go version is updated to Go 1.21+. ([#1639](go-sql-driver/mysql#1639)) - Add support for VECTOR type introduced in MySQL 9.0. ([#1609](go-sql-driver/mysql#1609)) - Config object can have custom dial function. ([#1527](go-sql-driver/mysql#1527)) ##### Bugfixes - Fix auth errors when username/password are too long. ([#1625](go-sql-driver/mysql#1625)) - Check if MySQL supports CLIENT_CONNECT_ATTRS before sending client attributes. ([#1640](go-sql-driver/mysql#1640)) - Fix auth switch request handling. ([#1666](go-sql-driver/mysql#1666)) ##### Other changes - Add "filename:line" prefix to log in go-mysql. Custom loggers now show it. ([#1589](go-sql-driver/mysql#1589)) - Improve error handling. It reduces the "busy buffer" errors. ([#1595](go-sql-driver/mysql#1595), [#1601](go-sql-driver/mysql#1601), [#1641](go-sql-driver/mysql#1641)) - Use `strconv.Atoi` to parse max_allowed_packet. ([#1661](go-sql-driver/mysql#1661)) - `rejectReadOnly` option now handles ER_READ_ONLY_MODE (1290) error too. ([#1660](go-sql-driver/mysql#1660)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "* 0-3 * * *" (UTC), Automerge - "* 0-3 * * *" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7293 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Renovate Bot <forgejo-renovate-action@forgejo.org> Co-committed-by: Renovate Bot <forgejo-renovate-action@forgejo.org>

Add error 1290/ER_READ_ONLY_MODE to rejectReadOnly handling

Loading
Loading status checks…

5699a68

kolbe marked this pull request as ready for review January 21, 2025 19:45

coderabbitai bot reviewed Jan 21, 2025

View reviewed changes

methane approved these changes Jan 23, 2025

View reviewed changes

methane merged commit 85c6311 into go-sql-driver:master Jan 23, 2025
1 check passed

This was referenced Jan 27, 2025

Fix for issue #1666 #1667

Merged

release v1.9.0 #1662

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add error 1290/ER_READ_ONLY_MODE to rejectReadOnly handling #1660

Add error 1290/ER_READ_ONLY_MODE to rejectReadOnly handling #1660

kolbe commented Jan 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 17, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

methane commented Jan 22, 2025

kolbe commented Jan 22, 2025

methane commented Jan 23, 2025

kolbe commented Jan 23, 2025

methane commented Jan 23, 2025

Add error 1290/ER_READ_ONLY_MODE to rejectReadOnly handling #1660

Add error 1290/ER_READ_ONLY_MODE to rejectReadOnly handling #1660

Conversation

kolbe commented Jan 17, 2025 • edited by coderabbitai bot Loading

Description

Checklist

Summary by CodeRabbit

coderabbitai bot commented Jan 17, 2025 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

methane commented Jan 22, 2025

kolbe commented Jan 22, 2025

methane commented Jan 23, 2025

kolbe commented Jan 23, 2025

methane commented Jan 23, 2025

kolbe commented Jan 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)