Specify a custom dial function per config

[aaronjheng]

Description

Specify a custom dial function per config instead of using RegisterDialContext. It's hard to bind different state infomation for dialing with RegisterDialContext. Like SSH tunneling, if we want to use diffrent SSH connections, unique net for RegisterDialContext is required If I'm not wrong.

Use cases:

1. SSH tunneling per Config/dsn

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
  • Introduced a configurable network connection handling feature, allowing users to specify custom methods for establishing network connections.
  • Added a new DialFunc field in the Config struct for enhanced control over connection establishment.
• Refactor
  • Enhanced the connector component to support flexible connection establishment through the new DialFunc option.
• Documentation
  • Updated Config struct documentation to reflect the addition of the DialFunc field, enabling more controlled connection processes.

[coderabbitai[bot]]

Walkthrough

The recent updates introduce a significant enhancement in connection management by incorporating a configurable DialFunc in the Config struct. This addition allows for more flexible and context-aware network connection establishment. By enabling the use of a custom DialFunc, if provided, or falling back to a default method otherwise, these changes cater to varying connection requirements and scenarios, thereby increasing the adaptability of the system.

Changes

File(s)	Change Summary
connector.go	Updated the Connect method to utilize a configurable DialFunc for network connections.
dsn.go	Introduced a DialFunc field in the Config struct for customizable connection establishment. Added context package import.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[dolmen]

I would like to see in the description of this PR an example of how that new feature would be used. Because I would to ensure this can't be implemented in another way.

[aaronjheng]

I’m not quite sure what kind of example you want. I think my PR description has already explained it clearly. Without using different custom net names, RegisterDialContext can only register the SSH Tunnel globally. However, what I want is to be able to use multiple SSH Tunnels in one program without registering the net globally. In this PR, different Tunnels can be configured through DSN configuration.

[aaronjheng]

Additionally, customizing a Dialer for each Client is a very common feature.

• https://github.com/golang/go/blob/70491a81113e7003e314451f3e3cf134c4d41dd7/src/net/http/transport.go#L143
• https://github.com/redis/go-redis/blob/3613df6115220a276599764b54baec9dfc9d1072/options.go#L43
• https://github.com/segmentio/kafka-go/blob/4713019eca4fc9864a38d5948223bd12a05a3f5f/dialer.go#L28
• https://github.com/mongodb/mongo-go-driver/blob/45f905947c6dbe59ad1b75ee7bbee6240fe1a7de/mongo/options/clientoptions.go#L656