Server.js 29.8 KB
Newer Older
liang ce committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
'use strict';

/* eslint-disable
  import/order,
  no-shadow,
  no-undefined,
  func-names
*/
const fs = require('fs');
const path = require('path');

const ip = require('ip');
const tls = require('tls');
const url = require('url');
const http = require('http');
const https = require('https');
const sockjs = require('sockjs');

const semver = require('semver');

const killable = require('killable');

const del = require('del');
const chokidar = require('chokidar');

const express = require('express');

const compress = require('compression');
const serveIndex = require('serve-index');
const httpProxyMiddleware = require('http-proxy-middleware');
const historyApiFallback = require('connect-history-api-fallback');

const webpack = require('webpack');
const webpackDevMiddleware = require('webpack-dev-middleware');

const updateCompiler = require('./utils/updateCompiler');
const createLogger = require('./utils/createLogger');
const createCertificate = require('./utils/createCertificate');

const validateOptions = require('schema-utils');
const schema = require('./options.json');

// 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;
    }
  };
}

// Workaround for node ^8.6.0, ^9.0.0
// DEFAULT_ECDH_CURVE is default to prime256v1 in these version
// breaking connection when certificate is not signed with prime256v1
// change it to auto allows OpenSSL to select the curve automatically
// See https://github.com/nodejs/node/issues/16196 for more infomation
if (semver.satisfies(process.version, '8.6.0 - 9')) {
  tls.DEFAULT_ECDH_CURVE = 'auto';
}

class Server {
  static get DEFAULT_STATS() {
    return {
      all: false,
      hash: true,
      assets: true,
      warnings: true,
      errors: true,
      errorDetails: false,
    };
  }

