webpack-dev-server 3.3.1 → 3.5.1

package/lib/options.json

@@ -1,33 +1,61 @@
 {
   "type": "object",
   "properties": {
-    "serveIndex": {
-      "type": "boolean"
-    },
-    "hot": {
-      "type": "boolean"
+    "after": {
+      "instanceof": "Function"
     },
-    "hotOnly": {
-      "type": "boolean"
+    "allowedHosts": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
     },
-    "lazy": {
-      "type": "boolean"
+    "before": {
+      "instanceof": "Function"
     },
     "bonjour": {
       "type": "boolean"
     },
-    "host": {
+    "ca": {
       "anyOf": [
         {
           "type": "string"
         },
         {
-          "type": "null"
+          "instanceof": "Buffer"
         }
       ]
     },
-    "port": {
+    "cert": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "instanceof": "Buffer"
+        }
+      ]
+    },
+    "clientLogLevel": {
+      "enum": [
+        "info",
+        "warn",
+        "error",
+        "debug",
+        "trace",
+        "silent",
+        "none",
+        "warning"
+      ]
+    },
+    "compress": {
+      "type": "boolean"
+    },
+    "contentBase": {
       "anyOf": [
+        {
+          "enum": [false]
+        },
         {
           "type": "number"
         },
@@ -35,11 +63,18 @@
           "type": "string"
         },
         {
-          "type": "null"
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
         }
       ]
     },
-    "allowedHosts": {
+    "disableHostCheck": {
+      "type": "boolean"
+    },
+    "features": {
       "type": "array",
       "items": {
         "type": "string"
@@ -58,89 +93,78 @@
         }
       ]
     },
-    "publicPath": {
-      "type": "string"
-    },
-    "socket": {
-      "type": "string"
-    },
-    "sockPath": {
-      "type": "string"
+    "fs": {
+      "type": "object"
     },
-    "watchOptions": {
+    "headers": {
       "type": "object"
     },
-    "writeToDisk": {
+    "historyApiFallback": {
       "anyOf": [
         {
           "type": "boolean"
         },
         {
-          "instanceof": "Function"
+          "type": "object"
         }
       ]
     },
-    "headers": {
-      "type": "object"
-    },
-    "logLevel": {
-      "enum": ["info", "warn", "error", "debug", "trace", "silent"]
-    },
-    "clientLogLevel": {
-      "enum": ["none", "info", "error", "warning"]
-    },
-    "overlay": {
+    "host": {
       "anyOf": [
         {
-          "type": "boolean"
+          "type": "string"
         },
         {
-          "type": "object",
-          "properties": {
-            "errors": {
-              "type": "boolean"
-            },
-            "warnings": {
-              "type": "boolean"
-            }
-          }
+          "type": "null"
         }
       ]
     },
-    "progress": {
+    "hot": {
       "type": "boolean"
     },
-    "key": {
+    "hotOnly": {
+      "type": "boolean"
+    },
+    "http2": {
+      "type": "boolean"
+    },
+    "https": {
       "anyOf": [
         {
-          "type": "string"
+          "type": "object"
         },
         {
-          "instanceof": "Buffer"
+          "type": "boolean"
         }
       ]
     },
-    "cert": {
+    "index": {
+      "type": "string"
+    },
+    "injectClient": {
       "anyOf": [
         {
-          "type": "string"
+          "type": "boolean"
         },
         {
-          "instanceof": "Buffer"
+          "instanceof": "Function"
         }
       ]
     },
-    "ca": {
+    "injectHot": {
       "anyOf": [
         {
-          "type": "string"
+          "type": "boolean"
         },
         {
-          "instanceof": "Buffer"
+          "instanceof": "Function"
         }
       ]
     },
-    "pfx": {
+    "inline": {
+      "type": "boolean"
+    },
+    "key": {
       "anyOf": [
         {
           "type": "string"
@@ -150,80 +174,88 @@
         }
       ]
     },
-    "pfxPassphrase": {
-      "type": "string"
+    "lazy": {
+      "type": "boolean"
     },
-    "requestCert": {
+    "liveReload": {
       "type": "boolean"
     },
-    "inline": {
+    "log": {
+      "instanceof": "Function"
+    },
+    "logLevel": {
+      "enum": ["info", "warn", "error", "debug", "trace", "silent"]
+    },
+    "logTime": {
       "type": "boolean"
     },
-    "disableHostCheck": {
+    "mimeTypes": {
+      "type": "object"
+    },
+    "noInfo": {
       "type": "boolean"
     },
-    "public": {
-      "type": "string"
+    "onListening": {
+      "instanceof": "Function"
     },
-    "https": {
+    "open": {
       "anyOf": [
         {
-          "type": "object"
+          "type": "string"
         },
         {
           "type": "boolean"
         }
       ]
     },
-    "http2": {
-      "type": "boolean"
+    "openPage": {
+      "type": "string"
     },
-    "contentBase": {
+    "overlay": {
       "anyOf": [
         {
-          "enum": [false]
+          "type": "boolean"
         },
         {
-          "type": "number"
-        },
+          "type": "object",
+          "properties": {
+            "errors": {
+              "type": "boolean"
+            },
+            "warnings": {
+              "type": "boolean"
+            }
+          }
+        }
+      ]
+    },
+    "pfx": {
+      "anyOf": [
         {
           "type": "string"
         },
         {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "minItems": 1
+          "instanceof": "Buffer"
         }
       ]
     },
-    "watchContentBase": {
-      "type": "boolean"
+    "pfxPassphrase": {
+      "type": "string"
     },
-    "open": {
+    "port": {
       "anyOf": [
+        {
+          "type": "number"
+        },
         {
           "type": "string"
         },
         {
-          "type": "boolean"
+          "type": "null"
         }
       ]
     },
-    "useLocalIp": {
-      "type": "boolean"
-    },
-    "openPage": {
-      "type": "string"
-    },
-    "features": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "compress": {
+    "progress": {
       "type": "boolean"
     },
     "proxy": {
@@ -247,28 +279,55 @@
         }
       ]
     },
-    "historyApiFallback": {
+    "public": {
+      "type": "string"
+    },
+    "publicPath": {
+      "type": "string"
+    },
+    "quiet": {
+      "type": "boolean"
+    },
+    "reporter": {
+      "instanceof": "Function"
+    },
+    "requestCert": {
+      "type": "boolean"
+    },
+    "serveIndex": {
+      "type": "boolean"
+    },
+    "serverSideRender": {
+      "type": "boolean"
+    },
+    "setup": {
+      "instanceof": "Function"
+    },
+    "sockHost": {
+      "type": "string"
+    },
+    "sockPath": {
+      "type": "string"
+    },
+    "sockPort": {
       "anyOf": [
         {
-          "type": "boolean"
+          "type": "number"
         },
         {
-          "type": "object"
+          "type": "string"
+        },
+        {
+          "type": "null"
         }
       ]
     },
+    "socket": {
+      "type": "string"
+    },
     "staticOptions": {
       "type": "object"
     },
-    "setup": {
-      "instanceof": "Function"
-    },
-    "before": {
-      "instanceof": "Function"
-    },
-    "after": {
-      "instanceof": "Function"
-    },
     "stats": {
       "anyOf": [
         {
@@ -278,92 +337,102 @@
           "type": "boolean"
         },
         {
-          "enum": ["none", "errors-only", "minimal", "normal", "verbose"]
+          "enum": [
+            "none",
+            "errors-only",
+            "errors-warnings",
+            "minimal",
+            "normal",
+            "verbose"
+          ]
         }
       ]
     },
-    "reporter": {
-      "instanceof": "Function"
-    },
-    "logTime": {
-      "type": "boolean"
-    },
-    "noInfo": {
+    "useLocalIp": {
       "type": "boolean"
     },
-    "mimeTypes": {
-      "type": "object"
-    },
-    "quiet": {
-      "type": "boolean"
+    "warn": {
+      "instanceof": "Function"
     },
-    "serverSideRender": {
+    "watchContentBase": {
       "type": "boolean"
     },
-    "index": {
-      "type": "string"
-    },
-    "log": {
-      "instanceof": "Function"
+    "watchOptions": {
+      "type": "object"
     },
-    "warn": {
-      "instanceof": "Function"
+    "writeToDisk": {
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "instanceof": "Function"
+        }
+      ]
     }
   },
   "errorMessage": {
     "properties": {
-      "hot": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-hot)",
-      "hotOnly": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-hotonly)",
-      "lazy": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-lazy-)",
-      "bonjour": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-bonjour)",
-      "publicPath": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-publicpath-)",
-      "host": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-host)",
-      "allowedHosts": "should be {Array} (https://webpack.js.org/configuration/dev-server/#devserver-allowedhosts)",
-      "logLevel": "should be {String} and equal to one of the allowed values\n\n [ 'trace', 'debug', 'info', 'warn', 'error', 'silent' ]\n\n(https://webpack.js.org/configuration/dev-server/#devserver-loglevel)",
-      "filename": "should be {String|RegExp|Function} (https://webpack.js.org/configuration/dev-server/#devserver-filename-)",
-      "port": "should be {String|Number} (https://webpack.js.org/configuration/dev-server/#devserver-port)",
-      "socket": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-socket)",
-      "sockPath": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-sockPath)",
-      "watchOptions": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserver-watchoptions)",
-      "writeToDisk": "should be {Boolean|Function} (https://github.com/webpack/webpack-dev-middleware#writetodisk)",
-      "headers": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserver-headers-)",
-      "clientLogLevel": "should be {String} and equal to one of the allowed values\n\n [ 'trace', 'debug', 'info', 'warn', 'error', 'silent' ]\n\n(https://webpack.js.org/configuration/dev-server/#devserver-clientloglevel)",
-      "overlay": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-overlay)",
-      "progress": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-progress-cli-only)",
-      "key": "should be {String|Buffer} (https://webpack.js.org/configuration/dev-server/#devserver-key)",
-      "cert": "should be {String|Buffer} (https://webpack.js.org/configuration/dev-server/#devserver-cert)",
-      "ca": "should be {String|Buffer} (https://webpack.js.org/configuration/dev-server/#devserver-ca)",
-      "pfx": "should be {String|Buffer} (https://webpack.js.org/configuration/dev-server/#devserver-pfx)",
-      "pfxPassphrase": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-pfxpassphrase)",
-      "requestCert": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-requestcert)",
-      "inline": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-inline)",
-      "disableHostCheck": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-disablehostcheck)",
-      "public": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-public)",
-      "https": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-https)",
-      "http2": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-http2)",
-      "contentBase": "should be {Array} (https://webpack.js.org/configuration/dev-server/#devserver-contentbase)",
-      "watchContentBase": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-watchcontentbase)",
-      "open": "should be {String|Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-open)",
-      "useLocalIp": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-uselocalip)",
-      "openPage": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-openpage)",
-      "features": "should be {Array} (https://webpack.js.org/configuration/dev-server/#devserver-features)",
-      "compress": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-compress)",
-      "proxy": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-hot)",
-      "historyApiFallback": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-historyapifallback)",
-      "staticOptions": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-staticOptions)",
-      "setup": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserver-setup)",
-      "before": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserver-before)",
-      "after": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserver-after)",
-      "stats": "should be {Boolean|Object|String} (https://webpack.js.org/configuration/dev-server/#devserver-stats-)",
-      "reporter": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserver-reporter)",
-      "logTime": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-logtime)",
-      "noInfo": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-noinfo-)",
+      "after": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserverafter)",
+      "allowedHosts": "should be {Array} (https://webpack.js.org/configuration/dev-server/#devserverallowedhosts)",
+      "before": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserverbefore)",
+      "bonjour": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverbonjour)",
+      "ca": "should be {String|Buffer}",
+      "cert": "should be {String|Buffer}",
+      "clientLogLevel": "should be {String} and equal to one of the allowed values\n\n [ 'info', 'warn', 'error', 'debug', 'trace', 'silent' ]\n\n (https://webpack.js.org/configuration/dev-server/#devserverclientloglevel)",
+      "compress": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devservercompress)",
+      "contentBase": "should be {Number|String|Array} (https://webpack.js.org/configuration/dev-server/#devservercontentbase)",
+      "disableHostCheck": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverdisablehostcheck)",
+      "features": "should be {Array}",
+      "filename": "should be {String|RegExp|Function} (https://webpack.js.org/configuration/dev-server/#devserverfilename-)",
+      "fs": "should be {Object} (https://github.com/webpack/webpack-dev-middleware#fs)",
+      "headers": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverheaders-)",
+      "historyApiFallback": "should be {Boolean|Object} (https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback)",
+      "host": "should be {String|Null} (https://webpack.js.org/configuration/dev-server/#devserverhost)",
+      "hot": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhot)",
+      "hotOnly": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhotonly)",
+      "http2": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttp2)",
+      "https": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttps)",
+      "index": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverindex)",
+      "injectClient": "should be {Boolean|Function}",
+      "injectHot": "should be {Boolean|Function}",
+      "inline": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverinline)",
+      "key": "should be {String|Buffer}",
+      "lazy": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverlazy-)",
+      "liveReload": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverlivereload-)",
+      "log": "should be {Function}",
+      "logLevel": "should be {String} and equal to one of the allowed values\n\n [ 'info', 'warn', 'error', 'debug', 'trace', 'silent' ]\n\n (https://github.com/webpack/webpack-dev-middleware#loglevel)",
+      "logTime": "should be {Boolean} (https://github.com/webpack/webpack-dev-middleware#logtime)",
       "mimeTypes": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devservermimetypes-)",
