feat(event processor): Send log event notification upon event dispatch when notification center available (#339)

Summary:

With this change, the event processor can be constructed with a notification center. If a notification center is provided, it triggers a log event notification after the event is sent to the event dispatcher.

Test plan:

Added new unit test. Manually tested

Issues:

https://optimizely.atlassian.net/browse/OASIS-4976

Author: mjc1283

packages/event-processor/__tests__/v1EventProcessor.spec.ts

@@ -23,6 +23,7 @@ import {
 } from '../src/eventDispatcher'
 import { EventProcessor } from '../src/eventProcessor'
 import { buildImpressionEventV1, makeBatchedEventV1 } from '../src/v1/buildEventV1'
+import { NotificationCenter, NOTIFICATION_TYPES } from '@optimizely/js-sdk-utils';
 
 function createImpressionEvent() {
   return {
@@ -340,5 +341,32 @@ describe('LogTierV1EventProcessor', () => {
       // flushing should reset queue, at this point only has two events
       expect(dispatchStub).toHaveBeenCalledTimes(1)
     })
+
+  })
+
+  describe('when a notification center is provided', () => {
+    it('should trigger a notification when the event dispatcher dispatches an event', () => {
+      const dispatcher: EventDispatcher = {
+        dispatchEvent: jest.fn()
+      }
+
+      const notificationCenter: NotificationCenter = {
+        sendNotifications: jest.fn()
+      }
+
+      const processor = new LogTierV1EventProcessor({
+        dispatcher,
+        notificationCenter,
+        maxQueueSize: 1,
+      })
+      processor.start()
+
+      const impressionEvent1 = createImpressionEvent()
+      processor.process(impressionEvent1)
+
+      expect(notificationCenter.sendNotifications).toBeCalledTimes(1)
+      const event = (dispatcher.dispatchEvent as jest.Mock).mock.calls[0][0]
+      expect(notificationCenter.sendNotifications).toBeCalledWith(NOTIFICATION_TYPES.LOG_EVENT, event)
+    })
   })
 })

packages/event-processor/package-lock.json

@@ -38,7 +38,7 @@
   },
   "dependencies": {
     "@optimizely/js-sdk-logging": "^0.1.0",
-    "@optimizely/js-sdk-utils": "^0.1.0"
+    "@optimizely/js-sdk-utils": "^0.2.0"
   },
   "devDependencies": {
     "@types/jest": "^24.0.9",

packages/event-processor/package.json

@@ -22,6 +22,7 @@ import {
 } from './eventDispatcher'
 import { EventQueue, DefaultEventQueue, SingleEventQueue } from './eventQueue'
 import { getLogger } from '@optimizely/js-sdk-logging'
+import { NOTIFICATION_TYPES, NotificationCenter } from '@optimizely/js-sdk-utils'
 
 const logger = getLogger('EventProcessor')
 
@@ -37,15 +38,18 @@ const MIN_FLUSH_INTERVAL = 100
 export abstract class AbstractEventProcessor implements EventProcessor {
   protected dispatcher: EventDispatcher
   protected queue: EventQueue<ProcessableEvents>
+  private notificationCenter?: NotificationCenter
 
   constructor({
     dispatcher,
     flushInterval = 30000,
     maxQueueSize = 3000,
+    notificationCenter,
   }: {
     dispatcher: EventDispatcher
     flushInterval?: number
     maxQueueSize?: number
+    notificationCenter?: NotificationCenter
   }) {
     this.dispatcher = dispatcher
 
@@ -61,6 +65,7 @@ export abstract class AbstractEventProcessor implements EventProcessor {
         sink: buffer => this.drainQueue(buffer),
       })
     }
+    this.notificationCenter = notificationCenter
   }
 
   drainQueue(buffer: ProcessableEvents[]): Promise<any> {
@@ -73,6 +78,13 @@ export abstract class AbstractEventProcessor implements EventProcessor {
         this.dispatcher.dispatchEvent(formattedEvent, () => {
           resolve()
         })
+
+        if (this.notificationCenter) {
+          this.notificationCenter.sendNotifications(
+            NOTIFICATION_TYPES.LOG_EVENT,
+            formattedEvent
+          )
+        }
       })
     })