Migrated domainVisits reducer to RTK

2026-04-20 05:26:20 +00:00 · 2022-11-12 17:51:37 +01:00
parent a3cc3d5fc2
commit ab7c52d049
7 changed files with 200 additions and 139 deletions
--- a/src/container/store.ts
+++ b/src/container/store.ts
@@ -19,7 +19,7 @@ export const setUpStore = (container: IContainer) => configureStore({
  reducer: reducer(container),
  preloadedState,
  middleware: (defaultMiddlewaresIncludingReduxThunk) =>
-    defaultMiddlewaresIncludingReduxThunk({ immutableCheck: false, serializableCheck: false })// State is too big for these
+    defaultMiddlewaresIncludingReduxThunk({ immutableCheck: false, serializableCheck: false }) // State is too big for these
      .prepend(container.selectServerListener.middleware)
      .concat(save(localStorageConfig)),
 });
--- a/src/reducers/index.ts
+++ b/src/reducers/index.ts
@@ -3,7 +3,6 @@ import { combineReducers } from '@reduxjs/toolkit';
 import { serversReducer } from '../servers/reducers/servers';
 import shortUrlVisitsReducer from '../visits/reducers/shortUrlVisits';
 import tagVisitsReducer from '../visits/reducers/tagVisits';
-import domainVisitsReducer from '../visits/reducers/domainVisits';
 import orphanVisitsReducer from '../visits/reducers/orphanVisits';
 import nonOrphanVisitsReducer from '../visits/reducers/nonOrphanVisits';
 import { settingsReducer } from '../settings/reducers/settings';
