feat(makeServerFetchye): adding run method to response

[jjallwood]

We have been experimenting with using fetchye across our tenancy, and have run into an interesting case where we want to be able to use both the data, and the reload run methods as part of our module thunk methods. Currently we get both the data object and the run method into our components via the useFetchye hook, we then pass these into our redux thunks as parameters. However this method is clumsy and starts to get heavy when the example includes more than one source of data (we managed to get up to 3x in one case), or when thunks begin to chain calls.

This change is to export the run method, so both the two interfaces to Fetchye expose the same API to the client. This would allow us to re-use the underlying makeOneServerFetchye methods not only in our loadModuleData functions, but in redux thunks to load / get / reload data without getting stuck in parameter hell.

Since we have started this change the oneFetchye method was added to fetchye-one-app which compliments our change allowing engineers to just dispatch their fetchye requests in their thunk.

What we have today

const onPrimaryTravelerSaveThunk = ({
  contactInfo, // fetchye run and data are renamed and passed as a param to the thunk
  reloadContactInfo, 
}) => async (dispatch, getState) => {
  const state = getState();
  await dispatch(setFormSubmitted(true));

  if (hasFormChanged(contactInfo, state)) {
    dispatch(setIsSaving());
    try {
      await dispatch(postUpdatesThunk());
      await dispatch(setSaveSuccessful());
    } catch (error) {
      await dispatch(setErrorSaving());
    } finally {
      reloadContactInfo();
    }
  }
  dispatch(setFormSubmitted(false));
};

What we would like to be able to do

const onPrimaryTravelerSaveThunk = () => async (dispatch, getState) => {
  const state = getState();
  await dispatch(setFormSubmitted(true));

  const {
    data: contactInfo,
    run: reloadContactInfo,
  } = await dispatch(loadContactInfo());  // by accessing data directly from fetchye via a thunk. we can remove the parameters

  if (hasFormChanged(contactInfo, state)) {
    dispatch(setIsSaving());
    try {
      await dispatch(postUpdatesThunk());
      await dispatch(setSaveSuccessful());
    } catch (error) {
      await dispatch(setErrorSaving());
    } finally {
      reloadContactInfo();
    }
  }
  dispatch(setFormSubmitted(false));
};

Here is how we access the exported data, errors and run response within a thunk context via our loadContactInfo function

export const loadContactInfo = ({
  isCompanion,
  companionId,
}) => async (dispatch, getState) => {
  const { data: profileId } = await dispatch(loadProfileId);
  const { data: secToken } = await dispatch(loadSecToken);
  return dispatch(oneFetchye(
    getContactInfoUrl(profileId, isCompanion, companionId)(getState()),
    {
      headers: generateHeaders(secToken),
      credentials: 'include',
    }
  ));
};

[CLAassistant]

All committers have signed the CLA.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit a5cb219:

Sandbox	Source
quick-install	Configuration
fetchye-provider-install	Configuration
fetchye-redux-provider-install	Configuration
nextjs-fetchye-ssr	Configuration

[code-forger]

🚀