Merge pull request #114 from optimizely/pawel/OASIS-5262

Added project config update notification

Author: pawels-optimizely

go.mod

@@ -9,3 +9,7 @@ require (
 	github.com/stretchr/testify v1.4.0
 	github.com/twmb/murmur3 v1.0.0
 )
+
+
+// Work around issue wtih git.apache.org/thrift.git
+replace git.apache.org/thrift.git => github.com/apache/thrift v0.12.0

optimizely/config/polling_manager.go

@@ -25,6 +25,7 @@ import (
 	"github.com/optimizely/go-sdk/optimizely"
 	"github.com/optimizely/go-sdk/optimizely/config/datafileprojectconfig"
 	"github.com/optimizely/go-sdk/optimizely/logging"
+	"github.com/optimizely/go-sdk/optimizely/notification"
 	"github.com/optimizely/go-sdk/optimizely/utils"
 )
 
@@ -37,18 +38,20 @@ var cmLogger = logging.GetLogger("PollingConfigManager")
 
 // PollingProjectConfigManagerOptions used to create an instance with custom configuration
 type PollingProjectConfigManagerOptions struct {
-	Datafile        []byte
-	PollingInterval time.Duration
-	Requester       utils.Requester
+	Datafile           []byte
+	PollingInterval    time.Duration
+	Requester          utils.Requester
+	NotificationCenter notification.Center
 }
 
 // PollingProjectConfigManager maintains a dynamic copy of the project config
 type PollingProjectConfigManager struct {
-	requester       utils.Requester
-	pollingInterval time.Duration
-	projectConfig   optimizely.ProjectConfig
-	configLock      sync.RWMutex
-	err             error
+	requester          utils.Requester
+	pollingInterval    time.Duration
+	projectConfig      optimizely.ProjectConfig
+	configLock         sync.RWMutex
+	err                error
+	notificationCenter notification.Center
 
 	exeCtx utils.ExecutionCtx // context used for execution control
 }
