Unstable return reference of generated hook when using a custom mutator hook.

[henkerik]

What are the steps to reproduce this issue?

First of all, thanks for building Orval. We use it for quite a few projects 👍 .

One can generate endpoints with a custom mutator hook, for example:

orval/samples/react-query/hook-mutator/endpoints.ts

Lines 36 to 38 in 4cfb246

	return (params?: ListPetsParams, signal?: AbortSignal) => {
	return listPets({ url: `/pets`, method: 'GET', params, signal });
	};

export const useListPetsHook = () => {
  const listPets = useCustomInstance<Pets>();

  return (params?: ListPetsParams, signal?: AbortSignal) => {
    return listPets({ url: `/pets`, method: 'GET', params, signal });
  };
};

What happens?

The reference returned by the generated useListPetsHook isn't stable: it changes on every render cycle.

What were you expecting to happen?

I would have expected the following:

export const useListPetsHook = () => {
  const listPets = useCustomInstance<Pets>();

  return useCallback((params?: ListPetsParams, signal?: AbortSignal) => {
    return listPets({ url: `/pets`, method: 'GET', params, signal });
  }, [listPets]);
};

Now, the useListPetsHook will return the same reference on subsequent calls (given that your useCustomInstance doesn't change of course).

A stable reference is useful when one uses memoization downstream, and the result of the useListPetsHook is part of a useMemo or useCallback call in user-land code.