client_options.go

package client

import (
	"time"

	"go.viam.com/utils/rpc"
)

// robotClientOpts configure a Dial call. robotClientOpts are set by the RobotClientOption
// values passed to NewClient.
type robotClientOpts struct {
	// refreshEvery is how often to refresh the status/parts of the
	// robot. If <=0, it will not be refreshed automatically, if unset,
	// it will automatically refresh every 10s
	refreshEvery *time.Duration

	// checkConnectedEvery is how often to check connection to the
	// robot. If <=0, it will not be refreshed automatically, if unset,
	// it will automatically refresh every 10s
	checkConnectedEvery *time.Duration

	// reconnectEvery is how often to try reconnecting the
	// robot. If <=0, it will not be refreshed automatically, if unset,
	// it will automatically refresh every 1s
	reconnectEvery *time.Duration

	// dialOptions are options using for clients dialing gRPC servers.
	dialOptions []rpc.DialOption

	// the name of the robot.
	remoteName string

	// controls whether or not sessions are disabled.
	disableSessions bool

	// initialConnectionAttempts indicates the number of times to try dialing when making
	// initial connection to a machine. Defaults to three. If set to zero or a negative
	// value, will attempt to connect forever.
	initialConnectionAttempts *int

	modName string
}

// RobotClientOption configures how we set up the connection.
// Cribbed from https://github.com/grpc/grpc-go/blob/aff571cc86e6e7e740130dbbb32a9741558db805/dialoptions.go#L41
type RobotClientOption interface {
	apply(*robotClientOpts)
}

// funcRobotClientOption wraps a function that modifies robotClientOpts into an
// implementation of the RobotClientOption interface.
type funcRobotClientOption struct {
	f func(*robotClientOpts)
}

func (fdo *funcRobotClientOption) apply(do *robotClientOpts) {
	fdo.f(do)
}

func newFuncRobotClientOption(f func(*robotClientOpts)) *funcRobotClientOption {
	return &funcRobotClientOption{
		f: f,
	}
}

// WithModName attaches a unary interceptor that attaches the module name for each outgoing gRPC
// request. Should only be used in Viam module library code.
func WithModName(modName string) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.modName = modName
	})
}

// WithRefreshEvery returns a RobotClientOption for how often to refresh the status/parts of the
// robot.
func WithRefreshEvery(refreshEvery time.Duration) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.refreshEvery = &refreshEvery
	})
}

// WithInitialDialAttempts sets the number of times to attempt to connect to a robot when
// initially dialing. Defaults to 3 attempts. If set to zero or a negative value, will
// attempt to connect forever.
func WithInitialDialAttempts(attempts int) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.initialConnectionAttempts = &attempts
	})
}

// WithCheckConnectedEvery returns a RobotClientOption for how often to check connection to the robot.
func WithCheckConnectedEvery(checkConnectedEvery time.Duration) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.checkConnectedEvery = &checkConnectedEvery
	})
}

// WithReconnectEvery returns a RobotClientOption for how often to reconnect the robot.
func WithReconnectEvery(reconnectEvery time.Duration) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.reconnectEvery = &reconnectEvery
	})
}

// WithRemoteName returns a RobotClientOption setting the name of the remote robot.
func WithRemoteName(remoteName string) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.remoteName = remoteName
	})
}

// WithDisableSessions returns a RobotClientOption that disables session support.
func WithDisableSessions() RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.disableSessions = true
	})
}

// WithDialOptions returns a RobotClientOption which sets the options for making
// gRPC connections to other servers.
func WithDialOptions(opts ...rpc.DialOption) RobotClientOption {
	return newFuncRobotClientOption(func(o *robotClientOpts) {
		o.dialOptions = opts
	})
}

// ExtractDialOptions extracts RPC dial options from the given options, if any exist.
func ExtractDialOptions(opts ...RobotClientOption) []rpc.DialOption {
	var rOpts robotClientOpts
	for _, opt := range opts {
		opt.apply(&rOpts)
	}
	return rOpts.dialOptions
}