webpackDevServer.config.js 6.4 KB

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