@@ -21,7 +20,7 @@ export default (container: IContainer) => combineReducers<ShlinkState>({
  shortUrlDetail: container.shortUrlDetailReducer,
  shortUrlVisits: shortUrlVisitsReducer,
  tagVisits: tagVisitsReducer,
-  domainVisits: domainVisitsReducer,
+  domainVisits: container.domainVisitsReducer,
  orphanVisits: orphanVisitsReducer,
  nonOrphanVisits: nonOrphanVisitsReducer,
  tagsList: container.tagsListReducer,
--- a/src/visits/reducers/common.ts
+++ b/src/visits/reducers/common.ts
@@ -1,11 +1,13 @@
 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 { Visit } from '../types';
 import { parseApiError } from '../../api/utils';
 import { ApiErrorAction } from '../../api/types/actions';
-import { dateToMatchingInterval } from '../../utils/dates/types';
-import { VisitsLoaded, VisitsLoadProgressChangedAction } from './types';
+import { DateInterval, dateToMatchingInterval } from '../../utils/dates/types';
+import { LoadVisits, VisitsLoaded, VisitsLoadProgressChangedAction } from './types';
+import { createAsyncThunk } from '../../utils/helpers/redux';
+import { ShlinkState } from '../../container/types';

 const ITEMS_PER_PAGE = 5000;
 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 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>(
  visitsLoader: VisitsLoader,
  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 = (
  doIntervalFallback: boolean,
  loader: (params: ShlinkVisitsParams) => Promise<ShlinkVisits>,
--- a/src/visits/reducers/domainVisits.ts
+++ b/src/visits/reducers/domainVisits.ts
@@ -1,30 +1,13 @@
-import { createAction } from '@reduxjs/toolkit';
-import { Dispatch } from 'redux';
-import { buildReducer } from '../../utils/helpers/redux';
+import { createSlice } from '@reduxjs/toolkit';
 import { ShlinkApiClientBuilder } from '../../api/services/ShlinkApiClientBuilder';
-import { GetState } from '../../container/types';
-import { ApiErrorAction } from '../../api/types/actions';
 import { isBetween } from '../../utils/helpers/date';
-import { getVisitsWithLoader, lastVisitLoaderForLoader } from './common';
-import { createNewVisits, CreateVisitsAction } from './visitCreation';
+import { createVisitsAsyncThunk, lastVisitLoaderForLoader } from './common';
+import { createNewVisits } from './visitCreation';
 import { domainMatches } from '../../short-urls/helpers';
-import {
-  LoadVisits,
-  VisitsFallbackIntervalAction,
-  VisitsInfo,
-  VisitsLoaded,
-  VisitsLoadedAction,
-  VisitsLoadProgressChangedAction,
-} from './types';
+import { LoadVisits, VisitsInfo } from './types';
+import { parseApiError } from '../../api/utils';

 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';

@@ -36,14 +19,6 @@ export interface DomainVisits extends VisitsInfo, WithDomain {}

 export interface LoadDomainVisits extends LoadVisits, WithDomain {}

-type DomainVisitsAction = VisitsLoadedAction<WithDomain>;
-
-type DomainVisitsCombinedAction = DomainVisitsAction
-& VisitsLoadProgressChangedAction
-& VisitsFallbackIntervalAction
-& CreateVisitsAction
-& ApiErrorAction;
-
 const initialState: DomainVisits = {
  visits: [],
  domain: '',
@@ -54,44 +29,61 @@ const initialState: DomainVisits = {
  progress: 0,
 };

-export default buildReducer<DomainVisits, DomainVisitsCombinedAction>({
-  [`${REDUCER_PREFIX}/getDomainVisits/pending`]: () => ({ ...initialState, loading: true }),
-  [`${REDUCER_PREFIX}/getDomainVisits/rejected`]: (_, { errorData }) => ({ ...initialState, error: true, errorData }),
-  [`${REDUCER_PREFIX}/getDomainVisits/fulfilled`]: (state, { payload }: DomainVisitsAction) => (
-    { ...state, ...payload, loading: false, loadingLarge: false, error: false }
-  ),
-  [`${REDUCER_PREFIX}/getDomainVisits/large`]: (state) => ({ ...state, loadingLarge: true }),
-  [`${REDUCER_PREFIX}/getDomainVisits/cancel`]: (state) => ({ ...state, cancelLoad: true }),
-  [`${REDUCER_PREFIX}/getDomainVisits/progressChanged`]: (state, { payload: progress }) => ({ ...state, progress }),
-  [`${REDUCER_PREFIX}/getDomainVisits/fallbackToInterval`]: (state, { payload: fallbackInterval }) => (
-    { ...state, fallbackInterval }
-  ),
-  [createNewVisits.toString()]: (state, { payload }: CreateVisitsAction) => {
-    const { domain, visits, query = {} } = state;
-    const { startDate, endDate } = query;
-    const newVisits = payload.createdVisits
-      .filter(({ shortUrl, visit }) =>
-        shortUrl && domainMatches(shortUrl, domain) && isBetween(visit.date, startDate, endDate))
-      .map(({ visit }) => visit);
+export const getDomainVisits = (buildShlinkApiClient: ShlinkApiClientBuilder) => createVisitsAsyncThunk({
+  actionsPrefix: `${REDUCER_PREFIX}/getDomainVisits`,
+  createLoaders: ({ domain, query = {}, doIntervalFallback = false }: LoadDomainVisits, 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));

-    return { ...state, visits: [...newVisits, ...visits] };
+    return [visitsLoader, lastVisitLoader];
  },
-}, initialState);
+  getExtraFulfilledPayload: ({ domain, query = {} }: LoadDomainVisits) => ({ domain, query }),
+  shouldCancel: (getState) => getState().domainVisits.cancelLoad,
+});

-export const getDomainVisits = (buildShlinkApiClient: ShlinkApiClientBuilder) => (
-  { 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`;
+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 }
+      ));

-  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 }) => {
+        const { domain, visits, query = {} } = state;
+        const { startDate, endDate } = query;
+        const newVisits = payload.createdVisits
+          .filter(({ shortUrl, visit }) =>
+            shortUrl && domainMatches(shortUrl, domain) && isBetween(visit.date, startDate, endDate))
+          .map(({ visit }) => visit);
+
+        return { ...state, visits: [...newVisits, ...visits] };
+      });
+    },
+  });
+
+  const { cancelGetDomainVisits } = actions;
+
+  return { reducer, cancelGetDomainVisits };
 };
-
-export const cancelGetDomainVisits = createAction<void>(`${REDUCER_PREFIX}/getDomainVisits/cancel`);
--- a/src/visits/services/provideServices.ts
+++ b/src/visits/services/provideServices.ts
@@ -8,7 +8,7 @@ import { OrphanVisits } from '../OrphanVisits';
 import { NonOrphanVisits } from '../NonOrphanVisits';
 import { cancelGetShortUrlVisits, getShortUrlVisits } from '../reducers/shortUrlVisits';
 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 { cancelGetNonOrphanVisits, getNonOrphanVisits } from '../reducers/nonOrphanVisits';
 import { ConnectDecorator } from '../../container/types';
@@ -60,8 +60,9 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
  bottle.serviceFactory('getTagVisits', getTagVisits, 'buildShlinkApiClient');
  bottle.serviceFactory('cancelGetTagVisits', () => cancelGetTagVisits);

-  bottle.serviceFactory('getDomainVisits', getDomainVisits, 'buildShlinkApiClient');
-  bottle.serviceFactory('cancelGetDomainVisits', () => cancelGetDomainVisits);
+  bottle.serviceFactory('getDomainVisitsCreator', getDomainVisits, 'buildShlinkApiClient');
+  bottle.serviceFactory('getDomainVisits', prop('asyncThunk'), 'getDomainVisitsCreator');
+  bottle.serviceFactory('cancelGetDomainVisits', prop('cancelGetDomainVisits'), 'domainVisitsReducerCreator');

  bottle.serviceFactory('getOrphanVisits', getOrphanVisits, 'buildShlinkApiClient');
  bottle.serviceFactory('cancelGetOrphanVisits', () => cancelGetOrphanVisits);
@@ -75,6 +76,9 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
  // Reducers
  bottle.serviceFactory('visitsOverviewReducerCreator', visitsOverviewReducerCreator, 'loadVisitsOverview');
  bottle.serviceFactory('visitsOverviewReducer', prop('reducer'), 'visitsOverviewReducerCreator');
+
+  bottle.serviceFactory('domainVisitsReducerCreator', domainVisitsReducerCreator, 'getDomainVisitsCreator');
+  bottle.serviceFactory('domainVisitsReducer', prop('reducer'), 'domainVisitsReducerCreator');
 };

 export default provideServices;