workers: fix invalid exit code in parent upon uncaught exception #21713
Conversation
Now worker.on('exit') reports correct exit code (1) if worker has exited
with uncaught exception.
Fixes: nodejs#21707
lib/internal/worker.js
Outdated
| @@ -445,6 +445,9 @@ function setupChild(evalScript) { | |||
|
|
|||
| function fatalException(error) { | |||
| debug(`[${threadId}] gets fatal exception`); | |||
|
|
|||
| process.exitCode = 1; | |||
There was a problem hiding this comment.
I'm afraid process.exitCode may be 1 even if the exception is caught.
There was a problem hiding this comment.
I agree – I think you want to move this into the if (!caught) block below?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
If I understand correctly windows CI failure seems unrelated: |
lib/internal/worker.js
Outdated
| @@ -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; | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
@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?
addaleax
added
the
author ready
|
CI: https://ci.nodejs.org/job/node-test-pull-request/15768/ (edit: ✔️) |
|
Landed in 1e9c3f8, thanks a lot for the PR! 🎉 |
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 <me@gus.host>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
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 <me@gus.host>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Now worker.on('exit') reports correct exit code (1) if worker has exited
with uncaught exception.
Fixes: #21707
Checklist
make -j4 test(UNIX) passesAlso, if there is any standard shorthand for uncaughtException then please tell me. I'd like to get the message down to 50 columns =).