This commit includes all the work on hitless upgrades with the addition
of:
- Pubsub Pool
- Examples
- Refactor of push
- Refactor of pool (using atomics for most things)
- Introducing of hooks in pool
* Fix hard code of failing timeout
1. if not set failing time limit, default is 15 seconds.
* feat: Complete configurable FailingTimeoutSeconds implementation
---------
Co-authored-by: Shino Wu <shino_wu@trendmicro.com>
- replace two similar functions `appendUniqueNode` and `appendIfNotExists` with a generic function.
- simplify the implementation of the `get` method in `clusterNodes`
- keep the member name `_generation` of `clusterNodes` consistent with other types.
- rename a data member `_masterAddr` to `masterAddr`.
Signed-off-by: Xiaolong Chen <fukua95@gmail.com>
Consolidate all push notification handling logic in the root package to eliminate
adapters and simplify the architecture. This provides direct access to concrete
types without any intermediate layers or type conversions.
Key Changes:
1. Moved Core Types to Root Package:
- Moved Registry, Processor, VoidProcessor to push_notifications.go
- Moved all push notification constants to root package
- Removed internal/pushnotif package dependencies
- Direct implementation without internal abstractions
2. Eliminated All Adapters:
- Removed handlerAdapter that bridged internal and public interfaces
- Removed voidProcessorAdapter for void processor functionality
- Removed convertInternalToPublicContext conversion functions
- Direct usage of concrete types throughout
3. Simplified Architecture:
- PushNotificationHandlerContext directly implemented in root package
- PushNotificationHandler directly implemented in root package
- Registry, Processor, VoidProcessor directly in root package
- No intermediate layers or type conversions needed
4. Direct Type Usage:
- GetClusterClient() returns *ClusterClient directly
- GetSentinelClient() returns *SentinelClient directly
- GetRegularClient() returns *Client directly
- GetPubSub() returns *PubSub directly
- No interface casting or type assertions required
5. Updated All Integration Points:
- Updated redis.go to use direct types
- Updated pubsub.go to use direct types
- Updated sentinel.go to use direct types
- Removed all internal/pushnotif imports
- Simplified context creation and usage
6. Core Implementation in Root Package:
```go
// Direct implementation - no adapters needed
type Registry struct {
handlers map[string]PushNotificationHandler
protected map[string]bool
}
type Processor struct {
registry *Registry
}
type VoidProcessor struct{}
```
7. Handler Context with Concrete Types:
```go
type PushNotificationHandlerContext interface {
GetClusterClient() *ClusterClient // Direct concrete type
GetSentinelClient() *SentinelClient // Direct concrete type
GetRegularClient() *Client // Direct concrete type
GetPubSub() *PubSub // Direct concrete type
}
```
8. Comprehensive Test Suite:
- Added push_notifications_test.go with full test coverage
- Tests for Registry, Processor, VoidProcessor
- Tests for HandlerContext with concrete type access
- Tests for all push notification constants
- Validates all functionality works correctly
9. Benefits:
- Eliminated complex adapter pattern
- Removed unnecessary type conversions
- Simplified codebase with direct type usage
- Better performance without adapter overhead
- Cleaner architecture with single source of truth
- Enhanced developer experience with direct access
10. Architecture Simplification:
Before: Client -> Adapter -> Internal -> Adapter -> Handler
After: Client -> Handler (direct)
No more:
- handlerAdapter bridging interfaces
- voidProcessorAdapter for void functionality
- convertInternalToPublicContext conversions
- Complex type mapping between layers
This refactoring provides a much cleaner, simpler architecture where all
push notification logic lives in the root package with direct access to
concrete Redis client types, eliminating unnecessary complexity while
maintaining full functionality and type safety.
Move push notification handler and context interfaces to main package to enable
strongly typed getters using concrete Redis client types instead of interfaces.
This provides much better type safety and usability for push notification handlers.
Key Changes:
1. Main Package Implementation:
- Moved PushNotificationHandlerContext to push_notifications.go
- Moved PushNotificationHandler to push_notifications.go
- Implemented concrete types for all getters
- GetClusterClient() returns *ClusterClient
- GetSentinelClient() returns *SentinelClient
- GetRegularClient() returns *Client
- GetPubSub() returns *PubSub
2. Concrete Type Benefits:
- No need for interface definitions or type assertions
- Direct access to concrete client methods and properties
- Compile-time type checking with actual client types
- IntelliSense support for all client-specific methods
- No runtime panics from incorrect type casting
3. Handler Interface with Concrete Types:
```go
type PushNotificationHandlerContext interface {
GetClusterClient() *ClusterClient
GetSentinelClient() *SentinelClient
GetRegularClient() *Client
GetPubSub() *PubSub
GetConn() *pool.Conn
IsBlocking() bool
}
```
4. Adapter Pattern Implementation:
- Created handlerAdapter to bridge internal and public interfaces
- Created voidProcessorAdapter for void processor functionality
- Seamless conversion between internal and public contexts
- Maintains compatibility with existing internal architecture
5. Context Conversion Functions:
- convertInternalToPublicContext() for seamless conversion
- Proper context bridging between internal and public APIs
- Maintains all context information during conversion
- Consistent behavior across all client types
6. Updated All Integration Points:
- Updated redis.go to use public context conversion
- Updated pubsub.go to use public context conversion
- Updated sentinel.go to use void processor adapter
- Maintained backward compatibility with existing code
7. Handler Usage Example:
```go
func (h *MyHandler) HandlePushNotification(
ctx context.Context,
handlerCtx PushNotificationHandlerContext,
notification []interface{},
) bool {
// Direct access to concrete types - no casting needed!
if clusterClient := handlerCtx.GetClusterClient(); clusterClient != nil {
// Full access to ClusterClient methods
nodes := clusterClient.ClusterNodes(ctx)
// ... cluster-specific logic
}
if regularClient := handlerCtx.GetRegularClient(); regularClient != nil {
// Full access to Client methods
info := regularClient.Info(ctx)
// ... regular client logic
}
return true
}
```
8. Type Safety Improvements:
- No interface{} fields in public API
- Concrete return types for all getters
- Compile-time verification of client type usage
- Clear API with explicit client type access
- Enhanced developer experience with full type information
Benefits:
- Strongly typed access to concrete Redis client types
- No type assertions or interface casting required
- Full IntelliSense support for client-specific methods
- Compile-time type checking prevents runtime errors
- Clean public API with concrete types
- Seamless integration with existing internal architecture
- Enhanced developer experience and productivity
This implementation provides handlers with direct access to concrete Redis
client types while maintaining the flexibility and context information needed
for sophisticated push notification handling, particularly important for
hitless upgrades and cluster management operations.
Convert HandlerContext from struct to interface with strongly typed getters
for different client types. This provides better type safety and a cleaner
API for push notification handlers while maintaining flexibility.
Key Changes:
1. HandlerContext Interface Design:
- Converted HandlerContext from struct to interface
- Added strongly typed getters for different client types
- GetClusterClient() returns ClusterClientInterface
- GetSentinelClient() returns SentinelClientInterface
- GetFailoverClient() returns FailoverClientInterface
- GetRegularClient() returns RegularClientInterface
- GetPubSub() returns PubSubInterface
2. Client Type Interfaces:
- Defined ClusterClientInterface for cluster client access
- Defined SentinelClientInterface for sentinel client access
- Defined FailoverClientInterface for failover client access
- Defined RegularClientInterface for regular client access
- Defined PubSubInterface for pub/sub access
- Each interface provides String() method for basic operations
3. Concrete Implementation:
- Created handlerContext struct implementing HandlerContext interface
- Added NewHandlerContext constructor function
- Implemented type-safe getters with interface casting
- Returns nil for incorrect client types (type safety)
4. Updated All Usage:
- Updated Handler interface to use HandlerContext interface
- Updated ProcessorInterface to use HandlerContext interface
- Updated all processor implementations (Processor, VoidProcessor)
- Updated all handler context creation sites
- Updated test handlers and test context creation
5. Helper Methods:
- Updated pushNotificationHandlerContext() in baseClient
- Updated pushNotificationHandlerContext() in PubSub
- Consistent context creation across all client types
- Proper parameter passing for different connection types
6. Type Safety Benefits:
- Handlers can safely cast to specific client types
- Compile-time checking for client type access
- Clear API for accessing different client capabilities
- No runtime panics from incorrect type assertions
7. API Usage Example:
```go
func (h *MyHandler) HandlePushNotification(
ctx context.Context,
handlerCtx HandlerContext,
notification []interface{},
) bool {
// Strongly typed access
if clusterClient := handlerCtx.GetClusterClient(); clusterClient != nil {
// Handle cluster-specific logic
}
if sentinelClient := handlerCtx.GetSentinelClient(); sentinelClient != nil {
// Handle sentinel-specific logic
}
return true
}
```
8. Backward Compatibility:
- Interface maintains same functionality as original struct
- All existing handler patterns continue to work
- No breaking changes to handler implementations
- Smooth migration path for existing code
Benefits:
- Strong type safety for client access in handlers
- Clear API with explicit client type getters
- Compile-time checking prevents runtime errors
- Flexible interface allows future extensions
- Better separation of concerns between client types
- Enhanced developer experience with IntelliSense support
This enhancement provides handlers with strongly typed access to different
Redis client types while maintaining the flexibility and context information
needed for sophisticated push notification handling, particularly important
for hitless upgrades and cluster management operations.
- Add PushNotifications field to FailoverOptions struct
- Update clientOptions() to pass PushNotifications field to Options
- Change SentinelClient and FailoverClient initialization to use same logic as regular Client
- Both clients now support real push notification processors when enabled
- Both clients use void processors only when explicitly disabled
- Consistent behavior across all client types (Client, SentinelClient, FailoverClient)
Benefits:
- SentinelClient and FailoverClient can now fully utilize push notifications
- Consistent API across all client types
- Real processors when push notifications are enabled
- Void processors only when explicitly disabled
- Equal push notification capabilities for all Redis client types
- Add GetHandler() method to PushNotificationProcessorInterface for better encapsulation
- Add GetPushNotificationHandler() convenience method to Client and SentinelClient
- Remove HasHandlers() check from ProcessPendingNotifications to ensure notifications are always consumed
- Use PushNotificationProcessorInterface in internal pool package for proper abstraction
- Maintain GetRegistry() for backward compatibility and testing
- Update pubsub to use GetHandler() instead of GetRegistry() for cleaner code
Benefits:
- Better API encapsulation - no need to expose entire registry
- Cleaner interface - direct access to specific handlers
- Always consume push notifications from reader regardless of handler presence
- Proper abstraction in internal pool package
- Backward compatibility maintained
- Consistent behavior across all processor types
- Add push processor initialization to NewFailoverClient to prevent nil pointer dereference
- Use VoidPushNotificationProcessor for failover clients (typically don't need push notifications)
- Ensure consistent behavior across all client creation paths including failover scenarios
- Complete the coverage of all client types that inherit from baseClient
This fixes the final nil pointer dereference that was occurring in failover client
contexts where the pushProcessor field was nil, causing segmentation violations
during Redis operations in sentinel-managed failover scenarios.
- Add push processor initialization to NewSentinelClient to prevent nil pointer dereference
- Add GetPushNotificationProcessor and RegisterPushNotificationHandler methods to SentinelClient
- Use VoidPushNotificationProcessor for Sentinel (typically doesn't need push notifications)
- Ensure consistent behavior across all client types that inherit from baseClient
This fixes the panic that was occurring in Sentinel contexts where the pushProcessor
field was nil, causing segmentation violations when processing commands.
* wip
* update documentation
* add streamingcredentialsprovider in options
* fix: put back option in pool creation
* add package level comment
* Initial re authentication implementation
Introduces the StreamingCredentialsProvider as the CredentialsProvider
with the highest priority.
TODO: needs to be tested
* Change function type name
Change CancelProviderFunc to UnsubscribeFunc
* add tests
* fix race in tests
* fix example tests
* wip, hooks refactor
* fix build
* update README.md
* update wordlist
* update README.md
* refactor(auth): early returns in cred listener
* fix(doctest): simulate some delay
* feat(conn): add close hook on conn
* fix(tests): simulate start/stop in mock credentials provider
* fix(auth): don't double close the conn
* docs(README): mark streaming credentials provider as experimental
* fix(auth): streamline auth err proccess
* fix(auth): check err on close conn
* chore(entraid): use the repo under redis org
* Better error handling when fetching the master node from the sentinels
* fix error message generation
* close the errCh to not block
* use len over errCh
* fix: handle network error on SETINFO
This fix addresses potential out of order responses as described in `CVE-2025-29923`
* fix: deprecate DisableIndentity and introduce DisableIdentity
Both options will work before V10. In v10 DisableIndentity will be dropped. The preferred flag to use is `DisableIdentity`.
