enhance: fetchAction.meta.createdAt -> fetchAction.meta.fetchedAt

.changeset/cold-melons-beam.md

@@ -0,0 +1,8 @@
+---
+'@data-client/core': minor
+---
+
+Renamed FETCH action.meta.createdAt to fetchedAt to be consistent with other actions like
+SET_RESPONSE.
+
+BREAKING CHANGE: fetchAction.meta.createdAt -> fetchAction.meta.fetchedAt

packages/core/src/actions.ts

@@ -80,7 +80,7 @@ export interface FetchMeta<A extends readonly any[] = readonly any[]> {
   resolve: (value?: any | PromiseLike<any>) => void;
   reject: (reason?: any) => void;
   promise: PromiseLike<any>;
-  createdAt: number;
+  fetchedAt: number;
 }
 
 export interface FetchAction<E extends EndpointAndUpdate<E> = EndpointDefault> {

packages/core/src/controller/Controller.ts

@@ -251,7 +251,7 @@ export default class Controller<
   };
 
   /**
-   * Resolves an inflight fetch. `fetchedAt` should `fetch`'s `createdAt`
+   * Resolves an inflight fetch.
    * @see https://dataclient.io/docs/api/Controller#resolve
    */
   resolve = <

packages/core/src/controller/createFetch.ts

@@ -25,7 +25,7 @@ export default function createFetch<
     resolve,
     reject,
     promise,
