feat: support nacos configstore component (level1)

cmd/layotto/main.go

@@ -65,6 +65,7 @@ import (
 	"mosn.io/pkg/log"
 
 	"mosn.io/layotto/components/configstores/etcdv3"
+	"mosn.io/layotto/components/configstores/nacos"
 	"mosn.io/layotto/components/file"
 	"mosn.io/layotto/components/sequencer"
 	"mosn.io/layotto/pkg/runtime/bindings"
@@ -278,6 +279,7 @@ func NewRuntimeGrpcServer(data json.RawMessage, opts ...grpc.ServerOption) (mgrp
 		runtime.WithConfigStoresFactory(
 			configstores.NewStoreFactory("apollo", apollo.NewStore),
 			configstores.NewStoreFactory("etcd", etcdv3.NewStore),
+			configstores.NewStoreFactory("nacos", nacos.NewStore),
 		),
 
 		// RPC

cmd/layotto_multiple_api/main.go

@@ -85,6 +85,7 @@ import (
 	// Configuration
 	"mosn.io/layotto/components/configstores"
 	"mosn.io/layotto/components/configstores/apollo"
+	"mosn.io/layotto/components/configstores/nacos"
 
 	// Pub/Sub
 	dapr_comp_pubsub "github.com/dapr/components-contrib/pubsub"
@@ -288,6 +289,7 @@ func NewRuntimeGrpcServer(data json.RawMessage, opts ...grpc.ServerOption) (mgrp
 		runtime.WithConfigStoresFactory(
 			configstores.NewStoreFactory("apollo", apollo.NewStore),
 			configstores.NewStoreFactory("etcd", etcdv3.NewStore),
+			configstores.NewStoreFactory("nacos", nacos.NewStore),
 		),
 
 		// RPC

cmd/layotto_without_xds/main.go

@@ -63,6 +63,7 @@ import (
 	"mosn.io/pkg/log"
 
 	"mosn.io/layotto/components/configstores/etcdv3"
+	"mosn.io/layotto/components/configstores/nacos"
 	"mosn.io/layotto/components/file"
 	"mosn.io/layotto/components/sequencer"
 	"mosn.io/layotto/pkg/runtime/bindings"
@@ -261,6 +262,7 @@ func NewRuntimeGrpcServer(data json.RawMessage, opts ...grpc.ServerOption) (mgrp
 		runtime.WithConfigStoresFactory(
 			configstores.NewStoreFactory("apollo", apollo.NewStore),
 			configstores.NewStoreFactory("etcd", etcdv3.NewStore),
+			configstores.NewStoreFactory("nacos", nacos.NewStore),
 		),
 
 		// RPC

components/configstores/nacos/change_listener.go

@@ -0,0 +1,57 @@
+// Copyright 2021 Layotto Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package nacos
+
+import "sync"
+
+// store the group and keys that client subscribe
+type subscriberHolder struct {
+	rw     sync.RWMutex
+	keyMap map[subscriberKey]struct{}
+}
+
+type subscriberKey struct {
+	group string
+	key   string
+}
+
+func newSubscriberHolder() *subscriberHolder {
+	return &subscriberHolder{
+		keyMap: make(map[subscriberKey]struct{}),
+	}
+}
+
+func (s *subscriberHolder) AddSubscriberKey(key subscriberKey) {
+	s.rw.Lock()
+	defer s.rw.Unlock()
+	s.keyMap[key] = struct{}{}
+}
+
+func (s *subscriberHolder) RemoveSubscriberKey(key subscriberKey) {
+	s.rw.Lock()
+	defer s.rw.Unlock()
+	delete(s.keyMap, key)
+}
+
+func (s *subscriberHolder) GetSubscriberKey() []subscriberKey {
+	s.rw.RLock()
+	defer s.rw.RUnlock()
+
+	res := make([]subscriberKey, 0, len(s.keyMap))
+	for k := range s.keyMap {
+		res = append(res, k)
+	}
+
+	return res
+}

components/configstores/nacos/change_listener_test.go

@@ -0,0 +1,61 @@
+// Copyright 2021 Layotto Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package nacos
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_newSubscriberHolder(t *testing.T) {
+	listener := newSubscriberHolder()
+	assert.NotNil(t, listener)
+	assert.NotNil(t, listener.keyMap)
+}
+
+func Test_subscriberHolder_AddSubscriberKey(t *testing.T) {
+	listener := newSubscriberHolder()
+	key := subscriberKey{key: "test-key", group: "test-group"}
+	listener.AddSubscriberKey(key)
+	s, ok := listener.keyMap[key]
+	assert.True(t, ok)
+	assert.EqualValues(t, struct{}{}, s)
+}
+
+func Test_subscriberHolder_GetSubscriberKey(t *testing.T) {
+	listener := newSubscriberHolder()
+	key := subscriberKey{key: "test-key", group: "test-group"}
+	listener.AddSubscriberKey(key)
+	getSubscriberKey := listener.GetSubscriberKey()
+	assert.EqualValues(t, 1, len(getSubscriberKey))
+	assert.EqualValues(t, key, getSubscriberKey[0])
+
+	key2 := subscriberKey{key: "test-key2", group: "test-group2"}
+	listener.AddSubscriberKey(key2)
+	getSubscriberKey = listener.GetSubscriberKey()
+	// Due to the use of go map results, the return order of map traversal
+	// cannot be determined, so the testing here haven't test the key2's value.
+	assert.Equal(t, 2, len(getSubscriberKey))
+}
+
+func Test_subscriberHolder_RemoveSubscriberKey(t *testing.T) {
+	listener := newSubscriberHolder()
+	key := subscriberKey{key: "test-key", group: "test-group"}
+	listener.AddSubscriberKey(key)
+	assert.EqualValues(t, 1, len(listener.keyMap))
+
+	listener.RemoveSubscriberKey(key)
+	assert.Equal(t, 0, len(listener.keyMap))
+}

components/configstores/nacos/client.go

@@ -0,0 +1,65 @@
+// Copyright 2021 Layotto Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package nacos
+
+import (
+	"github.com/nacos-group/nacos-sdk-go/v2/model"
+	"github.com/nacos-group/nacos-sdk-go/v2/vo"
+)
+
+type Client interface {
+	// GetConfig use to get config from nacos server
+	// dataId  require
+	// group   require
+	// tenant ==>nacos.namespace optional
+	GetConfig(param vo.ConfigParam) (string, error)
+
+	// PublishConfig use to publish config to nacos server
+	// dataId  require
+	// group   require
+	// content require
+	// tenant ==>nacos.namespace optional
+	PublishConfig(param vo.ConfigParam) (bool, error)
+
+	// DeleteConfig use to delete config
+	// dataId  require
+	// group   require
+	// tenant ==>nacos.namespace optional
+	DeleteConfig(param vo.ConfigParam) (bool, error)
+
+	// ListenConfig use to listen config change,it will callback OnChange() when config change
+	// dataId  require
+	// group   require
+	// onchange require
+	// tenant ==>nacos.namespace optional
+	ListenConfig(params vo.ConfigParam) (err error)
+
+	//CancelListenConfig use to cancel listen config change
+	// dataId  require
+	// group   require
+	// tenant ==>nacos.namespace optional
+	CancelListenConfig(params vo.ConfigParam) (err error)
+
+	// SearchConfig use to search nacos config
+	// search  require search=accurate--精确搜索  search=blur--模糊搜索
+	// group   option
+	// dataId  option
+	// tenant ==>nacos.namespace optional
+	// pageNo  option,default is 1
+	// pageSize option,default is 10
+	SearchConfig(param vo.SearchConfigParam) (*model.ConfigPage, error)
+
+	// CloseClient Close the GRPC client
+	CloseClient()
+}

components/configstores/nacos/config.go

@@ -0,0 +1,88 @@
+// Copyright 2021 Layotto Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package nacos
+
+// map keys
+const (
+	namespaceIdKey = "namespace_id"
+	appNameKey     = "app_name"
+	userNameKey    = "username"
+	passwordKey    = "password"
+	endPointKey    = "end_point"
+	regionIdKey    = "region_id"
+	accessKey      = "access_key"
+	secretKey      = "secret_key"
+)
+
+type Metadata struct {
+	AppName     string
+	NameSpaceId string
+	Username    string
+	Password    string
+	// ACM & KMS
+	Endpoint  string
+	RegionId  string
+	AccessKey string
+	SecretKey string
+	OpenKMS   bool
+}
+
+func ParseNacosMetadata(properties map[string]string) (*Metadata, error) {
+	if properties == nil {
+		return nil, errConfigMissingField("metadata")
+	}
+
+	config := &Metadata{}
+	config.AppName = properties[appNameKey]
+	if config.AppName == "" {
+		return nil, errConfigMissingField(appNameKey)
+	}
+
+	// the namespace of config, not required
+	config.NameSpaceId = properties[namespaceIdKey]
+	if config.NameSpaceId == "" {
+		config.NameSpaceId = defaultNamespaceId
+	}
+
+	if v, ok := properties[userNameKey]; ok && v != "" {
+		config.Username = v
+	}
+
+	if v, ok := properties[passwordKey]; ok && v != "" {
+		config.Password = v
+	}
+
+	// ACM & KMS
+	if v, ok := properties[endPointKey]; ok && v != "" {
+		config.Endpoint = v
+		config.OpenKMS = true
+	}
+
+	if v, ok := properties[regionIdKey]; ok && v != "" {
+		config.RegionId = v
+		config.OpenKMS = true
+	}
+
+	if v, ok := properties[accessKey]; ok && v != "" {
+		config.AccessKey = v
+		config.OpenKMS = true
+	}
+
+	if v, ok := properties[secretKey]; ok && v != "" {
+		config.SecretKey = v
+		config.OpenKMS = true
+	}
+
+	return config, nil
+}

components/configstores/nacos/config_test.go

@@ -0,0 +1,45 @@
+// Copyright 2021 Layotto Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package nacos
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseNacosMetadata(t *testing.T) {
+	// without metadata
+	_, err := ParseNacosMetadata(nil)
+	assert.Error(t, err)
+
+	properties := make(map[string]string)
+	// without app_name
+	_, err = ParseNacosMetadata(properties)
+	assert.Error(t, err)
+
+	// success
+	appName := "app"
+	properties[appNameKey] = appName
+	metadata, err := ParseNacosMetadata(properties)
+	assert.Nil(t, err)
+	assert.EqualValues(t, appName, metadata.AppName)
+
+	// test set namespace
+	namespaceId := "namespace"
+	properties[namespaceIdKey] = namespaceId
+	metadata, err = ParseNacosMetadata(properties)
+	assert.Nil(t, err)
+	assert.Equal(t, namespaceId, metadata.NameSpaceId)
+}