Reproduce race condition error with LoroWebsocketClient when mounting in effect in react strict mode via unit test
Fix the race condition
Explanation
In development, react has a thing called "strict mode" which mounts, then unmounts, then re-mounts all components.
sendJoinPayload calls void this.connect() as a fallback retry. connect() unconditionally sets shouldReconnect = true, which resurrects a client that was intentionally closed via close(). This manifests in React strict mode where useEffect creates a client + joins a room, and the cleanup function calls close() but a deferred microtask from resolveAuth().then(sendJoinPayload) fires after close(), calling connect() and creating a zombie WebSocket connection.
A piece of sample code that would cause this fire is:
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
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.
Explanation
In development, react has a thing called "strict mode" which mounts, then unmounts, then re-mounts all components.
sendJoinPayload calls void this.connect() as a fallback retry. connect() unconditionally sets shouldReconnect = true, which resurrects a client that was intentionally closed via close(). This manifests in React strict mode where useEffect creates a client + joins a room, and the cleanup function calls close() but a deferred microtask from resolveAuth().then(sendJoinPayload) fires after close(), calling connect() and creating a zombie WebSocket connection.
A piece of sample code that would cause this fire is: