feat: add query-session-end and improve session-end events on Windows #44598

savely-krasovsky · 2024-11-08T15:10:54Z

Description of Change

Current Electron version allows to handle only WM_ENDSESSION, but not WM_QUERYENDSESSION. This cause a lot of problems while Electron app is packaged into own MSI and is a menubar/tray app. For example currently we cannot close app using Restart Manager which is used by default since Windows Installer 4.0. We have to use util:CloseApplication or call taskkil.

Quote from Restart Manager guidelines for Applications:

Applications running on Windows Vista and Windows Server 2008 should adhere to these guidelines to ensure that the Restart Manager can shut down and restart applications if necessary to install updates.

GUI applications should listen for the WM_QUERYENDSESSION message and return a value of TRUE if the application is prepared to shut down and restart. If no application returns a value of FALSE, the Restart Manager sends a WM_ENDSESSION message with the lParam parameter set to ENDSESSION_CLOSEAPP (0x1) and the wparam parameter set to TRUE. [...] If any GUI application responds to a WM_QUERYENDSESSION message by returning a value of FALSE, the shutdown is canceled.

So to properly close GUI app we need to handle WM_QUERYENDSESSION properly and return TRUE. But for now for any unknown WM message it will cause us to return FALSE (see calling code: https://github.com/chromium/chromium/blob/134896c2d6148c6bd2f7b096b0664b1e4013cb5c/ui/views/win/hwnd_message_handler.cc#L1069).

My implementation will return TRUE by default (in case of WM_QUERYSESSION), so it could probably fix longstanding issues like this: #15880. ev.preventDefault() can still return old behaviour.

Also both query-session-end and session-end now return a reasons why they receiving this event, it could be shutdown, close-app, critical and logoff.

Checklist

PR description included and stakeholders cc'd
npm test passes
tests are changed or added
relevant documentation, tutorials, templates and examples are changed or added
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Added query-session-end event and improved session-end events on Windows

welcome · 2024-11-08T15:10:58Z

💖 Thanks for opening this pull request! 💖

Semantic PR titles

We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix.

Examples of commit messages with semantic prefixes:

fix: don't overwrite prevent_default if default wasn't prevented
feat: add app.isPackaged() method
docs: app.isDefaultProtocolClient is now available on Linux

Commit signing

This repo enforces commit signatures for all incoming PRs.
To sign your commits, see GitHub's documentation on Telling Git about your signing key.

PR tips

Things that will help get your PR across the finish line:

Follow the JavaScript, C++, and Python coding style.
Run npm run lint locally to catch formatting errors earlier.
Document any user-facing changes you've made following the documentation styleguide.
Include tests when adding/changing behavior.
Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

docs/tutorial/multithreading.md

docs/api/base-window.md

codebytere

Thanks for working on this!

shell/browser/native_window_views_win.cc

docs/api/base-window.md

docs/api/browser-window.md

shell/browser/api/electron_api_base_window.cc

shell/browser/api/electron_api_base_window.h

savely-krasovsky · 2024-11-13T11:36:10Z

@codebytere thanks for the review! Everything sounds reasonable. I would commit fixes soon.

docs/api/base-window.md

docs/api/browser-window.md

shell/browser/api/electron_api_base_window.cc

…object

shell/browser/api/electron_api_base_window.cc

shell/common/gin_helper/event_emitter.h

samuelmaddock

API LGTM

docs/api/browser-window.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

docs/api/base-window.md

savely-krasovsky · 2024-11-18T20:31:00Z

~~Any ideas what went wrong with Linux tests? I didn't change anything related. Could it just a flaky test?~~

Nevermind, it was a flaky test.

itsananderson

Left a small suggestion for the session-end event, but overall API LGTM

docs/api/base-window.md

docs/api/browser-window.md

Co-authored-by: Will Anderson <will@itsananderson.com>

savely-krasovsky · 2024-11-21T12:49:49Z

@itsananderson @samuelmaddock @codebytere requesting a last review I hope! Fixed everything you highlighted.

itsananderson

Thanks for submitting this!

welcome · 2024-11-22T19:47:39Z

Congrats on merging your first pull request! 🎉🎉🎉

release-clerk · 2024-11-22T19:47:40Z

Release Notes Persisted

Added query-session-end event and improved session-end events on Windows

electron-cation bot added the new-pr 🌱 PR opened recently label Nov 8, 2024

feat: add query-session-end event for Windows

6211b11

savely-krasovsky force-pushed the main branch from 56e93f4 to 6211b11 Compare November 8, 2024 15:18

savely-krasovsky added 3 commits November 8, 2024 16:30

fix: remove debug line

e4af304

feat: notify with reason on session-end

1ab9b05

docs: add comments and return params

9b7384c

ckerr added the api-review/requested 🗳 label Nov 8, 2024

savely-krasovsky changed the title ~~feat: add query-session-end event for Windows~~ feat: add query-session-end and improve session-end events on Windows Nov 8, 2024

savely-krasovsky added 2 commits November 8, 2024 22:39

docs: add same docs to the BrowserWindow

c011a85

fix: add shutdown reason if lParam == 0

7917b6f

savely-krasovsky mentioned this pull request Nov 8, 2024

feat: add win.preventShutdown method on Windows #44601

Open

5 tasks

itsananderson reviewed Nov 8, 2024

View reviewed changes

docs/tutorial/multithreading.md Show resolved Hide resolved

docs/api/base-window.md Outdated Show resolved Hide resolved

savely-krasovsky added 2 commits November 8, 2024 23:39

docs: remove 'force' word

cef395b

docs: revert multithreading.md change

0ed2322

savely-krasovsky requested review from a team as code owners November 9, 2024 00:44

savely-krasovsky force-pushed the main branch from 99bba84 to 0ed2322 Compare November 9, 2024 00:46

savely-krasovsky requested a review from itsananderson November 9, 2024 00:47

codebytere requested changes Nov 13, 2024

View reviewed changes

savely-krasovsky added 2 commits November 13, 2024 12:53

docs: add reasons documentation, reason variable renamed to reasons

fa5aa97

docs: improve 'shutdown' reason wording

156806b

savely-krasovsky requested a review from codebytere November 13, 2024 12:02

samuelmaddock requested changes Nov 13, 2024

View reviewed changes

shell/browser/api/electron_api_base_window.cc Outdated Show resolved Hide resolved

savely-krasovsky added 4 commits November 13, 2024 21:33

docs: reword with 'can be'

75bed7c

fix: pass reasons by reference

3756390

fix: use newer approach which expose reasons value directly on Event …

3191e1f

…object

docs: add escaping

d8ad4eb

style: linter fixes

17c84ec

savely-krasovsky requested a review from samuelmaddock November 13, 2024 22:45

fix: project now should compile

289b476

samuelmaddock added semver/minor backwards-compatible functionality no-backport labels Nov 15, 2024

electron-cation bot removed the new-pr 🌱 PR opened recently label Nov 15, 2024

samuelmaddock reviewed Nov 15, 2024

View reviewed changes

shell/browser/api/electron_api_base_window.cc Outdated Show resolved Hide resolved

shell/common/gin_helper/event_emitter.h Outdated Show resolved Hide resolved

fix: EmitWithoutEvent method added, EmitWithEvent moved to private again

f96c2df

savely-krasovsky requested a review from samuelmaddock November 15, 2024 18:41

samuelmaddock approved these changes Nov 18, 2024

View reviewed changes

docs/api/browser-window.md Outdated Show resolved Hide resolved

docs: typo fix

f7101c8

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

samuelmaddock reviewed Nov 18, 2024

View reviewed changes

docs/api/base-window.md Show resolved Hide resolved

docs: dedicated WindowSessionEndEvent type created

54f2229

savely-krasovsky requested a review from samuelmaddock November 18, 2024 17:35

itsananderson reviewed Nov 19, 2024

View reviewed changes

docs/api/base-window.md Outdated Show resolved Hide resolved

docs/api/browser-window.md Outdated Show resolved Hide resolved

electron-cation bot added api-review/approved ✅ and removed api-review/requested 🗳 labels Nov 19, 2024

docs: better wording for session-end event description

ee73fcf

Co-authored-by: Will Anderson <will@itsananderson.com>

savely-krasovsky requested a review from itsananderson November 21, 2024 12:48

itsananderson approved these changes Nov 21, 2024

View reviewed changes

VerteDinde approved these changes Nov 21, 2024

View reviewed changes

codebytere approved these changes Nov 22, 2024

View reviewed changes

VerteDinde merged commit c5ea177 into electron:main Nov 22, 2024
51 checks passed

This was referenced Jan 18, 2025

callbacks for hookWindowMessage should have their return value sent to OS #8762

Closed

session-end doesn't fire at all #15880

Closed

mlaurencin mentioned this pull request Mar 4, 2025

chore: add Electron 35 blog post electron/website#761

Merged

5 tasks

feat: add query-session-end and improve session-end events on Windows #44598

feat: add query-session-end and improve session-end events on Windows #44598

Uh oh!

Conversation

savely-krasovsky commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Checklist

Release Notes

Uh oh!

welcome bot commented Nov 8, 2024

Semantic PR titles

Commit signing

PR tips

Uh oh!

Uh oh!

Uh oh!

codebytere left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

savely-krasovsky commented Nov 13, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samuelmaddock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

savely-krasovsky commented Nov 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

itsananderson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

savely-krasovsky commented Nov 21, 2024

Uh oh!

itsananderson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

welcome bot commented Nov 22, 2024

Uh oh!

release-clerk bot commented Nov 22, 2024

Uh oh!

Uh oh!

savely-krasovsky commented Nov 8, 2024 •

edited

Loading

savely-krasovsky commented Nov 18, 2024 •

edited

Loading