Skip to content

Commit

Permalink
src: emit 'beforeExit' event on process object
Browse files Browse the repository at this point in the history
Unlike the 'exit' event, this event allows the user to schedule more
work and thereby postpone the exit.  That also means that the
'beforeExit' event may be emitted many times, see the attached test
case for an example.

Refs nodejs#6305.
  • Loading branch information
bnoordhuis committed Oct 7, 2013
1 parent 5b23000 commit 0a0ab22
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
22 changes: 21 additions & 1 deletion src/node.cc
Original file line number Diff line number Diff line change
Expand Up @@ -3237,6 +3237,19 @@ void AtExit(void (*cb)(void* arg), void* arg) {
}


void EmitBeforeExit(Environment* env) {
Context::Scope context_scope(env->context());
HandleScope handle_scope(env->isolate());
Local<Object> process_object = env->process_object();
Local<String> exit_code = FIXED_ONE_BYTE_STRING(env->isolate(), "exitCode");
Local<Value> args[] = {
FIXED_ONE_BYTE_STRING(env->isolate(), "beforeExit"),
process_object->Get(exit_code)->ToInteger()
};
MakeCallback(env, process_object, "emit", ARRAY_SIZE(args), args);
}


void EmitExit(Environment* env) {
// process.emit('exit')
Context::Scope context_scope(env->context());
Expand Down Expand Up @@ -3330,7 +3343,14 @@ int Start(int argc, char** argv) {
CreateEnvironment(node_isolate, argc, argv, exec_argc, exec_argv);
Context::Scope context_scope(env->context());
HandleScope handle_scope(env->isolate());
uv_run(env->event_loop(), UV_RUN_DEFAULT);
bool more;
do {
more = uv_run(env->event_loop(), UV_RUN_ONCE);
if (more == false) {
EmitBeforeExit(env);
more = uv_run(env->event_loop(), UV_RUN_NOWAIT);
}
} while (more == true);
EmitExit(env);

This comment has been minimized.

Copy link
@sam-github

sam-github Oct 16, 2013

I considered doing it the way you had, and then didn't because it looked to me that it doesn't work in this situation:

  1. EmitBeforeExit() causes ONE request to become active
  2. uv_run(NOWAIT)
    1. runs that ONE request
    2. assigns r = uv__loop_alive(), so r = 0, it is not alive, the one request has been run
    3. returns 0, so more is now false
  3. loop exits, wrongly

I think the behaviour in the abstract should be "if beforeExit event handler causes uv__loop_alive() to become true, run until its false. BUT if uv_loop_alive() did not become true, continue to exit."

When you call RUN_NOWAIT, you only know after its return that epoll never blocked (because timeout was zero), and that after zero or or more cycles, the loop is no longer alive. Its not clear to me whether you know the loop is no longer alive because work was done, or it is no longer alive because the beforeExit handler didn't actually make the event loop "alive".

Perhaps this situation is impossible, because its not possible to do something in the beforeExit event that will make the loop alive, but then all the work gets done before epoll-with-timeout-zero occurs.

This comment has been minimized.

Copy link
@bnoordhuis

bnoordhuis Oct 16, 2013

Author Owner

Not sure I follow. When you schedule some new work in your beforeExit callback and it completes on the next call to uv_run(), it's going to make a call into JS land and you can schedule more work from that callback.

This comment has been minimized.

Copy link
@sam-github

sam-github Oct 25, 2013

Code is clearer. I PRed tests to #3

RunAtExit(env);
env->Dispose();
Expand Down
34 changes: 34 additions & 0 deletions test/simple/test-process-before-exit.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

var assert = require('assert');
var common = require('../common');

var N = 5;
var n = 0;

function f() {
if (++n < N) setTimeout(f, 5);
}
process.on('beforeExit', f);
process.on('exit', function() {
assert.equal(n, N + 1); // The sixth time we let it through.
});

0 comments on commit 0a0ab22

Please sign in to comment.