embark/lib/modules/webserver/server.js

189 lines
6.0 KiB
JavaScript
Raw Normal View History

const async = require('async');
2017-03-29 17:50:05 +00:00
let serveStatic = require('serve-static');
const {canonicalHost, defaultHost, dockerHostSwap} = require('../../utils/host');
2018-09-19 23:19:37 +00:00
const expressWebSocket = require('express-ws');
2018-09-18 13:28:17 +00:00
const express = require('express');
const fs = require('../../core/fs');
2017-12-17 23:34:41 +00:00
require('http-shutdown').extend();
2018-08-01 16:53:37 +00:00
var cors = require('cors');
let path = require('path');
2018-03-13 10:46:58 +00:00
var bodyParser = require('body-parser');
const helmet = require('helmet');
2016-08-21 15:02:50 +00:00
2017-03-30 11:12:39 +00:00
class Server {
constructor(options) {
this.logger = options.logger;
this.buildDir = options.buildDir;
this.events = options.events;
2017-03-30 11:12:39 +00:00
this.port = options.port || 8000;
2018-09-30 22:56:33 +00:00
this.dist = options.dist || 'dist/';
this.hostname = dockerHostSwap(options.host) || defaultHost;
this.isFirstStart = true;
this.opened = false;
this.openBrowser = options.openBrowser;
2018-09-28 19:11:26 +00:00
this.logging = false;
2018-08-27 20:22:53 +00:00
this.plugins = options.plugins;
this.enableCatchAll = options.enableCatchAll;
this.events.once('outputDone', () => {
this.logger.info(this._getMessage());
});
2018-09-28 19:11:26 +00:00
}
enableLogging(callback) {
this.logging = true;
return callback(null, __("Enabled Webserver Logs"));
}
disableLogging(callback) {
this.logging = false;
return callback(null, __("Disabled Webserver Logs"));
2017-03-30 11:12:39 +00:00
}
2016-08-21 15:02:50 +00:00
2017-03-30 11:12:39 +00:00
start(callback) {
2018-08-27 20:22:53 +00:00
callback = callback || function() {};
2018-09-19 23:19:37 +00:00
const self = this;
if (this.server && this.server.listening) {
2018-08-10 14:09:56 +00:00
let message = __("a webserver is already running at") + " " +
2018-08-27 20:22:53 +00:00
("http://" + canonicalHost(this.hostname) +
":" + this.port).bold.underline.green;
2018-08-10 14:09:56 +00:00
return callback(null, message);
}
2016-08-21 15:02:50 +00:00
2018-09-18 13:28:17 +00:00
const coverage = serveStatic(fs.dappPath('coverage/__root__/'), {'index': ['index.html', 'index.htm']});
const coverageStyle = serveStatic(fs.dappPath('coverage/'));
const main = serveStatic(this.buildDir, {'index': ['index.html', 'index.htm']});
this.app = express();
2018-10-03 20:21:59 +00:00
const expressWs = expressWebSocket(this.app);
2018-09-28 19:11:26 +00:00
// Assign Logging Function
this.app.use(function(req, res, next) {
if (self.logging) {
if (!req.headers.upgrade) {
console.log('Webserver> ' + req.method + " " + req.originalUrl);
}
}
next();
});
this.app.use(helmet.noCache());
2018-08-01 15:14:02 +00:00
this.app.use(cors());
2018-10-01 09:10:17 +00:00
this.app.use(main);
2018-09-18 13:28:17 +00:00
this.app.use('/coverage', coverage);
this.app.use(coverageStyle);
2016-08-21 15:02:50 +00:00
2018-10-01 08:31:21 +00:00
this.app.use(express.static(path.join(fs.dappPath(this.dist)), {'index': ['index.html', 'index.htm']}));
2018-08-01 09:19:11 +00:00
this.app.use('/embark', express.static(path.join(__dirname, '../../../embark-ui/build')));
2018-09-30 22:56:33 +00:00
this.app.use(bodyParser.json()); // support json encoded bodies
this.app.use(bodyParser.urlencoded({extended: true})); // support encoded bodies
2018-03-13 10:46:58 +00:00
2018-10-01 08:31:21 +00:00
this.app.ws('/logs', function(ws, _req) {
2018-02-26 14:45:46 +00:00
self.events.on("log", function(logLevel, logMsg) {
ws.send(JSON.stringify({msg: logMsg, msg_clear: logMsg.stripColors, logLevel: logLevel}), () => {});
2018-02-26 14:45:46 +00:00
});
2018-03-10 18:12:22 +00:00
});
2018-07-16 06:50:59 +00:00
if (self.plugins) {
let apiCalls = self.plugins.getPluginsProperty("apiCalls", "apiCalls");
2018-10-01 08:31:21 +00:00
this.app.get('/embark-api/plugins', function(req, res) {
res.send(JSON.stringify(self.plugins.plugins.map((plugin) => {
return {name: plugin.name};
})));
});
2018-07-16 06:50:59 +00:00
for (let apiCall of apiCalls) {
console.dir("adding " + apiCall.method + " " + apiCall.endpoint);
2018-10-01 08:31:21 +00:00
this.app[apiCall.method].apply(this.app, [apiCall.endpoint, this.applyAPIFunction.bind(this, apiCall.cb)]);
2018-07-16 06:50:59 +00:00
}
}
2018-10-03 20:21:59 +00:00
const wss = expressWs.getWss('/');
2018-10-03 14:28:00 +00:00
2018-10-03 20:21:59 +00:00
self.events.on('outputDone', () => {
2018-10-03 20:49:25 +00:00
wss.clients.forEach(function(client) {
2018-10-03 20:21:59 +00:00
client.send('outputDone');
});
2018-10-03 20:46:13 +00:00
});
self.events.on('outputError', () => {
2018-10-03 20:49:25 +00:00
wss.clients.forEach(function(client) {
2018-10-03 20:46:13 +00:00
client.send('outputError');
2018-08-02 16:45:59 +00:00
});
});
2018-08-01 09:19:11 +00:00
2018-09-06 20:06:07 +00:00
this.events.on('plugins:register:api', (apiCall) => {
console.dir("adding " + apiCall.method + " " + apiCall.endpoint);
self.app[apiCall.method].apply(self.app, [apiCall.endpoint, this.applyAPIFunction.bind(this, apiCall.cb)]);
});
2018-10-03 20:49:25 +00:00
this.app.get('/embark/*', function(req, res) {
2018-08-01 09:19:11 +00:00
self.logger.trace('webserver> GET ' + req.path);
res.sendFile(path.join(__dirname, '../../../embark-ui/build', 'index.html'));
2018-09-19 23:19:37 +00:00
});
2018-08-23 19:11:43 +00:00
2018-10-01 08:31:21 +00:00
if (this.enableCatchAll === true) {
2018-10-03 20:49:25 +00:00
this.app.get('/*', function(req, res) {
2018-10-01 08:31:21 +00:00
self.logger.trace('webserver> GET ' + req.path);
res.sendFile(path.join(fs.dappPath(self.dist, 'index.html')));
});
}
2018-07-13 07:50:57 +00:00
async.waterfall([
function createPlaceholderPage(next) {
if (!self.isFirstStart) {
return next();
}
self.isFirstStart = false;
self.events.request('build-placeholder', next);
},
function listen(next) {
2018-09-18 13:28:17 +00:00
self.server = self.app.listen(self.port, self.hostname, () => {
self.port = self.server.address().port;
next();
});
},
function openBrowser(next) {
if (!self.openBrowser || self.opened) {
return next();
}
2018-09-04 13:20:58 +00:00
self.opened = true;
self.events.request('open-browser', next);
}
2018-10-03 20:49:25 +00:00
], function(err) {
2018-09-04 13:20:58 +00:00
if (err) {
return callback(err);
}
callback(null, self._getMessage(), self.port);
2018-09-04 13:20:58 +00:00
});
2017-12-17 23:34:41 +00:00
}
_getMessage() {
return __('webserver available at') + ' ' +
('http://' + canonicalHost(this.hostname) + ':' + this.port).bold.underline.green;
}
2018-09-06 20:06:07 +00:00
applyAPIFunction (cb, req, res) {
2018-10-03 20:21:59 +00:00
const authToken = (!res.send) ? req.protocol : req.headers.authorization;
this.events.request('authenticator:authorize', authToken, (err) => {
2018-09-06 20:06:07 +00:00
if (err) {
const send = res.send ? res.send.bind(res) : req.send.bind(req); // WS only has the first params
return send(err);
}
cb(req, res);
});
}
2017-12-17 23:34:41 +00:00
stop(callback) {
2018-08-27 20:22:53 +00:00
callback = callback || function () {};
if (!this.server || !this.server.listening) {
2018-08-10 14:09:56 +00:00
return callback(null, __("no webserver is currently running"));
}
2018-09-18 13:28:17 +00:00
this.server.close(function() {
2018-08-10 14:09:56 +00:00
callback(null, __("Webserver stopped"));
2017-12-17 23:34:41 +00:00
});
2017-03-30 11:12:39 +00:00
}
}
2016-08-21 15:02:50 +00:00
module.exports = Server;