-      "quiet": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-quiet-)",
-      "serverSideRender": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserver-serversiderender)",
-      "index": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserver-index)",
-      "log": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserver-log)",
-      "warn": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserver-warn)"
+      "noInfo": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devservernoinfo-)",
+      "onListening": "should be {Function} (https://webpack.js.org/configuration/dev-server/#onlistening)",
+      "open": "should be {String|Boolean} (https://webpack.js.org/configuration/dev-server/#devserveropen)",
+      "openPage": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserveropenpage)",
+      "overlay": "should be {Boolean|Object} (https://webpack.js.org/configuration/dev-server/#devserveroverlay)",
+      "pfx": "should be {String|Buffer} (https://webpack.js.org/configuration/dev-server/#devserverpfx)",
+      "pfxPassphrase": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverpfxpassphrase)",
+      "port": "should be {Number|String|Null} (https://webpack.js.org/configuration/dev-server/#devserverport)",
+      "progress": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverprogress---cli-only)",
+      "proxy": "should be {Object|Array} (https://webpack.js.org/configuration/dev-server/#devserverproxy)",
+      "public": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverpublic)",
+      "publicPath": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverpublicpath-)",
+      "quiet": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverquiet-)",
+      "reporter": "should be {Function} (https://github.com/webpack/webpack-dev-middleware#reporter)",
+      "requestCert": "should be {Boolean}",
+      "serveIndex": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverserveindex)",
+      "serverSideRender": "should be {Boolean} (https://github.com/webpack/webpack-dev-middleware#serversiderender)",
+      "setup": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserversetup)",
+      "sockHost": "should be {String|Null} (https://webpack.js.org/configuration/dev-server/#devserversockhost)",
+      "sockPath": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserversockpath)",
+      "sockPort": "should be {Number|String|Null} (https://webpack.js.org/configuration/dev-server/#devserversockport)",
+      "socket": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserversocket)",
+      "staticOptions": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverstaticoptions)",
+      "stats": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserverstats-)",
+      "useLocalIp": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserveruselocalip)",
+      "warn": "should be {Function}",
+      "watchContentBase": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverwatchcontentbase)",
+      "watchOptions": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverwatchoptions-)",
+      "writeToDisk": "should be {Boolean|Function} (https://webpack.js.org/configuration/dev-server/#devserverwritetodisk-)"
     }
   },
   "additionalProperties": false

