React-query admin wrapper and possibily undefined value with useGetOne

According to the React Query documentation, we have the possibility to block the running query thanks to the enabled function if one of our parameter is not defined. On the documentation sample, we can see userId can be set on the query definition without any issue.

We also have the possibility to use this option from the useGetOne hooks as you specified on the code doc block

https://github.com/marmelab/react-admin/blob/69d1cd1af77a432e2d1a3c2215ee93a2dedcd4be/packages/ra-core/src/dataProvider/useGetOne.ts#L26

However, the typing of the function requires the id to be a valid identifier:

https://github.com/marmelab/react-admin/blob/1ddb1672fe323baffb80567c890c759b3cea379c/packages/ra-core/src/types.ts#L139

Because of that, we have to cheat by casting the typing of the undefined value, for example:

const { data: userData } = useGetOne<UserRecord>('users', { id: userId || '' }, { enabled: !!userId });

According to me, we should make that param optional to match the react-query implementation.

What do you think?

[fzaninotto]

Thanks for your proposal.

To me, what you suggest isn’t an improvement in the general case. If a user doesn’t use the enabled prop, they will see the id parameter as optional, which is misleading.

To make it work with TypeScript, the function should have two signatures: one with enabled enabled, where the params are optional, and one without. But I’m not even sure this is correct or feasible.

In other terms, I think the react-admin codebase shouldn’t handle this case. We should at most document the gotcha in the documentation of the enabled option.

That’s my opinion, I’m open to other points of view.

[fzaninotto]

Indeed, this issue remains open, so any PR addressing it is welcome!