⚡️ Fix Presence Stream leak
#629
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
alecgibson
force-pushed
the
presence-subscribe-once
branch
from
97793c2 to
99315b8
Compare
alecgibson
force-pushed
the
subscription-stream-leak
branch
from
cc9c9e9 to
dadf3fa
Compare
alecgibson
force-pushed
the
subscription-stream-leak
branch
from
dadf3fa to
0270d21
Compare
At the moment, when subscribing a `Presence` multiple times, multiple PubSub `Stream`s are created per-subscription. However, unsubscribing will only destroy the [last created][1], resulting in streams that are never destroyed. This change updates our subscription logic to check if we already have an existing stream. If we already have a stream, then we just re-request presence from other clients (which is needed by our [`DocPresence` logic][2]), and return. Note that we also tweak our unsubscribe logic to eagerly remove the stream after calling destroy (so that subsequent subscribes don't try to reuse a stream that is currently being destroyed). We also remove a check against `seq`, which is currently not covered by tests (and actually never calls the `callback`), so is clearly broken and unneeded anyway. [1]: https://github.com/share/sharedb/blob/62e4ec5d46c0dcb097931e9dae60240aaba6b2b3/lib/agent.js#L829-L830 [2]: https://github.com/share/sharedb/blob/62e4ec5d46c0dcb097931e9dae60240aaba6b2b3/lib/client/presence/remote-doc-presence.js#L108-L110
alecgibson
force-pushed
the
subscription-stream-leak
branch
from
0270d21 to
e73b26f
Compare
ericyhwang
approved these changes
Oct 10, 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.
At the moment, when subscribing a
Presencemultiple times, multiple PubSubStreams are created per-subscription.However, unsubscribing will only destroy the last created, resulting in streams that are never destroyed.
This change updates our subscription logic to check if we already have an existing stream. If we already have a stream, then we just re-request presence from other clients (which is needed by our
DocPresencelogic), and return.Note that we also tweak our unsubscribe logic to eagerly remove the stream after calling destroy (so that subsequent subscribes don't try to reuse a stream that is currently being destroyed).
We also remove a check against
seq, which is currently not covered by tests (and actually never calls thecallback), so is clearly broken and unneeded anyway.Depends on