Ignore doc does not exist on presence destroy #381
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 we destroy local presence, we attempt to update the presence to `null` for remote clients as part of the cleanup. However, if we delete a doc, and then destroy the associated presence, the presence attempts to send a message on a deleted doc, which returns an error. Let's just ignore this error. There's no need to reset presence on a deleted doc, because remote clients will [already assume it's `null`][1]. [1]: https://github.com/share/sharedb/blob/a81e2c99af77da12885f0fa860e87cc2602a6cc1/lib/client/presence/local-doc-presence.js#L90-L96
ericyhwang
reviewed
Jul 22, 2020
| LocalPresence.prototype.destroy.call(this, function(error) { | ||
| // If the doc does not exist, let's just ignore the error. There's no need to | ||
| // tidy up presence on a deleted doc. | ||
| if (error && error.code === ERROR_CODE.ERR_DOC_DOES_NOT_EXIST) error = null; |
There was a problem hiding this comment.
As discussed, doing the skip here means that if !this._doc.type (the check in LocalDocPresence.prototype.submit), the LocalPresence.prototype.destroy.call could have been replaced with a short-circuit.
But you said that you wanted the cleanup here to still run:
So the update to instead not emit an error in LocalDocPresence.prototype.submit if the value is null seems good. Or short circuit.
This change amends the `destroy` logic for `LocalDocPresence`, which handled the error in the wrong place, and meant that the `LocalPresence` would not correctly tidy up the reference to the destroyed local doc presence. This change adds a check to `LocalDocPresence.submit`. If we're submitting `null` on a deleted doc, we just immediately return, since the remote client will already assume a `null` presence in this case.
ericyhwang
approved these changes
Jul 22, 2020
alecgibson
force-pushed
the
presence-destroy
branch
from
e002dab
to
37d35f0
Compare
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 we destroy local presence, we attempt to update the presence to
nullfor remote clients as part of the cleanup.However, if we delete a doc, and then destroy the associated presence,
the presence attempts to send a message on a deleted doc, which returns
an error.
Let's just ignore this error. There's no need to reset presence on a
deleted doc, because remote clients will already assume it's
null.