Merge pull request #1 from yoyofxteam/dev

notify event on remote config changed

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 yoyofx
+
+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.

config_remote_provider.go

@@ -1,6 +1,7 @@
 package nacos_viper_remote
 
 import (
+	"bytes"
 	"fmt"
 	"github.com/spf13/viper"
 )
@@ -16,9 +17,9 @@ func NewRemoteProvider(configType string) *ViperRemoteProvider {
 		configSet:  "yoyogo.cloud.discovery.metadata"}
 }
 
-func (provider *ViperRemoteProvider) GetProvider(runtime_viper *viper.Viper) *viper.Viper {
+func (provider *ViperRemoteProvider) GetProvider(runtimeViper *viper.Viper) *viper.Viper {
 	var option *Option
-	err := runtime_viper.Sub(provider.configSet).Unmarshal(&option)
+	err := runtimeViper.Sub(provider.configSet).Unmarshal(&option)
 	if err != nil {
 		panic(err)
 		return nil
@@ -32,7 +33,7 @@ func (provider *ViperRemoteProvider) GetProvider(runtime_viper *viper.Viper) *vi
 	remote_viper.SetConfigType(provider.configType)
 	err = remote_viper.ReadRemoteConfig()
 	if err == nil {
-		err = remote_viper.WatchRemoteConfigOnChannel()
+		//err = remote_viper.WatchRemoteConfigOnChannel()
 		if err == nil {
 			fmt.Println("used remote viper")
 			return remote_viper
@@ -40,5 +41,22 @@ func (provider *ViperRemoteProvider) GetProvider(runtime_viper *viper.Viper) *vi
 	} else {
 		panic(err)
 	}
-	return runtime_viper
+	return runtimeViper
+}
+
+func (provider *ViperRemoteProvider) WatchRemoteConfigOnChannel(remoteViper *viper.Viper) <-chan bool {
+	updater := make(chan bool)
+
+	respChan, _ := viper.RemoteConfig.WatchChannel(DefaultRemoteProvider())
+	go func(rc <-chan *viper.RemoteResponse) {
+		for {
+			b := <-rc
+			reader := bytes.NewReader(b.Value)
+			_ = remoteViper.ReadConfig(reader)
+			// configuration on changed
+			updater <- true
+		}
+	}(respChan)
+
+	return updater
 }

example/main.go

@@ -32,14 +32,21 @@ func main() {
 	remote_viper := viper.New()
 	err := remote_viper.AddRemoteProvider("nacos", "localhost", "")
 	remote_viper.SetConfigType("yaml")
-
 	err = remote_viper.ReadRemoteConfig()
-	if err == nil {
+
-		err = remote_viper.WatchRemoteConfigOnChannel()
 	if err == nil {
 		config_viper = remote_viper
 		fmt.Println("used remote viper")
+		provider := remote.NewRemoteProvider("yaml")
+		respChan := provider.WatchRemoteConfigOnChannel(config_viper)
+
+		go func(rc <-chan bool) {
+			for {
+				<-rc
+				fmt.Printf("remote async: %s", config_viper.GetString("yoyogo.application.name"))
 			}
+		}(respChan)
+
 	}
 
 	appName := config_viper.GetString("yoyogo.application.name")
@@ -50,7 +57,7 @@ func main() {
 		for {
 			time.Sleep(time.Second * 30) // delay after each request
 			appName = config_viper.GetString("yoyogo.application.name")
-			fmt.Println(appName)
+			fmt.Println("sync:" + appName)
 		}
 	}()
 

example_config.yaml

@@ -18,3 +18,8 @@ yoyogo:
           enable: true
           username: "root"
           password: "1234"
+          endpoint: ""
+          regionId: ""
+          accessKey: ""
+          secretKey: ""
+          openKMS: false

go.mod

@@ -3,6 +3,6 @@ module github.com/yoyofxteam/nacos-viper-remote
 go 1.14
 
 require (
-	github.com/spf13/viper v1.7.1
 	github.com/nacos-group/nacos-sdk-go v1.0.7
+	github.com/spf13/viper v1.8.1
 )

nacos_manager.go

@@ -34,9 +34,15 @@ func NewNacosConfigManager(option *Option) (*nacosConfigManager, error) {
 		MaxAge:              3,
 		LogLevel:            "info",
 	}
+
 	if option.Auth != nil && option.Auth.Enable {
 		clientConfig.Username = option.Auth.User
 		clientConfig.Password = option.Auth.Password
+		clientConfig.Endpoint = option.Auth.Endpoint
+		clientConfig.RegionId = option.Auth.RegionId
+		clientConfig.AccessKey = option.Auth.AccessKey
+		clientConfig.SecretKey = option.Auth.SecretKey
+		clientConfig.OpenKMS = option.Auth.OpenKMS
 	}
 	client, err := clients.CreateConfigClient(map[string]interface{}{
 		"serverConfigs": serverConfigs,

nacos_options.go

@@ -17,4 +17,15 @@ type Auth struct {
 	Enable   bool   `mapstructure:"enable"`
 	User     string `mapstructure:"username"`
 	Password string `mapstructure:"password"`
+
+	// ACM Endpoint
+	Endpoint string `mapstructure:"endpoint"`
+	// ACM RegionId
+	RegionId string `mapstructure:"regionId"`
+	// ACM AccessKey
+	AccessKey string `mapstructure:"accessKey"`
+	// ACM SecretKey
+	SecretKey string `mapstructure:"secretKey"`
+	// ACM OpenKMS
+	OpenKMS bool `mapstructure:"openKMS"`
 }

nacosprovider.go

@@ -0,0 +1,28 @@
+package nacos_viper_remote
+
+type nacosRemoteProvider struct {
+	provider      string
+	endpoint      string
+	path          string
+	secretKeyring string
+}
+
+func DefaultRemoteProvider() *nacosRemoteProvider {
+	return &nacosRemoteProvider{provider: "nacos", endpoint: "localhost", path: "", secretKeyring: ""}
+}
+
+func (rp nacosRemoteProvider) Provider() string {
+	return rp.provider
+}
+
+func (rp nacosRemoteProvider) Endpoint() string {
+	return rp.endpoint
+}
+
+func (rp nacosRemoteProvider) Path() string {
+	return rp.path
+}
+
+func (rp nacosRemoteProvider) SecretKeyring() string {
+	return rp.secretKeyring
+}

viper_remote.go

@@ -7,17 +7,20 @@ import (
 	"io"
 )
 
-var nacosOptions = &Option{}
+//var nacosOptions = &Option{}
 
 func SetOptions(option *Option) {
-	nacosOptions = option
+	manager, _ := NewNacosConfigManager(option)
+	viper.SupportedRemoteProviders = []string{"nacos"}
+	viper.RemoteConfig = &remoteConfigProvider{ConfigManager: manager}
 }
 
 type remoteConfigProvider struct {
+	ConfigManager *nacosConfigManager
 }
 
 func (rc *remoteConfigProvider) Get(rp viper.RemoteProvider) (io.Reader, error) {
-	cmt, err := getConfigManager(rp)
+	cmt, err := rc.getConfigManager(rp)
 	if err != nil {
 		return nil, err
 	}
@@ -37,7 +40,7 @@ func (rc *remoteConfigProvider) Watch(rp viper.RemoteProvider) (io.Reader, error
 }
 
 func (rc *remoteConfigProvider) WatchChannel(rp viper.RemoteProvider) (<-chan *viper.RemoteResponse, chan bool) {
-	cmt, err := getConfigManager(rp)
+	cmt, err := rc.getConfigManager(rp)
 	if err != nil {
 		return nil, nil
 	}
@@ -52,15 +55,10 @@ func (rc *remoteConfigProvider) WatchChannel(rp viper.RemoteProvider) (<-chan *v
 	return nil, nil
 }
 
-func getConfigManager(rp viper.RemoteProvider) (interface{}, error) {
+func (rc *remoteConfigProvider) getConfigManager(rp viper.RemoteProvider) (interface{}, error) {
 	if rp.Provider() == "nacos" {
-		return NewNacosConfigManager(nacosOptions)
+		return rc.ConfigManager, nil
 	} else {
 		return nil, errors.New("The Nacos configuration manager is not supported!")
 	}
 }
-
-func init() {
-	viper.SupportedRemoteProviders = []string{"nacos"}
-	viper.RemoteConfig = &remoteConfigProvider{}
-}