  constructor(compiler, options = {}, _log) {
    this.log = _log || createLogger(options);

    validateOptions(schema, options, 'webpack Dev Server');

    if (options.lazy && !options.filename) {
      throw new Error("'filename' option must be set in lazy mode.");
    }

    // if the user enables http2, we can safely enable https
    if (options.http2 && !options.https) {
      options.https = true;
    }

    updateCompiler(compiler, options);

    this.originalStats =
      options.stats && Object.keys(options.stats).length ? options.stats : {};

    this.hot = options.hot || options.hotOnly;
    this.headers = options.headers;
    this.progress = options.progress;

    this.serveIndex = options.serveIndex;

    this.clientOverlay = options.overlay;
    this.clientLogLevel = options.clientLogLevel;

    this.publicHost = options.public;
    this.allowedHosts = options.allowedHosts;
    this.disableHostCheck = !!options.disableHostCheck;

    this.sockets = [];

    this.watchOptions = options.watchOptions || {};
    this.contentBaseWatchers = [];
    // Replace leading and trailing slashes to normalize path
    this.sockPath = `/${
      options.sockPath
        ? options.sockPath.replace(/^\/|\/$/g, '')
        : 'sockjs-node'
    }`;

    // Listening for events
    const invalidPlugin = () => {
      this.sockWrite(this.sockets, 'invalid');
    };

    if (this.progress) {
      const progressPlugin = new webpack.ProgressPlugin(
        (percent, msg, addInfo) => {
          percent = Math.floor(percent * 100);

          if (percent === 100) {
            msg = 'Compilation completed';
          }

          if (addInfo) {
            msg = `${msg} (${addInfo})`;
          }

          this.sockWrite(this.sockets, 'progress-update', { percent, msg });
        }
      );

      progressPlugin.apply(compiler);
    }

    const addHooks = (compiler) => {
      const { compile, invalid, done } = compiler.hooks;

      compile.tap('webpack-dev-server', invalidPlugin);
      invalid.tap('webpack-dev-server', invalidPlugin);
      done.tap('webpack-dev-server', (stats) => {
        this._sendStats(this.sockets, this.getStats(stats));
        this._stats = stats;
      });
    };

    if (compiler.compilers) {
      compiler.compilers.forEach(addHooks);
    } else {
      addHooks(compiler);
    }

    // Init express server
    // eslint-disable-next-line
    const app = (this.app = new express());

    // ref: https://github.com/webpack/webpack-dev-server/issues/1575
    // ref: https://github.com/webpack/webpack-dev-server/issues/1724
    // remove this when send@^0.16.3
    if (express.static && express.static.mime && express.static.mime.types) {
      express.static.mime.types.wasm = 'application/wasm';
    }

    app.all('*', (req, res, next) => {
      if (this.checkHost(req.headers)) {
        return next();
      }

      res.send('Invalid Host header');
    });

    const wdmOptions = { logLevel: this.log.options.level };

    // middleware for serving webpack bundle
    this.middleware = webpackDevMiddleware(
      compiler,
      Object.assign({}, options, wdmOptions)
    );

    app.get('/__webpack_dev_server__/live.bundle.js', (req, res) => {
      res.setHeader('Content-Type', 'application/javascript');

      fs.createReadStream(
        path.join(__dirname, '..', 'client', 'live.bundle.js')
      ).pipe(res);
    });

    app.get('/__webpack_dev_server__/sockjs.bundle.js', (req, res) => {
      res.setHeader('Content-Type', 'application/javascript');

      fs.createReadStream(
        path.join(__dirname, '..', 'client', 'sockjs.bundle.js')
      ).pipe(res);
    });

    app.get('/webpack-dev-server.js', (req, res) => {
      res.setHeader('Content-Type', 'application/javascript');

      fs.createReadStream(
        path.join(__dirname, '..', 'client', 'index.bundle.js')
      ).pipe(res);
    });

    app.get('/webpack-dev-server/*', (req, res) => {
      res.setHeader('Content-Type', 'text/html');

      fs.createReadStream(
        path.join(__dirname, '..', 'client', 'live.html')
      ).pipe(res);
    });

    app.get('/webpack-dev-server', (req, res) => {
      res.setHeader('Content-Type', 'text/html');

      res.write(
        '<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body>'
      );

      const outputPath = this.middleware.getFilenameFromUrl(
        options.publicPath || '/'
      );

      const filesystem = this.middleware.fileSystem;

      function writeDirectory(baseUrl, basePath) {
        const content = filesystem.readdirSync(basePath);

        res.write('<ul>');

        content.forEach((item) => {
          const p = `${basePath}/${item}`;

          if (filesystem.statSync(p).isFile()) {
            res.write('<li><a href="');
            res.write(baseUrl + item);
            res.write('">');
            res.write(item);
            res.write('</a></li>');

            if (/\.js$/.test(item)) {
              const html = item.substr(0, item.length - 3);

              res.write('<li><a href="');
              res.write(baseUrl + html);
              res.write('">');
              res.write(html);
              res.write('</a> (magic html for ');
              res.write(item);
              res.write(') (<a href="');
              res.write(
                baseUrl.replace(
                  // eslint-disable-next-line
                  /(^(https?:\/\/[^\/]+)?\/)/,
                  '$1webpack-dev-server/'
                ) + html
              );
              res.write('">webpack-dev-server</a>)</li>');
            }
          } else {
            res.write('<li>');
            res.write(item);
            res.write('<br>');

            writeDirectory(`${baseUrl + item}/`, p);

            res.write('</li>');
          }
        });

        res.write('</ul>');
      }

      writeDirectory(options.publicPath || '/', outputPath);

      res.end('</body></html>');
    });

    let contentBase;

    if (options.contentBase !== undefined) {
      contentBase = options.contentBase;
    } else {
      contentBase = process.cwd();
    }

    // Keep track of websocket proxies for external websocket upgrade.
    const websocketProxies = [];

    const features = {
      compress: () => {
        if (options.compress) {
          // Enable gzip compression.
          app.use(compress());
        }
      },
      proxy: () => {
        if (options.proxy) {
          /**
           * Assume a proxy configuration specified as:
           * proxy: {
           *   'context': { options }
           * }
           * OR
           * proxy: {
           *   'context': 'target'
           * }
           */
          if (!Array.isArray(options.proxy)) {
            if (Object.prototype.hasOwnProperty.call(options.proxy, 'target')) {
              options.proxy = [options.proxy];
            } else {
              options.proxy = Object.keys(options.proxy).map((context) => {
                let proxyOptions;
                // For backwards compatibility reasons.
                const correctedContext = context
                  .replace(/^\*$/, '**')
                  .replace(/\/\*$/, '');

                if (typeof options.proxy[context] === 'string') {
                  proxyOptions = {
                    context: correctedContext,
                    target: options.proxy[context],
                  };
                } else {
                  proxyOptions = Object.assign({}, options.proxy[context]);
                  proxyOptions.context = correctedContext;
                }

                proxyOptions.logLevel = proxyOptions.logLevel || 'warn';

                return proxyOptions;
              });
            }
          }

          const getProxyMiddleware = (proxyConfig) => {
            const context = proxyConfig.context || proxyConfig.path;
            // It is possible to use the `bypass` method without a `target`.
            // However, the proxy middleware has no use in this case, and will fail to instantiate.
            if (proxyConfig.target) {
              return httpProxyMiddleware(context, proxyConfig);
            }
          };
          /**
           * Assume a proxy configuration specified as:
           * proxy: [
           *   {
           *     context: ...,
           *     ...options...
           *   },
           *   // or:
           *   function() {
           *     return {
           *       context: ...,
           *       ...options...
           *     };
           *   }
           * ]
           */
          options.proxy.forEach((proxyConfigOrCallback) => {
            let proxyConfig;
            let proxyMiddleware;

            if (typeof proxyConfigOrCallback === 'function') {
              proxyConfig = proxyConfigOrCallback();
            } else {
              proxyConfig = proxyConfigOrCallback;
            }

            proxyMiddleware = getProxyMiddleware(proxyConfig);

            if (proxyConfig.ws) {
              websocketProxies.push(proxyMiddleware);
            }

            app.use((req, res, next) => {
              if (typeof proxyConfigOrCallback === 'function') {
                const newProxyConfig = proxyConfigOrCallback();

                if (newProxyConfig !== proxyConfig) {
                  proxyConfig = newProxyConfig;
                  proxyMiddleware = getProxyMiddleware(proxyConfig);
                }
              }

              // - Check if we have a bypass function defined
              // - In case the bypass function is defined we'll retrieve the
              // bypassUrl from it otherwise byPassUrl would be null
              const isByPassFuncDefined =
                typeof proxyConfig.bypass === 'function';
              const bypassUrl = isByPassFuncDefined
                ? proxyConfig.bypass(req, res, proxyConfig)
                : null;

              if (typeof bypassUrl === 'boolean') {
                // skip the proxy
                req.url = null;
                next();
              } else if (typeof bypassUrl === 'string') {
                // byPass to that url
                req.url = bypassUrl;
                next();
              } else if (proxyMiddleware) {
                return proxyMiddleware(req, res, next);
              } else {
                next();
              }
            });
          });
        }
      },
      historyApiFallback: () => {
        if (options.historyApiFallback) {
          const fallback =
            typeof options.historyApiFallback === 'object'
              ? options.historyApiFallback
              : null;
          // Fall back to /index.html if nothing else matches.
          app.use(historyApiFallback(fallback));
        }
      },
      contentBaseFiles: () => {
        if (Array.isArray(contentBase)) {
          contentBase.forEach((item) => {
            app.get('*', express.static(item));
          });
        } else if (/^(https?:)?\/\//.test(contentBase)) {
          this.log.warn(
            'Using a URL as contentBase is deprecated and will be removed in the next major version. Please use the proxy option instead.'
          );

          this.log.warn(
            'proxy: {\n\t"*": "<your current contentBase configuration>"\n}'
          );
          // Redirect every request to contentBase
          app.get('*', (req, res) => {
            res.writeHead(302, {
              Location: contentBase + req.path + (req._parsedUrl.search || ''),
            });

            res.end();
          });
        } else if (typeof contentBase === 'number') {
          this.log.warn(
            'Using a number as contentBase is deprecated and will be removed in the next major version. Please use the proxy option instead.'
          );

          this.log.warn(
            'proxy: {\n\t"*": "//localhost:<your current contentBase configuration>"\n}'
          );
          // Redirect every request to the port contentBase
          app.get('*', (req, res) => {
            res.writeHead(302, {
              Location: `//localhost:${contentBase}${req.path}${req._parsedUrl
                .search || ''}`,
            });

            res.end();
          });
        } else {
          // route content request
          app.get('*', express.static(contentBase, options.staticOptions));
        }
      },
      contentBaseIndex: () => {
        if (Array.isArray(contentBase)) {
          contentBase.forEach((item) => {
            app.get('*', serveIndex(item));
          });
        } else if (
          !/^(https?:)?\/\//.test(contentBase) &&
          typeof contentBase !== 'number'
        ) {
          app.get('*', serveIndex(contentBase));
        }
      },
      watchContentBase: () => {
        if (
          /^(https?:)?\/\//.test(contentBase) ||
          typeof contentBase === 'number'
        ) {
          throw new Error('Watching remote files is not supported.');
        } else if (Array.isArray(contentBase)) {
          contentBase.forEach((item) => {
            this._watch(item);
          });
        } else {
          this._watch(contentBase);
        }
      },
      before: () => {
        if (typeof options.before === 'function') {
          options.before(app, this, compiler);
        }
      },
      middleware: () => {
        // include our middleware to ensure
        // it is able to handle '/index.html' request after redirect
        app.use(this.middleware);
      },
      after: () => {
        if (typeof options.after === 'function') {
          options.after(app, this, compiler);
        }
      },
      headers: () => {
        app.all('*', this.setContentHeaders.bind(this));
      },
      magicHtml: () => {
        app.get('*', this.serveMagicHtml.bind(this));
      },
      setup: () => {
        if (typeof options.setup === 'function') {
          this.log.warn(
            'The `setup` option is deprecated and will be removed in v4. Please update your config to use `before`'
          );

          options.setup(app, this);
        }
      },
    };

    const defaultFeatures = ['setup', 'before', 'headers', 'middleware'];

    if (options.proxy) {
      defaultFeatures.push('proxy', 'middleware');
    }

    if (contentBase !== false) {
      defaultFeatures.push('contentBaseFiles');
    }

    if (options.watchContentBase) {
      defaultFeatures.push('watchContentBase');
    }

    if (options.historyApiFallback) {
      defaultFeatures.push('historyApiFallback', 'middleware');

      if (contentBase !== false) {
        defaultFeatures.push('contentBaseFiles');
      }
    }

    defaultFeatures.push('magicHtml');

    // checking if it's set to true or not set (Default : undefined => true)
    this.serveIndex = this.serveIndex || this.serveIndex === undefined;

    const shouldHandleServeIndex = contentBase && this.serveIndex;

    if (shouldHandleServeIndex) {
      defaultFeatures.push('contentBaseIndex');
    }

    // compress is placed last and uses unshift so that it will be the first middleware used
    if (options.compress) {
      defaultFeatures.unshift('compress');
    }

    if (options.after) {
      defaultFeatures.push('after');
    }

    (options.features || defaultFeatures).forEach((feature) => {
      features[feature]();
    });

    if (options.https) {
      // for keep supporting CLI parameters
      if (typeof options.https === 'boolean') {
        options.https = {
          ca: options.ca,
          pfx: options.pfx,
          key: options.key,
          cert: options.cert,
          passphrase: options.pfxPassphrase,
          requestCert: options.requestCert || false,
        };
      }

      for (const property of ['ca', 'pfx', 'key', 'cert']) {
        const value = options.https[property];
        const isBuffer = value instanceof Buffer;

        if (value && !isBuffer) {
          let stats = null;

          try {
            stats = fs.lstatSync(value).isFile();
          } catch (error) {
            // ignore error
          }

          if (stats) {
            // It is file
            options.https[property] = fs.readFileSync(path.resolve(value));
          } else {
            options.https[property] = value;
          }
        }
      }

      let fakeCert;

      if (!options.https.key || !options.https.cert) {
        // Use a self-signed certificate if no certificate was configured.
        // Cycle certs every 24 hours
        const certPath = path.join(__dirname, '../ssl/server.pem');

        let certExists = fs.existsSync(certPath);

        if (certExists) {
          const certTtl = 1000 * 60 * 60 * 24;
          const certStat = fs.statSync(certPath);

          const now = new Date();

          // cert is more than 30 days old, kill it with fire
          if ((now - certStat.ctime) / certTtl > 30) {
            this.log.info(
              'SSL Certificate is more than 30 days old. Removing.'
            );

            del.sync([certPath], { force: true });

            certExists = false;
          }
        }

        if (!certExists) {
          this.log.info('Generating SSL Certificate');

          const attrs = [{ name: 'commonName', value: 'localhost' }];

          const pems = createCertificate(attrs);

          fs.writeFileSync(certPath, pems.private + pems.cert, {
            encoding: 'utf8',
          });
        }

        fakeCert = fs.readFileSync(certPath);
      }

      options.https.key = options.https.key || fakeCert;
      options.https.cert = options.https.cert || fakeCert;

      // Only prevent HTTP/2 if http2 is explicitly set to false
      const isHttp2 = options.http2 !== false;

      // note that options.spdy never existed. The user was able
      // to set options.https.spdy before, though it was not in the
      // docs. Keep options.https.spdy if the user sets it for
      // backwards compatability, but log a deprecation warning.
      if (options.https.spdy) {
        // for backwards compatability: if options.https.spdy was passed in before,
        // it was not altered in any way
        this.log.warn(
          'Providing custom spdy server options is deprecated and will be removed in the next major version.'
        );
      } else {
        // if the normal https server gets this option, it will not affect it.
        options.https.spdy = {
          protocols: ['h2', 'http/1.1'],
        };
      }

      // `spdy` is effectively unmaintained, and as a consequence of an
      // implementation that extensively relies on Node’s non-public APIs, broken
      // on Node 10 and above. In those cases, only https will be used for now.
      // Once express supports Node's built-in HTTP/2 support, migrating over to
      // that should be the best way to go.
      // The relevant issues are:
      // - https://github.com/nodejs/node/issues/21665
      // - https://github.com/webpack/webpack-dev-server/issues/1449
      // - https://github.com/expressjs/express/issues/3388
      if (semver.gte(process.version, '10.0.0') || !isHttp2) {
        if (options.http2) {
          // the user explicitly requested http2 but is not getting it because
          // of the node version.
          this.log.warn(
            'HTTP/2 is currently unsupported for Node 10.0.0 and above, but will be supported once Express supports it'
          );
        }
        this.listeningApp = https.createServer(options.https, app);
      } else {
        /* eslint-disable global-require */
        // The relevant issues are:
        // https://github.com/spdy-http2/node-spdy/issues/350
        // https://github.com/webpack/webpack-dev-server/issues/1592
        this.listeningApp = require('spdy').createServer(options.https, app);
        /* eslint-enable global-require */
      }
    } else {
      this.listeningApp = http.createServer(app);
    }

    killable(this.listeningApp);

    // Proxy websockets without the initial http request
    // https://github.com/chimurai/http-proxy-middleware#external-websocket-upgrade
    websocketProxies.forEach(function(wsProxy) {
      this.listeningApp.on('upgrade', wsProxy.upgrade);
    }, this);
  }

