🐛 Fix Presence.destroy() race condition
#645
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
There's currently a race condition that can throw uncaught errors when destroying both a `LocalPresence` *and* its parent `Presence` object. If the `LocalPresence` destroys first, then - since the `Presence` [cached][1] its ID before the `Presence` unsubscribe - by the time the `Presence` tries to destroy its children, the `LocalPresence` is already gone, which throws when [trying to call `destroy()`][2]. This change adds a test for this race condition, and adds a fix, which just checks if the `LocalPresence` still exists on the parent before trying to destroy it. [1]: https://github.com/share/sharedb/blob/91cae28a0065faf68749243ef36aadf54bf0645d/lib/client/presence/presence.js#L56 [2]: https://github.com/share/sharedb/blob/91cae28a0065faf68749243ef36aadf54bf0645d/lib/client/presence/presence.js#L64
ericyhwang
approved these changes
Mar 27, 2024
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.
There's currently a race condition that can throw uncaught errors when destroying both a
LocalPresenceand its parentPresenceobject.If the
LocalPresencedestroys first, then - since thePresencecached its ID before thePresenceunsubscribe - by the time thePresencetries to destroy its children, theLocalPresenceis already gone, which throws when trying to calldestroy().This change adds a test for this race condition, and adds a fix, which just checks if the
LocalPresencestill exists on the parent before trying to destroy it.