fix: prevent 'afterUnloadDocument' being triggered immediately after onLoadDocument#893
Merged
janthurau merged 1 commit intoueberdosis:mainfrom Jan 29, 2025
Merged
Conversation
…DocumentHooks' promise
This file contains hidden or 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
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.
unloadDocumentmethod of theHocuspocusclass, if the document no longer has any clients, the following events are guaranteed to occur in a synchronous nature:onStoreDocumenthooks ->afterStoreDocumenthooks ->unloadDocumentunloadDocumentmethod includes an asynchronous call to trigger allafterUnloadDocumenthooks without any await, or without extending the promise chain, the completion of theafterUnloadDocumenthook is not guaranteed when thestoreDocumentHooksreturns a resolved promise.afterUnloadDocumentcallback is incomplete.A particular case can arise, prompted by an instant disconnect and reconnect of the websocket, where the
afterUnloadDocumenthook is triggered immediately after theonLoadDocumenthook for a specific document, leading to possible unexpecting behavior.In our example, we were using the 'afterUnloadDocument' to remove a document from a local cache. You can imagine the problems this has created when that document is removed from the cache despite being active.