package/lib/servers/BaseServer.js

@@ -0,0 +1,9 @@
+'use strict';
+
+// base class that users should extend if they are making their own
+// server implementation
+module.exports = class BaseServer {
+  constructor(server) {
+    this.server = server;
+  }
+};

package/lib/servers/SockJSServer.js

@@ -0,0 +1,64 @@
+'use strict';
+
+/* eslint-disable
+  class-methods-use-this,
+  func-names
+*/
+const sockjs = require('sockjs');
+const BaseServer = require('./BaseServer');
+
+// Workaround for sockjs@~0.3.19
+// sockjs will remove Origin header, however Origin header is required for checking host.
+// See https://github.com/webpack/webpack-dev-server/issues/1604 for more information
+{
+  // eslint-disable-next-line global-require
+  const SockjsSession = require('sockjs/lib/transport').Session;
+  const decorateConnection = SockjsSession.prototype.decorateConnection;
+  SockjsSession.prototype.decorateConnection = function(req) {
+    decorateConnection.call(this, req);
+    const connection = this.connection;
+    if (
+      connection.headers &&
+      !('origin' in connection.headers) &&
+      'origin' in req.headers
+    ) {
+      connection.headers.origin = req.headers.origin;
+    }
+  };
+}
+
+module.exports = class SockJSServer extends BaseServer {
+  // options has: error (function), debug (function), server (http/s server), path (string)
+  constructor(server) {
+    super(server);
+    this.socket = sockjs.createServer({
+      // Use provided up-to-date sockjs-client
+      sockjs_url: '/__webpack_dev_server__/sockjs.bundle.js',
+      // Limit useless logs
+      log: (severity, line) => {
+        if (severity === 'error') {
+          this.server.log.error(line);
+        } else {
+          this.server.log.debug(line);
+        }
+      },
+    });
+
+    this.socket.installHandlers(this.server.listeningApp, {
+      prefix: this.server.sockPath,
+    });
+  }
+
+  send(connection, message) {
+    connection.write(message);
+  }
+
+  close(connection) {
+    connection.close();
+  }
+
+  // f should return the resulting connection
+  onConnection(f) {
+    this.socket.on('connection', f);
+  }
+};