Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nacos datasource #184

Merged
merged 19 commits into from
Jul 22, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions ext/datasource/nacos/nacos.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
package nacos

import (
"fmt"

"github.com/alibaba/sentinel-golang/ext/datasource"
"github.com/alibaba/sentinel-golang/logging"
"github.com/alibaba/sentinel-golang/util"
"github.com/nacos-group/nacos-sdk-go/clients/config_client"
"github.com/nacos-group/nacos-sdk-go/vo"
"github.com/pkg/errors"
)

var (
logger = logging.GetDefaultLogger()
)

type NacosDataSource struct {
datasource.Base
client config_client.IConfigClient
isInitialized util.AtomicBool
group string
dataId string
closeChan chan struct{}
}

func NewNacosDataSource(client config_client.IConfigClient, group, dataId string, handlers ...datasource.PropertyHandler) (*NacosDataSource, error) {
if client == nil {
return nil, errors.New("Nil nacos config client")
}
if len(group) == 0 || len(dataId) == 0 {
return nil, errors.New(fmt.Sprintf("Invalid parameters, group: %s, dataId: %s", group, dataId))
}
var ds = &NacosDataSource{
Base: datasource.Base{},
client: client,
group: group,
dataId: dataId,
closeChan: make(chan struct{}, 1),
}
for _, h := range handlers {
ds.AddPropertyHandler(h)
}
return ds, nil
}

func (s *NacosDataSource) Initialize() error {
if !s.isInitialized.CompareAndSet(false, true) {
return nil
}
data, err := s.ReadSource()
if err != nil {
return err
}
if err = s.doUpdate(data); err != nil {
return err
}
err = s.listen(s.client)
if err == nil {
logger.Infof("Nacos data source is successfully initialized, group: %s, dataId: %s", s.group, s.dataId)
}
return err
}

func (s *NacosDataSource) ReadSource() ([]byte, error) {
content, err := s.client.GetConfig(vo.ConfigParam{
DataId: s.group,
Group: s.dataId,
})
if err != nil {
return nil, errors.Errorf("Failed to read the nacos data source when initialization, err: %+v", err)
}

logger.Infof("Succeed to read source for group: %s, dataId: %s, data: %s", s.group, s.dataId, content)
return []byte(content), err
}

func (s *NacosDataSource) doUpdate(data []byte) error {
return s.Handle(data)
}

func (s *NacosDataSource) listen(client config_client.IConfigClient) (err error) {
listener := vo.ConfigParam{
DataId: s.dataId,
Group: s.group,
OnChange: func(namespace, group, dataId, data string) {
logger.Infof("Receive listened property. namespace: %s, group: %s, dataId: %s, data: %s", namespace, group, dataId, data)
err := s.doUpdate([]byte(data))
if err != nil {
logger.Errorf("Fail to update data source, err: %+v", err)
}
},
ListenCloseChan: s.closeChan,
}
err = client.ListenConfig(listener)
if err != nil {
return errors.Errorf("Failed to listen to the nacos data source, err: %+v", err)
}
return nil
}

func (s *NacosDataSource) Close() error {
s.closeChan <- struct{}{}
logger.Infof("The nacos datasource had been closed, group: %s, dataId: %s", s.group, s.dataId)
return nil
}
60 changes: 60 additions & 0 deletions ext/datasource/nacos/nacos_example.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package nacos

import (
"fmt"
"time"

"github.com/alibaba/sentinel-golang/ext/datasource"
"github.com/nacos-group/nacos-sdk-go/clients/config_client"
"github.com/nacos-group/nacos-sdk-go/clients/nacos_client"
"github.com/nacos-group/nacos-sdk-go/common/constant"
"github.com/nacos-group/nacos-sdk-go/common/http_agent"
"github.com/stretchr/testify/mock"
)

var serverConfig = constant.ServerConfig{
ContextPath: "/nacos",
Port: 8848,
IpAddr: "127.0.0.1",
}

var clientConfigTest = constant.ClientConfig{
BeatInterval: 10000,
TimeoutMs: 10000,
ListenInterval: 20000,
}

func createConfigClientTest() (*config_client.ConfigClient, error) {
nc := nacos_client.NacosClient{}
err := nc.SetServerConfig([]constant.ServerConfig{serverConfig})
err = nc.SetClientConfig(clientConfigTest)
err = nc.SetHttpAgent(&http_agent.HttpAgent{})
client, err := config_client.NewConfigClient(&nc)

return &client, err
}

func Example_NacosDatasource_CustomizeClient() {
client, err := createConfigClientTest()
if err != nil {
fmt.Printf("Fail to create client, err: %+v", err)
return
}
h := &datasource.MockPropertyHandler{}
h.On("isPropertyConsistent", mock.Anything).Return(true)
h.On("Handle", mock.Anything).Return(nil)
nds, err := NewNacosDataSource(client, "sentinel-go", "system-rules", h)
if err != nil {
fmt.Printf("Fail to create nacos data source client, err: %+v", err)
return
}
err = nds.Initialize()
if err != nil {
fmt.Printf("Fail to initialize nacos data source client, err: %+v", err)
return
}

time.Sleep(time.Second * 10)
nds.Close()
fmt.Println("Nacos datasource is Closed")
}
99 changes: 99 additions & 0 deletions ext/datasource/nacos/nacos_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
package nacos

