Debugging configuration, update readme, add sample debugging configurations. #505
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
Signed-off-by: Paul Mourer <paul.mourer@gmail.com>
Signed-off-by: Paul Mourer <paul.mourer@gmail.com>
Signed-off-by: Paul Mourer <paul.mourer@gmail.com>
Signed-off-by: Paul Mourer <paul.mourer@gmail.com>
Signed-off-by: Paul Mourer <paul.mourer@gmail.com>
pm0u
commented
Apr 26, 2020
| "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron-webpack", | ||
| "args": ["dev"], | ||
| "env": { | ||
| //"DEBUG":"*", |
There was a problem hiding this comment.
I left this line commented as it may be useful. This outputs extremely verbose output from electron/electron-webpack.
pm0u
commented
Apr 26, 2020
| "sourceMaps": true, | ||
| "smartStep": true, | ||
| "showAsyncStacks": true, | ||
| "timeout": 30000 |
There was a problem hiding this comment.
This timeout will vary, but it needs to be longer than the amount of time it takes for the electron app to launch so that VSCode does not give up. Perhaps i will note this..
Signed-off-by: Paul Mourer <paul.mourer@gmail.com>
pm0u
changed the title
algernon
approved these changes
Apr 28, 2020
|
@algernon - go ahead and merge at your leisure, then :) |
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.
This PR adds sample debugging configurations under a
dev/samplefolder (would this be the proper/desired location?) and and ENV file that sets proper environment variables for the main process, and allows a remote debugging port to be passed to the renderer process.Few gotchas:
src/main/index.js. Sometimes it will, other times it seems to attach after this code has been executed.--inspect-brk=$PORTunder ELECTRON_ARGS to break on the first line (and then ideally you could connect debugger before any code insrc/main/index.jsis executed)... but this seems to break on the first line of some internal electron process, rather than the app.A workaround for these could be to throw a
debugger;line insrc/main/index.jsif you need to debug that file, and then hopefully execution would sit until the debugger connects, unsure on that one.3. The renderer process doesn't seem to map breakpoints within class components properly. (more reason to use functional components? 😄 ) Any breakpoint set within the component is mapped to the class declaration line, and then following execution leads to a rabbit hole of inner React modules. I am not sure how to get past this, and I couldn't find anything about this in searching.Re: # 3 -- This seems to be related to HMR, if a refresh is forced once the app has opened (Ctrl + r), then breakpoints are mapped properly. Unsure why.
In VSCode it is also possible to launch with debug params in an external console (supposedly) but when i tried this, it just launched my terminal and never acutally launched the app within that terminal window. I think this would be ideal for the main process, rather than launching within VSCode's internal terminal (which can be hard to use).
Reference
electron-webpack env vars
debugging issue 1
debugging issue 2