1
0
mirror of https://github.com/redis/go-redis.git synced 2025-07-20 22:42:59 +03:00

feat: remove GetRegistry from PushNotificationProcessorInterface for better encapsulation

- Remove GetRegistry() method from PushNotificationProcessorInterface
- Enforce use of GetHandler() method for cleaner API design
- Add GetRegistryForTesting() method for test access only
- Update all tests to use new testing helper methods
- Maintain clean separation between public API and internal implementation

Benefits:
- Better encapsulation - no direct registry access from public interface
- Cleaner API - forces use of GetHandler() for specific handler access
- Consistent interface design across all processor types
- Internal registry access only available for testing purposes
- Prevents misuse of registry in production code
This commit is contained in:
Nedyalko Dyakov
2025-06-27 14:31:36 +03:00
parent e6c5590255
commit 03bfd9ffcc
3 changed files with 91 additions and 44 deletions

View File

@ -11,6 +11,18 @@ import (
"github.com/redis/go-redis/v9/internal/proto" "github.com/redis/go-redis/v9/internal/proto"
) )
// Helper function to access registry for testing
func getRegistryForTestingCoverage(processor PushNotificationProcessorInterface) *PushNotificationRegistry {
switch p := processor.(type) {
case *PushNotificationProcessor:
return p.GetRegistryForTesting()
case *VoidPushNotificationProcessor:
return p.GetRegistryForTesting()
default:
return nil
}
}
// testHandler is a simple implementation of PushNotificationHandler for testing // testHandler is a simple implementation of PushNotificationHandler for testing
type testHandler struct { type testHandler struct {
handlerFunc func(ctx context.Context, notification []interface{}) bool handlerFunc func(ctx context.Context, notification []interface{}) bool
@ -154,9 +166,10 @@ func TestConnPushNotificationMethods(t *testing.T) {
t.Error("Conn should have push notification processor") t.Error("Conn should have push notification processor")
} }
// Processor should have a registry when enabled // Test that processor can handle handlers when enabled
if processor.GetRegistry() == nil { testHandler := processor.GetHandler("TEST")
t.Error("Conn push notification processor should have a registry when enabled") if testHandler != nil {
t.Error("Should not have handler for TEST initially")
} }
// Test RegisterPushNotificationHandler // Test RegisterPushNotificationHandler
@ -183,16 +196,25 @@ func TestConnPushNotificationMethods(t *testing.T) {
t.Error("Should get error when registering duplicate handler") t.Error("Should get error when registering duplicate handler")
} }
// Test that handlers work // Test that handlers work using GetHandler
registry := processor.GetRegistry()
ctx := context.Background() ctx := context.Background()
handled := registry.HandleNotification(ctx, []interface{}{"TEST_CONN_HANDLER", "data"}) connHandler := processor.GetHandler("TEST_CONN_HANDLER")
if connHandler == nil {
t.Error("Should have handler for TEST_CONN_HANDLER after registration")
return
}
handled := connHandler.HandlePushNotification(ctx, []interface{}{"TEST_CONN_HANDLER", "data"})
if !handled { if !handled {
t.Error("Handler should have been called") t.Error("Handler should have been called")
} }
handled = registry.HandleNotification(ctx, []interface{}{"TEST_CONN_FUNC", "data"}) funcHandler := processor.GetHandler("TEST_CONN_FUNC")
if funcHandler == nil {
t.Error("Should have handler for TEST_CONN_FUNC after registration")
return
}
handled = funcHandler.HandlePushNotification(ctx, []interface{}{"TEST_CONN_FUNC", "data"})
if !handled { if !handled {
t.Error("Handler func should have been called") t.Error("Handler func should have been called")
} }
@ -217,9 +239,10 @@ func TestConnWithoutPushNotifications(t *testing.T) {
if processor == nil { if processor == nil {
t.Error("Conn should always have a push notification processor") t.Error("Conn should always have a push notification processor")
} }
// VoidPushNotificationProcessor should have nil registry // VoidPushNotificationProcessor should return nil for all handlers
if processor.GetRegistry() != nil { handler := processor.GetHandler("TEST")
t.Error("VoidPushNotificationProcessor should have nil registry for RESP2") if handler != nil {
t.Error("VoidPushNotificationProcessor should return nil for all handlers")
} }
// Test RegisterPushNotificationHandler returns nil (no error) // Test RegisterPushNotificationHandler returns nil (no error)
@ -297,10 +320,14 @@ func TestClonedClientPushNotifications(t *testing.T) {
t.Error("Cloned client should have same push notification processor") t.Error("Cloned client should have same push notification processor")
} }
// Test that handlers work on cloned client // Test that handlers work on cloned client using GetHandler
registry := clonedProcessor.GetRegistry()
ctx := context.Background() ctx := context.Background()
handled := registry.HandleNotification(ctx, []interface{}{"TEST_CLONE", "data"}) cloneHandler := clonedProcessor.GetHandler("TEST_CLONE")
if cloneHandler == nil {
t.Error("Cloned client should have TEST_CLONE handler")
return
}
handled := cloneHandler.HandlePushNotification(ctx, []interface{}{"TEST_CLONE", "data"})
if !handled { if !handled {
t.Error("Cloned client should handle notifications") t.Error("Cloned client should handle notifications")
} }

