301 lines
6.7 KiB
Go
301 lines
6.7 KiB
Go
package config
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"go.unistack.org/micro/v3/codec"
|
|
"go.unistack.org/micro/v3/logger"
|
|
"go.unistack.org/micro/v3/meter"
|
|
"go.unistack.org/micro/v3/options"
|
|
"go.unistack.org/micro/v3/tracer"
|
|
)
|
|
|
|
// Options hold the config options
|
|
type Options struct {
|
|
// Struct holds the destination config struct
|
|
Struct interface{}
|
|
// Codec that used for load/save
|
|
Codec codec.Codec
|
|
// Tracer that will be used
|
|
Tracer tracer.Tracer
|
|
// Meter that will be used
|
|
Meter meter.Meter
|
|
// Logger that will be used
|
|
Logger logger.Logger
|
|
// Context used for external options
|
|
Context context.Context
|
|
// Name of the config
|
|
Name string
|
|
// StructTag name
|
|
StructTag string
|
|
// BeforeSave contains slice of funcs that runs before Save
|
|
BeforeSave []func(context.Context, Config) error
|
|
// AfterSave contains slice of funcs that runs after Save
|
|
AfterSave []func(context.Context, Config) error
|
|
// BeforeLoad contains slice of funcs that runs before Load
|
|
BeforeLoad []func(context.Context, Config) error
|
|
// AfterLoad contains slice of funcs that runs after Load
|
|
AfterLoad []func(context.Context, Config) error
|
|
// BeforeInit contains slice of funcs that runs before Init
|
|
BeforeInit []func(context.Context, Config) error
|
|
// AfterInit contains slice of funcs that runs after Init
|
|
AfterInit []func(context.Context, Config) error
|
|
// AllowFail flag to allow fail in config source
|
|
AllowFail bool
|
|
// SkipLoad runs only if condition returns true
|
|
SkipLoad func(context.Context, Config) bool
|
|
// SkipSave runs only if condition returns true
|
|
SkipSave func(context.Context, Config) bool
|
|
// Hooks can be run before/after config Save/Load
|
|
Hooks options.Hooks
|
|
}
|
|
|
|
// Option function signature
|
|
type Option func(o *Options)
|
|
|
|
// NewOptions new options struct with filed values
|
|
func NewOptions(opts ...Option) Options {
|
|
options := Options{
|
|
Logger: logger.DefaultLogger,
|
|
Meter: meter.DefaultMeter,
|
|
Tracer: tracer.DefaultTracer,
|
|
Context: context.Background(),
|
|
}
|
|
for _, o := range opts {
|
|
o(&options)
|
|
}
|
|
|
|
return options
|
|
}
|
|
|
|
// LoadOption function signature
|
|
type LoadOption func(o *LoadOptions)
|
|
|
|
// LoadOptions struct
|
|
type LoadOptions struct {
|
|
Struct interface{}
|
|
Context context.Context
|
|
Override bool
|
|
Append bool
|
|
}
|
|
|
|
// NewLoadOptions create LoadOptions struct with provided opts
|
|
func NewLoadOptions(opts ...LoadOption) LoadOptions {
|
|
options := LoadOptions{}
|
|
for _, o := range opts {
|
|
o(&options)
|
|
}
|
|
return options
|
|
}
|
|
|
|
// LoadOverride override values when load
|
|
func LoadOverride(b bool) LoadOption {
|
|
return func(o *LoadOptions) {
|
|
o.Override = b
|
|
}
|
|
}
|
|
|
|
// LoadAppend override values when load
|
|
func LoadAppend(b bool) LoadOption {
|
|
return func(o *LoadOptions) {
|
|
o.Append = b
|
|
}
|
|
}
|
|
|
|
// LoadStruct override struct for loading
|
|
func LoadStruct(src interface{}) LoadOption {
|
|
return func(o *LoadOptions) {
|
|
o.Struct = src
|
|
}
|
|
}
|
|
|
|
// SaveOption function signature
|
|
type SaveOption func(o *SaveOptions)
|
|
|
|
// SaveOptions struct
|
|
type SaveOptions struct {
|
|
Struct interface{}
|
|
Context context.Context
|
|
}
|
|
|
|
// SaveStruct override struct for save to config
|
|
func SaveStruct(src interface{}) SaveOption {
|
|
return func(o *SaveOptions) {
|
|
o.Struct = src
|
|
}
|
|
}
|
|
|
|
// NewSaveOptions fill SaveOptions struct
|
|
func NewSaveOptions(opts ...SaveOption) SaveOptions {
|
|
options := SaveOptions{}
|
|
for _, o := range opts {
|
|
o(&options)
|
|
}
|
|
return options
|
|
}
|
|
|
|
// AllowFail allows config source to fail
|
|
func AllowFail(b bool) Option {
|
|
return func(o *Options) {
|
|
o.AllowFail = b
|
|
}
|
|
}
|
|
|
|
// BeforeInit run funcs before config Init
|
|
func BeforeInit(fn ...func(context.Context, Config) error) Option {
|
|
return func(o *Options) {
|
|
o.BeforeInit = fn
|
|
}
|
|
}
|
|
|
|
// AfterInit run funcs after config Init
|
|
func AfterInit(fn ...func(context.Context, Config) error) Option {
|
|
return func(o *Options) {
|
|
o.AfterInit = fn
|
|
}
|
|
}
|
|
|
|
// BeforeLoad run funcs before config load
|
|
func BeforeLoad(fn ...func(context.Context, Config) error) Option {
|
|
return func(o *Options) {
|
|
o.BeforeLoad = fn
|
|
}
|
|
}
|
|
|
|
// AfterLoad run funcs after config load
|
|
func AfterLoad(fn ...func(context.Context, Config) error) Option {
|
|
return func(o *Options) {
|
|
o.AfterLoad = fn
|
|
}
|
|
}
|
|
|
|
// BeforeSave run funcs before save
|
|
func BeforeSave(fn ...func(context.Context, Config) error) Option {
|
|
return func(o *Options) {
|
|
o.BeforeSave = fn
|
|
}
|
|
}
|
|
|
|
// AfterSave run fncs after save
|
|
func AfterSave(fn ...func(context.Context, Config) error) Option {
|
|
return func(o *Options) {
|
|
o.AfterSave = fn
|
|
}
|
|
}
|
|
|
|
// Context pass context
|
|
func Context(ctx context.Context) Option {
|
|
return func(o *Options) {
|
|
o.Context = ctx
|
|
}
|
|
}
|
|
|
|
// Codec sets the source codec
|
|
func Codec(c codec.Codec) Option {
|
|
return func(o *Options) {
|
|
o.Codec = c
|
|
}
|
|
}
|
|
|
|
// Logger sets the logger
|
|
func Logger(l logger.Logger) Option {
|
|
return func(o *Options) {
|
|
o.Logger = l
|
|
}
|
|
}
|
|
|
|
// Tracer to be used for tracing
|
|
func Tracer(t tracer.Tracer) Option {
|
|
return func(o *Options) {
|
|
o.Tracer = t
|
|
}
|
|
}
|
|
|
|
// Struct used as config
|
|
func Struct(v interface{}) Option {
|
|
return func(o *Options) {
|
|
o.Struct = v
|
|
}
|
|
}
|
|
|
|
// StructTag sets the struct tag that used for filling
|
|
func StructTag(name string) Option {
|
|
return func(o *Options) {
|
|
o.StructTag = name
|
|
}
|
|
}
|
|
|
|
// Name sets the name
|
|
func Name(n string) Option {
|
|
return func(o *Options) {
|
|
o.Name = n
|
|
}
|
|
}
|
|
|
|
// WatchOptions struuct
|
|
type WatchOptions struct {
|
|
// Context used by non default options
|
|
Context context.Context
|
|
// Struct for filling
|
|
Struct interface{}
|
|
// MinInterval specifies the min time.Duration interval for poll changes
|
|
MinInterval time.Duration
|
|
// MaxInterval specifies the max time.Duration interval for poll changes
|
|
MaxInterval time.Duration
|
|
// Coalesce multiple events to one
|
|
Coalesce bool
|
|
}
|
|
|
|
// WatchOption func signature
|
|
type WatchOption func(*WatchOptions)
|
|
|
|
// NewWatchOptions create WatchOptions struct with provided opts
|
|
func NewWatchOptions(opts ...WatchOption) WatchOptions {
|
|
options := WatchOptions{
|
|
Context: context.Background(),
|
|
MinInterval: DefaultWatcherMinInterval,
|
|
MaxInterval: DefaultWatcherMaxInterval,
|
|
}
|
|
for _, o := range opts {
|
|
o(&options)
|
|
}
|
|
return options
|
|
}
|
|
|
|
// WatchContext pass context
|
|
func WatchContext(ctx context.Context) WatchOption {
|
|
return func(o *WatchOptions) {
|
|
o.Context = ctx
|
|
}
|
|
}
|
|
|
|
// WatchCoalesce controls watch event combining
|
|
func WatchCoalesce(b bool) WatchOption {
|
|
return func(o *WatchOptions) {
|
|
o.Coalesce = b
|
|
}
|
|
}
|
|
|
|
// WatchInterval specifies min and max time.Duration for pulling changes
|
|
func WatchInterval(min, max time.Duration) WatchOption {
|
|
return func(o *WatchOptions) {
|
|
o.MinInterval = min
|
|
o.MaxInterval = max
|
|
}
|
|
}
|
|
|
|
// WatchStruct overrides struct for fill
|
|
func WatchStruct(src interface{}) WatchOption {
|
|
return func(o *WatchOptions) {
|
|
o.Struct = src
|
|
}
|
|
}
|
|
|
|
// Hooks sets hook runs before action
|
|
func Hooks(h ...options.Hook) Option {
|
|
return func(o *Options) {
|
|
o.Hooks = append(o.Hooks, h...)
|
|
}
|
|
}
|