Transaction Commit/Rollback returns conn's cached error, if present by brad-defined · Pull Request #1691 · go-sql-driver/mysql

brad-defined · 2025-04-01T15:24:11Z

Description

Fix #1690, if a transaction connection has a cached error, return it instead of ErrInvalidConn during Commit/Rollback operations.

Checklist

[ x] Code compiles correctly
Created tests which fail without the change (if possible) (The condition is a race which can be difficult to duplicate in tests)
[x ] All tests passing
Extended the README / documentation, if necessary
[ x] Added myself / the copyright holder to the AUTHORS file

Summary by CodeRabbit

Chores
- Updated the contributor list with a new individual and organization, ensuring the recognition remains organized.
Bug Fixes
- Improved error reporting during transactional operations to deliver clearer, more specific feedback when connection issues arise.

…sent.

coderabbitai · 2025-04-01T15:24:20Z

Walkthrough

This pull request makes two distinct updates. First, it adds two new entries to the AUTHORS file—one for the individual Brad Higgins and one for the organization Defined Networking Inc.—in alphabetical order. Second, it refines error handling in the transaction.go file by separating connection nil-checks from connection closure checks in the Commit and Rollback methods of the mysqlTx struct. When a connection is closed, the code now attempts to retrieve a specific error before defaulting to ErrInvalidConn.

Changes

File(s)	Change Summary
AUTHORS	Added individual entry "Brad Higgins " and organization "Defined Networking Inc." in alphabetical order.
transaction.go	Modified the error handling in `Commit` and `Rollback` methods of `mysqlTx`: now explicitly checks if the connection is nil and, if closed, retrieves a specific error from the connection before defaulting to `ErrInvalidConn`.

Sequence Diagram(s)

sequenceDiagram
  participant Caller
  participant mysqlTx
  participant mysqlConn

  Caller->>mysqlTx: Call Commit()/Rollback()
  alt tx.mc is nil
      mysqlTx->>Caller: return ErrInvalidConn
  else
      alt tx.mc.closed is true
          mysqlTx->>mysqlConn: Retrieve error (mc.error())
          alt error exists
              mysqlTx->>Caller: return specific error (e.g., context.Canceled)
          else
              mysqlTx->>Caller: return ErrInvalidConn
          end
      else
          mysqlTx->>Caller: proceed with transaction commit/rollback
      end
  end

Assessment against linked issues

Objective ([#1690])	Addressed	Explanation
Ensure that when a transaction’s context is canceled, operations return context.Canceled instead of ErrInvalidConn	❓	The changes retrieve an error from the connection if closed, but it is not explicit that a canceled context returns context.Canceled in all cases.

Possibly related PRs

Fix for issue #1666 #1667: Involved similar updates to the AUTHORS file, indicating a related modification in how contributors are tracked.

Suggested reviewers

methane

Poem

I'm a hopping little rabbit, full of code cheer,
Adding names to AUTHORS, making history clear.
Transactions now check errors with a careful glance,
Hunting bugs in the flow with a rhythmic, joyful dance.
With each commit I bounce, leaving no issue to chance! 🐇

📜 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 1fbafa8 and c79e885.

📒 Files selected for processing (2)

AUTHORS (2 hunks)
transaction.go (1 hunks)

🔇 Additional comments (4)

AUTHORS (2)

28-28: LGTM: Author added in alphabetical order

The addition of 'Brad Higgins' to the individual persons section follows the required format and maintains alphabetical ordering.

137-137: LGTM: Organization added in alphabetical order

The addition of 'Defined Networking Inc.' to the organizations section follows the file guidelines and maintains alphabetical ordering.

transaction.go (2)

16-25: Improved error handling for closed connections

This change enhances the error reporting by separating the nil check from the closed connection check, allowing the code to return the connection's cached error (if present) rather than the generic ErrInvalidConn. This provides more specific error information when a transaction fails, which will help with debugging.

32-41: LGTM: Consistent error handling implementation

The changes to the Rollback method mirror those in the Commit method, ensuring consistent error handling behavior across both transaction operations. This implementation correctly returns any cached connection error when available.

✨ 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.
- 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.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

coveralls · 2025-04-04T04:43:08Z

coverage: 82.782% (-0.2%) from 82.959%
when pulling c79e885 on DefinedNet:return-original-error-from-transaction
into 1fbafa8 on go-sql-driver:master.

Copilot

Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.

Files not reviewed (1)

AUTHORS: Language not supported

shogo82148

LGTM

…o-sql-driver#1691) If a transaction connection has a cached error, return it instead of ErrInvalidConn during Commit/Rollback operations. Fix go-sql-driver#1690

Transaction Commit/Rollback returns connection's cached error, if pre…

c79e885

…sent.

methane approved these changes Apr 4, 2025

View reviewed changes

methane requested a review from Copilot April 4, 2025 04:55

Copilot AI reviewed Apr 4, 2025

View reviewed changes

shogo82148 approved these changes Apr 6, 2025

View reviewed changes

methane merged commit 7da50ff into go-sql-driver:master Apr 21, 2025
38 checks passed

coderabbitai bot mentioned this pull request Jun 13, 2025

Release v1.9.3 #1724

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Transaction Commit/Rollback returns conn's cached error, if present#1691

Transaction Commit/Rollback returns conn's cached error, if present#1691
methane merged 1 commit intogo-sql-driver:masterfrom
DefinedNet:return-original-error-from-transaction

brad-defined commented Apr 1, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 1, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coveralls commented Apr 4, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

shogo82148 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

brad-defined commented Apr 1, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 1, 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

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

Uh oh!

coveralls commented Apr 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

shogo82148 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

brad-defined commented Apr 1, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)