feat(log event notification): Update event processor version & pass notificationCenter to event processor (optimizely#345)

Summary:

This PR puts together the final pieces to enable the log event notification.
- The event processor dependency is updated to the latest version, which has support for receiving a notification center and using it to trigger log event notifications
- Initialization code in Optimizely is updated to pass the notification center to the event processor
- js-sdk-utils is also updated to the latest version in order to start using that package as the single source of truth for notification types

Test plan:

Updated unit tests

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

Author: mjc1283

packages/optimizely-sdk/lib/optimizely/index.js

@@ -112,6 +112,7 @@ function Optimizely(config) {
     dispatcher: this.eventDispatcher,
     flushInterval: config.eventFlushInterval !== undefined ? config.eventFlushInterval : DEFAULT_EVENT_FLUSH_INTERVAL,
     maxQueueSize: config.eventBatchSize !== undefined ? config.eventBatchSize : DEFAULT_EVENT_MAX_QUEUE_SIZE,
+    notificationCenter: this.notificationCenter,
   });
   this.eventProcessor.start();
 

packages/optimizely-sdk/lib/optimizely/index.tests.js

@@ -5607,11 +5607,11 @@ describe('lib/optimizely', function() {
           isValidInstance: true,
         });
 
-        sinon.assert.calledWithExactly(eventProcessor.LogTierV1EventProcessor, {
+        sinon.assert.calledWithExactly(eventProcessor.LogTierV1EventProcessor, sinon.match({
           dispatcher: eventDispatcher,
           flushInterval: 5000,
           maxQueueSize: 1,
-        });
+        }));
       });
     });
 
@@ -5629,11 +5629,11 @@ describe('lib/optimizely', function() {
           eventBatchSize: 100,
         });
 
-        sinon.assert.calledWithExactly(eventProcessor.LogTierV1EventProcessor, {
+        sinon.assert.calledWithExactly(eventProcessor.LogTierV1EventProcessor, sinon.match({
           dispatcher: eventDispatcher,
           flushInterval: 50,
           maxQueueSize: 100,
-        });
+        }));
       });
     });
   });
@@ -5939,4 +5939,61 @@ describe('lib/optimizely', function() {
       });
     });
   });
+
+  describe('log event notification', function() {
+    var optlyInstance;
+    var bucketStub;
+    var eventDispatcherSpy;
+    beforeEach(function() {
+      bucketStub = sinon.stub(bucketer, 'bucket');
+      eventDispatcherSpy = sinon.spy();
+      optlyInstance = new Optimizely({
+        clientEngine: 'node-sdk',
+        datafile: testData.getTestProjectConfig(),
+        eventBuilder: eventBuilder,
+        errorHandler: {
+          handleError: function() {},
+        },
+        eventDispatcher: {
+          dispatchEvent: eventDispatcherSpy,
+        },
+        logger: {
+          log: function() {},
+        },
+        isValidInstance: true,
+        eventBatchSize: 1,
+      });
+    });
+
+    afterEach(function() {
+      bucketer.bucket.restore();
+      optlyInstance.close();
+    });
+
+    it('should trigger a log event notification when an impression event is dispatched', function() {
+      var notificationListener = sinon.spy();
+      optlyInstance.notificationCenter.addNotificationListener(
+        enums.NOTIFICATION_TYPES.LOG_EVENT,
+        notificationListener
+      );
+      bucketStub.returns('111129');
+      var activate = optlyInstance.activate('testExperiment', 'testUser');
+      assert.strictEqual(activate, 'variation');
+      sinon.assert.calledOnce(eventDispatcherSpy);
+      sinon.assert.calledOnce(notificationListener);
+      sinon.assert.calledWithExactly(notificationListener, eventDispatcherSpy.getCall(0).args[0]);
+    });
+
+    it('should trigger a log event notification when a conversion event is dispatched', function() {
+      var notificationListener = sinon.spy();
+      optlyInstance.notificationCenter.addNotificationListener(
+        enums.NOTIFICATION_TYPES.LOG_EVENT,
+        notificationListener
+      );
+      optlyInstance.track('testEvent', 'testUser');
+      sinon.assert.calledOnce(eventDispatcherSpy);
+      sinon.assert.calledOnce(notificationListener);
+      sinon.assert.calledWithExactly(notificationListener, eventDispatcherSpy.getCall(0).args[0]);
+    });
+  });
 });

packages/optimizely-sdk/lib/utils/enums/index.js

@@ -14,6 +14,8 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
+var jsSdkUtils = require('@optimizely/js-sdk-utils');
+
 /**
  * Contains global enums used throughout the library
  */
@@ -164,47 +166,7 @@ exports.VALID_CLIENT_ENGINES = [
   exports.JAVASCRIPT_CLIENT_ENGINE,
 ];
 
-/*
- * Notification types for use with NotificationCenter
- * Format is EVENT: <list of parameters to callback>
- *
- * SDK consumers can use these to register callbacks with the notification center.
- *
- *  @deprecated since 3.1.0
- *  ACTIVATE: An impression event will be sent to Optimizely
- *  Callbacks will receive an object argument with the following properties:
- *    - experiment {Object}
- *    - userId {string}
- *    - attributes {Object|undefined}
- *    - variation {Object}
- *    - logEvent {Object}
- *
- *  DECISION: A decision is made in the system. i.e. user activation,
- *  feature access or feature-variable value retrieval
- *  Callbacks will receive an object argument with the following properties:
- *    - type {string}
- *    - userId {string}
- *    - attributes {Object|undefined}
- *    - decisionInfo {Object|undefined}
- *
- *  OPTIMIZELY_CONFIG_UPDATE: This Optimizely instance has been updated with a new
- *  config
- *
- *  TRACK: A conversion event will be sent to Optimizely
- *  Callbacks will receive the an object argument with the following properties:
- *    - eventKey {string}
- *    - userId {string}
- *    - attributes {Object|undefined}
- *    - eventTags {Object|undefined}
- *    - logEvent {Object}
- *
- */
-exports.NOTIFICATION_TYPES = {
-  ACTIVATE: 'ACTIVATE:experiment, user_id,attributes, variation, event',
-  DECISION: 'DECISION:type, userId, attributes, decisionInfo',
-  OPTIMIZELY_CONFIG_UPDATE: 'OPTIMIZELY_CONFIG_UPDATE',
-  TRACK: 'TRACK:event_key, user_id, attributes, event_tags, event',
-};
+exports.NOTIFICATION_TYPES = jsSdkUtils.NOTIFICATION_TYPES;
 
 exports.DECISION_NOTIFICATION_TYPES = {
   AB_TEST: 'ab-test',

packages/optimizely-sdk/package-lock.json

@@ -33,9 +33,9 @@
   "homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/optimizely-sdk",
   "dependencies": {
     "@optimizely/js-sdk-datafile-manager": "^0.4.0",
-    "@optimizely/js-sdk-event-processor": "^0.2.1",
+    "@optimizely/js-sdk-event-processor": "^0.3.0",
     "@optimizely/js-sdk-logging": "^0.1.0",
-    "@optimizely/js-sdk-utils": "^0.1.0",
+    "@optimizely/js-sdk-utils": "^0.2.0",
     "json-schema": "^0.2.3",
     "lodash": "^4.17.11",
     "murmurhash": "0.0.2",