UNPKG

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