mirror of
https://github.com/shlinkio/shlink-web-client.git
synced 2024-12-23 01:20:24 +03:00
Migrated domainVisits reducer to RTK
This commit is contained in:
parent
a3cc3d5fc2
commit
ab7c52d049
7 changed files with 200 additions and 139 deletions
|
@ -1,8 +1,11 @@
|
||||||
import '@testing-library/jest-dom';
|
import '@testing-library/jest-dom';
|
||||||
import 'jest-canvas-mock';
|
import 'jest-canvas-mock';
|
||||||
import ResizeObserver from 'resize-observer-polyfill';
|
import ResizeObserver from 'resize-observer-polyfill';
|
||||||
|
import { setAutoFreeze } from 'immer';
|
||||||
|
|
||||||
(global as any).ResizeObserver = ResizeObserver;
|
(global as any).ResizeObserver = ResizeObserver;
|
||||||
(global as any).scrollTo = () => {};
|
(global as any).scrollTo = () => {};
|
||||||
(global as any).prompt = () => {};
|
(global as any).prompt = () => {};
|
||||||
(global as any).matchMedia = (media: string) => ({ matches: false, media });
|
(global as any).matchMedia = (media: string) => ({ matches: false, media });
|
||||||
|
|
||||||
|
setAutoFreeze(false); // TODO Bypassing a bug on jest
|
||||||
|
|
|
@ -3,7 +3,6 @@ import { combineReducers } from '@reduxjs/toolkit';
|
||||||
import { serversReducer } from '../servers/reducers/servers';
|
import { serversReducer } from '../servers/reducers/servers';
|
||||||
import shortUrlVisitsReducer from '../visits/reducers/shortUrlVisits';
|
import shortUrlVisitsReducer from '../visits/reducers/shortUrlVisits';
|
||||||
import tagVisitsReducer from '../visits/reducers/tagVisits';
|
import tagVisitsReducer from '../visits/reducers/tagVisits';
|
||||||
import domainVisitsReducer from '../visits/reducers/domainVisits';
|
|
||||||
import orphanVisitsReducer from '../visits/reducers/orphanVisits';
|
import orphanVisitsReducer from '../visits/reducers/orphanVisits';
|
||||||
import nonOrphanVisitsReducer from '../visits/reducers/nonOrphanVisits';
|
import nonOrphanVisitsReducer from '../visits/reducers/nonOrphanVisits';
|
||||||
import { settingsReducer } from '../settings/reducers/settings';
|
import { settingsReducer } from '../settings/reducers/settings';
|
||||||
|
@ -21,7 +20,7 @@ export default (container: IContainer) => combineReducers<ShlinkState>({
|
||||||
shortUrlDetail: container.shortUrlDetailReducer,
|
shortUrlDetail: container.shortUrlDetailReducer,
|
||||||
shortUrlVisits: shortUrlVisitsReducer,
|
shortUrlVisits: shortUrlVisitsReducer,
|
||||||
tagVisits: tagVisitsReducer,
|
tagVisits: tagVisitsReducer,
|
||||||
domainVisits: domainVisitsReducer,
|
domainVisits: container.domainVisitsReducer,
|
||||||
orphanVisits: orphanVisitsReducer,
|
orphanVisits: orphanVisitsReducer,
|
||||||
nonOrphanVisits: nonOrphanVisitsReducer,
|
nonOrphanVisits: nonOrphanVisitsReducer,
|
||||||
tagsList: container.tagsListReducer,
|
tagsList: container.tagsListReducer,
|
||||||
|
|
|
@ -1,11 +1,13 @@
|
||||||
import { flatten, prop, range, splitEvery } from 'ramda';
|
import { flatten, prop, range, splitEvery } from 'ramda';
|
||||||
import { Dispatch } from '@reduxjs/toolkit';
|
import { createAction, Dispatch } from '@reduxjs/toolkit';
|
||||||
import { ShlinkPaginator, ShlinkVisits, ShlinkVisitsParams } from '../../api/types';
|
import { ShlinkPaginator, ShlinkVisits, ShlinkVisitsParams } from '../../api/types';
|
||||||
import { Visit } from '../types';
|
import { Visit } from '../types';
|
||||||
import { parseApiError } from '../../api/utils';
|
import { parseApiError } from '../../api/utils';
|
||||||
import { ApiErrorAction } from '../../api/types/actions';
|
import { ApiErrorAction } from '../../api/types/actions';
|
||||||
import { dateToMatchingInterval } from '../../utils/dates/types';
|
import { DateInterval, dateToMatchingInterval } from '../../utils/dates/types';
|
||||||
import { VisitsLoaded, VisitsLoadProgressChangedAction } from './types';
|
import { LoadVisits, VisitsLoaded, VisitsLoadProgressChangedAction } from './types';
|
||||||
|
import { createAsyncThunk } from '../../utils/helpers/redux';
|
||||||
|
import { ShlinkState } from '../../container/types';
|
||||||
|
|
||||||
const ITEMS_PER_PAGE = 5000;
|
const ITEMS_PER_PAGE = 5000;
|
||||||
const PARALLEL_REQUESTS_COUNT = 4;
|
const PARALLEL_REQUESTS_COUNT = 4;
|
||||||
|
@ -17,6 +19,13 @@ const calcProgress = (total: number, current: number): number => (current * 100)
|
||||||
type VisitsLoader = (page: number, itemsPerPage: number) => Promise<ShlinkVisits>;
|
type VisitsLoader = (page: number, itemsPerPage: number) => Promise<ShlinkVisits>;
|
||||||
type LastVisitLoader = () => Promise<Visit | undefined>;
|
type LastVisitLoader = () => Promise<Visit | undefined>;
|
||||||
|
|
||||||
|
interface VisitsAsyncThunkOptions<T extends LoadVisits = LoadVisits, R extends VisitsLoaded = VisitsLoaded> {
|
||||||
|
actionsPrefix: string;
|
||||||
|
createLoaders: (params: T, getState: () => ShlinkState) => [VisitsLoader, LastVisitLoader];
|
||||||
|
getExtraFulfilledPayload: (params: T) => Partial<R>;
|
||||||
|
shouldCancel: (getState: () => ShlinkState) => boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export const getVisitsWithLoader = async <T extends VisitsLoaded>(
|
export const getVisitsWithLoader = async <T extends VisitsLoaded>(
|
||||||
visitsLoader: VisitsLoader,
|
visitsLoader: VisitsLoader,
|
||||||
lastVisitLoader: LastVisitLoader,
|
lastVisitLoader: LastVisitLoader,
|
||||||
|
@ -81,6 +90,66 @@ export const getVisitsWithLoader = async <T extends VisitsLoaded>(
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const createVisitsAsyncThunk = <T extends LoadVisits = LoadVisits, R extends VisitsLoaded = VisitsLoaded>(
|
||||||
|
{ actionsPrefix, createLoaders, getExtraFulfilledPayload, shouldCancel }: VisitsAsyncThunkOptions<T, R>,
|
||||||
|
) => {
|
||||||
|
const progressChangedAction = createAction<number>(`${actionsPrefix}/progressChanged`);
|
||||||
|
const largeAction = createAction<void>(`${actionsPrefix}/large`);
|
||||||
|
const fallbackToIntervalAction = createAction<DateInterval>(`${actionsPrefix}/fallbackToInterval`);
|
||||||
|
|
||||||
|
const asyncThunk = createAsyncThunk(actionsPrefix, async (params: T, { getState, dispatch }): Promise<R> => {
|
||||||
|
const [visitsLoader, lastVisitLoader] = createLoaders(params, getState);
|
||||||
|
|
||||||
|
const loadVisitsInParallel = async (pages: number[]): Promise<Visit[]> =>
|
||||||
|
Promise.all(pages.map(async (page) => visitsLoader(page, ITEMS_PER_PAGE).then(prop('data')))).then(flatten);
|
||||||
|
|
||||||
|
const loadPagesBlocks = async (pagesBlocks: number[][], index = 0): Promise<Visit[]> => {
|
||||||
|
if (shouldCancel(getState)) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const data = await loadVisitsInParallel(pagesBlocks[index]);
|
||||||
|
|
||||||
|
dispatch(progressChangedAction(calcProgress(pagesBlocks.length, index + PARALLEL_STARTING_PAGE)));
|
||||||
|
|
||||||
|
if (index < pagesBlocks.length - 1) {
|
||||||
|
return data.concat(await loadPagesBlocks(pagesBlocks, index + 1));
|
||||||
|
}
|
||||||
|
|
||||||
|
return data;
|
||||||
|
};
|
||||||
|
|
||||||
|
const loadVisits = async (page = 1) => {
|
||||||
|
const { pagination, data } = await visitsLoader(page, ITEMS_PER_PAGE);
|
||||||
|
|
||||||
|
// If pagination was not returned, then this is an old shlink version. Just return data
|
||||||
|
if (!pagination || isLastPage(pagination)) {
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If there are more pages, make requests in blocks of 4
|
||||||
|
const pagesRange = range(PARALLEL_STARTING_PAGE, pagination.pagesCount + 1);
|
||||||
|
const pagesBlocks = splitEvery(PARALLEL_REQUESTS_COUNT, pagesRange);
|
||||||
|
|
||||||
|
if (pagination.pagesCount - 1 > PARALLEL_REQUESTS_COUNT) {
|
||||||
|
dispatch(largeAction());
|
||||||
|
}
|
||||||
|
|
||||||
|
return data.concat(await loadPagesBlocks(pagesBlocks));
|
||||||
|
};
|
||||||
|
|
||||||
|
const [visits, lastVisit] = await Promise.all([loadVisits(), lastVisitLoader()]);
|
||||||
|
|
||||||
|
if (!visits.length && lastVisit) {
|
||||||
|
dispatch(fallbackToIntervalAction(dateToMatchingInterval(lastVisit.date)));
|
||||||
|
}
|
||||||
|
|
||||||
|
return { ...getExtraFulfilledPayload(params), visits } as any; // TODO Get rid of this casting
|
||||||
|
});
|
||||||
|
|
||||||
|
return { asyncThunk, progressChangedAction, largeAction, fallbackToIntervalAction };
|
||||||
|
};
|
||||||
|
|
||||||
export const lastVisitLoaderForLoader = (
|
export const lastVisitLoaderForLoader = (
|
||||||
doIntervalFallback: boolean,
|
doIntervalFallback: boolean,
|
||||||
loader: (params: ShlinkVisitsParams) => Promise<ShlinkVisits>,
|
loader: (params: ShlinkVisitsParams) => Promise<ShlinkVisits>,
|
||||||
|
|
|
@ -1,30 +1,13 @@
|
||||||
import { createAction } from '@reduxjs/toolkit';
|
import { createSlice } from '@reduxjs/toolkit';
|
||||||
import { Dispatch } from 'redux';
|
|
||||||
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 } from './visitCreation';
|
||||||
import { domainMatches } from '../../short-urls/helpers';
|
import { domainMatches } from '../../short-urls/helpers';
|
||||||
import {
|
import { LoadVisits, VisitsInfo } from './types';
|
||||||
LoadVisits,
|
import { parseApiError } from '../../api/utils';
|
||||||
VisitsFallbackIntervalAction,
|
|
||||||
VisitsInfo,
|
|
||||||
VisitsLoaded,
|
|
||||||
VisitsLoadedAction,
|
|
||||||
VisitsLoadProgressChangedAction,
|
|
||||||
} from './types';
|
|
||||||
|
|
||||||
const REDUCER_PREFIX = 'shlink/domainVisits';
|
const REDUCER_PREFIX = 'shlink/domainVisits';
|
||||||
export const GET_DOMAIN_VISITS_START = `${REDUCER_PREFIX}/getDomainVisits/pending`;
|
|
||||||
export const GET_DOMAIN_VISITS_ERROR = `${REDUCER_PREFIX}/getDomainVisits/rejected`;
|
|
||||||
export const GET_DOMAIN_VISITS = `${REDUCER_PREFIX}/getDomainVisits/fulfilled`;
|
|
||||||
export const GET_DOMAIN_VISITS_LARGE = `${REDUCER_PREFIX}/getDomainVisits/large`;
|
|
||||||
export const GET_DOMAIN_VISITS_CANCEL = `${REDUCER_PREFIX}/getDomainVisits/cancel`;
|
|
||||||
export const GET_DOMAIN_VISITS_PROGRESS_CHANGED = `${REDUCER_PREFIX}/getDomainVisits/progressChanged`;
|
|
||||||
export const GET_DOMAIN_VISITS_FALLBACK_TO_INTERVAL = `${REDUCER_PREFIX}/getDomainVisits/fallbackToInterval`;
|
|
||||||
|
|
||||||
export const DEFAULT_DOMAIN = 'DEFAULT';
|
export const DEFAULT_DOMAIN = 'DEFAULT';
|
||||||
|
|
||||||
|
@ -36,14 +19,6 @@ export interface DomainVisits extends VisitsInfo, WithDomain {}
|
||||||
|
|
||||||
export interface LoadDomainVisits extends LoadVisits, WithDomain {}
|
export interface LoadDomainVisits extends LoadVisits, WithDomain {}
|
||||||
|
|
||||||
type DomainVisitsAction = VisitsLoadedAction<WithDomain>;
|
|
||||||
|
|
||||||
type DomainVisitsCombinedAction = DomainVisitsAction
|
|
||||||
& VisitsLoadProgressChangedAction
|
|
||||||
& VisitsFallbackIntervalAction
|
|
||||||
& CreateVisitsAction
|
|
||||||
& ApiErrorAction;
|
|
||||||
|
|
||||||
const initialState: DomainVisits = {
|
const initialState: DomainVisits = {
|
||||||
visits: [],
|
visits: [],
|
||||||
domain: '',
|
domain: '',
|
||||||
|
@ -54,19 +29,48 @@ const initialState: DomainVisits = {
|
||||||
progress: 0,
|
progress: 0,
|
||||||
};
|
};
|
||||||
|
|
||||||
export default buildReducer<DomainVisits, DomainVisitsCombinedAction>({
|
export const getDomainVisits = (buildShlinkApiClient: ShlinkApiClientBuilder) => createVisitsAsyncThunk({
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/pending`]: () => ({ ...initialState, loading: true }),
|
actionsPrefix: `${REDUCER_PREFIX}/getDomainVisits`,
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/rejected`]: (_, { errorData }) => ({ ...initialState, error: true, errorData }),
|
createLoaders: ({ domain, query = {}, doIntervalFallback = false }: LoadDomainVisits, getState) => {
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/fulfilled`]: (state, { payload }: DomainVisitsAction) => (
|
const { getDomainVisits: getVisits } = buildShlinkApiClient(getState);
|
||||||
|
const visitsLoader = async (page: number, itemsPerPage: number) => getVisits(
|
||||||
|
domain,
|
||||||
|
{ ...query, page, itemsPerPage },
|
||||||
|
);
|
||||||
|
const lastVisitLoader = lastVisitLoaderForLoader(doIntervalFallback, async (params) => getVisits(domain, params));
|
||||||
|
|
||||||
|
return [visitsLoader, lastVisitLoader];
|
||||||
|
},
|
||||||
|
getExtraFulfilledPayload: ({ domain, query = {} }: LoadDomainVisits) => ({ domain, query }),
|
||||||
|
shouldCancel: (getState) => getState().domainVisits.cancelLoad,
|
||||||
|
});
|
||||||
|
|
||||||
|
export const domainVisitsReducerCreator = (
|
||||||
|
{ asyncThunk, largeAction, progressChangedAction, fallbackToIntervalAction }: ReturnType<typeof getDomainVisits>,
|
||||||
|
) => {
|
||||||
|
const { reducer, actions } = createSlice({
|
||||||
|
name: REDUCER_PREFIX,
|
||||||
|
initialState,
|
||||||
|
reducers: {
|
||||||
|
cancelGetDomainVisits: (state) => ({ ...state, cancelLoad: true }),
|
||||||
|
},
|
||||||
|
extraReducers: (builder) => {
|
||||||
|
builder.addCase(asyncThunk.pending, () => ({ ...initialState, loading: true }));
|
||||||
|
builder.addCase(asyncThunk.rejected, (_, { error }) => (
|
||||||
|
{ ...initialState, error: true, errorData: parseApiError(error) }
|
||||||
|
));
|
||||||
|
builder.addCase(asyncThunk.fulfilled, (state, { payload }) => (
|
||||||
{ ...state, ...payload, loading: false, loadingLarge: false, error: false }
|
{ ...state, ...payload, loading: false, loadingLarge: false, error: false }
|
||||||
),
|
));
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/large`]: (state) => ({ ...state, loadingLarge: true }),
|
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/cancel`]: (state) => ({ ...state, cancelLoad: true }),
|
builder.addCase(largeAction, (state) => ({ ...state, loadingLarge: true }));
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/progressChanged`]: (state, { payload: progress }) => ({ ...state, progress }),
|
builder.addCase(progressChangedAction, (state, { payload: progress }) => ({ ...state, progress }));
|
||||||
[`${REDUCER_PREFIX}/getDomainVisits/fallbackToInterval`]: (state, { payload: fallbackInterval }) => (
|
builder.addCase(
|
||||||
{ ...state, fallbackInterval }
|
fallbackToIntervalAction,
|
||||||
),
|
(state, { payload: fallbackInterval }) => ({ ...state, fallbackInterval }),
|
||||||
[createNewVisits.toString()]: (state, { payload }: CreateVisitsAction) => {
|
);
|
||||||
|
|
||||||
|
builder.addCase(createNewVisits, (state, { payload }) => {
|
||||||
const { domain, visits, query = {} } = state;
|
const { domain, visits, query = {} } = state;
|
||||||
const { startDate, endDate } = query;
|
const { startDate, endDate } = query;
|
||||||
const newVisits = payload.createdVisits
|
const newVisits = payload.createdVisits
|
||||||
|
@ -75,23 +79,11 @@ export default buildReducer<DomainVisits, DomainVisitsCombinedAction>({
|
||||||
.map(({ visit }) => visit);
|
.map(({ visit }) => visit);
|
||||||
|
|
||||||
return { ...state, visits: [...newVisits, ...visits] };
|
return { ...state, visits: [...newVisits, ...visits] };
|
||||||
|
});
|
||||||
},
|
},
|
||||||
}, initialState);
|
});
|
||||||
|
|
||||||
export const getDomainVisits = (buildShlinkApiClient: ShlinkApiClientBuilder) => (
|
const { cancelGetDomainVisits } = actions;
|
||||||
{ domain, query = {}, doIntervalFallback = false }: LoadDomainVisits,
|
|
||||||
) => async (dispatch: Dispatch, getState: GetState) => {
|
|
||||||
const { getDomainVisits: getVisits } = buildShlinkApiClient(getState);
|
|
||||||
const visitsLoader = async (page: number, itemsPerPage: number) => getVisits(
|
|
||||||
domain,
|
|
||||||
{ ...query, page, itemsPerPage },
|
|
||||||
);
|
|
||||||
const lastVisitLoader = lastVisitLoaderForLoader(doIntervalFallback, async (params) => getVisits(domain, params));
|
|
||||||
const shouldCancel = () => getState().domainVisits.cancelLoad;
|
|
||||||
const extraFinishActionData: Partial<VisitsLoaded<WithDomain>> = { domain, query };
|
|
||||||
const prefix = `${REDUCER_PREFIX}/getDomainVisits`;
|
|
||||||
|
|
||||||
return getVisitsWithLoader(visitsLoader, lastVisitLoader, extraFinishActionData, prefix, dispatch, shouldCancel);
|
return { reducer, cancelGetDomainVisits };
|
||||||
};
|
};
|
||||||
|
|
||||||
export const cancelGetDomainVisits = createAction<void>(`${REDUCER_PREFIX}/getDomainVisits/cancel`);
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ import { OrphanVisits } from '../OrphanVisits';
|
||||||
import { NonOrphanVisits } from '../NonOrphanVisits';
|
import { NonOrphanVisits } from '../NonOrphanVisits';
|
||||||
import { cancelGetShortUrlVisits, getShortUrlVisits } from '../reducers/shortUrlVisits';
|
import { cancelGetShortUrlVisits, getShortUrlVisits } from '../reducers/shortUrlVisits';
|
||||||
import { cancelGetTagVisits, getTagVisits } from '../reducers/tagVisits';
|
import { cancelGetTagVisits, getTagVisits } from '../reducers/tagVisits';
|
||||||
import { cancelGetDomainVisits, getDomainVisits } from '../reducers/domainVisits';
|
import { getDomainVisits, domainVisitsReducerCreator } from '../reducers/domainVisits';
|
||||||
import { cancelGetOrphanVisits, getOrphanVisits } from '../reducers/orphanVisits';
|
import { cancelGetOrphanVisits, getOrphanVisits } from '../reducers/orphanVisits';
|
||||||
import { cancelGetNonOrphanVisits, getNonOrphanVisits } from '../reducers/nonOrphanVisits';
|
import { cancelGetNonOrphanVisits, getNonOrphanVisits } from '../reducers/nonOrphanVisits';
|
||||||
import { ConnectDecorator } from '../../container/types';
|
import { ConnectDecorator } from '../../container/types';
|
||||||
|
@ -60,8 +60,9 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
|
||||||
bottle.serviceFactory('getTagVisits', getTagVisits, 'buildShlinkApiClient');
|
bottle.serviceFactory('getTagVisits', getTagVisits, 'buildShlinkApiClient');
|
||||||
bottle.serviceFactory('cancelGetTagVisits', () => cancelGetTagVisits);
|
bottle.serviceFactory('cancelGetTagVisits', () => cancelGetTagVisits);
|
||||||
|
|
||||||
bottle.serviceFactory('getDomainVisits', getDomainVisits, 'buildShlinkApiClient');
|
bottle.serviceFactory('getDomainVisitsCreator', getDomainVisits, 'buildShlinkApiClient');
|
||||||
bottle.serviceFactory('cancelGetDomainVisits', () => cancelGetDomainVisits);
|
bottle.serviceFactory('getDomainVisits', prop('asyncThunk'), 'getDomainVisitsCreator');
|
||||||
|
bottle.serviceFactory('cancelGetDomainVisits', prop('cancelGetDomainVisits'), 'domainVisitsReducerCreator');
|
||||||
|
|
||||||
bottle.serviceFactory('getOrphanVisits', getOrphanVisits, 'buildShlinkApiClient');
|
bottle.serviceFactory('getOrphanVisits', getOrphanVisits, 'buildShlinkApiClient');
|
||||||
bottle.serviceFactory('cancelGetOrphanVisits', () => cancelGetOrphanVisits);
|
bottle.serviceFactory('cancelGetOrphanVisits', () => cancelGetOrphanVisits);
|
||||||
|
@ -75,6 +76,9 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
|
||||||
// Reducers
|
// Reducers
|
||||||
bottle.serviceFactory('visitsOverviewReducerCreator', visitsOverviewReducerCreator, 'loadVisitsOverview');
|
bottle.serviceFactory('visitsOverviewReducerCreator', visitsOverviewReducerCreator, 'loadVisitsOverview');
|
||||||
bottle.serviceFactory('visitsOverviewReducer', prop('reducer'), 'visitsOverviewReducerCreator');
|
bottle.serviceFactory('visitsOverviewReducer', prop('reducer'), 'visitsOverviewReducerCreator');
|
||||||
|
|
||||||
|
bottle.serviceFactory('domainVisitsReducerCreator', domainVisitsReducerCreator, 'getDomainVisitsCreator');
|
||||||
|
bottle.serviceFactory('domainVisitsReducer', prop('reducer'), 'domainVisitsReducerCreator');
|
||||||
};
|
};
|
||||||
|
|
||||||
export default provideServices;
|
export default provideServices;
|
||||||
|
|
|
@ -1,17 +1,10 @@
|
||||||
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 {
|
||||||
getDomainVisits,
|
getDomainVisits as getDomainVisitsCreator,
|
||||||
cancelGetDomainVisits,
|
|
||||||
GET_DOMAIN_VISITS_START,
|
|
||||||
GET_DOMAIN_VISITS_ERROR,
|
|
||||||
GET_DOMAIN_VISITS,
|
|
||||||
GET_DOMAIN_VISITS_LARGE,
|
|
||||||
GET_DOMAIN_VISITS_CANCEL,
|
|
||||||
GET_DOMAIN_VISITS_PROGRESS_CHANGED,
|
|
||||||
GET_DOMAIN_VISITS_FALLBACK_TO_INTERVAL,
|
|
||||||
DomainVisits,
|
DomainVisits,
|
||||||
DEFAULT_DOMAIN,
|
DEFAULT_DOMAIN,
|
||||||
|
domainVisitsReducerCreator,
|
||||||
} from '../../../src/visits/reducers/domainVisits';
|
} from '../../../src/visits/reducers/domainVisits';
|
||||||
import { rangeOf } from '../../../src/utils/utils';
|
import { rangeOf } from '../../../src/utils/utils';
|
||||||
import { Visit } from '../../../src/visits/types';
|
import { Visit } from '../../../src/visits/types';
|
||||||
|
@ -26,33 +19,34 @@ import { createNewVisits } from '../../../src/visits/reducers/visitCreation';
|
||||||
describe('domainVisitsReducer', () => {
|
describe('domainVisitsReducer', () => {
|
||||||
const now = new Date();
|
const now = new Date();
|
||||||
const visitsMocks = rangeOf(2, () => Mock.all<Visit>());
|
const visitsMocks = rangeOf(2, () => Mock.all<Visit>());
|
||||||
|
const getDomainVisitsCall = jest.fn();
|
||||||
|
const buildApiClientMock = () => Mock.of<ShlinkApiClient>({ getDomainVisits: getDomainVisitsCall });
|
||||||
|
const creator = getDomainVisitsCreator(buildApiClientMock);
|
||||||
|
const { asyncThunk: getDomainVisits, progressChangedAction, largeAction, fallbackToIntervalAction } = creator;
|
||||||
|
const { reducer, cancelGetDomainVisits } = domainVisitsReducerCreator(creator);
|
||||||
|
|
||||||
|
beforeEach(jest.clearAllMocks);
|
||||||
|
|
||||||
describe('reducer', () => {
|
describe('reducer', () => {
|
||||||
const buildState = (data: Partial<DomainVisits>) => Mock.of<DomainVisits>(data);
|
const buildState = (data: Partial<DomainVisits>) => Mock.of<DomainVisits>(data);
|
||||||
|
|
||||||
it('returns loading on GET_DOMAIN_VISITS_START', () => {
|
it('returns loading on GET_DOMAIN_VISITS_START', () => {
|
||||||
const state = reducer(buildState({ loading: false }), { type: GET_DOMAIN_VISITS_START } as any);
|
const { loading } = reducer(buildState({ loading: false }), { type: getDomainVisits.pending.toString() });
|
||||||
const { loading } = state;
|
|
||||||
|
|
||||||
expect(loading).toEqual(true);
|
expect(loading).toEqual(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns loadingLarge on GET_DOMAIN_VISITS_LARGE', () => {
|
it('returns loadingLarge on GET_DOMAIN_VISITS_LARGE', () => {
|
||||||
const state = reducer(buildState({ loadingLarge: false }), { type: GET_DOMAIN_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_DOMAIN_VISITS_CANCEL', () => {
|
it('returns cancelLoad on GET_DOMAIN_VISITS_CANCEL', () => {
|
||||||
const state = reducer(buildState({ cancelLoad: false }), { type: GET_DOMAIN_VISITS_CANCEL } as any);
|
const { cancelLoad } = reducer(buildState({ cancelLoad: false }), { type: cancelGetDomainVisits.toString() });
|
||||||
const { cancelLoad } = state;
|
|
||||||
|
|
||||||
expect(cancelLoad).toEqual(true);
|
expect(cancelLoad).toEqual(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('stops loading and returns error on GET_DOMAIN_VISITS_ERROR', () => {
|
it('stops loading and returns error on GET_DOMAIN_VISITS_ERROR', () => {
|
||||||
const state = reducer(buildState({ loading: true, error: false }), { type: GET_DOMAIN_VISITS_ERROR } as any);
|
const state = reducer(buildState({ loading: true, error: false }), { type: getDomainVisits.rejected.toString() });
|
||||||
const { loading, error } = state;
|
const { loading, error } = state;
|
||||||
|
|
||||||
expect(loading).toEqual(false);
|
expect(loading).toEqual(false);
|
||||||
|
@ -61,11 +55,10 @@ describe('domainVisitsReducer', () => {
|
||||||
|
|
||||||
it('return visits on GET_DOMAIN_VISITS', () => {
|
it('return visits on GET_DOMAIN_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_DOMAIN_VISITS,
|
type: getDomainVisits.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);
|
||||||
|
@ -128,21 +121,16 @@ describe('domainVisitsReducer', () => {
|
||||||
],
|
],
|
||||||
])('prepends new visits on CREATE_VISIT', (state, shortUrlDomain, expectedVisits) => {
|
])('prepends new visits on CREATE_VISIT', (state, shortUrlDomain, expectedVisits) => {
|
||||||
const shortUrl = Mock.of<ShortUrl>({ domain: shortUrlDomain });
|
const shortUrl = Mock.of<ShortUrl>({ domain: shortUrlDomain });
|
||||||
const prevState = buildState({
|
const { visits } = reducer(buildState({ ...state, visits: visitsMocks }), {
|
||||||
...state,
|
|
||||||
visits: visitsMocks,
|
|
||||||
});
|
|
||||||
|
|
||||||
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_DOMAIN_VISITS_PROGRESS_CHANGED', () => {
|
it('returns new progress on GET_DOMAIN_VISITS_PROGRESS_CHANGED', () => {
|
||||||
const state = reducer(undefined, { type: GET_DOMAIN_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 }));
|
||||||
});
|
});
|
||||||
|
@ -151,7 +139,7 @@ describe('domainVisitsReducer', () => {
|
||||||
const fallbackInterval: DateInterval = 'last30Days';
|
const fallbackInterval: DateInterval = 'last30Days';
|
||||||
const state = reducer(
|
const state = reducer(
|
||||||
undefined,
|
undefined,
|
||||||
{ type: GET_DOMAIN_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 }));
|
||||||
|
@ -159,28 +147,25 @@ describe('domainVisitsReducer', () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('getDomainVisits', () => {
|
describe('getDomainVisits', () => {
|
||||||
type GetVisitsReturn = Promise<ShlinkVisits> | ((shortCode: string, query: any) => Promise<ShlinkVisits>);
|
|
||||||
|
|
||||||
const buildApiClientMock = (returned: GetVisitsReturn) => Mock.of<ShlinkApiClient>({
|
|
||||||
getDomainVisits: 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>({
|
||||||
domainVisits: { cancelLoad: false },
|
domainVisits: { cancelLoad: false },
|
||||||
});
|
});
|
||||||
const domain = 'foo.com';
|
const domain = 'foo.com';
|
||||||
|
|
||||||
beforeEach(jest.clearAllMocks);
|
|
||||||
|
|
||||||
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(new Error()));
|
getDomainVisitsCall.mockRejectedValue(new Error());
|
||||||
|
|
||||||
await getDomainVisits(() => shlinkApiClient)({ domain })(dispatchMock, getState);
|
await getDomainVisits({ domain })(dispatchMock, getState, {});
|
||||||
|
|
||||||
expect(dispatchMock).toHaveBeenCalledTimes(2);
|
expect(dispatchMock).toHaveBeenCalledTimes(2);
|
||||||
expect(dispatchMock).toHaveBeenNthCalledWith(1, { type: GET_DOMAIN_VISITS_START });
|
expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
|
||||||
expect(dispatchMock).toHaveBeenNthCalledWith(2, { type: GET_DOMAIN_VISITS_ERROR });
|
type: getDomainVisits.pending.toString(),
|
||||||
expect(shlinkApiClient.getDomainVisits).toHaveBeenCalledTimes(1);
|
}));
|
||||||
|
expect(dispatchMock).toHaveBeenNthCalledWith(2, expect.objectContaining({
|
||||||
|
type: getDomainVisits.rejected.toString(),
|
||||||
|
}));
|
||||||
|
expect(getDomainVisitsCall).toHaveBeenCalledTimes(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
|
@ -188,37 +173,45 @@ describe('domainVisitsReducer', () => {
|
||||||
[{}],
|
[{}],
|
||||||
])('dispatches start and success when promise is resolved', async (query) => {
|
])('dispatches start and success when promise is resolved', async (query) => {
|
||||||
const visits = visitsMocks;
|
const visits = visitsMocks;
|
||||||
const shlinkApiClient = buildApiClientMock(Promise.resolve({
|
getDomainVisitsCall.mockResolvedValue({
|
||||||
data: visitsMocks,
|
data: visitsMocks,
|
||||||
pagination: {
|
pagination: {
|
||||||
currentPage: 1,
|
currentPage: 1,
|
||||||
pagesCount: 1,
|
pagesCount: 1,
|
||||||
totalItems: 1,
|
totalItems: 1,
|
||||||
},
|
},
|
||||||
}));
|
});
|
||||||
|
|
||||||
await getDomainVisits(() => shlinkApiClient)({ domain, query })(dispatchMock, getState);
|
await getDomainVisits({ domain, query })(dispatchMock, getState, {});
|
||||||
|
|
||||||
expect(dispatchMock).toHaveBeenCalledTimes(2);
|
expect(dispatchMock).toHaveBeenCalledTimes(2);
|
||||||
expect(dispatchMock).toHaveBeenNthCalledWith(1, { type: GET_DOMAIN_VISITS_START });
|
expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
|
||||||
expect(dispatchMock).toHaveBeenNthCalledWith(2, {
|
type: getDomainVisits.pending.toString(),
|
||||||
type: GET_DOMAIN_VISITS,
|
}));
|
||||||
|
expect(dispatchMock).toHaveBeenNthCalledWith(2, expect.objectContaining({
|
||||||
|
type: getDomainVisits.fulfilled.toString(),
|
||||||
payload: { visits, domain, query: query ?? {} },
|
payload: { visits, domain, query: query ?? {} },
|
||||||
});
|
}));
|
||||||
expect(shlinkApiClient.getDomainVisits).toHaveBeenCalledTimes(1);
|
expect(getDomainVisitsCall).toHaveBeenCalledTimes(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
it.each([
|
it.each([
|
||||||
[
|
[
|
||||||
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 20)) })],
|
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 20)) })],
|
||||||
{ type: GET_DOMAIN_VISITS_FALLBACK_TO_INTERVAL, payload: 'last30Days' },
|
{ type: fallbackToIntervalAction.toString(), payload: 'last30Days' },
|
||||||
|
3,
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 100)) })],
|
[Mock.of<Visit>({ date: formatISO(subDays(new Date(), 100)) })],
|
||||||
{ type: GET_DOMAIN_VISITS_FALLBACK_TO_INTERVAL, payload: 'last180Days' },
|
{ type: fallbackToIntervalAction.toString(), payload: 'last180Days' },
|
||||||
|
3,
|
||||||
],
|
],
|
||||||
[[], expect.objectContaining({ type: GET_DOMAIN_VISITS })],
|
[[], expect.objectContaining({ type: getDomainVisits.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: {
|
||||||
|
@ -227,22 +220,23 @@ describe('domainVisitsReducer', () => {
|
||||||
totalItems: 1,
|
totalItems: 1,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
const getShlinkDomainVisits = jest.fn()
|
getDomainVisitsCall
|
||||||
.mockResolvedValueOnce(buildVisitsResult())
|
.mockResolvedValueOnce(buildVisitsResult())
|
||||||
.mockResolvedValueOnce(buildVisitsResult(lastVisits));
|
.mockResolvedValueOnce(buildVisitsResult(lastVisits));
|
||||||
const ShlinkApiClient = Mock.of<ShlinkApiClient>({ getDomainVisits: getShlinkDomainVisits });
|
|
||||||
|
|
||||||
await getDomainVisits(() => ShlinkApiClient)({ domain, doIntervalFallback: true })(dispatchMock, getState);
|
await getDomainVisits({ domain, doIntervalFallback: true })(dispatchMock, getState, {});
|
||||||
|
|
||||||
expect(dispatchMock).toHaveBeenCalledTimes(2);
|
expect(dispatchMock).toHaveBeenCalledTimes(expectedDispatchCalls);
|
||||||
expect(dispatchMock).toHaveBeenNthCalledWith(1, { type: GET_DOMAIN_VISITS_START });
|
expect(dispatchMock).toHaveBeenNthCalledWith(1, expect.objectContaining({
|
||||||
|
type: getDomainVisits.pending.toString(),
|
||||||
|
}));
|
||||||
expect(dispatchMock).toHaveBeenNthCalledWith(2, expectedSecondDispatch);
|
expect(dispatchMock).toHaveBeenNthCalledWith(2, expectedSecondDispatch);
|
||||||
expect(getShlinkDomainVisits).toHaveBeenCalledTimes(2);
|
expect(getDomainVisitsCall).toHaveBeenCalledTimes(2);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('cancelGetDomainVisits', () => {
|
describe('cancelGetDomainVisits', () => {
|
||||||
it('just returns the action with proper type', () =>
|
it('just returns the action with proper type', () =>
|
||||||
expect(cancelGetDomainVisits()).toEqual({ type: GET_DOMAIN_VISITS_CANCEL }));
|
expect(cancelGetDomainVisits()).toEqual(expect.objectContaining({ type: cancelGetDomainVisits.toString() })));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
Loading…
Reference in a new issue