Docs: Cleanup with Promise instead of setTimeout #21476
Merged
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.
What I did
This PR changes the cleanup of stories in docs mode to be executed with a
Promise
, instead ofsetTimeout
as introduced in #21214When navigating between two docs entries, the
setTimeout
would causeteardown
of the first set of stories to be called afterrenderToCanvas
of the second set of stories. This results in the primary story from the second set of stories getting teared down and you end up with a blank canvas.Using
Promise.resolve
instead makes sure thatteardown
happen beforerenderToCanvas
, while still eliminating the React warning.How to test
Navigate between two docs entries and see that there is no blank canvas anymore.
Checklist
MIGRATION.MD
Maintainers
make sure to add the
ci:merged
orci:daily
GH label to it.["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]