feat: Make redraws when Promises returned by event handlers are completed#3020
Merged
Conversation
dead-claudia
requested changes
May 2, 2025
| if (eventRedraw && ev.redraw !== false) { | ||
| eventRedraw() | ||
| if (result != null && typeof result.then === "function") { | ||
| Promise.resolve(result).finally(function () { |
Member
There was a problem hiding this comment.
Suggested change
| Promise.resolve(result).finally(function () { | |
| Promise.resolve(result).then(function () { |
I'd rather rejections and thrown errors have the same behavior. It's less surprising to users.
Obviously, this will also require changes to the tests.
Contributor
Author
There was a problem hiding this comment.
OK, I changed finally to then and fixed the test.
dead-claudia
approved these changes
May 6, 2025
Collaborator
|
Note: @dead-claudia @kfule I don't think this should be a semver major change. I've started a thread on zulip here for us to discuss. |
Member
|
@JAForbes And responded. We can continue the discussion there. |
8 tasks
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
3 participants
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.
This PR allows redraw on completion of the async event handler.
Description
This PR makes redraws when Promises returned by event handlers are completed. This allows for async event handlers to be redrawn on completion of the function as well as synchronous event handlers.
Motivation and Context
This is like re-opening the #2862 that was accidentally closed.
Unlike #2862 , this PR
usesadds the conditionPromise.finallyto handle the return value and alsoevent.redraw === false. Therefore, I did not cherry-pick #2862 .How Has This Been Tested?
I added the tests and confirmed that
npm run testpasses.I also added eslintrc because the new test code includes the async functions.
Types of changes
Checklist