feat: add flag --proxy-all

Adds a flag which allows http-server to be used purely as a proxy
without serving any files.

Author: KernelDeimos

README.md

@@ -76,6 +76,7 @@ with the provided Dockerfile.
 |`-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 | |
+|`--proxy-all` |Forward every request to the proxy target instead of serving local files|`false`|
 |`--proxy-options` |Pass proxy [options](https://github.com/http-party/node-http-proxy#options) using nested dotted objects. e.g.: --proxy-options.secure false |
 |`--username` |Username for basic authentication | |
 |`--password` |Password for basic authentication | |

bin/http-server

@@ -14,8 +14,10 @@ var argv = require('minimist')(process.argv.slice(2), {
   alias: {
     tls: 'ssl',
     header: 'H'
-  }
+  },
+  boolean: ['proxy-all']
 });
+
 var ifaces = os.networkInterfaces();
 
 process.title = 'http-server';
@@ -59,6 +61,7 @@ if (argv.h || argv.help) {
     '  --log-ip     Enable logging of the client\'s IP address',
     '',
     '  -P --proxy       Fallback proxy if the request cannot be resolved. e.g.: http://someurl.com',
+    '  --proxy-all      Send every request to the proxy target instead of serving local files',
     '  --proxy-options  Pass options to proxy using nested dotted objects. e.g.: --proxy-options.secure false',
     '  --websocket      Enable websocket proxy',
     '',
@@ -87,6 +90,7 @@ var port = argv.p || argv.port || parseInt(process.env.PORT, 10),
     proxy = argv.P || argv.proxy,
     proxyOptions = argv['proxy-options'],
     websocket = argv.websocket,
+    proxyAll = Boolean(argv['proxy-all']),
     utc = argv.U || argv.utc,
     version = argv.v || argv.version,
     baseDir = argv['base-dir'],
@@ -168,6 +172,7 @@ function listen(port) {
     logFn: logger.request,
     proxy: proxy,
     proxyOptions: proxyOptions,
+    proxyAll: proxyAll,
     showDotfiles: argv.dotfiles,
     mimetypes: argv.mimetypes,
     contentType: argv['content-type'],
@@ -223,6 +228,11 @@ function listen(port) {
     }
   }
 
+  if (proxyAll && !proxy) {
+    logger.info(chalk.red('Error: --proxy-all requires --proxy to be set'));
+    process.exit(1);
+  }
+
   if (tls) {
     options.https = {
       cert: argv.C || argv.cert || 'cert.pem',

doc/http-server.1

@@ -97,6 +97,11 @@ Enable logging of the client IP address.
 .BI \-P ", " \-\-proxy
 Fallback proxy if the request cannot be resolved.
 
+.TP
+.BI \-\-proxy\-all
+Forward every request to the proxy target and disable local file serving.
+Requires \-\-proxy.
+
 .TP
 .BI \-\-proxy\-options
 Pass proxy options using nested dotted objects.

lib/http-server.js

@@ -29,6 +29,11 @@ exports.createServer = function (options) {
  */
 function HttpServer(options) {
   options = options || {};
+  var proxyAll = options.proxyAll === true || options.proxyAll === 'true';
+
+  if (proxyAll && typeof options.proxy !== 'string') {
+    throw new Error('proxyAll option requires "proxy" to be configured');
+  }
 
   if (options.root) {
     this.root = options.root;
@@ -139,21 +144,23 @@ function HttpServer(options) {
     });
   }
 
-  before.push(httpServerCore({
-    root: this.root,
-    baseDir: options.baseDir,
-    cache: this.cache,
-    showDir: this.showDir,
-    showDotfiles: this.showDotfiles,
-    autoIndex: this.autoIndex,
-    defaultExt: this.ext,
-    gzip: this.gzip,
-    brotli: this.brotli,
-    forceContentEncoding: this.forceContentEncoding,
-    contentType: this.contentType,
-    mimetypes: options.mimetypes,
-    handleError: typeof options.proxy !== 'string'
-  }));
+  if (!proxyAll) {
+    before.push(httpServerCore({
+      root: this.root,
+      baseDir: options.baseDir,
+      cache: this.cache,
+      showDir: this.showDir,
+      showDotfiles: this.showDotfiles,
+      autoIndex: this.autoIndex,
+      defaultExt: this.ext,
+      gzip: this.gzip,
+      brotli: this.brotli,
+      forceContentEncoding: this.forceContentEncoding,
+      contentType: this.contentType,
+      mimetypes: options.mimetypes,
+      handleError: typeof options.proxy !== 'string'
+    }));
+  }
 
   if (typeof options.proxy === 'string') {
     var proxyOptions = options.proxyOptions || {};

package-lock.json

@@ -7,6 +7,7 @@ const request = require('request');
 const spawn = require('child_process').spawn;
 const path = require('path');
 const portfinder = require('portfinder');
+const httpServer = require('../lib/http-server');
 
 const node = process.execPath;
 const defaultPort = 8080;
@@ -46,6 +47,8 @@ const getPort = () => new Promise((resolve, reject) => {
   });
 });
 
+const stripAnsi = (str) => str.replace(/\u001b\[[0-9;]*m/g, '');
+
 test('setting port via cli - custom port', (t) => {
   t.plan(2);
 
@@ -115,6 +118,60 @@ test('--proxy requires you to specify a protocol', (t) => {
   });
 });
 
+test('--proxy-all requires --proxy', (t) => {
+  t.plan(1);
+
+  const options = ['.', '--proxy-all', 'true'];
+  const server = startServer(options);
+
+  tearDown(server, t);
+
+  server.on('exit', (code) => {
+    t.equal(code, 1);
+  });
+});
+
+test('--proxy-all does not consume following positional args', (t) => {
+  t.plan(4);
+
+  const root = path.resolve(__dirname, 'fixtures', 'root');
+  const targetServer = httpServer.createServer({ root });
+
+  targetServer.listen(0, () => {
+    const targetPort = targetServer.address().port;
+    getPort().then((port) => {
+      const options = [
+        '--proxy', `http://localhost:${targetPort}`,
+        '--proxy-all',
+        root,
+        '--port', port
+      ];
+      const server = startServer(options);
+
+      tearDown(server, t);
+      t.teardown(() => targetServer.close());
+
+      let sawRootLog = false;
+
+      server.stdout.on('data', (msg) => {
+        const text = stripAnsi(msg.toString());
+        if (text.includes(root)) {
+          sawRootLog = true;
+        }
+        checkServerIsRunning(`http://localhost:${port}`, msg, t, (err, res) => {
+          if (err) {
+            t.fail(err.toString());
+            return;
+          }
+
+          t.ok(sawRootLog, 'root path should remain positional argument');
+          t.equal(res.statusCode, 200, 'proxied request should succeed');
+        });
+      });
+    });
+  });
+});
+
 function doHeaderOptionTest(t, argv, obj) {
   const options = ['.', '--port', defaultPort].concat(argv);
   const server = startServer(options);

test/cli.test.js

@@ -0,0 +1 @@
+This file should never be served when proxyAll is enabled.

test/fixtures/proxy-all-local/does-not-exist

@@ -0,0 +1 @@
+Local proxy-all fixture file