From 8a81c8201cfef5eca719605f17b4b3a9c85f298c Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Sat, 30 Jul 2016 00:43:28 +0100 Subject: [PATCH] Add proxy option to package.json --- package.json | 2 ++ scripts/start.js | 57 +++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 56 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 35243aed443..85c6cb5aba7 100644 --- a/package.json +++ b/package.json @@ -42,6 +42,7 @@ "babel-runtime": "6.11.6", "case-sensitive-paths-webpack-plugin": "1.1.2", "chalk": "1.1.3", + "connect-history-api-fallback": "1.2.0", "cross-spawn": "4.0.0", "css-loader": "0.23.1", "detect-port": "0.1.4", @@ -57,6 +58,7 @@ "fs-extra": "0.30.0", "gzip-size": "3.0.0", "html-webpack-plugin": "2.22.0", + "http-proxy-middleware": "0.17.0", "json-loader": "0.5.4", "opn": "4.0.2", "postcss-loader": "0.9.1", diff --git a/scripts/start.js b/scripts/start.js index c93754df3b0..cebc5003e05 100644 --- a/scripts/start.js +++ b/scripts/start.js @@ -13,11 +13,14 @@ var path = require('path'); var chalk = require('chalk'); var webpack = require('webpack'); var WebpackDevServer = require('webpack-dev-server'); +var historyApiFallback = require('connect-history-api-fallback'); +var httpProxyMiddleware = require('http-proxy-middleware'); var execSync = require('child_process').execSync; var opn = require('opn'); var detect = require('detect-port'); var prompt = require('./utils/prompt'); var config = require('../config/webpack.config.dev'); +var paths = require('../config/paths'); // Tools like Cloud9 rely on this var DEFAULT_PORT = process.env.PORT || 3000; @@ -150,16 +153,64 @@ function openBrowser(port) { opn('http://localhost:' + port + '/'); } +function addMiddleware(devServer) { + // `proxy` lets you to specify a fallback server during development. + // Every unrecognized request will be forwarded to it. + var proxy = require(paths.appPackageJson).proxy; + devServer.use(historyApiFallback({ + // For single page apps, we generally want to fallback to /index.html. + // However we also want to respect `proxy` for API calls. + // So if `proxy` is specified, we need to decide which fallback to use. + // We use a heuristic: if request `accept`s text/html, we pick /index.html. + // Modern browsers include text/html into `accept` header when navigating. + // However API calls like `fetch()` won’t generally won’t accept text/html. + // If this heuristic doesn’t work well for you, don’t use `proxy`. + htmlAcceptHeaders: proxy ? + ['text/html'] : + ['text/html', '*/*'] + })); + if (proxy) { + if (typeof proxy !== 'string') { + console.log(chalk.red('When specified, "proxy" in package.json must be a string.')); + console.log(chalk.red('Instead, the type of "proxy" was "' + typeof proxy + '".')); + console.log(chalk.red('Either remove "proxy" from package.json, or make it a string.')); + process.exit(1); + } + + // Otherwise, if proxy is specified, we will let it handle any request. + // There are a few exceptions which we won't send to the proxy: + // - /index.html (served as HTML5 history API fallback) + // - /*.hot-update.json (WebpackDevServer uses this too for hot reloading) + // - /sockjs-node/* (WebpackDevServer uses this for hot reloading) + var mayProxy = /^(?!\/(index\.html$|.*\.hot-update\.json$|sockjs-node\/)).*$/; + devServer.use(mayProxy, + // Pass the scope regex both to Express and to the middleware for proxying + // of both HTTP and WebSockets to work without false positives. + httpProxyMiddleware(pathname => mayProxy.test(pathname), { + target: proxy, + logLevel: 'silent', + secure: false, + changeOrigin: true, + ws: true + }) + ); + } + // Finally, by now we have certainly resolved the URL. + // It may be /index.html, so let the dev server try serving it again. + devServer.use(devServer.middleware); +} + function runDevServer(port) { - new WebpackDevServer(compiler, { - historyApiFallback: true, + var devServer = new WebpackDevServer(compiler, { hot: true, // Note: only CSS is currently hot reloaded publicPath: config.output.publicPath, quiet: true, watchOptions: { ignored: /node_modules/ } - }).listen(port, (err, result) => { + }); + addMiddleware(devServer); + devServer.listen(port, (err, result) => { if (err) { return console.log(err); }