-    createdAt: Date.now(),
+    fetchedAt: Date.now(),
   };
 
   return {

packages/core/src/manager/NetworkManager.ts

@@ -154,7 +154,7 @@ export default class NetworkManager implements Manager {
    */
   protected handleFetch(action: FetchAction) {
     const fetch = action.payload;
-    const { key, resolve, reject, createdAt } = action.meta;
+    const { key, resolve, reject, fetchedAt } = action.meta;
     const throttle = !action.endpoint.sideEffect;
 
     const deferedFetch = () => {
@@ -178,7 +178,7 @@ export default class NetworkManager implements Manager {
         promise = resolvePromise(promise);
       }
       promise = promise
-        .then(data => {
+        .then(response => {
           let lastReset = this.getLastReset();
 
           /* istanbul ignore else */
@@ -190,23 +190,23 @@ export default class NetworkManager implements Manager {
           }
 
           // don't update state with promises started before last clear
-          if (createdAt >= lastReset) {
+          if (fetchedAt >= lastReset) {
             this.controller.resolve(action.endpoint, {
               args: action.meta.args,
-              response: data,
-              fetchedAt: createdAt,
+              response,
+              fetchedAt,
             });
           }
-          return data;
+          return response;
         })
         .catch(error => {
           const lastReset = this.getLastReset();
           // don't update state with promises started before last clear
-          if (createdAt >= lastReset) {
+          if (fetchedAt >= lastReset) {
             this.controller.resolve(action.endpoint, {
               args: action.meta.args,
               response: error,
-              fetchedAt: createdAt,
+              fetchedAt,
               error: true,
             });
           }
@@ -216,7 +216,7 @@ export default class NetworkManager implements Manager {
     };
 
     if (throttle) {
-      return this.throttle(key, deferedFetch, createdAt)
+      return this.throttle(key, deferedFetch, fetchedAt)
         .then(data => resolve(data))
         .catch(error => reject(error));
     } else {
@@ -267,7 +267,7 @@ export default class NetworkManager implements Manager {
   protected throttle(
     key: string,
     fetch: () => Promise<any>,
-    createdAt: number,
+    fetchedAt: number,
   ) {
     const lastReset = this.getLastReset();
     // we're already fetching so reuse the promise
@@ -280,7 +280,7 @@ export default class NetworkManager implements Manager {
       this.resolvers[key] = resolve;
       this.rejectors[key] = reject;
     });
-    this.fetchedAt[key] = createdAt;
+    this.fetchedAt[key] = fetchedAt;
 
     this.idleCallback(
       () => {

packages/core/src/manager/__tests__/pollingSubscription.ts

@@ -178,13 +178,13 @@ describe('PollingSubscription', () => {
       jest.advanceTimersByTime(5000);
       expect(dispatch.mock.calls.length).toBe(1);
       dispatch.mock.calls[0].forEach((element: any) => {
-        delete element?.meta?.createdAt;
+        delete element?.meta?.fetchedAt;
       });
       expect(dispatch.mock.calls[0]).toMatchSnapshot();
       jest.advanceTimersByTime(5000);
       expect(dispatch.mock.calls.length).toBe(2);
       dispatch.mock.calls[1].forEach((element: any) => {
-        delete element?.meta?.createdAt;
+        delete element?.meta?.fetchedAt;
       });
 
       expect(dispatch.mock.calls[1]).toMatchSnapshot();

packages/core/src/state/__tests__/reducer.ts

@@ -611,7 +611,7 @@ describe('reducer', () => {
           reject: (v: any) => null,
           resolve: (v: any) => null,
           promise: new Promise((v: any) => null),
-          createdAt: 0,
+          fetchedAt: 0,
         },
       };
       const iniState = {

packages/core/src/state/reducer/fetchReducer.ts

@@ -12,7 +12,7 @@ export function fetchReducer(state: State<unknown>, action: FetchAction) {
   if (action.endpoint.getOptimisticResponse && action.endpoint.sideEffect) {
     setAction = createOptimistic(action.endpoint, {
       args: action.meta.args,
-      fetchedAt: action.meta.createdAt,
+      fetchedAt: action.meta.fetchedAt,
     });
   } else {
     // If 'fetch' action reaches the reducer there are no middlewares installed to handle it

packages/react/src/__tests__/hooks-endpoint.web.tsx

@@ -36,7 +36,7 @@ async function testDispatchFetch(
   expect(dispatch).toHaveBeenCalledTimes(payloads.length);
   let i = 0;
   for (const call of dispatch.mock.calls) {
-    delete call[0]?.meta?.createdAt;
+    delete call[0]?.meta?.fetchedAt;
     delete call[0]?.meta?.promise;
     expect(call[0]).toMatchSnapshot();
     const action = call[0];

packages/react/src/hooks/__tests__/useDLE.native.tsx

@@ -46,7 +46,7 @@ async function testDispatchFetch(
   expect(dispatch.mock.calls.length).toBe(payloads.length);
   const i = 0;
   for (const call of dispatch.mock.calls) {
-    delete call[0]?.meta?.createdAt;
+    delete call[0]?.meta?.fetchedAt;
     delete call[0]?.meta?.promise;
     expect(call[0]).toMatchSnapshot();
     // const action = call[0];

packages/react/src/hooks/__tests__/useFetch.native.tsx

@@ -45,7 +45,7 @@ async function testDispatchFetch(
   expect(dispatch.mock.calls.length).toBe(payloads.length);
   let i = 0;
   for (const call of dispatch.mock.calls) {
-    delete call[0]?.meta?.createdAt;
+    delete call[0]?.meta?.fetchedAt;
     delete call[0]?.meta?.promise;
     expect(call[0]).toMatchSnapshot();
     const action = call[0];

packages/react/src/hooks/__tests__/useFetch.web.tsx

@@ -35,7 +35,7 @@ async function testDispatchFetch(
   expect(dispatch.mock.calls.length).toBe(payloads.length);
   let i = 0;
   for (const call of dispatch.mock.calls) {
-    delete call[0]?.meta?.createdAt;
+    delete call[0]?.meta?.fetchedAt;
     delete call[0]?.meta?.promise;
     expect(call[0]).toMatchSnapshot();
     const action = call[0];

packages/react/src/hooks/__tests__/useSuspense.native.tsx

@@ -65,7 +65,7 @@ async function testDispatchFetch(
   let i = 0;
   for (const call of dispatch.mock.calls as any) {
     expect(call[0].type).toBe(actionTypes.FETCH_TYPE);
-    delete call[0]?.meta?.createdAt;
+    delete call[0]?.meta?.fetchedAt;
     delete call[0]?.meta?.promise;
     expect(call[0]).toMatchSnapshot();
     const action: FetchAction = call[0] as any;

packages/react/src/hooks/__tests__/useSuspense.web.tsx

@@ -68,7 +68,7 @@ async function testDispatchFetch(
   let i = 0;
   for (const call of dispatch.mock.calls as any) {
     expect(call[0].type).toBe(actionTypes.FETCH_TYPE);
-    delete call[0]?.meta?.createdAt;
+    delete call[0]?.meta?.fetchedAt;
     delete call[0]?.meta?.promise;
     expect(call[0]).toMatchSnapshot();
     const action: FetchAction = call[0] as any;