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

release v1.9.0 #1662

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

release v1.9.0 #1662

wants to merge 2 commits into from

Conversation

methane
Copy link
Member

@methane methane commented Jan 22, 2025

Description

Update changelog.

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

  • New Features

    • Added zlib compression support
    • Enhanced config object with custom dial function
    • Added support for VECTOR type in MySQL 9.0
  • Bug Fixes

    • Resolved authentication errors with long usernames and passwords
    • Fixed client attribute transmission for MySQL versions
    • Improved error handling to reduce "busy buffer" errors
  • Improvements

    • Updated supported Go version to 1.21+
    • Enhanced logging with "filename:line" prefix
    • Improved max_allowed_packet parsing
    • Enhanced handling of the ER_READ_ONLY_MODE (1290) error

Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

This pull request updates the CHANGELOG.md for version v1.9.0, documenting significant improvements to the MySQL driver. The changes include adding zlib compression support, updating the Go version compatibility to 1.21+, introducing MySQL 9.0 VECTOR type support, and enhancing configuration and error handling capabilities. The changelog highlights improvements in logging, client attribute handling, and resolving authentication and buffer-related issues.

Changes

File Change Summary
CHANGELOG.md Added version v1.9.0 with comprehensive updates including:
- Zlib compression implementation
- Go version support update to 1.21+
- MySQL 9.0 VECTOR type support
- Custom dial function for config object
- Authentication and client attribute improvements
- Enhanced logging with "filename:line" prefix
- Improved error handling

Possibly related PRs

Suggested reviewers

  • shogo82148

Poem

🐰 A MySQL driver's tale unfolds,
With version nine, our code takes hold!
Zlib compression, logging bright,
Go 1.21 shines its light.
Vectors dance, errors take flight! 🚀


📜 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 01b24d6 and 92fc991.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: test (macos-latest, 1.23, mariadb-10.5)
  • GitHub Check: test (macos-latest, 1.23, mariadb-10.6)
  • GitHub Check: test (macos-latest, 1.23, mariadb-10.11)
  • GitHub Check: test (macos-latest, 1.23, mariadb-11.2)
  • GitHub Check: test (macos-latest, 1.23, 9.0)
  • GitHub Check: test (ubuntu-latest, 1.23, mariadb-10.11)
  • GitHub Check: test (ubuntu-latest, 1.23, mariadb-11.1)
  • GitHub Check: test (ubuntu-latest, 1.23, mariadb-11.2)
  • GitHub Check: test (ubuntu-latest, 1.23, 5.7)
  • GitHub Check: test (ubuntu-latest, 1.23, 9.0)
🔇 Additional comments (5)
CHANGELOG.md (5)

3-3: Update the release date placeholder.

The version header contains a placeholder (XX) for the day. Please update it with the actual release date before merging.


14-15: LGTM! Well-documented security and compatibility fixes.

The bugfixes properly address authentication issues and client attribute compatibility.


1-22: LGTM! Well-structured changelog entry.

The changelog entry follows the established format, properly categorizes changes, and includes PR references for all changes.


8-8: Verify Go version compatibility statement.

The change to Go 1.21+ is a breaking change. Let's verify this is reflected in other project files.

✅ Verification successful

Go version compatibility is consistently documented

The Go 1.21+ requirement is properly reflected across the codebase:

  • go.mod: Explicitly sets Go 1.21
  • README.md: Documents Go 1.21+ requirement and versioning policy
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if Go version requirement is consistently documented
echo "Checking go.mod for Go version:"
cat go.mod | grep -i "go 1."

echo -e "\nChecking README.md for Go version requirements:"
rg -i "go 1\.21" README.md

Length of output: 319


20-20: Verify the impact of error handling improvements.

The changes claim to reduce "busy buffer" errors. Let's verify the actual improvements across PRs #1595, #1601, and #1641.

✅ Verification successful

Error handling improvements verified across PRs

The changes effectively reduce "busy buffer" errors through:

  • Better connection lifecycle management
  • Improved packet writing error handling
  • Strategic buffer state checks in ResetSession() and IsValid()
  • Removal of unnecessary COM_QUIT operations that could trigger errors
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Fetch the error handling improvements from the referenced PRs
echo "Checking error handling changes:"
for pr in 1595 1601 1641; do
    echo -e "\nChanges in PR #$pr:"
    gh pr view $pr --json title,body
done

Length of output: 3928


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.

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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

20-20: Consider consistent PR reference formatting.

For better readability, consider using a consistent format for multiple PR references. You could either:

  1. Use the same hyperlink format as older entries: [#1595](url), [#1601](url), [#1641](url)
  2. Or keep the current format but add spaces after commas: (#1595, #1601, #1641)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 255d1ad and 01b24d6.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: test (windows-latest, 1.23, mariadb-10.5)
  • GitHub Check: test (windows-latest, 1.23, mariadb-10.6)
  • GitHub Check: test (windows-latest, 1.23, mariadb-10.11)
  • GitHub Check: test (windows-latest, 1.23, mariadb-11.1)
  • GitHub Check: test (windows-latest, 1.23, mariadb-11.2)
  • GitHub Check: test (windows-latest, 1.23, mariadb-11.4)
  • GitHub Check: test (windows-latest, 1.23, 5.7)
  • GitHub Check: test (windows-latest, 1.23, 8.0)
  • GitHub Check: test (windows-latest, 1.23, 8.4)
  • GitHub Check: test (windows-latest, 1.23, 9.0)
  • GitHub Check: test (macos-latest, 1.23, mariadb-10.5)
  • GitHub Check: test (macos-latest, 1.23, mariadb-10.6)
  • GitHub Check: test (macos-latest, 1.23, mariadb-10.11)
  • GitHub Check: test (macos-latest, 1.23, mariadb-11.4)
  • GitHub Check: test (macos-latest, 1.23, 9.0)
🔇 Additional comments (2)
CHANGELOG.md (2)

9-9: Verify MySQL 9.0 reference.

MySQL 9.0 hasn't been released yet. Consider clarifying if this is for a preview/beta version or if the version number needs to be corrected.


1-22: Well-structured changelog entry.

The changelog entry is well-organized, properly categorized, and follows the project's established format. All changes are tracked with PR references, making it easy to find detailed information about each change.

@coveralls
Copy link

coveralls commented Jan 22, 2025

Coverage Status

coverage: 83.06% (+0.004%) from 83.056%
when pulling 92fc991 on methane:release-v190
into 255d1ad on go-sql-driver:master.

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.

2 participants