move filter keys to constant package

common/constant/default.go

@@ -51,9 +51,9 @@ const (
 const (
  DEFAULT_KEY = "default"
  PREFIX_DEFAULT_KEY = "default."
- DEFAULT_SERVICE_FILTERS = "echo,token,accesslog,tps,generic_service,execute,pshutdown"
- DEFAULT_REFERENCE_FILTERS = "cshutdown"
- GENERIC_REFERENCE_FILTERS = "generic"
+ DEFAULT_SERVICE_FILTERS = EchoFilterKey+","+TokenFilterKey+","+AccessLogFilterKey+","+TpsLimitFilterKey+","+GenericServiceFilterKey+","+ExecuteLimitFilterKey+","+GracefulShutdownProviderFilterKey
+ DEFAULT_REFERENCE_FILTERS = GracefulShutdownConsumerFilterKey
+ GENERIC_REFERENCE_FILTERS = GenericFilterKey
  GENERIC = "$invoke"
  ECHO = "$echo"
 )

common/constant/key.go

@@ -60,6 +60,29 @@ const (
  REFERENCE_FILTER_KEY = "reference.filter"
 )
 
+// Filter Keys
+const (
+ AccessLogFilterKey = "accesslog"
+ ActiveFilterKey = "active"
+ AuthConsumerFilterKey = "sign"
+ AuthProviderFilterKey = "auth"
+ EchoFilterKey = "echo"
+ ExecuteLimitFilterKey = "execute"
+ GenericFilterKey = "generic"
+ GenericServiceFilterKey = "generic_service"
+ GracefulShutdownProviderFilterKey = "pshutdown"
+ GracefulShutdownConsumerFilterKey = "cshutdown"
+ HystrixConsumerFilterKey = "hystrix_consumer"
+ HystrixProviderFilterKey = "hystrix_provider"
+ MetricsFilterKey = "metrics"
+ SeataFilterKey = "seata"
+ SentinelProviderFilterKey = "sentinel-provider"
+ SentinelConsumerFilterKey = "sentinel-consumer"
+ TokenFilterKey = "token"
+ TpsLimitFilterKey = "tps"
+ TracingFilterKey = "tracing"
+)
+
 const (
  TIMESTAMP_KEY = "timestamp"
  REMOTE_TIMESTAMP_KEY = "remote.timestamp"
@@ -74,7 +97,6 @@ const (
  FORKS_KEY = "forks"
  DEFAULT_FORKS = 2
  DEFAULT_TIMEOUT = 1000
- ACCESS_LOG_KEY = "accesslog"
  TPS_LIMITER_KEY = "tps.limiter"
  TPS_REJECTED_EXECUTION_HANDLER_KEY = "tps.limit.rejected.handler"
  TPS_LIMIT_RATE_KEY = "tps.limit.rate"
@@ -85,8 +107,6 @@ const (
  EXECUTE_LIMIT_KEY = "execute.limit"
  DEFAULT_EXECUTE_LIMIT = "-1"
  EXECUTE_REJECTED_EXECUTION_HANDLER_KEY = "execute.limit.rejected.handler"
- PROVIDER_SHUTDOWN_FILTER = "pshutdown"
- CONSUMER_SHUTDOWN_FILTER = "cshutdown"
  SERIALIZATION_KEY = "serialization"
  PID_KEY = "pid"
  SYNC_REPORT_KEY = "sync.report"
@@ -251,11 +271,8 @@ const (
  AttachmentKey = DubboCtxKey("attachment")
 )
 
+// Auth filter
 const (
- // name of consumer sign filter
- CONSUMER_SIGN_FILTER = "sign"
- // name of consumer sign filter
- PROVIDER_AUTH_FILTER = "auth"
  // name of service filter
  SERVICE_AUTH_KEY = "auth"
  // key of authenticator

config/config_loader_test.go

@@ -77,10 +77,10 @@ func TestConfigLoader(t *testing.T) {
 }
 
 func TestLoad(t *testing.T) {
- extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
  return &mockGracefulShutdownFilter{}
  })
- extension.SetFilter(constant.PROVIDER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownProviderFilterKey, func() filter.Filter {
  return &mockGracefulShutdownFilter{}
  })
 

config/graceful_shutdown.go

@@ -60,10 +60,10 @@ func GracefulShutdownInit() {
  signal.Notify(signals, ShutdownSignals...)
 
  // retrieve ShutdownConfig for gracefulShutdownFilter
- if filter, ok := extension.GetFilter(constant.CONSUMER_SHUTDOWN_FILTER).(Setter); ok && GetConsumerConfig().ShutdownConfig != nil {
+ if filter, ok := extension.GetFilter(constant.GracefulShutdownConsumerFilterKey).(Setter); ok && GetConsumerConfig().ShutdownConfig != nil {
  filter.Set(GracefulShutdownFilterShutdownConfig, GetConsumerConfig().ShutdownConfig)
  }
- if filter, ok := extension.GetFilter(constant.PROVIDER_SHUTDOWN_FILTER).(Setter); ok && GetProviderConfig().ShutdownConfig != nil {
+ if filter, ok := extension.GetFilter(constant.GracefulShutdownProviderFilterKey).(Setter); ok && GetProviderConfig().ShutdownConfig != nil {
  filter.Set(GracefulShutdownFilterShutdownConfig, GetProviderConfig().ShutdownConfig)
  }
 

config/graceful_shutdown_test.go

@@ -29,10 +29,10 @@ import (
 )
 
 func TestGracefulShutdownInit(t *testing.T) {
- extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
  return &mockGracefulShutdownFilter{}
  })
- extension.SetFilter(constant.PROVIDER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownProviderFilterKey, func() filter.Filter {
  return &mockGracefulShutdownFilter{}
  })
  GracefulShutdownInit()

config/reference_config_test.go

@@ -385,7 +385,7 @@ func (p *mockRegistryProtocol) GetRegistries() []registry.Registry {
 
 func mockFilter() {
  consumerFiler := &mockShutdownFilter{}
- extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
  return consumerFiler
  })
 }

config/service_config.go

@@ -304,7 +304,7 @@ func (c *ServiceConfig) getUrlMap() url.Values {
  urlMap.Set(constant.SERVICE_FILTER_KEY, mergeValue(providerConfig.Filter, c.Filter, constant.DEFAULT_SERVICE_FILTERS))
 
  // filter special config
- urlMap.Set(constant.ACCESS_LOG_KEY, c.AccessLog)
+ urlMap.Set(constant.AccessLogFilterKey, c.AccessLog)
  // tps limiter
  urlMap.Set(constant.TPS_LIMIT_STRATEGY_KEY, c.TpsLimitStrategy)
  urlMap.Set(constant.TPS_LIMIT_INTERVAL_KEY, c.TpsLimitInterval)

filter/accesslog/filter.go

@@ -53,9 +53,7 @@ const (
 )
 
 func init() {
- extension.SetFilter(constant.ACCESS_LOG_KEY, func() filter.Filter {
- return NewFilter()
- })
+ extension.SetFilter(constant.AccessLogFilterKey, newFilter)
 }
 
 // Filter for Access Log
@@ -79,9 +77,9 @@ type Filter struct {
 }
 
 // Invoke will check whether user wants to use this filter.
-// If we find the value of key constant.ACCESS_LOG_KEY, we will log the invocation info
+// If we find the value of key constant.AccessLogFilterKey, we will log the invocation info
 func (f *Filter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
- accessLog := invoker.GetURL().GetParam(constant.ACCESS_LOG_KEY, "")
+ accessLog := invoker.GetURL().GetParam(constant.AccessLogFilterKey, "")
 
  // the user do not
  if len(accessLog) > 0 {
@@ -222,7 +220,7 @@ func isDefault(accessLog string) bool {
  return strings.EqualFold("true", accessLog) || strings.EqualFold("default", accessLog)
 }
 
-func NewFilter() *Filter {
+func newFilter() filter.Filter {
  accessLogFilter := &Filter{logChan: make(chan Data, LogMaxBuffer)}
  go func() {
  for accessLogData := range accessLogFilter.logChan {

filter/active/filter.go

@@ -23,6 +23,7 @@ import (
 )
 
 import (
+ "dubbo.apache.org/dubbo-go/v3/common/constant"
  "dubbo.apache.org/dubbo-go/v3/common/extension"
  "dubbo.apache.org/dubbo-go/v3/common/logger"
  "dubbo.apache.org/dubbo-go/v3/filter"
@@ -32,11 +33,10 @@ import (
 
 const (
  dubboInvokeStartTime = "dubboInvokeStartTime"
- Active = "active"
 )
 
 func init() {
- extension.SetFilter(Active, func() filter.Filter {
+ extension.SetFilter(constant.ActiveFilterKey, func() filter.Filter {
  return &Filter{}
  })
 }

filter/auth/consumer_sign_filter.go

@@ -31,10 +31,10 @@ import (
 )
 
 func init() {
- extension.SetFilter(constant.CONSUMER_SIGN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.AuthConsumerFilterKey, func() filter.Filter {
  return &ConsumerSignFilter{}
  })
- extension.SetFilter(constant.PROVIDER_AUTH_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.AuthProviderFilterKey, func() filter.Filter {
  return &ProviderAuthFilter{}
  })
 }

filter/auth/provider_auth_filter.go

@@ -30,7 +30,7 @@ import (
 )
 
 func init() {
- extension.SetFilter(constant.PROVIDER_AUTH_FILTER, newProviderAuthFilter)
+ extension.SetFilter(constant.AuthProviderFilterKey, newProviderAuthFilter)
 }
 
 // ProviderAuthFilter verifies the correctness of the signature on provider side

filter/echo/filter.go

@@ -29,12 +29,8 @@ import (
  "dubbo.apache.org/dubbo-go/v3/protocol"
 )
 
-const (
- Echo = "echo"
-)
-
 func init() {
- extension.SetFilter(Echo, func() filter.Filter {
+ extension.SetFilter(constant.EchoFilterKey, func() filter.Filter {
  return &Filter{}
  })
 }

filter/execlmt/filter.go

@@ -37,14 +37,8 @@ import (
  "dubbo.apache.org/dubbo-go/v3/protocol"
 )
 
-const (
- ExecuteLimit = "execute"
-)
-
 func init() {
- extension.SetFilter(ExecuteLimit, func() filter.Filter {
- return NewFilter()
- })
+ extension.SetFilter(constant.ExecuteLimitFilterKey, newFilter)
 }
 
 // Filter will limit the number of in-progress request and it's thread-safe.
@@ -141,8 +135,8 @@ var (
  executeLimitFilter *Filter
 )
 
-// NewFilter returns the singleton Filter instance
-func NewFilter() *Filter {
+// newFilter returns the singleton Filter instance
+func newFilter() filter.Filter {
  executeLimitOnce.Do(func() {
  executeLimitFilter = &Filter{
  executeState: concurrent.NewMap(),

filter/execlmt/filter_test.go

@@ -42,7 +42,7 @@ func TestFilterInvokeIgnored(t *testing.T) {
  common.WithParams(url.Values{}),
  common.WithParamsValue(constant.INTERFACE_KEY, methodName))
 
- limitFilter := NewFilter()
+ limitFilter := newFilter()
 
  result := limitFilter.Invoke(context.Background(), protocol.NewBaseInvoker(invokeUrl), invoc)
  assert.NotNil(t, result)
@@ -59,7 +59,7 @@ func TestFilterInvokeConfigureError(t *testing.T) {
  common.WithParamsValue(constant.EXECUTE_LIMIT_KEY, "13a"),
  )
 
- limitFilter := NewFilter()
+ limitFilter := newFilter()
 
  result := limitFilter.Invoke(context.Background(), protocol.NewBaseInvoker(invokeUrl), invoc)
  assert.NotNil(t, result)
@@ -76,7 +76,7 @@ func TestFilterInvoke(t *testing.T) {
  common.WithParamsValue(constant.EXECUTE_LIMIT_KEY, "20"),
  )
 
- limitFilter := NewFilter()
+ limitFilter := newFilter()
 
  result := limitFilter.Invoke(context.Background(), protocol.NewBaseInvoker(invokeUrl), invoc)
  assert.NotNil(t, result)

filter/generic/filter.go

@@ -36,12 +36,8 @@ import (
  invocation2 "dubbo.apache.org/dubbo-go/v3/protocol/invocation"
 )
 
-const (
- Generic = "generic"
-)
-
 func init() {
- extension.SetFilter(Generic, func() filter.Filter {
+ extension.SetFilter(constant.GenericFilterKey, func() filter.Filter {
  return &Filter{}
  })
 }

filter/generic/service_filter.go

@@ -39,13 +39,12 @@ import (
 )
 
 const (
- GenericService = "generic_service"
  // nolint
  GENERIC_SERIALIZATION_DEFAULT = "true"
 )
 
 func init() {
- extension.SetFilter(GenericService, func() filter.Filter {
+ extension.SetFilter(constant.GenericServiceFilterKey, func() filter.Filter {
  return &ServiceFilter{}
  })
 }

filter/gshutdown/filter.go

@@ -33,10 +33,10 @@ import (
 
 func init() {
  // `init()` is performed before config.Load(), so shutdownConfig will be retrieved after config was loaded.
- extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
  return &Filter{}
  })
- extension.SetFilter(constant.PROVIDER_SHUTDOWN_FILTER, func() filter.Filter {
+ extension.SetFilter(constant.GracefulShutdownProviderFilterKey, func() filter.Filter {
  return &Filter{}
  })
 }

filter/gshutdown/filter_test.go

@@ -42,7 +42,7 @@ func TestGenericFilterInvoke(t *testing.T) {
  invoc := invocation.NewRPCInvocation("GetUser", []interface{}{"OK"}, make(map[string]interface{}))
  invokeUrl := common.NewURLWithOptions(common.WithParams(url.Values{}))
 
- shutdownFilter := extension.GetFilter(constant.PROVIDER_SHUTDOWN_FILTER).(*Filter)
+ shutdownFilter := extension.GetFilter(constant.GracefulShutdownProviderFilterKey).(*Filter)
 
  providerConfig := config.GetProviderConfig()
 

filter/hystrix/filter.go

@@ -31,6 +31,7 @@ import (
 )
 
 import (
+ "dubbo.apache.org/dubbo-go/v3/common/constant"
  "dubbo.apache.org/dubbo-go/v3/common/extension"
  "dubbo.apache.org/dubbo-go/v3/common/logger"
  "dubbo.apache.org/dubbo-go/v3/config"
@@ -41,8 +42,6 @@ import (
 const (
  // nolint
  HYSTRIX = "hystrix"
- HystrixConsumer = "hystrix_consumer"
- HystrixProvider = "hystrix_provider"
 )
 
 var (
@@ -54,8 +53,8 @@ var (
 )
 
 func init() {
- extension.SetFilter(HystrixConsumer, newFilterConsumer)
- extension.SetFilter(HystrixProvider, newFilterProvider)
+ extension.SetFilter(constant.HystrixConsumerFilterKey, newFilterConsumer)
+ extension.SetFilter(constant.HystrixProviderFilterKey, newFilterProvider)
 }
 
 // FilterError implements error interface

filter/metrics/filter.go

@@ -23,20 +23,19 @@ import (
 )
 
 import (
+ "dubbo.apache.org/dubbo-go/v3/common/constant"
  "dubbo.apache.org/dubbo-go/v3/common/extension"
  "dubbo.apache.org/dubbo-go/v3/config"
  "dubbo.apache.org/dubbo-go/v3/filter"
  "dubbo.apache.org/dubbo-go/v3/metrics"
  "dubbo.apache.org/dubbo-go/v3/protocol"
 )
 
-const Metrics = "metrics"
-
 // must initialized before using the filter and after loading configuration
 var metricFilterInstance *Filter
 
 func init() {
- extension.SetFilter(Metrics, newFilter)
+ extension.SetFilter(constant.MetricsFilterKey, newFilter)
 }
 
 // Filter will calculate the invocation's duration and the report to the reporters

filter/seata/filter.go

@@ -32,11 +32,10 @@ import (
 
 const (
  SEATA_XID = constant.DubboCtxKey("SEATA_XID")
- Seata = constant.DubboCtxKey("seata")
 )
 
 func init() {
- extension.SetFilter(string(Seata), func() filter.Filter {
+ extension.SetFilter(constant.SeataFilterKey, func() filter.Filter {
  return &Filter{}
  })
 }