gitlab-org--gitlab-foss/spec/frontend/lib/utils/ajax_cache_spec.js

162 lines
4.5 KiB
JavaScript
Raw Normal View History

2018-01-31 04:58:14 -05:00
import MockAdapter from 'axios-mock-adapter';
import axios from '~/lib/utils/axios_utils';
2017-05-05 18:47:32 -04:00
import AjaxCache from '~/lib/utils/ajax_cache';
describe('AjaxCache', () => {
const dummyEndpoint = '/AjaxCache/dummyEndpoint';
const dummyResponse = {
important: 'dummy data',
};
beforeEach(() => {
2018-10-17 03:13:26 -04:00
AjaxCache.internalStorage = {};
AjaxCache.pendingRequests = {};
2017-05-05 18:47:32 -04:00
});
2017-05-10 18:01:00 -04:00
describe('get', () => {
2017-05-05 18:47:32 -04:00
it('returns undefined if cache is empty', () => {
const data = AjaxCache.get(dummyEndpoint);
expect(data).toBe(undefined);
});
it('returns undefined if cache contains no matching data', () => {
AjaxCache.internalStorage['not matching'] = dummyResponse;
const data = AjaxCache.get(dummyEndpoint);
expect(data).toBe(undefined);
});
it('returns matching data', () => {
AjaxCache.internalStorage[dummyEndpoint] = dummyResponse;
const data = AjaxCache.get(dummyEndpoint);
expect(data).toBe(dummyResponse);
});
});
2017-05-10 18:01:00 -04:00
describe('hasData', () => {
2017-05-05 18:47:32 -04:00
it('returns false if cache is empty', () => {
expect(AjaxCache.hasData(dummyEndpoint)).toBe(false);
});
it('returns false if cache contains no matching data', () => {
AjaxCache.internalStorage['not matching'] = dummyResponse;
expect(AjaxCache.hasData(dummyEndpoint)).toBe(false);
});
it('returns true if data is available', () => {
AjaxCache.internalStorage[dummyEndpoint] = dummyResponse;
expect(AjaxCache.hasData(dummyEndpoint)).toBe(true);
});
});
2017-05-10 18:01:00 -04:00
describe('remove', () => {
2017-05-05 18:47:32 -04:00
it('does nothing if cache is empty', () => {
2017-05-10 18:01:00 -04:00
AjaxCache.remove(dummyEndpoint);
2017-05-05 18:47:32 -04:00
2018-10-17 03:13:26 -04:00
expect(AjaxCache.internalStorage).toEqual({});
2017-05-05 18:47:32 -04:00
});
it('does nothing if cache contains no matching data', () => {
AjaxCache.internalStorage['not matching'] = dummyResponse;
2017-05-10 18:01:00 -04:00
AjaxCache.remove(dummyEndpoint);
2017-05-05 18:47:32 -04:00
expect(AjaxCache.internalStorage['not matching']).toBe(dummyResponse);
});
it('removes matching data', () => {
AjaxCache.internalStorage[dummyEndpoint] = dummyResponse;
2017-05-10 18:01:00 -04:00
AjaxCache.remove(dummyEndpoint);
2017-05-05 18:47:32 -04:00
2018-10-17 03:13:26 -04:00
expect(AjaxCache.internalStorage).toEqual({});
2017-05-05 18:47:32 -04:00
});
});
describe('override', () => {
it('overrides existing cache', () => {
AjaxCache.internalStorage.endpoint = 'existing-endpoint';
AjaxCache.override('endpoint', 'new-endpoint');
expect(AjaxCache.internalStorage.endpoint).toEqual('new-endpoint');
});
});
2018-01-31 10:12:10 -05:00
describe('retrieve', () => {
2018-01-31 04:58:14 -05:00
let mock;
2017-05-10 18:01:00 -04:00
beforeEach(() => {
2018-01-31 04:58:14 -05:00
mock = new MockAdapter(axios);
2018-12-20 11:49:44 -05:00
jest.spyOn(axios, 'get');
2018-01-31 04:58:14 -05:00
});
afterEach(() => {
mock.restore();
2017-05-10 18:01:00 -04:00
});
2018-12-20 11:49:44 -05:00
it('stores and returns data from Ajax call if cache is empty', () => {
2018-01-31 04:58:14 -05:00
mock.onGet(dummyEndpoint).reply(200, dummyResponse);
2017-05-10 18:01:00 -04:00
2018-12-20 11:49:44 -05:00
return AjaxCache.retrieve(dummyEndpoint).then(data => {
expect(data).toEqual(dummyResponse);
expect(AjaxCache.internalStorage[dummyEndpoint]).toEqual(dummyResponse);
});
2017-05-05 18:47:32 -04:00
});
2018-12-20 11:49:44 -05:00
it('makes no Ajax call if request is pending', () => {
2018-01-31 04:58:14 -05:00
mock.onGet(dummyEndpoint).reply(200, dummyResponse);
2017-05-10 18:01:00 -04:00
2018-12-20 11:49:44 -05:00
return Promise.all([
AjaxCache.retrieve(dummyEndpoint),
AjaxCache.retrieve(dummyEndpoint),
]).then(() => {
expect(axios.get).toHaveBeenCalledTimes(1);
});
2017-05-10 18:01:00 -04:00
});
2018-12-20 11:49:44 -05:00
it('returns undefined if Ajax call fails and cache is empty', () => {
2018-01-31 04:58:14 -05:00
const errorMessage = 'Network Error';
mock.onGet(dummyEndpoint).networkError();
2017-05-05 18:47:32 -04:00
2018-12-20 11:49:44 -05:00
expect.assertions(2);
return AjaxCache.retrieve(dummyEndpoint).catch(error => {
expect(error.message).toBe(`${dummyEndpoint}: ${errorMessage}`);
expect(error.textStatus).toBe(errorMessage);
});
2017-05-05 18:47:32 -04:00
});
2018-12-20 11:49:44 -05:00
it('makes no Ajax call if matching data exists', () => {
2017-05-05 18:47:32 -04:00
AjaxCache.internalStorage[dummyEndpoint] = dummyResponse;
2018-12-20 11:49:44 -05:00
return AjaxCache.retrieve(dummyEndpoint).then(data => {
expect(data).toBe(dummyResponse);
expect(axios.get).not.toHaveBeenCalled();
});
2017-05-05 18:47:32 -04:00
});
2018-12-20 11:49:44 -05:00
it('makes Ajax call even if matching data exists when forceRequest parameter is provided', () => {
const oldDummyResponse = {
important: 'old dummy data',
};
AjaxCache.internalStorage[dummyEndpoint] = oldDummyResponse;
2018-01-31 04:58:14 -05:00
mock.onGet(dummyEndpoint).reply(200, dummyResponse);
2018-12-20 11:49:44 -05:00
return Promise.all([
AjaxCache.retrieve(dummyEndpoint),
AjaxCache.retrieve(dummyEndpoint, true),
]).then(data => {
expect(data).toEqual([oldDummyResponse, dummyResponse]);
});
});
2017-05-05 18:47:32 -04:00
});
});