github.com/m3db/m3@v1.5.0/src/cluster/client/etcd/options.go

// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package etcd

import (
	"crypto/tls"
	"crypto/x509"
	"errors"
	"fmt"
	"io/ioutil"
	"math"
	"os"
	"time"

	"google.golang.org/grpc"

	"github.com/m3db/m3/src/cluster/services"
	"github.com/m3db/m3/src/x/instrument"
	"github.com/m3db/m3/src/x/retry"
)

const (
	defaultAutoSyncInterval = 1 * time.Minute
	defaultDialTimeout      = 15 * time.Second

	defaultKeepAliveEnabled         = true
	defaultKeepAlivePeriod          = 20 * time.Second
	defaultKeepAlivePeriodMaxJitter = 10 * time.Second
	defaultKeepAliveTimeout         = 10 * time.Second

	defaultRequestTimeout         = 10 * time.Second
	defaultWatchChanCheckInterval = 10 * time.Second
	defaultWatchChanResetInterval = 10 * time.Second
	defaultWatchChanInitTimeout   = 10 * time.Second

	defaultRetryInitialBackoff = 2 * time.Second
	defaultRetryBackoffFactor  = 2.0
	defaultRetryMaxRetries     = 3
	defaultRetryMaxBackoff     = time.Duration(math.MaxInt64)
	defaultRetryJitter         = true

	defaultDirectoryMode = os.FileMode(0755)
)

type keepAliveOptions struct {
	keepAliveEnabled         bool
	keepAlivePeriod          time.Duration
	keepAlivePeriodMaxJitter time.Duration
	keepAliveTimeout         time.Duration
}

// NewKeepAliveOptions provide a set of keepAlive options.
func NewKeepAliveOptions() KeepAliveOptions {
	return &keepAliveOptions{
		keepAliveEnabled:         defaultKeepAliveEnabled,
		keepAlivePeriod:          defaultKeepAlivePeriod,
		keepAlivePeriodMaxJitter: defaultKeepAlivePeriodMaxJitter,
		keepAliveTimeout:         defaultKeepAliveTimeout,
	}
}

func (o *keepAliveOptions) KeepAliveEnabled() bool { return o.keepAliveEnabled }

func (o *keepAliveOptions) SetKeepAliveEnabled(value bool) KeepAliveOptions {
	opts := *o
	opts.keepAliveEnabled = value
	return &opts
}

func (o *keepAliveOptions) KeepAlivePeriod() time.Duration { return o.keepAlivePeriod }

func (o *keepAliveOptions) SetKeepAlivePeriod(value time.Duration) KeepAliveOptions {
	opts := *o
	opts.keepAlivePeriod = value
	return &opts
}

func (o *keepAliveOptions) KeepAlivePeriodMaxJitter() time.Duration {
	return o.keepAlivePeriodMaxJitter
}

func (o *keepAliveOptions) SetKeepAlivePeriodMaxJitter(value time.Duration) KeepAliveOptions {
	opts := *o
	opts.keepAlivePeriodMaxJitter = value
	return &opts
}

func (o *keepAliveOptions) KeepAliveTimeout() time.Duration {
	return o.keepAliveTimeout
}

func (o *keepAliveOptions) SetKeepAliveTimeout(value time.Duration) KeepAliveOptions {
	opts := *o
	opts.keepAliveTimeout = value
	return &opts
}

// NewTLSOptions creates a set of TLS Options.
func NewTLSOptions() TLSOptions {
	return tlsOptions{}
}

type tlsOptions struct {
	cert string
	key  string
	ca   string
}

func (o tlsOptions) CrtPath() string {
	return o.cert
}

func (o tlsOptions) SetCrtPath(cert string) TLSOptions {
	o.cert = cert
	return o
}

func (o tlsOptions) KeyPath() string {
	return o.key
}
func (o tlsOptions) SetKeyPath(key string) TLSOptions {
	o.key = key
	return o
}

func (o tlsOptions) CACrtPath() string {
	return o.ca
}
func (o tlsOptions) SetCACrtPath(ca string) TLSOptions {
	o.ca = ca
	return o
}

