/** * Copyright (c) 2015-present, Facebook, Inc. * * This source code is licensed under the MIT license found in the * LICENSE file at * https://github.com/facebookincubator/create-react-app/blob/master/LICENSE */ const fs = require('fs') const url = require('url') const path = require('path') const chalk = require('chalk') const address = require('address') module.exports = function prepareProxy (proxy, appPublicFolder) { // `proxy` lets you specify alternate servers for specific requests. // It can either be a string or an object conforming to the Webpack dev server proxy configuration // https://webpack.github.io/docs/webpack-dev-server.html if (!proxy) { return undefined } if (typeof proxy !== 'object' && typeof proxy !== 'string') { console.log( chalk.red( 'When specified, "proxy" in package.json must be a string or an object.' ) ) 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 an object.' ) ) process.exit(1) } // Otherwise, if proxy is specified, we will let it handle any request except for files in the public folder. function mayProxy (pathname) { const maybePublicPath = path.resolve(appPublicFolder, pathname.slice(1)) return !fs.existsSync(maybePublicPath) } // Support proxy as a string for those who are using the simple proxy option if (typeof proxy === 'string') { if (!/^http(s)?:\/\//.test(proxy)) { console.log( chalk.red( 'When "proxy" is specified in package.json it must start with either http:// or https://' ) ) process.exit(1) } let target if (process.platform === 'win32') { target = resolveLoopback(proxy) } else { target = proxy } return [ { target, logLevel: 'silent', // 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 as a string, 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 accept text/html. // If this heuristic doesn’t work well for you, use a custom `proxy` object. context: function (pathname, req) { return ( mayProxy(pathname) && req.headers.accept && req.headers.accept.indexOf('text/html') === -1 ) }, onProxyReq: proxyReq => { // Browers may send Origin headers even with same-origin // requests. To prevent CORS issues, we have to change // the Origin to match the target URL. if (proxyReq.getHeader('origin')) { proxyReq.setHeader('origin', target) } }, onError: onProxyError(target), secure: false, changeOrigin: true, ws: true, xfwd: true } ] } // Otherwise, proxy is an object so create an array of proxies to pass to webpackDevServer return Object.keys(proxy).map(function (context) { if (!proxy[context].hasOwnProperty('target')) { console.log( chalk.red( 'When `proxy` in package.json is as an object, each `context` object must have a ' + '`target` property specified as a url string' ) ) process.exit(1) } let target if (process.platform === 'win32') { target = resolveLoopback(proxy[context].target) } else { target = proxy[context].target } return Object.assign({}, proxy[context], { context: function (pathname) { return mayProxy(pathname) && pathname.match(context) }, onProxyReq: proxyReq => { // Browers may send Origin headers even with same-origin // requests. To prevent CORS issues, we have to change // the Origin to match the target URL. if (proxyReq.getHeader('origin')) { proxyReq.setHeader('origin', target) } }, target, onError: onProxyError(target) }) }) } function resolveLoopback (proxy) { const o = url.parse(proxy) o.host = undefined if (o.hostname !== 'localhost') { return proxy } // Unfortunately, many languages (unlike node) do not yet support IPv6. // This means even though localhost resolves to ::1, the application // must fall back to IPv4 (on 127.0.0.1). // We can re-enable this in a few years. /* try { o.hostname = address.ipv6() ? '::1' : '127.0.0.1'; } catch (_ignored) { o.hostname = '127.0.0.1'; }*/ try { // Check if we're on a network; if we are, chances are we can resolve // localhost. Otherwise, we can just be safe and assume localhost is // IPv4 for maximum compatibility. if (!address.ip()) { o.hostname = '127.0.0.1' } } catch (_ignored) { o.hostname = '127.0.0.1' } return url.format(o) } // We need to provide a custom onError function for httpProxyMiddleware. // It allows us to log custom error messages on the console. function onProxyError (proxy) { return (err, req, res) => { const host = req.headers && req.headers.host console.log( chalk.red('Proxy error:') + ' Could not proxy request ' + chalk.cyan(req.url) + ' from ' + chalk.cyan(host) + ' to ' + chalk.cyan(proxy) + '.' ) console.log( 'See https://nodejs.org/api/errors.html#errors_common_system_errors for more information (' + chalk.cyan(err.code) + ').' ) console.log() // And immediately send the proper error response to the client. // Otherwise, the request will eventually timeout with ERR_EMPTY_RESPONSE on the client side. if (res.writeHead && !res.headersSent) { res.writeHead(500) } res.end( 'Proxy error: Could not proxy request ' + req.url + ' from ' + host + ' to ' + proxy + ' (' + err.code + ').' ) } }