@xen-orchestra/rest-api 0.28.1 → 0.29.0

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

@@ -3,8 +3,10 @@ import { createGzip } from 'node:zlib';
 import { pipeline } from 'node:stream/promises';
 import { Readable } from 'node:stream';
 import { BASE_URL } from '../index.mjs';
+import { makeMarkdownTable } from '../helpers/markdown.helper.mjs';
 import { makeNdJsonStream } from '../helpers/stream.helper.mjs';
 import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
+import { invalidParameters } from 'xo-common/api-errors.js';
 import { NDJSON_CONTENT_TYPE, safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
 const noop = () => { };
 export class BaseController extends Controller {
@@ -18,12 +20,20 @@ export class BaseController extends Controller {
     sendObjects(objects, req, path) {
         const mapper = makeObjectMapper(req, path);
         const mappedObjects = objects.map(mapper);
+        if (req.query.ndjson === 'true' && req.query.markdown === 'true') {
+            throw invalidParameters('Cannot use both ndjson and markdown output formats simultaneously');
+        }
         if (req.query.ndjson === 'true') {
             const res = req.res;
             res.setHeader('Content-Type', NDJSON_CONTENT_TYPE);
             const stream = Readable.from(makeNdJsonStream(mappedObjects));
             return stream;
         }
+        else if (req.query.markdown === 'true') {
+            const res = req.res;
+            res.setHeader('Content-Type', 'text/markdown; charset=utf-8');
+            return Readable.from([makeMarkdownTable(mappedObjects)]);
+        }
         else {
             return mappedObjects;
         }

package/dist/abstract-classes/listener.mjs

@@ -14,12 +14,18 @@ export class Listener {
         return this.#eventEmitter;
     }
     addSubscriber(subscriber, fields = '*') {
-        this.#subscribers.set(subscriber.id, { fields, subscriber });
+        const unregisterOnClear = subscriber.onClear(() => this.removeSubscriber(subscriber.id));
+        this.#subscribers.set(subscriber.id, { fields, subscriber, unregisterOnClear });
         if (this.#subscribers.size === 1) {
             this.#watchedEvent.forEach(event => this.#addEventListener(event));
         }
     }
     removeSubscriber(subscriberId) {
+        const subscriberWithConf = this.#subscribers.get(subscriberId);
+        if (subscriberWithConf === undefined) {
+            return;
+        }
+        subscriberWithConf.unregisterOnClear();
         this.#subscribers.delete(subscriberId);
         if (this.#subscribers.size === 0) {
             this.removeAllEventListeners();
@@ -32,8 +38,7 @@ export class Listener {
         this.#eventCallbacks.clear();
     }
     clear() {
-        this.removeAllEventListeners();
-        this.#subscribers.clear();
+        this.#subscribers.forEach(({ subscriber }) => this.removeSubscriber(subscriber.id));
         this.#watchedEvent = [];
     }
     #addEventListener(event) {

package/dist/alarms/alarm.controller.mjs

@@ -43,7 +43,7 @@ let AlarmController = class AlarmController extends XapiXoController {
      * @example filter "body:name:physical_utilisation"
      * @example limit 42
      */
-    getAlarms(req, fields, ndjson, filter, limit) {
+    getAlarms(req, fields, ndjson, markdown, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -61,7 +61,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], AlarmController.prototype, "getAlarms", null);
 __decorate([
     Example(alarm),

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

@@ -61,7 +61,7 @@ let BackupArchiveController = class BackupArchiveController extends XoController
      * @example filter "disks:length:>0"
      * @example limit 42
      */
-    async getBackupArchives(req, backupRepositories, fields, ndjson, filter, limit) {
+    async getBackupArchives(req, backupRepositories, fields, ndjson, markdown, filter, limit) {
         const backupArchives = await this.getObjects({ backupRepositories, filter, limit });
         return this.sendObjects(Object.values(backupArchives), req);
     }
@@ -83,7 +83,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], BackupArchiveController.prototype, "getBackupArchives", null);
 __decorate([
     Example(backupArchive),

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

@@ -46,7 +46,7 @@ let BackupJobController = class BackupJobController extends XoController {
      * @example filter "type:backup"
      * @example limit 42
      */
-    async getBackupJobs(req, fields, ndjson, filter, limit) {
+    async getBackupJobs(req, fields, ndjson, markdown, filter, limit) {
         const backupJobs = await this.getObjects({ filter, limit });
         return this.sendObjects(Object.values(backupJobs), req, 'backup-jobs');
     }
@@ -65,7 +65,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], BackupJobController.prototype, "getBackupJobs", null);
 __decorate([
     Example(vmBackupJob),
@@ -117,7 +118,7 @@ let DeprecatedBackupController = class DeprecatedBackupController extends XoCont
      * @example filter "mode:delta"
      * @example limit 42
      */
-    async getVmBackupJobs(req, fields, ndjson, filter, limit) {
+    async getVmBackupJobs(req, fields, ndjson, markdown, filter, limit) {
         const vmBackupJobs = await this.restApi.xoApp.getAllJobs('backup');
         return this.sendObjects(limitAndFilterArray(vmBackupJobs, { filter, limit }), req, 'backup-jobs');
     }
@@ -138,7 +139,7 @@ let DeprecatedBackupController = class DeprecatedBackupController extends XoCont
      * @example filter "xoMetadata?"
      * @example limit 42
      */
-    async getMetadataBackupJobs(req, fields, ndjson, filter, limit) {
+    async getMetadataBackupJobs(req, fields, ndjson, markdown, filter, limit) {
         const metadataBackupJobs = await this.restApi.xoApp.getAllJobs('metadataBackup');
         return this.sendObjects(limitAndFilterArray(metadataBackupJobs, { filter, limit }), req, 'backup-jobs');
     }
@@ -154,7 +155,7 @@ let DeprecatedBackupController = class DeprecatedBackupController extends XoCont
      * @example filter "mode:delta"
      * @example limit 42
      */
-    async getMirrorBackupJobs(req, fields, ndjson, filter, limit) {
+    async getMirrorBackupJobs(req, fields, ndjson, markdown, filter, limit) {
         const mirrorBackupJobs = await this.restApi.xoApp.getAllJobs('mirrorBackup');
         return this.sendObjects(limitAndFilterArray(mirrorBackupJobs, { filter, limit }), req, 'backup-jobs');
     }
@@ -169,7 +170,7 @@ let DeprecatedBackupController = class DeprecatedBackupController extends XoCont
      * @example filter "status:success"
      * @example limit 42
      */
-    async getDeprecatedBackupLogs(req, fields, ndjson, filter, limit) {
+    async getDeprecatedBackupLogs(req, fields, ndjson, markdown, filter, limit) {
         const userFilter = filter === undefined ? () => true : safeParseComplexMatcher(filter).createPredicate();
         const predicate = (log) => {
             if (!this.#backupLogService.isBackupLog(log)) {
@@ -201,7 +202,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], DeprecatedBackupController.prototype, "getVmBackupJobs", null);
 __decorate([
     Hidden(),
@@ -228,7 +230,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], DeprecatedBackupController.prototype, "getMetadataBackupJobs", null);
 __decorate([
     Example(metadataBackupJob),
@@ -248,7 +251,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], DeprecatedBackupController.prototype, "getMirrorBackupJobs", null);
 __decorate([
     Example(mirrorBackupJob),
@@ -268,7 +272,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], DeprecatedBackupController.prototype, "getDeprecatedBackupLogs", null);
 __decorate([
     Example(backupLog),

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

@@ -37,7 +37,7 @@ let BackupLogController = class BackupLogController extends XoController {
      * @example filter "status:success"
      * @example limit 42
      */
-    async getBackupLogs(req, fields, ndjson, filter, limit) {
+    async getBackupLogs(req, fields, ndjson, markdown, filter, limit) {
         const backupLogs = await this.getObjects({ filter, limit });
         return this.sendObjects(Object.values(backupLogs), req);
     }
@@ -56,7 +56,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], BackupLogController.prototype, "getBackupLogs", null);
 __decorate([
     Example(backupLog),

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

@@ -30,7 +30,7 @@ let BackupRepositoryController = class BackupRepositoryController extends XoCont
      * @example filter "enabled?"
      * @example limit 42
      */
-    async getRepositories(req, fields, ndjson, filter, limit) {
+    async getRepositories(req, fields, ndjson, markdown, filter, limit) {
         return this.sendObjects(Object.values(await this.getObjects({ filter, limit })), req);
     }
     /**
@@ -48,7 +48,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], BackupRepositoryController.prototype, "getRepositories", null);
 __decorate([
     Example(backupRepository),

package/dist/events/event.class.mjs

@@ -10,6 +10,7 @@ export class Subscriber {
     #manager;
     #connection;
     #isAlive;
+    #cleanupCallbacks = new Set();
     get id() {
         return this.#id;
     }
@@ -34,6 +35,10 @@ export class Subscriber {
             this.clear();
         }
     }
+    onClear(callback) {
+        this.#cleanupCallbacks.add(callback);
+        return () => this.#cleanupCallbacks.delete(callback);
+    }
     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');
@@ -44,10 +49,13 @@ export class Subscriber {
         this.#safeWrite(payload);
     }
     clear() {
-        this.#isAlive = false;
-        if (!this.#connection.closed || !this.#connection.destroyed) {
-            this.#connection.destroy();
+        if (!this.#isAlive) {
+            return;
         }
+        this.#isAlive = false;
+        this.#connection.destroy();
+        this.#cleanupCallbacks.forEach(cb => cb());
+        this.#cleanupCallbacks.clear();
         this.#manager.removeSubscriber(this.id);
     }
 }
@@ -132,11 +140,6 @@ export class SubscriberManager {
         this.#subscribers.delete(id);
     }
     clear() {
-        this.#subscribers.forEach(subscriber => {
-            if (!subscriber.connection.closed) {
-                subscriber.connection.destroy();
-            }
-            this.#subscribers.delete(subscriber.id);
-        });
+        this.#subscribers.forEach(subscriber => subscriber.clear());
     }
 }

package/dist/events/event.service.mjs

@@ -1,4 +1,3 @@
-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';
@@ -50,9 +49,9 @@ export class EventService {
             'Cache-Control': 'no-cache, no-transform',
         });
         res.setHeaders(headers);
-        const maxRam = this.#restApi.xoApp.config.get('rest-api.percentOfRamAllocatedPerSseClient');
+        const maxRam = this.#restApi.xoApp.config.get('rest-api.maxRamAllocatedPerSseClient');
         const connection = new PassThrough({
-            highWaterMark: Math.round(os.totalmem() * (maxRam / 100)),
+            highWaterMark: Math.round(1024 * 1024 * maxRam),
         });
         pipeline(connection, res, error => {
             if (error?.code !== 'ERR_STREAM_PREMATURE_CLOSE') {

package/dist/groups/group.controller.mjs

@@ -38,7 +38,7 @@ let GroupController = class GroupController extends XoController {
      * @example filter "users:length:>0"
      * @example limit 42
      */
-    async getGroups(req, fields, ndjson, filter, limit) {
+    async getGroups(req, fields, ndjson, markdown, filter, limit) {
         return this.sendObjects(Object.values(await this.getObjects({ filter, limit })), req);
     }
     /**
@@ -102,7 +102,7 @@ let GroupController = class GroupController extends XoController {
      * @example filter "permission:none"
      * @example limit 42
      */
-    async getGroupUsers(req, id, fields, ndjson, filter, limit) {
+    async getGroupUsers(req, id, fields, ndjson, markdown, filter, limit) {
         const group = await this.getObject(id);
         const users = await Promise.all(group.users.map(id => this.#userService.getUser(id)));
         return this.sendObjects(limitAndFilterArray(users, { filter, limit }), req, 'users');
@@ -113,7 +113,7 @@ let GroupController = class GroupController extends XoController {
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getGroupTasks(req, id, fields, ndjson, filter, limit) {
+    async getGroupTasks(req, id, fields, ndjson, markdown, filter, limit) {
         const tasks = await this.getTasksForObject(id, { filter, limit });
         return this.sendObjects(Object.values(tasks), req, 'tasks');
     }
@@ -126,7 +126,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], GroupController.prototype, "getGroups", null);
 __decorate([
     Example(group),
@@ -186,7 +187,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], GroupController.prototype, "getGroupUsers", null);
 __decorate([
     Example(taskIds),
@@ -199,7 +201,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], GroupController.prototype, "getGroupTasks", null);
 GroupController = __decorate([
     Route('groups'),

package/dist/helpers/markdown.helper.mjs

@@ -0,0 +1,20 @@
+const escapeCell = (value) => {
+    if (value == null)
+        return '';
+    const text = typeof value === 'object' ? JSON.stringify(value) : String(value);
+    return text.replace(/\|/g, '\\|').replace(/\n/g, ' ');
+};
+export function makeMarkdownTable(objects) {
+    if (objects.length === 0) {
+        return 'No results.';
+    }
+    if (typeof objects[0] === 'string') {
+        return objects.join('\n');
+    }
+    const records = objects;
+    const headers = Object.keys(records[0]).filter(key => key !== 'href');
+    const headerRow = '| ' + headers.join(' | ') + ' |';
+    const separatorRow = '| ' + headers.map(() => '---').join(' | ') + ' |';
+    const dataRows = records.map(obj => '| ' + headers.map(header => escapeCell(obj[header])).join(' | ') + ' |');
+    return [headerRow, separatorRow, ...dataRows].join('\n');
+}

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

@@ -11,11 +11,11 @@ export function makeObjectMapper(req, path) {
             if (tmpPath.startsWith('/')) {
                 tmpPath = tmpPath.slice(1);
             }
-            if (tmpPath.endsWith('/')) {
-                tmpPath = tmpPath.slice(0, -1);
-            }
             _path = `${BASE_URL}/${tmpPath}`;
         }
+        if (_path.endsWith('/')) {
+            _path = _path.slice(0, -1);
+        }
         return `${_path}/${String(obj.id)}`;
     };
     let objectMapper;

package/dist/hosts/host.controller.mjs

@@ -38,7 +38,7 @@ let HostController = class HostController extends XapiXoController {
      * @example filter "productBrand:XCP-ng"
      * @example limit 42
      */
-    getHosts(req, fields, ndjson, filter, limit) {
+    getHosts(req, fields, ndjson, markdown, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -95,7 +95,7 @@ let HostController = class HostController extends XapiXoController {
      * @example filter "time:>1747053793"
      * @example limit 42
      */
-    getHostAlarms(req, id, fields, ndjson, filter, limit) {
+    getHostAlarms(req, id, fields, ndjson, markdown, filter, limit) {
         const host = this.getObject(id);
         const alarms = this.#alarmService.getAlarms({
             filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${host.uuid}`,
@@ -129,7 +129,7 @@ let HostController = class HostController extends XapiXoController {
      * @example filter "name:PBD_PLUG_FAILED_ON_SERVER_START"
      * @example limit 42
      */
-    getHostMessages(req, id, fields, ndjson, filter, limit) {
+    getHostMessages(req, id, fields, ndjson, markdown, filter, limit) {
         const messages = this.getMessagesForObject(id, { filter, limit });
         return this.sendObjects(Object.values(messages), req, 'messages');
     }
@@ -139,7 +139,7 @@ let HostController = class HostController extends XapiXoController {
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getHostTasks(req, id, fields, ndjson, filter, limit) {
+    async getHostTasks(req, id, fields, ndjson, markdown, filter, limit) {
         const tasks = await this.getTasksForObject(id, { filter, limit });
         return this.sendObjects(Object.values(tasks), req, 'tasks');
     }
@@ -261,7 +261,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], HostController.prototype, "getHosts", null);
 __decorate([
     Example(host),
@@ -304,7 +305,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], HostController.prototype, "getHostAlarms", null);
 __decorate([
     Example(hostSmt),
@@ -331,7 +333,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], HostController.prototype, "getHostMessages", null);
 __decorate([
     Example(taskIds),
@@ -344,7 +347,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], HostController.prototype, "getHostTasks", null);
 __decorate([
     Put('{id}/tags/{tag}'),

package/dist/messages/message.controller.mjs

@@ -47,7 +47,7 @@ let MessageController = class MessageController extends XapiXoController {
      * @example filter "name:VM_STARTED"
      * @example limit 42
      */
-    getMessages(req, fields, ndjson, filter, limit) {
+    getMessages(req, fields, ndjson, markdown, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -65,7 +65,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], MessageController.prototype, "getMessages", null);
 __decorate([
     Example(message),

package/dist/networks/network.controller.mjs

@@ -30,7 +30,7 @@ let NetworkController = class NetworkController extends XapiXoController {
      * @example filter "nbd?"
      * @example limit 42
      */
-    getNetworks(req, fields, ndjson, filter, limit) {
+    getNetworks(req, fields, ndjson, markdown, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -52,7 +52,7 @@ let NetworkController = class NetworkController extends XapiXoController {
      * @example filter "time:>1747053793"
      * @example limit 42
      */
-    getNetworkAlarms(req, id, fields, ndjson, filter, limit) {
+    getNetworkAlarms(req, id, fields, ndjson, markdown, filter, limit) {
         const network = this.getObject(id);
         const alarms = this.#alarmService.getAlarms({
             filter: `${escapeUnsafeComplexMatcher(filter) ?? ''} object:uuid:${network.uuid}`,
@@ -66,7 +66,7 @@ let NetworkController = class NetworkController extends XapiXoController {
      * @example filter "name:VM_STARTED"
      * @example limit 42
      */
-    getNetworkMessages(req, id, fields, ndjson, filter, limit) {
+    getNetworkMessages(req, id, fields, ndjson, markdown, filter, limit) {
         const messages = this.getMessagesForObject(id, { filter, limit });
         return this.sendObjects(Object.values(messages), req, 'messages');
     }
@@ -76,7 +76,7 @@ let NetworkController = class NetworkController extends XapiXoController {
      * @example filter "status:failure"
      * @example limit 42
      */
-    async getNetworkTasks(req, id, fields, ndjson, filter, limit) {
+    async getNetworkTasks(req, id, fields, ndjson, markdown, filter, limit) {
         const tasks = await this.getTasksForObject(id, { filter, limit });
         return this.sendObjects(Object.values(tasks), req, 'tasks');
     }
@@ -105,7 +105,8 @@ __decorate([
     __param(1, Query()),
     __param(2, Query()),
     __param(3, Query()),
-    __param(4, Query())
+    __param(4, Query()),
+    __param(5, Query())
 ], NetworkController.prototype, "getNetworks", null);
 __decorate([
     Example(network),
@@ -129,7 +130,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], NetworkController.prototype, "getNetworkAlarms", null);
 __decorate([
     Example(messageIds),
@@ -142,7 +144,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], NetworkController.prototype, "getNetworkMessages", null);
 __decorate([
     Example(taskIds),
@@ -155,7 +158,8 @@ __decorate([
     __param(2, Query()),
     __param(3, Query()),
     __param(4, Query()),
-    __param(5, Query())
+    __param(5, Query()),
+    __param(6, Query())
 ], NetworkController.prototype, "getNetworkTasks", null);
 __decorate([
     Put('{id}/tags/{tag}'),