  getStats(statsObj) {
    const stats = Server.DEFAULT_STATS;

    if (this.originalStats.warningsFilter) {
      stats.warningsFilter = this.originalStats.warningsFilter;
    }

    return statsObj.toJson(stats);
  }

  use() {
    // eslint-disable-next-line
    this.app.use.apply(this.app, arguments);
  }

  setContentHeaders(req, res, next) {
    if (this.headers) {
      // eslint-disable-next-line
      for (const name in this.headers) {
        // eslint-disable-line
        res.setHeader(name, this.headers[name]);
      }
    }

    next();
  }

  checkHost(headers) {
    return this.checkHeaders(headers, 'host');
  }

  checkOrigin(headers) {
    return this.checkHeaders(headers, 'origin');
  }

  checkHeaders(headers, headerToCheck) {
    // allow user to opt-out this security check, at own risk
    if (this.disableHostCheck) {
      return true;
    }

    if (!headerToCheck) {
      headerToCheck = 'host';
    }

    // get the Host header and extract hostname
    // we don't care about port not matching
    const hostHeader = headers[headerToCheck];

    if (!hostHeader) {
      return false;
    }

    // use the node url-parser to retrieve the hostname from the host-header.
    const hostname = url.parse(
      // if hostHeader doesn't have scheme, add // for parsing.
      /^(.+:)?\/\//.test(hostHeader) ? hostHeader : `//${hostHeader}`,
      false,
      true
    ).hostname;
    // always allow requests with explicit IPv4 or IPv6-address.
    // A note on IPv6 addresses:
    // hostHeader will always contain the brackets denoting
    // an IPv6-address in URLs,
    // these are removed from the hostname in url.parse(),
    // so we have the pure IPv6-address in hostname.
    if (ip.isV4Format(hostname) || ip.isV6Format(hostname)) {
      return true;
    }
    // always allow localhost host, for convience
    if (hostname === 'localhost') {
      return true;
    }
    // allow if hostname is in allowedHosts
    if (this.allowedHosts && this.allowedHosts.length) {
      for (let hostIdx = 0; hostIdx < this.allowedHosts.length; hostIdx++) {
        const allowedHost = this.allowedHosts[hostIdx];

        if (allowedHost === hostname) {
          return true;
        }

        // support "." as a subdomain wildcard
        // e.g. ".example.com" will allow "example.com", "www.example.com", "subdomain.example.com", etc
        if (allowedHost[0] === '.') {
          // "example.com"
          if (hostname === allowedHost.substring(1)) {
            return true;
          }
          // "*.example.com"
          if (hostname.endsWith(allowedHost)) {
            return true;
          }
        }
      }
    }

    // allow hostname of listening adress
    if (hostname === this.hostname) {
      return true;
    }

    // also allow public hostname if provided
    if (typeof this.publicHost === 'string') {
      const idxPublic = this.publicHost.indexOf(':');

      const publicHostname =
        idxPublic >= 0 ? this.publicHost.substr(0, idxPublic) : this.publicHost;

      if (hostname === publicHostname) {
        return true;
      }
    }

    // disallow
    return false;
  }

