zeroconf dns (bonjour) service publishing (#930)

samuraisam · shellscape · commit c9fe53d1f105 · 2017-06-16T07:11:57.000-04:00
* zeroconf dns (bonjour) service publishing

* address code style issues

* zeroconf: cleanup console.logs and fix broken test

* bonjour: add test file
diff --git a/bin/webpack-dev-server.js b/bin/webpack-dev-server.js
@@ -8,6 +8,7 @@ const net = require("net");
 const portfinder = require("portfinder");
 const addDevServerEntrypoints = require("../lib/util/addDevServerEntrypoints");
 const createDomain = require("../lib/util/createDomain");
+const bonjour = require("bonjour")();
 
 // Local version replaces global one
 try {
@@ -64,6 +65,10 @@ const BASIC_GROUP = "Basic options:";
 const DEFAULT_PORT = 8080;
 
 yargs.options({
+	"bonjour": {
+		type: "boolean",
+		describe: "Broadcasts the server via ZeroConf networking on start"
+	},
 	"lazy": {
 		type: "boolean",
 		describe: "Lazy"
@@ -214,6 +219,9 @@ function processOptions(wpOpt) {
 
 	const options = wpOpt.devServer || firstWpOpt.devServer || {};
 
+	if(argv.bonjour)
+		options.bonjour = true;
+
 	if(argv.host !== "localhost" || !options.host)
 		options.host = argv.host;
 
@@ -410,6 +418,7 @@ function startDevServer(wpOpt, options) {
 	} else {
 		server.listen(options.port, options.host, function(err) {
 			if(err) throw err;
+			if(options.bonjour) broadcastZeroconf(options);
 			reportReadiness(uri, options);
 		});
 	}
@@ -434,6 +443,22 @@ function reportReadiness(uri, options) {
 			console.log("Unable to open browser. If you are running in a headless environment, please do not use the open flag.");
 		});
 	}
+	if(options.bonjour)
+		console.log("Broadcasting \"http\" with subtype of \"webpack\" via ZeroConf DNS (Bonjour)");
+}
+
+function broadcastZeroconf(options) {
+	bonjour.publish({
+		name: "Webpack Dev Server",
+		port: options.port,
+		type: "http",
+		subtypes: ["webpack"]
+	});
+	process.on("exit", function() {
+		bonjour.unpublishAll(function() {
+			bonjour.destroy();
+		});
+	});
 }
 
 processOptions(wpOpt);
diff --git a/examples/bonjour/README.md b/examples/bonjour/README.md
@@ -0,0 +1,10 @@
+# host and port
+
+For basic usage
+```shell
+node ../../bin/webpack-dev-server.js --bonjour
+```
+
+## What should happen
+
+It should publish a zeroconf service with a type of `http` and a subtype of `webpack`.
diff --git a/examples/bonjour/app.js b/examples/bonjour/app.js
@@ -0,0 +1 @@
+document.write("It's working.");
diff --git a/examples/bonjour/index.html b/examples/bonjour/index.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<script src="bundle.js" type="text/javascript" charset="utf-8"></script>
+	</head>
+	<body>
+		<h1>Example: host and port</h1>
+	</body>
+</html>
diff --git a/examples/bonjour/webpack.config.js b/examples/bonjour/webpack.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+	context: __dirname,
+	entry: "./app.js",
+}
diff --git a/lib/optionsSchema.json b/lib/optionsSchema.json
@@ -13,6 +13,10 @@
       "description": "Disables watch mode and recompiles bundle only on a request.",
       "type": "boolean"
     },
+    "bonjour": {
+      "description": "Publishes the ZeroConf DNS service",
+      "type": "boolean"
+    },
     "host": {
       "description": "The host the server listens to.",
       "type": "string"
diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
   },
   "dependencies": {
     "ansi-html": "0.0.7",
+    "bonjour": "^3.5.0",
     "chokidar": "^1.6.0",
     "compression": "^1.5.2",
     "connect-history-api-fallback": "^1.3.0",
diff --git a/test/Validation.test.js b/test/Validation.test.js
@@ -48,7 +48,7 @@ describe("Validation", function() {
 		config: { asdf: true },
 		message: [
 			" - configuration has an unknown property 'asdf'. These properties are valid:",
-			"   object { hot?, hotOnly?, lazy?, host?, allowedHosts?, filename?, publicPath?, port?, socket?, " +
+			"   object { hot?, hotOnly?, lazy?, bonjour?, host?, allowedHosts?, filename?, publicPath?, port?, socket?, " +
 			"watchOptions?, headers?, clientLogLevel?, overlay?, key?, cert?, ca?, pfx?, pfxPassphrase?, " +
 			"inline?, disableHostCheck?, public?, https?, contentBase?, watchContentBase?, open?, openPage?, features?, " +
 			"compress?, proxy?, historyApiFallback?, staticOptions?, setup?, stats?, reporter?, " +
