aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/scripts/start.js
diff options
context:
space:
mode:
Diffstat (limited to 'server/sonar-web/scripts/start.js')
-rw-r--r--server/sonar-web/scripts/start.js220
1 files changed, 24 insertions, 196 deletions
diff --git a/server/sonar-web/scripts/start.js b/server/sonar-web/scripts/start.js
index a985f1bddd7..ab7347d9444 100644
--- a/server/sonar-web/scripts/start.js
+++ b/server/sonar-web/scripts/start.js
@@ -23,46 +23,34 @@ process.env.NODE_ENV = 'development';
const chalk = require('chalk');
const webpack = require('webpack');
const WebpackDevServer = require('webpack-dev-server');
-const historyApiFallback = require('connect-history-api-fallback');
-const httpProxyMiddleware = require('http-proxy-middleware');
-const detect = require('detect-port');
const clearConsole = require('react-dev-utils/clearConsole');
const formatWebpackMessages = require('react-dev-utils/formatWebpackMessages');
-const prompt = require('react-dev-utils/prompt');
+const errorOverlayMiddleware = require('react-error-overlay/middleware');
const getConfig = require('../config/webpack.config');
const paths = require('../config/paths');
const config = getConfig({ production: false });
-// Tools like Cloud9 rely on this.
-const DEFAULT_PORT = process.env.PORT || 3000;
-let compiler;
-let handleCompile;
+const port = process.env.PORT || 3000;
+const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
+const host = process.env.HOST || 'localhost';
+const proxy = 'http://localhost:9000';
-const PROXY_URL = 'http://localhost:9000';
+const compiler = setupCompiler(host, port, protocol);
+
+runDevServer(compiler, host, port, protocol);
function setupCompiler(host, port, protocol) {
- // "Compiler" is a low-level interface to Webpack.
- // It lets us listen to some events and provide our own custom messages.
- compiler = webpack(config, handleCompile);
+ const compiler = webpack(config);
- // "invalid" event fires when you have changed a file, and Webpack is
- // recompiling a bundle. WebpackDevServer takes care to pause serving the
- // bundle, so if you refresh, it'll wait instead of serving the old one.
- // "invalid" is short for "bundle invalidated", it doesn't imply any errors.
compiler.plugin('invalid', () => {
clearConsole();
console.log('Compiling...');
});
- // "done" event fires when Webpack has finished recompiling the bundle.
- // Whether or not you have warnings or errors, you will get this event.
compiler.plugin('done', stats => {
clearConsole();
- // We have switched off the default Webpack output in WebpackDevServer
- // options so we are going to "massage" the warnings and errors and present
- // them in a readable focused way.
const jsonStats = stats.toJson({}, true);
const messages = formatWebpackMessages(jsonStats);
const seconds = jsonStats.time / 1000;
@@ -74,12 +62,8 @@ function setupCompiler(host, port, protocol) {
console.log();
console.log(' ' + chalk.cyan(protocol + '://' + host + ':' + port + '/'));
console.log();
- console.log('Note that the development build is not optimized.');
- console.log('To create a production build, use ' + chalk.cyan('npm run build') + '.');
- console.log();
}
- // If errors exist, only show errors.
if (messages.errors.length) {
console.log(chalk.red('Failed to compile.'));
console.log();
@@ -89,167 +73,38 @@ function setupCompiler(host, port, protocol) {
});
return;
}
-
- // Show warnings if no errors were found.
- if (messages.warnings.length) {
- console.log(chalk.yellow('Compiled with warnings.'));
- console.log();
- messages.warnings.forEach(message => {
- console.log(message);
- console.log();
- });
- // Teach some ESLint tricks.
- console.log('You may use special comments to disable some warnings.');
- console.log(
- 'Use ' + chalk.yellow('// eslint-disable-next-line') + ' to ignore the next line.'
- );
- console.log(
- 'Use ' + chalk.yellow('/* eslint-disable */') + ' to ignore all warnings in a file.'
- );
- }
});
-}
-
-// 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 function(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 +
- ').'
- );
- };
+ return compiler;
}
-function addMiddleware(devServer) {
- // `proxy` lets you to specify a fallback server during development.
- // Every unrecognized request will be forwarded to it.
- const proxy = PROXY_URL;
- devServer.use(
- historyApiFallback({
- // Paths with dots should still use the history fallback.
- // See https://github.com/facebookincubator/create-react-app/issues/387.
- disableDotRule: true,
- // 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 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:
- // - /*.hot-update.json (WebpackDevServer uses this too for hot reloading)
- // - /sockjs-node/* (WebpackDevServer uses this for hot reloading)
- // Tip: use https://jex.im/regulex/ to visualize the regex
- const 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',
- onError: onProxyError(proxy),
- secure: false,
- changeOrigin: 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(host, port, protocol) {
+function runDevServer(compiler, host, port, protocol) {
const devServer = new WebpackDevServer(compiler, {
- // Enable gzip compression of generated files.
compress: true,
- // Silence WebpackDevServer's own logs since they're generally not useful.
- // It will still show compile warnings and errors with this setting.
clientLogLevel: 'none',
- // By default WebpackDevServer serves physical files from current directory
- // in addition to all the virtual build products that it serves from memory.
- // This is confusing because those files won’t automatically be available in
- // production build folder unless we copy them. However, copying the whole
- // project directory is dangerous because we may expose sensitive files.
- // Instead, we establish a convention that only files in `public` directory
- // get served. Our build script will copy `public` into the `build` folder.
- // In `index.html`, you can get URL of `public` folder with %PUBLIC_PATH%:
- // <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
- // In JavaScript code, you can access it with `process.env.PUBLIC_URL`.
- // Note that we only recommend to use `public` folder as an escape hatch
- // for files like `favicon.ico`, `manifest.json`, and libraries that are
- // for some reason broken when imported through Webpack. If you just want to
- // use an image, put it in `src` and `import` it from JavaScript instead.
contentBase: paths.appPublic,
- // Enable hot reloading server. It will provide /sockjs-node/ endpoint
- // for the WebpackDevServer client so it can learn when the files were
- // updated. The WebpackDevServer client is included as an entry point
- // in the Webpack development configuration. Note that only changes
- // to CSS are currently hot reloaded. JS changes will refresh the browser.
hot: true,
- // It is important to tell WebpackDevServer to use the same "root" path
- // as we specified in the config. In development, we always serve from /.
publicPath: config.output.publicPath,
- // WebpackDevServer is noisy by default so we emit custom message instead
- // by listening to the compiler events with `compiler.plugin` calls above.
quiet: true,
- // Reportedly, this avoids CPU overload on some systems.
- // https://github.com/facebookincubator/create-react-app/issues/293
watchOptions: {
ignored: /node_modules/
},
- // Enable HTTPS if the HTTPS environment variable is set to 'true'
https: protocol === 'https',
- host
+ host,
+ overlay: false,
+ historyApiFallback: {
+ disableDotRule: true
+ },
+ proxy: {
+ '/api': proxy,
+ '/fonts': proxy,
+ '/images': proxy
+ },
+ setup(app) {
+ app.use(errorOverlayMiddleware());
+ }
});
- // Our custom middleware proxies requests to /index.html or a remote API.
- addMiddleware(devServer);
-
- // Launch WebpackDevServer.
devServer.listen(port, err => {
if (err) {
return console.log(err);
@@ -260,30 +115,3 @@ function runDevServer(host, port, protocol) {
console.log();
});
}
-
-function run(port) {
- const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
- const host = process.env.HOST || 'localhost';
- setupCompiler(host, port, protocol);
- runDevServer(host, port, protocol);
-}
-
-// We attempt to use the default port but if it is busy, we offer the user to
-// run on a different port. `detect()` Promise resolves to the next free port.
-detect(DEFAULT_PORT).then(port => {
- if (port === DEFAULT_PORT) {
- run(port);
- return;
- }
-
- clearConsole();
- const question =
- chalk.yellow('Something is already running on port ' + DEFAULT_PORT + '.') +
- '\n\nWould you like to run the app on another port instead?';
-
- prompt(question, true).then(shouldChangePort => {
- if (shouldChangePort) {
- run(port);
- }
- });
-});