chore: log hint on renderer crash #25317
Merged
Conversation
This file contains 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
ckerr
reviewed
Sep 4, 2020
codebytere
force-pushed
the
log-on-renderer-crash
branch
from
1fae775
to
87b2259
Compare
zcbenz
approved these changes
Sep 15, 2020
|
Release Notes Persisted
|
|
I have automatically backported this PR to "10-x-y", please check out #25472 |
This was referenced Sep 15, 2020
|
I have automatically backported this PR to "9-x-y", please check out #25473 |
|
I have automatically backported this PR to "11-x-y", please check out #25474 |
nornagon
reviewed
Sep 15, 2020
| @@ -461,6 +461,11 @@ const addReturnValueToEvent = (event: any) => { | |||
| }); | |||
| }; | |||
|
|
|||
| const loggingEnabled = () => { | |||
| return Object.prototype.hasOwnProperty.call(process.env, 'ELECTRON_ENABLE_LOGGING') || | |||
| process.argv.some(arg => arg.toLowerCase().startsWith('--enable-logging')); | |||
There was a problem hiding this comment.
better to use app.commandLine to check this sort of thing.
Suggested change
| process.argv.some(arg => arg.toLowerCase().startsWith('--enable-logging')); | |
| app.commandLine.hasSwitch('enable-logging') |
nornagon
reviewed
Sep 15, 2020
|
|
||
| // Log out a hint to help users better debug renderer crashes. | ||
| if (loggingEnabled()) { | ||
| console.info('Renderer process crashed - see https://www.electronjs.org/docs/tutorial/application-debugging for potential debugging information.'); |
There was a problem hiding this comment.
Can we give some more info about the crash here?
mlaurencin
pushed a commit
to mlaurencin/electron
that referenced
this pull request
Sep 16, 2020
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of Change
Refs #25141 (comment).
It's clear that we can and should provide more helpful tips when debugging certain types of crashes in Electron, but this seems like a small and helpful step we can take towards helping users debug renderer crashes. This will now log a small hint to console when the renderer crashes, telling them that they can set the logging env var to potentially see more information.
cc @ckerr @jkleinsc @zcbenz
Checklist
npm testpassesRelease Notes
Notes: Added a small console hint to console to help debug renderer crashes.