func (o tlsOptions) Config() (*tls.Config, error) {
	if o.cert == "" {
		// By default we should use nil config instead of empty config.
		return nil, nil
	}

	cert, err := tls.LoadX509KeyPair(o.cert, o.key)
	if err != nil {
		return nil, err
	}
	caCert, err := ioutil.ReadFile(o.ca)
	if err != nil {
		return nil, err
	}
	caPool := x509.NewCertPool()
	if ok := caPool.AppendCertsFromPEM(caCert); !ok {
		return nil, fmt.Errorf("can't read PEM-formatted certificates from file %s as root CA pool", o.ca)
	}
	return &tls.Config{
		MinVersion:         tls.VersionTLS12,
		InsecureSkipVerify: false,
		Certificates:       []tls.Certificate{cert},
		RootCAs:            caPool,
	}, nil
}

// NewOptions creates a set of Options.
func NewOptions() Options {
	return options{
		sdOpts:                 services.NewOptions(),
		iopts:                  instrument.NewOptions(),
		requestTimeout:         defaultRequestTimeout,
		watchChanInitTimeout:   defaultWatchChanInitTimeout,
		watchChanCheckInterval: defaultWatchChanCheckInterval,
		watchChanResetInterval: defaultWatchChanResetInterval,
		// NB(r): Set some default retry options so changes to retry
		// option defaults don't change behavior of this client's retry options
		retryOpts: retry.NewOptions().
			SetInitialBackoff(defaultRetryInitialBackoff).
			SetBackoffFactor(defaultRetryBackoffFactor).
			SetMaxBackoff(defaultRetryMaxBackoff).
			SetMaxRetries(defaultRetryMaxRetries).
			SetJitter(defaultRetryJitter),
		newDirectoryMode: defaultDirectoryMode,
	}
}

type options struct {
	requestTimeout         time.Duration
	env                    string
	zone                   string
	service                string
	cacheDir               string
	watchChanCheckInterval time.Duration
	watchChanResetInterval time.Duration
	watchChanInitTimeout   time.Duration
	watchWithRevision      int64
	enableFastGets         bool
	sdOpts                 services.Options
	clusters               map[string]Cluster
	iopts                  instrument.Options
	retryOpts              retry.Options
	newDirectoryMode       os.FileMode
}

func (o options) Validate() error {
	if o.service == "" {
		return errors.New("invalid options, no service name set")
	}

	if len(o.clusters) == 0 {
		return errors.New("invalid options, no etcd clusters set")
	}

	if o.iopts == nil {
		return errors.New("invalid options, no instrument options set")
	}

	if o.watchChanCheckInterval <= 0 {
		return errors.New("invalid watch channel check interval")
	}

	if o.watchChanResetInterval <= 0 {
		return errors.New("invalid watch reset interval")
	}

	if o.watchChanInitTimeout <= 0 {
		return errors.New("invalid watch init interval")
	}

	if o.requestTimeout <= 0 {
		return errors.New("invalid request timeout")
	}

	return nil
}

func (o options) Env() string {
	return o.env
}

func (o options) SetEnv(e string) Options {
	o.env = e
	return o
}

func (o options) Zone() string {
	return o.zone
}

func (o options) SetZone(z string) Options {
	o.zone = z
	return o
}

func (o options) ServicesOptions() services.Options {
	return o.sdOpts
}

func (o options) SetServicesOptions(cfg services.Options) Options {
	o.sdOpts = cfg
	return o
}

func (o options) CacheDir() string {
	return o.cacheDir
}

func (o options) SetCacheDir(dir string) Options {
	o.cacheDir = dir
	return o
}

func (o options) Service() string {
	return o.service
}

func (o options) SetService(id string) Options {
	o.service = id
	return o
}

func (o options) Clusters() []Cluster {
	res := make([]Cluster, 0, len(o.clusters))
	for _, c := range o.clusters {
		res = append(res, c)
	}
	return res
}

func (o options) SetClusters(clusters []Cluster) Options {
	o.clusters = make(map[string]Cluster, len(clusters))
	for _, c := range clusters {
		o.clusters[c.Zone()] = c
	}
	return o
}

func (o options) ClusterForZone(z string) (Cluster, bool) {
	c, ok := o.clusters[z]
	return c, ok
}

func (o options) InstrumentOptions() instrument.Options {
	return o.iopts
}

