added https support to (listen) proxy server

Author: marcelduran

bin/webpagetest

@@ -147,9 +147,8 @@ Object.keys(mapping.commands).forEach(function eachCommand(name) {
         formatData = null;
       }
     },
-    'listen': function(port) {
-      defaultAction(port);
-      options = undefined;
+    'listen': function(port, opts) {
+      defaultAction(port, opts);
       formatData = function customFormat(err, data) {
         if (err) {
           output(JSON.stringify({error: err}, null, 2), 1);

lib/mapping.js

@@ -595,6 +595,20 @@ var options = {
       param: 'number',
       info: 'the request number [1]'
     }
+  },
+  'listen': {
+    'key': {
+      name: 'key',
+      key: 'k',
+      param: 'file',
+      info: 'private key file to use for SSL'
+    },
+    'cert': {
+      name: 'cert',
+      key: 'c',
+      param: 'file',
+      info: 'public x509 certificate file to use for SSL'
+    }
   }
 };
 
@@ -725,7 +739,8 @@ var commands = {
     name: 'listen',
     param: 'hostname:port',
     optional: true,
-    info: 'start webpagetest-api server on <hostname>:<port> [hostname:%s]'
+    options: [options.listen],
+    info: 'start webpagetest-api proxy server on <hostname>:<port> [hostname:%s]'
   }
 };
 

lib/server.js

@@ -5,9 +5,11 @@
  * Released under the MIT License
  */
 
-var http    = require('http'),
+var https   = require('https'),
+    http    = require('http'),
     path    = require('path'),
     url     = require('url'),
+    fs      = require('fs'),
     mapping = require('./mapping');
 
 var help = {};
@@ -142,31 +144,40 @@ function route(req, res) {
 }
 
 module.exports = {
-  listen: function listen(local, callback) {
-    var httpServer = http.createServer(route.bind(this));
+  listen: function listen(local, options, callback) {
+    var server;
+
+    if (fs.existsSync(options.key) && fs.existsSync(options.cert)) {
+      server = https.createServer({
+        key: fs.readFileSync(path.resolve(process.cwd(), options.key)),
+        cert: fs.readFileSync(path.resolve(process.cwd(), options.cert))
+      }, route.bind(this));
+    } else {
+      server = http.createServer(route.bind(this));
+    }
 
-    httpServer.on('error', function listenError(err) {
-        if (typeof callback === 'function') {
-          callback(err);
-        }
-      }).on('listening', function listenError() {
-        if (typeof callback === 'function') {
-          callback(undefined, {
-            server: httpServer,
-            protocol: 'http',
+    server.on('error', function listenError(err) {
+      if (typeof callback === 'function') {
+        callback(err);
+      }
+    }).on('listening', function listenError() {
+      if (typeof callback === 'function') {
+        callback(undefined, {
+          server: server,
+          protocol: server instanceof https.Server ? 'https' : 'http',
+          hostname: local.hostname,
+          port: local.port,
+          url: url.format({
+            protocol: server instanceof https.Server ? 'https' : 'http',
             hostname: local.hostname,
-            port: local.port,
-            url: url.format({
-              protocol: 'http',
-              hostname: local.hostname,
-              port: local.port
-            })
-          });
-        }
-      }).listen(local.port);
+            port: local.port
+          })
+        });
+      }
+    }).listen(local.port);
 
     buildHelp(url.format(this.config.hostname));
 
-    return httpServer;
+    return server;
   }
 };

lib/webpagetest.js

@@ -644,10 +644,12 @@ function getScreenshotImage(id, options, callback) {
   return api.call(this, pathname, callback, params, options);
 }
 
-function listen(local, callback) {
+function listen(local, options, callback) {
+  callback = callback || options;
+  options = options === callback ? {} : options;
   local = helper.localhost(local, WebPageTest.defaultListenPort);
 
-  return server.listen.call(this, local, callback);
+  return server.listen.call(this, local, options, callback);
 }
 
 function getEmbedVideoPlayer(id, options, callback) {

test/fixtures/command-line/help-listen.txt

@@ -3,5 +3,7 @@
 
   Options:
 
-    -h, --help  output usage information
+    -h, --help         output usage information
+    -k, --key <file>   private key file to use for SSL
+    -c, --cert <file>  public x509 certificate file to use for SSL
 

test/fixtures/command-line/help.txt

@@ -24,7 +24,7 @@
     screenshot [options] <id> get the fully loaded page screenshot in JPG format (PNG if in full resolution)
     video [options] <tests> create a video from <tests> (comma separated test ids)
     player <id>            get a html5 player for a video <id>
-    listen [hostname:port] start webpagetest-api server on <hostname>:<port> [hostname:7791]
+    listen [options] [hostname:port] start webpagetest-api proxy server on <hostname>:<port> [hostname:7791]
     batch <file>           run commands in batch, i.e. one command per line from <file> in parallel
 
   Options: