package maintnotifications import ( "context" "errors" "fmt" "time" "github.com/redis/go-redis/v9/internal" "github.com/redis/go-redis/v9/internal/maintnotifications/logs" "github.com/redis/go-redis/v9/internal/pool" "github.com/redis/go-redis/v9/push" ) // NotificationHandler handles push notifications for the simplified manager. type NotificationHandler struct { manager *Manager operationsManager OperationsManagerInterface } // HandlePushNotification processes push notifications with hook support. func (snh *NotificationHandler) HandlePushNotification(ctx context.Context, handlerCtx push.NotificationHandlerContext, notification []interface{}) error { if len(notification) == 0 { internal.Logger.Printf(ctx, logs.InvalidNotificationFormat(notification)) return ErrInvalidNotification } notificationType, ok := notification[0].(string) if !ok { internal.Logger.Printf(ctx, logs.InvalidNotificationTypeFormat(notification[0])) return ErrInvalidNotification } // Process pre-hooks - they can modify the notification or skip processing modifiedNotification, shouldContinue := snh.manager.processPreHooks(ctx, handlerCtx, notificationType, notification) if !shouldContinue { return nil // Hooks decided to skip processing } var err error switch notificationType { case NotificationMoving: err = snh.handleMoving(ctx, handlerCtx, modifiedNotification) case NotificationMigrating: err = snh.handleMigrating(ctx, handlerCtx, modifiedNotification) case NotificationMigrated: err = snh.handleMigrated(ctx, handlerCtx, modifiedNotification) case NotificationFailingOver: err = snh.handleFailingOver(ctx, handlerCtx, modifiedNotification) case NotificationFailedOver: err = snh.handleFailedOver(ctx, handlerCtx, modifiedNotification) default: // Ignore other notification types (e.g., pub/sub messages) err = nil } // Process post-hooks with the result snh.manager.processPostHooks(ctx, handlerCtx, notificationType, modifiedNotification, err) return err } // handleMoving processes MOVING notifications. // ["MOVING", seqNum, timeS, endpoint] - per-connection handoff func (snh *NotificationHandler) handleMoving(ctx context.Context, handlerCtx push.NotificationHandlerContext, notification []interface{}) error { if len(notification) < 3 { internal.Logger.Printf(ctx, logs.InvalidNotification("MOVING", notification)) return ErrInvalidNotification } seqID, ok := notification[1].(int64) if !ok { internal.Logger.Printf(ctx, logs.InvalidSeqIDInMovingNotification(notification[1])) return ErrInvalidNotification } // Extract timeS timeS, ok := notification[2].(int64) if !ok { internal.Logger.Printf(ctx, logs.InvalidTimeSInMovingNotification(notification[2])) return ErrInvalidNotification } newEndpoint := "" if len(notification) > 3 { // Extract new endpoint newEndpoint, ok = notification[3].(string) if !ok { stringified := fmt.Sprintf("%v", notification[3]) // this could be which is valid if notification[3] == nil || stringified == internal.RedisNull { newEndpoint = "" } else { internal.Logger.Printf(ctx, logs.InvalidNewEndpointInMovingNotification(notification[3])) return ErrInvalidNotification } } } // Get the connection that received this notification conn := handlerCtx.Conn if conn == nil { internal.Logger.Printf(ctx, logs.NoConnectionInHandlerContext("MOVING")) return ErrInvalidNotification } // Type assert to get the underlying pool connection var poolConn *pool.Conn if pc, ok := conn.(*pool.Conn); ok { poolConn = pc } else { internal.Logger.Printf(ctx, logs.InvalidConnectionTypeInHandlerContext("MOVING", conn, handlerCtx)) return ErrInvalidNotification } // If the connection is closed or not pooled, we can ignore the notification // this connection won't be remembered by the pool and will be garbage collected // Keep pubsub connections around since they are not pooled but are long-lived // and should be allowed to handoff (the pubsub instance will reconnect and change // the underlying *pool.Conn) if (poolConn.IsClosed() || !poolConn.IsPooled()) && !poolConn.IsPubSub() { return nil } deadline := time.Now().Add(time.Duration(timeS) * time.Second) // If newEndpoint is empty, we should schedule a handoff to the current endpoint in timeS/2 seconds if newEndpoint == "" || newEndpoint == internal.RedisNull { if internal.LogLevel.DebugOrAbove() { internal.Logger.Printf(ctx, logs.SchedulingHandoffToCurrentEndpoint(poolConn.GetID(), float64(timeS)/2)) } // same as current endpoint newEndpoint = snh.manager.options.GetAddr() // delay the handoff for timeS/2 seconds to the same endpoint // do this in a goroutine to avoid blocking the notification handler // NOTE: This timer is started while parsing the notification, so the connection is not marked for handoff // and there should be no possibility of a race condition or double handoff. time.AfterFunc(time.Duration(timeS/2)*time.Second, func() { if poolConn == nil || poolConn.IsClosed() { return } if err := snh.markConnForHandoff(poolConn, newEndpoint, seqID, deadline); err != nil { // Log error but don't fail the goroutine - use background context since original may be cancelled internal.Logger.Printf(context.Background(), logs.FailedToMarkForHandoff(poolConn.GetID(), err)) } }) return nil } return snh.markConnForHandoff(poolConn, newEndpoint, seqID, deadline) } func (snh *NotificationHandler) markConnForHandoff(conn *pool.Conn, newEndpoint string, seqID int64, deadline time.Time) error { if err := conn.MarkForHandoff(newEndpoint, seqID); err != nil { internal.Logger.Printf(context.Background(), logs.FailedToMarkForHandoff(conn.GetID(), err)) // Connection is already marked for handoff, which is acceptable // This can happen if multiple MOVING notifications are received for the same connection return nil } // Optionally track in m if snh.operationsManager != nil { connID := conn.GetID() // Track the operation (ignore errors since this is optional) _ = snh.operationsManager.TrackMovingOperationWithConnID(context.Background(), newEndpoint, deadline, seqID, connID) } else { return errors.New(logs.ManagerNotInitialized()) } return nil } // handleMigrating processes MIGRATING notifications. func (snh *NotificationHandler) handleMigrating(ctx context.Context, handlerCtx push.NotificationHandlerContext, notification []interface{}) error { // MIGRATING notifications indicate that a connection is about to be migrated // Apply relaxed timeouts to the specific connection that received this notification if len(notification) < 2 { internal.Logger.Printf(ctx, logs.InvalidNotification("MIGRATING", notification)) return ErrInvalidNotification } if handlerCtx.Conn == nil { internal.Logger.Printf(ctx, logs.NoConnectionInHandlerContext("MIGRATING")) return ErrInvalidNotification } conn, ok := handlerCtx.Conn.(*pool.Conn) if !ok { internal.Logger.Printf(ctx, logs.InvalidConnectionTypeInHandlerContext("MIGRATING", handlerCtx.Conn, handlerCtx)) return ErrInvalidNotification } // Apply relaxed timeout to this specific connection if internal.LogLevel.InfoOrAbove() { internal.Logger.Printf(ctx, logs.RelaxedTimeoutDueToNotification(conn.GetID(), "MIGRATING", snh.manager.config.RelaxedTimeout)) } conn.SetRelaxedTimeout(snh.manager.config.RelaxedTimeout, snh.manager.config.RelaxedTimeout) return nil } // handleMigrated processes MIGRATED notifications. func (snh *NotificationHandler) handleMigrated(ctx context.Context, handlerCtx push.NotificationHandlerContext, notification []interface{}) error { // MIGRATED notifications indicate that a connection migration has completed // Restore normal timeouts for the specific connection that received this notification if len(notification) < 2 { internal.Logger.Printf(ctx, logs.InvalidNotification("MIGRATED", notification)) return ErrInvalidNotification } if handlerCtx.Conn == nil { internal.Logger.Printf(ctx, logs.NoConnectionInHandlerContext("MIGRATED")) return ErrInvalidNotification } conn, ok := handlerCtx.Conn.(*pool.Conn) if !ok { internal.Logger.Printf(ctx, logs.InvalidConnectionTypeInHandlerContext("MIGRATED", handlerCtx.Conn, handlerCtx)) return ErrInvalidNotification } // Clear relaxed timeout for this specific connection if internal.LogLevel.InfoOrAbove() { connID := conn.GetID() internal.Logger.Printf(ctx, logs.UnrelaxedTimeout(connID)) } conn.ClearRelaxedTimeout() return nil } // handleFailingOver processes FAILING_OVER notifications. func (snh *NotificationHandler) handleFailingOver(ctx context.Context, handlerCtx push.NotificationHandlerContext, notification []interface{}) error { // FAILING_OVER notifications indicate that a connection is about to failover // Apply relaxed timeouts to the specific connection that received this notification if len(notification) < 2 { internal.Logger.Printf(ctx, logs.InvalidNotification("FAILING_OVER", notification)) return ErrInvalidNotification } if handlerCtx.Conn == nil { internal.Logger.Printf(ctx, logs.NoConnectionInHandlerContext("FAILING_OVER")) return ErrInvalidNotification } conn, ok := handlerCtx.Conn.(*pool.Conn) if !ok { internal.Logger.Printf(ctx, logs.InvalidConnectionTypeInHandlerContext("FAILING_OVER", handlerCtx.Conn, handlerCtx)) return ErrInvalidNotification } // Apply relaxed timeout to this specific connection if internal.LogLevel.InfoOrAbove() { connID := conn.GetID() internal.Logger.Printf(ctx, logs.RelaxedTimeoutDueToNotification(connID, "FAILING_OVER", snh.manager.config.RelaxedTimeout)) } conn.SetRelaxedTimeout(snh.manager.config.RelaxedTimeout, snh.manager.config.RelaxedTimeout) return nil } // handleFailedOver processes FAILED_OVER notifications. func (snh *NotificationHandler) handleFailedOver(ctx context.Context, handlerCtx push.NotificationHandlerContext, notification []interface{}) error { // FAILED_OVER notifications indicate that a connection failover has completed // Restore normal timeouts for the specific connection that received this notification if len(notification) < 2 { internal.Logger.Printf(ctx, logs.InvalidNotification("FAILED_OVER", notification)) return ErrInvalidNotification } if handlerCtx.Conn == nil { internal.Logger.Printf(ctx, logs.NoConnectionInHandlerContext("FAILED_OVER")) return ErrInvalidNotification } conn, ok := handlerCtx.Conn.(*pool.Conn) if !ok { internal.Logger.Printf(ctx, logs.InvalidConnectionTypeInHandlerContext("FAILED_OVER", handlerCtx.Conn, handlerCtx)) return ErrInvalidNotification } // Clear relaxed timeout for this specific connection if internal.LogLevel.InfoOrAbove() { connID := conn.GetID() internal.Logger.Printf(ctx, logs.UnrelaxedTimeout(connID)) } conn.ClearRelaxedTimeout() return nil }