webpack-dev-server 2.4.2 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +86 -86
  3. package/bin/webpack-dev-server.js +45 -4
  4. package/client/index.bundle.js +1 -1
  5. package/client/index.js +188 -181
  6. package/client/live.bundle.js +3 -3
  7. package/client/live.html +1 -1
  8. package/client/live.js +119 -119
  9. package/client/overlay.js +126 -126
  10. package/client/page.pug +7 -7
  11. package/client/socket.js +41 -41
  12. package/client/sockjs.bundle.js +1 -1
  13. package/client/sockjs.js +1 -1
  14. package/client/style.css +58 -58
  15. package/client/web_modules/jquery/index.js +1 -1
  16. package/client/web_modules/jquery/jquery-1.8.1.js +9301 -9301
  17. package/client/webpack.config.js +19 -19
  18. package/client/webpack.sockjs.config.js +6 -6
  19. package/lib/OptionsValidationError.js +159 -159
  20. package/lib/Server.js +599 -509
  21. package/lib/optionsSchema.json +312 -289
  22. package/lib/util/addDevServerEntrypoints.js +26 -26
  23. package/lib/util/createDomain.js +14 -13
  24. package/package.json +6 -2
  25. package/ssl/.gitkeep +0 -0
  26. package/ssl/server.pem +0 -46
