Add graceful shutdown and error handling (#779)

* Add graceful shutdown and error handling

* Add to --help switch and turn into optional (ENV variables)'

* Add readme documentation

* Change documentation inside --help switch

* Add some tests and debugging (commented out).
Currently not functional due to switch not working

* Add documentation to http-server.1 file

* -n switch

* Fixes, commented out tests

* -

* Delte log files

* Add log files to gitignore

* Comment out all tests

* Delete tests

* Fixes (according to suggestion)

Co-authored-by: Jade Michael Thornton <[email protected]>

* Remove `-n` short argument and enhance the logfile name

* Apply suggestion from @KernelDeimos

* Apply suggestion from @KernelDeimos

---------

Co-authored-by: Octopus <[email protected]>
Co-authored-by: Jade Michael Thornton <[email protected]>
Co-authored-by: Eric Dubé <[email protected]>

Author: 3 people

.gitignore

@@ -3,4 +3,5 @@ npm-debug.log*
 .nyc_*/
 .dir-locals.el
 .DS_Store
+.httpserver*
 .tap

README.md

@@ -96,6 +96,7 @@ with the provided Dockerfile.
 |`--mimetypes` |Path to a .types file for custom mimetype definition| |
 |`-h` or `--help` |Print this list and exit. |   |
 |`-v` or `--version`|Print the version and exit. | |
+| `--no-panic` | Don't print error stack in the console, put it in a log file | `false`|
 
 ## Magic Files
 

bin/http-server

@@ -7,7 +7,6 @@ var chalk     = require('chalk'),
   httpServer = require('../lib/http-server'),
   portfinder = require('portfinder'),
   opener     = require('opener'),
-
   fs         = require('fs'),
   url        = require('url');
 var argv = require('minimist')(process.argv.slice(2), {
@@ -18,7 +17,6 @@ var argv = require('minimist')(process.argv.slice(2), {
   },
   boolean: ['proxy-all']
 });
-
 var ifaces = os.networkInterfaces();
 
 if (argv.h || argv.help) {
@@ -86,12 +84,15 @@ if (argv.h || argv.help) {
     '  --no-dotfiles      Do not show dotfiles',
     '  --mimetypes        Path to a .types file for custom mimetype definition',
     '  -h --help          Print this list and exit.',
-    '  -v --version       Print the version and exit.'
+    '  -v --version       Print the version and exit.',
+    '  --no-panic         If error occurs, gracefully shut down and create log file',
+    '                     Can also be specified with the env variable NODE_HTTP_SERVER_NO_PANIC'   
   ].join('\n'));
   process.exit();
 }
 
 var port = argv.p || argv.port || parseInt(process.env.PORT, 10),
+    nopanic = !argv['panic'] || argv.n || process.env.NODE_HTTP_SERVER_NO_PANIC,
     host = argv.a || '::',
     tls = argv.S || argv.tls,
     title = argv.T || argv.title,
@@ -106,6 +107,19 @@ var port = argv.p || argv.port || parseInt(process.env.PORT, 10),
     baseDir = argv['base-dir'],
     logger;
 
+if (nopanic){
+  process.on('error', (e)=> {
+    // Results in a string like "2021-12-27 14:56:31"
+    const etime = new Date().toISOString().replace(/T/, ' ').replace(/\..+/, '');
+    console.log(colors.green(etime));
+    console.log(`${colors.red('Fatal error: ')}${e.code}: ${e.message}`);
+    const filename = `httpserver-${etime.split(' ').join('_')}.log`;
+    console.log(colors.bold(`Check ${filename} file in this folder.`));
+    fs.writeFileSync(filename, JSON.stringify(e));
+    process.exit(1);
+  });
+}
+
 var proxyOptionsBooleanProps = [
   'ws', 'xfwd', 'secure', 'toProxy', 'prependPath', 'ignorePath', 'changeOrigin',
   'preserveHeaderKeyCase', 'followRedirects', 'selfHandleResponse'

doc/http-server.1

@@ -69,6 +69,10 @@ Default file extension is none is provided.
 .BI \-s ", " \-\-silent
 Suppress log messages from output.
 
+.TP
+.BI \-n ", " \-\-no-panic
+Gracefully shut down whenever a fatal error occurs, sending stack to log file, not console.
+
 .TP
 .BI \-\-coop " " [\fIMODE\fR]
 Enable COOP via the "Cross-Origin-Opener-Policy" header and sets