fix: Showing the about panel is async on all platforms #37440
Conversation
There was a problem hiding this comment.
Seems fine. Teeeeechnically I guess this could be considered a breaking change, but it seems far fetched to me that an app would be relying on this behavior, so I don't mind skipping a note in breaking-changes.md for this one.
Perhaps expand the release notes somewhat, to something like:
showAboutPanelno longer blocks the main thread on Windows or Linux, thus matching macOS.
There was a problem hiding this comment.
I agree with @nornagon that this is arguably semver-major but given usage and context i'm also fine slapping a semver-patch label on it and calling it a day
|
Release Notes Persisted
|
* fix: about panel is a base::Value::Dict * nix this test for a diff PR * what if the about dialog was not blocking * add this test back in * document synchronicity * github editor is a fan of spaces Co-authored-by: Calvin <clavin@users.noreply.github.com>
|
I have automatically backported this PR to "24-x-y", please check out #37508 |
trop
bot
added
in-flight/24-x-y
merged/24-x-y
fix: Showing the about panel is async on all platforms (#37440) * fix: about panel is a base::Value::Dict * nix this test for a diff PR * what if the about dialog was not blocking * add this test back in * document synchronicity * github editor is a fan of spaces Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Calvin <clavin@users.noreply.github.com>
Description of Change
Currently,
app.showAboutPanel()is inconsistent in its synchronicity across platforms:This PR aligns the behavior of this function across platforms to run asynchronously.
I believe asynchronous is the "expected" behavior for this API. The documentation doesn't specify, so there was no confirmed behavior before. It is unlikely that code usually wants to wait for the auxiliary about dialog to close before continuing execution. If we decide that functionality is desirable in the future, we still have room to add it in, either with a
Syncvariant of this function or by accepting a completion callback.(Note: this PR is based on top of #37373 and thus that PR's changes also show here. I will rebase this branch once the other PR is merged.)
Checklist
npm testpassesRelease Notes
Notes:
app.showAboutPanel()no longer blocks the main thread on Windows or Linux, thus matching macOS.