@xen-orchestra/rest-api 0.21.0 → 0.21.1

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/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/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/open-api/spec/swagger.json

@@ -12004,7 +12004,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.21.0",
+		"version": "0.21.1",
 		"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.1",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,