@@ -77,6 +80,16 @@ func (cm *PollingProjectConfigManager) SyncConfig(datafile []byte) {
 		} else {
 			cmLogger.Debug(fmt.Sprintf("Received new datafile and updated config. Old revision number: %s. New revision number: %s", cm.projectConfig.GetRevision(), projectConfig.GetRevision()))
 			cm.projectConfig = projectConfig
+
+			if cm.notificationCenter != nil {
+				projectConfigUpdateNotification := notification.ProjectConfigUpdateNotification{
+					Type:     notification.ProjectConfigUpdate,
+					Revision: cm.projectConfig.GetRevision(),
+				}
+				if err = cm.notificationCenter.Send(notification.ProjectConfigUpdate, projectConfigUpdateNotification); err != nil {
+					cmLogger.Warning("Problem with sending notification")
+				}
+			}
 		}
 	} else {
 		cm.projectConfig = projectConfig
@@ -120,7 +133,7 @@ func NewPollingProjectConfigManagerWithOptions(exeCtx utils.ExecutionCtx, sdkKey
 		pollingInterval = defaultPollingInterval
 	}
 
-	pollingProjectConfigManager := PollingProjectConfigManager{requester: requester, pollingInterval: pollingInterval, exeCtx: exeCtx}
+	pollingProjectConfigManager := PollingProjectConfigManager{requester: requester, pollingInterval: pollingInterval, notificationCenter: options.NotificationCenter, exeCtx: exeCtx}
 
 	pollingProjectConfigManager.SyncConfig(options.Datafile) // initial poll
 
@@ -142,3 +155,29 @@ func (cm *PollingProjectConfigManager) GetConfig() (optimizely.ProjectConfig, er
 	defer cm.configLock.RUnlock()
 	return cm.projectConfig, cm.err
 }
+
+// OnProjectConfigUpdate registers a handler for ProjectConfigUpdate notifications
+func (cm *PollingProjectConfigManager) OnProjectConfigUpdate(callback func(notification.ProjectConfigUpdateNotification)) (int, error) {
+	handler := func(payload interface{}) {
+		if projectConfigUpdateNotification, ok := payload.(notification.ProjectConfigUpdateNotification); ok {
+			callback(projectConfigUpdateNotification)
+		} else {
+			cmLogger.Warning(fmt.Sprintf("Unable to convert notification payload %v into ProjectConfigUpdateNotification", payload))
+		}
+	}
+	id, err := cm.notificationCenter.AddHandler(notification.ProjectConfigUpdate, handler)
+	if err != nil {
+		cmLogger.Warning("Problem with adding notification handler")
+		return 0, err
+	}
+	return id, nil
+}
+
+// RemoveOnProjectConfigUpdate removes handler for ProjectConfigUpdate notification with given id
+func (cm *PollingProjectConfigManager) RemoveOnProjectConfigUpdate(id int) error {
+	if err := cm.notificationCenter.RemoveHandler(id, notification.ProjectConfigUpdate); err != nil {
+		cmLogger.Warning("Problem with removing notification handler")
+		return err
+	}
+	return nil
+}

optimizely/config/polling_manager_test.go

@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/optimizely/go-sdk/optimizely/config/datafileprojectconfig"
+	"github.com/optimizely/go-sdk/optimizely/notification"
 	"github.com/optimizely/go-sdk/optimizely/utils"
 
 	"github.com/stretchr/testify/assert"
@@ -130,3 +131,43 @@ func TestNewPollingProjectConfigManagerWithDifferentDatafileRevisions(t *testing
 	actual, err = configManager.GetConfig()
 	assert.Equal(t, projectConfig2, actual)
 }
+
+func TestNewPollingProjectConfigManagerOnDecision(t *testing.T) {
+	mockDatafile1 := []byte(`{"revision":"42","botFiltering":true}`)
+	mockDatafile2 := []byte(`{"revision":"43","botFiltering":false}`)
+
+	mockRequester := new(MockRequester)
+	mockRequester.On("Get", []utils.Header(nil)).Return(mockDatafile1, 200, nil)
+
+	// Test we fetch using requester
+	sdkKey := "test_sdk_key"
+	options := PollingProjectConfigManagerOptions{
+		Requester:          mockRequester,
+		NotificationCenter: notification.NewNotificationCenter(),
+	}
+
+	exeCtx := utils.NewCancelableExecutionCtx()
+	configManager := NewPollingProjectConfigManagerWithOptions(exeCtx, sdkKey, options)
+
+	var numberOfCalls = 0
+	callback := func(notification notification.ProjectConfigUpdateNotification) {
+		numberOfCalls++
+	}
+	id, _ := configManager.OnProjectConfigUpdate(callback)
+	mockRequester.AssertExpectations(t)
+
+	actual, err := configManager.GetConfig()
+	assert.Nil(t, err)
+	assert.NotNil(t, actual)
+
+	configManager.SyncConfig(mockDatafile2)
+	actual, err = configManager.GetConfig()
+	assert.Nil(t, err)
+	assert.NotNil(t, actual)
+
+	assert.NotEqual(t, id, 0)
+	assert.Equal(t, numberOfCalls, 1)
+
+	err = configManager.RemoveOnProjectConfigUpdate(id)
+	assert.Nil(t, err)
+}

optimizely/notification/center.go

@@ -34,8 +34,10 @@ type DefaultCenter struct {
 // NewNotificationCenter returns a new notification center
 func NewNotificationCenter() *DefaultCenter {
 	decisionNotificationManager := NewAtomicManager()
+	projectConfigUpdateNotificationManager := NewAtomicManager()
 	managerMap := make(map[Type]Manager)
 	managerMap[Decision] = decisionNotificationManager
+	managerMap[ProjectConfigUpdate] = projectConfigUpdateNotificationManager
 	return &DefaultCenter{
 		managerMap: managerMap,
 	}

optimizely/notification/entities.go

@@ -22,15 +22,14 @@ import "github.com/optimizely/go-sdk/optimizely/entities"
 // Type is the type of notification
 type Type string
 
-const (
-	// Decision notification type
-	Decision Type = "decision"
-)
-
 // DecisionNotificationType is the type of decision notification
 type DecisionNotificationType string
 
 const (
+	// Decision notification type
+	Decision Type = "decision"
+	// ProjectConfigUpdate notification type
+	ProjectConfigUpdate Type = "project_config_update"
 	// Feature is used when the decision is returned as part of evaluating a feature
 	Feature DecisionNotificationType = "feature"
 )
@@ -41,3 +40,9 @@ type DecisionNotification struct {
 	UserContext  entities.UserContext
 	DecisionInfo map[string]interface{}
 }
+
+// ProjectConfigUpdateNotification is a notification triggered when a project config is updated
+type ProjectConfigUpdateNotification struct {
+	Type     Type
+	Revision string
+}