Fix useFacetCallback mismatch subscriptions #115
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
pirelenito
requested review from
a team and
xaviervia
and removed request for
a team
ja-ni
approved these changes
Mar 6, 2023
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.
After the fix of #114, it introduced a new bug that would cause the callback to never being able to be called since
useFacetCallbackwould internally might no longer have a facet with an active subscription.The new bug was caused by using a shared
noopinstance across all usages ofuseFacetCallback, and it occurs because ourcreateFacetimplementation uses a given listener instance as a key to keep track of all its listeners. See: https://github.com/Mojang/ore-ui/blob/main/packages/%40react-facet/core/src/facet/createFacet.ts#L17The fix makes sure that we don't reuse the same instance, with a accompanying unit test.
In the future we might want to review our decision of using a
Setas it can potentially introduce issues such as this one. There has been some work on this front, but it comes with other challenges as well (potentially on performance and supporting unsubscribing as events are firing).