redis/go-redis
1
0
Fork 0
mirror of https://github.com/redis/go-redis.git synced 2025-07-28 06:42:00 +03:00
Code Activity

feat: update to ParseClusterURL and use addr param

Browse Source
This commit is contained in:
Stephanie Hingtgen
2021-10-18 09:07:36 -05:00
parent 7daa7f91fd
commit 175d0d81fc
3 changed files with 102 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

127
cluster.go
View File

@ -133,12 +133,15 @@ func (opt *ClusterOptions) init() {
}
}
// ParseClusterURLs parses an array of URLs into ClusterOptions that can be used to connect to Redis.
// The strings in the array must be in the form:
// ParseClusterURL parses a URL into ClusterOptions that can be used to connect to Redis.
// The URL must be in the form:
// redis://<user>:<password>@<host>:<port>
// or
// rediss://<user>:<password>@<host>:<port>
// All strings in the array must use the same scheme, username, and password.
// To add additional addresses, specify the query parameter, "addr" one or more times. e.g:
// redis://<user>:<password>@<host>:<port>?addr=<host2>:<port2>&addr=<host3>:<port3>
// or
// rediss://<user>:<password>@<host>:<port>?addr=<host2>:<port2>&addr=<host3>:<port3>
//
// Most Option fields can be set using query parameters, with the following restrictions:
// - field names are mapped using snake-case conversion: to set MaxRetries, use max_retries
@ -152,88 +155,66 @@ func (opt *ClusterOptions) init() {
// URL attributes (scheme, host, userinfo, resp.), query paremeters using these
// names will be treated as unknown parameters
// - unknown parameter names will result in an error
// - if query parameters differ between urls, the last one in the array will be used
// Examples:
// [
// redis://user:password@localhost:6789?dial_timeout=3&read_timeout=6s&max_retries=2,
// redis://user:password@localhost:6790?dial_timeout=3&read_timeout=6s&max_retries=2,
// redis://user:password@localhost:6791?dial_timeout=3&read_timeout=6s&max_retries=5,
// ]
// Example:
// redis://user:password@localhost:6789?dial_timeout=3&read_timeout=6s&max_retries=2&addr=localhost:6790&addr=localhost:6791
// is equivalent to:
// &ClusterOptions{
// Addr: ["localhost:6789", "localhost:6790", "localhost:6791"]
// DialTimeout: 3 * time.Second, // no time unit = seconds
// ReadTimeout: 6 * time.Second,
// MaxRetries: 5, // last one in the array is used
// MaxRetries: 2,
// }
func ParseClusterURLs(redisURLs []string) (*ClusterOptions, error) {
func ParseClusterURL(redisURL string) (*ClusterOptions, error) {
o := &ClusterOptions{}
previousScheme := ""
// loop through all the URLs and retrieve the addresses as well as the
// cluster options
for _, redisURL := range redisURLs {
u, err := url.Parse(redisURL)
if err != nil {
return nil, err
}
h, p, err := net.SplitHostPort(u.Host)
if err != nil {
h = u.Host
}
if h == "" {
h = "localhost"
}
if p == "" {
p = "6379"
}
o.Addrs = append(o.Addrs, net.JoinHostPort(h, p))
// all URLS must use the same scheme
if previousScheme != "" && u.Scheme != previousScheme {
return nil, fmt.Errorf("redis: mismatch schemes: %s and %s", previousScheme, u.Scheme)
}
previousScheme = u.Scheme
// setup username, password, and other configurations
o, err = setupClusterConn(u, h, o)
if err != nil {
return nil, err
}
u, err := url.Parse(redisURL)
if err != nil {
return nil, err
}
// add base URL to the array of addresses
// more addresses may be added through the URL params
h, p, err := net.SplitHostPort(u.Host)
if err != nil {
h = u.Host
}
if h == "" {
h = "localhost"
}
if p == "" {
p = "6379"
}
o.Addrs = append(o.Addrs, net.JoinHostPort(h, p))
// setup username, password, and other configurations
o, err = setupClusterConn(u, h, o)
if err != nil {
return nil, err
}
return o, nil
}
// setupClusterConn gets the username and password from the URL and the query parameters.
func setupClusterConn(u *url.URL, host string, o *ClusterOptions) (*ClusterOptions, error) {
switch u.Scheme {
case "rediss":
o.TLSConfig = &tls.Config{ServerName: host}
fallthrough
case "redis":
o.Username, o.Password = getUserPassword(u)
default:
return nil, fmt.Errorf("redis: invalid URL scheme: %s", u.Scheme)
}
// retrieve the configuration from the query parameters
o, err := setupClusterQueryParams(u, o)
if err != nil {
return nil, err
}
switch u.Scheme {
case "rediss":
o.TLSConfig = &tls.Config{ServerName: host}
fallthrough
case "redis":
// get the username & password - they must be consistent across urls
u, p := getUserPassword(u)
if o.Username != "" && o.Username != u {
return nil, fmt.Errorf("redis: mismatch usernames: %s and %s", o.Username, u)
}
if o.Password != "" && o.Password != p {
return nil, fmt.Errorf("redis: mismatch passwords")
}
o.Username, o.Password = u, p
return o, nil
default:
return nil, fmt.Errorf("redis: invalid URL scheme: %s", u.Scheme)
}
return o, nil
}
// setupClusterQueryParams converts query parameters in u to option value in o.
@ -262,6 +243,22 @@ func setupClusterQueryParams(u *url.URL, o *ClusterOptions) (*ClusterOptions, er
return nil, q.err
}
// addr can be specified as many times as needed
addr := q.string("addr")
for addr != "" {
h, p, err := net.SplitHostPort(addr)
if err != nil || h == "" || p == "" {
return nil, fmt.Errorf("redis: unable to parse addr param: %s", addr)
}
o.Addrs = append(o.Addrs, net.JoinHostPort(h, p))
addr = q.string("addr")
if q.err != nil {
return nil, q.err
}
}
// any parameters left?
if r := q.remaining(); len(r) > 0 {
return nil, fmt.Errorf("redis: unexpected option: %s", strings.Join(r, ", "))