@xen-orchestra/rest-api 0.24.0 → 0.25.0

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

@@ -9,8 +9,10 @@ import { NDJSON_CONTENT_TYPE, safeParseComplexMatcher } from '../helpers/utils.h
 const noop = () => { };
 export class BaseController extends Controller {
     restApi;
-    constructor(restApi) {
+    type;
+    constructor(type, restApi) {
         super();
+        this.type = type;
         this.restApi = restApi;
     }
     sendObjects(objects, req, path) {
@@ -51,6 +53,7 @@ export class BaseController extends Controller {
     async createAction(cb, { statusCode = 200, sync = false, taskProperties, }) {
         taskProperties.name = 'REST API: ' + taskProperties.name;
         taskProperties.type = 'xo:rest-api:action';
+        taskProperties.objectType = this.type;
         const task = this.restApi.tasks.create(taskProperties);
         const pResult = task.run(() => cb(task));
         if (sync) {

package/dist/abstract-classes/xapi-xo-controller.mjs

@@ -2,19 +2,17 @@ import { BaseController } from './base-controller.mjs';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { RAW_ALARM_FILTER } from '../alarms/alarm.service.mjs';
 export class XapiXoController extends BaseController {
-    #type;
     constructor(type, restApi) {
-        super(restApi);
-        this.#type = type;
+        super(type, restApi);
     }
     getObjects(opts) {
-        return this.restApi.getObjectsByType(this.#type, opts);
+        return this.restApi.getObjectsByType(this.type, opts);
     }
     getObject(id) {
-        return this.restApi.getObject(id, this.#type);
+        return this.restApi.getObject(id, this.type);
     }
     getXapiObject(maybeId) {
-        return this.restApi.getXapiObject(maybeId, this.#type);
+        return this.restApi.getXapiObject(maybeId, this.type);
     }
     getMessagesForObject(id, { filter, limit } = {}) {
         const object = this.getObject(id);

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

@@ -1,19 +1,8 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-import { inject } from 'inversify';
 import { BaseController } from './base-controller.mjs';
-import { RestApi } from '../rest-api/rest-api.mjs';
 import { limitAndFilterArray } from '../helpers/utils.helper.mjs';
-let XoController = class XoController extends BaseController {
-    constructor(restApi) {
-        super(restApi);
+export class XoController extends BaseController {
+    constructor(type, restApi) {
+        super(type, restApi);
     }
     async getObjects(opts = {}) {
         let objects = await this.getAllCollectionObjects(opts);
@@ -27,8 +16,4 @@ let XoController = class XoController extends BaseController {
     async getObject(id) {
         return this.getCollectionObject(id);
     }
-};
-XoController = __decorate([
-    __param(0, inject(RestApi))
-], XoController);
-export { XoController };
+}

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

@@ -8,14 +8,19 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
 import { noSuchObject } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
 import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 import { backupArchive, backupArchiveIds, partialBackupArchives, } from '../open-api/oa-examples/backup-archive.oa-example.mjs';
 // BR uuid/xo-vm-backups/VM uuid/(ISO 8601 compact).json
 const BACKUP_ARCHIVE_ID_REGEX = /^([0-9a-fA-F-]{36})\/+xo-vm-backups\/+([0-9a-fA-F-]{36})\/+(\d{8}T\d{6}Z)\.json$/;
 let BackupArchiveController = class BackupArchiveController extends XoController {
+    constructor(restApi) {
+        super('backup-archive', restApi);
+    }
     async getAllCollectionObjects({ backupRepositories = [], } = {}) {
         const backupRepositoryIds = [];
         if (backupRepositories.includes('*')) {
@@ -92,6 +97,7 @@ BackupArchiveController = __decorate([
     Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('backup-archives'),
-    provide(BackupArchiveController)
+    provide(BackupArchiveController),
+    __param(0, inject(RestApi))
 ], BackupArchiveController);
 export { BackupArchiveController };

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

@@ -25,7 +25,7 @@ const log = createLogger('xo:rest-api:backupJob-controller');
 let BackupJobController = class BackupJobController extends XoController {
     #backupJobService;
     constructor(restApi, backupJobService) {
-        super(restApi);
+        super('backup-job', restApi);
         this.#backupJobService = backupJobService;
     }
     async getAllCollectionObjects() {
@@ -89,7 +89,7 @@ let DeprecatedBackupController = class DeprecatedBackupController extends XoCont
     #backupLogService;
     #backupJobService;
     constructor(restApi, backupLogService, backupJobService) {
-        super(restApi);
+        super('backup', restApi);
         this.#backupLogService = backupLogService;
         this.#backupJobService = backupJobService;
     }

package/dist/backup-logs/backup-log.controller.mjs

@@ -19,7 +19,7 @@ import { XoController } from '../abstract-classes/xo-controller.mjs';
 let BackupLogController = class BackupLogController extends XoController {
     #backupLogService;
     constructor(restApi, backupLogService) {
-        super(restApi);
+        super('backup-log', restApi);
         this.#backupLogService = backupLogService;
     }
     getAllCollectionObjects() {

package/dist/backup-repositories/backup-repositories.controller.mjs

@@ -8,11 +8,16 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
 import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
 import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { backupRepositoryIds, partialBackupRepositories, backupRepository, } from '../open-api/oa-examples/backup-repository.oa-example.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 let BackupRepositoryController = class BackupRepositoryController extends XoController {
+    constructor(restApi) {
+        super('backup-repository', restApi);
+    }
     // --- abstract methods
     getAllCollectionObjects() {
         return this.restApi.xoApp.getAllRemotes();
@@ -57,6 +62,7 @@ BackupRepositoryController = __decorate([
     Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('backup-repositories'),
-    provide(BackupRepositoryController)
+    provide(BackupRepositoryController),
+    __param(0, inject(RestApi))
 ], BackupRepositoryController);
 export { BackupRepositoryController };

package/dist/events/event.class.mjs

@@ -19,31 +19,35 @@ export class Subscriber {
     get connection() {
         return this.#connection;
     }
-    constructor(res, manager) {
+    constructor(connection, manager) {
         this.#id = crypto.randomUUID();
-        const headers = new Headers({
-            'Content-Type': 'text/event-stream',
-            Connection: 'keep-alive',
-            'Cache-Control': 'no-cache, no-transform',
-        });
-        res.setHeaders(headers);
-        res.on('close', () => this.clear());
+        connection.on('close', () => this.clear());
         manager.addSubscriber(this);
-        this.#connection = res;
+        this.#connection = connection;
         this.#manager = manager;
         this.#isAlive = true;
     }
+    #safeWrite(payload) {
+        const ok = this.#connection.write(payload);
+        if (!ok) {
+            log.error(`Too much data in queue for the client ${this.id} (${Math.round(this.#connection.writableLength / 1024 / 1024)} MB). The connection is going to be destroyed`);
+            this.clear();
+        }
+    }
     broadcast(event, data) {
         if (!this.#isAlive) {
             log.warn('broadcast called on a subscriber that is not alive, but still in memory! Force clear and do nothing');
             this.clear();
             return;
         }
-        this.#connection.write(`event:${event}\n`);
-        this.#connection.write(`data:${JSON.stringify(data)}\n\n`);
+        const payload = `event: ${event}\ndata: ${JSON.stringify(data)}\n\n`;
+        this.#safeWrite(payload);
     }
     clear() {
         this.#isAlive = false;
+        if (!this.#connection.closed || !this.#connection.destroyed) {
+            this.#connection.destroy();
+        }
         this.#manager.removeSubscriber(this.id);
     }
 }
@@ -58,20 +62,25 @@ export class XoListener extends Listener {
     handleData({ fields, event }, object, previousObj) {
         let _object = object;
         let _prevObject = previousObj;
-        if (this.#type === 'alarm') {
-            if (object !== undefined &&
-                'type' in object &&
-                object.type === 'message' &&
-                this.#alarmService?.isAlarm(object)) {
-                _object = this.#alarmService.parseAlarm(object);
+        if (this.#type === 'alarm' || this.#type === 'message') {
+            const isAlarm = (object) => object !== undefined && 'type' in object && object.type === 'message' && this.#alarmService.isAlarm(object);
+            const objectIsAlarm = isAlarm(object);
+            const prevObjectIsAlarm = isAlarm(previousObj);
+            // If we are in an alarm listener and the objects are messages
+            // we clean them to ensure they are not sent via the SSE
+            // Same if we are in a message listener and the objects are alarms
+            if (this.#type === 'alarm') {
+                _object = objectIsAlarm ? this.#alarmService.parseAlarm(object) : undefined;
+                _prevObject = prevObjectIsAlarm ? this.#alarmService.parseAlarm(previousObj) : undefined;
             }
-            if (previousObj !== undefined &&
-                'type' in previousObj &&
-                previousObj.type === 'message' &&
-                this.#alarmService?.isAlarm(previousObj)) {
-                _prevObject = this.#alarmService.parseAlarm(previousObj);
+            else {
+                _object = objectIsAlarm ? undefined : object;
+                _prevObject = prevObjectIsAlarm ? undefined : object;
             }
         }
+        if (_object === undefined && _prevObject === undefined) {
+            return;
+        }
         if (fields !== '*') {
             if (_object !== undefined) {
                 _object = pick(_object, fields);

package/dist/events/event.service.mjs

@@ -1,4 +1,6 @@
+import os from 'node:os';
 import { createLogger } from '@xen-orchestra/log';
+import { PassThrough, pipeline } from 'node:stream';
 import { PingListener, Subscriber, SubscriberManager, XoListener } from './event.class.mjs';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 const log = createLogger('xo:rest-api:event-service');
@@ -26,7 +28,7 @@ export class EventService {
             listener = new PingListener();
         }
         else {
-            const isAlarm = type === 'alarm';
+            const isMessage = type === 'alarm' || type === 'message';
             let eventEmitter;
             if (type === 'task') {
                 eventEmitter = this.#restApi.xoApp.tasks;
@@ -34,15 +36,30 @@ export class EventService {
             else {
                 // alarm is purely XO-related; it doesn't exist at the XAPI level.
                 // alarm is a message with parsed values. So, in the case of an alarm listener, it listens for message collection.
-                eventEmitter = this.#restApi.xoApp.objects.allIndexes.type.getEventEmitterByType(isAlarm ? 'message' : type);
+                eventEmitter = this.#restApi.xoApp.objects.allIndexes.type.getEventEmitterByType(isMessage ? 'message' : type);
             }
-            listener = new XoListener(type, eventEmitter, isAlarm ? this.#alarmService : undefined);
+            listener = new XoListener(type, eventEmitter, isMessage ? this.#alarmService : undefined);
         }
         this.#listeners.set(type, listener);
         return listener;
     }
     createSseSubscriber(res) {
-        const subscriber = new Subscriber(res, this.#subscriberManager);
+        const headers = new Headers({
+            'Content-Type': 'text/event-stream',
+            Connection: 'keep-alive',
+            'Cache-Control': 'no-cache, no-transform',
+        });
+        res.setHeaders(headers);
+        const maxRam = this.#restApi.xoApp.config.get('rest-api.percentOfRamAllocatedPerSseClient');
+        const connection = new PassThrough({
+            highWaterMark: Math.round(os.totalmem() * (maxRam / 100)),
+        });
+        pipeline(connection, res, error => {
+            if (error?.code !== 'ERR_STREAM_PREMATURE_CLOSE') {
+                log.error(error);
+            }
+        });
+        const subscriber = new Subscriber(connection, this.#subscriberManager);
         subscriber.broadcast('init', { id: subscriber.id });
         this.addListenerFor(subscriber.id, { type: 'ping' });
         log.debug(`new SSE subscriber added: ${subscriber.id}`);

package/dist/groups/group.controller.mjs

@@ -23,7 +23,7 @@ import { partialTasks, taskIds } from '../open-api/oa-examples/task.oa-example.m
 let GroupController = class GroupController extends XoController {
     #userService;
     constructor(restApi, userService) {
-        super(restApi);
+        super('group', restApi);
         this.#userService = userService;
     }
     // --- abstract methods

package/dist/helpers/object-wrapper.helper.mjs

@@ -1,7 +1,5 @@
-import path from 'node:path';
 import pick from 'lodash/pick.js';
 import { BASE_URL } from '../index.mjs';
-const { join } = path.posix;
 export function makeObjectMapper(req, path) {
     const makeUrl = (obj) => {
         let _path;
@@ -9,9 +7,16 @@ export function makeObjectMapper(req, path) {
             _path = req.path;
         }
         else {
-            _path = `${BASE_URL}/${typeof path === 'string' ? path : path(obj)}`;
+            let tmpPath = typeof path === 'string' ? path : path(obj);
+            if (tmpPath.startsWith('/')) {
+                tmpPath = tmpPath.slice(1);
+            }
+            if (tmpPath.endsWith('/')) {
+                tmpPath = tmpPath.slice(0, -1);
+            }
+            _path = `${BASE_URL}/${tmpPath}`;
         }
-        return join(_path, typeof obj.id === 'number' ? String(obj.id) : obj.id);
+        return `${_path}/${String(obj.id)}`;
     };
     let objectMapper;
     const { query } = req;

package/dist/middlewares/authentication.middleware.mjs

@@ -51,7 +51,7 @@ export function setupApiContext(xoApp) {
             res.locals.authType = 'basic';
         }
         try {
-            const { user } = await xoApp.authenticateUser(credentials, { ip });
+            const { user } = await xoApp.authenticateUser(credentials, { ip }, { bypassTaskCreation: hasToken });
             return xoApp.runWithApiContext(user, next);
         }
         catch (error) {

package/dist/open-api/oa-examples/vif.oa-example.mjs

@@ -2,6 +2,7 @@ export const vifIds = [
     '/rest/v0/vifs/f028c5d4-578a-332c-394e-087aaca32dd3',
     '/rest/v0/vifs/9cc245bf-8dac-8550-e1ae-54bc679b68d9',
 ];
+export const vifId = { id: 'f028c5d4-578a-332c-394e-087aaca32dd3' };
 export const partialVifs = [
     {
         attached: true,