add route to list backups by site

This commit is contained in:
Girish Ramakrishnan
2025-10-06 14:10:29 +02:00
parent 1b33b2c48c
commit 43962c4a5a
5 changed files with 48 additions and 0 deletions
+13
View File
@@ -9,6 +9,7 @@ exports = module.exports = {
update,
setState,
list,
listBySiteId,
del,
removePrivateFields,
@@ -195,6 +196,18 @@ async function list(page, perPage) {
return results;
}
async function listBySiteId(siteId, page, perPage) {
assert.strictEqual(typeof siteId, 'string');
assert(typeof page === 'number' && page > 0);
assert(typeof perPage === 'number' && perPage > 0);
const results = await database.query(`SELECT ${BACKUPS_FIELDS} FROM backups WHERE siteId=? ORDER BY creationTime DESC LIMIT ?,?`, [ siteId, (page-1)*perPage, perPage ]);
results.forEach(function (result) { postProcess(result); });
return results;
}
async function del(id) {
assert.strictEqual(typeof id, 'string');
+16
View File
@@ -18,6 +18,7 @@ exports = module.exports = {
setContents,
setEncryption,
listBackups,
createBackup,
cleanup,
remount,
@@ -26,6 +27,7 @@ exports = module.exports = {
const assert = require('node:assert'),
AuditSource = require('../auditsource.js'),
backups = require('../backups.js'),
backupSites = require('../backupsites.js'),
BoxError = require('../boxerror.js'),
HttpError = require('@cloudron/connect-lastmile').HttpError,
@@ -254,3 +256,17 @@ async function getStatus(req, res, next) {
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, mountStatus));
}
async function listBackups(req, res, next) {
assert.strictEqual(typeof req.resources.backupSite, 'object');
const page = typeof req.query.page === 'string' ? parseInt(req.query.page) : 1;
if (!page || page < 0) return next(new HttpError(400, 'page query param has to be a postive number'));
const perPage = typeof req.query.per_page === 'string'? parseInt(req.query.per_page) : 25;
if (!perPage || perPage < 0) return next(new HttpError(400, 'per_page query param has to be a postive number'));
const [error, results] = await safe(backups.listBySiteId(req.resources.backupSite.id, page, perPage));
if (error) return next(BoxError.toHttpError(error));
next(new HttpSuccess(200, { backups: results }));
}
+9
View File
@@ -32,6 +32,15 @@ describe('Backups API', function () {
someBackup = response.body.backups[0];
});
it('can list by site id', async function () {
const site = await getDefaultBackupSite();
const response = await superagent.get(`${serverUrl}/api/v1/backup_sites/${site.id}/backups`)
.query({ access_token: admin.token });
expect(response.status).to.equal(200);
expect(response.body.backups.length).to.be(1);
});
it('cannot get random id', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/backups/bad_id`)
.query({ access_token: owner.token })
+9
View File
@@ -364,4 +364,13 @@ describe('Backups API', function () {
await waitForTask(response.body.taskId);
});
});
describe('listBySiteId', async function () {
it('succeeds', async function () {
const response = await superagent.get(`${serverUrl}/api/v1/backup_sites/${newSite.id}/backups`)
.query({ access_token: admin.token });
expect(response.status).to.equal(200);
expect(response.body.backups).to.be.an(Array);
});
});
});
+1
View File
@@ -163,6 +163,7 @@ async function initializeExpressSync() {
router.post('/api/v1/backup_sites', json, token, authorizeOwner, routes.backupSites.add);
router.del ('/api/v1/backup_sites/:id', token, authorizeOwner, routes.backupSites.load, routes.backupSites.del);
router.get ('/api/v1/backup_sites/:id/status', token, authorizeAdmin, routes.backupSites.load, routes.backupSites.getStatus);
router.get ('/api/v1/backup_sites/:id/backups', token, authorizeAdmin, routes.backupSites.load, routes.backupSites.listBackups);
router.post('/api/v1/backup_sites/:id/create_backup', token, authorizeAdmin, routes.backupSites.load, routes.backupSites.createBackup);
router.post('/api/v1/backup_sites/:id/cleanup', json, token, authorizeAdmin, routes.backupSites.load, routes.backupSites.cleanup);
router.post('/api/v1/backup_sites/:id/remount', json, token, authorizeAdmin, routes.backupSites.load, routes.backupSites.remount);