Skip to content
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.

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

remove unnecessary logs #1599

Merged
merged 1 commit into from
Jun 16, 2024
Merged

remove unnecessary logs #1599

merged 1 commit into from
Jun 16, 2024

Conversation

methane
Copy link
Member

@methane methane commented Jun 14, 2024

Description

Logging ErrInvalidConn when the connection already closed doesn't provide any help to users.

Additonally, database/sql now uses Validator() to check connection liveness before calling query methods.
So stop using mc.log(ErrInvalidConn) idiom.

This PR includes some cleanup and documentation relating to mc.markBadConn().

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

  • Refactor

    • Improved connection error handling to conditionally return errors, reducing unnecessary error logs.
    • Enhanced interface declarations for better type safety and functionality clarity.
  • Documentation

    • Updated comments to provide clearer guidance on handling connection errors.

This update aims to streamline error management for a more efficient and cleaner user experience.

Copy link

coderabbitai bot commented Jun 14, 2024

Walkthrough

The changes primarily involve refining the way mysqlConn handles connection errors in various methods, ensuring that driver.ErrBadConn is returned more appropriately. Additional logging has been minimized to reduce redundancy. Interface implementations for driver.SessionResetter and driver.Validator have been explicitly declared. These updates improve code clarity and error-handling efficiency.

Changes

Files Change Summaries
connection.go Refactored error handling to conditionally return driver.ErrBadConn and removed redundant logging. Declared driver.SessionResetter and driver.Validator interfaces.
errors.go Updated a comment for clarity regarding handling connection errors.
statement.go Removed redundant error logging in CheckNamedValue and query functions.

Possibly related issues

Poem

In the world of code where bytes do dance,
We tweaked our logic, seized the chance.
Connections now more wisely marked,
Errors less noisy, brightly sparked!
Interfaces set, our mission clear,
To make MySQL's path sincere. 🐇✨

Warning

Review ran into problems

Problems (1)
  • Git: Failed to clone repository. Please contact CodeRabbit support.

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>.
    • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@@ -408,7 +403,7 @@ func (mc *mysqlConn) query(query string, args []driver.Value) (*textRows, error)
var resLen int
resLen, err = handleOk.readResultSetHeaderPacket()
if err != nil {
return nil, mc.markBadConn(err)
return nil, err
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is place we shouldn't use mc.markBadConn() because we sent packet already.
Since readResultSetHeaderPacket() (and underlaying readPacket()) won't return errBadConnNoWrite, we don't have unsafe retry bug.

@methane methane requested a review from shogo82148 June 14, 2024 07:34
@coveralls
Copy link

Coverage Status

coverage: 82.507% (+0.1%) from 82.368%
when pulling 90bafd2 on methane:remove-logs
into 87443b9 on go-sql-driver:master.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 87443b9 and 90bafd2.

Files selected for processing (3)
  • connection.go (8 hunks)
  • errors.go (1 hunks)
  • statement.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • errors.go
Additional comments not posted (2)
connection.go (2)

114-120: Refactoring of markBadConn to only return driver.ErrBadConn when err is errBadConnNoWrite improves the specificity of error handling. This change should help in making the retry logic more predictable.


702-703: Explicitly implementing driver.SessionResetter and driver.Validator interfaces enhances the clarity and maintainability of the code. This is a good practice, especially for public APIs.

Copy link
Contributor

@shogo82148 shogo82148 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@methane methane merged commit 52c1917 into go-sql-driver:master Jun 16, 2024
32 checks passed
@methane methane deleted the remove-logs branch June 16, 2024 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants