mirrors/shlink-web-client
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink-web-client.git synced 2024-12-23 09:30:31 +03:00
Code Issues Projects Releases Packages Wiki Activity

Migrated shortUrlVisits reducer to RTK

Browse source
This commit is contained in:
Alejandro Celaya 2022-11-12 19:36:12 +01:00
parent f81999a4fe
commit 3e474a3f2d
4 changed files with 133 additions and 145 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/reducers/index.ts
View file

@ -1,7 +1,6 @@
import { IContainer } from 'bottlejs'; import { IContainer } from 'bottlejs';
import { combineReducers } from '@reduxjs/toolkit'; import { combineReducers } from '@reduxjs/toolkit';
import { serversReducer } from '../servers/reducers/servers'; import { serversReducer } from '../servers/reducers/servers';
import shortUrlVisitsReducer from '../visits/reducers/shortUrlVisits';
import tagVisitsReducer from '../visits/reducers/tagVisits'; import tagVisitsReducer from '../visits/reducers/tagVisits';
import { settingsReducer } from '../settings/reducers/settings'; import { settingsReducer } from '../settings/reducers/settings';
import { appUpdatesReducer } from '../app/reducers/appUpdates'; import { appUpdatesReducer } from '../app/reducers/appUpdates';
@ -16,7 +15,7 @@ export default (container: IContainer) => combineReducers<ShlinkState>({
shortUrlDeletion: container.shortUrlDeletionReducer, shortUrlDeletion: container.shortUrlDeletionReducer,
shortUrlEdition: container.shortUrlEditionReducer, shortUrlEdition: container.shortUrlEditionReducer,
shortUrlDetail: container.shortUrlDetailReducer, shortUrlDetail: container.shortUrlDetailReducer,
shortUrlVisits: shortUrlVisitsReducer, shortUrlVisits: container.shortUrlVisitsReducer,
tagVisits: tagVisitsReducer, tagVisits: tagVisitsReducer,
domainVisits: container.domainVisitsReducer, domainVisits: container.domainVisitsReducer,
orphanVisits: container.orphanVisitsReducer, orphanVisits: container.orphanVisitsReducer,

136
src/visits/reducers/shortUrlVisits.ts
View file

@ -1,46 +1,21 @@
import { createAction } from '@reduxjs/toolkit'; import { createSlice } from '@reduxjs/toolkit';
import { Dispatch } from 'redux';
import { shortUrlMatches } from '../../short-urls/helpers'; import { shortUrlMatches } from '../../short-urls/helpers';
import { ShortUrlIdentifier } from '../../short-urls/data'; import { ShortUrlIdentifier } from '../../short-urls/data';
import { buildReducer } from '../../utils/helpers/redux';
import { ShlinkApiClientBuilder } from '../../api/services/ShlinkApiClientBuilder'; import { ShlinkApiClientBuilder } from '../../api/services/ShlinkApiClientBuilder';
import { GetState } from '../../container/types';
import { ApiErrorAction } from '../../api/types/actions';
import { isBetween } from '../../utils/helpers/date'; import { isBetween } from '../../utils/helpers/date';
import { getVisitsWithLoader, lastVisitLoaderForLoader } from './common'; import { createVisitsAsyncThunk, lastVisitLoaderForLoader } from './common';
import { createNewVisits, CreateVisitsAction } from './visitCreation'; import { createNewVisits, CreateVisitsAction } from './visitCreation';
import { import { LoadVisits, VisitsInfo } from './types';
LoadVisits, import { parseApiError } from '../../api/utils';
VisitsFallbackIntervalAction,
VisitsInfo,
VisitsLoaded,
VisitsLoadedAction,
VisitsLoadProgressChangedAction,
} from './types';
const REDUCER_PREFIX = 'shlink/shortUrlVisits'; const REDUCER_PREFIX = 'shlink/shortUrlVisits';
export const GET_SHORT_URL_VISITS_START = `${REDUCER_PREFIX}/getShortUrlVisits/pending`;
export const GET_SHORT_URL_VISITS_ERROR = `${REDUCER_PREFIX}/getShortUrlVisits/rejected`;
export const GET_SHORT_URL_VISITS = `${REDUCER_PREFIX}/getShortUrlVisits/fulfilled`;
export const GET_SHORT_URL_VISITS_LARGE = `${REDUCER_PREFIX}/getShortUrlVisits/large`;
export const GET_SHORT_URL_VISITS_CANCEL = `${REDUCER_PREFIX}/getShortUrlVisits/cancel`;
export const GET_SHORT_URL_VISITS_PROGRESS_CHANGED = `${REDUCER_PREFIX}/getShortUrlVisits/progressChanged`;
export const GET_SHORT_URL_VISITS_FALLBACK_TO_INTERVAL = `${REDUCER_PREFIX}/getShortUrlVisits/fallbackToInterval`;
export interface ShortUrlVisits extends VisitsInfo, ShortUrlIdentifier {} export interface ShortUrlVisits extends VisitsInfo, ShortUrlIdentifier {}
type ShortUrlVisitsAction = VisitsLoadedAction<ShortUrlIdentifier>;
export interface LoadShortUrlVisits extends LoadVisits { export interface LoadShortUrlVisits extends LoadVisits {
shortCode: string; shortCode: string;
} }
type ShortUrlVisitsCombinedAction = ShortUrlVisitsAction
& VisitsLoadProgressChangedAction
& VisitsFallbackIntervalAction
& CreateVisitsAction
& ApiErrorAction;
const initialState: ShortUrlVisits = { const initialState: ShortUrlVisits = {
visits: [], visits: [],
shortCode: '', shortCode: '',
@ -52,53 +27,66 @@ const initialState: ShortUrlVisits = {
progress: 0, progress: 0,
}; };
export default buildReducer<ShortUrlVisits, ShortUrlVisitsCombinedAction>({ export const getShortUrlVisits = (buildShlinkApiClient: ShlinkApiClientBuilder) => createVisitsAsyncThunk({
[`${REDUCER_PREFIX}/getShortUrlVisits/pending`]: () => ({ ...initialState, loading: true }), actionsPrefix: `${REDUCER_PREFIX}/getShortUrlVisits`,
[`${REDUCER_PREFIX}/getShortUrlVisits/rejected`]: (_, { errorData }) => ({ ...initialState, error: true, errorData }), createLoaders: ({ shortCode, query = {}, doIntervalFallback = false }: LoadShortUrlVisits, getState) => {
[`${REDUCER_PREFIX}/getShortUrlVisits/fulfilled`]: (state, { payload }: ShortUrlVisitsAction) => ({ const { getShortUrlVisits: shlinkGetShortUrlVisits } = buildShlinkApiClient(getState);
...state, const visitsLoader = async (page: number, itemsPerPage: number) => shlinkGetShortUrlVisits(
...payload, shortCode,
loading: false, { ...query, page, itemsPerPage },
loadingLarge: false, );
error: false, const lastVisitLoader = lastVisitLoaderForLoader(
}), doIntervalFallback,
[`${REDUCER_PREFIX}/getShortUrlVisits/large`]: (state) => ({ ...state, loadingLarge: true }), async (params) => shlinkGetShortUrlVisits(shortCode, { ...params, domain: query.domain }),
[`${REDUCER_PREFIX}/getShortUrlVisits/cancel`]: (state) => ({ ...state, cancelLoad: true }), );
[`${REDUCER_PREFIX}/getShortUrlVisits/progressChanged`]: (state, { payload: progress }) => ({ ...state, progress }),
[`${REDUCER_PREFIX}/getShortUrlVisits/fallbackToInterval`]: (state, { payload: fallbackInterval }) => (
{ ...state, fallbackInterval }
),
[createNewVisits.toString()]: (state, { payload }: CreateVisitsAction) => {
const { shortCode, domain, visits, query = {} } = state;
const { startDate, endDate } = query;
const newVisits = payload.createdVisits
.filter(
({ shortUrl, visit }) =>
shortUrl && shortUrlMatches(shortUrl, shortCode, domain) && isBetween(visit.date, startDate, endDate),
)
.map(({ visit }) => visit);
return newVisits.length === 0 ? state : { ...state, visits: [...newVisits, ...visits] }; return [visitsLoader, lastVisitLoader];
}, },
}, initialState); getExtraFulfilledPayload: ({ shortCode, query = {} }: LoadShortUrlVisits) => (
{ shortCode, query, domain: query.domain }
),
shouldCancel: (getState) => getState().shortUrlVisits.cancelLoad,
});
export const getShortUrlVisits = (buildShlinkApiClient: ShlinkApiClientBuilder) => ( export const shortUrlVisitsReducerCreator = (
{ shortCode, query = {}, doIntervalFallback = false }: LoadShortUrlVisits, { asyncThunk, largeAction, progressChangedAction, fallbackToIntervalAction }: ReturnType<typeof getShortUrlVisits>,
) => async (dispatch: Dispatch, getState: GetState) => { ) => {
const { getShortUrlVisits: shlinkGetShortUrlVisits } = buildShlinkApiClient(getState); const { reducer, actions } = createSlice({
const visitsLoader = async (page: number, itemsPerPage: number) => shlinkGetShortUrlVisits( name: REDUCER_PREFIX,
shortCode, initialState,
{ ...query, page, itemsPerPage }, reducers: {
); cancelGetShortUrlVisits: (state) => ({ ...state, cancelLoad: true }),
const lastVisitLoader = lastVisitLoaderForLoader( },
doIntervalFallback, extraReducers: (builder) => {
async (params) => shlinkGetShortUrlVisits(shortCode, { ...params, domain: query.domain }), builder.addCase(asyncThunk.pending, () => ({ ...initialState, loading: true }));
); builder.addCase(asyncThunk.rejected, (_, { error }) => (
const shouldCancel = () => getState().shortUrlVisits.cancelLoad; { ...initialState, error: true, errorData: parseApiError(error) }
const extraFinishActionData: Partial<VisitsLoaded<ShortUrlIdentifier>> = { shortCode, query, domain: query.domain }; ));
const prefix = `${REDUCER_PREFIX}/getShortUrlVisits`; builder.addCase(asyncThunk.fulfilled, (state, { payload }) => (
{ ...state, ...payload, loading: false, loadingLarge: false, error: false }
));
return getVisitsWithLoader(visitsLoader, lastVisitLoader, extraFinishActionData, prefix, dispatch, shouldCancel); builder.addCase(largeAction, (state) => ({ ...state, loadingLarge: true }));
builder.addCase(progressChangedAction, (state, { payload: progress }) => ({ ...state, progress }));
builder.addCase(fallbackToIntervalAction, (state, { payload: fallbackInterval }) => (
{ ...state, fallbackInterval }
));
builder.addCase(createNewVisits, (state, { payload }: CreateVisitsAction) => {
const { shortCode, domain, visits, query = {} } = state;
const { startDate, endDate } = query;
const newVisits = payload.createdVisits
.filter(
({ shortUrl, visit }) =>
shortUrl && shortUrlMatches(shortUrl, shortCode, domain) && isBetween(visit.date, startDate, endDate),
)
.map(({ visit }) => visit);
return newVisits.length === 0 ? state : { ...state, visits: [...newVisits, ...visits] };
});
},
});
const { cancelGetShortUrlVisits } = actions;
return { reducer, cancelGetShortUrlVisits };
}; };
export const cancelGetShortUrlVisits = createAction<void>(`${REDUCER_PREFIX}/getShortUrlVisits/cancel`);

10
src/visits/services/provideServices.ts
View file

@ -6,7 +6,7 @@ import { ShortUrlVisits } from '../ShortUrlVisits';
import { TagVisits } from '../TagVisits'; import { TagVisits } from '../TagVisits';
import { OrphanVisits } from '../OrphanVisits'; import { OrphanVisits } from '../OrphanVisits';
import { NonOrphanVisits } from '../NonOrphanVisits'; import { NonOrphanVisits } from '../NonOrphanVisits';
import { cancelGetShortUrlVisits, getShortUrlVisits } from '../reducers/shortUrlVisits'; import { getShortUrlVisits, shortUrlVisitsReducerCreator } from '../reducers/shortUrlVisits';
import { cancelGetTagVisits, getTagVisits } from '../reducers/tagVisits'; import { cancelGetTagVisits, getTagVisits } from '../reducers/tagVisits';
import { getDomainVisits, domainVisitsReducerCreator } from '../reducers/domainVisits'; import { getDomainVisits, domainVisitsReducerCreator } from '../reducers/domainVisits';
import { getOrphanVisits, orphanVisitsReducerCreator } from '../reducers/orphanVisits'; import { getOrphanVisits, orphanVisitsReducerCreator } from '../reducers/orphanVisits';
@ -54,8 +54,9 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
bottle.serviceFactory('VisitsParser', () => visitsParser); bottle.serviceFactory('VisitsParser', () => visitsParser);
// Actions // Actions
bottle.serviceFactory('getShortUrlVisits', getShortUrlVisits, 'buildShlinkApiClient'); bottle.serviceFactory('getShortUrlVisitsCreator', getShortUrlVisits, 'buildShlinkApiClient');
bottle.serviceFactory('cancelGetShortUrlVisits', () => cancelGetShortUrlVisits); bottle.serviceFactory('getShortUrlVisits', prop('asyncThunk'), 'getShortUrlVisitsCreator');
bottle.serviceFactory('cancelGetShortUrlVisits', prop('cancelGetShortUrlVisits'), 'shortUrlVisitsReducerCreator');
bottle.serviceFactory('getTagVisits', getTagVisits, 'buildShlinkApiClient'); bottle.serviceFactory('getTagVisits', getTagVisits, 'buildShlinkApiClient');
bottle.serviceFactory('cancelGetTagVisits', () => cancelGetTagVisits); bottle.serviceFactory('cancelGetTagVisits', () => cancelGetTagVisits);
@ -87,6 +88,9 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
bottle.serviceFactory('orphanVisitsReducerCreator', orphanVisitsReducerCreator, 'getOrphanVisitsCreator'); bottle.serviceFactory('orphanVisitsReducerCreator', orphanVisitsReducerCreator, 'getOrphanVisitsCreator');
bottle.serviceFactory('orphanVisitsReducer', prop('reducer'), 'orphanVisitsReducerCreator'); bottle.serviceFactory('orphanVisitsReducer', prop('reducer'), 'orphanVisitsReducerCreator');
bottle.serviceFactory('shortUrlVisitsReducerCreator', shortUrlVisitsReducerCreator, 'getShortUrlVisitsCreator');
bottle.serviceFactory('shortUrlVisitsReducer', prop('reducer'), 'shortUrlVisitsReducerCreator');
}; };
export default provideServices; export default provideServices;

129
test/visits/reducers/shortUrlVisits.test.ts
View file

@ -1,15 +1,8 @@
import { Mock } from 'ts-mockery'; import { Mock } from 'ts-mockery';
import { addDays, formatISO, subDays } from 'date-fns'; import { addDays, formatISO, subDays } from 'date-fns';
import reducer, { import {
getShortUrlVisits, getShortUrlVisits as getShortUrlVisitsCreator,
cancelGetShortUrlVisits, shortUrlVisitsReducerCreator,
GET_SHORT_URL_VISITS_START,
GET_SHORT_URL_VISITS_ERROR,
GET_SHORT_URL_VISITS,
GET_SHORT_URL_VISITS_LARGE,
GET_SHORT_URL_VISITS_CANCEL,
GET_SHORT_URL_VISITS_PROGRESS_CHANGED,
GET_SHORT_URL_VISITS_FALLBACK_TO_INTERVAL,
ShortUrlVisits, ShortUrlVisits,
} from '../../../src/visits/reducers/shortUrlVisits'; } from '../../../src/visits/reducers/shortUrlVisits';
import { rangeOf } from '../../../src/utils/utils'; import { rangeOf } from '../../../src/utils/utils';
@ -24,34 +17,37 @@ import { createNewVisits } from '../../../src/visits/reducers/visitCreation';
describe('shortUrlVisitsReducer', () => { describe('shortUrlVisitsReducer', () => {
const now = new Date(); const now = new Date();
const visitsMocks = rangeOf(2, () => Mock.all<Visit>()); const visitsMocks = rangeOf(2, () => Mock.all<Visit>());
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);
describe('reducer', () => { describe('reducer', () => {
const buildState = (data: Partial<ShortUrlVisits>) => Mock.of<ShortUrlVisits>(data); const buildState = (data: Partial<ShortUrlVisits>) => Mock.of<ShortUrlVisits>(data);
it('returns loading on GET_SHORT_URL_VISITS_START', () => { it('returns loading on GET_SHORT_URL_VISITS_START', () => {
const state = reducer(buildState({ loading: false }), { type: GET_SHORT_URL_VISITS_START } as any); const { loading } = reducer(buildState({ loading: false }), { type: getShortUrlVisits.pending.toString() });
const { loading } = state;
expect(loading).toEqual(true); expect(loading).toEqual(true);
}); });
it('returns loadingLarge on GET_SHORT_URL_VISITS_LARGE', () => { it('returns loadingLarge on GET_SHORT_URL_VISITS_LARGE', () => {
const state = reducer(buildState({ loadingLarge: false }), { type: GET_SHORT_URL_VISITS_LARGE } as any); const { loadingLarge } = reducer(buildState({ loadingLarge: false }), { type: largeAction.toString() });
const { loadingLarge } = state;
expect(loadingLarge).toEqual(true); expect(loadingLarge).toEqual(true);
}); });
it('returns cancelLoad on GET_SHORT_URL_VISITS_CANCEL', () => { it('returns cancelLoad on GET_SHORT_URL_VISITS_CANCEL', () => {
const state = reducer(buildState({ cancelLoad: false }), { type: GET_SHORT_URL_VISITS_CANCEL } as any); const { cancelLoad } = reducer(buildState({ cancelLoad: false }), { type: cancelGetShortUrlVisits.toString() });
const { cancelLoad } = state;
expect(cancelLoad).toEqual(true); expect(cancelLoad).toEqual(true);
}); });
it('stops loading and returns error on GET_SHORT_URL_VISITS_ERROR', () => { it('stops loading and returns error on GET_SHORT_URL_VISITS_ERROR', () => {
const state = reducer(buildState({ loading: true, error: false }), { type: GET_SHORT_URL_VISITS_ERROR } as any); const { loading, error } = reducer(
const { loading, error } = state; buildState({ loading: true, error: false }),
{ type: getShortUrlVisits.rejected.toString() },
);
expect(loading).toEqual(false); expect(loading).toEqual(false);
expect(error).toEqual(true); expect(error).toEqual(true);
@ -59,11 +55,10 @@ describe('shortUrlVisitsReducer', () => {
it('return visits on GET_SHORT_URL_VISITS', () => { it('return visits on GET_SHORT_URL_VISITS', () => {
const actionVisits = [{}, {}]; const actionVisits = [{}, {}];
const state = reducer(buildState({ loading: true, error: false }), { const { loading, error, visits } = reducer(buildState({ loading: true, error: false }), {
type: GET_SHORT_URL_VISITS, type: getShortUrlVisits.fulfilled.toString(),
payload: { visits: actionVisits }, payload: { visits: actionVisits },
} as any); });
const { loading, error, visits } = state;
expect(loading).toEqual(false); expect(loading).toEqual(false);
expect(error).toEqual(false); expect(error).toEqual(false);
@ -129,14 +124,13 @@ describe('shortUrlVisitsReducer', () => {
const { visits } = reducer(prevState, { const { visits } = reducer(prevState, {
type: createNewVisits.toString(), type: createNewVisits.toString(),
payload: { createdVisits: [{ shortUrl, visit: { date: formatIsoDate(now) ?? undefined } }] }, payload: { createdVisits: [{ shortUrl, visit: { date: formatIsoDate(now) ?? undefined } }] },
} as any); });
expect(visits).toHaveLength(expectedVisits); expect(visits).toHaveLength(expectedVisits);
}); });
it('returns new progress on GET_SHORT_URL_VISITS_PROGRESS_CHANGED', () => { it('returns new progress on GET_SHORT_URL_VISITS_PROGRESS_CHANGED', () => {
const state = reducer(undefined, { type: GET_SHORT_URL_VISITS_PROGRESS_CHANGED, payload: 85 } as any); const state = reducer(undefined, { type: progressChangedAction.toString(), payload: 85 });
expect(state).toEqual(expect.objectContaining({ progress: 85 })); expect(state).toEqual(expect.objectContaining({ progress: 85 }));
}); });
@ -144,7 +138,7 @@ describe('shortUrlVisitsReducer', () => {
const fallbackInterval: DateInterval = 'last30Days'; const fallbackInterval: DateInterval = 'last30Days';
const state = reducer( const state = reducer(
undefined, undefined,
{ type: GET_SHORT_URL_VISITS_FALLBACK_TO_INTERVAL, payload: fallbackInterval } as any, { type: fallbackToIntervalAction.toString(), payload: fallbackInterval },
); );
expect(state).toEqual(expect.objectContaining({ fallbackInterval })); expect(state).toEqual(expect.objectContaining({ fallbackInterval }));
@ -152,27 +146,24 @@ describe('shortUrlVisitsReducer', () => {
}); });
describe('getShortUrlVisits', () => { describe('getShortUrlVisits', () => {
type GetVisitsReturn = Promise<ShlinkVisits> | ((shortCode: string, query: any) => Promise<ShlinkVisits>);
const buildApiClientMock = (returned: GetVisitsReturn) => Mock.of<ShlinkApiClient>({
getShortUrlVisits: jest.fn(typeof returned === 'function' ? returned : async () => returned),
});
const dispatchMock = jest.fn(); const dispatchMock = jest.fn();
const getState = () => Mock.of<ShlinkState>({ const getState = () => Mock.of<ShlinkState>({
shortUrlVisits: Mock.of<ShortUrlVisits>({ cancelLoad: false }), shortUrlVisits: Mock.of<ShortUrlVisits>({ cancelLoad: false }),
}); });
beforeEach(() => dispatchMock.mockReset());
it('dispatches start and error when promise is rejected', async () => { it('dispatches start and error when promise is rejected', async () => {
const ShlinkApiClient = buildApiClientMock(Promise.reject({})); getShortUrlVisitsCall.mockRejectedValue({});
await getShortUrlVisits(() => ShlinkApiClient)({ shortCode: 'abc123' })(dispatchMock, getState); await getShortUrlVisits({ shortCode: 'abc123' })(dispatchMock, getState, {});
expect(dispatchMock).toHaveBeenCalledTimes(2); expect(dispatchMock).toHaveBeenCalledTimes(2);
expect(dispatchMock).toHaveBeenNthCalledWith(1, { type: GET_SHORT_URL_VISITS_START }); expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
expect(dispatchMock).toHaveBeenNthCalledWith(2, { type: GET_SHORT_URL_VISITS_ERROR }); type: getShortUrlVisits.pending.toString(),
expect(ShlinkApiClient.getShortUrlVisits).toHaveBeenCalledTimes(1); }));
expect(dispatchMock).toHaveBeenNthCalledWith(2, expect.objectContaining({
type: getShortUrlVisits.rejected.toString(),
}));
expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(1);
}); });
it.each([ it.each([
@ -182,29 +173,31 @@ describe('shortUrlVisitsReducer', () => {
])('dispatches start and success when promise is resolved', async (query, domain) => { ])('dispatches start and success when promise is resolved', async (query, domain) => {
const visits = visitsMocks; const visits = visitsMocks;
const shortCode = 'abc123'; const shortCode = 'abc123';
const ShlinkApiClient = buildApiClientMock(Promise.resolve({ getShortUrlVisitsCall.mockResolvedValue({
data: visitsMocks, data: visitsMocks,
pagination: { pagination: {
currentPage: 1, currentPage: 1,
pagesCount: 1, pagesCount: 1,
totalItems: 1, totalItems: 1,
}, },
})); });
await getShortUrlVisits(() => ShlinkApiClient)({ shortCode, query })(dispatchMock, getState); await getShortUrlVisits({ shortCode, query })(dispatchMock, getState, {});
expect(dispatchMock).toHaveBeenCalledTimes(2); expect(dispatchMock).toHaveBeenCalledTimes(2);
expect(dispatchMock).toHaveBeenNthCalledWith(1, { type: GET_SHORT_URL_VISITS_START }); expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
expect(dispatchMock).toHaveBeenNthCalledWith(2, { type: getShortUrlVisits.pending.toString(),
type: GET_SHORT_URL_VISITS, }));
expect(dispatchMock).toHaveBeenNthCalledWith(2, expect.objectContaining({
type: getShortUrlVisits.fulfilled.toString(),
payload: { visits, shortCode, domain, query: query ?? {} }, payload: { visits, shortCode, domain, query: query ?? {} },
}); }));
expect(ShlinkApiClient.getShortUrlVisits).toHaveBeenCalledTimes(1); expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(1);
}); });
it('performs multiple API requests when response contains more pages', async () => { it('performs multiple API requests when response contains more pages', async () => {
const expectedRequests = 3; const expectedRequests = 3;
const ShlinkApiClient = buildApiClientMock(async (_, { page }) => getShortUrlVisitsCall.mockImplementation(async (_, { page }) =>
Promise.resolve({ Promise.resolve({
data: visitsMocks, data: visitsMocks,
pagination: { pagination: {
@ -214,9 +207,9 @@ describe('shortUrlVisitsReducer', () => {
}, },
})); }));
await getShortUrlVisits(() => ShlinkApiClient)({ shortCode: 'abc123' })(dispatchMock, getState); await getShortUrlVisits({ shortCode: 'abc123' })(dispatchMock, getState, {});
expect(ShlinkApiClient.getShortUrlVisits).toHaveBeenCalledTimes(expectedRequests); expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(expectedRequests);
expect(dispatchMock).toHaveBeenNthCalledWith(3, expect.objectContaining({ expect(dispatchMock).toHaveBeenNthCalledWith(3, expect.objectContaining({
payload: expect.objectContaining({ payload: expect.objectContaining({
visits: [...visitsMocks, ...visitsMocks, ...visitsMocks], visits: [...visitsMocks, ...visitsMocks, ...visitsMocks],
@ -227,14 +220,20 @@ describe('shortUrlVisitsReducer', () => {
it.each([ it.each([
[ [
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 5)) })], [Mock.of<Visit>({ date: formatISO(subDays(new Date(), 5)) })],
{ type: GET_SHORT_URL_VISITS_FALLBACK_TO_INTERVAL, payload: 'last7Days' }, { type: fallbackToIntervalAction.toString(), payload: 'last7Days' },
3,
], ],
[ [
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 200)) })], [Mock.of<Visit>({ date: formatISO(subDays(new Date(), 200)) })],
{ type: GET_SHORT_URL_VISITS_FALLBACK_TO_INTERVAL, payload: 'last365Days' }, { type: fallbackToIntervalAction.toString(), payload: 'last365Days' },
3,
], ],
[[], expect.objectContaining({ type: GET_SHORT_URL_VISITS })], [[], expect.objectContaining({ type: getShortUrlVisits.fulfilled.toString() }), 2],
])('dispatches fallback interval when the list of visits is empty', async (lastVisits, expectedSecondDispatch) => { ])('dispatches fallback interval when the list of visits is empty', async (
lastVisits,
expectedSecondDispatch,
expectedDispatchCalls,
) => {
const buildVisitsResult = (data: Visit[] = []): ShlinkVisits => ({ const buildVisitsResult = (data: Visit[] = []): ShlinkVisits => ({
data, data,
pagination: { pagination: {
@ -243,25 +242,23 @@ describe('shortUrlVisitsReducer', () => {
totalItems: 1, totalItems: 1,
}, },
}); });
const getShlinkShortUrlVisits = jest.fn() getShortUrlVisitsCall
.mockResolvedValueOnce(buildVisitsResult()) .mockResolvedValueOnce(buildVisitsResult())
.mockResolvedValueOnce(buildVisitsResult(lastVisits)); .mockResolvedValueOnce(buildVisitsResult(lastVisits));
const ShlinkApiClient = Mock.of<ShlinkApiClient>({ getShortUrlVisits: getShlinkShortUrlVisits });
await getShortUrlVisits(() => ShlinkApiClient)({ shortCode: 'abc123', doIntervalFallback: true })( await getShortUrlVisits({ shortCode: 'abc123', doIntervalFallback: true })(dispatchMock, getState, {});
dispatchMock,
getState,
);
expect(dispatchMock).toHaveBeenCalledTimes(2); expect(dispatchMock).toHaveBeenCalledTimes(expectedDispatchCalls);
expect(dispatchMock).toHaveBeenNthCalledWith(1, { type: GET_SHORT_URL_VISITS_START }); expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
type: getShortUrlVisits.pending.toString(),
}));
expect(dispatchMock).toHaveBeenNthCalledWith(2, expectedSecondDispatch); expect(dispatchMock).toHaveBeenNthCalledWith(2, expectedSecondDispatch);
expect(getShlinkShortUrlVisits).toHaveBeenCalledTimes(2); expect(getShortUrlVisitsCall).toHaveBeenCalledTimes(2);
}); });
}); });
describe('cancelGetShortUrlVisits', () => { describe('cancelGetShortUrlVisits', () => {
it('just returns the action with proper type', () => it('just returns the action with proper type', () =>
expect(cancelGetShortUrlVisits()).toEqual({ type: GET_SHORT_URL_VISITS_CANCEL })); expect(cancelGetShortUrlVisits()).toEqual({ type: cancelGetShortUrlVisits.toString() }));
}); });
}); });