enhance: setResponseAction.payload -> setResponseAction.response; rem…

…ove fetchAction.payload (#3141)

.changeset/big-crews-pump.md

@@ -0,0 +1,50 @@
+---
+'@data-client/core': minor
+'@data-client/react': patch
+'@data-client/test': patch
+---
+
+BREAKING CHANGE: setResponseAction.payload -> setResponseAction.response
+
+This only affects those writing custom [Managers](https://dataclient.io/docs/concepts/managers) that
+inspect `SET_RESPONSE_TYPE` `action.payload`.
+
+#### Before
+
+```ts
+import { SET_RESPONSE_TYPE, type Manager, type Middleware } from '@data-client/react';
+
+export default class MyManager implements Manager {
+  getMiddleware = (): Middleware => controller => next => async action => {
+    switch (action.type) {
+      case SET_RESPONSE_TYPE:
+        console.log('Resolved with value', action.payload);
+        return next(action);
+      default:
+        return next(action);
+    }
+  };
+
+  cleanup() {}
+}
+```
+
+#### After
+
+```ts
+import { SET_RESPONSE_TYPE, type Manager, type Middleware } from '@data-client/react';
+
+export default class MyManager implements Manager {
+  getMiddleware = (): Middleware => controller => next => async action => {
+    switch (action.type) {
+      case SET_RESPONSE_TYPE:
+        console.log('Resolved with value', action.response);
+        return next(action);
+      default:
+        return next(action);
+    }
+  };
+
+  cleanup() {}
+}
+```

.changeset/light-tables-guess.md

@@ -0,0 +1,53 @@
+---
+'@data-client/core': minor
+'@data-client/react': patch
+'@data-client/test': patch
+---
+
+BREAKING CHANGE: remove fetchAction.payload
+
+This only affects those writing custom [Managers](https://dataclient.io/docs/concepts/managers) that
+inspect `FETCH_TYPE` `action.fetch`.
+
+#### Before
+
+```ts
+import { FETCH_TYPE, type Manager, type Middleware } from '@data-client/react';
+
+export default class MyManager implements Manager {
+  getMiddleware = (): Middleware => controller => next => async action => {
+    switch (action.type) {
+      case FETCH_TYPE:
+        // consume fetch, and print the resolution
+        action.fetch().then(response => console.log(response));
+      default:
+        return next(action);
+    }
+  };
+
+  cleanup() {}
+}
+```
+
+#### After
+
+```ts
+import { FETCH_TYPE, type Manager, type Middleware } from '@data-client/react';
+
+export default class MyManager implements Manager {
+  getMiddleware = (): Middleware => controller => next => async action => {
+    switch (action.type) {
+      case FETCH_TYPE:
+        // consume fetch, and print the resolution
+        action
+          .endpoint(...action.meta.args)
+          .fetch()
+          .then(response => console.log(response));
+      default:
+        return next(action);
+    }
+  };
+
+  cleanup() {}
+}
+```

packages/core/src/actions.ts

@@ -57,7 +57,7 @@ export interface SetResponseActionSuccess<
   type: typeof SET_RESPONSE_TYPE;
   endpoint: E;
   meta: SetResponseMeta;
-  payload: ResolveType<E>;
+  response: ResolveType<E>;
   error?: false;
 }
 export interface SetResponseActionError<
@@ -66,7 +66,7 @@ export interface SetResponseActionError<
   type: typeof SET_RESPONSE_TYPE;
   endpoint: E;
   meta: SetResponseMeta;
-  payload: UnknownError;
+  response: UnknownError;
   error: true;
 }
 export type SetResponseAction<
@@ -87,7 +87,6 @@ export interface FetchAction<E extends EndpointAndUpdate<E> = EndpointDefault> {
   type: typeof FETCH_TYPE;
   endpoint: E;
   meta: FetchMeta<readonly [...Parameters<E>]>;
-  payload: () => ReturnType<E>;
 }
 
 /* OPTIMISTIC */

packages/core/src/controller/createFetch.ts

@@ -30,7 +30,6 @@ export default function createFetch<
 
   return {
     type: FETCH_TYPE,
-    payload: () => endpoint(...args) as any,
     meta,
     endpoint,
   };

packages/core/src/controller/createSetResponse.ts

@@ -59,19 +59,19 @@ export default function createSetResponse<
   if (process.env.NODE_ENV === 'development' && expiryLength < 0) {
     throw new Error('Negative expiry length are not allowed.');
   }
-  const now = Date.now();
+  const date = Date.now();
   const meta: SetResponseMeta = {
     args: args.map(ensurePojo),
-    fetchedAt: fetchedAt ?? now,
-    date: now,
-    expiresAt: now + expiryLength,
+    fetchedAt: fetchedAt ?? date,
+    date,
+    expiresAt: date + expiryLength,
     key: endpoint.key(...args),
   };
 
   const action: SetResponseAction<E> = {
     type: SET_RESPONSE_TYPE,
-    payload: response,
-    endpoint: endpoint,
+    response,
+    endpoint,
     meta,
   };
   if (error) (action as any).error = true;

packages/core/src/manager/LogoutManager.ts

@@ -18,7 +18,7 @@ export default class LogoutManager implements Manager {
       if (
         action.type === SET_RESPONSE_TYPE &&
         action.error &&
-        this.shouldLogout(action.payload)
+        this.shouldLogout(action.response)
       ) {
         this.handleLogout(controller);
       }

packages/core/src/manager/NetworkManager.ts

@@ -153,12 +153,11 @@ export default class NetworkManager implements Manager {
    * for ensures mutation requests always go through.
    */
   protected handleFetch(action: FetchAction) {
-    const fetch = action.payload;
     const { key, resolve, reject, fetchedAt } = action.meta;
     const throttle = !action.endpoint.sideEffect;
 
     const deferedFetch = () => {
-      let promise = fetch();
+      let promise = action.endpoint(...action.meta.args);
       const resolvePromise = (
         promise: Promise<string | number | object | null>,
       ) =>
@@ -237,7 +236,7 @@ export default class NetworkManager implements Manager {
       } else {
         promiseHandler = this.resolvers[action.meta.key];
       }
-      promiseHandler(action.payload);
+      promiseHandler(action.response);
       // since we're resolved we no longer need to keep track of this promise
       this.clear(action.meta.key);
     }

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

@@ -17,7 +17,6 @@ exports[`PollingSubscription fresh data should call after period 1`] = `
       "reject": [Function],
       "resolve": [Function],
     },
-    "payload": [Function],
     "type": "rdc/fetch",
   },
 ]
@@ -34,7 +33,6 @@ exports[`PollingSubscription fresh data should call after period 2`] = `
       "reject": [Function],
       "resolve": [Function],
     },
-    "payload": [Function],
     "type": "rdc/fetch",
   },
 ]

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

@@ -6,7 +6,7 @@ import Controller from '../../controller/Controller';
 import createFetch from '../../controller/createFetch';
 import NetworkManager from '../../manager/NetworkManager';
 import { initialState } from '../../state/reducer/createReducer';
-import { Middleware } from '../../types';
+import { Middleware, SetResponseAction } from '../../types';
 
 describe('NetworkManager', () => {
   const manager = new NetworkManager();
@@ -154,15 +154,17 @@ describe('NetworkManager', () => {
 
       middleware(API)(next)(fetchResolveAction);
 
-      const data = await fetchResolveAction.payload();
+      const response = await fetchResolveAction.endpoint(
+        ...fetchResolveAction.meta.args,
+      );
 
       // mutations resolve before dispatch, so we must wait for next tick to see set
       await new Promise(resolve => setTimeout(resolve, 0));
 
-      const action = {
+      const action: SetResponseAction = {
         type: SET_RESPONSE_TYPE,
         endpoint: fetchResolveAction.endpoint,
-        payload: data,
+        response,
         meta: {
           args: fetchResolveAction.meta.args,
           key: fetchResolveAction.meta.key,
@@ -187,15 +189,17 @@ describe('NetworkManager', () => {
 
       middleware(API)(next)(fetchSetWithUpdatersAction);
 
-      const data = await fetchSetWithUpdatersAction.payload();
+      const response = await fetchSetWithUpdatersAction.endpoint(
+        ...fetchSetWithUpdatersAction.meta.args,
+      );
 
       // mutations resolve before dispatch, so we must wait for next tick to see set
       await new Promise(resolve => setTimeout(resolve, 0));
 
-      const action = {
+      const action: SetResponseAction = {
         type: SET_RESPONSE_TYPE,
         endpoint: fetchSetWithUpdatersAction.endpoint,
-        payload: data,
+        response,
         meta: {
           args: fetchSetWithUpdatersAction.meta.args,
           key: fetchSetWithUpdatersAction.meta.key,
@@ -220,15 +224,17 @@ describe('NetworkManager', () => {
 
       middleware(API)(next)(fetchRpcWithUpdatersAction);
 
-      const data = await fetchRpcWithUpdatersAction.payload();
+      const response = await fetchRpcWithUpdatersAction.endpoint(
+        ...fetchRpcWithUpdatersAction.meta.args,
+      );
 
       // mutations resolve before dispatch, so we must wait for next tick to see set
       await new Promise(resolve => setTimeout(resolve, 0));
 
-      const action = {
+      const action: SetResponseAction = {
         type: SET_RESPONSE_TYPE,
         endpoint: fetchRpcWithUpdatersAction.endpoint,
-        payload: data,
+        response,
         meta: {
           args: fetchRpcWithUpdatersAction.meta.args,
           key: fetchRpcWithUpdatersAction.meta.key,
@@ -253,15 +259,17 @@ describe('NetworkManager', () => {
 
       middleware(API)(next)(fetchRpcWithUpdatersAndOptimisticAction);
 
-      const data = await fetchRpcWithUpdatersAndOptimisticAction.payload();
+      const response = await fetchRpcWithUpdatersAndOptimisticAction.endpoint(
+        ...fetchRpcWithUpdatersAndOptimisticAction.meta.args,
+      );
 
       expect(next).toHaveBeenCalled();
       // mutations resolve before dispatch, so we must wait for next tick to see set
       await new Promise(resolve => setTimeout(resolve, 0));
       expect(dispatch).toHaveBeenCalledWith({
         type: SET_RESPONSE_TYPE,
         endpoint: fetchRpcWithUpdatersAndOptimisticAction.endpoint,
-        payload: data,
+        response,
         meta: {
           args: fetchRpcWithUpdatersAndOptimisticAction.meta.args,
           key: fetchRpcWithUpdatersAndOptimisticAction.meta.key,
@@ -286,7 +294,7 @@ describe('NetworkManager', () => {
         endpoint: detailEndpoint.extend({ dataExpiryLength: 314 }),
       });
 
-      await fetchResolveAction.payload();
+      await fetchResolveAction.endpoint(...fetchResolveAction.meta.args);
 
       expect(dispatch).toHaveBeenCalled();
       const { meta } = dispatch.mock.calls[0][0];
@@ -307,7 +315,7 @@ describe('NetworkManager', () => {
         endpoint: detailEndpoint.extend({ dataExpiryLength: undefined }),
       });
 
-      await fetchResolveAction.payload();
+      await fetchResolveAction.endpoint(...fetchResolveAction.meta.args);
 
       expect(dispatch).toHaveBeenCalled();
       const { meta } = dispatch.mock.calls[0][0];
@@ -330,7 +338,7 @@ describe('NetworkManager', () => {
         expect(next).not.toHaveBeenCalled();
         expect(dispatch).toHaveBeenCalledWith({
           type: SET_RESPONSE_TYPE,
-          payload: error,
+          response: error,
           meta: {
             key: fetchRejectAction.meta.key,
             date: expect.any(Number),

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

@@ -48,31 +48,31 @@ describe('SubscriptionManager', () => {
 
   describe('middleware', () => {
     function createSubscribeAction(
-      payload: Record<string, any>,
+      response: Record<string, any>,
       reject = false,
     ): SubscribeAction {
       const fetch =
         reject ?
           () => Promise.reject(new Error('Failed'))
-        : () => Promise.resolve(payload);
+        : () => Promise.resolve(response);
       return {
         type: SUBSCRIBE_TYPE,
         endpoint: PollingArticleResource.get,
         meta: {
-          key: PollingArticleResource.get.key({ id: payload.id }),
-          args: [{ id: payload.id }],
+          key: PollingArticleResource.get.key({ id: response.id }),
+          args: [{ id: response.id }],
         },
       };
     }
     function createUnsubscribeAction(
-      payload: Record<string, any>,
+      response: Record<string, any>,
     ): UnsubscribeAction {
       return {
         type: UNSUBSCRIBE_TYPE,
         endpoint: PollingArticleResource.get,
         meta: {
-          key: PollingArticleResource.get.key({ id: payload.id }),
-          args: [{ id: payload.id }],
+          key: PollingArticleResource.get.key({ id: response.id }),
+          args: [{ id: response.id }],
         },
       };
     }