Merge pull request #1677 from ral-facilities/configurable-retries

Allow query retry setting to be configurable
ral-facilities · Oct 2, 2024 · 309c2a7 · 309c2a7
2 parents 2633dcd + 03de9cb
commit 309c2a7
Show file tree

Hide file tree

Showing 34 changed files with 502 additions and 45 deletions.
diff --git a/packages/datagateway-common/src/api/cart.tsx b/packages/datagateway-common/src/api/cart.tsx
@@ -11,7 +11,7 @@ import {
   useMutation,
   UseMutationResult,
 } from 'react-query';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 export const fetchDownloadCart = (config: {
   facilityName: string;
@@ -57,6 +57,7 @@ export const useCart = (): UseQueryResult<DownloadCartItem[], AxiosError> => {
   const facilityName = useSelector(
     (state: StateType) => state.dgcommon.facilityName
   );
+  const retryICATErrors = useRetryICATErrors();
   return useQuery(
     'cart',
     () =>

diff --git a/packages/datagateway-common/src/api/dataPublications.tsx b/packages/datagateway-common/src/api/dataPublications.tsx
@@ -15,7 +15,7 @@ import { useSelector } from 'react-redux';
 import { useLocation } from 'react-router-dom';
 import { getApiParams, parseSearchToQuery } from '.';
 import { StateType } from '..';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 const fetchDataPublications = (
   apiUrl: string,
@@ -61,6 +61,7 @@ export const useDataPublicationsPaginated = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort, page, results } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     DataPublication[],
@@ -118,6 +119,7 @@ export const useDataPublicationsInfinite = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     [
@@ -154,6 +156,7 @@ export const useDataPublication = (
   >
 ): UseQueryResult<DataPublication, AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery(
     ['dataPublication', dataPublicationId],
@@ -203,6 +206,7 @@ export const useDataPublications = (
   additionalFilters: AdditionalFilters
 ): UseQueryResult<DataPublication[], AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     DataPublication[],
@@ -259,6 +263,7 @@ export const useDataPublicationCount = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number,

diff --git a/packages/datagateway-common/src/api/datafiles.tsx b/packages/datagateway-common/src/api/datafiles.tsx
@@ -18,7 +18,7 @@ import type {
   UseQueryOptions,
 } from 'react-query';
 import { useQuery, useInfiniteQuery } from 'react-query';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 export const fetchDatafiles = (
   apiUrl: string,
@@ -62,6 +62,7 @@ export const useDatafilesPaginated = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort, page, results } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Datafile[],
@@ -114,6 +115,7 @@ export const useDatafilesInfinite = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     ['datafile', { sort: JSON.stringify(sort), filters }, additionalFilters], // need to stringify sort as property order is important!
@@ -167,6 +169,7 @@ export const useDatafileCount = (
   const location = useLocation();
 
   const filters = parseSearchToQuery(location.search).filters;
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number,
@@ -223,6 +226,7 @@ export const useDatafileDetails = (
   >
 ): UseQueryResult<Datafile, AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Datafile,

diff --git a/packages/datagateway-common/src/api/datasets.tsx b/packages/datagateway-common/src/api/datasets.tsx
@@ -18,7 +18,7 @@ import {
   useInfiniteQuery,
   UseInfiniteQueryResult,
 } from 'react-query';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 export const fetchDatasets = (
   apiUrl: string,
@@ -60,6 +60,7 @@ export const useDataset = (
   additionalFilters?: AdditionalFilters
 ): UseQueryResult<Dataset[], AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Dataset[],
@@ -95,6 +96,7 @@ export const useDatasetsPaginated = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort, page, results } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Dataset[],
@@ -147,6 +149,7 @@ export const useDatasetsInfinite = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     ['dataset', { sort: JSON.stringify(sort), filters }, additionalFilters], // need to stringify sort as property order is important!
@@ -199,6 +202,7 @@ export const useDatasetCount = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const filters = parseSearchToQuery(location.search).filters;
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number,
@@ -242,6 +246,7 @@ export const useDatasetDetails = (
   datasetId: number
 ): UseQueryResult<Dataset, AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<Dataset, AxiosError, Dataset, [string, number]>(
     ['datasetDetails', datasetId],

diff --git a/packages/datagateway-common/src/api/facilityCycles.tsx b/packages/datagateway-common/src/api/facilityCycles.tsx
@@ -13,7 +13,7 @@ import {
   useInfiniteQuery,
   UseInfiniteQueryResult,
 } from 'react-query';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 const fetchFacilityCycles = (
   apiUrl: string,
@@ -79,6 +79,7 @@ export const useAllFacilityCycles = (
   enabled?: boolean
 ): UseQueryResult<FacilityCycle[], AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<FacilityCycle[], AxiosError, FacilityCycle[], string>(
     'facilityCycle',
@@ -100,6 +101,7 @@ export const useFacilityCyclesPaginated = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort, page, results } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     FacilityCycle[],
@@ -157,6 +159,7 @@ export const useFacilityCyclesInfinite = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     ['facilityCycle', instrumentId, { sort: JSON.stringify(sort), filters }],
@@ -220,6 +223,7 @@ export const useFacilityCycleCount = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number,

diff --git a/packages/datagateway-common/src/api/index.tsx b/packages/datagateway-common/src/api/index.tsx
@@ -24,7 +24,7 @@ import { useSelector } from 'react-redux';
 import { StateType } from '../state/app.types';
 import format from 'date-fns/format';
 import { isValid } from 'date-fns';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 export * from './cart';
 export * from './facilityCycles';
@@ -678,6 +678,7 @@ export const useIds = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number[],
@@ -758,6 +759,7 @@ export const useCustomFilter = (
   }[]
 ): UseQueryResult<string[], Error> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     string[],
@@ -842,6 +844,7 @@ export const useCustomFilterCount = (
   }[]
 ): UseQueryResult<number, AxiosError>[] => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   const queryConfigs: UseQueryOptions<
     number,
@@ -891,7 +894,14 @@ export const useCustomFilterCount = (
         staleTime: Infinity,
       };
     });
-  }, [apiUrl, entityType, filterIds, filterKey, additionalFilters]);
+  }, [
+    filterIds,
+    entityType,
+    filterKey,
+    additionalFilters,
+    retryICATErrors,
+    apiUrl,
+  ]);
 
   // useQueries doesn't allow us to specify type info, so ignore this line
   // since we strongly type the queries object anyway

diff --git a/packages/datagateway-common/src/api/instruments.tsx b/packages/datagateway-common/src/api/instruments.tsx
@@ -18,7 +18,7 @@ import {
   useInfiniteQuery,
   UseInfiniteQueryResult,
 } from 'react-query';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 const fetchInstruments = (
   apiUrl: string,
@@ -62,6 +62,7 @@ export const useInstrumentsPaginated = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort, page, results } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Instrument[],
@@ -112,6 +113,7 @@ export const useInstrumentsInfinite = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     ['instrument', { sort: JSON.stringify(sort), filters }], // need to stringify sort as property order is important!
@@ -155,6 +157,7 @@ export const useInstrumentCount = (): UseQueryResult<number, AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number,
@@ -198,6 +201,7 @@ export const useInstrumentDetails = (
   instrumentId: number
 ): UseQueryResult<Instrument, AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<Instrument, AxiosError, Instrument, [string, number]>(
     ['instrumentDetails', instrumentId],

diff --git a/packages/datagateway-common/src/api/investigations.tsx b/packages/datagateway-common/src/api/investigations.tsx
@@ -18,7 +18,7 @@ import {
   useQuery,
   UseQueryResult,
 } from 'react-query';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 export const fetchInvestigations = (
   apiUrl: string,
@@ -61,6 +61,7 @@ export const useInvestigation = (
   additionalFilters?: AdditionalFilters
 ): UseQueryResult<Investigation[], AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Investigation[],
@@ -97,6 +98,7 @@ export const useInvestigationsPaginated = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort, page, results } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     Investigation[],
@@ -158,6 +160,7 @@ export const useInvestigationsInfinite = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const { filters, sort } = parseSearchToQuery(location.search);
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     [
@@ -216,6 +219,7 @@ export const useInvestigationCount = (
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
   const location = useLocation();
   const filters = parseSearchToQuery(location.search).filters;
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<
     number,
@@ -267,6 +271,7 @@ export const useInvestigationDetails = (
   investigationId: number
 ): UseQueryResult<Investigation, AxiosError> => {
   const apiUrl = useSelector((state: StateType) => state.dgcommon.urls.apiUrl);
+  const retryICATErrors = useRetryICATErrors();
 
   return useQuery<Investigation, AxiosError, Investigation, [string, number]>(
     ['investigationDetails', investigationId],

diff --git a/packages/datagateway-common/src/api/lucene.tsx b/packages/datagateway-common/src/api/lucene.tsx
@@ -19,7 +19,7 @@ import {
 } from '../app.types';
 import handleICATError from '../handleICATError';
 import { readSciGatewayToken } from '../parseTokens';
-import retryICATErrors from './retryICATErrors';
+import { useRetryICATErrors } from './retryICATErrors';
 
 interface QueryParameters {
   target: string;
@@ -352,6 +352,7 @@ export const useLuceneSearchInfinite = (
       {}
     );
   }
+  const retryICATErrors = useRetryICATErrors();
 
   return useInfiniteQuery(
     ['search', datasearchType, luceneParams],