enhance: Remove throttle from fetch action (#3138)

reactive · Jul 8, 2024 · ee509fb · ee509fb
1 parent 2ad1811
commit ee509fb
Show file tree

Hide file tree

Showing 13 changed files with 11 additions and 28 deletions.
diff --git a/.changeset/healthy-buses-design.md b/.changeset/healthy-buses-design.md
@@ -0,0 +1,7 @@
+---
+'@data-client/core': minor
+---
+
+Remove throttle from FETCH_TYPE action
+
+BREAKING CHANGE: action.meta.throttle -> !action.endpoint.sideEffect
diff --git a/packages/core/src/actions.ts b/packages/core/src/actions.ts
@@ -77,7 +77,6 @@ export type SetResponseAction<
 export interface FetchMeta<A extends readonly any[] = readonly any[]> {
   args: A;
   key: string;
-  throttle: boolean;
   resolve: (value?: any | PromiseLike<any>) => void;
   reject: (reason?: any) => void;
   promise: PromiseLike<any>;

diff --git a/packages/core/src/controller/createFetch.ts b/packages/core/src/controller/createFetch.ts
@@ -22,7 +22,6 @@ export default function createFetch<
   const meta: FetchMeta<typeof args> = {
     args,
     key,
-    throttle: !endpoint.sideEffect,
     resolve,
     reject,
     promise,

diff --git a/packages/core/src/manager/NetworkManager.ts b/packages/core/src/manager/NetworkManager.ts
@@ -149,12 +149,13 @@ export default class NetworkManager implements Manager {
    * Will then start a promise for a key and potentially start the network
    * fetch.
    *
-   * Uses throttle only when instructed by action meta. This is valuable
+   * Uses throttle endpoints without sideEffects. This is valuable
    * for ensures mutation requests always go through.
    */
   protected handleFetch(action: FetchAction) {
     const fetch = action.payload;
-    const { key, throttle, resolve, reject, createdAt } = action.meta;
+    const { key, resolve, reject, createdAt } = action.meta;
+    const throttle = !action.endpoint.sideEffect;
 
     const deferedFetch = () => {
       let promise = fetch();

diff --git a/packages/core/src/manager/__tests__/__snapshots__/pollingSubscription.ts.snap b/packages/core/src/manager/__tests__/__snapshots__/pollingSubscription.ts.snap
@@ -17,7 +17,6 @@ exports[`PollingSubscription fresh data should call after period 1`] = `
       "promise": Promise {},
       "reject": [Function],
       "resolve": [Function],
-      "throttle": true,
     },
     "payload": [Function],
     "type": "rdc/fetch",
@@ -36,7 +35,6 @@ exports[`PollingSubscription fresh data should call after period 2`] = `
       "promise": Promise {},
       "reject": [Function],
       "resolve": [Function],
-      "throttle": true,
     },
     "payload": [Function],
     "type": "rdc/fetch",

diff --git a/packages/core/src/state/__tests__/reducer.ts b/packages/core/src/state/__tests__/reducer.ts
@@ -608,7 +608,6 @@ describe('reducer', () => {
         meta: {
           args: [{ id: 5 }],
           key: ArticleResource.get.url({ id: 5 }),
-          throttle: true,
           reject: (v: any) => null,
           resolve: (v: any) => null,
           promise: new Promise((v: any) => null),

diff --git a/packages/react/src/__tests__/__snapshots__/hooks-endpoint.web.tsx.snap b/packages/react/src/__tests__/__snapshots__/hooks-endpoint.web.tsx.snap
@@ -45,7 +45,6 @@ exports[`useController.fetch should dispatch an action that fetches a create 1`]
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": false,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -68,7 +67,6 @@ exports[`useController.fetch should dispatch an action that fetches a full updat
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": false,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -91,7 +89,6 @@ exports[`useController.fetch should dispatch an action that fetches a partial up
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": false,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -111,7 +108,6 @@ exports[`useController.fetch should dispatch an action with updater in the meta
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": false,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -131,7 +127,6 @@ exports[`useController.fetch should refresh get details 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",

diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useDLE.native.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useDLE.native.tsx.snap
@@ -13,7 +13,6 @@ exports[`useDLE should dispatch singles 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -33,7 +32,6 @@ exports[`useDLE should dispatch with fetch shape defined dataExpiryLength 1`] =
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -53,7 +51,6 @@ exports[`useDLE should dispatch with fetch shape defined errorExpiryLength 1`] =
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -73,7 +70,6 @@ exports[`useDLE should dispatch with resource defined dataExpiryLength 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",

diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useFetch.native.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useFetch.native.tsx.snap
@@ -13,7 +13,6 @@ exports[`useFetch should dispatch singles 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -33,7 +32,6 @@ exports[`useFetch should dispatch with fetch shape defined dataExpiryLength 1`]
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -53,7 +51,6 @@ exports[`useFetch should dispatch with fetch shape defined errorExpiryLength 1`]
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -73,7 +70,6 @@ exports[`useFetch should dispatch with resource defined dataExpiryLength 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",

diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useFetch.web.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useFetch.web.tsx.snap
@@ -13,7 +13,6 @@ exports[`useFetch should dispatch singles 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -33,7 +32,6 @@ exports[`useFetch should dispatch with fetch shape defined dataExpiryLength 1`]
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -53,7 +51,6 @@ exports[`useFetch should dispatch with fetch shape defined errorExpiryLength 1`]
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",
@@ -73,7 +70,6 @@ exports[`useFetch should dispatch with resource defined dataExpiryLength 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",

diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.native.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.native.tsx.snap
@@ -121,7 +121,6 @@ exports[`useSuspense() should dispatch an action that fetches 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",

diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.web.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.web.tsx.snap
@@ -121,7 +121,6 @@ exports[`useSuspense() should dispatch an action that fetches 1`] = `
     "nm": false,
     "reject": [Function],
     "resolve": [Function],
-    "throttle": true,
   },
   "payload": [Function],
   "type": "rdc/fetch",

diff --git a/website/src/components/Playground/editor-types/@data-client/core.d.ts b/website/src/components/Playground/editor-types/@data-client/core.d.ts
@@ -320,7 +320,6 @@ type SetResponseAction<E extends EndpointAndUpdate<E> = EndpointDefault> = SetRe
 interface FetchMeta<A extends readonly any[] = readonly any[]> {
     args: A;
     key: string;
-    throttle: boolean;
     resolve: (value?: any | PromiseLike<any>) => void;
     reject: (reason?: any) => void;
     promise: PromiseLike<any>;
@@ -658,7 +657,7 @@ declare class NetworkManager implements Manager {
      * Will then start a promise for a key and potentially start the network
      * fetch.
      *
-     * Uses throttle only when instructed by action meta. This is valuable
+     * Uses throttle endpoints without sideEffects. This is valuable
      * for ensures mutation requests always go through.
      */
     protected handleFetch(action: FetchAction): Promise<any>;