@xen-orchestra/rest-api 0.21.0 → 0.21.2

package/dist/abstract-classes/base-controller.mjs

@@ -1,4 +1,3 @@
-import * as CM from 'complex-matcher';
 import { Controller } from 'tsoa';
 import { createGzip } from 'node:zlib';
 import { pipeline } from 'node:stream/promises';
@@ -6,7 +5,7 @@ import { Readable } from 'node:stream';
 import { BASE_URL } from '../index.mjs';
 import { makeNdJsonStream } from '../helpers/stream.helper.mjs';
 import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
-import { NDJSON_CONTENT_TYPE } from '../helpers/utils.helper.mjs';
+import { NDJSON_CONTENT_TYPE, safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 const noop = () => { };
 export class BaseController extends Controller {
     restApi;
@@ -34,7 +33,7 @@ export class BaseController extends Controller {
         const objectFilter = (task) => task.properties.objectId === object.id || task.properties.params?.id === object.id;
         let userFilter = () => true;
         if (filter !== undefined) {
-            userFilter = typeof filter === 'string' ? CM.parse(filter).createPredicate() : filter;
+            userFilter = typeof filter === 'string' ? safeParseComplexMatcher(filter).createPredicate() : filter;
         }
         for await (const task of this.restApi.tasks.list({ filter: objectFilter })) {
             if (limit === 0) {

package/dist/alarms/alarm.service.mjs

@@ -1,10 +1,10 @@
-import * as CM from 'complex-matcher';
 import { BASE_URL } from '../index.mjs';
+import { safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 // E.g: 'value: 0.6\nconfig:\n<variable>\n<name value="cpu_usage"/>\n<alarm_trigger_level value="0.4"/>\n<alarm_trigger_period value ="60"/>\n</variable>';
 const ALARM_BODY_REGEX = /^value:\s*(Infinity|NaN|-Infinity|\d+(?:\.\d+)?)\s*config:\s*<variable>\s*<name value="(.*?)"/;
 const ALARM_NAMES = ['ALARM', 'BOND_STATUS_CHANGED', 'MULTIPATH_PERIODIC_ALERT'];
 export const RAW_ALARM_FILTER = `name:|(${ALARM_NAMES.join(' ')})`;
-export const alarmPredicate = CM.parse(RAW_ALARM_FILTER).createPredicate();
+export const alarmPredicate = safeParseComplexMatcher(RAW_ALARM_FILTER).createPredicate();
 export class AlarmService {
     #restApi;
     constructor(restApi) {
@@ -50,7 +50,7 @@ export class AlarmService {
         });
         let userFilter = () => true;
         if (filter !== undefined) {
-            userFilter = typeof filter === 'string' ? CM.parse(filter).createPredicate() : filter;
+            userFilter = typeof filter === 'string' ? safeParseComplexMatcher(filter).createPredicate() : filter;
         }
         const alarms = {};
         for (const id in rawAlarms) {

package/dist/backup-archives/backup-archive.controller.mjs

@@ -30,6 +30,7 @@ let BackupArchiveController = class BackupArchiveController extends XoController
         }
         const backupArchivesByRemote = await this.restApi.xoApp.listVmBackupsNg(backupRepositoryIds);
         const vmBackupArchives = Object.values(backupArchivesByRemote)
+            .filter(backupsByVm => backupsByVm !== undefined)
             .map(backupsByVm => Object.values(backupsByVm))
             .flat(2);
         return vmBackupArchives;

package/dist/backup-jobs/backup-job.controller.mjs

@@ -7,7 +7,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import * as CM from 'complex-matcher';
 import { createLogger } from '@xen-orchestra/log';
 import { inject } from 'inversify';
 import { noSuchObject } from 'xo-common/api-errors.js';
@@ -17,7 +16,7 @@ import { backupLog, backupLogIds, partialBackupLogs } from '../open-api/oa-examp
 import { BackupLogService } from '../backup-logs/backup-log.service.mjs';
 import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
-import { limitAndFilterArray } from '../helpers/utils.helper.mjs';
+import { limitAndFilterArray, safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
 import { metadataBackupJob, metadataBackupJobIds, mirrorBackupJob, mirrorBackupJobIds, partialMetadataBackupJobs, partialMirrorBackupJobs, partialVmBackupJobs, vmBackupJob, vmBackupJobIds, } from '../open-api/oa-examples/backup-job.oa-example.mjs';
 import { BASE_URL } from '../index.mjs';
@@ -171,7 +170,7 @@ let DeprecatedBackupController = class DeprecatedBackupController extends XoCont
      * @example limit 42
      */
     async getDeprecatedBackupLogs(req, fields, ndjson, filter, limit) {
-        const userFilter = filter === undefined ? () => true : CM.parse(filter).createPredicate();
+        const userFilter = filter === undefined ? () => true : safeParseComplexMatcher(filter).createPredicate();
         const predicate = (log) => {
             if (!this.#backupLogService.isBackupLog(log)) {
                 return false;

package/dist/helpers/error.helper.mjs

@@ -1,10 +1,15 @@
 export class ApiError extends Error {
     #status;
-    constructor(message, status) {
+    #data;
+    constructor(message, status, opts = {}) {
         super(message);
         this.#status = status;
+        this.#data = opts.data;
     }
     get status() {
         return this.#status;
     }
+    get data() {
+        return this.#data;
+    }
 }

package/dist/helpers/utils.helper.mjs

@@ -1,6 +1,7 @@
 import * as CM from 'complex-matcher';
 import { createLogger } from '@xen-orchestra/log';
 import { isPromise } from 'node:util/types';
+import { ApiError } from './error.helper.mjs';
 export const NDJSON_CONTENT_TYPE = 'application/x-ndjson';
 const log = createLogger('xo:rest-api:utils-helper');
 export const isSrWritable = (sr) => isSrWritableOrIso(sr) && sr.content_type !== 'iso';
@@ -76,9 +77,22 @@ export function escapeUnsafeComplexMatcher(maybeString) {
     }
     return `(${maybeString})`;
 }
+export function safeParseComplexMatcher(string) {
+    try {
+        return CM.parse(string);
+    }
+    catch (_error) {
+        // CM.parse only throw errors that are instances of Error
+        const error = _error;
+        const apiError = new ApiError(error.message, 400, { data: { stringToParse: string } });
+        apiError.cause = error;
+        apiError.stack = error.stack;
+        throw apiError;
+    }
+}
 export function limitAndFilterArray(array, { filter, limit = Infinity } = {}) {
     if (filter !== undefined) {
-        const predicate = typeof filter === 'string' ? CM.parse(filter).createPredicate() : filter;
+        const predicate = typeof filter === 'string' ? safeParseComplexMatcher(filter).createPredicate() : filter;
         array = array.filter(predicate);
     }
     if (limit < array.length) {

package/dist/index.mjs

@@ -12,6 +12,7 @@ const swaggerOpenApiSpec = require('../open-api/spec/swagger.json');
 export const BASE_URL = '/rest/v0';
 const SWAGGER_UI_OPTIONS = {
     swaggerOptions: {
+        url: `${BASE_URL}/docs/swagger.json`,
         displayRequestDuration: true,
         docExpansion: 'none', // collapse all tags by default
         filter: true, // add a tags searchbar,
@@ -40,7 +41,7 @@ export default function setupRestApi(express, xoApp) {
     });
     // do not register the doc at the root level, or it may lead to unwanted behaviour
     express.get('/rest/v0', (_req, res) => res.redirect('/rest/v0/docs'));
-    express.use(`${BASE_URL}/docs`, swaggerUi.serve, swaggerUi.setup(swaggerOpenApiSpec, SWAGGER_UI_OPTIONS));
+    express.use(`${BASE_URL}/docs`, swaggerUi.serveFiles(undefined, SWAGGER_UI_OPTIONS), swaggerUi.setup(null, SWAGGER_UI_OPTIONS));
     express.use(BASE_URL, tsoaToXoErrorHandler);
     express.use(BASE_URL, genericErrorHandler);
 }

package/dist/messages/message.controller.mjs

@@ -7,7 +7,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import * as CM from 'complex-matcher';
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
 import { noSuchObject } from 'xo-common/api-errors.js';
@@ -17,6 +16,7 @@ import { message, messageIds, partialMessages } from '../open-api/oa-examples/me
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+import { safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 let MessageController = class MessageController extends XapiXoController {
     constructor(restapi) {
         super('message', restapi);
@@ -27,7 +27,7 @@ let MessageController = class MessageController extends XapiXoController {
     getObjects({ filter, limit = Infinity } = {}) {
         let userfilter = () => true;
         if (filter !== undefined) {
-            userfilter = CM.parse(filter).createPredicate();
+            userfilter = safeParseComplexMatcher(filter).createPredicate();
         }
         const messagePredicate = (obj) => !alarmPredicate(obj) && userfilter(obj);
         return super.getObjects({ filter: messagePredicate, limit });

package/dist/open-api/routes/routes.js

@@ -105,7 +105,7 @@ const models = {
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "XoGuiRoutes": {
         "dataType": "refAlias",
-        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "xo6": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }], "required": true }, "xo5": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }], "required": true } }, "validators": {} },
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "xo6": { "dataType": "string" }, "xo5": { "dataType": "string" } }, "validators": {} },
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Record_string.string_": {
@@ -350,7 +350,7 @@ const models = {
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "UnbrandedVmDashboard": {
         "dataType": "refAlias",
-        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "backupsInfo": { "dataType": "nestedObjectLiteral", "nestedProperties": { "backupArchives": { "dataType": "array", "array": { "dataType": "refAlias", "ref": "Unbrand_VmDashboardBackupArchive_" }, "required": true }, "replication": { "ref": "Unbrand_VmDashboard-at-backupsInfo_91_replication_93__" }, "vmProtected": { "dataType": "boolean", "required": true }, "lastRuns": { "dataType": "array", "array": { "dataType": "refAlias", "ref": "Unbrand_VmDashboardRun_" }, "required": true } }, "required": true }, "alarms": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "quickInfo": { "dataType": "intersection", "subSchemas": [{ "ref": "Omit_Unbrand_VmDashboard-at-quickInfo_.creation_" }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "creation": { "ref": "Unbrand_VmDashboard-at-quickInfo_91_creation_93__", "required": true } } }], "required": true } }, "validators": {} },
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "backupsInfo": { "dataType": "nestedObjectLiteral", "nestedProperties": { "backupArchives": { "dataType": "array", "array": { "dataType": "refAlias", "ref": "Unbrand_VmDashboardBackupArchive_" }, "required": true }, "replication": { "ref": "Unbrand_VmDashboard-at-backupsInfo_91_replication_93__" }, "vmProtection": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["protected"] }, { "dataType": "enum", "enums": ["unprotected"] }, { "dataType": "enum", "enums": ["not-in-job"] }], "required": true }, "lastRuns": { "dataType": "array", "array": { "dataType": "refAlias", "ref": "Unbrand_VmDashboardRun_" }, "required": true } }, "required": true }, "alarms": { "dataType": "array", "array": { "dataType": "string" }, "required": true }, "quickInfo": { "dataType": "intersection", "subSchemas": [{ "ref": "Omit_Unbrand_VmDashboard-at-quickInfo_.creation_" }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "creation": { "ref": "Unbrand_VmDashboard-at-quickInfo_91_creation_93__", "required": true } } }], "required": true } }, "validators": {} },
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Partial_Unbrand_XoVmTemplate__": {

package/dist/rest-api/rest-api.mjs

@@ -1,6 +1,6 @@
-import * as CM from 'complex-matcher';
 import { createLogger } from '@xen-orchestra/log';
 import { invalidCredentials } from 'xo-common/api-errors.js';
+import { safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 const log = createLogger('xo:rest-api:error-handler');
 export class RestApi {
     #ioc;
@@ -34,7 +34,7 @@ export class RestApi {
     }
     getObjectsByType(type, { filter, ...opts } = {}) {
         if (filter !== undefined && typeof filter === 'string') {
-            filter = CM.parse(filter).createPredicate();
+            filter = safeParseComplexMatcher(filter).createPredicate();
         }
         return this.#xoApp.getObjectsByType(type, { filter, ...opts });
     }

package/dist/tasks/task.controller.mjs

@@ -7,7 +7,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import * as CM from 'complex-matcher';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
 import { Get, Path, Query, Request, Route, Security, Tags, Response, Example, Delete, Post, SuccessResponse, } from 'tsoa';
 import { asynchronousActionResp, badRequestResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
@@ -17,6 +16,7 @@ import pDefer from 'promise-toolbox/defer';
 import { ApiError } from '../helpers/error.helper.mjs';
 import { Transform } from 'node:stream';
 import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
+import { safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 let TaskController = class TaskController extends XoController {
     async getAllCollectionObjects() {
         const result = [];
@@ -41,7 +41,7 @@ let TaskController = class TaskController extends XoController {
             if (!ndjson) {
                 throw new ApiError('watch=true requires ndjson=true', 400);
             }
-            const userFilter = filter === undefined ? undefined : CM.parse(filter).createPredicate();
+            const userFilter = filter === undefined ? undefined : safeParseComplexMatcher(filter).createPredicate();
             const stream = new Transform({
                 objectMode: true,
                 transform([event, object], encoding, callback) {

package/dist/vms/vm.service.mjs

@@ -239,29 +239,32 @@ export class VmService {
                 status,
             };
         });
-        let isProtected = false;
+        let vmProtection = 'not-in-job';
         if (!vmContainsNoBakTag(vm)) {
             const backupLogsByJob = groupBy(backupLogs, 'jobId');
             for (const backupJob of relevantJobsWithSchedule) {
-                if (isProtected) {
+                if (vmProtection === 'protected') {
                     break;
                 }
+                vmProtection = 'unprotected';
                 // can be undefined if the backup did run for now
                 const jobLogs = backupLogsByJob[backupJob.id]
                     ?.filter(log => log.status !== 'pending')
                     .slice(-3);
                 if (jobLogs !== undefined) {
-                    isProtected = jobLogs.every(log => {
+                    vmProtection = jobLogs.every(log => {
                         if (log.status === 'success') {
                             return true;
                         }
                         const vmTaskLog = this.#backupLogService.getVmBackupTaskLog(log, id);
                         return vmTaskLog?.status === 'success';
-                    });
+                    })
+                        ? 'protected'
+                        : 'unprotected';
                 }
             }
         }
-        return { lastRuns: lastBackupRuns, vmProtected: isProtected };
+        return { lastRuns: lastBackupRuns, vmProtection };
     }
     async #getLastVmBackupArchives(id) {
         const vm = this.#restApi.getObject(id, 'VM');
@@ -274,7 +277,7 @@ export class VmService {
             .map(ba => ({ id: ba.id, timestamp: ba.timestamp, backupRepository: ba.backupRepository, size: ba.size }));
     }
     async getVmDashboard(id, { stream } = {}) {
-        const [quickInfo, alarms, lastReplication, { lastRuns, vmProtected }, lastBackupArchives] = await Promise.all([
+        const [quickInfo, alarms, lastReplication, { lastRuns, vmProtection }, lastBackupArchives] = await Promise.all([
             promiseWriteInStream({ maybePromise: this.#getDashboardQuickInfo(id), path: 'quickInfo', stream }),
             promiseWriteInStream({ maybePromise: Object.keys(this.getVmAlarms(id)), path: 'alarms', stream }),
             promiseWriteInStream({ maybePromise: this.#getLastReplication(id), path: 'backupsInfo.replication', stream }),
@@ -290,7 +293,7 @@ export class VmService {
             alarms: alarms,
             backupsInfo: {
                 lastRuns,
-                vmProtected,
+                vmProtection,
                 replication: lastReplication,
                 backupArchives: lastBackupArchives,
             },

package/dist/xoa/xoa.controller.mjs

@@ -17,10 +17,13 @@ import { badRequestResp, unauthorizedResp } from '../open-api/common/response.co
 import { xoaDashboard } from '../open-api/oa-examples/xoa.oa-example.mjs';
 import { XoaService } from './xoa.service.mjs';
 import { NDJSON_CONTENT_TYPE } from '../helpers/utils.helper.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 let XoaController = class XoaController extends Controller {
+    #restApi;
     #xoaService;
-    constructor(xoaService) {
+    constructor(restApi, xoaService) {
         super();
+        this.#restApi = restApi;
         this.#xoaService = xoaService;
     }
     async getDashboard(req, ndjson) {
@@ -45,8 +48,12 @@ let XoaController = class XoaController extends Controller {
             timestamp: Date.now(),
         };
     }
-    getGuiRoutes() {
-        return this.#xoaService.getGuiRoutes();
+    async getGuiRoutes() {
+        const { xo5, xo6 } = await this.#restApi.xoApp.config.getGuiRoutes();
+        return {
+            xo5: xo5.url,
+            xo6: xo6.url,
+        };
     }
 };
 __decorate([
@@ -72,6 +79,7 @@ XoaController = __decorate([
     Security('*'),
     Tags('xoa'),
     provide(XoaController),
-    __param(0, inject(XoaService))
+    __param(0, inject(RestApi)),
+    __param(1, inject(XoaService))
 ], XoaController);
 export { XoaController };

package/dist/xoa/xoa.service.mjs

@@ -484,21 +484,4 @@ export class XoaService {
             vmsStatus,
         };
     }
-    getGuiRoutes() {
-        const mounts = this.#restApi.xoApp.config.getOptional('http.mounts') ?? {};
-        let xo5Mount;
-        let xo6Mount;
-        for (const [key, value] of Object.entries(mounts)) {
-            if (value.includes('xo-web/dist')) {
-                xo5Mount = key;
-            }
-            else if (value.includes('@xen-orchestra/web/dist')) {
-                xo6Mount = key;
-            }
-        }
-        return {
-            xo5: xo5Mount,
-            xo6: xo6Mount,
-        };
-    }
 }

package/open-api/spec/swagger.json

@@ -2597,8 +2597,13 @@
 							"replication": {
 								"$ref": "#/components/schemas/Unbrand_VmDashboard-at-backupsInfo_91_replication_93__"
 							},
-							"vmProtected": {
-								"type": "boolean"
+							"vmProtection": {
+								"type": "string",
+								"enum": [
+									"protected",
+									"unprotected",
+									"not-in-job"
+								]
 							},
 							"lastRuns": {
 								"items": {
@@ -2609,7 +2614,7 @@
 						},
 						"required": [
 							"backupArchives",
-							"vmProtected",
+							"vmProtection",
 							"lastRuns"
 						],
 						"type": "object"
@@ -12004,7 +12009,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.21.0",
+		"version": "0.21.2",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"

package/package.json

@@ -6,7 +6,7 @@
   "main": "./dist/index.mjs",
   "name": "@xen-orchestra/rest-api",
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/rest-api",
-  "version": "0.21.0",
+  "version": "0.21.2",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,
@@ -36,7 +36,7 @@
     "@vates/async-each": "^1.0.1",
     "@vates/task": "^0.6.1",
     "@vates/types": "^1.15.0",
-    "@xen-orchestra/backups": "^0.67.0",
+    "@xen-orchestra/backups": "^0.67.1",
     "@xen-orchestra/log": "^0.7.1",
     "@xen-orchestra/xapi": "^8.6.1",
     "complex-matcher": "^1.0.0",