Skip to content

Commit 822422c

Browse files
heygradymrmckeb
heygrady
and
mrmckeb
authored
Enable custom sockjs pathname for hot reloading server. (#7750)
* Enable custom sockjs pathname for hot reloading server. * Update docusaurus/docs/advanced-configuration.md Co-Authored-By: Brody McKee <[email protected]> * let WDS_SOCKET_PATH be undefined * adding env variables for sockHost and sockPort options Co-authored-by: Brody McKee <[email protected]>
1 parent cc985d0 commit 822422c

File tree

5 files changed

+29
-5
lines changed

5 files changed

+29
-5
lines changed

‎docusaurus/docs/advanced-configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ You can adjust various development and production settings by setting environmen
1414
| HOST | ✅ Used | 🚫 Ignored | By default, the development web server binds to all hostnames on the device (`localhost`, LAN network address, etc.). You may use this variable to specify a different host. |
1515
| PORT | ✅ Used | 🚫 Ignored | By default, the development web server will attempt to listen on port 3000 or prompt you to attempt the next available port. You may use this variable to specify a different port. |
1616
| HTTPS | ✅ Used | 🚫 Ignored | When set to `true`, Create React App will run the development server in `https` mode. |
17+
| WDS_SOCKET_HOST | ✅ Used | 🚫 Ignored | When set, Create React App will run the development server with a custom websocket hostname for hot module reloading. Normally, `webpack-dev-server` defaults to `window.location.hostname` for the SockJS hostname. You may use this variable to start local development on more than one Create React App project at a time. See [webpack-dev-server documentation](https://webpack.js.org/configuration/dev-server/#devserversockhost) for more details. |
18+
| WDS_SOCKET_PATH | ✅ Used | 🚫 Ignored | When set, Create React App will run the development server with a custom websocket path for hot module reloading. Normally, `webpack-dev-server` defaults to `/sockjs-node` for the SockJS pathname. You may use this variable to start local development on more than one Create React App project at a time. See [webpack-dev-server documentation](https://webpack.js.org/configuration/dev-server/#devserversockpath) for more details. |
19+
| WDS_SOCKET_PORT | ✅ Used | 🚫 Ignored | When set, Create React App will run the development server with a custom websocket port for hot module reloading. Normally, `webpack-dev-server` defaults to `window.location.port` for the SockJS port. You may use this variable to start local development on more than one Create React App project at a time. See [webpack-dev-server documentation](https://webpack.js.org/configuration/dev-server/#devserversockport) for more details. |
1720
| PUBLIC_URL | 🚫 Ignored | ✅ Used | Create React App assumes your application is hosted at the serving web server's root or a subpath as specified in [`package.json` (`homepage`)](deployment#building-for-relative-paths). Normally, Create React App ignores the hostname. You may use this variable to force assets to be referenced verbatim to the url you provide (hostname included). This may be particularly useful when using a CDN to host your application. |
1821
| CI | ✅ Used | ✅ Used | When set to `true`, Create React App treats warnings as failures in the build. It also makes the test runner non-watching. Most CIs set this flag by default. |
1922
| REACT_EDITOR | ✅ Used | 🚫 Ignored | When an app crashes in development, you will see an error overlay with clickable stack trace. When you click on it, Create React App will try to determine the editor you are using based on currently running processes, and open the relevant source file. You can [send a pull request to detect your editor of choice](https://github.com/facebook/create-react-app/issues/2636). Setting this environment variable overrides the automatic detection. If you do it, make sure your systems [PATH](<https://en.wikipedia.org/wiki/PATH_(variable)>) environment variable points to your editor’s bin folder. You can also set it to `none` to disable it completely. |

‎packages/react-dev-utils/WebpackDevServerUtils.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,10 +377,14 @@ function prepareProxy(proxy, appPublicFolder) {
377377
// If proxy is specified, let it handle any request except for
378378
// files in the public folder and requests to the WebpackDevServer socket endpoint.
379379
// https://github.com/facebook/create-react-app/issues/6720
380+
const sockPath = process.env.WDS_SOCKET_PATH || '/sockjs-node';
381+
const isDefaultSockHost = !process.env.WDS_SOCKET_HOST;
380382
function mayProxy(pathname) {
381383
const maybePublicPath = path.resolve(appPublicFolder, pathname.slice(1));
382384
const isPublicFileRequest = fs.existsSync(maybePublicPath);
383-
const isWdsEndpointRequest = pathname.startsWith('/sockjs-node'); // used by webpackHotDevClient
385+
// used by webpackHotDevClient
386+
const isWdsEndpointRequest =
387+
isDefaultSockHost && pathname.startsWith(sockPath);
384388
return !(isPublicFileRequest || isWdsEndpointRequest);
385389
}
386390

‎packages/react-dev-utils/webpackHotDevClient.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ if (module.hot && typeof module.hot.dispose === 'function') {
6060
var connection = new WebSocket(
6161
url.format({
6262
protocol: window.location.protocol === 'https:' ? 'wss' : 'ws',
63-
hostname: window.location.hostname,
64-
port: window.location.port,
63+
hostname: process.env.WDS_SOCKET_HOST || window.location.hostname,
64+
port: process.env.WDS_SOCKET_PORT || window.location.port,
6565
// Hardcoded in WebpackDevServer
66-
pathname: '/sockjs-node',
66+
pathname: process.env.WDS_SOCKET_PATH || '/sockjs-node',
6767
slashes: true,
6868
})
6969
);

‎packages/react-scripts/config/env.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,14 @@ function getClientEnvironment(publicUrl) {
8585
// This should only be used as an escape hatch. Normally you would put
8686
// images into the `src` and `import` them in code to get their paths.
8787
PUBLIC_URL: publicUrl,
88+
// We support configuring the sockjs pathname during development.
89+
// These settings let a developer run multiple simultaneous projects.
90+
// They are used as the connection `hostname`, `pathname` and `port`
91+
// in webpackHotDevClient. They are used as the `sockHost`, `sockPath`
92+
// and `sockPort` options in webpack-dev-server.
93+
WDS_SOCKET_HOST: process.env.WDS_SOCKET_HOST,
94+
WDS_SOCKET_PATH: process.env.WDS_SOCKET_PATH,
95+
WDS_SOCKET_PORT: process.env.WDS_SOCKET_PORT,
8896
}
8997
);
9098
// Stringify all values so we can feed into Webpack DefinePlugin

‎packages/react-scripts/config/webpackDevServer.config.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ const fs = require('fs');
1717

1818
const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
1919
const host = process.env.HOST || '0.0.0.0';
20+
const sockHost = process.env.WDS_SOCKET_HOST;
21+
const sockPath = process.env.WDS_SOCKET_PATH; // default: '/sockjs-node'
22+
const sockPort = process.env.WDS_SOCKET_PORT;
2023

2124
module.exports = function(proxy, allowedHost) {
2225
return {
@@ -60,7 +63,7 @@ module.exports = function(proxy, allowedHost) {
6063
contentBase: paths.appPublic,
6164
// By default files from `contentBase` will not trigger a page reload.
6265
watchContentBase: true,
63-
// Enable hot reloading server. It will provide /sockjs-node/ endpoint
66+
// Enable hot reloading server. It will provide WDS_SOCKET_PATH endpoint
6467
// for the WebpackDevServer client so it can learn when the files were
6568
// updated. The WebpackDevServer client is included as an entry point
6669
// in the Webpack development configuration. Note that only changes
@@ -72,6 +75,12 @@ module.exports = function(proxy, allowedHost) {
7275
// Prevent a WS client from getting injected as we're already including
7376
// `webpackHotDevClient`.
7477
injectClient: false,
78+
// Enable custom sockjs pathname for websocket connection to hot reloading server.
79+
// Enable custom sockjs hostname, pathname and port for websocket connection
80+
// to hot reloading server.
81+
sockHost,
82+
sockPath,
83+
sockPort,
7584
// It is important to tell WebpackDevServer to use the same "root" path
7685
// as we specified in the config. In development, we always serve from /.
7786
publicPath: '/',

0 commit comments

Comments
 (0)