webpack-hot-server-middleware
Advanced tools
Webpack Hot Server Middleware is designed to be used in conjunction with webpack-dev-middleware (and optionally webpack-hot-middleware) to hot update Webpack bundles on the server.
When creating universal Web apps it's common to build two bundles with Webpack, one client bundle targeting 'web' and another server bundle targeting 'node'.
The entry point to the client bundle renders to the DOM, e.g.
// client.js
import ReactDOM from 'react-dom';
import App from './components/App';
ReactDOM.render(<App />, document.getElementById('root'));
And the entry point to the server bundle renders to string, e.g.
// server.js
import { renderToString } from 'react-dom/server';
import App from './components/App';
export default function serverRenderer() {
return (req, res, next) => {
res.status(200).send(`
<!doctype html>
<html>
<head>
<title>App</title>
</head>
<body>
<div id="root">
${renderToString(<App />)}
</div>
<script src="/client.js"></script>
</body>
</html>
`);
};
}
NOTE: The server bundle is itself middleware allowing you to mount it anywhere in an existing node server, e.g.
const express = require('express');
const serverRenderer = require('./dist/server');
const app = express();
app.use(serverRenderer());
app.listen(6060);
Given this setup it's fairly easy to hook up hot module reloading for your client bundle using webpack-dev-server or webpack-hot-middleware however these middlewares don't handle server bundles meaning you need to constantly restart your server whenever a change is made.
Webpack Hot Server Middleware will ensure that the server bundle used is always the latest compilation without requiring a restart.
It turns out hot reloading a Webpack bundle on the server is much easier than on the client as you don't have any state to preserve because renderToString is neccesarily stateless so the entire bundle can be replaced at the top level whenever a change occurs.
Webpack Hot Server Middleware expects your Webpack config to export an array of configurations, one for your client bundle and one for your server bundle, e.g.
// webpack.config.js
module.exports = [
{
name: 'client',
target: 'web',
entry: './client.js'
...
}, {
name: 'server',
target: 'node',
entry: './server.js'
...
}
];
NOTE: It's important both the 'client' and 'server' configs are given the name 'client' and 'server' respectively.
It then needs to be mounted immediately after webpack-dev-middleware, e.g.
const express = require('express');
const webpack = require('webpack');
const webpackDevMiddleware = require('webpack-dev-middleware');
const webpackHotServerMiddleware = require('webpack-hot-server-middleware');
const config = require('./webpack.config.js');
const app = express();
const compiler = webpack(config);
app.use(webpackDevMiddleware(compiler));
app.use(webpackHotServerMiddleware(compiler));
app.listen(6060);
Now whenever Webpack rebuilds the new bundle will be used both client and server side.
A simple example can be found in the example directory and a more real world example can be seen in the 60fram.es boilerplate
MIT
FAQs
Hot updates Webpack bundles on the server
We found that webpack-hot-server-middleware demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.