Fix timeout flag behavior (#826)

* Fix timeout flag behavior for 0 value, negative value, and empty value. Add timeout flag to README.

* add docs

---------

Co-authored-by: Eric Dubé <[email protected]>

Author: elliotwutingfeng

README.md

@@ -76,6 +76,7 @@ with the provided Dockerfile.
 |`-H` or `--header` |Add an extra response header (can be used several times)  | |
 |`-o [path]` |Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ | |
 |`-c` |Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds. To disable caching, use `-c-1`.|`3600` |
+|`-t` |Connection timeout in seconds, e.g. `-t60` for 1 minute. To disable timeout, use `-t0`.|`120` |
 |`-U` or `--utc` |Use UTC time format in log messages.| |
 |`--log-ip` |Enable logging of the client's IP address |`false` |
 |`-P` or `--proxy` |Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | |

bin/http-server

@@ -3,13 +3,13 @@
 'use strict';
 
 var chalk     = require('chalk'),
-    os         = require('os'),
-    httpServer = require('../lib/http-server'),
-    portfinder = require('portfinder'),
-    opener     = require('opener'),
+  os         = require('os'),
+  httpServer = require('../lib/http-server'),
+  portfinder = require('portfinder'),
+  opener     = require('opener'),
 
-    fs         = require('fs'),
-    url        = require('url');
+  fs         = require('fs'),
+  url        = require('url');
 var argv = require('minimist')(process.argv.slice(2), {
   alias: {
     tls: 'ssl',
@@ -59,8 +59,8 @@ if (argv.h || argv.help) {
     '               Optionally provide a URL path to open the browser window to.',
     '  -c           Cache time (max-age) in seconds [3600], e.g. -c10 for 10 seconds.',
     '               To disable caching, use -c-1.',
-    '  -t           Connections timeout in seconds [120], e.g. -t60 for 1 minute.',
-    '               To disable timeout, use -t0',
+    '  -t           Connection timeout in seconds [120], e.g. -t60 for 1 minute.',
+    '               To disable timeout, use -t0.',
     '  -U --utc     Use UTC time format in log messages.',
     '  --log-ip     Enable logging of the client\'s IP address',
     '',
@@ -119,16 +119,15 @@ if (!argv.s && !argv.silent) {
     request: function (req, res, error) {
       var date = utc ? new Date().toUTCString() : new Date();
       var ip = argv['log-ip']
-          ? req.headers['x-forwarded-for'] || '' +  req.connection.remoteAddress
-          : '';
+        ? req.headers['x-forwarded-for'] || '' +  req.connection.remoteAddress
+        : '';
       if (error) {
         logger.info(
           '[%s] %s "%s %s" Error (%s): "%s"',
           date, ip, chalk.red(req.method), chalk.red(req.url),
           chalk.red(error.status.toString()), chalk.red(error.message)
         );
-      }
-      else {
+      } else {
         logger.info(
           '[%s] %s "%s %s" "%s"',
           date, ip, chalk.cyan(req.method), chalk.cyan(req.url),
@@ -137,8 +136,7 @@ if (!argv.s && !argv.silent) {
       }
     }
   };
-}
-else if (chalk) {
+} else if (chalk) {
   logger = {
     info: function () {},
     request: function () {}
@@ -156,8 +154,7 @@ if (!port) {
     if (err) { throw err; }
     listen(port);
   });
-}
-else {
+} else {
   listen(port);
 }
 
@@ -232,9 +229,8 @@ function listen(port) {
 
   if (proxy) {
     try {
-      new url.URL(proxy)
-    }
-    catch (err) {
+      new url.URL(proxy);
+    } catch (err) {
       logger.info(chalk.red('Error: Invalid proxy url'));
       process.exit(1);
     }
@@ -249,19 +245,17 @@ function listen(port) {
     options.https = {
       cert: argv.C || argv.cert || 'cert.pem',
       key: argv.K || argv.key || 'key.pem',
-      passphrase: sslPassphrase,
+      passphrase: sslPassphrase
     };
     try {
       fs.lstatSync(options.https.cert);
-    }
-    catch (err) {
+    } catch (err) {
       logger.info(chalk.red('Error: Could not find certificate ' + options.https.cert));
       process.exit(1);
     }
     try {
       fs.lstatSync(options.https.key);
-    }
-    catch (err) {
+    } catch (err) {
       logger.info(chalk.red('Error: Could not find private key ' + options.https.key));
       process.exit(1);
     }
@@ -285,7 +279,9 @@ function listen(port) {
       ([chalk.yellow('COOP: '), argv.coop ? chalk.cyan(argv.coop) : chalk.red('disabled')].join('')),
       ([chalk.yellow('CORS: '), argv.cors ? chalk.cyan(argv.cors) : chalk.red('disabled')].join('')),
       ([chalk.yellow('Cache: '), argv.c ? (argv.c === '-1' ? chalk.red('disabled') : chalk.cyan(argv.c + ' seconds')) : chalk.cyan('3600 seconds')].join('')),
-      ([chalk.yellow('Connection Timeout: '), argv.t === '0' ? chalk.red('disabled') : (argv.t ? chalk.cyan(argv.t + ' seconds') : chalk.cyan('120 seconds'))].join('')),
+      ([chalk.yellow('Connection Timeout: '), Math.max(0, argv.t) === 0 ? chalk.red('disabled') :
+        ((!isNaN(argv.t) && !isNaN(parseFloat(argv.t))) ?
+          chalk.cyan(Number(argv.t) + ' seconds') : chalk.cyan('120 seconds'))].join('')),
       ([chalk.yellow('Directory Listings: '), argv.d ? chalk.red('not visible') : chalk.cyan('visible')].join('')),
       ([chalk.yellow('AutoIndex: '), argv.i ? chalk.red('not visible') : chalk.cyan('visible')].join('')),
       ([chalk.yellow('Serve GZIP Files: '), argv.g || argv.gzip ? chalk.cyan('true') : chalk.red('false')].join('')),
@@ -323,8 +319,7 @@ function listen(port) {
     if (typeof proxy === 'string') {
       if (proxyOptions) {
         logger.info('Unhandled requests will be served from: ' + proxy + '. Options: ' + JSON.stringify(proxyOptions));
-      }
-      else {
+      } else {
         logger.info('Unhandled requests will be served from: ' + proxy);
       }
     }

doc/http-server.1

@@ -96,6 +96,12 @@ Cache time (max-age) in seconds.
 To disable caching, use \-c \-1.
 Default is 3600.
 
+.TP
+.BI \-t " " \fITIMEOUT\fR
+Connection timeout in seconds, e.g. -t60 for 1 minute.
+To disable timeout, use \-t0.
+Default is 120.
+
 .TP
 .BI \-U ", " \-\-utc
 Use UTC time format in log messages.

lib/http-server.js

@@ -213,8 +213,11 @@ function HttpServer(options) {
     ? require('./shims/https-server-shim')(serverOptions)
     : union.createServer(serverOptions);
 
-  if (options.timeout !== undefined) {
-    this.server.setTimeout(options.timeout);
+  if (isNaN(options.timeout) || isNaN(parseFloat(options.timeout))) {
+    this.server.setTimeout(120);
+  } else {
+    // set custom timeout only if options.timeout is a numeric string
+    this.server.setTimeout(Math.max(0, Number(options.timeout)));
   }
 
   if (typeof options.proxy === 'string' && options.websocket) {