Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

workers: fix invalid exit code in parent upon uncaught exception #21713

Closed
wants to merge 3 commits into from

Conversation

lundibundi
Copy link
Member

Now worker.on('exit') reports correct exit code (1) if worker has exited
with uncaught exception.

Fixes: #21707

Checklist
  • make -j4 test (UNIX) passes
  • tests are included
  • commit message follows commit guidelines

Also, if there is any standard shorthand for uncaughtException then please tell me. I'd like to get the message down to 50 columns =).

Now worker.on('exit') reports correct exit code (1) if worker has exited
with uncaught exception.

Fixes: nodejs#21707
@nodejs-github-bot nodejs-github-bot added the worker Issues and PRs related to Worker support. label Jul 8, 2018
@hiroppy
Copy link
Member

hiroppy commented Jul 8, 2018

@@ -445,6 +445,9 @@ function setupChild(evalScript) {

function fatalException(error) {
debug(`[${threadId}] gets fatal exception`);

process.exitCode = 1;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm afraid process.exitCode may be 1 even if the exception is caught.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree – I think you want to move this into the if (!caught) block below?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I assumed that this was unrecoverable (I thought 'uncaughtException' didn't count as recovery). Will push soon. I also added test similar to test-process-exit-code for workers.

Copy link
Member

@addaleax addaleax Jul 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think behaviour should match the main thread’s behaviour as closely as possible – in there, we have that process.exitCode is not set, as far as I can tell:

process.on("uncaughtException", () => console.log(process.exitCode));
throw new Error();

prints undefined.

@lundibundi
Copy link
Member Author

Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Labelling with the red X just to make sure this doesn’t get lost, because it already has a few approvals

If I understand correctly windows CI failure seems unrelated

Yes, I think they are nothing to worry about. :)

@@ -445,6 +445,10 @@ function setupChild(evalScript) {

function fatalException(error) {
debug(`[${threadId}] gets fatal exception`);

// set exit code for local worker's 'exit' listeners
process.exitCode = 1;
Copy link
Member

@addaleax addaleax Jul 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copying the comment because Github currently hides it:

I think behaviour should match the main thread’s behaviour as closely as possible – in there, we have that process.exitCode is not set, as far as I can tell:

process.on("uncaughtException", () => console.log(process.exitCode));
throw new Error();

prints undefined.

I really think we just need to set process.exitCode in the if (!caught) block once.

Copy link
Member Author

@lundibundi lundibundi Jul 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, but we should probably consider setting the code before calling handler (in both here and for process), to avoid current situation where it emits code 1 but process.exitCode has older value or undefined?
Edit: I mean in 'exit' event.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lundibundi I think that makes sense, yes. But since it affects all Node.js code, not just Workers, we probably should do it in a separate (and maybe even semver-major) PR.

The code you’d probably want to look at – if you want to tackle it yourself – is in process._fatalException in lib/internal/bootstrap/node.js and FatalException() in src/node.cc. We currently have hardcoded values for exiting in the latter function, so I think setting process.exitCode from exit handlers doesn’t have any effect at the moment?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax Yeah, while looking into this one I looked though those functions (I actually first thought that exit code should be set on c++ side because we are listening on an exit callback from it).
From what I've seen both workers and process use node.cc/EmitExit which actually reevaluates exitCode after the event, so I think it will change the code. But indeed for the uncaught exception this is not the case, as it will always exit with 1 from FatalException() if it wasn't handled (or other hardcoded codes).
Should I open an issue first to track it or it should be okay to just submit PR?

Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@addaleax addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 9, 2018
@addaleax
Copy link
Member

addaleax commented Jul 9, 2018

@addaleax
Copy link
Member

Landed in 1e9c3f8, thanks a lot for the PR! 🎉

@addaleax addaleax closed this Jul 10, 2018
addaleax pushed a commit that referenced this pull request Jul 10, 2018
Now worker.on('exit') reports correct exit code (1) if worker has exited
with uncaught exception.

Fixes: #21707

PR-URL: #21713
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
Reviewed-By: Weijia Wang <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
targos pushed a commit that referenced this pull request Jul 12, 2018
Now worker.on('exit') reports correct exit code (1) if worker has exited
with uncaught exception.

Fixes: #21707

PR-URL: #21713
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
Reviewed-By: Weijia Wang <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@targos targos mentioned this pull request Jul 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. worker Issues and PRs related to Worker support.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants