feat:add consul && client && server &&config watch

.github/workflows/tests.yml

@@ -6,7 +6,7 @@ jobs:
   unit-benchmark-test:
     strategy:
       matrix:
-        go: [ 1.17, 1.18, 1.19 ]
+        go: [ 1.19 ]
         os: [ X64, ARM64 ]
     runs-on: ${{ matrix.os }}
     steps:

client/circult_breaker.go

@@ -0,0 +1,109 @@
+// Copyright 2024 CloudWeGo 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 client
+
+import (
+	"config-consul/consul"
+	"config-consul/utils"
+	"strings"
+
+	"github.com/cloudwego/kitex/client"
+	"github.com/cloudwego/kitex/pkg/circuitbreak"
+	"github.com/cloudwego/kitex/pkg/klog"
+	"github.com/cloudwego/kitex/pkg/rpcinfo"
+)
+
+// WithCircuitBreaker sets the circuit breaker policy from consul configuration center.
+func WithCircuitBreaker(dest, src string, consulClient consul.Client, uniqueID int64, opts utils.Options) []client.Option {
+	param, err := consulClient.ClientConfigParam(&consul.ConfigParamConfig{
+		Category:          circuitBreakerConfigName,
+		ServerServiceName: dest,
+		ClientServiceName: src,
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	for _, f := range opts.ConsulCustomFunctions {
+		f(&param)
+	}
+	key := param.Prefix + "/" + param.Path
+	cbSuite := initCircuitBreaker(param.Type, key, dest, src, consulClient, uniqueID)
+
+	return []client.Option{
+		client.WithCircuitBreaker(cbSuite),
+		client.WithCloseCallbacks(func() error {
+			// cancel the configuration listener when client is closed.
+			consulClient.DeregisterConfig(key, uniqueID)
+			err = cbSuite.Close()
+			if err != nil {
+				return err
+			}
+			return nil
+		}),
+	}
+}
+
+// keep consistent when initialising the circuit breaker suit and updating
+// the circuit breaker policy.
+func genServiceCBKeyWithRPCInfo(ri rpcinfo.RPCInfo) string {
+	if ri == nil {
+		return ""
+	}
+	return genServiceCBKey(ri.To().ServiceName(), ri.To().Method())
+}
+
+func genServiceCBKey(toService, method string) string {
+	sum := len(toService) + len(method) + 2
+	var buf strings.Builder
+	buf.Grow(sum)
+	buf.WriteString(toService)
+	buf.WriteByte('/')
+	buf.WriteString(method)
+	return buf.String()
+}
+
+func initCircuitBreaker(kind consul.ConfigType, key, dest, src string,
+	consulClient consul.Client, uniqueID int64,
+) *circuitbreak.CBSuite {
+	cb := circuitbreak.NewCBSuite(genServiceCBKeyWithRPCInfo)
+	lcb := utils.ThreadSafeSet{}
+
+	onChangeCallback := func(data string, parser consul.ConfigParser) {
+		set := utils.Set{}
+		configs := map[string]circuitbreak.CBConfig{}
+		err := parser.Decode(kind, data, &configs)
+		if err != nil {
+			klog.Warnf("[consul] %s client consul circuit breaker: unmarshal data %s failed: %s, skip...", key, data, err)
+			return
+		}
+
+		for method, config := range configs {
+			set[method] = true
+			key := genServiceCBKey(dest, method)
+			cb.UpdateServiceCBConfig(key, config)
+		}
+
+		for _, method := range lcb.DiffAndEmplace(set) {
+			key := genServiceCBKey(dest, method)
+			// For deleted method configs, set to default policy
+			cb.UpdateServiceCBConfig(key, circuitbreak.GetDefaultCBConfig())
+		}
+	}
+
+	consulClient.RegisterConfigCallback(key, uniqueID, onChangeCallback)
+
+	return cb
+}

client/retry.go

@@ -0,0 +1,87 @@
+// Copyright 2024 CloudWeGo 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 client
+
+import (
+	"config-consul/consul"
+	"config-consul/utils"
+
+	"github.com/cloudwego/kitex/client"
+	"github.com/cloudwego/kitex/pkg/klog"
+	"github.com/cloudwego/kitex/pkg/retry"
+)
+
+// WithRetryPolicy sets the retry policy from consul configuration center.
+func WithRetryPolicy(dest, src string, consulClient consul.Client, uniqueID int64, opts utils.Options) []client.Option {
+	param, err := consulClient.ClientConfigParam(&consul.ConfigParamConfig{
+		Category:          retryConfigName,
+		ServerServiceName: dest,
+		ClientServiceName: src,
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	for _, f := range opts.ConsulCustomFunctions {
+		f(&param)
+	}
+	key := param.Prefix + "/" + param.Path
+	rc := initRetryContainer(param.Type, key, dest, consulClient, uniqueID)
+	return []client.Option{
+		client.WithRetryContainer(rc),
+		client.WithCloseCallbacks(func() error {
+			// cancel the configuration listener when client is closed.
+			consulClient.DeregisterConfig(key, uniqueID)
+			return nil
+		}),
+		client.WithCloseCallbacks(rc.Close),
+	}
+}
+
+func initRetryContainer(kind consul.ConfigType, key, dest string,
+	consulClient consul.Client, uniqueID int64,
+) *retry.Container {
+	retryContainer := retry.NewRetryContainerWithPercentageLimit()
+
+	ts := utils.ThreadSafeSet{}
+
+	onChangeCallback := func(data string, parser consul.ConfigParser) {
+		// the key is method name, wildcard "*" can match anything.
+		rcs := map[string]*retry.Policy{}
+		err := parser.Decode(kind, data, &rcs)
+		if err != nil {
+			klog.Warnf("[consul] %s client consul retry: unmarshal data %s failed: %s, skip...", key, data, err)
+			return
+		}
+		set := utils.Set{}
+		for method, policy := range rcs {
+			set[method] = true
+			if policy.Enable && policy.BackupPolicy == nil && policy.FailurePolicy == nil {
+				klog.Warnf("[consul] %s client policy for method %s BackupPolicy and FailurePolicy must not be empty at same time",
+					dest, method)
+				continue
+			}
+			retryContainer.NotifyPolicyChange(method, *policy)
+		}
+
+		for _, method := range ts.DiffAndEmplace(set) {
+			retryContainer.DeletePolicy(method)
+		}
+	}
+
+	consulClient.RegisterConfigCallback(key, uniqueID, onChangeCallback)
+
+	return retryContainer
+}

client/rpc_timeout.go

@@ -0,0 +1,71 @@
+// Copyright 2024 CloudWeGo 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 client
+
+import (
+	"config-consul/consul"
+	"config-consul/utils"
+
+	"github.com/cloudwego/kitex/client"
+	"github.com/cloudwego/kitex/pkg/klog"
+	"github.com/cloudwego/kitex/pkg/rpcinfo"
+	"github.com/cloudwego/kitex/pkg/rpctimeout"
+)
+
+// WithRPCTimeout sets the RPC timeout policy from consul configuration center.
+func WithRPCTimeout(dest, src string, consulClient consul.Client, uniqueID int64, opts utils.Options) []client.Option {
+	param, err := consulClient.ClientConfigParam(&consul.ConfigParamConfig{
+		Category:          rpcTimeoutConfigName,
+		ServerServiceName: dest,
+		ClientServiceName: src,
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	for _, f := range opts.ConsulCustomFunctions {
+		f(&param)
+	}
+	key := param.Prefix + "/" + param.Path
+	return []client.Option{
+		client.WithTimeoutProvider(initRPCTimeoutContainer(param.Type, key, dest, consulClient, uniqueID)),
+		client.WithCloseCallbacks(func() error {
+			// cancel the configuration listener when client is closed.
+			consulClient.DeregisterConfig(key, uniqueID)
+			return nil
+		}),
+	}
+}
+
+func initRPCTimeoutContainer(kind consul.ConfigType, key, dest string,
+	consulClient consul.Client, uniqueID int64,
+) rpcinfo.TimeoutProvider {
+	rpcTimeoutContainer := rpctimeout.NewContainer()
+
+	onChangeCallback := func(data string, parser consul.ConfigParser) {
+		configs := map[string]*rpctimeout.RPCTimeout{}
+		err := parser.Decode(kind, data, &configs)
+		if err != nil {
+			klog.Warnf("[consul] %s client consul rpc timeout: unmarshal data %s failed: %s, skip...", key, data, err)
+			return
+		}
+
+		rpcTimeoutContainer.NotifyPolicyChange(configs)
+	}
+
+	consulClient.RegisterConfigCallback(key, uniqueID, onChangeCallback)
+
+	return rpcTimeoutContainer
+}

client/suite.go

@@ -0,0 +1,63 @@
+// Copyright 2024 CloudWeGo 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 client
+
+import (
+	"config-consul/consul"
+	"config-consul/utils"
+
+	"github.com/cloudwego/kitex/client"
+)
+
+const (
+	retryConfigName          = "retry"
+	rpcTimeoutConfigName     = "rpc_timeout"
+	circuitBreakerConfigName = "circuit_break"
+)
+
+type ConsulClientSuite struct {
+	uid          int64
+	consulClient consul.Client
+	service      string
+	client       string
+	opts         utils.Options
+}
+
+// NewSuite service is the destination service name and client is the local identity.
+func NewSuite(service, client string, cli consul.Client,
+	opts ...utils.Option,
+) *ConsulClientSuite {
+	uid := consul.AllocateUniqueID()
+	su := &ConsulClientSuite{
+		uid:          uid,
+		service:      service,
+		client:       client,
+		consulClient: cli,
+	}
+	for _, opt := range opts {
+		opt.Apply(&su.opts)
+	}
+
+	return su
+}
+
+// Options return a list client.Option
+func (s *ConsulClientSuite) Options() []client.Option {
+	opts := make([]client.Option, 0, 7)
+	opts = append(opts, WithCircuitBreaker(s.service, s.client, s.consulClient, s.uid, s.opts)...)
+	opts = append(opts, WithRetryPolicy(s.service, s.client, s.consulClient, s.uid, s.opts)...)
+	opts = append(opts, WithRPCTimeout(s.service, s.client, s.consulClient, s.uid, s.opts)...)
+	return opts
+}