[FEAT] React-Query v5 compatibility

[bombillazo]

Is your feature request related to a problem? Please describe.

We've created a branch to migrate our application code to RQ v5, but have refrained since Refine uses RQ under the hood and want to avoid breaking any dependencies.

Describe alternatives you've considered

Keep using RQ v4 for the time being.

Additional context

https://tanstack.com/query/v5/docs/react/guides/migrating-to-v5

The migration process is relatively straightforward. They did remove the query callbacks, and the new paradigm for reacting to queries is doing so with useEffect hooks. One can still set global callbacks for queries, which refine uses for the notifications context, so the migration for Refine will likely center around that for their custom useQuery hooks.

They've also standardized the query function signatures only to accept objects. The typing should auto-alert the internal refine code.

Describe the thing to improve

Having the ability to use React Query v5 in our refine project.

[BatuhanW]

Thanks for the issue @bombillazo.

Migration looks straightforward, other than callbacks. @aliemir had the idea of providing these callbacks as a polyfill with the current v4 version of refine.

This means we could still accept queryOptions.onSuccess, onError, etc., and trigger them with useEffect inside our hooks.

[bombillazo]

Yeah! I think that would be the best approach for backward compatibility; in fact, I think (if I remember correctly from the RQ maintainers) that is what RQ is doing internally for those callbacks.

[rilrom]

Would migrating to v5 allow us to take advantage of the react query suspense features?

[zernie]

yea suspense would be great

[bombillazo]

any update on this?

[donalffons]

Just wanted to give my +1 for this request.

(I'm having a "brownfield" project, which is already using react-query@5 and I tried using refine there. It looks like the missing support for the new version of react-query sadly blocks me from adopting refine.)

Also: Huge "thank you" for this fantastic project 🙂!

[zernie]

@BatuhanW could you please specify what needs to be done in preparation before migration to react-query v5?

[BatuhanW]

Hey @zernie the main refactor should be replacing removed onXXX calbacks with useEffect for notifications in internal logic. Also, since these callbacks might be used by current Refine users, we also need to keep these types and trigger them with useEffect. Other thing is we need to check react-query's new types and make sure there is no breaking change with current Refine types.

We are open to contributions for this issue, if anyone wants to work on this.

[bombillazo]

Was anyone able to look into this? The Refine source is pretty daunting and internally has lots of file/usage of RQ, perhaps identifying where the changes are required will motivate others to take the challenge?

[kziemski]

Curious if this is on roadmap and/or in need of contributors? Haven't seen any mention of it in awhile.

[BatuhanW]

Hey @kziemski we are open to contributions for this one.

We've discussed with core team internally, there is no way to do this upgrade without a breaking change in refine v4. If we update react-query to v5, we'll have users both on react-query v4 and v5. We will not release a major Refine version atm, and we also have plans to make react-query (Store provider) agnostic on our next major release. But they aren't clear yet.