wip

Author: ndyakov

adapters.go

@@ -19,7 +19,7 @@ var ErrInvalidCommand = errors.New("invalid command type")
 var ErrInvalidPool = errors.New("invalid pool type")
 
 // NewClientAdapter creates a new client adapter for regular Redis clients.
-func NewClientAdapter(client *Client) interfaces.ClientInterface {
+func NewClientAdapter(client *baseClient) interfaces.ClientInterface {
 	return &clientAdapter{client: client}
 }
 
@@ -30,7 +30,7 @@ func NewClusterClientAdapter(client interface{}) interfaces.ClientInterface {
 
 // clientAdapter adapts a Redis client to implement interfaces.ClientInterface.
 type clientAdapter struct {
-	client *Client
+	client *baseClient
 }
 
 // GetOptions returns the client options.

example/pubsub/main.go

@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/redis/go-redis/v9"
+	"github.com/redis/go-redis/v9/hitless"
 )
 
 var ctx = context.Background()
@@ -19,7 +20,9 @@ func main() {
 	wg := &sync.WaitGroup{}
 	rdb := redis.NewClient(&redis.Options{
 		Addr:            ":6379",
-		HitlessUpgrades: true,
+		HitlessUpgradeConfig: &redis.HitlessUpgradeConfig{
+			Enabled: hitless.MaintNotificationsEnabled,
+		},
 	})
 	_ = rdb.FlushDB(ctx).Err()
 

hitless/config.go

@@ -4,17 +4,43 @@ import (
 	"time"
 )
 
+// Constants for maintenance push notifications modes
+const (
+	MaintNotificationsDisabled = "disabled" // Client doesn't send CLIENT MAINT_NOTIFICATIONS ON command
+	MaintNotificationsEnabled  = "enabled"  // Client forcefully sends command, interrupts connection on error
+	MaintNotificationsAuto     = "auto"     // Client tries to send command, disables feature on error
+)
+
+// Constants for endpoint types
+const (
+	EndpointTypeAuto         = "auto"          // Auto-detect based on connection
+	EndpointTypeInternalIP   = "internal-ip"   // Internal IP address
+	EndpointTypeInternalFQDN = "internal-fqdn" // Internal FQDN
+	EndpointTypeExternalIP   = "external-ip"   // External IP address
+	EndpointTypeExternalFQDN = "external-fqdn" // External FQDN
+	EndpointTypeNone         = "none"          // No endpoint (reconnect with current config)
+)
+
 // Config provides configuration options for hitless upgrades.
 type Config struct {
-	// Enabled controls whether hitless upgrades are enabled.
-	// Requires RESP3 protocol for push notifications.
-	// Default: false
-	Enabled bool
+	// Enabled controls how client maintenance notifications are handled.
+	// Valid values: MaintNotificationsDisabled, MaintNotificationsEnabled, MaintNotificationsAuto
+	// - disabled: The client doesn't send CLIENT MAINT_NOTIFICATIONS ON command
+	// - enabled: The client forcefully sends the command, interrupts connection on error
+	// - auto: The client tries to send the command, disables feature on error
+	// Default: MaintNotificationsAuto ("auto")
+	Enabled string
 
 	// EndpointType specifies the type of endpoint to request in MOVING notifications.
-	// Valid values: "internal-ip", "internal-fqdn", "external-ip", "external-fqdn", "none"
-	// If empty, the client will auto-detect based on connection settings.
-	// Default: "" (auto-detect)
+	// Valid values: EndpointTypeAuto, EndpointTypeInternalIP, EndpointTypeInternalFQDN,
+	//               EndpointTypeExternalIP, EndpointTypeExternalFQDN, EndpointTypeNone
+	// - auto: Auto-detect based on connection (private IP → internal, TLS → FQDN)
+	// - internal-ip: Enforce requesting the internal IP
+	// - internal-fqdn: Enforce requesting the internal FQDN
+	// - external-ip: Enforce requesting the external IP address
+	// - external-fqdn: Enforce requesting the external FQDN
+	// - none: Request null endpoint (reconnect based on current config)
+	// Default: EndpointTypeAuto ("auto")
 	EndpointType string
 
 	// RelaxedTimeout is the concrete timeout value to use during
@@ -70,17 +96,17 @@ type Config struct {
 // DefaultConfig returns a Config with sensible defaults.
 func DefaultConfig() *Config {
 	return &Config{
-		Enabled:                false,
-		EndpointType:           "", // Auto-detect
-		RelaxedTimeout:         30 * time.Second,
-		RelaxedTimeoutDuration: 30 * time.Second,
-		HandoffTimeout:            15 * time.Second,
-		MinWorkers:               0, // Auto-calculated based on pool size
-		MaxWorkers:               0, // Auto-calculated based on pool size
-		HandoffQueueSize:          0, // Auto-calculated based on max workers
+		Enabled:                    MaintNotificationsAuto, // Enable by default for Redis Cloud
+		EndpointType:               EndpointTypeAuto,       // Auto-detect based on connection
+		RelaxedTimeout:             30 * time.Second,
+		RelaxedTimeoutDuration:     30 * time.Second,
+		HandoffTimeout:             15 * time.Second,
+		MinWorkers:                 0,                      // Auto-calculated based on pool size
+		MaxWorkers:                 0,                      // Auto-calculated based on pool size
+		HandoffQueueSize:           0,                      // Auto-calculated based on max workers
 		PostHandoffRelaxedDuration: 10 * time.Second,
-		ScaleDownDelay:            2 * time.Second,
-		LogLevel:                  1,
+		ScaleDownDelay:             2 * time.Second,
+		LogLevel:                   1,
 	}
 }
 
@@ -111,15 +137,25 @@ func (c *Config) Validate() error {
 		return ErrInvalidLogLevel
 	}
 
+	// Validate Enabled (maintenance notifications mode)
+	validMaintNotifications := map[string]bool{
+		MaintNotificationsDisabled: true,
+		MaintNotificationsEnabled:  true,
+		MaintNotificationsAuto:     true,
+	}
+	if !validMaintNotifications[c.Enabled] {
+		return ErrInvalidMaintNotifications
+	}
+
+	// Validate EndpointType
 	validEndpointTypes := map[string]bool{
-		"":              true, // Auto-detect
-		"internal-ip":   true,
-		"internal-fqdn": true,
-		"external-ip":   true,
-		"external-fqdn": true,
-		"none":          true,
+		EndpointTypeAuto:         true,
+		EndpointTypeInternalIP:   true,
+		EndpointTypeInternalFQDN: true,
+		EndpointTypeExternalIP:   true,
+		EndpointTypeExternalFQDN: true,
+		EndpointTypeNone:         true,
 	}
-	
 	if !validEndpointTypes[c.EndpointType] {
 		return ErrInvalidEndpointType
 	}
@@ -142,9 +178,19 @@ func (c *Config) ApplyDefaultsWithPoolSize(poolSize int) *Config {
 	}
 
 	defaults := DefaultConfig()
-	result := &Config{
-		Enabled:      c.Enabled, // boolean, no default needed
-		EndpointType: c.EndpointType, // string, empty is valid (auto-detect)
+	result := &Config{}
+
+	// Apply defaults for string fields (empty means not set)
+	if c.Enabled == "" {
+		result.Enabled = defaults.Enabled
+	} else {
+		result.Enabled = c.Enabled
+	}
+
+	if c.EndpointType == "" {
+		result.EndpointType = defaults.EndpointType
+	} else {
+		result.EndpointType = c.EndpointType
 	}
 
 	// Apply defaults for duration fields (zero means not set)

hitless/errors.go

@@ -13,8 +13,9 @@ var (
 	ErrInvalidWorkerRange                = errors.New("hitless: MaxWorkers must be greater than or equal to MinWorkers")
 	ErrInvalidHandoffQueueSize           = errors.New("hitless: handoff queue size must be greater than 0")
 	ErrInvalidPostHandoffRelaxedDuration = errors.New("hitless: post-handoff relaxed duration must be greater than or equal to 0")
-	ErrInvalidLogLevel                   = errors.New("hitless: log level must be between 0 and 3")
-	ErrInvalidEndpointType               = errors.New("hitless: invalid endpoint type")
+	ErrInvalidLogLevel           = errors.New("hitless: log level must be between 0 and 3")
+	ErrInvalidEndpointType       = errors.New("hitless: invalid endpoint type")
+	ErrInvalidMaintNotifications = errors.New("hitless: invalid maintenance notifications setting (must be 'disabled', 'enabled', or 'auto')")
 )
 
 // Integration errors

hitless/example_config_usage.go

@@ -7,8 +7,8 @@ import (
 // ExampleCustomConfig shows how to create a custom hitless configuration
 func ExampleCustomConfig() *Config {
 	return &Config{
-		Enabled:                true,
-		EndpointType:           "internal-ip",
+		Enabled:                MaintNotificationsEnabled,
+		EndpointType:           EndpointTypeInternalIP,
 		RelaxedTimeout:         45 * time.Second,
 		RelaxedTimeoutDuration: 45 * time.Second,
 		HandoffTimeout:         20 * time.Second,
@@ -22,8 +22,8 @@ func ExampleCustomConfig() *Config {
 // ExampleLowResourceConfig shows a configuration for resource-constrained environments
 func ExampleLowResourceConfig() *Config {
 	return &Config{
-		Enabled:                true,
-		EndpointType:           "internal-ip",
+		Enabled:                MaintNotificationsEnabled,
+		EndpointType:           EndpointTypeInternalIP,
 		RelaxedTimeout:         20 * time.Second,
 		RelaxedTimeoutDuration: 20 * time.Second,
 		HandoffTimeout:         10 * time.Second,
@@ -37,8 +37,8 @@ func ExampleLowResourceConfig() *Config {
 // ExampleHighThroughputConfig shows a configuration for high-throughput scenarios
 func ExampleHighThroughputConfig() *Config {
 	return &Config{
-		Enabled:                true,
-		EndpointType:           "internal-ip",
+		Enabled:                MaintNotificationsEnabled,
+		EndpointType:           EndpointTypeInternalIP,
 		RelaxedTimeout:         60 * time.Second,
 		RelaxedTimeoutDuration: 60 * time.Second,
 		HandoffTimeout:         30 * time.Second,
@@ -54,7 +54,7 @@ func ExamplePartialConfig() *Config {
 	// Only specify the fields you want to customize
 	// Other fields will automatically get default values when ApplyDefaults() is called
 	return &Config{
-		Enabled:    true,
+		Enabled:    MaintNotificationsEnabled,
 		MinWorkers: 3,  // Custom minimum worker count
 		MaxWorkers: 15, // Custom maximum worker count
 		LogLevel:   2,  // Info level logging
@@ -69,7 +69,7 @@ func ExamplePartialConfig() *Config {
 func ExampleMinimalConfig() *Config {
 	// Just enable hitless upgrades, everything else gets defaults
 	return &Config{
-		Enabled: true,
+		Enabled: MaintNotificationsEnabled,
 		// All other fields will get default values automatically
 	}
 }