Request State Issue - Need To Access Query Metadata(?)

[peter-batley-depop]

Context

• I have an infinite query to make requests to a search service
  • This query is prefetched in a server component, and consumed in multiple client components
• The search service requires the client to send a unique ID for each 'new' request
  • a new request is defined as any change to search query string, filters, sorting etc. (i.e. all requests except requests for more pages of an existing query)
• The client application also needs to have the unique ID whilst the request is in flight
• If client state reverts to an already cached query (e.g. add a filter and then remove it):
  • if query is not stale, use the cached data + its associated uuid
  • if query is stale, refetch the data and generate a new uuid

Is there any way to neatly achieve my desired functionality with the current API?

I believe that this is a difficult problem because my request has a dependency that does not belong in the query key (the uuid). The mapping from query key to UUID is 1:many, because we need a new one each time the query goes stale.

Current Hack - leveraging page params

• use a global state solution (redux or context) to generate optimistic UUIDs
• use page params to pass a UUID from one page to the next
• create a custom data fetching hook to wrap the useInfiniteQuery
  • return the optimistic UUID from this hook alongside the useInfiniteQuery result
  • within the queryFn, try to use lastPage.uuid and fall back to the optimistic UUID

This solution ensures that page 0 fetches (i.e. 'new' requests) always use a new UUID. And the page params hack ensures that subsequent pages of a query retain a consistent UUID.