feat(event-dispatcher): Exposing logx URL for agent. (#268)

Author: yasirfolio3

pkg/event/dispatcher_test.go

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019, Optimizely, Inc. and contributors                        *
+ * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -106,7 +106,7 @@ func TestQueueEventDispatcher_DispatchEvent(t *testing.T) {
 	q := NewQueueEventDispatcher("", metricsRegistry)
 
 	assert.True(t, q.Dispatcher != nil)
-	if d,ok := q.Dispatcher.(*httpEventDispatcher); ok {
+	if d, ok := q.Dispatcher.(*httpEventDispatcher); ok {
 		assert.True(t, d.requester != nil && d.logger != nil)
 	} else {
 		assert.True(t, false)
@@ -121,7 +121,7 @@ func TestQueueEventDispatcher_DispatchEvent(t *testing.T) {
 
 	batch := createBatchEvent(conversionUserEvent, createVisitorFromUserEvent(conversionUserEvent))
 
-	logEvent := createLogEvent(batch)
+	logEvent := createLogEvent(batch, DefaultEventEndPoint)
 
 	success, _ := q.DispatchEvent(logEvent)
 
@@ -179,7 +179,7 @@ func TestQueueEventDispatcher_FailDispath(t *testing.T) {
 
 	batch := createBatchEvent(conversionUserEvent, createVisitorFromUserEvent(conversionUserEvent))
 
-	logEvent := createLogEvent(batch)
+	logEvent := createLogEvent(batch, DefaultEventEndPoint)
 
 	q.DispatchEvent(logEvent)
 

pkg/event/factory.go

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019, Optimizely, Inc. and contributors                        *
+ * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -32,11 +32,10 @@ const impressionKey string = "campaign_activated"
 const attributeType = "custom"
 const specialPrefix = "$opt_"
 const botFilteringKey = "$opt_bot_filtering"
-const eventEndPoint = "https://logx.optimizely.com/v1/events"
 const revenueKey = "revenue"
 const valueKey = "value"
 
-func createLogEvent(event Batch) LogEvent {
+func createLogEvent(event Batch, eventEndPoint string) LogEvent {
 	return LogEvent{EndPoint: eventEndPoint, Event: event}
 }
 

pkg/event/processor.go

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019, Optimizely, Inc. and contributors                        *
+ * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -46,6 +46,7 @@ type BatchEventProcessor struct {
 	MaxQueueSize    int           // max size of the queue before flush
 	FlushInterval   time.Duration // in milliseconds
 	BatchSize       int
+	EventEndPoint   string
 	Q               Queue
 	flushLock       sync.Mutex
 	Ticker          *time.Ticker
@@ -64,6 +65,9 @@ const DefaultEventQueueSize = 2000
 // DefaultEventFlushInterval holds the default value for the event flush interval
 const DefaultEventFlushInterval = 30 * time.Second
 
+// DefaultEventEndPoint is used as the default endpoint for sending events.
+const DefaultEventEndPoint = "https://logx.optimizely.com/v1/events"
+
 const maxFlushWorkers = 1
 
 // BPOptionConfig is the BatchProcessor options that give you the ability to add one more more options before the processor is initialized.
@@ -76,6 +80,13 @@ func WithBatchSize(bsize int) BPOptionConfig {
 	}
 }
 
+// WithEventEndPoint sets the end point as a config option to be passed into the NewProcessor method
+func WithEventEndPoint(endPoint string) BPOptionConfig {
+	return func(qp *BatchEventProcessor) {
+		qp.EventEndPoint = endPoint
+	}
+}
+
 // WithQueueSize sets the queue size as a config option to be passed into the NewProcessor method
 func WithQueueSize(qsize int) BPOptionConfig {
 	return func(qp *BatchEventProcessor) {
@@ -141,6 +152,10 @@ func NewBatchEventProcessor(options ...BPOptionConfig) *BatchEventProcessor {
 		p.BatchSize = DefaultBatchSize
 	}
 
+	if p.EventEndPoint == "" {
+		p.EventEndPoint = DefaultEventEndPoint
+	}
+
 	if p.BatchSize > p.MaxQueueSize {
 		p.logger.Warning(
 			fmt.Sprintf("Batch size %d is larger than queue size %d.  Setting to defaults",
@@ -297,7 +312,7 @@ func (p *BatchEventProcessor) flushEvents() {
 		}
 		if batchEventCount > 0 {
 			// TODO: figure out what to do with the error
-			logEvent := createLogEvent(batchEvent)
+			logEvent := createLogEvent(batchEvent, p.EventEndPoint)
 			notificationCenter := registry.GetNotificationCenter(p.sdkKey)
 
 			err := notificationCenter.Send(notification.LogEvent, logEvent)

pkg/event/processor_test.go

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2019, Optimizely, Inc. and contributors                        *
+ * Copyright 2019-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -102,6 +102,17 @@ func TestCustomEventProcessor_Create(t *testing.T) {
 	assert.Equal(t, 0, processor.eventsCount())
 }
 
+func TestEndPointOptionEventProcessor(t *testing.T) {
+	// Default end point
+	processor := NewBatchEventProcessor()
+	assert.Equal(t, DefaultEventEndPoint, processor.EventEndPoint)
+
+	customEndPoint := "https://logx.optimizely.com"
+	processor = NewBatchEventProcessor(
+		WithEventEndPoint(customEndPoint))
+	assert.Equal(t, customEndPoint, processor.EventEndPoint)
+}
+
 func TestDefaultEventProcessor_LogEventNotification(t *testing.T) {
 	eg := newExecutionContext()
 	processor := NewBatchEventProcessor(