UNPKG

5.59 kBJavaScriptView Raw
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
11const errorOverlayMiddleware = require('react-dev-utils/errorOverlayMiddleware');
12const noopServiceWorkerMiddleware = require('react-dev-utils/noopServiceWorkerMiddleware');
13const ignoredFiles = require('react-dev-utils/ignoredFiles');
14const config = require('./webpack.config.dev');
15const paths = require('./paths');
16
17const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
18const host = process.env.HOST || '0.0.0.0';
19
20module.exports = function(proxy, allowedHost) {
21 return {
22 // WebpackDevServer 2.4.3 introduced a security fix that prevents remote
23 // websites from potentially accessing local content through DNS rebinding:
24 // https://github.com/webpack/webpack-dev-server/issues/887
25 // https://medium.com/webpack/webpack-dev-server-middleware-security-issues-1489d950874a
26 // However, it made several existing use cases such as development in cloud
27 // environment or subdomains in development significantly more complicated:
28 // https://github.com/facebookincubator/create-react-app/issues/2271
29 // https://github.com/facebookincubator/create-react-app/issues/2233
30 // While we're investigating better solutions, for now we will take a
31 // compromise. Since our WDS configuration only serves files in the `public`
32 // folder we won't consider accessing them a vulnerability. However, if you
33 // use the `proxy` feature, it gets more dangerous because it can expose
34 // remote code execution vulnerabilities in backends like Django and Rails.
35 // So we will disable the host check normally, but enable it if you have
36 // specified the `proxy` setting. Finally, we let you override it if you
37 // really know what you're doing with a special environment variable.
38 disableHostCheck:
39 !proxy || process.env.DANGEROUSLY_DISABLE_HOST_CHECK === 'true',
40 // Enable gzip compression of generated files.
41 compress: true,
42 // Silence WebpackDevServer's own logs since they're generally not useful.
43 // It will still show compile warnings and errors with this setting.
44 clientLogLevel: 'none',
45 // By default WebpackDevServer serves physical files from current directory
46 // in addition to all the virtual build products that it serves from memory.
47 // This is confusing because those files won’t automatically be available in
48 // production build folder unless we copy them. However, copying the whole
49 // project directory is dangerous because we may expose sensitive files.
50 // Instead, we establish a convention that only files in `public` directory
51 // get served. Our build script will copy `public` into the `build` folder.
52 // In `index.html`, you can get URL of `public` folder with %PUBLIC_URL%:
53 // <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
54 // In JavaScript code, you can access it with `process.env.PUBLIC_URL`.
55 // Note that we only recommend to use `public` folder as an escape hatch
56 // for files like `favicon.ico`, `manifest.json`, and libraries that are
57 // for some reason broken when imported through Webpack. If you just want to
58 // use an image, put it in `src` and `import` it from JavaScript instead.
59 contentBase: paths.appPublic,
60 // By default files from `contentBase` will not trigger a page reload.
61 watchContentBase: true,
62 // Enable hot reloading server. It will provide /sockjs-node/ endpoint
63 // for the WebpackDevServer client so it can learn when the files were
64 // updated. The WebpackDevServer client is included as an entry point
65 // in the Webpack development configuration. Note that only changes
66 // to CSS are currently hot reloaded. JS changes will refresh the browser.
67 hot: true,
68 // It is important to tell WebpackDevServer to use the same "root" path
69 // as we specified in the config. In development, we always serve from /.
70 publicPath: config.output.publicPath,
71 // WebpackDevServer is noisy by default so we emit custom message instead
72 // by listening to the compiler events with `compiler.plugin` calls above.
73 quiet: true,
74 // Reportedly, this avoids CPU overload on some systems.
75 // https://github.com/facebookincubator/create-react-app/issues/293
76 // src/node_modules is not ignored to support absolute imports
77 // https://github.com/facebookincubator/create-react-app/issues/1065
78 watchOptions: {
79 ignored: ignoredFiles(paths.appSrc),
80 },
81 // Enable HTTPS if the HTTPS environment variable is set to 'true'
82 https: protocol === 'https',
83 host: host,
84 overlay: false,
85 historyApiFallback: {
86 // Paths with dots should still use the history fallback.
87 // See https://github.com/facebookincubator/create-react-app/issues/387.
88 disableDotRule: true,
89 },
90 public: allowedHost,
91 proxy,
92 before(app) {
93 // This lets us open files from the runtime error overlay.
94 app.use(errorOverlayMiddleware());
95 // This service worker file is effectively a 'no-op' that will reset any
96 // previous service worker registered for the same host:port combination.
97 // We do this in development to avoid hitting the production cache if
98 // it used the same host and port.
99 // https://github.com/facebookincubator/create-react-app/issues/2272#issuecomment-302832432
100 app.use(noopServiceWorkerMiddleware());
101 },
102 };
103};