Add unit test and docs

README.md

@@ -274,6 +274,7 @@ The echo method uses the following configuration (0.3, 100) and other methods us
 
 | Variable   | Introduction                       |
 |------------|------------------------------------|
+| enable     | Whether to enable degradation      |
 | percentage | The percentage of dropped requests | 
 
 Example：

README_CN.md

@@ -272,9 +272,10 @@ echo 方法使用下面的配置（0.3、100），其他方法使用全局默认
 
 [JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/circuitbreak/item_circuit_breaker.go#L30)
 
-| 参数         | 说明      |
-|------------|---------|
-| percentage | 丢弃请求的比例 | 
+| 参数         | 说明       |
+|------------|----------|
+| enable     | 是否开启降级策略 |
+| percentage | 丢弃请求的比例  | 
 
 例子：
 

client/circuit_breaker.go

@@ -18,14 +18,13 @@ import (
 	"context"
 	"strings"
 
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
-
 	"github.com/cloudwego/kitex/pkg/klog"
 
 	"github.com/cloudwego/kitex/client"
 	"github.com/cloudwego/kitex/pkg/circuitbreak"
 	"github.com/cloudwego/kitex/pkg/rpcinfo"
 	"github.com/kitex-contrib/config-etcd/etcd"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 // WithCircuitBreaker sets the circuit breaker policy from etcd configuration center.

client/degradation.go

@@ -21,7 +21,7 @@ import (
 	"github.com/cloudwego/kitex/pkg/klog"
 	"github.com/kitex-contrib/config-etcd/etcd"
 	"github.com/kitex-contrib/config-etcd/pkg/degradation"
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 func WithDegradation(dest, src string, etcdClient etcd.Client, uniqueID int64, opts utils.Options) []client.Option {

client/retry.go

@@ -17,12 +17,11 @@ package client
 import (
 	"context"
 
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
-
 	"github.com/cloudwego/kitex/client"
 	"github.com/cloudwego/kitex/pkg/klog"
 	"github.com/cloudwego/kitex/pkg/retry"
 	"github.com/kitex-contrib/config-etcd/etcd"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 // WithRetryPolicy sets the retry policy from etcd configuration center.

client/rpc_timeout.go

@@ -17,13 +17,12 @@ package client
 import (
 	"context"
 
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
-
 	"github.com/cloudwego/kitex/client"
 	"github.com/cloudwego/kitex/pkg/klog"
 	"github.com/cloudwego/kitex/pkg/rpcinfo"
 	"github.com/cloudwego/kitex/pkg/rpctimeout"
 	"github.com/kitex-contrib/config-etcd/etcd"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 // WithRPCTimeout sets the RPC timeout policy from etcd configuration center.

client/suite.go

@@ -17,7 +17,7 @@ package client
 import (
 	"github.com/cloudwego/kitex/client"
 	"github.com/kitex-contrib/config-etcd/etcd"
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 const (

example/client/main.go

@@ -25,7 +25,7 @@ import (
 	"github.com/cloudwego/kitex/pkg/klog"
 	etcdclient "github.com/kitex-contrib/config-etcd/client"
 	"github.com/kitex-contrib/config-etcd/etcd"
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 type configLog struct{}

pkg/degradation/degradation_test.go

@@ -0,0 +1,37 @@
+// Copyright 2023 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 degradation
+
+import (
+	"context"
+	"errors"
+	"github.com/cloudwego/kitex/pkg/kerrors"
+	"github.com/cloudwego/thriftgo/pkg/test"
+	"testing"
+)
+
+var errFake = errors.New("fake error")
+
+func invoke(ctx context.Context, request, response interface{}) error {
+	return errFake
+}
+
+func TestNewDegradationMiddleware(t *testing.T) {
+	container := NewContainer()
+	degradationMiddleware := NewDegradationMiddleware(container)
+	test.Assert(t, errors.Is(degradationMiddleware(invoke)(context.Background(), nil, nil), errFake))
+	container.NotifyPolicyChange(&Config{Enable: true, Percentage: 100})
+	test.Assert(t, errors.Is(degradationMiddleware(invoke)(context.Background(), nil, nil), kerrors.ErrACL))
+}

pkg/degradation/item_degradation.go

@@ -25,19 +25,19 @@ import (
 )
 
 var defaultConfig = &Config{
-	Enabled:    false,
+	Enable:     false,
 	Percentage: 0,
 }
 
 type Config struct {
-	Enabled    bool `json:"enabled"`
+	Enable     bool `json:"enabled"`
 	Percentage int  `json:"percentage"`
 }
 
 // DeepCopy returns a copy of the current Config
 func (c *Config) DeepCopy() iface.ConfigValueItem {
 	result := &Config{
-		Enabled:    c.Enabled,
+		Enable:     c.Enable,
 		Percentage: c.Percentage,
 	}
 	return result
@@ -46,7 +46,7 @@ func (c *Config) DeepCopy() iface.ConfigValueItem {
 // EqualsTo returns true if the current Config equals to the other Config
 func (c *Config) EqualsTo(other iface.ConfigValueItem) bool {
 	o := other.(*Config)
-	return c.Enabled == o.Enabled && c.Percentage == o.Percentage
+	return c.Enable == o.Enable && c.Percentage == o.Percentage
 }
 
 // Container is a wrapper for RejectFunc and Config
@@ -68,7 +68,7 @@ func (c *Container) NotifyPolicyChange(cfg *Config) {
 func (c *Container) GetAclRule() acl.RejectFunc {
 	return func(ctx context.Context, request interface{}) (reason error) {
 		cfg := c.config.Load().(*Config)
-		if !cfg.Enabled {
+		if !cfg.Enable {
 			return nil
 		}
 		if fastrand.Intn(100) < cfg.Percentage {

server/limiter.go

@@ -18,7 +18,7 @@ import (
 	"context"
 	"sync/atomic"
 
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
+	"github.com/kitex-contrib/config-etcd/utils"
 
 	"github.com/kitex-contrib/config-etcd/etcd"
 

server/suite.go

@@ -17,7 +17,7 @@ package server
 import (
 	"github.com/cloudwego/kitex/server"
 	"github.com/kitex-contrib/config-etcd/etcd"
-	"github.com/kitex-contrib/config-etcd/pkg/utils"
+	"github.com/kitex-contrib/config-etcd/utils"
 )
 
 const (