webpackDevServer.config.js 6.2 KB

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