func (o options) SetInstrumentOptions(iopts instrument.Options) Options {
	o.iopts = iopts
	return o
}

//nolint:gocritic
func (o options) RequestTimeout() time.Duration {
	return o.requestTimeout
}

//nolint:gocritic
func (o options) SetRequestTimeout(t time.Duration) Options {
	o.requestTimeout = t
	return o
}

func (o options) RetryOptions() retry.Options {
	return o.retryOpts
}

func (o options) SetRetryOptions(retryOpts retry.Options) Options {
	o.retryOpts = retryOpts
	return o
}

//nolint:gocritic
func (o options) WatchChanCheckInterval() time.Duration {
	return o.watchChanCheckInterval
}

//nolint:gocritic
func (o options) SetWatchChanCheckInterval(t time.Duration) Options {
	o.watchChanCheckInterval = t
	return o
}

//nolint:gocritic
func (o options) WatchChanResetInterval() time.Duration {
	return o.watchChanResetInterval
}

//nolint:gocritic
func (o options) SetWatchChanResetInterval(t time.Duration) Options {
	o.watchChanResetInterval = t
	return o
}

//nolint:gocritic
func (o options) WatchChanInitTimeout() time.Duration {
	return o.watchChanInitTimeout
}

//nolint:gocritic
func (o options) SetWatchChanInitTimeout(t time.Duration) Options {
	o.watchChanInitTimeout = t
	return o
}

func (o options) WatchWithRevision() int64 {
	return o.watchWithRevision
}

func (o options) SetWatchWithRevision(rev int64) Options {
	o.watchWithRevision = rev
	return o
}

func (o options) SetNewDirectoryMode(fm os.FileMode) Options {
	o.newDirectoryMode = fm
	return o
}

func (o options) NewDirectoryMode() os.FileMode {
	return o.newDirectoryMode
}

//nolint:gocritic
func (o options) EnableFastGets() bool {
	return o.enableFastGets
}

//nolint:gocritic
func (o options) SetEnableFastGets(enabled bool) Options {
	o.enableFastGets = enabled
	return o
}

// NewCluster creates a Cluster.
func NewCluster() Cluster {
	return cluster{
		autoSyncInterval: defaultAutoSyncInterval,
		dialTimeout:      defaultDialTimeout,
		keepAliveOpts:    NewKeepAliveOptions(),
		tlsOpts:          NewTLSOptions(),
	}
}

type cluster struct {
	zone             string
	endpoints        []string
	keepAliveOpts    KeepAliveOptions
	tlsOpts          TLSOptions
	autoSyncInterval time.Duration
	dialTimeout      time.Duration
	dialOptions      []grpc.DialOption
}

func (c cluster) Zone() string {
	return c.zone
}

func (c cluster) SetZone(z string) Cluster {
	c.zone = z
	return c
}

func (c cluster) Endpoints() []string {
	return c.endpoints
}

func (c cluster) SetEndpoints(endpoints []string) Cluster {
	c.endpoints = endpoints
	return c
}

func (c cluster) KeepAliveOptions() KeepAliveOptions {
	return c.keepAliveOpts
}

func (c cluster) SetKeepAliveOptions(value KeepAliveOptions) Cluster {
	c.keepAliveOpts = value
	return c
}

func (c cluster) TLSOptions() TLSOptions {
	return c.tlsOpts
}

func (c cluster) SetTLSOptions(opts TLSOptions) Cluster {
	c.tlsOpts = opts
	return c
}

func (c cluster) AutoSyncInterval() time.Duration {
	return c.autoSyncInterval
}

func (c cluster) SetAutoSyncInterval(autoSyncInterval time.Duration) Cluster {
	c.autoSyncInterval = autoSyncInterval
	return c
}

//nolint:gocritic
func (c cluster) DialTimeout() time.Duration {
	return c.dialTimeout
}

//nolint:gocritic
func (c cluster) SetDialTimeout(dialTimeout time.Duration) Cluster {
	c.dialTimeout = dialTimeout

	return c
}

func (c cluster) DialOptions() []grpc.DialOption {
	return c.dialOptions
}

func (c cluster) SetDialOptions(opts []grpc.DialOption) Cluster {
	c.dialOptions = opts
	return c
}