Fix race condition in WithPermissions #5822
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When an app has two components calling WithPermissions on the same render phase, a race condition used to lead the second call to never return the actual permissions.
fzaninotto
commented
Jan 27, 2021
| expect(renders).toBe(1); // does not rerender when the getPermissions returns the same permissions | ||
| }); | ||
|
|
||
| it('can be called by two independent components', async () => { |
There was a problem hiding this comment.
this test used to fail before the patch
fzaninotto
commented
Jan 27, 2021
| @@ -13,7 +13,7 @@ const emptyParams = {}; | |||
|
|
|||
| // keep a cache of already fetched permissions to initialize state for new | |||
| // components and avoid a useless rerender if the permissions haven't changed | |||
| const alreadyFetchedPermissions = { '{}': [] }; | |||
| const alreadyFetchedPermissions = { '{}': undefined }; | |||
There was a problem hiding this comment.
This was another regression introduced in 3.11. Before, WithPermissions injected undefined on mount. After, it injected an empty array.
| @@ -71,7 +71,7 @@ const usePermissionsOptimized = (params = emptyParams) => { | |||
| error, | |||
| }); | |||
| }); | |||
| }, [getPermissions, params, setState]); | |||
| }, [getPermissions, key]); // eslint-disable-line react-hooks/exhaustive-deps | |||
There was a problem hiding this comment.
this is done on purpose, and there is no way around it
djhi
approved these changes
Jan 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When an app has two components calling
<WithPermissions>on the same render phase, a race condition used to lead the second call to never return the actual permissions.Foowas rendered once with empty permissions, then rerendered with the permissions Fetched from the authProvider.Barwas only rendered once, with empty permissions.This was a bug due to the permissions from the authProvider being compared to the cache rather than to the initial state.