move server routes into /system

This commit is contained in:
Girish Ramakrishnan
2023-08-04 13:41:13 +05:30
parent 1264cd1dd7
commit 2cdbf4d2c5
12 changed files with 457 additions and 509 deletions
+5 -137
View File
@@ -6,24 +6,17 @@ exports = module.exports = {
passwordResetRequest,
passwordReset,
setupAccount,
reboot,
isRebootRequired,
getConfig,
getDisks,
getDiskUsage,
updateDiskUsage,
getMemory,
getLogs,
getLogStream,
updateDashboardDomain,
prepareDashboardDomain,
getLanguages,
getSystemGraphs,
getPlatformStatus,
getBlockDevices,
getPlatformStatus,
getLanguages,
getLanguage,
setLanguage,
getTimeZone,
setTimeZone
};
@@ -35,13 +28,11 @@ const assert = require('assert'),
constants = require('../constants.js'),
debug = require('debug')('box:routes/cloudron'),
eventlog = require('../eventlog.js'),
graphs = require('../graphs.js'),
HttpError = require('connect-lastmile').HttpError,
HttpSuccess = require('connect-lastmile').HttpSuccess,
platform = require('../platform.js'),
safe = require('safetydance'),
speakeasy = require('speakeasy'),
system = require('../system.js'),
tokens = require('../tokens.js'),
translation = require('../translation.js'),
users = require('../users.js');
@@ -141,20 +132,6 @@ async function setupAccount(req, res, next) {
next(new HttpSuccess(201, { accessToken }));
}
async function reboot(req, res, next) {
// Finish the request, to let the appstore know we triggered the reboot
next(new HttpSuccess(202, {}));
await safe(cloudron.reboot());
}
async function isRebootRequired(req, res, next) {
const [error, rebootRequired] = await safe(cloudron.isRebootRequired());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, { rebootRequired }));
}
async function getConfig(req, res, next) {
const [error, cloudronConfig] = await safe(cloudron.getConfig());
if (error) return next(BoxError.toHttpError(error));
@@ -162,97 +139,6 @@ async function getConfig(req, res, next) {
next(new HttpSuccess(200, cloudronConfig));
}
async function getDisks(req, res, next) {
const [getDisksError, disks] = await safe(system.getDisks());
if (getDisksError) return next(BoxError.toHttpError(getDisksError));
let [getSwapsError, swaps] = await safe(system.getSwaps());
if (getSwapsError) return next(BoxError.toHttpError(getSwapsError));
next(new HttpSuccess(200, { disks, swaps }));
}
async function getDiskUsage(req, res, next) {
const [error, result] = await safe(system.getDiskUsage());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, { usage: result }));
}
async function updateDiskUsage(req, res, next) {
const [error, taskId] = await safe(cloudron.updateDiskUsage());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(201, { taskId }));
}
async function getMemory(req, res, next) {
const [error, result] = await safe(system.getMemory());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, result));
}
async function getLogs(req, res, next) {
assert.strictEqual(typeof req.params.unit, 'string');
const lines = 'lines' in req.query ? parseInt(req.query.lines, 10) : 10; // we ignore last-event-id
if (isNaN(lines)) return next(new HttpError(400, 'lines must be a number'));
const options = {
lines: lines,
follow: false,
format: req.query.format || 'json'
};
const [error, logStream] = await safe(cloudron.getLogs(req.params.unit, options));
if (error) return next(BoxError.toHttpError(error));
res.writeHead(200, {
'Content-Type': 'application/x-logs',
'Content-Disposition': `attachment; filename="${req.params.unit}.log"`,
'Cache-Control': 'no-cache',
'X-Accel-Buffering': 'no' // disable nginx buffering
});
logStream.pipe(res);
}
async function getLogStream(req, res, next) {
assert.strictEqual(typeof req.params.unit, 'string');
const lines = 'lines' in req.query ? parseInt(req.query.lines, 10) : 10; // we ignore last-event-id
if (isNaN(lines)) return next(new HttpError(400, 'lines must be a valid number'));
function sse(id, data) { return 'id: ' + id + '\ndata: ' + data + '\n\n'; }
if (req.headers.accept !== 'text/event-stream') return next(new HttpError(400, 'This API call requires EventStream'));
const options = {
lines: lines,
follow: true,
format: req.query.format || 'json'
};
const [error, logStream] = await safe(cloudron.getLogs(req.params.unit, options));
if (error) return next(BoxError.toHttpError(error));
res.writeHead(200, {
'Content-Type': 'text/event-stream',
'Cache-Control': 'no-cache',
'Connection': 'keep-alive',
'X-Accel-Buffering': 'no', // disable nginx buffering
'Access-Control-Allow-Origin': '*'
});
res.write('retry: 3000\n');
res.on('close', logStream.close);
logStream.on('data', function (data) {
const obj = JSON.parse(data);
res.write(sse(obj.realtimeTimestamp, JSON.stringify(obj))); // send timestamp as id
});
logStream.on('end', res.end.bind(res));
logStream.on('error', res.end.bind(res, null));
}
async function updateDashboardDomain(req, res, next) {
if (!req.body.domain || typeof req.body.domain !== 'string') return next(new HttpError(400, 'domain must be a string'));
@@ -278,28 +164,10 @@ async function getLanguages(req, res, next) {
next(new HttpSuccess(200, { languages }));
}
async function getSystemGraphs(req, res, next) {
if (!req.query.fromMinutes || !parseInt(req.query.fromMinutes)) return next(new HttpError(400, 'fromMinutes must be a number'));
const fromMinutes = parseInt(req.query.fromMinutes);
const noNullPoints = !!req.query.noNullPoints;
const [error, result] = await safe(graphs.getSystem(fromMinutes, noNullPoints));
if (error) return next(new HttpError(500, error));
next(new HttpSuccess(200, result));
}
async function getPlatformStatus(req, res, next) {
next(new HttpSuccess(200, platform.getStatus()));
}
async function getBlockDevices(req, res, next) {
const [error, devices] = await safe(cloudron.getBlockDevices());
if (error) return next(new HttpError(500, error));
next(new HttpSuccess(200, { devices }));
}
async function getTimeZone(req, res, next) {
const [error, timeZone] = await safe(cloudron.getTimeZone());
if (error) return next(BoxError.toHttpError(error));
+2 -1
View File
@@ -22,10 +22,11 @@ exports = module.exports = {
oidc: require('./oidc.js'),
profile: require('./profile.js'),
provision: require('./provision.js'),
reverseProxy: require('./reverseProxy.js'),
reverseProxy: require('./reverseproxy.js'),
services: require('./services.js'),
settings: require('./settings.js'),
support: require('./support.js'),
system: require('./system.js'),
tasks: require('./tasks.js'),
tokens: require('./tokens.js'),
updater: require('./updater.js'),
+145
View File
@@ -0,0 +1,145 @@
'use strict';
exports = module.exports = {
reboot,
isRebootRequired,
getDisks,
getDiskUsage,
updateDiskUsage,
getMemory,
getLogs,
getLogStream,
getSystemGraphs,
getBlockDevices,
};
const assert = require('assert'),
BoxError = require('../boxerror.js'),
graphs = require('../graphs.js'),
HttpError = require('connect-lastmile').HttpError,
HttpSuccess = require('connect-lastmile').HttpSuccess,
safe = require('safetydance'),
system = require('../system.js');
async function reboot(req, res, next) {
// Finish the request, to let the appstore know we triggered the reboot
next(new HttpSuccess(202, {}));
await safe(system.reboot());
}
async function isRebootRequired(req, res, next) {
const [error, rebootRequired] = await safe(system.isRebootRequired());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, { rebootRequired }));
}
async function getDisks(req, res, next) {
const [getDisksError, disks] = await safe(system.getDisks());
if (getDisksError) return next(BoxError.toHttpError(getDisksError));
let [getSwapsError, swaps] = await safe(system.getSwaps());
if (getSwapsError) return next(BoxError.toHttpError(getSwapsError));
next(new HttpSuccess(200, { disks, swaps }));
}
async function getDiskUsage(req, res, next) {
const [error, result] = await safe(system.getDiskUsage());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, { usage: result }));
}
async function updateDiskUsage(req, res, next) {
const [error, taskId] = await safe(system.startUpdateDiskUsage());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(201, { taskId }));
}
async function getMemory(req, res, next) {
const [error, result] = await safe(system.getMemory());
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, result));
}
async function getLogs(req, res, next) {
assert.strictEqual(typeof req.params.unit, 'string');
const lines = 'lines' in req.query ? parseInt(req.query.lines, 10) : 10; // we ignore last-event-id
if (isNaN(lines)) return next(new HttpError(400, 'lines must be a number'));
const options = {
lines: lines,
follow: false,
format: req.query.format || 'json'
};
const [error, logStream] = await safe(system.getLogs(req.params.unit, options));
if (error) return next(BoxError.toHttpError(error));
res.writeHead(200, {
'Content-Type': 'application/x-logs',
'Content-Disposition': `attachment; filename="${req.params.unit}.log"`,
'Cache-Control': 'no-cache',
'X-Accel-Buffering': 'no' // disable nginx buffering
});
logStream.pipe(res);
}
async function getLogStream(req, res, next) {
assert.strictEqual(typeof req.params.unit, 'string');
const lines = 'lines' in req.query ? parseInt(req.query.lines, 10) : 10; // we ignore last-event-id
if (isNaN(lines)) return next(new HttpError(400, 'lines must be a valid number'));
function sse(id, data) { return 'id: ' + id + '\ndata: ' + data + '\n\n'; }
if (req.headers.accept !== 'text/event-stream') return next(new HttpError(400, 'This API call requires EventStream'));
const options = {
lines: lines,
follow: true,
format: req.query.format || 'json'
};
const [error, logStream] = await safe(system.getLogs(req.params.unit, options));
if (error) return next(BoxError.toHttpError(error));
res.writeHead(200, {
'Content-Type': 'text/event-stream',
'Cache-Control': 'no-cache',
'Connection': 'keep-alive',
'X-Accel-Buffering': 'no', // disable nginx buffering
'Access-Control-Allow-Origin': '*'
});
res.write('retry: 3000\n');
res.on('close', logStream.close);
logStream.on('data', function (data) {
const obj = JSON.parse(data);
res.write(sse(obj.realtimeTimestamp, JSON.stringify(obj))); // send timestamp as id
});
logStream.on('end', res.end.bind(res));
logStream.on('error', res.end.bind(res, null));
}
async function getSystemGraphs(req, res, next) {
if (!req.query.fromMinutes || !parseInt(req.query.fromMinutes)) return next(new HttpError(400, 'fromMinutes must be a number'));
const fromMinutes = parseInt(req.query.fromMinutes);
const noNullPoints = !!req.query.noNullPoints;
const [error, result] = await safe(graphs.getSystem(fromMinutes, noNullPoints));
if (error) return next(new HttpError(500, error));
next(new HttpSuccess(200, result));
}
async function getBlockDevices(req, res, next) {
const [error, devices] = await safe(system.getBlockDevices());
if (error) return next(new HttpError(500, error));
next(new HttpSuccess(200, { devices }));
}
+1 -235
View File
@@ -8,16 +8,11 @@
const constants = require('../../constants.js'),
common = require('./common.js'),
expect = require('expect.js'),
fs = require('fs'),
http = require('http'),
os = require('os'),
paths = require('../../paths.js'),
safe = require('safetydance'),
superagent = require('superagent'),
settings = require('../../settings.js');
describe('Cloudron API', function () {
const { setup, cleanup, serverUrl, owner, user, waitForTask } = common;
const { setup, cleanup, serverUrl, owner, user } = common;
before(setup);
after(cleanup);
@@ -300,136 +295,6 @@ describe('Cloudron API', function () {
});
});
describe('logs', function () {
before(function () {
console.log(paths.BOX_LOG_FILE);
fs.writeFileSync(paths.BOX_LOG_FILE, '2022-11-06T15:06:20.009Z box:apphealthmonitor app health: 0 alive / 0 dead.\n', 'utf8');
});
it('logStream - requires event-stream accept header', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/logstream/box`)
.query({ access_token: owner.token, fromLine: 0 })
.ok(() => true);
expect(response.statusCode).to.be(400);
});
it('logStream - stream logs', function (done) {
const options = {
host: 'localhost',
port: constants.PORT,
path: '/api/v1/cloudron/logstream/box?lines=10&access_token=' + owner.token,
headers: { 'Accept': 'text/event-stream', 'Connection': 'keep-alive' }
};
// superagent doesn't work. maybe https://github.com/visionmedia/superagent/issues/420
const req = http.get(options, function (res) {
let data = '';
res.on('data', function (d) { data += d.toString('utf8'); });
setTimeout(function checkData() {
let dataMessageFound = false;
expect(data.length).to.not.be(0);
data.split('\n').forEach(function (line) {
if (line.indexOf('id: ') === 0) {
expect(parseInt(line.substr('id: '.length), 10)).to.be.a('number');
} else if (line.indexOf('data: ') === 0) {
const message = JSON.parse(line.slice('data: '.length)).message;
if (Array.isArray(message) || typeof message === 'string') dataMessageFound = true;
}
});
expect(dataMessageFound).to.be.ok();
res.destroy();
req.destroy();
done();
}, 1000);
res.on('error', done);
});
req.on('error', done);
});
});
describe('memory', function () {
it('cannot get without token', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/memory`)
.ok(() => true);
expect(response.statusCode).to.equal(401);
});
it('succeeds (admin)', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/memory`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.memory).to.eql(os.totalmem());
expect(response.body.swap).to.be.a('number');
});
it('fails (non-admin)', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/memory`)
.query({ access_token: user.token })
.ok(() => true);
expect(response.statusCode).to.equal(403);
});
});
describe('disks', function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/disks`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.disks).to.be.ok();
expect(Object.keys(response.body.disks).some(fs => response.body.disks[fs].mountpoint === '/')).to.be(true);
});
});
describe('disk usage', function () {
it('get succeeds with no cache', async function () {
safe.fs.unlinkSync(paths.DISK_USAGE_FILE);
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/disk_usage`)
.query({ access_token: owner.token })
.send({});
expect(response.statusCode).to.equal(200);
expect(response.body).to.eql({ usage: null });
});
it('update the cache', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/disk_usage`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(201);
expect(response.body.taskId).to.be.ok();
await waitForTask(response.body.taskId);
});
it('get succeeds with cache', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/disk_usage`)
.query({ access_token: owner.token })
.send({});
expect(response.statusCode).to.equal(200);
expect(response.body.usage.ts).to.be.a('number');
const filesystems = Object.keys(response.body.usage.disks);
let dockerUsage = null;
for (const fs of filesystems) {
for (const content of response.body.usage.disks[fs].contents) {
if (content.id === 'docker') dockerUsage = content;
}
}
expect(dockerUsage).to.be.ok();
expect(dockerUsage.usage).to.be.a('number');
});
});
describe('languages', function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/languages`);
@@ -439,103 +304,4 @@ describe('Cloudron API', function () {
expect(response.body.languages.indexOf('en')).to.not.equal(-1);
});
});
describe('blockdevices', function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/block_devices`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.devices).to.be.ok();
expect(response.body.devices.some(d => d.mountpoint === '/')).to.be(true);
});
});
describe('time_zone', function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/time_zone`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.timeZone).to.be('UTC');
});
it('cannot set tz with missing timeZone', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/time_zone`)
.query({ access_token: owner.token })
.send({ foo: 'bar' })
.ok(() => true);
expect(response.statusCode).to.equal(400);
});
it('cannot set language with invalid timeZone', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/time_zone`)
.query({ access_token: owner.token })
.send({ timeZone: 'doesnotexist' })
.ok(() => true);
expect(response.statusCode).to.equal(400);
});
it('can set time zone', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/time_zone`)
.query({ access_token: owner.token })
.send({ timeZone: 'Africa/Johannesburg' });
expect(response.statusCode).to.equal(200);
});
it('did set time zone', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/time_zone`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.timeZone).to.equal('Africa/Johannesburg');
});
});
describe('language', function () {
it('can get default language', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/language`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.language).to.equal('en');
});
it('cannot set language with missing language', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/language`)
.query({ access_token: owner.token })
.send({ foo: 'bar' })
.ok(() => true);
expect(response.statusCode).to.equal(400);
});
it('cannot set language with invalid language', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/language`)
.query({ access_token: owner.token })
.send({ language: 'doesnotexist' })
.ok(() => true);
expect(response.statusCode).to.equal(400);
});
it('can set language', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/cloudron/language`)
.query({ access_token: owner.token })
.send({ language: 'de' });
expect(response.statusCode).to.equal(200);
});
it('did set language', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/cloudron/language`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.language).to.equal('de');
});
});
});
+165
View File
@@ -0,0 +1,165 @@
'use strict';
/* global it:false */
/* global describe:false */
/* global before:false */
/* global after:false */
const constants = require('../../constants.js'),
common = require('./common.js'),
expect = require('expect.js'),
fs = require('fs'),
http = require('http'),
os = require('os'),
paths = require('../../paths.js'),
safe = require('safetydance'),
superagent = require('superagent');
describe('Cloudron API', function () {
const { setup, cleanup, serverUrl, owner, user, waitForTask } = common;
before(setup);
after(cleanup);
describe('logs', function () {
before(function () {
console.log(paths.BOX_LOG_FILE);
fs.writeFileSync(paths.BOX_LOG_FILE, '2022-11-06T15:06:20.009Z box:apphealthmonitor app health: 0 alive / 0 dead.\n', 'utf8');
});
it('logStream - requires event-stream accept header', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/logstream/box`)
.query({ access_token: owner.token, fromLine: 0 })
.ok(() => true);
expect(response.statusCode).to.be(400);
});
it('logStream - stream logs', function (done) {
const options = {
host: 'localhost',
port: constants.PORT,
path: '/api/v1/system/logstream/box?lines=10&access_token=' + owner.token,
headers: { 'Accept': 'text/event-stream', 'Connection': 'keep-alive' }
};
// superagent doesn't work. maybe https://github.com/visionmedia/superagent/issues/420
const req = http.get(options, function (res) {
let data = '';
res.on('data', function (d) { data += d.toString('utf8'); });
setTimeout(function checkData() {
let dataMessageFound = false;
expect(data.length).to.not.be(0);
data.split('\n').forEach(function (line) {
if (line.indexOf('id: ') === 0) {
expect(parseInt(line.substr('id: '.length), 10)).to.be.a('number');
} else if (line.indexOf('data: ') === 0) {
const message = JSON.parse(line.slice('data: '.length)).message;
if (Array.isArray(message) || typeof message === 'string') dataMessageFound = true;
}
});
expect(dataMessageFound).to.be.ok();
res.destroy();
req.destroy();
done();
}, 1000);
res.on('error', done);
});
req.on('error', done);
});
});
describe('memory', function () {
it('cannot get without token', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/memory`)
.ok(() => true);
expect(response.statusCode).to.equal(401);
});
it('succeeds (admin)', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/memory`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.memory).to.eql(os.totalmem());
expect(response.body.swap).to.be.a('number');
});
it('fails (non-admin)', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/memory`)
.query({ access_token: user.token })
.ok(() => true);
expect(response.statusCode).to.equal(403);
});
});
describe('disks', function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/disks`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.disks).to.be.ok();
expect(Object.keys(response.body.disks).some(fs => response.body.disks[fs].mountpoint === '/')).to.be(true);
});
});
describe('disk usage', function () {
it('get succeeds with no cache', async function () {
safe.fs.unlinkSync(paths.DISK_USAGE_FILE);
const response = await superagent.get(`${serverUrl}/api/v1/system/disk_usage`)
.query({ access_token: owner.token })
.send({});
expect(response.statusCode).to.equal(200);
expect(response.body).to.eql({ usage: null });
});
it('update the cache', async function () {
const response = await superagent.post(`${serverUrl}/api/v1/system/disk_usage`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(201);
expect(response.body.taskId).to.be.ok();
await waitForTask(response.body.taskId);
});
it('get succeeds with cache', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/disk_usage`)
.query({ access_token: owner.token })
.send({});
expect(response.statusCode).to.equal(200);
expect(response.body.usage.ts).to.be.a('number');
const filesystems = Object.keys(response.body.usage.disks);
let dockerUsage = null;
for (const fs of filesystems) {
for (const content of response.body.usage.disks[fs].contents) {
if (content.id === 'docker') dockerUsage = content;
}
}
expect(dockerUsage).to.be.ok();
expect(dockerUsage.usage).to.be.a('number');
});
});
describe('blockdevices', function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/system/block_devices`)
.query({ access_token: owner.token });
expect(response.statusCode).to.equal(200);
expect(response.body.devices).to.be.ok();
expect(response.body.devices.some(d => d.mountpoint === '/')).to.be(true);
});
});
});