import (
"testing"

"github.com/nacos-group/nacos-sdk-go/clients/config_client"

"github.com/alibaba/sentinel-golang/ext/datasource"
"github.com/stretchr/testify/assert"

"github.com/nacos-group/nacos-sdk-go/model"
"github.com/nacos-group/nacos-sdk-go/vo"
"github.com/stretchr/testify/mock"
)

const (
TestSystemRules = `[
{
"id": 0,
"metricType": 0,
"adaptiveStrategy": 0
},
{
"id": 1,
"metricType": 0,
"adaptiveStrategy": 0
},
{
"id": 2,
"metricType": 0,
"adaptiveStrategy": 0
}
]`
)

var (
Group = "sentinel-go"
DataId = "system-rules"
)

type nacosClientMock struct {
mock.Mock
}

func (n *nacosClientMock) GetConfig(param vo.ConfigParam) (string, error) {
ret := n.Called(param)
return ret.String(0), ret.Error(1)
}

func (n *nacosClientMock) PublishConfig(param vo.ConfigParam) (bool, error) {
ret := n.Called(param)
return ret.Bool(0), ret.Error(1)
}

func (n *nacosClientMock) DeleteConfig(param vo.ConfigParam) (bool, error) {
ret := n.Called(param)
return ret.Bool(0), ret.Error(1)
}

func (n *nacosClientMock) ListenConfig(params vo.ConfigParam) (err error) {
ret := n.Called(params)
return ret.Error(0)
}
func (n *nacosClientMock) SearchConfig(param vo.SearchConfigParm) (*model.ConfigPage, error) {
ret := n.Called(param)
return ret.Get(0).(*model.ConfigPage), ret.Error(1)
}

func getNacosDataSource(client config_client.IConfigClient) (*NacosDataSource, error) {
mh1 := &datasource.MockPropertyHandler{}
mh1.On("Handle", mock.Anything).Return(nil)
mh1.On("isPropertyConsistent", mock.Anything).Return(false)
nds, err := NewNacosDataSource(client, Group, DataId, mh1)

return nds, err
}

func TestNacosDataSource(t *testing.T) {

t.Run("NewNacosDataSource", func(t *testing.T) {
client, err := createConfigClientTest()
assert.Nil(t, err)
nds, err := getNacosDataSource(client)
assert.True(t, nds != nil && err == nil)
})

t.Run("NacosDataSource_Initialize", func(t *testing.T) {
mh1 := &datasource.MockPropertyHandler{}
mh1.On("Handle", mock.Anything).Return(nil)
mh1.On("isPropertyConsistent", mock.Anything).Return(false)
nacosClientMock := new(nacosClientMock)
nacosClientMock.On("GetConfig", mock.Anything).Return(TestSystemRules, nil)
nacosClientMock.On("ListenConfig", mock.Anything).Return(nil)
nds, err := getNacosDataSource(nacosClientMock)
assert.True(t, nds != nil && err == nil)
err = nds.Initialize()
assert.True(t, err == nil)
})
}
9 changes: 5 additions & 4 deletions go.mod
Original file line number Diff line number Diff line change
@@ -4,20 +4,21 @@ go 1.13

require (
github.com/StackExchange/wmi v0.0.0-20190523213315-cbe66965904d // indirect
github.com/apache/dubbo-go v0.1.2-0.20200224151332-dd1a3c24d656
github.com/apache/dubbo-go v1.4.2
github.com/coreos/etcd v3.3.13+incompatible
github.com/fsnotify/fsnotify v1.4.7
github.com/gin-gonic/gin v1.5.0
github.com/go-ole/go-ole v1.2.4 // indirect
github.com/google/uuid v1.1.1
github.com/hashicorp/consul/api v1.4.0
github.com/labstack/echo/v4 v4.1.15
github.com/pkg/errors v0.8.1
github.com/nacos-group/nacos-sdk-go v0.4.0
github.com/pkg/errors v0.9.1
github.com/shirou/gopsutil v2.19.12+incompatible
github.com/stretchr/testify v1.4.0
github.com/stretchr/testify v1.5.1
github.com/tidwall/gjson v1.6.0
go.uber.org/multierr v1.5.0
golang.org/x/tools v0.0.0-20200426102838-f3a5411a4c3b // indirect
google.golang.org/grpc v1.22.1
github.com/tidwall/gjson v1.6.0
gopkg.in/yaml.v2 v2.2.8
)
118 changes: 107 additions & 11 deletions go.sum

Large diffs are not rendered by default.