shlink-web-client/test/visits/reducers/shortUrlVisits.test.ts

265 lines
9.5 KiB
TypeScript
Raw Normal View History

import { Mock } from 'ts-mockery';
import { addDays, formatISO, subDays } from 'date-fns';
2022-11-12 21:36:12 +03:00
import {
getShortUrlVisits as getShortUrlVisitsCreator,
shortUrlVisitsReducerCreator,
ShortUrlVisits,
2018-09-08 09:49:49 +03:00
} from '../../../src/visits/reducers/shortUrlVisits';
import { rangeOf } from '../../../src/utils/utils';
import { Visit } from '../../../src/visits/types';
import { ShlinkVisits } from '../../../src/api/types';
2022-05-28 11:47:39 +03:00
import { ShlinkApiClient } from '../../../src/api/services/ShlinkApiClient';
import { ShlinkState } from '../../../src/container/types';
import { formatIsoDate } from '../../../src/utils/helpers/date';
import { DateInterval } from '../../../src/utils/dates/types';
import { createNewVisits } from '../../../src/visits/reducers/visitCreation';
2018-09-08 09:49:49 +03:00
describe('shortUrlVisitsReducer', () => {
const now = new Date();
const visitsMocks = rangeOf(2, () => Mock.all<Visit>());
2022-11-12 21:36:12 +03:00
const getShortUrlVisitsCall = jest.fn();
const buildApiClientMock = () => Mock.of<ShlinkApiClient>({ getShortUrlVisits: getShortUrlVisitsCall });
const creator = getShortUrlVisitsCreator(buildApiClientMock);
const { asyncThunk: getShortUrlVisits, largeAction, progressChangedAction, fallbackToIntervalAction } = creator;
const { reducer, cancelGetShortUrlVisits } = shortUrlVisitsReducerCreator(creator);
beforeEach(jest.clearAllMocks);
2018-09-08 09:49:49 +03:00
describe('reducer', () => {
const buildState = (data: Partial<ShortUrlVisits>) => Mock.of<ShortUrlVisits>(data);
2018-09-08 09:49:49 +03:00
it('returns loading on GET_SHORT_URL_VISITS_START', () => {
2022-11-12 21:36:12 +03:00
const { loading } = reducer(buildState({ loading: false }), { type: getShortUrlVisits.pending.toString() });
2018-09-08 09:49:49 +03:00
expect(loading).toEqual(true);
});
it('returns loadingLarge on GET_SHORT_URL_VISITS_LARGE', () => {
2022-11-12 21:36:12 +03:00
const { loadingLarge } = reducer(buildState({ loadingLarge: false }), { type: largeAction.toString() });
expect(loadingLarge).toEqual(true);
});
it('returns cancelLoad on GET_SHORT_URL_VISITS_CANCEL', () => {
2022-11-12 21:36:12 +03:00
const { cancelLoad } = reducer(buildState({ cancelLoad: false }), { type: cancelGetShortUrlVisits.toString() });
expect(cancelLoad).toEqual(true);
});
2018-09-08 09:49:49 +03:00
it('stops loading and returns error on GET_SHORT_URL_VISITS_ERROR', () => {
2022-11-12 21:36:12 +03:00
const { loading, error } = reducer(
buildState({ loading: true, error: false }),
{ type: getShortUrlVisits.rejected.toString() },
);
2018-09-08 09:49:49 +03:00
expect(loading).toEqual(false);
expect(error).toEqual(true);
});
it('return visits on GET_SHORT_URL_VISITS', () => {
const actionVisits = [{}, {}];
2022-11-12 21:36:12 +03:00
const { loading, error, visits } = reducer(buildState({ loading: true, error: false }), {
type: getShortUrlVisits.fulfilled.toString(),
payload: { visits: actionVisits },
2022-11-12 21:36:12 +03:00
});
2018-09-08 09:49:49 +03:00
expect(loading).toEqual(false);
expect(error).toEqual(false);
expect(visits).toEqual(actionVisits);
});
it.each([
2022-03-26 14:17:42 +03:00
[{ shortCode: 'abc123' }, visitsMocks.length + 1],
[{ shortCode: 'def456' }, visitsMocks.length],
[
Mock.of<ShortUrlVisits>({
shortCode: 'abc123',
query: { endDate: formatIsoDate(subDays(now, 1)) ?? undefined },
}),
visitsMocks.length,
],
[
Mock.of<ShortUrlVisits>({
shortCode: 'abc123',
query: { startDate: formatIsoDate(addDays(now, 1)) ?? undefined },
}),
visitsMocks.length,
],
[
Mock.of<ShortUrlVisits>({
shortCode: 'abc123',
query: {
startDate: formatIsoDate(subDays(now, 5)) ?? undefined,
endDate: formatIsoDate(subDays(now, 2)) ?? undefined,
},
}),
visitsMocks.length,
],
[
Mock.of<ShortUrlVisits>({
shortCode: 'abc123',
query: {
startDate: formatIsoDate(subDays(now, 5)) ?? undefined,
endDate: formatIsoDate(addDays(now, 3)) ?? undefined,
},
}),
visitsMocks.length + 1,
],
[
Mock.of<ShortUrlVisits>({
shortCode: 'def456',
query: {
startDate: formatIsoDate(subDays(now, 5)) ?? undefined,
endDate: formatIsoDate(addDays(now, 3)) ?? undefined,
},
}),
visitsMocks.length,
],
])('prepends new visits on CREATE_VISIT', (state, expectedVisits) => {
const shortUrl = {
shortCode: 'abc123',
};
const prevState = buildState({
...state,
visits: visitsMocks,
});
const { visits } = reducer(prevState, {
type: createNewVisits.toString(),
payload: { createdVisits: [{ shortUrl, visit: { date: formatIsoDate(now) ?? undefined } }] },
2022-11-12 21:36:12 +03:00
});
expect(visits).toHaveLength(expectedVisits);
});
it('returns new progress on GET_SHORT_URL_VISITS_PROGRESS_CHANGED', () => {
2022-11-12 21:36:12 +03:00
const state = reducer(undefined, { type: progressChangedAction.toString(), payload: 85 });
expect(state).toEqual(expect.objectContaining({ progress: 85 }));
});
it('returns fallbackInterval on GET_SHORT_URL_VISITS_FALLBACK_TO_INTERVAL', () => {
const fallbackInterval: DateInterval = 'last30Days';
const state = reducer(
undefined,
2022-11-12 21:36:12 +03:00
{ type: fallbackToIntervalAction.toString(), payload: fallbackInterval },
);
expect(state).toEqual(expect.objectContaining({ fallbackInterval }));
});
2018-09-08 09:49:49 +03:00
});
describe('getShortUrlVisits', () => {
2019-04-19 13:41:59 +03:00
const dispatchMock = jest.fn();
const getState = () => Mock.of<ShlinkState>({
shortUrlVisits: Mock.of<ShortUrlVisits>({ cancelLoad: false }),
});
2018-09-08 09:49:49 +03:00
it('dispatches start and error when promise is rejected', async () => {
2022-11-12 21:36:12 +03:00
getShortUrlVisitsCall.mockRejectedValue({});
2018-09-08 09:49:49 +03:00
2022-11-12 21:36:12 +03:00
await getShortUrlVisits({ shortCode: 'abc123' })(dispatchMock, getState, {});
2018-09-08 09:49:49 +03:00
2019-04-19 13:41:59 +03:00
expect(dispatchMock).toHaveBeenCalledTimes(2);
2022-11-12 21:36:12 +03:00
expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
type: getShortUrlVisits.pending.toString(),
}));
expect(dispatchMock).toHaveBeenNthCalledWith(2, expect.objectContaining({
type: getShortUrlVisits.rejected.toString(),
}));
expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(1);
2018-09-08 09:49:49 +03:00
});
it.each([
2022-03-26 14:17:42 +03:00
[undefined, undefined],
[{}, undefined],
[{ domain: 'foobar.com' }, 'foobar.com'],
])('dispatches start and success when promise is resolved', async (query, domain) => {
const visits = visitsMocks;
const shortCode = 'abc123';
2022-11-12 21:36:12 +03:00
getShortUrlVisitsCall.mockResolvedValue({
data: visitsMocks,
2019-01-10 22:05:02 +03:00
pagination: {
currentPage: 1,
pagesCount: 1,
2020-12-08 21:31:09 +03:00
totalItems: 1,
2019-01-10 22:05:02 +03:00
},
2022-11-12 21:36:12 +03:00
});
2018-09-08 09:49:49 +03:00
2022-11-12 21:36:12 +03:00
await getShortUrlVisits({ shortCode, query })(dispatchMock, getState, {});
2018-09-08 09:49:49 +03:00
2019-04-19 13:41:59 +03:00
expect(dispatchMock).toHaveBeenCalledTimes(2);
2022-11-12 21:36:12 +03:00
expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
type: getShortUrlVisits.pending.toString(),
}));
expect(dispatchMock).toHaveBeenNthCalledWith(2, expect.objectContaining({
type: getShortUrlVisits.fulfilled.toString(),
payload: { visits, shortCode, domain, query: query ?? {} },
2022-11-12 21:36:12 +03:00
}));
expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(1);
2018-09-08 09:49:49 +03:00
});
2019-01-10 22:05:02 +03:00
2019-01-10 22:11:32 +03:00
it('performs multiple API requests when response contains more pages', async () => {
2019-01-10 22:05:02 +03:00
const expectedRequests = 3;
2022-11-12 21:36:12 +03:00
getShortUrlVisitsCall.mockImplementation(async (_, { page }) =>
2019-01-10 22:05:02 +03:00
Promise.resolve({
data: visitsMocks,
2019-01-10 22:05:02 +03:00
pagination: {
currentPage: page,
pagesCount: expectedRequests,
2020-12-08 21:31:09 +03:00
totalItems: 1,
2019-01-10 22:05:02 +03:00
},
}));
2022-11-12 21:36:12 +03:00
await getShortUrlVisits({ shortCode: 'abc123' })(dispatchMock, getState, {});
2019-01-10 22:05:02 +03:00
2022-11-12 21:36:12 +03:00
expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(expectedRequests);
expect(dispatchMock).toHaveBeenNthCalledWith(3, expect.objectContaining({
payload: expect.objectContaining({
visits: [...visitsMocks, ...visitsMocks, ...visitsMocks],
}),
2019-04-19 13:41:59 +03:00
}));
2019-01-10 22:05:02 +03:00
});
it.each([
[
2022-03-26 14:17:42 +03:00
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 5)) })],
2022-11-12 21:36:12 +03:00
{ type: fallbackToIntervalAction.toString(), payload: 'last7Days' },
3,
],
[
2022-03-26 14:17:42 +03:00
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 200)) })],
2022-11-12 21:36:12 +03:00
{ type: fallbackToIntervalAction.toString(), payload: 'last365Days' },
3,
],
2022-11-12 21:36:12 +03:00
[[], expect.objectContaining({ type: getShortUrlVisits.fulfilled.toString() }), 2],
])('dispatches fallback interval when the list of visits is empty', async (
lastVisits,
expectedSecondDispatch,
expectedDispatchCalls,
) => {
const buildVisitsResult = (data: Visit[] = []): ShlinkVisits => ({
data,
pagination: {
currentPage: 1,
pagesCount: 1,
totalItems: 1,
},
});
2022-11-12 21:36:12 +03:00
getShortUrlVisitsCall
.mockResolvedValueOnce(buildVisitsResult())
.mockResolvedValueOnce(buildVisitsResult(lastVisits));
2022-11-12 21:36:12 +03:00
await getShortUrlVisits({ shortCode: 'abc123', doIntervalFallback: true })(dispatchMock, getState, {});
2022-11-12 21:36:12 +03:00
expect(dispatchMock).toHaveBeenCalledTimes(expectedDispatchCalls);
expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
type: getShortUrlVisits.pending.toString(),
}));
expect(dispatchMock).toHaveBeenNthCalledWith(2, expectedSecondDispatch);
2022-11-12 21:36:12 +03:00
expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(2);
});
2018-09-08 09:49:49 +03:00
});
describe('cancelGetShortUrlVisits', () => {
it('just returns the action with proper type', () =>
2022-11-12 21:36:12 +03:00
expect(cancelGetShortUrlVisits()).toEqual({ type: cancelGetShortUrlVisits.toString() }));
});
2018-09-08 09:49:49 +03:00
});