Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[lexical-react] Refactor: Ensure disconnect is called after connection is established in useYjsCollaboration #6619

Merged
merged 4 commits into from
Sep 11, 2024

Conversation

smworld01
Copy link
Contributor

connect can be an asynchronous function, and we don't take this into account when disconnecting, meaning that it is possible to disconnect without completing the connect.
I think this can lead to various side effects, such as being disconnected but still in the connect state.

In my case, this happened in React.StrictMode, which is a bit unusual.

It's a simple code change, so I don't think test code is necessary.

Copy link

vercel bot commented Sep 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 11, 2024 6:06pm
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 11, 2024 6:06pm

@facebook-github-bot
Copy link
Contributor

Hi @smworld01!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

Copy link

github-actions bot commented Sep 11, 2024

size-limit report 📦

Path Size
lexical - cjs 29.77 KB (0%)
lexical - esm 29.6 KB (0%)
@lexical/rich-text - cjs 38.24 KB (0%)
@lexical/rich-text - esm 31.46 KB (0%)
@lexical/plain-text - cjs 36.82 KB (0%)
@lexical/plain-text - esm 28.86 KB (0%)
@lexical/react - cjs 40.01 KB (0%)
@lexical/react - esm 32.93 KB (0%)

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 11, 2024
@potatowagon potatowagon added the extended-tests Run extended e2e tests on a PR label Sep 11, 2024
Comment on lines +158 to +160
Promise.resolve(connectionPromise).then(() => {
disconnect();
});
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a timing difference between Promise.resolve(undefined).then(f) and f() because the former executes during the next microtask, but I think generally speaking that should be fine unless someone has some overly sensitive unit tests.

I guess if someone really did need the existing timing behavior they could use something like:

// undefined when connected
let connectingPromise: Promise<undefined> | undefined = connect()?.then(() => {
  connectingPromise = undefined;
});
connectingPromise?.then(() => disconnect()) ?? disconnect();

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. extended-tests Run extended e2e tests on a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants