Expose a way to update query cache for custom data provider methods

[jvasseur]

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

When calling custom RPC methods like described in https://marmelab.com/react-admin/Actions.html#calling-custom-methods, if you want to update the query cache like it is done in the built-in useUpdate hooks you have to either copy most of what the updateCache function is doing into your code or force a complete refresh of the ressource.

Describe the solution you'd like

I would like a method to update the query cache without having to trigger a full refresh. The simplest solution is probably to expose the updateCache feature as a public API (maybe a useUpdateCache hook).

Another solution could be to allow overriding the data provider method that is called by the useUpdate hook but that requires that the method returns the data in the correct format and it wouldn't cover the case where a mutation update multiple entities at the same time.

I'm willing to spend some time working of the solution if it's something that you are willing to add to the core.

[slax57]

Hi,

Not sure exactly what you are missing here:

• If you need to create your own 'useUpdate' but for your custom method, then you can copy the useUpdate hook's code and call this hook instead (btw, since 5.12.0, copying a dataProvider hook is easier than ever thanks to the useMutationWithMutationMode abstraction 😀 )
• If you simply need to edit the cache after calling useUpdate, you can easily do it in a side-effect callback (like onSuccess) by calling queryClient.setQueriesData() yourself. See the CRM demo for an example.

Feel free to elaborate on your needs if they are still not covered by this reply (or to close this issue if they are!)

Thanks

[jvasseur]

The problem with calling setQueriesData is that you have to call it multiple times to update the getOne, getList, getMany, getManyReference. I would like to have a way to abstract all that into one call.

Which is what a copy of the useUpdate code would be but it requires to copy paste code from RA which is not ideal.

Basically what I want is to be able to do something like this:

const dataProvider = useDataProvider();
const updateCache = useUpdateCache();
const { mutate, isPending } = useMutation({
    mutationFn: () => dataProvider.banUser(userId),
    onSuccess: () => updateCache('users', userId, { banned: true }),
});

(This could of course be improved with the addition of the useMutationWithMutationMode if we want to support other mutation modes).