@xen-orchestra/rest-api 0.14.0 → 0.16.0

package/dist/vms/vm.controller.mjs

@@ -11,24 +11,32 @@ import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Ta
 import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
-import { AlarmService } from '../alarms/alarm.service.mjs';
-import { asynchronousActionResp, createdResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { AlarmService, RAW_ALARM_FILTER } from '../alarms/alarm.service.mjs';
+import { asynchronousActionResp, createdResp, forbiddenOperationResp, incorrectStateResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { BASE_URL } from '../index.mjs';
 import { escapeUnsafeComplexMatcher, limitAndFilterArray } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { partialVms, vm, vmIds, vmStatsExample, vmVdis } from '../open-api/oa-examples/vm.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
-import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
+import { partialTasks, taskIds, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { VmService } from './vm.service.mjs';
+import { TaskService } from '../tasks/task.service.mjs';
+import { BackupJobService } from '../backup-jobs/backup-job.service.mjs';
+import { partialVmBackupJobs, vmBackupJobIds } from '../open-api/oa-examples/backup-job.oa-example.mjs';
+import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
 const IGNORED_VDIS_TAG = '[NOSNAP]';
 let VmController = class VmController extends XapiXoController {
     #alarmService;
     #vmService;
-    constructor(restApi, alarmService, vmService) {
+    #taskService;
+    #backupJobService;
+    constructor(restApi, alarmService, vmService, taskService, backupJobService) {
         super('VM', restApi);
         this.#alarmService = alarmService;
         this.#vmService = vmService;
+        this.#taskService = taskService;
+        this.#backupJobService = backupJobService;
     }
     /**
      *
@@ -39,6 +47,18 @@ let VmController = class VmController extends XapiXoController {
     getVms(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
+    /**
+     *
+     * Export VM. Compress is only used for XVA format
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async exportVm(req, id, format, compress) {
+        const stream = await this.#vmService.export(id, 'VM', { compress, format, response: req.res });
+        process.on('SIGTERM', () => req.destroy());
+        req.on('close', () => stream.destroy());
+        return stream;
+    }
     /**
      *
      * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
@@ -46,6 +66,13 @@ let VmController = class VmController extends XapiXoController {
     getVm(id) {
         return this.getObject(id);
     }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async deleteVm(id) {
+        const xapiVm = this.getXapiObject(id);
+        await xapiVm.$xapi.VM_destroy(xapiVm.$ref);
+    }
     /**
      *
      *  VM must be running
@@ -326,6 +353,50 @@ let VmController = class VmController extends XapiXoController {
         const vdis = this.#vmService.getVmVdis(id, 'VM');
         return this.sendObjects(limitAndFilterArray(vdis, { filter, limit }), req, obj => obj.type.toLowerCase() + 's');
     }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example fields "mode,name,type,id"
+     * @example filter "mode:full"
+     * @example limit 42
+     */
+    async vmGetVmBackupJobs(req, id, fields, ndjson, filter, limit) {
+        const backupJobs = await this.restApi.xoApp.getAllJobs('backup');
+        const vmBackupJobs = [];
+        for (const backupJob of backupJobs) {
+            if (await this.#backupJobService.isVmInBackupJob(backupJob.id, id)) {
+                vmBackupJobs.push(backupJob);
+            }
+        }
+        return this.sendObjects(limitAndFilterArray(vmBackupJobs, { filter, limit }), req, '/backup-jobs');
+    }
+    /**
+     * @example id "cef5f68c-61ae-3831-d2e6-1590d4934acf"
+     * @example fields "name,id,$object"
+     * @example filter "name:VM_STARTED"
+     * @example limit 42
+     */
+    getVmMessages(req, id, fields, ndjson, filter, limit) {
+        const vm = this.getObject(id);
+        const messages = this.restApi.getObjectsByType('message', {
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} $object:${vm.uuid} !${RAW_ALARM_FILTER}`,
+            limit,
+        });
+        return this.sendObjects(Object.values(messages), req, 'messages');
+    }
+    /**
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example fields "id,status,properties"
+     * @example filter "status:failure"
+     * @example limit 42
+     */
+    async getVmTasks(req, id, fields, ndjson, filter, limit) {
+        const vm = this.getObject(id);
+        const tasks = await this.#taskService.getTasks({
+            filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} |(properties:objectId:${vm.id} properties:params:id:${vm.id})`,
+            limit,
+        });
+        return this.sendObjects(tasks, req, 'tasks');
+    }
 };
 __decorate([
     Example(vmIds),
@@ -337,12 +408,30 @@ __decorate([
     __param(3, Query()),
     __param(4, Query())
 ], VmController.prototype, "getVms", null);
+__decorate([
+    Get('{id}.{format}'),
+    SuccessResponse(200, 'Download started', 'application/octet-stream'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(422, 'Invalid format, Invalid compress'),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Path()),
+    __param(3, Query())
+], VmController.prototype, "exportVm", null);
 __decorate([
     Example(vm),
     Get('{id}'),
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VmController.prototype, "getVm", null);
+__decorate([
+    Delete('{id}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(forbiddenOperationResp.status, forbiddenOperationResp.description),
+    Response(incorrectStateResp.status, incorrectStateResp.description),
+    __param(0, Path())
+], VmController.prototype, "deleteVm", null);
 __decorate([
     Example(vmStatsExample),
     Get('{id}/stats'),
@@ -489,6 +578,45 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VmController.prototype, "getVmVdis", null);
+__decorate([
+    Example(vmBackupJobIds),
+    Example(partialVmBackupJobs),
+    Get('{id}/backup-jobs'),
+    Tags('backup-jobs'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmController.prototype, "vmGetVmBackupJobs", null);
+__decorate([
+    Example(messageIds),
+    Example(partialMessages),
+    Get('{id}/messages'),
+    Tags('messages'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmController.prototype, "getVmMessages", null);
+__decorate([
+    Example(taskIds),
+    Example(partialTasks),
+    Get('{id}/tasks'),
+    Tags('tasks'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Request()),
+    __param(1, Path()),
+    __param(2, Query()),
+    __param(3, Query()),
+    __param(4, Query()),
+    __param(5, Query())
+], VmController.prototype, "getVmTasks", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),
@@ -500,6 +628,8 @@ VmController = __decorate([
     provide(VmController),
     __param(0, inject(RestApi)),
     __param(1, inject(AlarmService)),
-    __param(2, inject(VmService))
+    __param(2, inject(VmService)),
+    __param(3, inject(TaskService)),
+    __param(4, inject(BackupJobService))
 ], VmController);
 export { VmController };

package/dist/vms/vm.service.mjs

@@ -97,4 +97,22 @@ export class VmService {
         }
         return vdis;
     }
+    async export(id, vmType, { compress, format, response }) {
+        const xapiVm = this.#restApi.getXapiObject(id, vmType);
+        let stream;
+        if (format === 'xva') {
+            stream = (await xapiVm.$xapi.VM_export(xapiVm.$ref, { compress })).body;
+        }
+        else {
+            stream = await xapiVm.$xapi.exportVmOva(xapiVm.$ref);
+        }
+        if (response !== undefined) {
+            const headers = new Headers({
+                'content-disposition': `attachment; filename=${id}.${format}`,
+                'content-type': 'application/octet-stream',
+            });
+            response.setHeaders(headers);
+        }
+        return stream;
+    }
 }

package/dist/xoa/xoa.service.mjs

@@ -1,4 +1,5 @@
 import groupBy from 'lodash/groupBy.js';
+import { featureUnauthorized } from 'xo-common/api-errors.js';
 import semver from 'semver';
 import { BACKUP_TYPE, VM_POWER_STATE, } from '@vates/types';
 import { createLogger } from '@xen-orchestra/log';
@@ -167,11 +168,11 @@ export class XoaService {
         }
         return nHostsEol;
     }
+    /**
+     * Throw if no authorization
+     */
     async #getMissingPatchesInfo() {
         const missingPatchesInfo = await this.#hostService.getMissingPatchesInfo();
-        if (!missingPatchesInfo.hasAuthorization) {
-            return { hasAuthorization: false };
-        }
         const { hasAuthorization, nHostsFailed, nHostsWithMissingPatches, nPoolsWithMissingPatches } = missingPatchesInfo;
         return {
             hasAuthorization,
@@ -437,7 +438,16 @@ export class XoaService {
                 handleError: true,
             }),
             promiseWriteInStream({ maybePromise: this.#getPoolsStatus(), path: 'poolsStatus', stream }),
-            promiseWriteInStream({ maybePromise: this.#getMissingPatchesInfo(), path: 'missingPatches', stream }),
+            promiseWriteInStream({
+                maybePromise: this.#getMissingPatchesInfo().catch(err => {
+                    if (featureUnauthorized.is(err)) {
+                        return { hasAuthorization: false };
+                    }
+                    throw err;
+                }),
+                path: 'missingPatches',
+                stream,
+            }),
             promiseWriteInStream({
                 maybePromise: this.#getBackupRepositoriesSizeInfo(),
                 path: 'backupRepositories',