Fix FormatDSN missing ConnectionAttributes by bogcon · Pull Request #1619 · go-sql-driver/mysql

bogcon · 2024-08-02T07:52:49Z

Description

Took into account ConnectionAttributes config, if set, in FormatDSN
Fixes #1618

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 support for including connection attributes in the generated DSN string, enhancing database configuration options.
- Expanded test coverage for database connection strings, focusing on handling various scenarios including unescaped values.
Documentation
- Updated the AUTHORS file to acknowledge Bogdan Constantinescu as a contributor.

coderabbitai · 2024-08-02T07:52:57Z

Walkthrough

A new entry has been added to the AUTHORS file for Bogdan Constantinescu, positioned alphabetically among existing authors. Additionally, the FormatDSN method in the dsn.go file has been modified to include user-defined ConnectionAttributes in the generated DSN string. Correspondingly, the dsn_test.go file has been updated with new test cases for both valid and invalid DSN scenarios to ensure comprehensive testing of the DSN parser's functionality.

Changes

Files	Change Summary
`AUTHORS`	Added Bogdan Constantinescu as a contributor.
`dsn.go`, `dsn_test.go`	Enhanced `FormatDSN` to include `ConnectionAttributes`. Added new test cases for valid and invalid DSNs to improve test coverage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Config
    participant DSNBuilder

    User->>Config: Create DSN with ConnectionAttributes
    Config->>DSNBuilder: FormatDSN()
    alt ConnectionAttributes present
        DSNBuilder->>DSNBuilder: Append connectionAttributes to DSN
    end
    DSNBuilder->>User: Return formatted DSN

Possibly related PRs

Fix for issue #1666 #1667: Related to the addition of a new author in the AUTHORS file, similar to the changes made in this PR.

🐰 In fields of code, where logic hops wide,
New attributes dance, with data as guide.
Contributors join, a new name to cheer,
Together we build, with each line sincere!
💻✨

📜 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 32a54ed and 92fe441.

📒 Files selected for processing (3)

AUTHORS (1 hunks)
dsn.go (1 hunks)
dsn_test.go (2 hunks)

🔇 Additional comments (4)

AUTHORS (1)

27-27: Author entry added correctly

The new author entry is positioned correctly in alphabetical order as per the file guidelines.

dsn.go (1)

310-312: Implementation correctly handles ConnectionAttributes in FormatDSN

This change properly addresses the issue mentioned in #1618 by including the ConnectionAttributes in the generated DSN when it's set. The value is correctly URL-escaped to ensure it's properly formatted for inclusion in the DSN string.

dsn_test.go (2)

81-82: Test case added for ConnectionAttributes in DSN

Good addition of a test case that verifies the ConnectionAttributes are correctly included in the DSN and properly parsed. The test includes complex attributes with URL-escaped characters to ensure thorough testing.

116-116: Invalid DSN test case for unescaped ConnectionAttributes

Good addition of an invalid test case that verifies the DSN parser correctly rejects unescaped values in ConnectionAttributes.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 44553d6 and 32a54ed.

Files selected for processing (3)

AUTHORS (1 hunks)
dsn.go (1 hunks)
dsn_test.go (2 hunks)

Files skipped from review due to trivial changes (1)

AUTHORS

Additional comments not posted (3)

dsn_test.go (2)

80-82: New test entry for connection attributes looks good.

The new test entry for testDSNs correctly includes connection attributes and other necessary parameters.

115-116: New test case for unescaped connection attributes looks good.

The new test case in TestDSNParserInvalid correctly checks for unescaped connection attributes, enhancing the robustness of the test suite.

dsn.go (1)

293-295: New conditional block for connection attributes looks good.

The new conditional block in the FormatDSN method correctly includes connection attributes in the formatted DSN if they are set.

coveralls · 2025-03-08T08:44:24Z

coverage: 82.984% (-0.09%) from 83.073%
when pulling 92fe441 on bogcon:fix_formatdsn_connectionattributes
into 58941dd on go-sql-driver:master.

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>

Merged upstream commits from v1.8.1 to v1.9.2, which includes: Major changes: - Implement zlib compression (go-sql-driver#1487) - Add support for VECTOR type (MySQL 9.0) (go-sql-driver#1609) - Add Charset() option (go-sql-driver#1679) - Config object can have custom dial function (go-sql-driver#1527) - Supported Go version updated to Go 1.21+ (go-sql-driver#1639) Bug fixes: - Fix auth errors when username/password are too long (go-sql-driver#1625) - Check if MySQL supports CLIENT_CONNECT_ATTRS before sending (go-sql-driver#1640) - Fix auth switch request handling (go-sql-driver#1666) - Fix FormatDSN missing ConnectionAttributes (go-sql-driver#1619) Other improvements: - Better error handling to reduce "busy buffer" errors - Add filename:line prefix to logs (go-sql-driver#1589) - Improved max_allowed_packet parsing (go-sql-driver#1661) - rejectReadOnly option now handles ER_READ_ONLY_MODE error (go-sql-driver#1660) Preserved local customizations: - skipParseNumbers DSN option (p2) - Custom _client_name connection attribute (p4) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Fix FormatDSN missing ConnectionAttributes

32a54ed

coderabbitai bot reviewed Aug 2, 2024

View reviewed changes

methane added 2 commits March 8, 2025 17:18

Merge branch 'master' into fix_formatdsn_connectionattributes

ef0bcc9

Fix missing closing brace in dsn.go

92fe441

methane approved these changes Mar 8, 2025

View reviewed changes

methane enabled auto-merge (squash) March 8, 2025 08:40

methane merged commit 88ff88b into go-sql-driver:master Mar 10, 2025
38 checks passed

coderabbitai bot mentioned this pull request Mar 14, 2025

release v1.9.1 #1683

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix FormatDSN missing ConnectionAttributes#1619

Fix FormatDSN missing ConnectionAttributes#1619
methane merged 3 commits intogo-sql-driver:masterfrom
bogcon:fix_formatdsn_connectionattributes

bogcon commented Aug 2, 2024 •

edited by methane

Loading

Uh oh!

coderabbitai bot commented Aug 2, 2024 •

edited

Loading

Chat

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

Uh oh!

coveralls commented Mar 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

bogcon commented Aug 2, 2024 • edited by methane 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 Aug 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Chat

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!

coveralls commented Mar 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bogcon commented Aug 2, 2024 •

edited by methane

Loading

coderabbitai bot commented Aug 2, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)