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