refactor: migrate graceful shutdown config to global

compat.go

@@ -17,10 +17,6 @@
 
 package dubbo
 
-import (
-	"go.uber.org/atomic"
-)
-
 import (
 	"dubbo.apache.org/dubbo-go/v3/common"
 	"dubbo.apache.org/dubbo-go/v3/config"
@@ -471,19 +467,7 @@ func compatShutdownConfig(c *global.ShutdownConfig) *config.ShutdownConfig {
 	if c == nil {
 		return nil
 	}
-	cfg := &config.ShutdownConfig{
-		Timeout:                     c.Timeout,
-		StepTimeout:                 c.StepTimeout,
-		NotifyTimeout:               c.NotifyTimeout,
-		ConsumerUpdateWaitTime:      c.ConsumerUpdateWaitTime,
-		RejectRequestHandler:        c.RejectRequestHandler,
-		InternalSignal:              c.InternalSignal,
-		OfflineRequestWindowTimeout: c.OfflineRequestWindowTimeout,
-		RejectRequest:               atomic.Bool{},
-	}
-	cfg.RejectRequest.Store(c.RejectRequest.Load())
-
-	return cfg
+	return c.Clone()
 }
 
 func compatRouterConfig(c *global.RouterConfig) *config.RouterConfig {

config/graceful_shutdown_config.go

@@ -17,141 +17,18 @@
 
 package config
 
-import (
-	"time"
-)
-
 import (
 	"github.com/creasty/defaults"
-
-	"github.com/dubbogo/gost/log/logger"
-
-	"go.uber.org/atomic"
 )
 
 import (
-	"dubbo.apache.org/dubbo-go/v3/common/constant"
-)
-
-const (
-	defaultTimeout                     = 60 * time.Second
-	defaultStepTimeout                 = 3 * time.Second
-	defaultNotifyTimeout               = 5 * time.Second
-	defaultConsumerUpdateWaitTime      = 3 * time.Second
-	defaultOfflineRequestWindowTimeout = 3 * time.Second
+	"dubbo.apache.org/dubbo-go/v3/global"
 )
 
-// ShutdownConfig is used as configuration for graceful shutdown
-type ShutdownConfig struct {
-	/*
-	 * Total timeout. Even though we don't release all resources,
-	 * the applicationConfig will shutdown if the costing time is over this configuration. The unit is ms.
-	 * default value is 60 * 1000 ms = 1 minutes
-	 * In general, it should be bigger than 3 * StepTimeout.
-	 */
-	Timeout string `default:"60s" yaml:"timeout" json:"timeout,omitempty" property:"timeout"`
-	/*
-	 * the timeout on each step. You should evaluate the response time of request
-	 * and the time that client noticed that server shutdown.
-	 * For example, if your client will received the notification within 10s when you start to close server,
-	 * and the 99.9% requests will return response in 2s, so the StepTimeout will be bigger than(10+2) * 1000ms,
-	 * maybe (10 + 2*3) * 1000ms is a good choice.
-	 */
-	StepTimeout string `default:"3s" yaml:"step-timeout" json:"step.timeout,omitempty" property:"step.timeout"`
-
-	/*
-	 * NotifyTimeout means the timeout budget for actively notifying long-connection consumers
-	 * during graceful shutdown. It only controls the notify step and should not be coupled to
-	 * request draining timeouts.
-	 */
-	NotifyTimeout string `default:"5s" yaml:"notify-timeout" json:"notify.timeout,omitempty" property:"notify.timeout"`
-
-	/*
-	 * ConsumerUpdateWaitTime means when provider is shutting down, after the unregister, time to wait for client to
-	 * update invokers. During this time, incoming invocation can be treated normally.
-	 */
-	ConsumerUpdateWaitTime string `default:"3s" yaml:"consumer-update-wait-time" json:"consumerUpdate.waitTIme,omitempty" property:"consumerUpdate.waitTIme"`
-	// when we try to shutdown the applicationConfig, we will reject the new requests. In most cases, you don't need to configure this.
-	RejectRequestHandler string `yaml:"reject-handler" json:"reject-handler,omitempty" property:"reject_handler"`
-	// internal listen kill signal，the default is true.
-	InternalSignal *bool `default:"true" yaml:"internal-signal" json:"internal.signal,omitempty" property:"internal.signal"`
-	// offline request window length
-	OfflineRequestWindowTimeout string `default:"3s" yaml:"offline-request-window-timeout" json:"offlineRequestWindowTimeout,omitempty" property:"offlineRequestWindowTimeout"`
-	// true -> new request will be rejected.
-	RejectRequest atomic.Bool
-	// active invocation
-	ConsumerActiveCount atomic.Int32
-	ProviderActiveCount atomic.Int32
-
-	// provider last received request timestamp
-	ProviderLastReceivedRequestTime atomic.Time
-}
-
-// Prefix dubbo.shutdown
-func (config *ShutdownConfig) Prefix() string {
-	return constant.ShutdownConfigPrefix
-}
-
-func (config *ShutdownConfig) GetTimeout() time.Duration {
-	result, err := time.ParseDuration(config.Timeout)
-	if err != nil {
-		logger.Errorf("The Timeout configuration is invalid: %s, and we will use the default value: %s, err: %v",
-			config.Timeout, defaultTimeout.String(), err)
-		return defaultTimeout
-	}
-	return result
-}
-
-func (config *ShutdownConfig) GetStepTimeout() time.Duration {
-	result, err := time.ParseDuration(config.StepTimeout)
-	if err != nil {
-		logger.Errorf("The StepTimeout configuration is invalid: %s, and we will use the default value: %s, err: %v",
-			config.StepTimeout, defaultStepTimeout.String(), err)
-		return defaultStepTimeout
-	}
-	return result
-}
-
-func (config *ShutdownConfig) GetNotifyTimeout() time.Duration {
-	result, err := time.ParseDuration(config.NotifyTimeout)
-	if err != nil {
-		logger.Errorf("The NotifyTimeout configuration is invalid: %s, and we will use the default value: %s, err: %v",
-			config.NotifyTimeout, defaultNotifyTimeout.String(), err)
-		return defaultNotifyTimeout
-	}
-	return result
-}
-
-func (config *ShutdownConfig) GetOfflineRequestWindowTimeout() time.Duration {
-	result, err := time.ParseDuration(config.OfflineRequestWindowTimeout)
-	if err != nil {
-		logger.Errorf("The OfflineRequestWindowTimeout configuration is invalid: %s, and we will use the default value: %s, err: %v",
-			config.OfflineRequestWindowTimeout, defaultOfflineRequestWindowTimeout.String(), err)
-		return defaultOfflineRequestWindowTimeout
-	}
-	return result
-}
-
-func (config *ShutdownConfig) GetConsumerUpdateWaitTime() time.Duration {
-	result, err := time.ParseDuration(config.ConsumerUpdateWaitTime)
-	if err != nil {
-		logger.Errorf("The ConsumerUpdateTimeout configuration is invalid: %s, and we will use the default value: %s, err: %v",
-			config.ConsumerActiveCount.Load(), defaultConsumerUpdateWaitTime.String(), err)
-		return defaultConsumerUpdateWaitTime
-	}
-	return result
-}
-
-func (config *ShutdownConfig) GetInternalSignal() bool {
-	if config.InternalSignal == nil {
-		return false
-	}
-	return *config.InternalSignal
-}
-
-func (config *ShutdownConfig) Init() error {
-	return defaults.Set(config)
-}
+// ShutdownConfig is kept as a compatibility alias for global.ShutdownConfig.
+// Use global.ShutdownConfig directly in new code. Field documentation lives on
+// global.ShutdownConfig because it owns the graceful shutdown configuration.
+type ShutdownConfig = global.ShutdownConfig
 
 type ShutdownConfigBuilder struct {
 	shutdownConfig *ShutdownConfig

config/graceful_shutdown_config_test.go

@@ -57,9 +57,9 @@ func TestShutdownConfigGetTimeout(t *testing.T) {
 	// test default
 	config = ShutdownConfig{}
 
-	assert.Equal(t, defaultTimeout, config.GetTimeout())
-	assert.Equal(t, defaultStepTimeout, config.GetStepTimeout())
-	assert.Equal(t, defaultOfflineRequestWindowTimeout, config.GetOfflineRequestWindowTimeout())
+	assert.Equal(t, 60*time.Second, config.GetTimeout())
+	assert.Equal(t, 3*time.Second, config.GetStepTimeout())
+	assert.Equal(t, 3*time.Second, config.GetOfflineRequestWindowTimeout())
 }
 
 func TestNewShutDownConfigBuilder(t *testing.T) {

config/graceful_shutdown_test.go

@@ -17,6 +17,76 @@
 
 package config
 
+import (
+	"context"
+	"testing"
+)
+
+import (
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+import (
+	"dubbo.apache.org/dubbo-go/v3/common/constant"
+	"dubbo.apache.org/dubbo-go/v3/common/extension"
+	"dubbo.apache.org/dubbo-go/v3/filter"
+	"dubbo.apache.org/dubbo-go/v3/global"
+	"dubbo.apache.org/dubbo-go/v3/protocol/base"
+	"dubbo.apache.org/dubbo-go/v3/protocol/result"
+)
+
+type captureShutdownConfigFilter struct {
+	captured any
+}
+
+func (f *captureShutdownConfigFilter) Invoke(context.Context, base.Invoker, base.Invocation) result.Result {
+	return &result.RPCResult{}
+}
+
+func (f *captureShutdownConfigFilter) OnResponse(context.Context, result.Result, base.Invoker, base.Invocation) result.Result {
+	return &result.RPCResult{}
+}
+
+func (f *captureShutdownConfigFilter) Set(_ string, config any) {
+	f.captured = config
+}
+
+func TestGracefulShutdownInitPassesGlobalShutdownConfigToFilters(t *testing.T) {
+	internalSignal := false
+	SetRootConfig(RootConfig{
+		Shutdown: &ShutdownConfig{
+			Timeout:        "11s",
+			StepTimeout:    "2s",
+			NotifyTimeout:  "4s",
+			InternalSignal: &internalSignal,
+		},
+	})
+
+	consumerFilter := &captureShutdownConfigFilter{}
+	providerFilter := &captureShutdownConfigFilter{}
+	extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
+		return consumerFilter
+	})
+	extension.SetFilter(constant.GracefulShutdownProviderFilterKey, func() filter.Filter {
+		return providerFilter
+	})
+
+	gracefulShutdownInit()
+
+	consumerShutdown, ok := consumerFilter.captured.(*global.ShutdownConfig)
+	require.True(t, ok)
+	assert.Equal(t, "11s", consumerShutdown.Timeout)
+	assert.Equal(t, "2s", consumerShutdown.StepTimeout)
+	assert.Equal(t, "4s", consumerShutdown.NotifyTimeout)
+
+	providerShutdown, ok := providerFilter.captured.(*global.ShutdownConfig)
+	require.True(t, ok)
+	assert.Equal(t, "11s", providerShutdown.Timeout)
+	assert.Equal(t, "2s", providerShutdown.StepTimeout)
+	assert.Equal(t, "4s", providerShutdown.NotifyTimeout)
+}
+
 //
 //import (
 //	"dubbo.apache.org/dubbo-go/v3/config"

filter/graceful_shutdown/consumer_filter.go

@@ -36,7 +36,6 @@ 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/global"
 	gracefulshutdown "dubbo.apache.org/dubbo-go/v3/graceful_shutdown"
@@ -122,9 +121,6 @@ func (f *consumerGracefulShutdownFilter) Set(name string, conf any) {
 		switch ct := conf.(type) {
 		case *global.ShutdownConfig:
 			f.shutdownConfig = ct
-		// only for compatibility with old config, able to directly remove after config is deleted
-		case *config.ShutdownConfig:
-			f.shutdownConfig = compatGlobalShutdownConfig(ct)
 		default:
 			logger.Warnf("[Filter][GracefulShutdown] the type of config for %s should be *global.ShutdownConfig", constant.GracefulShutdownFilterShutdownConfig)
 		}

filter/graceful_shutdown/consumer_filter_test.go

@@ -38,6 +38,7 @@ import (
 	"dubbo.apache.org/dubbo-go/v3/common"
 	"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/graceful_shutdown"
 	"dubbo.apache.org/dubbo-go/v3/protocol/base"
 	"dubbo.apache.org/dubbo-go/v3/protocol/invocation"
@@ -86,6 +87,15 @@ func TestConsumerFilterInvokeWithGlobalPackage(t *testing.T) {
 	assert.NoError(t, result.Error())
 }
 
+func TestConsumerFilterAcceptsConfigPackageShutdownConfigAlias(t *testing.T) {
+	filter := &consumerGracefulShutdownFilter{}
+	shutdownConfig := config.NewShutDownConfigBuilder().Build()
+
+	filter.Set(constant.GracefulShutdownFilterShutdownConfig, shutdownConfig)
+
+	assert.Same(t, shutdownConfig, filter.shutdownConfig)
+}
+
 func TestIsClosingError(t *testing.T) {
 	assert.True(t, isClosingError(base.ErrClientClosed))
 	assert.True(t, isClosingError(status.Error(codes.Unavailable, "server shutting down")))

filter/graceful_shutdown/provider_filter.go

@@ -30,7 +30,6 @@ 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/global"
 	"dubbo.apache.org/dubbo-go/v3/protocol/base"
@@ -114,9 +113,6 @@ func (f *providerGracefulShutdownFilter) Set(name string, conf any) {
 		switch ct := conf.(type) {
 		case *global.ShutdownConfig:
 			f.shutdownConfig = ct
-		// only for compatibility with old config, able to directly remove after config is deleted
-		case *config.ShutdownConfig:
-			f.shutdownConfig = compatGlobalShutdownConfig(ct)
 		default:
 			logger.Warnf("[Filter][GracefulShutdown] the type of config for %s should be *global.ShutdownConfig", constant.GracefulShutdownFilterShutdownConfig)
 		}

filter/graceful_shutdown/provider_filter_test.go

@@ -34,6 +34,7 @@ import (
 	"dubbo.apache.org/dubbo-go/v3/common"
 	"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/graceful_shutdown"
 	"dubbo.apache.org/dubbo-go/v3/protocol/base"
@@ -88,6 +89,15 @@ func TestProviderFilterOnResponseDoesNotDecrementRejectedRequest(t *testing.T) {
 	assert.Equal(t, int32(0), opt.Shutdown.ProviderActiveCount.Load())
 }
 
+func TestProviderFilterAcceptsConfigPackageShutdownConfigAlias(t *testing.T) {
+	providerFilter := &providerGracefulShutdownFilter{}
+	shutdownConfig := config.NewShutDownConfigBuilder().Build()
+
+	providerFilter.Set(constant.GracefulShutdownFilterShutdownConfig, shutdownConfig)
+
+	assert.Same(t, shutdownConfig, providerFilter.shutdownConfig)
+}
+
 type TestRejectedExecutionHandler struct{}
 
 // RejectedExecution will do nothing, it only log the invocation.