package/lib/Server.js CHANGED
@@ -1,509 +1,599 @@
1
- "use strict";
2
-
3
- const fs = require("fs");
4
- const chokidar = require("chokidar");
5
- const path = require("path");
6
- const webpackDevMiddleware = require("webpack-dev-middleware");
7
- const express = require("express");
8
- const compress = require("compression");
9
- const sockjs = require("sockjs");
10
- const http = require("http");
11
- const spdy = require("spdy");
12
- const httpProxyMiddleware = require("http-proxy-middleware");
13
- const serveIndex = require("serve-index");
14
- const historyApiFallback = require("connect-history-api-fallback");
15
- const webpack = require("webpack");
16
- const OptionsValidationError = require("./OptionsValidationError");
17
- const optionsSchema = require("./optionsSchema.json");
18
-
19
- const clientStats = { errorDetails: false };
20
-
21
- function Server(compiler, options) {
22
- // Default options
23
- if(!options) options = {};
24
-
25
- const validationErrors = webpack.validateSchema(optionsSchema, options);
26
- if(validationErrors.length) {
27
- throw new OptionsValidationError(validationErrors);
28
- }
29
-
30
- if(options.lazy && !options.filename) {
31
- throw new Error("'filename' option must be set in lazy mode.");
32
- }
33
-
34
- this.hot = options.hot || options.hotOnly;
35
- this.headers = options.headers;
36
- this.clientLogLevel = options.clientLogLevel;
37
- this.clientOverlay = options.overlay;
38
- this.sockets = [];
39
- this.contentBaseWatchers = [];
40
-
41
- // Listening for events
42
- const invalidPlugin = () => {
43
- this.sockWrite(this.sockets, "invalid");
44
- };
45
- compiler.plugin("compile", invalidPlugin);
46
- compiler.plugin("invalid", invalidPlugin);
47
- compiler.plugin("done", (stats) => {
48
- this._sendStats(this.sockets, stats.toJson(clientStats));
49
- this._stats = stats;
50
- });
51
-
52
- // Init express server
53
- const app = this.app = new express();
54
-
55
- // middleware for serving webpack bundle
56
- this.middleware = webpackDevMiddleware(compiler, options);
57
-
58
- app.get("/__webpack_dev_server__/live.bundle.js", (req, res) => {
59
- res.setHeader("Content-Type", "application/javascript");
60
- fs.createReadStream(path.join(__dirname, "..", "client", "live.bundle.js")).pipe(res);
61
- });
62
-
63
- app.get("/__webpack_dev_server__/sockjs.bundle.js", (req, res) => {
64
- res.setHeader("Content-Type", "application/javascript");
65
- fs.createReadStream(path.join(__dirname, "..", "client", "sockjs.bundle.js")).pipe(res);
66
- });
67
-
68
- app.get("/webpack-dev-server.js", (req, res) => {
69
- res.setHeader("Content-Type", "application/javascript");
70
- fs.createReadStream(path.join(__dirname, "..", "client", "index.bundle.js")).pipe(res);
71
- });
72
-
73
- app.get("/webpack-dev-server/*", (req, res) => {
74
- res.setHeader("Content-Type", "text/html");
75
- fs.createReadStream(path.join(__dirname, "..", "client", "live.html")).pipe(res);
76
- });
77
-
78
- app.get("/webpack-dev-server", (req, res) => {
79
- res.setHeader("Content-Type", "text/html");
80
- /* eslint-disable quotes */
81
- res.write('<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body>');
82
- const path = this.middleware.getFilenameFromUrl(options.publicPath || "/");
83
- const fs = this.middleware.fileSystem;
84
-
85
- function writeDirectory(baseUrl, basePath) {
86
- const content = fs.readdirSync(basePath);
87
- res.write("<ul>");
88
- content.forEach(function(item) {
89
- const p = `${basePath}/${item}`;
90
- if(fs.statSync(p).isFile()) {
91
- res.write('<li><a href="');
92
- res.write(baseUrl + item);
93
- res.write('">');
94
- res.write(item);
95
- res.write('</a></li>');
96
- if(/\.js$/.test(item)) {
97
- const htmlItem = item.substr(0, item.length - 3);
98
- res.write('<li><a href="');
99
- res.write(baseUrl + htmlItem);
100
- res.write('">');
101
- res.write(htmlItem);
102
- res.write('</a> (magic html for ');
103
- res.write(item);
104
- res.write(') (<a href="');
105
- res.write(baseUrl.replace(/(^(https?:\/\/[^\/]+)?\/)/, "$1webpack-dev-server/") + htmlItem);
106
- res.write('">webpack-dev-server</a>)</li>');
107
- }
108
- } else {
109
- res.write('<li>');
110
- res.write(item);
111
- res.write('<br>');
112
- writeDirectory(`${baseUrl + item}/`, p);
113
- res.write('</li>');
114
- }
115
- });
116
- res.write("</ul>");
117
- }
118
- /* eslint-enable quotes */
119
- writeDirectory(options.publicPath || "/", path);
120
- res.end("</body></html>");
121
- });
122
-
123
- let contentBase;
124
- if(options.contentBase !== undefined) {
125
- contentBase = options.contentBase;
126
- } else {
127
- contentBase = process.cwd();
128
- }
129
-
130
- // Keep track of websocket proxies for external websocket upgrade.
131
- const websocketProxies = [];
132
-
133
- const features = {
134
- compress() {
135
- if(options.compress) {
136
- // Enable gzip compression.
137
- app.use(compress());
138
- }
139
- },
140
-
141
- proxy() {
142
- if(options.proxy) {
143
- /**
144
- * Assume a proxy configuration specified as:
145
- * proxy: {
146
- * 'context': { options }
147
- * }
148
- * OR
149
- * proxy: {
150
- * 'context': 'target'
151
- * }
152
- */
153
- if(!Array.isArray(options.proxy)) {
154
- options.proxy = Object.keys(options.proxy).map((context) => {
155
- let proxyOptions;
156
- // For backwards compatibility reasons.
157
- const correctedContext = context.replace(/^\*$/, "**").replace(/\/\*$/, "");
158
-
159
- if(typeof options.proxy[context] === "string") {
160
- proxyOptions = {
161
- context: correctedContext,
162
- target: options.proxy[context]
163
- };
164
- } else {
165
- proxyOptions = Object.assign({}, options.proxy[context]);
166
- proxyOptions.context = correctedContext;
167
- }
168
- proxyOptions.logLevel = proxyOptions.logLevel || "warn";
169
-
170
- return proxyOptions;
171
- });
172
- }
173
-
174
- const getProxyMiddleware = (proxyConfig) => {
175
- const context = proxyConfig.context || proxyConfig.path;
176
-
177
- // It is possible to use the `bypass` method without a `target`.
178
- // However, the proxy middleware has no use in this case, and will fail to instantiate.
179
- if(proxyConfig.target) {
180
- return httpProxyMiddleware(context, proxyConfig);
181
- }
182
- }
183
-
184
- /**
185
- * Assume a proxy configuration specified as:
186
- * proxy: [
187
- * {
188
- * context: ...,
189
- * ...options...
190
- * },
191
- * // or:
192
- * function() {
193
- * return {
194
- * context: ...,
195
- * ...options...
196
- * };
197
- * }
198
- * ]
199
- */
200
- options.proxy.forEach((proxyConfigOrCallback) => {
201
- let proxyConfig;
202
- let proxyMiddleware;
203
-
204
- if(typeof proxyConfigOrCallback === "function") {
205
- proxyConfig = proxyConfigOrCallback();
206
- } else {
207
- proxyConfig = proxyConfigOrCallback;
208
- }
209
-
210
- proxyMiddleware = getProxyMiddleware(proxyConfig);
211
- if(proxyConfig.ws) {
212
- websocketProxies.push(proxyMiddleware);
213
- }
214
-
215
- app.use((req, res, next) => {
216
- if(typeof proxyConfigOrCallback === "function") {
217
- const newProxyConfig = proxyConfigOrCallback();
218
- if(newProxyConfig !== proxyConfig) {
219
- proxyConfig = newProxyConfig;
220
- proxyMiddleware = getProxyMiddleware(proxyConfig);
221
- }
222
- }
223
- const bypass = typeof proxyConfig.bypass === "function";
224
- const bypassUrl = bypass && proxyConfig.bypass(req, res, proxyConfig) || false;
225
-
226
- if(bypassUrl) {
227
- req.url = bypassUrl;
228
- next();
229
- } else if(proxyMiddleware) {
230
- return proxyMiddleware(req, res, next);
231
- } else {
232
- next();
233
- }
234
- });
235
- });
236
- }
237
- },
238
-
239
- historyApiFallback() {
240
- if(options.historyApiFallback) {
241
- // Fall back to /index.html if nothing else matches.
242
- app.use(
243
- historyApiFallback(typeof options.historyApiFallback === "object" ? options.historyApiFallback : null)
244
- );
245
- }
246
- },
247
-
248
- contentBaseFiles() {
249
- if(Array.isArray(contentBase)) {
250
- contentBase.forEach((item) => {
251
- app.get("*", express.static(item));
252
- });
253
- } else if(/^(https?:)?\/\//.test(contentBase)) {
254
- console.log("Using a URL as contentBase is deprecated and will be removed in the next major version. Please use the proxy option instead.");
255
- console.log('proxy: {\n\t"*": "<your current contentBase configuration>"\n}'); // eslint-disable-line quotes
256
- // Redirect every request to contentBase
257
- app.get("*", (req, res) => {
258
- res.writeHead(302, {
259
- "Location": contentBase + req.path + (req._parsedUrl.search || "")
260
- });
261
- res.end();
262
- });
263
- } else if(typeof contentBase === "number") {
264
- console.log("Using a number as contentBase is deprecated and will be removed in the next major version. Please use the proxy option instead.");
265
- console.log('proxy: {\n\t"*": "//localhost:<your current contentBase configuration>"\n}'); // eslint-disable-line quotes
266
- // Redirect every request to the port contentBase
267
- app.get("*", (req, res) => {
268
- res.writeHead(302, {
269
- "Location": `//localhost:${contentBase}${req.path}${req._parsedUrl.search || ""}`
270
- });
271
- res.end();
272
- });
273
- } else {
274
- // route content request
275
- app.get("*", express.static(contentBase, options.staticOptions));
276
- }
277
- },
278
-
279
- contentBaseIndex() {
280
- if(Array.isArray(contentBase)) {
281
- contentBase.forEach((item) => {
282
- app.get("*", serveIndex(item));
283
- });
284
- } else if(!/^(https?:)?\/\//.test(contentBase) && typeof contentBase !== "number") {
285
- app.get("*", serveIndex(contentBase));
286
- }
287
- },
288
-
289
- watchContentBase: () => {
290
- if(/^(https?:)?\/\//.test(contentBase) || typeof contentBase === "number") {
291
- throw new Error("Watching remote files is not supported.");
292
- } else if(Array.isArray(contentBase)) {
293
- contentBase.forEach((item) => {
294
- this._watch(item);
295
- });
296
- } else {
297
- this._watch(contentBase);
298
- }
299
- },
300
-
301
- middleware: () => {
302
- // include our middleware to ensure it is able to handle '/index.html' request after redirect
303
- app.use(this.middleware);
304
- },
305
-
306
- headers: () => {
307
- app.all("*", this.setContentHeaders.bind(this));
308
- },
309
-
310
- magicHtml: () => {
311
- app.get("*", this.serveMagicHtml.bind(this));
312
- },
313
-
314
- setup: () => {
315
- if(typeof options.setup === "function")
316
- options.setup(app, this);
317
- }
318
- };
319
-
320
- const defaultFeatures = ["setup", "headers", "middleware"];
321
- if(options.proxy)
322
- defaultFeatures.push("proxy", "middleware");
323
- if(contentBase !== false)
324
- defaultFeatures.push("contentBaseFiles");
325
- if(options.watchContentBase)
326
- defaultFeatures.push("watchContentBase");
327
- if(options.historyApiFallback) {
328
- defaultFeatures.push("historyApiFallback", "middleware");
329
- if(contentBase !== false)
330
- defaultFeatures.push("contentBaseFiles");
331
- }
332
- defaultFeatures.push("magicHtml");
333
- if(contentBase !== false)
334
- defaultFeatures.push("contentBaseIndex");
335
- // compress is placed last and uses unshift so that it will be the first middleware used
336
- if(options.compress)
337
- defaultFeatures.unshift("compress");
338
-
339
- (options.features || defaultFeatures).forEach((feature) => {
340
- features[feature]();
341
- });
342
-
343
- if(options.https) {
344
- // for keep supporting CLI parameters
345
- if(typeof options.https === "boolean") {
346
- options.https = {
347
- key: options.key,
348
- cert: options.cert,
349
- ca: options.ca,
350
- pfx: options.pfx,
351
- passphrase: options.pfxPassphrase
352
- };
353
- }
354
-
355
- // Use built-in self-signed certificate if no certificate was configured
356
- const fakeCert = fs.readFileSync(path.join(__dirname, "../ssl/server.pem"));
357
- options.https.key = options.https.key || fakeCert;
358
- options.https.cert = options.https.cert || fakeCert;
359
-
360
- if(!options.https.spdy) {
361
- options.https.spdy = {
362
- protocols: ["h2", "http/1.1"]
363
- };
364
- }
365
-
366
- this.listeningApp = spdy.createServer(options.https, app);
367
- } else {
368
- this.listeningApp = http.createServer(app);
369
- }
370
-
371
- // Proxy websockets without the initial http request
372
- // https://github.com/chimurai/http-proxy-middleware#external-websocket-upgrade
373
- websocketProxies.forEach(function(wsProxy) {
374
- this.listeningApp.on("upgrade", wsProxy.upgrade);
375
- }, this);
376
- }
377
-
378
- Server.prototype.use = function() {
379
- this.app.use.apply(this.app, arguments);
380
- }
381
-
382
- Server.prototype.setContentHeaders = function(req, res, next) {
383
- if(this.headers) {
384
- for(const name in this.headers) {
385
- res.setHeader(name, this.headers[name]);
386
- }
387
- }
388
-
389
- next();
390
- }
391
-
392
- // delegate listen call and init sockjs
393
- Server.prototype.listen = function() {
394
- const returnValue = this.listeningApp.listen.apply(this.listeningApp, arguments);
395
- const sockServer = sockjs.createServer({
396
- // Use provided up-to-date sockjs-client
397
- sockjs_url: "/__webpack_dev_server__/sockjs.bundle.js",
398
- // Limit useless logs
399
- log: function(severity, line) {
400
- if(severity === "error") {
401
- console.log(line);
402
- }
403
- }
404
- });
405
- sockServer.on("connection", (conn) => {
406
- if(!conn) return;
407
- this.sockets.push(conn);
408
-
409
- conn.on("close", () => {
410
- const connIndex = this.sockets.indexOf(conn);
411
- if(connIndex >= 0) {
412
- this.sockets.splice(connIndex, 1);
413
- }
414
- });
415
-
416
- if(this.clientLogLevel)
417
- this.sockWrite([conn], "log-level", this.clientLogLevel);
418
-
419
- if(this.clientOverlay)
420
- this.sockWrite([conn], "overlay", this.clientOverlay);
421
-
422
- if(this.hot) this.sockWrite([conn], "hot");
423
-
424
- if(!this._stats) return;
425
- this._sendStats([conn], this._stats.toJson(clientStats), true);
426
- });
427
-
428
- sockServer.installHandlers(this.listeningApp, {
429
- prefix: "/sockjs-node"
430
- });
431
- return returnValue;
432
- }
433
-
434
- Server.prototype.close = function(callback) {
435
- this.sockets.forEach((sock) => {
436
- sock.close();
437
- });
438
- this.sockets = [];
439
- this.listeningApp.close(() => {
440
- this.middleware.close(callback);
441
- });
442
-
443
- this.contentBaseWatchers.forEach((watcher) => {
444
- watcher.close();
445
- });
446
- this.contentBaseWatchers = [];
447
- }
448
-
449
- Server.prototype.sockWrite = function(sockets, type, data) {
450
- sockets.forEach((sock) => {
451
- sock.write(JSON.stringify({
452
- type: type,
453
- data: data
454
- }));
455
- });
456
- }
457
-
458
- Server.prototype.serveMagicHtml = function(req, res, next) {
459
- const _path = req.path;
460
- try {
461
- if(!this.middleware.fileSystem.statSync(this.middleware.getFilenameFromUrl(`${_path}.js`)).isFile())
462
- return next();
463
- // Serve a page that executes the javascript
464
- /* eslint-disable quotes */
465
- res.write('<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body><script type="text/javascript" charset="utf-8" src="');
466
- res.write(_path);
467
- res.write('.js');
468
- res.write(req._parsedUrl.search || "");
469
- res.end('"></script></body></html>');
470
- /* eslint-enable quotes */
471
- } catch(e) {
472
- return next();
473
- }
474
- }
475
-
476
- // send stats to a socket or multiple sockets
477
- Server.prototype._sendStats = function(sockets, stats, force) {
478
- if(!force &&
479
- stats &&
480
- (!stats.errors || stats.errors.length === 0) &&
481
- stats.assets &&
482
- stats.assets.every((asset) => !asset.emitted)
483
- )
484
- return this.sockWrite(sockets, "still-ok");
485
- this.sockWrite(sockets, "hash", stats.hash);
486
- if(stats.errors.length > 0)
487
- this.sockWrite(sockets, "errors", stats.errors);
488
- else if(stats.warnings.length > 0)
489
- this.sockWrite(sockets, "warnings", stats.warnings);
490
- else
491
- this.sockWrite(sockets, "ok");
492
- }
493
-
494
- Server.prototype._watch = function(path) {
495
- const watcher = chokidar.watch(path).on("change", () => {
496
- this.sockWrite(this.sockets, "content-changed");
497
- });
498
-
499
- this.contentBaseWatchers.push(watcher);
500
- }
501
-
502
- Server.prototype.invalidate = function() {
503
- if(this.middleware) this.middleware.invalidate();
504
- }
505
-
506
- // Export this logic, so that other implementations, like task-runners can use it
507
- Server.addDevServerEntrypoints = require("./util/addDevServerEntrypoints");
508
-
509
- module.exports = Server;
1
+ "use strict";
2
+
3
+ const chokidar = require("chokidar");
4
+ const compress = require("compression");
5
+ const del = require("del");
6
+ const express = require("express");
7
+ const fs = require("fs");
8
+ const http = require("http");
9
+ const httpProxyMiddleware = require("http-proxy-middleware");
10
+ const serveIndex = require("serve-index");
11
+ const historyApiFallback = require("connect-history-api-fallback");
12
+ const path = require("path");
13
+ const selfsigned = require("selfsigned");
14
+ const sockjs = require("sockjs");
15
+ const spdy = require("spdy");
16
+ const webpack = require("webpack");
17
+ const webpackDevMiddleware = require("webpack-dev-middleware");
18
+
19
+ const OptionsValidationError = require("./OptionsValidationError");
20
+ const optionsSchema = require("./optionsSchema.json");
21
+
22
+ const clientStats = { errorDetails: false };
23
+
24
+ function Server(compiler, options) {
25
+ // Default options
26
+ if(!options) options = {};
27
+
28
+ const validationErrors = webpack.validateSchema(optionsSchema, options);
29
+ if(validationErrors.length) {
30
+ throw new OptionsValidationError(validationErrors);
31
+ }
32
+
33
+ if(options.lazy && !options.filename) {
34
+ throw new Error("'filename' option must be set in lazy mode.");
35
+ }
36
+
37
+ this.hot = options.hot || options.hotOnly;
38
+ this.headers = options.headers;
39
+ this.clientLogLevel = options.clientLogLevel;
40
+ this.clientOverlay = options.overlay;
41
+ this.disableHostCheck = !!options.disableHostCheck;
42
+ this.publicHost = options.public;
43
+ this.allowedHosts = options.allowedHosts;
44
+ this.sockets = [];
45
+ this.contentBaseWatchers = [];
46
+
47
+ // Listening for events
48
+ const invalidPlugin = () => {
49
+ this.sockWrite(this.sockets, "invalid");
50
+ };
51
+ compiler.plugin("compile", invalidPlugin);
52
+ compiler.plugin("invalid", invalidPlugin);
53
+ compiler.plugin("done", (stats) => {
54
+ this._sendStats(this.sockets, stats.toJson(clientStats));
55
+ this._stats = stats;
56
+ });
57
+
58
+ // Init express server
59
+ const app = this.app = new express();
60
+
61
+ app.all("*", (req, res, next) => {
62
+ if(this.checkHost(req.headers))
63
+ return next();
64
+ res.send("Invalid Host header");
65
+ });
66
+
67
+ // middleware for serving webpack bundle
68
+ this.middleware = webpackDevMiddleware(compiler, options);
69
+
70
+ app.get("/__webpack_dev_server__/live.bundle.js", (req, res) => {
71
+ res.setHeader("Content-Type", "application/javascript");
72
+ fs.createReadStream(path.join(__dirname, "..", "client", "live.bundle.js")).pipe(res);
73
+ });
74
+
75
+ app.get("/__webpack_dev_server__/sockjs.bundle.js", (req, res) => {
76
+ res.setHeader("Content-Type", "application/javascript");
77
+ fs.createReadStream(path.join(__dirname, "..", "client", "sockjs.bundle.js")).pipe(res);
78
+ });
79
+
80
+ app.get("/webpack-dev-server.js", (req, res) => {
81
+ res.setHeader("Content-Type", "application/javascript");
82
+ fs.createReadStream(path.join(__dirname, "..", "client", "index.bundle.js")).pipe(res);
83
+ });
84
+
85
+ app.get("/webpack-dev-server/*", (req, res) => {
86
+ res.setHeader("Content-Type", "text/html");
87
+ fs.createReadStream(path.join(__dirname, "..", "client", "live.html")).pipe(res);
88
+ });
89
+
90
+ app.get("/webpack-dev-server", (req, res) => {
91
+ res.setHeader("Content-Type", "text/html");
92
+ /* eslint-disable quotes */
93
+ res.write('<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body>');
94
+ const path = this.middleware.getFilenameFromUrl(options.publicPath || "/");
95
+ const fs = this.middleware.fileSystem;
96
+
97
+ function writeDirectory(baseUrl, basePath) {
98
+ const content = fs.readdirSync(basePath);
99
+ res.write("<ul>");
100
+ content.forEach(function(item) {
101
+ const p = `${basePath}/${item}`;
102
+ if(fs.statSync(p).isFile()) {
103
+ res.write('<li><a href="');
104
+ res.write(baseUrl + item);
105
+ res.write('">');
106
+ res.write(item);
107
+ res.write('</a></li>');
108
+ if(/\.js$/.test(item)) {
109
+ const htmlItem = item.substr(0, item.length - 3);
110
+ res.write('<li><a href="');
111
+ res.write(baseUrl + htmlItem);
112
+ res.write('">');
113
+ res.write(htmlItem);
114
+ res.write('</a> (magic html for ');
115
+ res.write(item);
116
+ res.write(') (<a href="');
117
+ res.write(baseUrl.replace(/(^(https?:\/\/[^\/]+)?\/)/, "$1webpack-dev-server/") + htmlItem);
118
+ res.write('">webpack-dev-server</a>)</li>');
119
+ }
120
+ } else {
121
+ res.write('<li>');
122
+ res.write(item);
123
+ res.write('<br>');
124
+ writeDirectory(`${baseUrl + item}/`, p);
125
+ res.write('</li>');
126
+ }
127
+ });
128
+ res.write("</ul>");
129
+ }
130
+ /* eslint-enable quotes */
131
+ writeDirectory(options.publicPath || "/", path);
132
+ res.end("</body></html>");
133
+ });
134
+
135
+ let contentBase;
136
+ if(options.contentBase !== undefined) {
137
+ contentBase = options.contentBase;
138
+ } else {
139
+ contentBase = process.cwd();
140
+ }
141
+
142
+ // Keep track of websocket proxies for external websocket upgrade.
143
+ const websocketProxies = [];
144
+
145
+ const features = {
146
+ compress() {
147
+ if(options.compress) {
148
+ // Enable gzip compression.
149
+ app.use(compress());
150
+ }
151
+ },
152
+
153
+ proxy() {
154
+ if(options.proxy) {
155
+ /**
156
+ * Assume a proxy configuration specified as:
157
+ * proxy: {
158
+ * 'context': { options }
159
+ * }
160
+ * OR
161
+ * proxy: {
162
+ * 'context': 'target'
163
+ * }
164
+ */
165
+ if(!Array.isArray(options.proxy)) {
166
+ options.proxy = Object.keys(options.proxy).map((context) => {
167
+ let proxyOptions;
168
+ // For backwards compatibility reasons.
169
+ const correctedContext = context.replace(/^\*$/, "**").replace(/\/\*$/, "");
170
+
171
+ if(typeof options.proxy[context] === "string") {
172
+ proxyOptions = {
173
+ context: correctedContext,
174
+ target: options.proxy[context]
175
+ };
176
+ } else {
177
+ proxyOptions = Object.assign({}, options.proxy[context]);
178
+ proxyOptions.context = correctedContext;
179
+ }
180
+ proxyOptions.logLevel = proxyOptions.logLevel || "warn";
181
+
182
+ return proxyOptions;
183
+ });
184
+ }
185
+
186
+ const getProxyMiddleware = (proxyConfig) => {
187
+ const context = proxyConfig.context || proxyConfig.path;
188
+
189
+ // It is possible to use the `bypass` method without a `target`.
190
+ // However, the proxy middleware has no use in this case, and will fail to instantiate.
191
+ if(proxyConfig.target) {
192
+ return httpProxyMiddleware(context, proxyConfig);
193
+ }
194
+ }
195
+
196
+ /**
197
+ * Assume a proxy configuration specified as:
198
+ * proxy: [
199
+ * {
200
+ * context: ...,
201
+ * ...options...
202
+ * },
203
+ * // or:
204
+ * function() {
205
+ * return {
206
+ * context: ...,
207
+ * ...options...
208
+ * };
209
+ * }
210
+ * ]
211
+ */
212
+ options.proxy.forEach((proxyConfigOrCallback) => {
213
+ let proxyConfig;
214
+ let proxyMiddleware;
215
+
216
+ if(typeof proxyConfigOrCallback === "function") {
217
+ proxyConfig = proxyConfigOrCallback();
218
+ } else {
219
+ proxyConfig = proxyConfigOrCallback;
220
+ }
221
+
222
+ proxyMiddleware = getProxyMiddleware(proxyConfig);
223
+ if(proxyConfig.ws) {
224
+ websocketProxies.push(proxyMiddleware);
225
+ }
226
+
227
+ app.use((req, res, next) => {
228
+ if(typeof proxyConfigOrCallback === "function") {
229
+ const newProxyConfig = proxyConfigOrCallback();
230
+ if(newProxyConfig !== proxyConfig) {
231
+ proxyConfig = newProxyConfig;
232
+ proxyMiddleware = getProxyMiddleware(proxyConfig);
233
+ }
234
+ }
235
+ const bypass = typeof proxyConfig.bypass === "function";
236
+ const bypassUrl = bypass && proxyConfig.bypass(req, res, proxyConfig) || false;
237
+
238
+ if(bypassUrl) {
239
+ req.url = bypassUrl;
240
+ next();
241
+ } else if(proxyMiddleware) {
242
+ return proxyMiddleware(req, res, next);
243
+ } else {
244
+ next();
245
+ }
246
+ });
247
+ });
248
+ }
249
+ },
250
+
251
+ historyApiFallback() {
252
+ if(options.historyApiFallback) {
253
+ // Fall back to /index.html if nothing else matches.
254
+ app.use(
255
+ historyApiFallback(typeof options.historyApiFallback === "object" ? options.historyApiFallback : null)
256
+ );
257
+ }
258
+ },
259
+
260
+ contentBaseFiles() {
261
+ if(Array.isArray(contentBase)) {
262
+ contentBase.forEach((item) => {
263
+ app.get("*", express.static(item));
264
+ });
265
+ } else if(/^(https?:)?\/\//.test(contentBase)) {
266
+ console.log("Using a URL as contentBase is deprecated and will be removed in the next major version. Please use the proxy option instead.");
267
+ console.log('proxy: {\n\t"*": "<your current contentBase configuration>"\n}'); // eslint-disable-line quotes
268
+ // Redirect every request to contentBase
269
+ app.get("*", (req, res) => {
270
+ res.writeHead(302, {
271
+ "Location": contentBase + req.path + (req._parsedUrl.search || "")
272
+ });
273
+ res.end();
274
+ });
275
+ } else if(typeof contentBase === "number") {
276
+ console.log("Using a number as contentBase is deprecated and will be removed in the next major version. Please use the proxy option instead.");
277
+ console.log('proxy: {\n\t"*": "//localhost:<your current contentBase configuration>"\n}'); // eslint-disable-line quotes
278
+ // Redirect every request to the port contentBase
279
+ app.get("*", (req, res) => {
280
+ res.writeHead(302, {
281
+ "Location": `//localhost:${contentBase}${req.path}${req._parsedUrl.search || ""}`
282
+ });
283
+ res.end();
284
+ });
285
+ } else {
286
+ // route content request
287
+ app.get("*", express.static(contentBase, options.staticOptions));
288
+ }
289
+ },
290
+
291
+ contentBaseIndex() {
292
+ if(Array.isArray(contentBase)) {
293
+ contentBase.forEach((item) => {
294
+ app.get("*", serveIndex(item));
295
+ });
296
+ } else if(!/^(https?:)?\/\//.test(contentBase) && typeof contentBase !== "number") {
297
+ app.get("*", serveIndex(contentBase));
298
+ }
299
+ },
300
+
301
+ watchContentBase: () => {
302
+ if(/^(https?:)?\/\//.test(contentBase) || typeof contentBase === "number") {
303
+ throw new Error("Watching remote files is not supported.");
304
+ } else if(Array.isArray(contentBase)) {
305
+ contentBase.forEach((item) => {
306
+ this._watch(item);
307
+ });
308
+ } else {
309
+ this._watch(contentBase);
310
+ }
311
+ },
312
+
313
+ middleware: () => {
314
+ // include our middleware to ensure it is able to handle '/index.html' request after redirect
315
+ app.use(this.middleware);
316
+ },
317
+
318
+ headers: () => {
319
+ app.all("*", this.setContentHeaders.bind(this));
320
+ },
321
+
322
+ magicHtml: () => {
323
+ app.get("*", this.serveMagicHtml.bind(this));
324
+ },
325
+
326
+ setup: () => {
327
+ if(typeof options.setup === "function")
328
+ options.setup(app, this);
329
+ }
330
+ };
331
+
332
+ const defaultFeatures = ["setup", "headers", "middleware"];
333
+ if(options.proxy)
334
+ defaultFeatures.push("proxy", "middleware");
335
+ if(contentBase !== false)
336
+ defaultFeatures.push("contentBaseFiles");
337
+ if(options.watchContentBase)
338
+ defaultFeatures.push("watchContentBase");
339
+ if(options.historyApiFallback) {
340
+ defaultFeatures.push("historyApiFallback", "middleware");
341
+ if(contentBase !== false)
342
+ defaultFeatures.push("contentBaseFiles");
343
+ }
344
+ defaultFeatures.push("magicHtml");
345
+ if(contentBase !== false)
346
+ defaultFeatures.push("contentBaseIndex");
347
+ // compress is placed last and uses unshift so that it will be the first middleware used
348
+ if(options.compress)
349
+ defaultFeatures.unshift("compress");
350
+
351
+ (options.features || defaultFeatures).forEach((feature) => {
352
+ features[feature]();
353
+ });
354
+
355
+ if(options.https) {
356
+ // for keep supporting CLI parameters
357
+ if(typeof options.https === "boolean") {
358
+ options.https = {
359
+ key: options.key,
360
+ cert: options.cert,
361
+ ca: options.ca,
362
+ pfx: options.pfx,
363
+ passphrase: options.pfxPassphrase
364
+ };
365
+ }
366
+
367
+ // Use a self-signed certificate if no certificate was configured.
368
+ // Cycle certs every 24 hours
369
+ const certPath = path.join(__dirname, "../ssl/server.pem");
370
+ let certExists = fs.existsSync(certPath);
371
+
372
+ if(certExists) {
373
+ const certStat = fs.statSync(certPath);
374
+ const certTtl = 1000 * 60 * 60 * 24;
375
+ const now = new Date();
376
+
377
+ // cert is more than 30 days old, kill it with fire
378
+ if((now - certStat.ctime) / certTtl > 30) {
379
+ console.log("SSL Certificate is more than 30 days old. Removing.");
380
+ del.sync([certPath], { force: true });
381
+ certExists = false;
382
+ }
383
+ }
384
+
385
+ if(!certExists) {
386
+ console.log("Generating SSL Certificate");
387
+ const attrs = [{ name: "commonName", value: "localhost" }];
388
+ const pems = selfsigned.generate(attrs, {
389
+ algorithm: "sha256",
390
+ days: 30,
391
+ keySize: 2048
392
+ });
393
+
394
+ fs.writeFileSync(certPath, pems.private + pems.cert, { encoding: "utf-8" });
395
+ }
396
+
397
+ const fakeCert = fs.readFileSync(certPath);
398
+ options.https.key = options.https.key || fakeCert;
399
+ options.https.cert = options.https.cert || fakeCert;
400
+
401
+ if(!options.https.spdy) {
402
+ options.https.spdy = {
403
+ protocols: ["h2", "http/1.1"]
404
+ };
405
+ }
406
+
407
+ this.listeningApp = spdy.createServer(options.https, app);
408
+ } else {
409
+ this.listeningApp = http.createServer(app);
410
+ }
411
+
412
+ // Proxy websockets without the initial http request
413
+ // https://github.com/chimurai/http-proxy-middleware#external-websocket-upgrade
414
+ websocketProxies.forEach(function(wsProxy) {
415
+ this.listeningApp.on("upgrade", wsProxy.upgrade);
416
+ }, this);
417
+ }
418
+
419
+ Server.prototype.use = function() {
420
+ this.app.use.apply(this.app, arguments);
421
+ }
422
+
423
+ Server.prototype.setContentHeaders = function(req, res, next) {
424
+ if(this.headers) {
425
+ for(const name in this.headers) {
426
+ res.setHeader(name, this.headers[name]);
427
+ }
428
+ }
429
+
430
+ next();
431
+ }
432
+
433
+ Server.prototype.checkHost = function(headers) {
434
+ // allow user to opt-out this security check, at own risk
435
+ if(this.disableHostCheck) return true;
436
+
437
+ // get the Host header and extract hostname
438
+ // we don't care about port not matching
439
+ const hostHeader = headers.host;
440
+ if(!hostHeader) return false;
441
+ const idx = hostHeader.indexOf(":");
442
+ const hostname = idx >= 0 ? hostHeader.substr(0, idx) : hostHeader;
443
+
444
+ // always allow localhost host, for convience
445
+ if(hostname === "127.0.0.1" || hostname === "localhost") return true;
446
+
447
+ // allow if hostname is in allowedHosts
448
+ if(this.allowedHosts && this.allowedHosts.length) {
449
+ for(let hostIdx = 0; hostIdx < this.allowedHosts.length; hostIdx++) {
450
+ const allowedHost = this.allowedHosts[hostIdx];
451
+ if(allowedHost === hostname) return true;
452
+
453
+ // support "." as a subdomain wildcard
454
+ // e.g. ".example.com" will allow "example.com", "www.example.com", "subdomain.example.com", etc
455
+ if(allowedHost[0] === ".") {
456
+ if(hostname === allowedHost.substring(1)) return true; // "example.com"
457
+ if(hostname.endsWith(allowedHost)) return true; // "*.example.com"
458
+ }
459
+ }
460
+ }
461
+
462
+ // allow hostname of listening adress
463
+ if(hostname === this.listenHostname) return true;
464
+
465
+ // also allow public hostname if provided
466
+ if(typeof this.publicHost === "string") {
467
+ const idxPublic = this.publicHost.indexOf(":");
468
+ const publicHostname = idxPublic >= 0 ? this.publicHost.substr(0, idxPublic) : this.publicHost;
469
+ if(hostname === publicHostname) return true;
470
+ }
471
+
472
+ // disallow
473
+ return false;
474
+ }
475
+
476
+ // delegate listen call and init sockjs
477
+ Server.prototype.listen = function(port, hostname) {
478
+ this.listenHostname = hostname;
479
+ const returnValue = this.listeningApp.listen.apply(this.listeningApp, arguments);
480
+ const sockServer = sockjs.createServer({
481
+ // Use provided up-to-date sockjs-client
482
+ sockjs_url: "/__webpack_dev_server__/sockjs.bundle.js",
483
+ // Limit useless logs
484
+ log: function(severity, line) {
485
+ if(severity === "error") {
486
+ console.log(line);
487
+ }
488
+ }
489
+ });
490
+ sockServer.on("connection", (conn) => {
491
+ if(!conn) return;
492
+ if(!this.checkHost(conn.headers)) {
493
+ this.sockWrite([conn], "error", "Invalid Host header");
494
+ conn.close();
495
+ return;
496
+ }
497
+ this.sockets.push(conn);
498
+
499
+ conn.on("close", () => {
500
+ const connIndex = this.sockets.indexOf(conn);
501
+ if(connIndex >= 0) {
502
+ this.sockets.splice(connIndex, 1);
503
+ }
504
+ });
505
+
506
+ if(this.clientLogLevel)
507
+ this.sockWrite([conn], "log-level", this.clientLogLevel);
508
+
509
+ if(this.clientOverlay)
510
+ this.sockWrite([conn], "overlay", this.clientOverlay);
511
+
512
+ if(this.hot) this.sockWrite([conn], "hot");
513
+
514
+ if(!this._stats) return;
515
+ this._sendStats([conn], this._stats.toJson(clientStats), true);
516
+ });
517
+
518
+ sockServer.installHandlers(this.listeningApp, {
519
+ prefix: "/sockjs-node"
520
+ });
521
+ return returnValue;
522
+ }
523
+
524
+ Server.prototype.close = function(callback) {
525
+ this.sockets.forEach((sock) => {
526
+ sock.close();
527
+ });
528
+ this.sockets = [];
529
+ this.listeningApp.close(() => {
530
+ this.middleware.close(callback);
531
+ });
532
+
533
+ this.contentBaseWatchers.forEach((watcher) => {
534
+ watcher.close();
535
+ });
536
+ this.contentBaseWatchers = [];
537
+ }
538
+
539
+ Server.prototype.sockWrite = function(sockets, type, data) {
540
+ sockets.forEach((sock) => {
541
+ sock.write(JSON.stringify({
542
+ type: type,
543
+ data: data
544
+ }));
545
+ });
546
+ }
547
+
548
+ Server.prototype.serveMagicHtml = function(req, res, next) {
549
+ const _path = req.path;
550
+ try {
551
+ if(!this.middleware.fileSystem.statSync(this.middleware.getFilenameFromUrl(`${_path}.js`)).isFile())
552
+ return next();
553
+ // Serve a page that executes the javascript
554
+ /* eslint-disable quotes */
555
+ res.write('<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body><script type="text/javascript" charset="utf-8" src="');
556
+ res.write(_path);
557
+ res.write('.js');
558
+ res.write(req._parsedUrl.search || "");
559
+ res.end('"></script></body></html>');
560
+ /* eslint-enable quotes */
561
+ } catch(e) {
562
+ return next();
563
+ }
564
+ }
565
+
566
+ // send stats to a socket or multiple sockets
567
+ Server.prototype._sendStats = function(sockets, stats, force) {
568
+ if(!force &&
569
+ stats &&
570
+ (!stats.errors || stats.errors.length === 0) &&
571
+ stats.assets &&
572
+ stats.assets.every((asset) => !asset.emitted)
573
+ )
574
+ return this.sockWrite(sockets, "still-ok");
575
+ this.sockWrite(sockets, "hash", stats.hash);
576
+ if(stats.errors.length > 0)
577
+ this.sockWrite(sockets, "errors", stats.errors);
578
+ else if(stats.warnings.length > 0)
579
+ this.sockWrite(sockets, "warnings", stats.warnings);
580
+ else
581
+ this.sockWrite(sockets, "ok");
582
+ }
583
+
584
+ Server.prototype._watch = function(path) {
585
+ const watcher = chokidar.watch(path).on("change", () => {
586
+ this.sockWrite(this.sockets, "content-changed");
587
+ });
588
+
589
+ this.contentBaseWatchers.push(watcher);
590
+ }
591
+
592
+ Server.prototype.invalidate = function() {
593
+ if(this.middleware) this.middleware.invalidate();
594
+ }
595
+
596
+ // Export this logic, so that other implementations, like task-runners can use it
597
+ Server.addDevServerEntrypoints = require("./util/addDevServerEntrypoints");
598
+
599
+ module.exports = Server;