Lock on the cleanNode function

[arvid220u]

Summary

It is possible for cleanNode to be called recursively. This PR adds a simple isCleaning lock to ensure that cleanNode isn't called on the same node twice.

Minimal example: https://playground.solidjs.com/anonymous/9f860e26-d0a3-476d-8b20-82ebff4763d7 (when you click "hide", you get a Cannot read properties of null error which comes from cleanNode being called twice on the same node).

I believe this error is most likely to happen when your entire app isn't in Solid, but you're instead mounting several Solid roots inside an existing application. We have global state controlling which Solid roots and components to show, and a syncState function that reads from the global state and disposes/creates Solid roots based on that. If component A has a Show that causes component B to be disposed, and component B has an onCleanup that calls the global syncState which disposes the entire Solid root that A is rendered in, then A will error in the cleanNode function.

I believe that this change should solve this problem, but I would love input on whether this change is reasonable at all, or whether it may have side effects that I haven't considered.

Thank you!

How did you test this change?

Would love advice on where you think it'd be best to add a test for this — didn't do it yet, because would first love input on whether this change makes sense.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4cff3e4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[ryansolid]

I think it does. The only challenge is concurrency. That being said I don't think it changes the desire for this. Just it complicates things a bit.

[tmm1]

Was this resolved in a different way? The linked playground no longer throws an error.