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.

Sign up for GitHub

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

Jump to bottom

Fix FormatDSN missing ConnectionAttributes #1619

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix FormatDSN missing ConnectionAttributes #1619

wants to merge 1 commit into from

Conversation

bogcon
Copy link

@bogcon bogcon commented Aug 2, 2024 •
edited by coderabbitai bot
Loading

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 coderabbitai
Copy link

coderabbitai bot commented Aug 2, 2024 •
edited
Loading

Walkthrough

This update adds support for ConnectionAttributes in the FormatDSN method of the Config struct within the MySQL driver. It enhances the functionality by allowing connection attributes to be included in the Data Source Name (DSN), improving database configuration options. Additionally, the AUTHORS file has been updated to include a new contributor, and test coverage for the DSN parsing has been expanded.

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 to ensure proper handling of connection attributes and invalid formats.

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
Loading

Assessment against linked issues

Objective Addressed Explanation
ConnectionAttributes included in FormatDSN (#1618) ✅
Maintain existing DSN format with attributes ✅

🐰 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!
💻✨

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 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[bot]
coderabbitai bot reviewed Aug 2, 2024
View reviewed changes
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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ConnectionAttributes is skipped in FormatDSN
1 participant
@bogcon