doc: document `beforeExit` and add more tests

diff --git a/doc/api/process.markdown b/doc/api/process.markdown
index 3cbbf24..e59baa8 100644 (file)
--- a/doc/api/process.markdown
+++ b/doc/api/process.markdown
@@ -69,6 +69,18 @@ Example of listening for `exit`:
       console.log('About to exit with code:', code);
     });
 
+
+## Event: 'beforeExit'
+
+This event is emitted when node empties it's event loop and has nothing else to
+schedule. Normally, node exits when there is no work scheduled, but a listener
+for 'beforeExit' can make asynchronous calls, and cause node to continue.
+
+'beforeExit' is not emitted for conditions causing explicit termination, such as
+`process.exit()` or uncaught exceptions, and should not be used as an
+alternative to the 'exit' event unless the intention is to schedule more work.
+
+
 ## Event: 'uncaughtException'
 
 Emitted when an exception bubbles all the way back to the event loop. If a

diff --git a/test/simple/test-beforeexit-event-exit.js b/test/simple/test-beforeexit-event-exit.js
new file mode 100644 (file)
index 0000000..be6f2c6
--- /dev/null
+++ b/test/simple/test-beforeexit-event-exit.js
@@ -0,0 +1,28 @@
+// 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');
+
+process.on('beforeExit', function() {
+  assert(false, 'exit should not allow this to occur');
+});
+
+process.exit();

diff --git a/test/simple/test-beforeexit-event.js b/test/simple/test-beforeexit-event.js
new file mode 100644 (file)
index 0000000..41cc1d3
--- /dev/null
+++ b/test/simple/test-beforeexit-event.js
@@ -0,0 +1,62 @@
+// 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 net = require('net');
+var util = require('util');
+var revivals = 0;
+var deaths = 0;
+
+process.on('beforeExit', function() { deaths++; } );
+
+process.once('beforeExit', tryImmediate);
+
+function tryImmediate() {
+  console.log('set immediate');
+  setImmediate(function() {
+    revivals++;
+    process.once('beforeExit', tryTimer);
+  });
+}
+
+function tryTimer() {
+  console.log('set a timeout');
+  setTimeout(function () {
+    console.log('timeout cb, do another once beforeExit');
+    revivals++;
+    process.once('beforeExit', tryListen);
+  }, 1);
+}
+
+function tryListen() {
+  console.log('create a server');
+  net.createServer()
+    .listen(0)
+    .on('listening', function() {
+      revivals++;
+      this.close();
+    });
+}
+
+process.on('exit', function() {
+  assert.equal(4, deaths);
+  assert.equal(3, revivals);
+});