Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjc1283 merged 6 commits into from
Jun 3, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bf96516
Fix tests hanging in lib/index.browser.tests.js
May 29, 2020
1627fc9
Fix hanging test in lib/plugins/event_dispatcher/index.node.tests.js
May 29, 2020
7e22d18
Fix hanging tests in lib/index.react_native.tests.js
May 29, 2020
829b000
Fix hanging tests in lib/optimizely/index.tests.js
Jun 1, 2020
0080a67
Undo whitespace change
Jun 1, 2020
d09fdb7
Mock timers instead of calling real close to clean up timers
Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions packages/optimizely-sdk/lib/index.browser.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
});

Comment on lines -169 to -181
Copy link
Contributor Author

@mjc1283 mjc1283 Jun 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted this because it's identical to the test above.

it('should activate with provided event dispatcher', function() {
var optlyInstance = optimizelyFactory.createInstance({
datafile: testData.getTestProjectConfig(),
Expand Down Expand Up @@ -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() {
Expand Down
29 changes: 14 additions & 15 deletions packages/optimizely-sdk/lib/index.react_native.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
});
});

Expand Down Expand Up @@ -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() {
Expand Down
Loading