View File

@ -112,7 +112,6 @@ func (r *PushNotificationRegistry) GetHandler(pushNotificationName string) PushN
// PushNotificationProcessorInterface defines the interface for push notification processors. // PushNotificationProcessorInterface defines the interface for push notification processors.
type PushNotificationProcessorInterface interface { type PushNotificationProcessorInterface interface {
GetHandler(pushNotificationName string) PushNotificationHandler GetHandler(pushNotificationName string) PushNotificationHandler
GetRegistry() *PushNotificationRegistry // For backward compatibility and testing
ProcessPendingNotifications(ctx context.Context, rd *proto.Reader) error ProcessPendingNotifications(ctx context.Context, rd *proto.Reader) error
RegisterHandler(pushNotificationName string, handler PushNotificationHandler, protected bool) error RegisterHandler(pushNotificationName string, handler PushNotificationHandler, protected bool) error
} }
@ -135,9 +134,9 @@ func (p *PushNotificationProcessor) GetHandler(pushNotificationName string) Push
return p.registry.GetHandler(pushNotificationName) return p.registry.GetHandler(pushNotificationName)
} }
// GetRegistry returns the push notification registry for internal use. // GetRegistryForTesting returns the push notification registry for testing.
// This method is primarily for testing and internal operations. // This method should only be used by tests.
func (p *PushNotificationProcessor) GetRegistry() *PushNotificationRegistry { func (p *PushNotificationProcessor) GetRegistryForTesting() *PushNotificationRegistry {
return p.registry return p.registry
} }
@ -248,8 +247,9 @@ func (v *VoidPushNotificationProcessor) GetHandler(pushNotificationName string)
return nil return nil
} }
// GetRegistry returns nil for void processor since it doesn't maintain handlers. // GetRegistryForTesting returns nil for void processor since it doesn't maintain handlers.
func (v *VoidPushNotificationProcessor) GetRegistry() *PushNotificationRegistry { // This method should only be used by tests.
func (v *VoidPushNotificationProcessor) GetRegistryForTesting() *PushNotificationRegistry {
return nil return nil
} }

View File

