refetchOneLastTime option for useQuery

[funwithtriangles]

The problem

I have one part of my app that is checking to see if we should be refetching or not. It tells another part of my app whether to stop refetching. Like this:

const isPolling = useIsPolling() // this is determined somewhere else in the app

const { data } = useInfiniteQuery({
    ...
    refetchInterval: isPolling ? POLL_INTERVAL : false,
  });

The problem I am facing, is that once polling has ended, I need to get one last request to get the final piece of updated data. When refetchInterval becomes false, it stops polling (as expected), but I'd love it to trigger one more request.

My proposal

const { data } = useInfiniteQuery({
    ...
    refetchInterval: isPolling ? POLL_INTERVAL : false,
    refetchOneLastTime: true // new feature
  });

When refetchOneLastTime is set to true, it triggers a query request if refetchInterval goes from true to false. Obviously the name of this option is up for debate 😛

Current workaround

I am able to solve my problem with some custom logic. This hook listens to isPolling and refetches based on the query key. It works but is a bit messy.

const useFetchAfterPolling = (
  queryKey: QueryKey,
  isPolling: boolean,
  isEnabled: boolean
) => {
  const queryClient = useQueryClient();
  const stableQueryKey = useDistinctValue(queryKey, isEqual); // spicy-hooks

  useEffect(() => {
    if (isPolling || !isEnabled) return;
    queryClient.refetchQueries({ queryKey: stableQueryKey });
  }, [isEnabled, isPolling, queryClient, stableQueryKey]);
};