Merge pull request #343 from amplitude/AMP-KW-override

Add `customQueryMiddlewareConfig` to requests/mutations

Author: kelsonpw

packages/redux-query-react/flow-test/hooks/use-request.js

@@ -7,6 +7,9 @@ import useRequest from '../../src/hooks/use-request';
 const Card = () => {
   const [{ isPending }] = useRequest({
     url: '/api',
+    customQueryMiddlewareConfig: {
+      retryableStatusCodes: [504],
+    },
   });
 
   return <div>{isPending ? 'loading…' : 'loaded'}</div>;

packages/redux-query/index.d.ts

@@ -39,15 +39,15 @@ declare module 'redux-query' {
   export type RollbackStrategy<T> = (initialValue: T, currentValue: T) => T;
 
   export type Update<TEntities = Entities> = {
-    [K in keyof TEntities]?: UpdateStrategy<TEntities[K]>
+    [K in keyof TEntities]?: UpdateStrategy<TEntities[K]>;
   };
 
   export type OptimisticUpdate<TEntities = Entities> = {
-    [K in keyof TEntities]?: OptimisticUpdateStrategy<TEntities[K]>
+    [K in keyof TEntities]?: OptimisticUpdateStrategy<TEntities[K]>;
   };
 
   export type Rollback<TEntities = Entities> = {
-    [K in keyof TEntities]?: RollbackStrategy<TEntities[K]>
+    [K in keyof TEntities]?: RollbackStrategy<TEntities[K]>;
   };
 
   export interface WithTime {
@@ -158,6 +158,15 @@ declare module 'redux-query' {
     queryCount: number;
   };
 
+  export type QueryMiddlewareConfig = {
+    backoff: {
+      maxAttempts: number;
+      minDuration: number;
+      maxDuration: number;
+    };
+    retryableStatusCodes: Array<Status>;
+  };
+
   export interface QueryConfig<TEntities = Entities> {
     body?: RequestBody;
     force?: boolean;
@@ -171,6 +180,7 @@ declare module 'redux-query' {
     rollback?: Rollback<TEntities>;
     unstable_preDispatchCallback?: () => void;
     url: Url;
+    customQueryMiddlewareConfig?: QueryMiddlewareConfig;
   }
 
   export interface QueriesState {

packages/redux-query/src/actions/index.js

@@ -276,6 +276,7 @@ export const requestAsync = ({
   url,
   /* eslint-disable-next-line camelcase */
   unstable_preDispatchCallback,
+  customQueryMiddlewareConfig,
 }: QueryConfig): RequestAsyncAction => {
   return {
     type: actionTypes.REQUEST_ASYNC,
@@ -289,6 +290,7 @@ export const requestAsync = ({
     update,
     url,
     unstable_preDispatchCallback,
+    customQueryMiddlewareConfig,
   };
 };
 
@@ -307,6 +309,7 @@ export const mutateAsync = ({
   transform,
   update,
   url,
+  customQueryMiddlewareConfig,
 }: QueryConfig): MutateAsyncAction => {
   return {
     type: actionTypes.MUTATE_ASYNC,
@@ -319,6 +322,7 @@ export const mutateAsync = ({
     transform,
     update,
     url,
+    customQueryMiddlewareConfig,
   };
 };
 

packages/redux-query/src/middleware/query.js

@@ -29,25 +29,17 @@ import type {
   ResponseBody,
   Status,
   Transform,
+  QueryMiddlewareConfig,
 } from '../types';
 
-type Config = {|
-  backoff: {|
-    maxAttempts: number,
-    minDuration: number,
-    maxDuration: number,
-  |},
-  retryableStatusCodes: Array<Status>,
-|};
-
 type ReduxStore = {|
   dispatch: (action: Action) => any,
   getState: () => any,
 |};
 
 type Next = (action: PublicAction) => any;
 
-const defaultConfig: Config = {
+const defaultConfig: QueryMiddlewareConfig = {
   backoff: {
     maxAttempts: 5,
     minDuration: 300,
@@ -105,7 +97,8 @@ const queryMiddleware = (
 
   return ({ dispatch, getState }: ReduxStore) => (next: Next) => (action: PublicAction) => {
     let returnValue;
-    const config = { ...defaultConfig, ...customConfig };
+    const customQueryMiddlewareConfigFromAction = action.customQueryMiddlewareConfig || {};
+    const config = { ...defaultConfig, ...customConfig, ...customQueryMiddlewareConfigFromAction };
 
     switch (action.type) {
       case actionTypes.REQUEST_ASYNC: {

packages/redux-query/src/types.js

@@ -13,6 +13,15 @@ type QueryOptions = {
   headers?: { [key: string]: any },
 };
 
+export type QueryMiddlewareConfig = {|
+  backoff: {|
+    maxAttempts: number,
+    minDuration: number,
+    maxDuration: number,
+  |},
+  retryableStatusCodes: Array<Status>,
+|};
+
 export type QueryConfig = {|
   body?: RequestBody,
   force?: boolean,
@@ -26,6 +35,7 @@ export type QueryConfig = {|
   rollback?: { [key: string]: (initialValue: any, currentValue: any) => any },
   unstable_preDispatchCallback?: () => void,
   url: Url,
+  customQueryMiddlewareConfig?: QueryMiddlewareConfig,
 |};
 
 export type QueryDetails = {