webpackDevServer.config.js 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. // @remove-on-eject-begin
  2. /**
  3. * Copyright (c) 2015-present, Facebook, Inc.
  4. *
  5. * This source code is licensed under the MIT license found in the
  6. * LICENSE file in the root directory of this source tree.
  7. */
  8. // @remove-on-eject-end
  9. 'use strict';
  10. const fs = require('fs');
  11. const errorOverlayMiddleware = require('react-dev-utils/errorOverlayMiddleware');
  12. const evalSourceMapMiddleware = require('react-dev-utils/evalSourceMapMiddleware');
  13. const noopServiceWorkerMiddleware = require('react-dev-utils/noopServiceWorkerMiddleware');
  14. const ignoredFiles = require('react-dev-utils/ignoredFiles');
  15. const redirectServedPath = require('react-dev-utils/redirectServedPathMiddleware');
  16. const paths = require('./paths');
  17. const getHttpsConfig = require('./getHttpsConfig');
  18. const host = process.env.HOST || '0.0.0.0';
  19. const sockHost = process.env.WDS_SOCKET_HOST;
  20. const sockPath = process.env.WDS_SOCKET_PATH; // default: '/sockjs-node'
  21. const sockPort = process.env.WDS_SOCKET_PORT;
  22. module.exports = function (proxy, allowedHost) {
  23. return {
  24. // WebpackDevServer 2.4.3 introduced a security fix that prevents remote
  25. // websites from potentially accessing local content through DNS rebinding:
  26. // https://github.com/webpack/webpack-dev-server/issues/887
  27. // https://medium.com/webpack/webpack-dev-server-middleware-security-issues-1489d950874a
  28. // However, it made several existing use cases such as development in cloud
  29. // environment or subdomains in development significantly more complicated:
  30. // https://github.com/facebook/create-react-app/issues/2271
  31. // https://github.com/facebook/create-react-app/issues/2233
  32. // While we're investigating better solutions, for now we will take a
  33. // compromise. Since our WDS configuration only serves files in the `public`
  34. // folder we won't consider accessing them a vulnerability. However, if you
  35. // use the `proxy` feature, it gets more dangerous because it can expose
  36. // remote code execution vulnerabilities in backends like Django and Rails.
  37. // So we will disable the host check normally, but enable it if you have
  38. // specified the `proxy` setting. Finally, we let you override it if you
  39. // really know what you're doing with a special environment variable.
  40. disableHostCheck:
  41. !proxy || process.env.DANGEROUSLY_DISABLE_HOST_CHECK === 'true',
  42. // Enable gzip compression of generated files.
  43. compress: true,
  44. // Silence WebpackDevServer's own logs since they're generally not useful.
  45. // It will still show compile warnings and errors with this setting.
  46. clientLogLevel: 'none',
  47. // By default WebpackDevServer serves physical files from current directory
  48. // in addition to all the virtual build products that it serves from memory.
  49. // This is confusing because those files won’t automatically be available in
  50. // production build folder unless we copy them. However, copying the whole
  51. // project directory is dangerous because we may expose sensitive files.
  52. // Instead, we establish a convention that only files in `public` directory
  53. // get served. Our build script will copy `public` into the `build` folder.
  54. // In `index.html`, you can get URL of `public` folder with %PUBLIC_URL%:
  55. // <link rel="icon" href="%PUBLIC_URL%/favicon.ico">
  56. // In JavaScript code, you can access it with `process.env.PUBLIC_URL`.
  57. // Note that we only recommend to use `public` folder as an escape hatch
  58. // for files like `favicon.ico`, `manifest.json`, and libraries that are
  59. // for some reason broken when imported through webpack. If you just want to
  60. // use an image, put it in `src` and `import` it from JavaScript instead.
  61. contentBase: paths.appPublic,
  62. contentBasePublicPath: paths.publicUrlOrPath,
  63. // By default files from `contentBase` will not trigger a page reload.
  64. watchContentBase: true,
  65. // Enable hot reloading server. It will provide WDS_SOCKET_PATH endpoint
  66. // for the WebpackDevServer client so it can learn when the files were
  67. // updated. The WebpackDevServer client is included as an entry point
  68. // in the webpack development configuration. Note that only changes
  69. // to CSS are currently hot reloaded. JS changes will refresh the browser.
  70. hot: true,
  71. // Use 'ws' instead of 'sockjs-node' on server since we're using native
  72. // websockets in `webpackHotDevClient`.
  73. transportMode: 'ws',
  74. // Prevent a WS client from getting injected as we're already including
  75. // `webpackHotDevClient`.
  76. injectClient: false,
  77. // Enable custom sockjs pathname for websocket connection to hot reloading server.
  78. // Enable custom sockjs hostname, pathname and port for websocket connection
  79. // to hot reloading server.
  80. sockHost,
  81. sockPath,
  82. sockPort,
  83. // It is important to tell WebpackDevServer to use the same "publicPath" path as
  84. // we specified in the webpack config. When homepage is '.', default to serving
  85. // from the root.
  86. // remove last slash so user can land on `/test` instead of `/test/`
  87. publicPath: paths.publicUrlOrPath.slice(0, -1),
  88. // WebpackDevServer is noisy by default so we emit custom message instead
  89. // by listening to the compiler events with `compiler.hooks[...].tap` calls above.
  90. quiet: true,
  91. // Reportedly, this avoids CPU overload on some systems.
  92. // https://github.com/facebook/create-react-app/issues/293
  93. // src/node_modules is not ignored to support absolute imports
  94. // https://github.com/facebook/create-react-app/issues/1065
  95. watchOptions: {
  96. ignored: ignoredFiles(paths.appSrc),
  97. },
  98. https: getHttpsConfig(),
  99. host,
  100. overlay: false,
  101. historyApiFallback: {
  102. // Paths with dots should still use the history fallback.
  103. // See https://github.com/facebook/create-react-app/issues/387.
  104. disableDotRule: true,
  105. index: paths.publicUrlOrPath,
  106. },
  107. public: allowedHost,
  108. // `proxy` is run between `before` and `after` `webpack-dev-server` hooks
  109. proxy,
  110. before(app, server) {
  111. // Keep `evalSourceMapMiddleware` and `errorOverlayMiddleware`
  112. // middlewares before `redirectServedPath` otherwise will not have any effect
  113. // This lets us fetch source contents from webpack for the error overlay
  114. app.use(evalSourceMapMiddleware(server));
  115. // This lets us open files from the runtime error overlay.
  116. app.use(errorOverlayMiddleware());
  117. if (fs.existsSync(paths.proxySetup)) {
  118. // This registers user provided middleware for proxy reasons
  119. require(paths.proxySetup)(app);
  120. }
  121. },
  122. after(app) {
  123. // Redirect to `PUBLIC_URL` or `homepage` from `package.json` if url not match
  124. app.use(redirectServedPath(paths.publicUrlOrPath));
  125. // This service worker file is effectively a 'no-op' that will reset any
  126. // previous service worker registered for the same host:port combination.
  127. // We do this in development to avoid hitting the production cache if
  128. // it used the same host and port.
  129. // https://github.com/facebook/create-react-app/issues/2272#issuecomment-302832432
  130. app.use(noopServiceWorkerMiddleware(paths.publicUrlOrPath));
  131. },
  132. };
  133. };