mirror of
https://github.com/electron/electron.git
synced 2026-10-28 11:44:46 +08:00
Samuel Attard
1cf98129e4
* feat: capture __fastfail crashes on Windows via a WER helper module Crashes raised through __fastfail (STATUS_STACK_BUFFER_OVERRUN: /GS failures, CFG violations, UCRT abort()) never reach crashpad's in-process exception filter, so they produced no minidump. Build electron_wer.dll, a Windows Error Reporting runtime exception helper wrapping crashpad's crashpad_wer_handler, ship it next to the executable, return its path from ElectronCrashReporterClient::GetWerRuntimeExceptionModule() so crashpad registers it in every process, and list it under the current user's RuntimeExceptionHelperModules key from crashReporter.start() so Windows will load it without installer changes. Closes #40363. * fix: keep WER active in libuv processes and scope helper pruning libuv's uv_init sets SEM_NOGPFAULTERRORBOX, which stops Windows Error Reporting from invoking runtime exception helpers, and Electron only cleared it in the browser process. Clear it in every process type (as Chromium does) and in ELECTRON_RUN_AS_NODE children after crashpad init, so __fastfail in Node-integrated renderers, utility processes and workers reaches electron_wer.dll; add a node-integrated renderer variant of the spec. Only prune stale RuntimeExceptionHelperModules entries that are siblings under this app's install root, so crashReporter.start() never probes other apps' (possibly remote) paths. * feat: look up the WER helper as <exe name>_wer.dll Name the helper after the executable so packagers that rename electron.exe rename the DLL alongside it (myapp.exe -> myapp_wer.dll); the GN output name is derived from electron_project_name and the docs say so. * fix: register the WER helper without probing the disk GetWerRuntimeExceptionModule() runs in sandboxed child processes too, where the PathExists() check fails and skipped registration (CI: the sandboxed renderer __fastfail spec got no dump while the unsandboxed one did). Match Chrome and return the path unconditionally; the browser still checks the file exists before listing it in the registry. * fix: let WER run for sandboxed child processes once crashpad is installed The sandbox job starts children with SEM_NOGPFAULTERRORBOX (JOB_OBJECT_LIMIT_DIE_ON_UNHANDLED_EXCEPTION), so the WER helper was never invoked for a sandboxed renderer's __fastfail. Clear the flag in child processes right after crashpad initialization. * refactor: ship crashpad's crashpad_wer.dll as the WER helper Copy the upstream crashpad_wer loadable module to <exe name>_wer.dll instead of building a duplicate, keep crashpad_wer.dll itself out of dist.zip, and resolve the helper's directory from base::DIR_ASSETS (the executable's directory by default) so apps that version their resources can relocate it.
Official Guides
Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.
FAQ
There are questions that are asked quite often. Check this out before creating an issue:
Guides and Tutorials
Getting started
Learning the basics
- Adding Features to Your App
- Notifications
- Recent Documents
- Application Progress
- Custom Dock Menu
- Custom Windows Taskbar
- Custom Linux Desktop Actions
- Keyboard Shortcuts
- Offline/Online Detection
- Represented File for macOS BrowserWindows
- Native File Drag & Drop
- Navigation History
- Window State Persistence
- Offscreen Rendering
- Dark Mode
- Web embeds in Electron
- Boilerplates and CLIs
- Boilerplate vs CLI
- Electron Forge
- electron-builder
- electron-react-boilerplate
- Other Tools and Boilerplates
Advanced steps
- Application Architecture
- Accessibility
- Testing and Debugging
- Distribution
- Updates
- Getting Support
Detailed Tutorials
These individual tutorials expand on topics discussed in the guide above.
- Installing Electron
- Electron Releases & Developer Feedback
API References
- Process Object
- Supported Command Line Switches
- Environment Variables
- Chrome Extensions Support
- Breaking API Changes
Custom Web Features:
Modules for the Main Process:
- app
- autoUpdater
- BaseWindow
- BrowserWindow
- contentTracing
- desktopCapturer
- dialog
- globalShortcut
- inAppPurchase
- ImageView
- ipcMain
- Menu
- MenuItem
- MessageChannelMain
- MessagePortMain
- nativeTheme
- net
- netLog
- Notification
- powerMonitor
- powerSaveBlocker
- protocol
- pushNotifications
- safeStorage
- screen
- ServiceWorkerMain
- session
- ShareMenu
- systemPreferences
- TouchBar
- Tray
- utilityProcess
- View
- webContents
- webFrameMain
- WebContentsView
Modules for the Renderer Process (Web Page):
Modules for Both Processes:
- clipboard (non-sandboxed renderers only)
- crashReporter
- nativeImage
- shell (non-sandboxed renderers only)