mirror of
https://github.com/spf13/viper
synced 2024-12-22 19:47:01 +00:00
Extend remote config watch with context and callback
This commit is contained in:
parent
947eb59667
commit
ba872b6d0d
1 changed files with 44 additions and 8 deletions
48
viper.go
48
viper.go
|
@ -21,6 +21,7 @@ package viper
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"context"
|
||||||
"encoding/csv"
|
"encoding/csv"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
@ -143,6 +144,16 @@ func DecodeHook(hook mapstructure.DecodeHookFunc) DecoderConfigOption {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type RemoteConfigEvent uint
|
||||||
|
|
||||||
|
const (
|
||||||
|
RemoteConfigEvent_Unknown RemoteConfigEvent = iota
|
||||||
|
// Remote config was updated
|
||||||
|
RemoteConfigEvent_Updated
|
||||||
|
// Remote config watch routine stopped
|
||||||
|
RemoteConfigEvent_Stopped
|
||||||
|
)
|
||||||
|
|
||||||
// Viper is a prioritized configuration registry. It
|
// Viper is a prioritized configuration registry. It
|
||||||
// maintains a set of configuration sources, fetches
|
// maintains a set of configuration sources, fetches
|
||||||
// values to populate those, and provides them according
|
// values to populate those, and provides them according
|
||||||
|
@ -218,6 +229,7 @@ type Viper struct {
|
||||||
typeByDefValue bool
|
typeByDefValue bool
|
||||||
|
|
||||||
onConfigChange func(fsnotify.Event)
|
onConfigChange func(fsnotify.Event)
|
||||||
|
onRemoteConfigChange func(RemoteConfigEvent)
|
||||||
|
|
||||||
logger *slog.Logger
|
logger *slog.Logger
|
||||||
|
|
||||||
|
@ -432,6 +444,14 @@ func (v *Viper) OnConfigChange(run func(in fsnotify.Event)) {
|
||||||
v.onConfigChange = run
|
v.onConfigChange = run
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// OnRemoteConfigChange sets the event handler that is called when a remote config file changes.
|
||||||
|
func OnRemoteConfigChange(run func(RemoteConfigEvent)) { v.OnRemoteConfigChange(run) }
|
||||||
|
|
||||||
|
// OnRemoteConfigChange sets the event handler that is called when a remote config file changes.
|
||||||
|
func (v *Viper) OnRemoteConfigChange(run func(RemoteConfigEvent)) {
|
||||||
|
v.onRemoteConfigChange = run
|
||||||
|
}
|
||||||
|
|
||||||
// WatchConfig starts watching a config file for changes.
|
// WatchConfig starts watching a config file for changes.
|
||||||
func WatchConfig() { v.WatchConfig() }
|
func WatchConfig() { v.WatchConfig() }
|
||||||
|
|
||||||
|
@ -1973,7 +1993,11 @@ func (v *Viper) WatchRemoteConfig() error {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (v *Viper) WatchRemoteConfigOnChannel() error {
|
func (v *Viper) WatchRemoteConfigOnChannel() error {
|
||||||
return v.watchKeyValueConfigOnChannel()
|
return v.watchKeyValueConfigOnChannelWithContext(context.TODO())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (v *Viper) WatchRemoteConfigOnChannelWithContext(ctx context.Context) error {
|
||||||
|
return v.watchKeyValueConfigOnChannelWithContext(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Retrieve the first found remote configuration.
|
// Retrieve the first found remote configuration.
|
||||||
|
@ -2010,20 +2034,32 @@ func (v *Viper) getRemoteConfig(provider RemoteProvider) (map[string]any, error)
|
||||||
return v.kvstore, err
|
return v.kvstore, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Retrieve the first found remote configuration.
|
// Watch the first found remote configuration.
|
||||||
func (v *Viper) watchKeyValueConfigOnChannel() error {
|
func (v *Viper) watchKeyValueConfigOnChannelWithContext(ctx context.Context) error {
|
||||||
if len(v.remoteProviders) == 0 {
|
if len(v.remoteProviders) == 0 {
|
||||||
return RemoteConfigError("No Remote Providers")
|
return RemoteConfigError("No Remote Providers")
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, rp := range v.remoteProviders {
|
for _, rp := range v.remoteProviders {
|
||||||
respc, _ := RemoteConfig.WatchChannel(rp)
|
respc, _ := RemoteConfig.WatchChannel(rp)
|
||||||
// Todo: Add quit channel
|
|
||||||
go func(rc <-chan *RemoteResponse) {
|
go func(rc <-chan *RemoteResponse) {
|
||||||
for {
|
for {
|
||||||
b := <-rc
|
select {
|
||||||
|
case b := <-rc:
|
||||||
reader := bytes.NewReader(b.Value)
|
reader := bytes.NewReader(b.Value)
|
||||||
v.unmarshalReader(reader, v.kvstore)
|
if err := v.unmarshalReader(reader, v.kvstore); err != nil {
|
||||||
|
v.logger.Error(fmt.Errorf("unmarshal remote config update: %w", err).Error())
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if v.onRemoteConfigChange != nil {
|
||||||
|
v.onRemoteConfigChange(RemoteConfigEvent_Updated)
|
||||||
|
}
|
||||||
|
case <-ctx.Done():
|
||||||
|
if v.onRemoteConfigChange != nil {
|
||||||
|
v.onRemoteConfigChange(RemoteConfigEvent_Stopped)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}(respc)
|
}(respc)
|
||||||
return nil
|
return nil
|
||||||
|
|
Loading…
Reference in a new issue