  // delegate listen call and init sockjs
  listen(port, hostname, fn) {
    this.hostname = hostname;

    return this.listeningApp.listen(port, hostname, (err) => {
      const 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.log.error(line);
          } else {
            this.log.debug(line);
          }
        },
      });

      socket.on('connection', (connection) => {
        if (!connection) {
          return;
        }

        if (
          !this.checkHost(connection.headers) ||
          !this.checkOrigin(connection.headers)
        ) {
          this.sockWrite([connection], 'error', 'Invalid Host/Origin header');

          connection.close();

          return;
        }

        this.sockets.push(connection);

        connection.on('close', () => {
          const idx = this.sockets.indexOf(connection);

          if (idx >= 0) {
            this.sockets.splice(idx, 1);
          }
        });

        if (this.hot) {
          this.sockWrite([connection], 'hot');
        }

        if (this.progress) {
          this.sockWrite([connection], 'progress', this.progress);
        }

        if (this.clientOverlay) {
          this.sockWrite([connection], 'overlay', this.clientOverlay);
        }

        if (this.clientLogLevel) {
          this.sockWrite([connection], 'log-level', this.clientLogLevel);
        }

        if (!this._stats) {
          return;
        }

        this._sendStats([connection], this.getStats(this._stats), true);
      });

      socket.installHandlers(this.listeningApp, {
        prefix: this.sockPath,
      });

      if (fn) {
        fn.call(this.listeningApp, err);
      }
    });
  }

  close(cb) {
    this.sockets.forEach((socket) => {
      socket.close();
    });

    this.sockets = [];

    this.contentBaseWatchers.forEach((watcher) => {
      watcher.close();
    });

    this.contentBaseWatchers = [];

    this.listeningApp.kill(() => {
      this.middleware.close(cb);
    });
  }

  // eslint-disable-next-line
  sockWrite(sockets, type, data) {
    sockets.forEach((socket) => {
      socket.write(JSON.stringify({ type, data }));
    });
  }

  serveMagicHtml(req, res, next) {
    const _path = req.path;

    try {
      const isFile = this.middleware.fileSystem
        .statSync(this.middleware.getFilenameFromUrl(`${_path}.js`))
        .isFile();

      if (!isFile) {
        return next();
      }
      // Serve a page that executes the javascript
      res.write(
        '<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body><script type="text/javascript" charset="utf-8" src="'
      );
      res.write(_path);
      res.write('.js');
      res.write(req._parsedUrl.search || '');

      res.end('"></script></body></html>');
    } catch (err) {
      return next();
    }
  }

  // send stats to a socket or multiple sockets
  _sendStats(sockets, stats, force) {
    if (
      !force &&
      stats &&
      (!stats.errors || stats.errors.length === 0) &&
      stats.assets &&
      stats.assets.every((asset) => !asset.emitted)
    ) {
      return this.sockWrite(sockets, 'still-ok');
    }

    this.sockWrite(sockets, 'hash', stats.hash);

    if (stats.errors.length > 0) {
      this.sockWrite(sockets, 'errors', stats.errors);
    } else if (stats.warnings.length > 0) {
      this.sockWrite(sockets, 'warnings', stats.warnings);
    } else {
      this.sockWrite(sockets, 'ok');
    }
  }

  _watch(watchPath) {
    // duplicate the same massaging of options that watchpack performs
    // https://github.com/webpack/watchpack/blob/master/lib/DirectoryWatcher.js#L49
    // this isn't an elegant solution, but we'll improve it in the future
    const usePolling = this.watchOptions.poll ? true : undefined;
    const interval =
      typeof this.watchOptions.poll === 'number'
        ? this.watchOptions.poll
        : undefined;

    const options = {
      ignoreInitial: true,
      persistent: true,
      followSymlinks: false,
      atomic: false,
      alwaysStat: true,
      ignorePermissionErrors: true,
      ignored: this.watchOptions.ignored,
      usePolling,
      interval,
    };

    const watcher = chokidar.watch(watchPath, options);

    watcher.on('change', () => {
      this.sockWrite(this.sockets, 'content-changed');
    });

    this.contentBaseWatchers.push(watcher);
  }

  invalidate() {
    if (this.middleware) {
      this.middleware.invalidate();
    }
  }
}

// Export this logic,
// so that other implementations,
// like task-runners can use it
Server.addDevServerEntrypoints = require('./utils/addEntries');

module.exports = Server;