Fix error when authProvider check methods are not async #10890
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When a developer forgets to return a Promise in
authProvider.checkAuth()
orauthProvider.checkError()
, they see a cryptic error message:Solution
Although the doc (and typescript) specifies that these methods must be async, react-admin can be more permissive and not throw any error in this case, by using async methods instead of promises.
How To Test
Update the authProvider in the simple example to use sync methods:
The simple example should still work.
Additional Checks
master
for a bugfix or a documentation fix, ornext
for a feature[ ] The PR includes unit tests (if not possible, describe why)[ ] The PR includes one or several stories (if not possible, describe why)No tests or stories because this is a corner case.