2018-03-09 20:18:59 +00:00
|
|
|
import $ from 'jquery';
|
2017-12-19 10:12:32 +00:00
|
|
|
import _ from 'underscore';
|
2017-10-31 12:15:54 +00:00
|
|
|
import SmartInterval from '~/smart_interval';
|
2018-07-10 19:28:14 +00:00
|
|
|
import waitForPromises from 'spec/helpers/wait_for_promises';
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
describe('SmartInterval', function () {
|
2016-11-18 15:49:40 +00:00
|
|
|
const DEFAULT_MAX_INTERVAL = 100;
|
|
|
|
const DEFAULT_STARTING_INTERVAL = 5;
|
|
|
|
const DEFAULT_SHORT_TIMEOUT = 75;
|
|
|
|
const DEFAULT_INCREMENT_FACTOR = 2;
|
|
|
|
|
|
|
|
function createDefaultSmartInterval(config) {
|
|
|
|
const defaultParams = {
|
2017-10-24 15:58:05 +00:00
|
|
|
callback: () => Promise.resolve(),
|
2016-11-18 15:49:40 +00:00
|
|
|
startingInterval: DEFAULT_STARTING_INTERVAL,
|
|
|
|
maxInterval: DEFAULT_MAX_INTERVAL,
|
|
|
|
incrementByFactorOf: DEFAULT_INCREMENT_FACTOR,
|
|
|
|
lazyStart: false,
|
2016-11-25 18:42:25 +00:00
|
|
|
immediateExecution: false,
|
|
|
|
hiddenInterval: null,
|
2016-11-18 15:49:40 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
if (config) {
|
|
|
|
_.extend(defaultParams, config);
|
|
|
|
}
|
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
return new SmartInterval(defaultParams);
|
2016-11-18 15:49:40 +00:00
|
|
|
}
|
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
beforeEach(() => {
|
|
|
|
jasmine.clock().install();
|
|
|
|
});
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
jasmine.clock().uninstall();
|
|
|
|
});
|
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
describe('Increment Interval', function () {
|
2018-07-10 19:28:14 +00:00
|
|
|
it('should increment the interval delay', (done) => {
|
|
|
|
const smartInterval = createDefaultSmartInterval();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
|
|
|
|
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
const intervalConfig = smartInterval.cfg;
|
|
|
|
const iterationCount = 4;
|
|
|
|
const maxIntervalAfterIterations = intervalConfig.startingInterval *
|
|
|
|
(intervalConfig.incrementByFactorOf ** iterationCount);
|
|
|
|
const currentInterval = smartInterval.getCurrentInterval();
|
|
|
|
|
|
|
|
// Provide some flexibility for performance of testing environment
|
|
|
|
expect(currentInterval).toBeGreaterThan(intervalConfig.startingInterval);
|
|
|
|
expect(currentInterval).toBeLessThanOrEqual(maxIntervalAfterIterations);
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
it('should not increment past maxInterval', (done) => {
|
|
|
|
const smartInterval = createDefaultSmartInterval({ maxInterval: DEFAULT_STARTING_INTERVAL });
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_STARTING_INTERVAL);
|
|
|
|
jasmine.clock().tick(DEFAULT_STARTING_INTERVAL * DEFAULT_INCREMENT_FACTOR);
|
2017-10-26 15:53:52 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
const currentInterval = smartInterval.getCurrentInterval();
|
|
|
|
expect(currentInterval).toBe(smartInterval.cfg.maxInterval);
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2017-10-26 15:53:52 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
it('does not increment while waiting for callback', done => {
|
2017-10-31 12:15:54 +00:00
|
|
|
const smartInterval = createDefaultSmartInterval({
|
|
|
|
callback: () => new Promise($.noop),
|
2017-10-26 15:53:52 +00:00
|
|
|
});
|
2017-10-31 12:15:54 +00:00
|
|
|
|
2017-11-02 11:13:34 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
const oneInterval = smartInterval.cfg.startingInterval * DEFAULT_INCREMENT_FACTOR;
|
|
|
|
expect(smartInterval.getCurrentInterval()).toEqual(oneInterval);
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2016-11-18 15:49:40 +00:00
|
|
|
});
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
describe('Public methods', function () {
|
|
|
|
beforeEach(function () {
|
|
|
|
this.smartInterval = createDefaultSmartInterval();
|
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
it('should cancel an interval', function (done) {
|
|
|
|
const interval = this.smartInterval;
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
interval.cancel();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
const { intervalId } = interval.state;
|
|
|
|
const currentInterval = interval.getCurrentInterval();
|
|
|
|
const intervalLowerLimit = interval.cfg.startingInterval;
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
expect(intervalId).toBeUndefined();
|
|
|
|
expect(currentInterval).toBe(intervalLowerLimit);
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
it('should resume an interval', function (done) {
|
|
|
|
const interval = this.smartInterval;
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
interval.cancel();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
interval.resume();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
const { intervalId } = interval.state;
|
|
|
|
expect(intervalId).toBeTruthy();
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2016-11-18 15:49:40 +00:00
|
|
|
});
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
describe('DOM Events', function () {
|
|
|
|
beforeEach(function () {
|
|
|
|
// This ensures DOM and DOM events are initialized for these specs.
|
|
|
|
setFixtures('<div></div>');
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
this.smartInterval = createDefaultSmartInterval();
|
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
it('should pause when page is not visible', function (done) {
|
|
|
|
const interval = this.smartInterval;
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
|
|
|
|
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
expect(interval.state.intervalId).toBeTruthy();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
// simulates triggering of visibilitychange event
|
|
|
|
interval.handleVisibilityChange({ target: { visibilityState: 'hidden' } });
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
expect(interval.state.intervalId).toBeUndefined();
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
it('should change to the hidden interval when page is not visible', done => {
|
2017-10-31 12:15:54 +00:00
|
|
|
const HIDDEN_INTERVAL = 1500;
|
|
|
|
const interval = createDefaultSmartInterval({ hiddenInterval: HIDDEN_INTERVAL });
|
2016-11-25 18:42:25 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
|
|
|
|
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
expect(interval.state.intervalId).toBeTruthy();
|
|
|
|
expect(interval.getCurrentInterval() >= DEFAULT_STARTING_INTERVAL &&
|
|
|
|
interval.getCurrentInterval() <= DEFAULT_MAX_INTERVAL).toBeTruthy();
|
2016-11-25 18:42:25 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
// simulates triggering of visibilitychange event
|
|
|
|
interval.handleVisibilityChange({ target: { visibilityState: 'hidden' } });
|
2016-11-25 18:42:25 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
expect(interval.state.intervalId).toBeTruthy();
|
|
|
|
expect(interval.getCurrentInterval()).toBe(HIDDEN_INTERVAL);
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-25 18:42:25 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
it('should resume when page is becomes visible at the previous interval', function (done) {
|
|
|
|
const interval = this.smartInterval;
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
expect(interval.state.intervalId).toBeTruthy();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
// simulates triggering of visibilitychange event
|
|
|
|
interval.handleVisibilityChange({ target: { visibilityState: 'hidden' } });
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
expect(interval.state.intervalId).toBeUndefined();
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
// simulates triggering of visibilitychange event
|
|
|
|
interval.handleVisibilityChange({ target: { visibilityState: 'visible' } });
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
expect(interval.state.intervalId).toBeTruthy();
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
it('should cancel on page unload', function (done) {
|
|
|
|
const interval = this.smartInterval;
|
2016-11-18 15:49:40 +00:00
|
|
|
|
2018-07-10 19:28:14 +00:00
|
|
|
jasmine.clock().tick(DEFAULT_SHORT_TIMEOUT);
|
|
|
|
|
|
|
|
waitForPromises()
|
|
|
|
.then(() => {
|
|
|
|
$(document).triggerHandler('beforeunload');
|
|
|
|
expect(interval.state.intervalId).toBeUndefined();
|
|
|
|
expect(interval.getCurrentInterval()).toBe(interval.cfg.startingInterval);
|
|
|
|
})
|
|
|
|
.then(done)
|
|
|
|
.catch(done.fail);
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|
2016-11-25 18:42:25 +00:00
|
|
|
|
2017-10-31 12:15:54 +00:00
|
|
|
it('should execute callback before first interval', function () {
|
|
|
|
const interval = createDefaultSmartInterval({ immediateExecution: true });
|
|
|
|
expect(interval.cfg.immediateExecution).toBeFalsy();
|
2016-11-18 15:49:40 +00:00
|
|
|
});
|
|
|
|
});
|
2017-10-31 12:15:54 +00:00
|
|
|
});
|