From 3110e48214ccefb25c251e6b437f871a366884e0 Mon Sep 17 00:00:00 2001 From: louyuting <1849491904@qq.com> Date: Mon, 7 Sep 2020 22:40:18 +0800 Subject: [PATCH] refine naming --- adapter/echo/middleware_test.go | 8 ++--- adapter/gin/middleware_test.go | 8 ++--- adapter/grpc/client_test.go | 16 +++++----- adapter/grpc/server_test.go | 16 +++++----- adapter/micro/client_test.go | 4 +-- adapter/micro/server_test.go | 8 ++--- core/flow/rule.go | 12 +++---- core/flow/rule_manager.go | 24 +++++++------- core/flow/rule_manager_test.go | 32 +++++++++---------- example/qps/qps_limit_example.go | 4 +-- example/qps/qps_limit_example_test.go | 4 +-- example/warm_up/qps_warm_up_example.go | 4 +-- example/warm_up/qps_warm_up_example_test.go | 4 +-- ext/datasource/helper_test.go | 20 ++++++------ tests/testdata/extension/helper/FlowRule.json | 6 ++-- 15 files changed, 85 insertions(+), 85 deletions(-) diff --git a/adapter/echo/middleware_test.go b/adapter/echo/middleware_test.go index 1e4ed995f..27e815f30 100644 --- a/adapter/echo/middleware_test.go +++ b/adapter/echo/middleware_test.go @@ -24,8 +24,8 @@ func initSentinel(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, { @@ -33,8 +33,8 @@ func initSentinel(t *testing.T) { MetricType: flow.QPS, Count: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/adapter/gin/middleware_test.go b/adapter/gin/middleware_test.go index 8c0d10c5d..7f95b6bba 100644 --- a/adapter/gin/middleware_test.go +++ b/adapter/gin/middleware_test.go @@ -24,8 +24,8 @@ func initSentinel(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, { @@ -33,8 +33,8 @@ func initSentinel(t *testing.T) { MetricType: flow.QPS, Count: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/adapter/grpc/client_test.go b/adapter/grpc/client_test.go index 7aa427635..bfdfbef87 100644 --- a/adapter/grpc/client_test.go +++ b/adapter/grpc/client_test.go @@ -29,8 +29,8 @@ func TestUnaryClientIntercept(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -50,8 +50,8 @@ func TestUnaryClientIntercept(t *testing.T) { MetricType: flow.QPS, Count: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -79,8 +79,8 @@ func TestStreamClientIntercept(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -102,8 +102,8 @@ func TestStreamClientIntercept(t *testing.T) { MetricType: flow.QPS, Count: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/adapter/grpc/server_test.go b/adapter/grpc/server_test.go index afdacc807..0859c4c4a 100644 --- a/adapter/grpc/server_test.go +++ b/adapter/grpc/server_test.go @@ -35,8 +35,8 @@ func TestStreamServerIntercept(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -56,8 +56,8 @@ func TestStreamServerIntercept(t *testing.T) { MetricType: flow.QPS, Count: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -83,8 +83,8 @@ func TestUnaryServerIntercept(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -114,8 +114,8 @@ func TestUnaryServerIntercept(t *testing.T) { MetricType: flow.QPS, Count: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/adapter/micro/client_test.go b/adapter/micro/client_test.go index 0cbde3890..e11cbcc5c 100644 --- a/adapter/micro/client_test.go +++ b/adapter/micro/client_test.go @@ -51,8 +51,8 @@ func TestClientLimiter(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/adapter/micro/server_test.go b/adapter/micro/server_test.go index e5e5462fc..9fbb20eec 100644 --- a/adapter/micro/server_test.go +++ b/adapter/micro/server_test.go @@ -61,8 +61,8 @@ func TestServerLimiter(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) @@ -78,8 +78,8 @@ func TestServerLimiter(t *testing.T) { MetricType: flow.QPS, Count: 1, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/core/flow/rule.go b/core/flow/rule.go index d6357c3db..61745456c 100644 --- a/core/flow/rule.go +++ b/core/flow/rule.go @@ -56,14 +56,14 @@ func (s RelationStrategy) String() string { } } -type TokenAllocation int32 +type TokenCalculateStrategy int32 const ( - Direct TokenAllocation = iota + Direct TokenCalculateStrategy = iota WarmUp ) -func (s TokenAllocation) String() string { +func (s TokenCalculateStrategy) String() string { switch s { case Direct: return "Direct" @@ -93,12 +93,12 @@ func (s ControlBehavior) String() string { } type ControlStrategy struct { - TokenAllocation TokenAllocation `json:"tokenAllocation"` - ControlBehavior ControlBehavior `json:"controlBehavior"` + TokenCalculateStrategy TokenCalculateStrategy `json:"tokenCalculateStrategy"` + ControlBehavior ControlBehavior `json:"controlBehavior"` } func (s ControlStrategy) String() string { - return fmt.Sprintf("{TokenAllocation: %s, ControlBehavior: %s}", s.TokenAllocation, s.ControlBehavior) + return fmt.Sprintf("{TokenCalculateStrategy: %s, ControlBehavior: %s}", s.TokenCalculateStrategy, s.ControlBehavior) } // Rule describes the strategy of flow control. diff --git a/core/flow/rule_manager.go b/core/flow/rule_manager.go index 98490f4ea..626184fbe 100644 --- a/core/flow/rule_manager.go +++ b/core/flow/rule_manager.go @@ -25,26 +25,26 @@ var ( func init() { // Initialize the traffic shaping controller generator map for existing control behaviors. tcGenFuncMap[ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Reject, + TokenCalculateStrategy: Direct, + ControlBehavior: Reject, }] = func(rule *Rule) *TrafficShapingController { return NewTrafficShapingController(NewDirectTrafficShapingCalculator(rule.Count), NewDefaultTrafficShapingChecker(rule), rule) } tcGenFuncMap[ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Throttling, + TokenCalculateStrategy: Direct, + ControlBehavior: Throttling, }] = func(rule *Rule) *TrafficShapingController { return NewTrafficShapingController(NewDirectTrafficShapingCalculator(rule.Count), NewThrottlingChecker(rule.MaxQueueingTimeMs), rule) } tcGenFuncMap[ControlStrategy{ - TokenAllocation: WarmUp, - ControlBehavior: Reject, + TokenCalculateStrategy: WarmUp, + ControlBehavior: Reject, }] = func(rule *Rule) *TrafficShapingController { return NewTrafficShapingController(NewWarmUpTrafficShapingCalculator(rule), NewDefaultTrafficShapingChecker(rule), rule) } tcGenFuncMap[ControlStrategy{ - TokenAllocation: WarmUp, - ControlBehavior: Throttling, + TokenCalculateStrategy: WarmUp, + ControlBehavior: Throttling, }] = func(rule *Rule) *TrafficShapingController { return NewTrafficShapingController(NewWarmUpTrafficShapingCalculator(rule), NewThrottlingChecker(rule.MaxQueueingTimeMs), rule) } @@ -171,7 +171,7 @@ func SetTrafficShapingGenerator(cs ControlStrategy, generator TrafficControllerG if generator == nil { return errors.New("nil generator") } - if cs.TokenAllocation >= Direct && cs.TokenAllocation <= WarmUp { + if cs.TokenCalculateStrategy >= Direct && cs.TokenCalculateStrategy <= WarmUp { return errors.New("not allowed to replace the generator for default control strategy") } if cs.ControlBehavior >= Reject && cs.ControlBehavior <= Throttling { @@ -185,7 +185,7 @@ func SetTrafficShapingGenerator(cs ControlStrategy, generator TrafficControllerG } func RemoveTrafficShapingGenerator(cs ControlStrategy) error { - if cs.TokenAllocation >= Direct && cs.TokenAllocation <= WarmUp { + if cs.TokenCalculateStrategy >= Direct && cs.TokenCalculateStrategy <= WarmUp { return errors.New("not allowed to replace the generator for default control strategy") } if cs.ControlBehavior >= Reject && cs.ControlBehavior <= Throttling { @@ -258,7 +258,7 @@ func IsValidRule(rule *Rule) error { if rule.RelationStrategy < 0 { return errors.New("invalid relation strategy") } - if rule.ControlStrategy.TokenAllocation < 0 || rule.ControlStrategy.ControlBehavior < 0 { + if rule.ControlStrategy.TokenCalculateStrategy < 0 || rule.ControlStrategy.ControlBehavior < 0 { return errors.New("invalid control strategy") } @@ -270,7 +270,7 @@ func IsValidRule(rule *Rule) error { } func checkControlStrategyField(rule *Rule) error { - switch rule.ControlStrategy.TokenAllocation { + switch rule.ControlStrategy.TokenCalculateStrategy { case WarmUp: if rule.WarmUpPeriodSec <= 0 { return errors.New("invalid warmUpPeriodSec") diff --git a/core/flow/rule_manager_test.go b/core/flow/rule_manager_test.go index ce20e635d..1a90e64d0 100644 --- a/core/flow/rule_manager_test.go +++ b/core/flow/rule_manager_test.go @@ -11,21 +11,21 @@ func TestSetAndRemoveTrafficShapingGenerator(t *testing.T) { tsc := &TrafficShapingController{} err := SetTrafficShapingGenerator(ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Reject, + TokenCalculateStrategy: Direct, + ControlBehavior: Reject, }, func(_ *Rule) *TrafficShapingController { return tsc }) assert.Error(t, err, "default control behaviors are not allowed to be modified") err = RemoveTrafficShapingGenerator(ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Reject, + TokenCalculateStrategy: Direct, + ControlBehavior: Reject, }) assert.Error(t, err, "default control behaviors are not allowed to be removed") cs := ControlStrategy{ - TokenAllocation: TokenAllocation(111), - ControlBehavior: ControlBehavior(112), + TokenCalculateStrategy: TokenCalculateStrategy(111), + ControlBehavior: ControlBehavior(112), } err = SetTrafficShapingGenerator(cs, func(_ *Rule) *TrafficShapingController { return tsc @@ -57,8 +57,8 @@ func TestSetAndRemoveTrafficShapingGenerator(t *testing.T) { func TestIsValidFlowRule(t *testing.T) { badRule1 := &Rule{ID: 1, Count: 1, MetricType: QPS, Resource: ""} badRule2 := &Rule{ID: 1, Count: -1.9, MetricType: QPS, Resource: "test"} - badRule3 := &Rule{Count: 5, MetricType: QPS, Resource: "test", ControlStrategy: ControlStrategy{TokenAllocation: WarmUp, ControlBehavior: Reject}} - goodRule1 := &Rule{Count: 10, MetricType: QPS, Resource: "test", ControlStrategy: ControlStrategy{TokenAllocation: WarmUp, ControlBehavior: Throttling}, WarmUpPeriodSec: 10} + badRule3 := &Rule{Count: 5, MetricType: QPS, Resource: "test", ControlStrategy: ControlStrategy{TokenCalculateStrategy: WarmUp, ControlBehavior: Reject}} + goodRule1 := &Rule{Count: 10, MetricType: QPS, Resource: "test", ControlStrategy: ControlStrategy{TokenCalculateStrategy: WarmUp, ControlBehavior: Throttling}, WarmUpPeriodSec: 10} assert.Error(t, IsValidRule(badRule1)) assert.Error(t, IsValidRule(badRule2)) @@ -79,8 +79,8 @@ func TestGetRules(t *testing.T) { Count: 0, RelationStrategy: 0, ControlStrategy: ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Reject, + TokenCalculateStrategy: Direct, + ControlBehavior: Reject, }, RefResource: "", WarmUpPeriodSec: 0, @@ -94,8 +94,8 @@ func TestGetRules(t *testing.T) { Count: 0, RelationStrategy: 0, ControlStrategy: ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Throttling, + TokenCalculateStrategy: Direct, + ControlBehavior: Throttling, }, RefResource: "", WarmUpPeriodSec: 0, @@ -131,8 +131,8 @@ func TestGetRules(t *testing.T) { Count: 0, RelationStrategy: 0, ControlStrategy: ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Reject, + TokenCalculateStrategy: Direct, + ControlBehavior: Reject, }, RefResource: "", WarmUpPeriodSec: 0, @@ -146,8 +146,8 @@ func TestGetRules(t *testing.T) { Count: 0, RelationStrategy: 0, ControlStrategy: ControlStrategy{ - TokenAllocation: Direct, - ControlBehavior: Throttling, + TokenCalculateStrategy: Direct, + ControlBehavior: Throttling, }, RefResource: "", WarmUpPeriodSec: 0, diff --git a/example/qps/qps_limit_example.go b/example/qps/qps_limit_example.go index b5b9fd760..7eabb78ef 100644 --- a/example/qps/qps_limit_example.go +++ b/example/qps/qps_limit_example.go @@ -25,8 +25,8 @@ func main() { MetricType: flow.QPS, Count: 10, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/example/qps/qps_limit_example_test.go b/example/qps/qps_limit_example_test.go index 6533cbcba..68c78b4ca 100644 --- a/example/qps/qps_limit_example_test.go +++ b/example/qps/qps_limit_example_test.go @@ -32,8 +32,8 @@ func doTest() { MetricType: flow.QPS, Count: 100, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, }, }) diff --git a/example/warm_up/qps_warm_up_example.go b/example/warm_up/qps_warm_up_example.go index 00b2c5c0c..9f1d5c7ed 100644 --- a/example/warm_up/qps_warm_up_example.go +++ b/example/warm_up/qps_warm_up_example.go @@ -37,8 +37,8 @@ func main() { MetricType: flow.QPS, Count: 100, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.WarmUp, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.WarmUp, + ControlBehavior: flow.Reject, }, WarmUpPeriodSec: 10, WarmUpColdFactor: 3, diff --git a/example/warm_up/qps_warm_up_example_test.go b/example/warm_up/qps_warm_up_example_test.go index e0a4a5fbb..dac06cc50 100644 --- a/example/warm_up/qps_warm_up_example_test.go +++ b/example/warm_up/qps_warm_up_example_test.go @@ -34,8 +34,8 @@ func doTest() { MetricType: flow.QPS, Count: 100, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.WarmUp, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.WarmUp, + ControlBehavior: flow.Reject, }, WarmUpPeriodSec: 10, }, diff --git a/ext/datasource/helper_test.go b/ext/datasource/helper_test.go index 7c1ffaec4..ed60f262b 100644 --- a/ext/datasource/helper_test.go +++ b/ext/datasource/helper_test.go @@ -53,8 +53,8 @@ func TestFlowRulesJsonConverter(t *testing.T) { Count: 100, RelationStrategy: flow.DirectResource, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, RefResource: "refDefault", WarmUpPeriodSec: 10, @@ -69,8 +69,8 @@ func TestFlowRulesJsonConverter(t *testing.T) { Count: 200, RelationStrategy: flow.AssociatedResource, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Throttling, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Throttling, }, RefResource: "refDefault", WarmUpPeriodSec: 20, @@ -85,8 +85,8 @@ func TestFlowRulesJsonConverter(t *testing.T) { Count: 300, RelationStrategy: flow.DirectResource, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Throttling, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Throttling, }, RefResource: "refDefault", WarmUpPeriodSec: 30, @@ -108,8 +108,8 @@ func TestFlowRulesUpdater(t *testing.T) { Count: 0, RelationStrategy: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, RefResource: "", WarmUpPeriodSec: 0, @@ -144,8 +144,8 @@ func TestFlowRulesUpdater(t *testing.T) { Count: 0, RelationStrategy: 0, ControlStrategy: flow.ControlStrategy{ - TokenAllocation: flow.Direct, - ControlBehavior: flow.Reject, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, }, RefResource: "", WarmUpPeriodSec: 0, diff --git a/tests/testdata/extension/helper/FlowRule.json b/tests/testdata/extension/helper/FlowRule.json index cb45ca1c0..5b60f2a9b 100644 --- a/tests/testdata/extension/helper/FlowRule.json +++ b/tests/testdata/extension/helper/FlowRule.json @@ -6,7 +6,7 @@ "count": 100.0, "relationStrategy": 0, "controlStrategy": { - "tokenAllocation": 0, + "tokenCalculateStrategy": 0, "controlBehavior": 0 }, "refResource": "refDefault", @@ -20,7 +20,7 @@ "count": 200.0, "relationStrategy": 1, "controlStrategy": { - "tokenAllocation": 0, + "tokenCalculateStrategy": 0, "controlBehavior": 1 }, "refResource": "refDefault", @@ -34,7 +34,7 @@ "count": 300.0, "relationStrategy": 0, "controlStrategy": { - "tokenAllocation": 0, + "tokenCalculateStrategy": 0, "controlBehavior": 1 }, "refResource": "refDefault",