fix: Stub event dispatcher and mock timers in tests (#497)

Summary

- Several unit tests weren't properly stubbing the default event dispatcher - add these stubs

- The test suite wasn't exiting due to active timers not being cleaned up. Fixed this by mocking setTimeout using sinon.useFakeTimers

- One test for Node default event dispatcher was relying on a real connection error from attempting to request to an invalid domain. Added a nock mock for this to prevent the real request.

Test plan:

Run npm test. Should exit immediately, and not make any outgoing HTTP requests.

Issues:

#487

Author: mjc1283

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

@@ -28,6 +28,17 @@ import eventProcessorConfigValidator from './utils/event_processor_config_valida
 var LocalStoragePendingEventsDispatcher = eventProcessor.LocalStoragePendingEventsDispatcher;
 
 describe('javascript-sdk', function() {
+  var clock;
+  beforeEach(function() {
+    sinon.stub(optimizelyFactory.eventDispatcher, 'dispatchEvent');
+    clock = sinon.useFakeTimers(new Date());
+  });
+
+  afterEach(function() {
+    optimizelyFactory.eventDispatcher.dispatchEvent.restore();
+    clock.restore();
+  });
+
   describe('APIs', function() {
     it('should expose logger, errorHandler, eventDispatcher and enums', function() {
       assert.isDefined(optimizelyFactory.logging);
@@ -166,19 +177,6 @@ describe('javascript-sdk', function() {
         assert.equal('react-sdk', optlyInstance.clientEngine);
       });
 
-      it('should allow passing of "react-sdk" as the clientEngine', function() {
-        var optlyInstance = optimizelyFactory.createInstance({
-          clientEngine: 'react-sdk',
-          datafile: {},
-          errorHandler: fakeErrorHandler,
-          eventDispatcher: fakeEventDispatcher,
-          logger: silentLogger,
-        });
-        // Invalid datafile causes onReady Promise rejection - catch this error
-        optlyInstance.onReady().catch(function() {});
-        assert.equal('react-sdk', optlyInstance.clientEngine);
-      });
-
       it('should activate with provided event dispatcher', function() {
         var optlyInstance = optimizelyFactory.createInstance({
           datafile: testData.getTestProjectConfig(),
@@ -393,7 +391,7 @@ describe('javascript-sdk', function() {
       describe('event processor configuration', function() {
         var eventProcessorSpy;
         beforeEach(function() {
-          eventProcessorSpy = sinon.stub(eventProcessor, 'LogTierV1EventProcessor').callThrough();
+          eventProcessorSpy = sinon.spy(eventProcessor, 'LogTierV1EventProcessor');
         });
 
         afterEach(function() {

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

@@ -23,10 +23,20 @@ import testData from './tests/test_data';
 import packageJSON from '../package.json';
 import optimizelyFactory from './index.react_native';
 import configValidator from './utils/config_validator';
-import defaultEventDispatcher from './plugins/event_dispatcher/index.browser';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 
 describe('javascript-sdk/react-native', function() {
+  var clock;
+  beforeEach(function() {
+    sinon.stub(optimizelyFactory.eventDispatcher, 'dispatchEvent');
+    clock = sinon.useFakeTimers(new Date());
+  });
+
+  afterEach(function() {
+    optimizelyFactory.eventDispatcher.dispatchEvent.restore();
+    clock.restore();
+  });
+
   describe('APIs', function() {
     it('should expose logger, errorHandler, eventDispatcher and enums', function() {
       assert.isDefined(optimizelyFactory.logging);
@@ -120,26 +130,15 @@ describe('javascript-sdk/react-native', function() {
       });
 
       describe('when no event dispatcher passed to createInstance', function() {
-        beforeEach(function() {
-          sinon.stub(defaultEventDispatcher, 'dispatchEvent', function(evt, cb) {
-            cb();
-          });
-        });
-
-        afterEach(function() {
-          defaultEventDispatcher.dispatchEvent.restore();
-        });
-
         it('uses the default event dispatcher', function() {
           var optlyInstance = optimizelyFactory.createInstance({
             datafile: testData.getTestProjectConfig(),
             errorHandler: fakeErrorHandler,
             logger: silentLogger,
           });
           optlyInstance.activate('testExperiment', 'testUser');
-          return optlyInstance.close().then(function() {
-            sinon.assert.calledOnce(defaultEventDispatcher.dispatchEvent);
-          });
+          clock.tick(30001)
+          sinon.assert.calledOnce(optimizelyFactory.eventDispatcher.dispatchEvent);
         });
       });
 
@@ -185,7 +184,7 @@ describe('javascript-sdk/react-native', function() {
       describe('event processor configuration', function() {
         var eventProcessorSpy;
         beforeEach(function() {
-          eventProcessorSpy = sinon.stub(eventProcessor, 'LogTierV1EventProcessor').callThrough();
+          eventProcessorSpy = sinon.spy(eventProcessor, 'LogTierV1EventProcessor');
         });
 
         afterEach(function() {