@ -9,6 +9,18 @@ import (
"github.com/redis/go-redis/v9/internal/pool" "github.com/redis/go-redis/v9/internal/pool"
) )
// Helper function to access registry for testing
func getRegistryForTesting(processor redis.PushNotificationProcessorInterface) *redis.PushNotificationRegistry {
switch p := processor.(type) {
case *redis.PushNotificationProcessor:
return p.GetRegistryForTesting()
case *redis.VoidPushNotificationProcessor:
return p.GetRegistryForTesting()
default:
return nil
}
}
// testHandler is a simple implementation of PushNotificationHandler for testing // testHandler is a simple implementation of PushNotificationHandler for testing
type testHandler struct { type testHandler struct {
handlerFunc func(ctx context.Context, notification []interface{}) bool handlerFunc func(ctx context.Context, notification []interface{}) bool
@ -84,8 +96,10 @@ func TestPushNotificationProcessor(t *testing.T) {
// Test the push notification processor // Test the push notification processor
processor := redis.NewPushNotificationProcessor() processor := redis.NewPushNotificationProcessor()
if processor.GetRegistry() == nil { // Test that we can get a handler (should be nil since none registered yet)
t.Error("Processor should have a registry") handler := processor.GetHandler("TEST")
if handler != nil {
t.Error("Should not have handler for TEST initially")
} }
// Test registering handlers // Test registering handlers
@ -106,10 +120,15 @@ func TestPushNotificationProcessor(t *testing.T) {
t.Fatalf("Failed to register handler: %v", err) t.Fatalf("Failed to register handler: %v", err)
} }
// Simulate handling a notification // Simulate handling a notification using GetHandler
ctx := context.Background() ctx := context.Background()
notification := []interface{}{"CUSTOM_NOTIFICATION", "data"} notification := []interface{}{"CUSTOM_NOTIFICATION", "data"}
handled := processor.GetRegistry().HandleNotification(ctx, notification) customHandler := processor.GetHandler("CUSTOM_NOTIFICATION")
if customHandler == nil {
t.Error("Should have handler for CUSTOM_NOTIFICATION after registration")
return
}
handled := customHandler.HandlePushNotification(ctx, notification)
if !handled { if !handled {
t.Error("Notification should have been handled") t.Error("Notification should have been handled")
@ -119,9 +138,10 @@ func TestPushNotificationProcessor(t *testing.T) {
t.Error("Specific handler should have been called") t.Error("Specific handler should have been called")
} }
// Test that processor always has a registry (no enable/disable anymore) // Test that processor can retrieve handlers (no enable/disable anymore)
if processor.GetRegistry() == nil { retrievedHandler := processor.GetHandler("CUSTOM_NOTIFICATION")
t.Error("Processor should always have a registry") if retrievedHandler == nil {
t.Error("Should be able to retrieve registered handler")
} }
} }
@ -140,7 +160,7 @@ func TestClientPushNotificationIntegration(t *testing.T) {
t.Error("Push notification processor should be initialized") t.Error("Push notification processor should be initialized")
} }
if processor.GetRegistry() == nil { if getRegistryForTesting(processor) == nil {
t.Error("Push notification processor should have a registry when enabled") t.Error("Push notification processor should have a registry when enabled")
} }
@ -157,7 +177,7 @@ func TestClientPushNotificationIntegration(t *testing.T) {
// Simulate notification handling // Simulate notification handling
ctx := context.Background() ctx := context.Background()
notification := []interface{}{"CUSTOM_EVENT", "test_data"} notification := []interface{}{"CUSTOM_EVENT", "test_data"}
handled := processor.GetRegistry().HandleNotification(ctx, notification) handled := getRegistryForTesting(processor).HandleNotification(ctx, notification)
if !handled { if !handled {
t.Error("Notification should have been handled") t.Error("Notification should have been handled")
@ -183,7 +203,7 @@ func TestClientWithoutPushNotifications(t *testing.T) {
t.Error("Push notification processor should never be nil") t.Error("Push notification processor should never be nil")
} }
// VoidPushNotificationProcessor should have nil registry // VoidPushNotificationProcessor should have nil registry
if processor.GetRegistry() != nil { if getRegistryForTesting(processor) != nil {
t.Error("VoidPushNotificationProcessor should have nil registry") t.Error("VoidPushNotificationProcessor should have nil registry")
} }
@ -211,8 +231,9 @@ func TestPushNotificationEnabledClient(t *testing.T) {
t.Error("Push notification processor should be initialized when enabled") t.Error("Push notification processor should be initialized when enabled")
} }
if processor.GetRegistry() == nil { registry := getRegistryForTesting(processor)
t.Error("Push notification processor should have a registry when enabled") if registry == nil {
t.Errorf("Push notification processor should have a registry when enabled. Processor type: %T", processor)
} }
// Test registering a handler // Test registering a handler
@ -226,7 +247,6 @@ func TestPushNotificationEnabledClient(t *testing.T) {
} }
// Test that the handler works // Test that the handler works
registry := processor.GetRegistry()
ctx := context.Background() ctx := context.Background()
notification := []interface{}{"TEST_NOTIFICATION", "data"} notification := []interface{}{"TEST_NOTIFICATION", "data"}
handled := registry.HandleNotification(ctx, notification) handled := registry.HandleNotification(ctx, notification)
@ -375,7 +395,7 @@ func TestPubSubWithGenericPushNotifications(t *testing.T) {
// Test that the processor can handle notifications // Test that the processor can handle notifications
notification := []interface{}{"CUSTOM_PUBSUB_EVENT", "arg1", "arg2"} notification := []interface{}{"CUSTOM_PUBSUB_EVENT", "arg1", "arg2"}
handled := processor.GetRegistry().HandleNotification(context.Background(), notification) handled := getRegistryForTesting(processor).HandleNotification(context.Background(), notification)
if !handled { if !handled {
t.Error("Push notification should have been handled") t.Error("Push notification should have been handled")
@ -559,7 +579,7 @@ func TestPushNotificationProcessorEdgeCases(t *testing.T) {
// Test processor with disabled state // Test processor with disabled state
processor := redis.NewPushNotificationProcessor() processor := redis.NewPushNotificationProcessor()
if processor.GetRegistry() == nil { if getRegistryForTesting(processor) == nil {
t.Error("Processor should have a registry") t.Error("Processor should have a registry")
} }
@ -573,7 +593,7 @@ func TestPushNotificationProcessorEdgeCases(t *testing.T) {
// Even with handlers registered, disabled processor shouldn't process // Even with handlers registered, disabled processor shouldn't process
ctx := context.Background() ctx := context.Background()
notification := []interface{}{"TEST_CMD", "data"} notification := []interface{}{"TEST_CMD", "data"}
handled := processor.GetRegistry().HandleNotification(ctx, notification) handled := getRegistryForTesting(processor).HandleNotification(ctx, notification)
if !handled { if !handled {
t.Error("Registry should still handle notifications even when processor is disabled") t.Error("Registry should still handle notifications even when processor is disabled")
@ -584,7 +604,7 @@ func TestPushNotificationProcessorEdgeCases(t *testing.T) {
} }
// Test that processor always has a registry // Test that processor always has a registry
if processor.GetRegistry() == nil { if getRegistryForTesting(processor) == nil {
t.Error("Processor should always have a registry") t.Error("Processor should always have a registry")
} }
} }
@ -619,7 +639,7 @@ func TestPushNotificationProcessorConvenienceMethods(t *testing.T) {
// Test specific handler // Test specific handler
notification := []interface{}{"CONV_CMD", "data"} notification := []interface{}{"CONV_CMD", "data"}
handled := processor.GetRegistry().HandleNotification(ctx, notification) handled := getRegistryForTesting(processor).HandleNotification(ctx, notification)
if !handled { if !handled {
t.Error("Notification should be handled") t.Error("Notification should be handled")
@ -635,7 +655,7 @@ func TestPushNotificationProcessorConvenienceMethods(t *testing.T) {
// Test func handler // Test func handler
notification = []interface{}{"FUNC_CMD", "data"} notification = []interface{}{"FUNC_CMD", "data"}
handled = processor.GetRegistry().HandleNotification(ctx, notification) handled = getRegistryForTesting(processor).HandleNotification(ctx, notification)
if !handled { if !handled {
t.Error("Notification should be handled") t.Error("Notification should be handled")
@ -676,7 +696,7 @@ func TestClientPushNotificationEdgeCases(t *testing.T) {
t.Error("Processor should never be nil") t.Error("Processor should never be nil")
} }
// VoidPushNotificationProcessor should have nil registry // VoidPushNotificationProcessor should have nil registry
if processor.GetRegistry() != nil { if getRegistryForTesting(processor) != nil {
t.Error("VoidPushNotificationProcessor should have nil registry when disabled") t.Error("VoidPushNotificationProcessor should have nil registry when disabled")
} }
} }
@ -838,10 +858,10 @@ func TestPushNotificationProcessorConcurrency(t *testing.T) {
// Handle notifications // Handle notifications
notification := []interface{}{command, "data"} notification := []interface{}{command, "data"}
processor.GetRegistry().HandleNotification(context.Background(), notification) getRegistryForTesting(processor).HandleNotification(context.Background(), notification)
// Access processor state // Access processor state
processor.GetRegistry() getRegistryForTesting(processor)
} }
}(i) }(i)
} }
@ -852,7 +872,7 @@ func TestPushNotificationProcessorConcurrency(t *testing.T) {
} }
// Verify processor is still functional // Verify processor is still functional
registry := processor.GetRegistry() registry := getRegistryForTesting(processor)
if registry == nil { if registry == nil {
t.Error("Processor registry should not be nil after concurrent operations") t.Error("Processor registry should not be nil after concurrent operations")
} }
@ -887,7 +907,7 @@ func TestPushNotificationClientConcurrency(t *testing.T) {
// Access processor // Access processor
processor := client.GetPushNotificationProcessor() processor := client.GetPushNotificationProcessor()
if processor != nil { if processor != nil {
processor.GetRegistry() getRegistryForTesting(processor)
} }
} }
}(i) }(i)
@ -921,7 +941,7 @@ func TestPushNotificationConnectionHealthCheck(t *testing.T) {
if processor == nil { if processor == nil {
t.Fatal("Push notification processor should not be nil") t.Fatal("Push notification processor should not be nil")
} }
if processor.GetRegistry() == nil { if getRegistryForTesting(processor) == nil {
t.Fatal("Push notification registry should not be nil when enabled") t.Fatal("Push notification registry should not be nil when enabled")
} }