Compare commits

..

795 Commits

Author SHA1 Message Date
Nathanaël HANNEBERT
a1857691a5 docs(xo): fix dependecy missmatch 2025-08-21 15:47:15 +02:00
Bastien Nollet
4eeae48ade feat: technical release (#8894) 2025-08-21 15:17:07 +02:00
Thomas Moraine
6a2d3e848b docs(xo): minor improvements to the load balancing page (#8893)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-08-21 13:58:54 +02:00
Thomas Moraine
e4bf576efa docs(xo): explain the usage reports plugin more explicitly (#8890)
* docs(xo): explain the usage reports plugin more explicitly

Previously, it wasn't clear what the toggle called All did. This commit makes the documentation more clear about how it works.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

* Update docs/docs/manage_infrastructure.md

Co-authored-by: Pierre Donias <pierre.donias@gmail.com>

---------

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
Co-authored-by: Pierre Donias <pierre.donias@gmail.com>
2025-08-20 11:27:22 +02:00
Thomas Moraine
76071b0732 docs(xo): restructure and expand load balancing doc (#8886)
Make the load balancing documentation clearer, better structured, with more illustrations, so that users can follow the process of creating or editing a load balancing plan without friction or hassle

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-08-20 10:54:27 +02:00
OlivierFL
6eaeab56a7 feat(xo-core): create UiCollapsibleList component (#8857) 2025-08-19 16:30:13 +02:00
OlivierFL
17640142ee feat(xo-core): update UiLogEntryViewer component (#8880) 2025-08-19 16:27:11 +02:00
Thomas Moraine
ff85cae993 docs(xo): mention automatic daily deployment of documentation (#8885)
The README now specifies that Xen Orchestra documentation updates are deployed automatically once per day. This makes it clearer for users that the online docs are always up to date without requiring manual intervention.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-08-18 09:49:23 +02:00
Thomas Moraine
70d59eb5f9 docs(xo): document network bonding (#8874)
Network bonding was absent from the Xen Orchestra documentation. Information about this feature was previously only available in a blog article on XCP-ng.

This commit updates the XO doc so that it properly documents this feature, and remains the single source of truth in this topic. XO users won't have to dig through blog posts to find the relevant information, making the documentation more useful and trustworthy.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-08-13 15:18:26 +02:00
Thierry Goettelmann
e0b9bc2004 feat(web): introducing defineRemoteResource (Web Core) and useXoCollectionState (XO 6) to handle XO API resources (#8855) 2025-08-13 10:28:40 +02:00
Pierre Donias
c1c88c6797 feat(lite/release): check that version matches build version (#8870)
* feat(lite/release): check that version matches build version

1. Let Vite's build get the last commit hash instead of passing an env variable
2. Emit a build file containing the current commit hash and package version
3. Before releasing a new version, compare hash and version with current git commit and version passed by user

* readJson
2025-08-12 12:04:20 +02:00
Mathieu
7ab857f5a7 feat(@xen-orchestra/rest-api): enhance getCurrentUser (#8875)
In the REST API, we generally work on authenticated requests. getCurrentUser can therefore be a bit tedious, as it can return undefined | XoUser. So, whenever we need the current user in an authenticated request, we need to add a check:
if user === undefined throw for typescript to be happy

So now: getCurrentUser returns XoUser (throw if no user) and getCurrentUser({throwUnauthenticated: false}) returns undefined | XoUser
2025-08-12 12:03:15 +02:00
Mathieu
199bf00df7 feat(@xen-orchestra/rest-api): expose vm(*)/:id/vdis (#8876)
Enhancements:

    Fixed @vates/types
    Added limitAndFilterArray in utils.helper to easily handle user filter/limit everywhere
    Enhance getObject type in rest-api
    makeObjectMapper can take a function to define the path (for path based on the object type)
    add getVmVdis in vmService to get VDIs from a VM

Endpoints:

    /vms/:id/vdis
    /vm-snapshots/:id/vdis
    /vm-controllers/:id/vdis
    /vm-templates/:id/vdis
2025-08-12 12:01:49 +02:00
Thierry Goettelmann
909cfd844a feat(web-stack): migrate FormSelect / select to VtsSelect + enhance useFormSelect (#8681) 2025-08-11 17:27:35 +02:00
Thierry Goettelmann
63d5de04fa feat(web): implement default tab handling (#8873) 2025-08-11 16:52:39 +02:00
Thierry Goettelmann
c19eabadc0 feat(lite): migrate the project to file-based navigation + implement default tab handling (#8872) 2025-08-11 16:40:49 +02:00
Thierry Goettelmann
6f9c5fb46e feat(web-core): add useDefaultTab to handle redirection to last visited tab (#8868) 2025-08-11 16:16:12 +02:00
Mathieu
935034517a feat(@xen-orchestra/rest-api): expose hosts/:id/smt (#8863) 2025-08-07 17:07:04 +02:00
Mathieu
4e3c1a82f4 feat(lite): 0.13.1 (#8867) 2025-08-06 17:09:27 +02:00
Mathieu
0c3ae5a560 feat: release 5.109.1 (#8866) 2025-08-06 16:55:27 +02:00
Mathieu
9e484e011f feat: technical release (#8864)
* feat(@xen-orchestra/web-core): 0.26.1

* feat(@xen-orchestra/rest-api): 0.13.1

* feat(@xen-orchestra/web): 0.24.1

* feat(xo-server): 5.184.2

* feat(xo-web): 5.182.0

* chore(CHANGELOG): update next

* fix identation
2025-08-06 15:12:00 +02:00
MlssFrncJrg
b30b897ad9 fix(xo-web): remove image format column on ISO SRs (#8852) 2025-08-06 14:43:27 +02:00
Thomas Moraine
fb69373264 doc(xo): deduplicate content across multiple pages (#8851)
* docs(xo): deduplicate acls content

The ACLs page in the XO documentation wasn't listed in the navigation bar and had content that duplicated the ACLs section of the Users page.

This commit removes the standalone page and updates the valid section with minor improvements (presentation, some missing info from the lone ACLs page) so that it becomes the only source of information on the topic.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

* docs(xo): remove obsolete administration page

The Administration page duplicates content in the VMs section of the Infrastructure management page.

Although the Administration page seemingly refers to itself as a 'section', it contains no subsections or extra content, so this might as been a draft for a bigger page, and was never elaborated upon.

In any case, this page isn't accessible from the navigation bar and doesn't seem to add much value to the doc, so I suggest we remove it from the tree view.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

* docs(xo): deduplicate backups and disaster recovery content

The 'Backups and Disaster Recovery' page in the XO documentation wasn't listed in the navigation bar and had content that was already present in other pages in the doc.

The last section of that page dealt with scheduled snapshots and completes the existing content on 'rolling snapshots'. That content has been added to the rolling snapshots section, so that everything can be grouped in a single location.

Finally, since the Backups and disaster recovery page is now obsolete, it has been deleted.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

* Update docs/docs/users.md

Co-authored-by: Laure S. <laure.souai@vates.tech>

---------

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
Co-authored-by: Laure S. <laure.souai@vates.tech>
2025-08-05 14:46:31 +02:00
Mathieu
f5cadfa3bc fix(xo-rest-api/xo-web/xo-lite): fix cpu provisioning computation (#8858)
* fix(xo-rest-api/xo-web/xo-lite): fix cpu provisioning computation

* changelogs

---------

Co-authored-by: debian <debian@XOA-from-source.lyon.vates.team>
2025-08-05 14:44:26 +02:00
Mathieu
bf44455250 fix(xo-server): fix incorrect state when remove server (#8854) 2025-08-05 11:35:23 +02:00
Mathieu
31a3f23fce feat(lite): 0.13.0 (#8849) 2025-07-31 18:39:06 +02:00
Mathieu
bc0720b9fc feat: release 5.109.0 (#8848) 2025-07-31 18:23:22 +02:00
Mathieu
497754ef4f feat: technical release (#8846) 2025-07-31 14:54:07 +02:00
Florent BEAUCHAMP
85e936f22f fix(vhd-lib): ensure vhd block read are always complete 2025-07-31 14:40:29 +02:00
Florent BEAUCHAMP
5d84f147ce fix(fs): better handling of incomplete read
from ticket 42001
do not retry an incomplete _read (for example read after the end of the file)
2025-07-31 14:40:29 +02:00
Florent BEAUCHAMP
2cec1aa44a fix(fs/test): fix read after the end of the file 2025-07-31 14:40:29 +02:00
Pierre Brunet
822a6f6e77 fix(xo-web/vdi): replace unknown image format by VHD (#8845)
* fix(xo-web/vdi): Replace unknown by vhd

* feat: update changelog packages

* Update CHANGELOG.unreleased.md

---------

Co-authored-by: Mathieu <70369997+MathieuRA@users.noreply.github.com>
2025-07-31 14:33:54 +02:00
Mathieu
4c229cf4a1 feat: technical release (#8844)
* feat(@xen-orchestra/web): 0.24.0

* feat(xo-server): 5.184.0

* feat(xo-web): 5.181.0

* chore(CHANGELOG): update next
2025-07-31 12:34:24 +02:00
Pierre Brunet
665a68b7fe feat(xo-cli/xo-web): add supported_image_format in xo-cli and xo-web (#8834) 2025-07-31 12:20:45 +02:00
Joris K
a7922f23aa feat(xo6): add alarms component on site dashboard (#8838)
* feat(xo6): add alarms component on site dashboard

* update

* add date sorter

* feedback and changelog

* feedback
2025-07-31 10:26:03 +02:00
Mathieu
2f39f37698 feat: technical release (#8842) 2025-07-30 16:25:08 +02:00
MlssFrncJrg
deedc5e7bf feat(@xen-orchestra/rest-api): migrate update user (#8784) 2025-07-30 16:02:50 +02:00
MlssFrncJrg
d45e4cb50b feat(@xen-orchestra/rest-api): expose patch groups (#8790) 2025-07-30 14:47:39 +02:00
MlssFrncJrg
50f5759d2e feat(@xen-orchestra/rest-api): expose delete user from group (#8773) 2025-07-30 14:06:31 +02:00
Joris K
d03c2b62fe fix(xo6): fix issue with infinite loading on site dashboard (#8841) 2025-07-30 12:07:35 +02:00
MlssFrncJrg
4465108333 feat(@xen-orchestra/rest-api): migrate add user to group (#8705) 2025-07-30 11:18:41 +02:00
Mathieu
0ce7b564ea feat(@xen-orchestra/rest-api): expose VM snapshot alarms (#8827) 2025-07-30 09:51:38 +02:00
Joris K
16f07463e1 feat(xo6/pool): Add dashboard view (#8791) 2025-07-30 09:45:08 +02:00
Mathieu
af1a8f2e2c feat(@xen-orchestra/rest-api): expose VM alarms (#8829) 2025-07-30 08:38:46 +02:00
Mathieu
95b5ee95eb fix(@xen-orchestra/rest-api/hosts): count host disabled only if running (#8833) 2025-07-30 08:37:44 +02:00
Thierry Goettelmann
13f406fe70 feat(web-stack): introducing defineRequest + convert site dashboard (#8839) 2025-07-29 17:59:27 +02:00
Pierre Donias
1045016545 feat(xo-web/backups): add strong confirm on single VM backup deletion (#8813) 2025-07-29 10:19:50 +02:00
MlssFrncJrg
51e8cf94f8 feat(@xen-orchestra/rest-api): expose post groups (#8703) 2025-07-29 09:51:27 +02:00
Enée DI IORIO
fb0e1b5f8d feat(xo-6): add connect pool view (#8763) 2025-07-28 17:21:33 +02:00
Mathieu
61e119fd55 feat(@xen-orchestra/rest-api): expose VBD alarms (#8822) 2025-07-28 17:09:37 +02:00
Mathieu
e465d6b9b1 feat(@xen-orchestra/rest-api): expose VIF alarms (#8825) 2025-07-28 17:02:46 +02:00
Mathieu
39509b5a24 feat(@xen-orchestra/rest-api): expose VM controller alarms (#8826) 2025-07-28 16:51:12 +02:00
Mathieu
6d5a1ccdd2 feat: technical release (#8836) 2025-07-28 14:53:35 +02:00
Mathieu
0faf25b050 feat(@xen-orchestra/rest-api): expose pool alarms (#8805) 2025-07-28 14:22:39 +02:00
Mathieu
df4949d5ca feat(@xen-orchestra/rest-api): expose SR alarms (#8810) 2025-07-28 14:21:32 +02:00
Pierre Brunet
ca4e4e272f feat(@xen-orchestra/rest-api): expose backup-repositories (#8831) 2025-07-28 14:21:04 +02:00
Pierre Brunet
36d1e883e2 feat(xo-web): display image_format in VDI tabs (#8835) 2025-07-28 11:23:09 +02:00
vates-bot
8535271fb3 feat(web-stack/i18n): update Xen Orchestra 6 (#8765) 2025-07-28 10:53:23 +02:00
Pierre Brunet
4ca170746d fix(backups): mustDoSnapshot now checks if a vdi has a tag NOBAK (#8820) 2025-07-28 10:24:38 +02:00
Mathieu
6277af813f fix(@xen-orchestra/rest-api): escape unsafe complex matcher input (#8832) 2025-07-25 11:54:00 +02:00
Mathieu
bd83ea3ffc feat(@xen-orchestra/rest-api): expose host logs.tgz (#8830) 2025-07-25 09:41:12 +02:00
Mathieu
afc5518e1d feat(@xen-orchestra/rest-api): expose VM template alarms (#8828) 2025-07-24 15:11:41 +02:00
Mathieu
c702433370 feat(@xen-orchestra/rest-api): expose VDI alarms (#8824) 2025-07-24 14:05:17 +02:00
Joris K
91e4003ca3 feat(web-core): update progress bar component to add possibility to display GB instead of percent depending on the case (#8815)
* feat(web-core): update progress bar component to add possibility to display prefix in case of value

* feedback
2025-07-24 10:29:05 +02:00
Mathieu
359a27bffe fix(xo-server/rest-api): unauthenticated request no longer creates xo task (#8821) 2025-07-23 17:09:36 +02:00
Mathieu
46b0a4b91f feat(@xen-orchestra/rest-api): expose VDI-snapshot alarms (#8823) 2025-07-23 17:09:19 +02:00
Julien Fontanet
aab0f75fb2 feat(xo-server): check build is up-to-date 2025-07-23 11:50:46 +02:00
Julien Fontanet
9373909581 feat(xo-server): show buid commit 2025-07-23 11:50:46 +02:00
Florent BEAUCHAMP
c922b62217 fix(backups): better handling of retrying an upload (#8776) 2025-07-23 11:44:27 +02:00
Joris K
0c914704db feat(web-core): added data ruler component (#8812) 2025-07-23 10:29:32 +02:00
Pierre Donias
e77a474614 fix(xapi): spelling and typos (#8817)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-07-22 17:29:07 +02:00
Pierre Donias
17a65e35e7 fix(openflow): spelling and typos (#8816)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-07-22 17:16:11 +02:00
Mathieu
01f22b8a66 feat(@xen-orchestra/rest-api): expose pif alarms (#8804) 2025-07-22 16:53:38 +02:00
Pierre Donias
adebc5961f fix(generator-toolbox): typo (#8814)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-07-22 16:06:13 +02:00
Thomas Moraine
6b172f7047 doc(xo): update links to new xo doc domain name (#8811)
The Xen Orchestra documentation moved to a new domain name a while ago. This commit updates the last remaining links in the XO doc and app that pointed to the old domain name

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-07-22 11:19:12 +02:00
Mathieu
a9789ba630 fix(@xen-orchestra/rest-api): identify errors case for some computed objects (#8806) 2025-07-22 10:09:54 +02:00
Mathieu
b86af049c1 feat(@xen-orchestra/rest-api): expose network alarms (#8801) 2025-07-22 09:39:46 +02:00
Mathieu
ef5a711bb6 feat(@xen-orchestra/rest-api): expose host alarms (#8800) 2025-07-22 08:52:47 +02:00
Mathieu
be454d8643 feat(@vates/types): enhance createVm type (#8798) 2025-07-22 08:46:58 +02:00
Mathieu
e5702e407c fix(@xen-orchestra/rest-api): include ISO SR in top 5 dashboard (#8803) 2025-07-18 16:21:14 +02:00
Mathieu
73ce910f34 fix(@xen-orchestra/rest-api): alarm time in ms and alarm value in percent (#8802) 2025-07-18 16:20:50 +02:00
Enée DI IORIO
fee7bd5813 feat(web-core): create UI alarm item and UI alarm list components (#8516)
* feat(web-core/alarm-item): creating component

* feat(web-core/alarm-item): add style

* feat(web-core/alarm-item): add description and togle button with vueuse

* feat(web-core/alarm-item): add size variant on alarm-item

* feat(web-core/alarm-item): create story for alarm-item

* feat(web-core/alarm-item): create story for alarm-item

* feat(web-core/alarm-item): compliance with the standard

* feat(web-core/alarm-item): fix responsive on ui alarm item

* feat(web-core/alarm-item): fix spacing

* feat(web-core/alarm-item): add ui-alarm-list on story

* fix(web-core/alarm-item): fix border if item is on a list

* fix: revert unwanted npmignore change

* review

* review

* add changelog

* feedback

* feedback

* feedback

* feedback

* feedback

* feedback & improve translate

* feedback & improve translate

---------

Co-authored-by: Olivier Floch <olivier.floch@vates.fr>
Co-authored-by: Joris-K <joris.kosacki@vates.tech>
2025-07-16 17:16:35 +02:00
Joris K
d4444df15a feat(xo6/lite): Updated sidebar to auto close when the screen is small (#8760) 2025-07-16 16:16:15 +02:00
Joris K
153ff4c641 fix(lite): error in changelog (#8799)
introduced by #8761
2025-07-16 15:11:56 +02:00
Pierre Donias
aa68b7432b fix(@xen-orchestra/mixins): typo (#8789)
See #8593
2025-07-15 11:38:29 +02:00
Joris K
c5ba756618 feat(web-core): updated query search bar to work in responsive (#8761) 2025-07-11 16:59:07 +02:00
Pierre Donias
0e69b3fdba feat(xo-web/acls): always use removeAcls to delete even a single entry (#8774)
See [MM](https://team.vates.fr/vates/pl/r7khs54wiidw8ehbf5kfm9enow)
2025-07-10 15:32:07 +02:00
Joris K
d4263d8408 fix(xo6/lite): fixed display error due to inversion of upload and download (#8793) 2025-07-10 15:19:28 +02:00
Mathieu
a403cd3711 feat(@xen-orchestra/rest-api): expose pool dashboard (#8768) 2025-07-10 14:51:53 +02:00
MlssFrncJrg
e47cf032e6 feat(@xen-orchestra/rest-api): expose delete group (#8704) 2025-07-07 16:51:59 +02:00
MlssFrncJrg
81fa8701c9 feat(xo-server/rest-api): migrate delete user (#8698) 2025-07-07 16:38:02 +02:00
MlssFrncJrg
424f303ade feat(@xen-orchestra/rest-api): expose create user (#8697) 2025-07-07 16:09:31 +02:00
Pierre Donias
8093cb461b fix(xo-web/health): correctly use snapshot functions/messages in snapshot tables (#8775)
See Zammad#41131
Introduced by #3274
2025-07-07 15:00:43 +02:00
Pierre Brunet
c8f9d81b8f fix(xo-lite): bump version 0.12.1 (#8788) 2025-07-03 15:40:40 +02:00
Pierre Brunet
895fd7f2d3 feat(lite): 0.12.1 (#8787) 2025-07-03 15:16:52 +02:00
Pierre Brunet
975c538229 feat: release 5.108.1 (#8786) 2025-07-03 14:50:38 +02:00
Pierre Brunet
2827c2a4ef feat: technical release (#8785)
* feat(xen-api): 4.7.3

* feat(@vates/nbd-client): 3.1.4

* feat(@vates/types): 1.8.0

* feat(@xen-orchestra/xapi): 8.3.2

* feat(@xen-orchestra/web-core): 0.24.0

* feat(@xen-orchestra/proxy): 0.29.25

* feat(@xen-orchestra/rest-api): 0.11.0

* feat(@xen-orchestra/web): 0.21.1

* feat(xo-server): 5.181.0

* chore(CHANGELOG): update next

* chore(CHANGELOG): pass changelogs to next release

* chore(CHANGELOG): remove changelog in wrong release

* chore(CHANGELOG): add packages
2025-07-03 11:56:28 +02:00
Thomas Moraine
797906283a docs(backups.md): explain how to schedule backups (#8783)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-07-03 11:46:59 +02:00
Thomas Moraine
0ef9ed97e4 docs(xo): deduplicate incremental backups and full replication content (#8777)
* docs: deduplicate delta_backups page

Previously, the content of the Incremental Backups page (filename: delta_backups.md) was duplicated by the page titled "Incremental Backups (formerly: Continuous Delta backups)", which was not referenced in the sidebar and had the filename incremental_backups.md.

We don't want duplicate content, as it is troublesome to maintain and may cause confusion for the reader.

Also, since Delta backup is outdated terminology and we now talk about Incremental backups, the lone incremental backups.md page has been deleted, and the current "Incremental Backups" page with the filename delta_backups.md has been renamed as the new incremental_backups.md

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

* docs: deduplicate full_replication page

Previously, the content of the Full Replication page (filename: disaster_recovery.md) was duplicated by the page titled "Full Replication (formerly: Disaster recovery)", which was not referenced in the sidebar and had the filename full_replication.md.

We don't want duplicate content, as it is troublesome to maintain and may cause confusion for the reader.

Also, since Disaster recovery is outdated terminology and we now talk about Full Replication, the lone full_replication.md page has been deleted, and the current "Full Replication" page with the filename disaster_recovery.md has been renamed as the new full_replication.md

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

---------

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-07-03 11:45:41 +02:00
Florent BEAUCHAMP
3bc90981af fix(xapi): respect the config file setting for preferNbd (#8780)
* fix(nbd-client): handle unreachable VM through nbd

when the user select nbd but don't have any way to reach
the storage/host of the VM (for example no NBD enabled network,
or a NBD enabled network unreachable by xo/proxy it was timing out
and blocking the start of the backup
This error was blocking the fallback to export stream mechanism

* fix(xapi): respect the config file setting for preferNbd

* fix(xapi): don't close export stream if nbd failed to connect

* fix(xapi):respect vhd/qcow2 when faling back to a full if delta exports fails
2025-07-03 10:53:59 +02:00
Mathieu
6123c82d40 fix(api-error): api-error return an error instead of throwing (#8782) 2025-07-03 09:38:32 +02:00
Joris K
193ca26ca3 fix(xo-lite): change timestamp calculation (#8778)
Reported by https://xcp-ng.org/forum/topic/11012/graph-in-v0.12.0-48bf9
introduced by #8529 and #8504
2025-07-02 15:24:21 +02:00
Joris K
e2edac3875 fix(web-core): fix tooltip overflow when too close to the edge (#8779)
Reported by https://xcp-ng.org/forum/topic/11012/graph-in-v0.12.0-48bf9/2
Introduced by #6376
2025-07-02 15:19:24 +02:00
Mathieu
3c54363b09 feat(@xen-orchestra/rest-api): expose host/:id/audit.txt (#8757) 2025-07-01 10:15:57 +02:00
Mathieu
42ddf02831 feat(@xen-orchestra/rest-api): expose pool stats (#8764) 2025-07-01 09:52:44 +02:00
Pierre Brunet
48bf9c95c9 feat(lite): version 0.12.0 (#8771) 2025-06-30 16:56:04 +02:00
Pierre Brunet
850bd41fe7 feat: release 5.108 (#8770) 2025-06-30 16:38:28 +02:00
Pierre Brunet
fcefaaea85 feat: technical release (#8767) 2025-06-30 10:43:41 +02:00
Florent BEAUCHAMP
3c8efb4dc3 fix(backups): non NBD backups stalls (#8766) 2025-06-30 09:57:44 +02:00
Thomas Moraine
ac04f0aa46 doc(configuration): document let's encrypt support in xoa (#8657)
doc(configuration) document let's encrypt support in xoa

Add documentation explaining how to  configure Let's Encrypt in Xen Orchestra Appliance (XOA). This feature was mentioned in the XO 5.73 release blog post but was not included in the technical documentation for Xen Orchestra.
2025-06-30 09:54:36 +02:00
Enée DI IORIO
d96ffde7f5 feat(xo-web/uiCounter): fix radius (#8732)
* feat(xo-web/uiCounter): fix radius

* review
2025-06-30 09:39:03 +02:00
Enée DI IORIO
d89c861ea2 fix(lite,web/Host): tag list color (#8731)
Fixing the color of the tag on all UI tags, On all UiTagsList, we always have info for the UiTag variant.
2025-06-30 09:37:29 +02:00
Enée DI IORIO
2effd8520a feat(web-core/xo-6/xo-lite): add pagination in data tables (#8573) 2025-06-27 17:50:18 +02:00
Enée DI IORIO
b2e61a146d feat(xo-6/host): add name of pGpu in system view (#8740) 2025-06-27 17:43:51 +02:00
vates-bot
9212cd2559 feat(web-stack/i18n): update Xen Orchestra 6 (#8643)
* feat(web-stack/i18n): update Czech

* feat(web-stack/i18n): update German

* feat(web-stack/i18n): update Russian

* feat(web-stack/i18n): update Russian

* feat(web-stack/i18n): update Dutch

* feat(web-stack/i18n): update Russian

* feat(web-stack/i18n): update Czech

* feat(web-stack/i18n): update Czech

* feat(web-stack/i18n): update Spanish

* feat(web-stack/i18n): update Czech

* feat(web-stack/i18n): update Spanish

* feat(web-stack/i18n): update Spanish

* feat(web-stack/i18n): update Spanish

* feat(web-stack/i18n): Update German

* add changelog

---------

Co-authored-by: OlivierFL <olivier.floch@vates.tech>
Co-authored-by: Olini <oliver.elsner@oribu.net>
Co-authored-by: Aleksey Kruglov <apkrugru@gmail.com>
Co-authored-by: Tristis Oris <faust-dourden@ya.ru>
Co-authored-by: Mitchel Nijkamp <IxFail@users.noreply.translate.vates.tech>
Co-authored-by: Ниджат <nnr@ndb24.ru>
Co-authored-by: Pavel Borecki <pavel.borecki@gmail.com>
Co-authored-by: Francisco Nacher <xiscoj@gmail.com>
Co-authored-by: Xavier Esteban <xest@hotmail.com>
Co-authored-by: Joris-K <joris.kosacki@vates.tech>
2025-06-27 17:21:47 +02:00
Mathieu
0778c6c53c fix(@xen-orchestra/web&lite): handle graphs with null value (#8722) 2025-06-27 16:54:36 +02:00
Pierre Brunet
541411586b feat: technical release (#8762) 2025-06-27 14:35:39 +02:00
OlivierFL
8527fd96ee fix(xo-6/vite-config): links in dev pages break prod build (#8759) 2025-06-27 14:03:41 +02:00
Pierre Brunet
1cb9c5e633 feat: technical release (#8758)
* feat(vhd-lib): 4.14.0

* feat(@xen-orchestra/disk-transform): 1.1.0

* feat(@xen-orchestra/qcow2): 1.0.0

* feat(@xen-orchestra/xapi): 8.3.0

* feat(@xen-orchestra/backups): 0.62.0

* feat(@xen-orchestra/backups-cli): 1.1.1

* feat(@xen-orchestra/immutable-backups): 1.0.22

* feat(@xen-orchestra/web-core): 0.22.0

* feat(@xen-orchestra/proxy): 0.29.23

* feat(@xen-orchestra/rest-api): 0.10.0

* feat(@xen-orchestra/web): 0.20.0

* feat(xo-acl-resolver): 0.5.1

* feat(xo-server): 5.180.0

* feat(xo-web): 5.178.0

* chore(CHANGELOG): update next

* feat(@vates/types): 1.6.0

* fix(chore): changelog package order
2025-06-27 10:19:25 +02:00
Florent BEAUCHAMP
d837056eac chore: update READMEs (#8734) 2025-06-26 16:07:03 +02:00
MlssFrncJrg
fe92e206eb feat(xo-server/rest-api): migrate create_vm (#8658) 2025-06-26 15:58:28 +02:00
Julien Fontanet
5950c09016 fix(xo-server,xo-web): ability to clear remote syslog (#8746)
See https://team.vates.fr/vates/pl/rmh9o5mgnfg9ueey8y7b4grsjw
2025-06-26 15:34:48 +02:00
Enée DI IORIO
b952dd1f8f feat(web-core/size): fix type of formatSizeRaw (#8723) 2025-06-26 15:28:56 +02:00
Florent BEAUCHAMP
d499f3ec9e fix(xo-web): clarify when CBT is enabled automatically (#8754) 2025-06-26 15:19:18 +02:00
mathieuRA
8b44f95de5 feat(@xen-orchestra/rest-api): expose vm unpause 2025-06-26 14:28:40 +02:00
mathieuRA
cd013b8f82 feat(@xen-orchestra/rest-api): expose vm resume 2025-06-26 14:28:40 +02:00
mathieuRA
0202b56d33 feat(@xen-orchestra/rest-api): ability to start a vm on a specific host 2025-06-26 14:28:40 +02:00
mathieuRA
80d0624409 feat(@xen-orchestra/rest-api): expose vm suspend 2025-06-26 14:28:40 +02:00
mathieuRA
36889b3841 feat(@xen-orchestra/rest-api): expose vm pause 2025-06-26 14:28:40 +02:00
mathieuRA
fd5db5bf06 chore(@xen-orchestra/rest-api): add getXapi in BaseController 2025-06-26 14:28:40 +02:00
Florent BEAUCHAMP
f0d893d29a feat(xo-web/tasks): show only failed tasks by default in xo-task view (#8676) 2025-06-26 14:20:50 +02:00
Pierre Donias
d6a702b5fa fix(xo-web/Link): fix middle-click behaviour on FF (#8756) 2025-06-26 14:09:26 +02:00
Pierre Donias
bda87c9023 feat(xo-web/remotes): creation/edition Azure/Azurite remotes (#8753)
Implement UI for creation and edition of Azure and Azurite remotes.
2025-06-26 11:19:13 +02:00
Florent BEAUCHAMP
aae93d0103 docs(backups-cli): document the new remote option (#8752) 2025-06-26 10:09:25 +02:00
Enée DI IORIO
8fb3cf3c6c feat(xo-6/site): add page to list servers (#8664) 2025-06-25 16:51:47 +02:00
Thomas Moraine
eca4cb8ba3 docs(backups.md): explain how to send logs to a syslog server (#8747)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-06-25 16:39:11 +02:00
Pierre Brunet
d967cc2efb feat(@xen-orchestra/rest-api): expose SM in the REST API (#8696) 2025-06-25 15:20:19 +02:00
Mathieu
4f9efb5e49 feat(@xen-orchestra/rest-api): expose VM import (#8748) 2025-06-25 14:46:32 +02:00
Florent BEAUCHAMP
bb4e14b6dd fix(backups): use the right format (qcow2/vhd) (#8750)
introduced by cbc07b319f
2025-06-25 12:15:56 +02:00
Thomas Moraine
a348ce07d8 docs(tab-advanced-js): fix wrong link to guest uefi secure boot guide (#8749)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-06-25 10:21:03 +02:00
Enée DI IORIO
a53297bd5a feat(web-core): create UiQuoteCode component (#8701) 2025-06-25 10:20:45 +02:00
Joris K
e4959045df feat(xo6/lite): update side panel behavior for mobile view (#8688)
* feat(xo6/lite): update side panel behavior for mobile view

* feedback & improvement

* feedback

* feedback

* fix issue with sticky side panel when datatable has a lot of data

* feedback and fix issue

* add changelog

* update icon

* review feedback

* update vts copy button icon
2025-06-24 17:03:47 +02:00
Mathieu
aa707b386a feat(@xen-orchestra/rest-api): dashboard enpoint can return a stream (#8695) 2025-06-24 16:35:11 +02:00
Florent BEAUCHAMP
cbc07b319f feat(xapi): support import and export of qcow2 disks (#8506)
This PR implement a limited support of generating and reading qcow2 . The support is limited since it only handles qcow2 with 64KB cluster size, with this structure :

    header
    refcount table
    refcount blocks
    L1 table
    L1 tables
    data clusters

generated by a9cd5bc639/scripts/qcow2-to-stdout.py
2025-06-24 15:32:20 +02:00
Pierre Brunet
7994fc52c3 feat: technical release (#8745)
* feat(xo-remote-parser): 0.10.0

* feat(@xen-orchestra/fs): 4.6.0

* feat(vhd-lib): 4.13.0

* feat(xen-api): 4.7.2

* feat(@vates/task): 0.6.2

* feat(@vates/types): 1.5.0

* feat(@xen-orchestra/backups): 0.61.2

* feat(@xen-orchestra/backups-cli): 1.1.0

* feat(@xen-orchestra/web-core): 0.21.0

* feat(@xen-orchestra/rest-api): 0.9.0

* feat(@xen-orchestra/web): 0.19.0

* feat(vhd-cli): 0.9.4

* feat(xo-web): 5.177.0

* feat(xo-server): 5.179.0

* feat(xo-server-auth-oidc): 0.3.3

* feat(xo-server-backup-reports): 1.6.0

* feat(xo-server-load-balancer): 0.10.2

* feat(xo-server-transport-nagios): 1.0.3

* chore(changelog): update next

* feat(@xen-orchestra/proxy): 0.29.22

* feat(xo-server-perf-alert): 0.6.3

* fix(chore): update changelog

* fix: fix yarn.lock
2025-06-23 17:27:36 +02:00
Florent BEAUCHAMP
1a7b56a4fe fix(fs): fix 'The last argument to .catch() must be a function, got […object Object]' (#8739)
introduced by afb110c473
2025-06-23 14:19:59 +02:00
Olivier Lambert
040ae74079 docs(restapi): improve the REST API page, explain the versioning and … (#8742)
docs(restapi): improve the REST API page, explain the versioning and the current status

Signed-off-by: Olivier Lambert <olivier.lambert@vates.tech>
2025-06-23 12:02:36 +02:00
Pierre Brunet
695b0c4d90 fix: re-add await for createOutputStream (#8741)
Fix issue in metadata backup which was broken due to forgotten async introduced by #8718
2025-06-23 11:41:45 +02:00
Florent BEAUCHAMP
858681ecc1 feat(backups): enable CBT only when using "purge snapshot data" (#8735) 2025-06-23 10:35:38 +02:00
Thomas Moraine
035f5b7651 docs(restapi): clean up the rest api page (#8683) 2025-06-23 10:00:04 +02:00
Josh Soref
be3677d0bb fix(rest-api): typo
See #8593
2025-06-23 09:52:46 +02:00
Pierre Donias
6b26353be8 fix(vhd-lib,vhd-cli): typos and spelling (#8730)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-06-20 16:30:13 +02:00
Pierre Brunet
0776fc1616 Feat fs safeguards (#8718)
Add safety functions in abstract instead of s3 and azure. A new function "withTimeout" allows to handle timeout and success/failure after timeout.
It should help for better debug and it can be used in several situations.
2025-06-20 14:55:51 +02:00
Josh Soref
1d6ea0a2b9 fix(xo-acl-resolver): typo
See #8593
2025-06-20 10:13:53 +02:00
Thierry Goettelmann
19412728cb feat(web-core): create initial icon packs + icon dev page (#8724) 2025-06-19 16:08:39 +02:00
Thierry Goettelmann
5772bbd005 feat(lite): remove old lite components usage in favor of web-core components (#8685)
* feat(lite): remove old lite components usage in favor of web-core components

* feedback
2025-06-19 15:27:55 +02:00
Pierre Donias
31ef709b30 fix(plugins): typos and spelling (#8728)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-06-19 14:15:41 +02:00
Pierre Donias
8d498151d9 fix(lite,web-core): typos and spelling (#8727)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-06-19 14:12:13 +02:00
Pierre Donias
fb9bd06dfd fix(@vates/task): typos (#8726)
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
See #8593
2025-06-19 11:11:49 +02:00
Pierre Donias
c6ee83bcad fix(workflows): typo (#8725)
See #8593
2025-06-19 11:04:48 +02:00
Joris K
a8723e3619 fix(xo6/site): fix issue with prefix in site dashboard (#8721)
Introduced by #8585
2025-06-19 09:48:22 +02:00
Mathieu
607e2ef67e feat(xo-server): ability to add/remove data source for VMs (#8699)
XO-846

Methods are also added in the JSON-RPC API because our partner do not use the REST API for now.
2025-06-18 10:27:53 +02:00
Florent BEAUCHAMP
4da43ff805 fix(fs): ensure configuration is really passed to remotes (#8707)
remoteOpiions of config file wasn't properly passed to the remotes

especially the timout settings
from ticket 36083
2025-06-18 10:04:28 +02:00
Florent BEAUCHAMP
c8f0a5a583 feat(backups-cli): handle cleanup of remotes (#8712)
zammad#39640
2025-06-17 16:47:35 +02:00
Florent BEAUCHAMP
d863696a17 fix(vhd-lib): handle double close of vhd file (#8706)
zammad#39533
2025-06-17 16:32:51 +02:00
p-bo
daec3dc89f fix(xo-web/intl): use correct ISO code for Swedish (#8719)
Introduced by #7844
See #8711
2025-06-17 15:16:32 +02:00
p-bo
f235925eed feat(xo-web/user): add XO6-only languages to be able to switch to them (#8711)
XO6 is translated into languages, not existing for XO5. And as it is not
possible to select language in XO6 yet (is inherited from XO5 settings), interim
solution is to add these new languages into XO5 user settings, to make them
actually accessible in XO6. It will not affect XO5, because it will simply
fallback into English in case of not existing language.
2025-06-17 14:14:41 +02:00
dinhngtu
0e02282f30 Apply suggestions from code review
Co-authored-by: Thomas Moraine <thomas.moraine@vates.tech>
Signed-off-by: Tu Dinh <ngoc-tu.dinh@vates.tech>
2025-06-17 10:36:27 +02:00
Tu Dinh
09f19ef22d docs(XO): add Windows cloudbase-init template guide
Add a step-by-step guide for creating VM templates with cloudbase-init
support, including master VM creation, template branching, customization,
reseal and VM instantiation.

Include best practices, tips and visual aids for each step.

Signed-off-by: Tu Dinh <ngoc-tu.dinh@vates.tech>
2025-06-17 10:36:27 +02:00
Joris K
6adb304e5d feat(xo-lite/vm): add dashboard view (#8529) 2025-06-17 10:29:35 +02:00
Thierry Goettelmann
b6083b214c feat(web-core): new icon management library (#8607) 2025-06-17 09:07:32 +02:00
OlivierFL
beeef40eda feat(xo-6/treeview): introduce site level in treeview (#8694) 2025-06-17 08:59:41 +02:00
Thomas Moraine
486034d32b docs(xo): upgrade docusaurus from 3.7 to 3.8.1
The new version of Docusaurus introduces performance improvements, see the announcement here: https://docusaurus.io/blog/releases/3.8

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-06-16 17:18:51 +02:00
Mathieu
bd64758e5b fix(xo-server): fix no such object when fetching servers (#8709) 2025-06-16 16:36:26 +02:00
Bastien Nollet
b71101feaf feat(xo-server-backup-reports): avoid making report content depend on reportWhen (#8670)
remove a value that was only used for backup reports, and was no longer used since we use the template system

avoid the backup report content to differ when the backup job has reportWhen = false, which also caused differences between regular backup reports and backup reports generated with the "test plugin" button. To make sure the users can still have the previous behavior, we add parameter in the backup job configuration that allows short failure reports by not displaying all successful VMs in error reports.

rewording "successful VMs" to "successful items" so it also makes sense for metadata backups
2025-06-16 16:34:18 +02:00
mathieuRA
dc2247d739 feat(@xen-orchestra/rest-api): expose delete servers/<id> 2025-06-16 16:00:34 +02:00
mathieuRA
6bd79394bd fix(xo-server): fix unregister server only disconnect 2025-06-16 16:00:34 +02:00
Pierre Donias
bb68d3495a fix(auth-oidc): require advanced prop when sub-props are required (#8662)
Introduced by #6684

If sub-properties are required but the parent property is not, then omitting
the parent property passes the validation, which is not what we want.
2025-06-16 09:45:09 +02:00
Joris K
36e594a3ca feat(xo-6/vm): add dashboard view (#8585) 2025-06-16 09:24:43 +02:00
Mathieu
7be702ef0d feat(@xen-orchestra/rest-api): expose pgpus (#8684) 2025-06-13 14:54:29 +02:00
Pierre Brunet
64eac04446 feat: add image_format to vdi object (#8654) 2025-06-12 17:02:18 +02:00
NadineYasser1
8add75a41d feat(fs): add azure blob storage (#8415)
implement azure backup storage on the backend
2025-06-11 11:58:58 +02:00
Thierry Goettelmann
1bda61e2a0 feat(web-core): simplify logic of VtsCopyButton (#8693) 2025-06-11 11:07:18 +02:00
Joris K
919cf12134 feat(web-core): create composable to translate, formatted and use pluralization with useTimeAgo (#8578) 2025-06-11 10:54:44 +02:00
Joris K
ee2bb3a1c7 feat(xo-6/dashboard): update components BackupIssues and VtsBackupState (#8674) 2025-06-11 10:53:44 +02:00
Mathieu
0c1947aba2 feat(@xen-orchestra/rest-api): expose dashboard endpoint (#8580) 2025-06-10 14:41:05 +02:00
Mathieu
b3145b1034 REST API: expose get pcis and get pci id (#8686) 2025-06-10 14:01:04 +02:00
Thierry Goettelmann
033e241a82 feat(web): improve sidebar (#8691) 2025-06-10 13:34:10 +02:00
OlivierFL
bd62d22c52 feat(web-stack/i18n): migrate $t to t (#8682) 2025-06-10 10:02:29 +02:00
Julien Fontanet
a504efb2ee fix: add missing rimraf dev dependency 2025-06-06 15:03:52 +02:00
Mathieu
9066e43f51 feat(@xen-orchestra/rest-api): ability to use ndjson for collections (#8628) 2025-06-06 15:02:18 +02:00
mathieuRA
5e733c9e69 feat(@xen-orchestra/rest-api): expose pool rolling_update 2025-06-06 14:51:10 +02:00
mathieuRA
35e8d960e2 feat(@xen-orchestra/rest-api): expose pool rolling_reboot 2025-06-06 14:51:10 +02:00
mathieuRA
1667e0f573 feat(@xen-orchestra/rest-api): expose pool emergency_shutdown 2025-06-06 14:51:10 +02:00
mathieuRA
815dad114c feat(@xen-orchestra/rest-api): expose delete network 2025-06-06 14:10:56 +02:00
mathieuRA
94db22f7b0 feat(@xen-orchestra/rest-api): expose create network 2025-06-06 14:10:56 +02:00
mathieuRA
d47fa03ec8 fix(xen-api): getObject* throw nosuchObject 2025-06-06 14:10:56 +02:00
Mathieu
83f52c25cb fix(@xen-orchestra/rest-api): fix typo in actionAsyncrone (#8675) 2025-06-06 11:44:56 +02:00
Thomas Moraine
bb0650d258 docs(vm-templates): document viridian extensions (#8525)
The Viridian setting in Xen Orchestra was mentioned in a release blog (XO 5.79) but not in the XO technical documentation.

This improvement explain what Viridian is and how to enable it for VMs and templates, from within XO.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-06-06 11:32:23 +02:00
Pierre Donias
f817d4a813 fix(xo-server/plugins): disable strictRequired in JSON compilation (#8669)
See https://ajv.js.org/strict-mode.html#defined-required-properties
2025-06-06 10:04:25 +02:00
Florent BEAUCHAMP
45394609d2 fix(xo-web/VM/Advanced): fix CPU mask computation (#8661) 2025-06-06 10:03:13 +02:00
Mathieu
c7167bcc49 fix: order of packages to fix the ci (#8680)
fix: order packages order for fix the CI
2025-06-05 18:41:56 +02:00
Mathieu
92932dd546 feat(xo-server): inject master in server properties (#8637) 2025-06-05 16:35:27 +02:00
Mathieu
a6ed74a8ec feat: release 5.107.2 (#8679) 2025-06-05 16:31:43 +02:00
Mathieu
529e6bd7d1 feat: technical release (#8677)
* feat(@vates/generator-toolbox): 1.0.3

* feat(@xen-orchestra/backups): 0.61.1

* feat(@xen-orchestra/proxy): 0.29.21

* feat(xo-server): 5.178.2

* feat(xo-web): 5.176.0

* chore(CHANGELOG): update next
2025-06-05 15:13:41 +02:00
Julien Fontanet
ceaf3ee2da fix(CHANGELOG): fix Markdown 2025-06-05 09:52:22 +02:00
OlivierFL
b21f49e804 chore(web-core/docs): update guidelines (#8640) 2025-06-05 09:32:55 +02:00
Enée DI IORIO
392352e324 feat(xo-lite/pool): add system page (#8660) 2025-06-05 08:47:53 +02:00
Thomas Moraine
e64c434d0c docs(plugins): fix links to various plugins
The documentation for mutliple plugins was updated or moved outside the general Plugins page over time.

As a result, the links contained in various plugin's Readme or Usage files got obsolete, as they all point to the general Plugins page, instead of the specific plugin documentations.

This commit updates those links with the relevant location.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-06-04 16:40:43 +02:00
Florent BEAUCHAMP
4253ad6823 fix(backups): properly clone data on incremental backup (#8668) 2025-06-04 15:29:07 +02:00
Josh Soref
0a378391a9 chore: fix spelling errors and typos in docs and comments (#8619) 2025-06-04 14:37:58 +02:00
Thomas Moraine
699f4e08a2 docs(usage-reports): fix link to the usage report plugin documentation
Previously, the Readme and Usage files related to the server-usage-report plugin contained links pointing to a general page on plugins.

The server-usage-report plugin has since been documented in the Management → Manage infrastructure management page of the Xen Orchestra documentation. As a result, these links have become obsolete.

This commit make the obsolete links point to the actual, new documentation on the server-usage-report plugin.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-06-04 13:48:02 +02:00
Enée DI IORIO
77cb05d861 feat(xo-6/pool): add system page (#8581)
* feat(xo-web): create system page

* feat(xo-web): creat poolGeneralInfo component

* feat(xo-web): creat poolLicensing component

* feat(xo-web): create poolNetworking component

* feat(xo-web): create poolManagement component

* feat(xo-web): create poolStorageConfiguration component

* feat(xo-web): create poolConnection and poolResourceManagement component

* feat(xo-web): create server.store for adding data on poolConnection

* feat(xo-web) update changelog

* fix(xo-web) add loading, fix server.store

* feat(xo-web) add VtsEnabledState from [#8521](https://github.com/vatesfr/xen-orchestra/pull/8521/files#diff-38e34d645fd18a178735268961d29214f9e9b683e3849d7766bc35ba7da64427)

* fix(xo-web) fix VtsEnabledState

* feat(xo-web): create system page

* feat(xo-web): creat poolGeneralInfo component

* feat(xo-web): creat poolLicensing component

* feat(xo-web): create poolNetworking component

* feat(xo-web): create poolManagement component

* feat(xo-web): create poolStorageConfiguration component

* feat(xo-web): create poolConnection and poolResourceManagement component

* feat(xo-web): create server.store for adding data on poolConnection

* feat(xo-web) update changelog

* fix(xo-web) add loading, fix server.store

* feat(xo-web) add VtsEnabledState from [#8521](https://github.com/vatesfr/xen-orchestra/pull/8521/files#diff-38e34d645fd18a178735268961d29214f9e9b683e3849d7766bc35ba7da64427)

* fix(xo-web) fix VtsEnabledState

* fix(xo-web) use vtsColumn on system page

* review

* fix(xo6/poolSystem): add vts loading hero

* review
2025-06-04 09:14:00 +02:00
Thierry Goettelmann
a54b233ea2 feat(web-core): enhance form select library (#8618) 2025-06-03 17:54:30 +02:00
Pierre Donias
e1ee2d11ac feat(xo-web/OTP): "password" → "OTP code" when enabling OTP (#8666)
See Zammad#39728
2025-06-03 15:53:39 +02:00
Pierre Donias
3603ac1c43 feat(xo-web/VM): add "HIDE_XSA468" tag on VM to hide all XSA-468 warnings (#8665)
See #8638
2025-06-03 15:44:55 +02:00
OlivierFL
3c24064bf3 fix(xo-6/changelog): add missing packages to release (#8667)
Introduced by 5c0ee7e
2025-06-03 15:10:31 +02:00
Pierre Donias
f6c9809c1f fix(perf-alert): add missing type "array" in JSON schema (#8663)
Introduced by #7911
2025-06-03 15:09:42 +02:00
Thierry Goettelmann
77389f91eb feat(web-core): enhance collection library (#8614) 2025-06-03 15:00:38 +02:00
Thierry Goettelmann
a82af251c5 feat(web-core): enhance mapper library (#8609) 2025-06-03 11:54:03 +02:00
OlivierFL
5c0ee7e269 feat(xo-6/xo-lite/host): rename RAM usage components and update CPU provisioning logic in dashboard (#8648) 2025-06-03 11:53:20 +02:00
Mathieu
6ecabc3d9a feat: release 5.107.1 (#8656) 2025-05-28 15:16:24 +02:00
Mathieu
009f791d84 feat: technical release (#8655) 2025-05-28 14:21:52 +02:00
Pierre Donias
2fd5759489 fix(xo-server/xapi-object-to-xo): do not check vulnerabilities on templates and snapshots (#8652)
Introduced by #8638
See https://xcp-ng.org/forum/topic/10888/xsa-468-multiple-windows-pv-driver-vulnerabilities-update-now/19
2025-05-28 10:24:45 +02:00
Mathieu
6ed35551ee feat(lite): 0.11.0 (#8650) 2025-05-27 18:15:29 +02:00
Mathieu
47ec82ded4 feat: release 5.107 (#8649) 2025-05-27 18:03:47 +02:00
Mathieu
f7b3e7da92 feat: technical release (#8647)
* feat(xo-web): 5.175.1

* chore(CHANGELOG): update next
2025-05-27 17:35:21 +02:00
Pierre Donias
e931c51af0 fix(xo-web): prevent subscribeSelfLicenses from returning an object (#8646)
Introduced by #8523
2025-05-27 17:26:10 +02:00
Mathieu
b5eaf53ba9 feat: technical release (#8645) 2025-05-27 16:13:45 +02:00
OlivierFL
00466fde65 fix(xo-6/vm): add required comment in vm index.vue file to prevent build fail (#8644) 2025-05-27 16:07:01 +02:00
Mathieu
a7346871c3 feat: technical release (#8642) 2025-05-27 15:47:25 +02:00
Pierre Donias
19db81f7d8 fix(CHANGELOG): fix XSA-468 links (#8641) 2025-05-27 15:19:52 +02:00
Pierre Donias
d48e537bd2 fix(xo-server,auth-ldap): do not pass undefined ID to registerUser2 (#8639) 2025-05-27 14:31:46 +02:00
Pierre Donias
bfc39542aa feat(xo-server,xo-web): show alert on VMs that are vulnerable to XSA-468 (#8638)
See https://xenbits.xen.org/xsa/advisory-468.html
See https://docs.xcp-ng.org/vms/#xsa-468-multiple-windows-pv-driver-vulnerabilities
See https://xcp-ng.org/blog/xsa-468-windows-pv-driver-vulnerabilities/
2025-05-27 14:25:39 +02:00
Mathieu
b8f9be6553 feat(@xen-orchestra/rest-api): expose vm snapshot action (#8622) 2025-05-27 13:50:51 +02:00
Florent BEAUCHAMP
dfbc578dfa fix(disk-transform): backup omnibus fix (#8635) 2025-05-27 13:50:27 +02:00
Enée DI IORIO
2f84a07066 feat(web-core/UiCardNumbers): fix if unit is undefined (#8636) 2025-05-27 11:37:44 +02:00
Bastien Nollet
55ac7f0035 fix(xo-web): hub ensure template is a template (#8634)
See xoa#234

Prevent importing hub templates that are actually not templates.
Importing an incorrect template previously created a VM without any way to know it.
2025-05-27 11:30:40 +02:00
Pierre Donias
2e1fe1dd34 fix(xo-web/VM/Advanced): handle vm.VTPMs containing null values (#8601)
Fixes Zammad#39180
Introduced by #7085
2025-05-27 10:43:08 +02:00
Nathanaël
bf7518c98b feat(web-stack/i18n): update Xen Orchestra 6 (#8534) 2025-05-27 09:54:49 +02:00
Enée DI IORIO
88a2144339 feat(xo-6/xo-lite): redirect /vm/UUID to /vm/UUID/console (#8553) 2025-05-26 17:38:17 +02:00
Joris K
e1dab25045 feat(xo-lite): add possibility to edit SR on existing vdis (#8507) 2025-05-26 17:31:35 +02:00
Bastien Nollet
c5a268277f fix(xo-web): avoid unrelevant errors on isPubKeyTooShort (#8605) 2025-05-26 14:50:19 +02:00
Enée DI IORIO
bff0e37fbd feat(web-core): update UI card numbers component (#8626) 2025-05-26 11:00:17 +02:00
Joris K
8d0151fcb5 feat(web-core): update svg with new illustrations, and add new vtsState components (#8591) 2025-05-26 10:59:39 +02:00
mathieuRA
3628066154 feat(@xen-orchestra/rest-api): expose get pifs and get pifs/id 2025-05-26 09:49:55 +02:00
mathieuRA
a55d1c4a00 feat(@vates/types): add XoPif 2025-05-26 09:49:55 +02:00
Mathieu
6e273b3328 feat: technical release (#8632)
* feat(@xen-orchestra/proxy): 0.29.19

* chore(CHANGELOG): update next
2025-05-26 08:52:40 +02:00
Mathieu
ca227536aa feat: technical release (#8631) 2025-05-23 15:47:32 +02:00
Florent BEAUCHAMP
a8753530bd fix(vhd-lib): add to changelog (#8630) 2025-05-23 15:37:57 +02:00
Mathieu
b674e0d13f feat: technical release (#8629)
* feat(@xen-orchestra/fs): 4.5.1

* feat(@vates/generator-toolbox): 1.0.2

* feat(@vates/nbd-client): 3.1.3

* feat(@vates/types): 1.3.0

* feat(@xen-orchestra/disk-transform): 1.0.0

* feat(@xen-orchestra/xapi): 8.2.0

* feat(@xen-orchestra/backups): 0.60.0

* feat(@xen-orchestra/backups-cli): 1.0.31

* feat(@xen-orchestra/immutable-backups): 1.0.20

* feat(@xen-orchestra/web-core): 0.20.0

* feat(@xen-orchestra/proxy): 0.29.18

* feat(@xen-orchestra/rest-api): 0.7.0

* feat(@xen-orchestra/web): 0.18.0

* feat(xo-server): 5.177.1

* feat(xo-server-auth-oidc): 0.3.2

* feat(xo-server-netbox): 1.9.0

* feat(xo-server-perf-alert): 0.6.2

* chore(CHANGELOG): update next
2025-05-23 15:06:25 +02:00
Mathieu
0dec1299f1 fix(web/lite): ability to create VM without VDIs (#8617) 2025-05-23 13:57:12 +02:00
Enée DI IORIO
2cff92641e feat(xo6/xo-lite): update vm/system (#8586) 2025-05-23 13:45:17 +02:00
Sebastian CZECH
9d9158266d feat(xo-lite/host): add system page (#8536) 2025-05-23 11:57:59 +02:00
Mathieu
dc1ffedb0a fix(xo-server/xen-server): fix disabling an enabled but disconnected server (#8599) 2025-05-23 11:39:00 +02:00
Bastien Nollet
c9a8083b12 feat: release 5.106.4 (#8627) 2025-05-23 11:37:40 +02:00
Bastien Nollet
2519284521 feat: technical release (#8625) 2025-05-23 10:21:55 +02:00
Pierre Donias
cb70114aa4 fix(xo-web/update): explicitly check trial when disabling email input (#8624)
Introduced by #8595
2025-05-23 10:08:02 +02:00
Sebastian CZECH
9140b0b9bb feat(xo-6/host): add system page (#8521) 2025-05-23 09:43:12 +02:00
Enée DI IORIO
958b5b4f03 fix(xo-6/header): Safari force rendering header on size change (#8574) 2025-05-23 09:42:37 +02:00
Bastien Nollet
160d7f7712 fix(@xen-orchestra/xapi): catch error on mdadm status for offline hosts (#8597) 2025-05-23 09:32:19 +02:00
OlivierFL
ae2361da1f feat(xo-6/host): update dashboard quick info section (#8606) 2025-05-23 09:04:09 +02:00
Mathieu
aeffcd32b9 fix(@xen-orchestra/rest-api): move networks into good folder (#8610) 2025-05-22 17:30:46 +02:00
Mathieu
9af1a729bc fix(xo-server): cpuCap and cpuWeight can no longer be null (#8577) 2025-05-22 16:53:24 +02:00
Mathieu
1404fda662 feat(@xen-orchestra/rest-api): expose vm (clean/hard)_reboot (#8611) 2025-05-22 16:45:04 +02:00
Florent BEAUCHAMP
f2a38591d3 fix(backups): error "a differential VHD must have a parent" (#8616) 2025-05-22 16:44:52 +02:00
Pierre Donias
4601306b23 feat(netbox): support Netbox v4.3.x (#8588)
Fixes #8587
2025-05-22 16:43:53 +02:00
Bastien Nollet
1615e0eb77 feat: release 5.106.3 (#8621) 2025-05-22 16:27:59 +02:00
Bastien Nollet
6d129a4ec4 feat: technical release (#8620) 2025-05-22 14:46:09 +02:00
Mathieu
87b5cacf52 feat(@xen-orchestra/rest-api): expose (clean/hard)_shutdown (#8612) 2025-05-22 12:21:02 +02:00
Pierre Donias
cbfcf9b736 docs(PULL_REQUEST_TEMPLATE): instruction for external contributors (#8600)
Fixes #8594
2025-05-21 15:45:21 +02:00
Thomas Moraine
c29a682d40 docs(advanced, manage_infrastructure): deduplicate alerts content
The Alerts page was not listed in the sidebar and duplicated content from the Alerts section in the Advanced page. This commit removes the standalone Alerts page and redirects all links pointing to it to the Alerts section of the Advanced page. This change also fixes a broken anchor warning in Docusaurus, which could prevent new documentation builds from succeeding.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-21 15:23:34 +02:00
Thomas Moraine
ad27a5d390 docs(manage_infrastructure): explain VIFs and network locking mode (#8584)
* doc(XO): Explain VIFs and Network locking mode

VIFs and the Network locking mode were previously missing in the Xen Orchestra technical documentation, with details scattered across XO blog posts, CLI references in the XCP-ng doc, and other sources.

This commit adds information on VIFs and the network working modes to the XO documentation, making it a more complete and reliable reference for users.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>

* Update manage_infrastructure.md

---------

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
Co-authored-by: Julien Fontanet <julien.fontanet@vates.tech>
2025-05-21 15:23:03 +02:00
Pierre Donias
bb59801c0f fix(xo-server/VM.setAndRestart): explicitly pass forceShutdownDelay: 0 to VM.stop (#8592)
Fixes Zammad#38602
Introduced by #7247

Avoid immediately falling back to a hard shutdown when calling `VM.stop`,
especially in cases where a clean shutdown was requested explicitly by the user
like in `VM.setAndRestart`.
2025-05-21 15:20:58 +02:00
Pierre Donias
4f65a85989 feat(xo-web/update): disable registration email input when XOA is in trial (#8595) 2025-05-21 14:54:28 +02:00
Thomas Moraine
802a5ceb90 docs(manage-infrastructure): explain rolling pool update scheduling (#8549)
Rolling pool update (RPU) scheduling was introduced in Xen Orchestra 5.102 and mentioned in the corresponding blog post, but it was not included in the XO technical documentation.

This commit explains how to schedule RPUs, so users no longer need to refer to blog posts for instructions.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-21 14:06:02 +02:00
Thomas Moraine
0e43512383 docs(restapi): add Swagger API documentation details (#8540)
As mentioned in the XO 5.104 release blog post, we're gradually documenting the Xen Orchestra REST API using Swagger.

The REST API page in our technical documentation already has a 'Future Improvements' section, which seems like a good place to mention Swagger, even though the documentation process is still ongoing.

This way, users won't need to check the XO blog to learn about this feature.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-21 13:55:24 +02:00
Thomas Moraine
3d2d6c8248 docs(footer): correct wrong GitHub link (#8598)
The GitHub link in the footer was the default one used by the Docusaurus template.

This commit changes the link so that it points to the Xen Orchestra GitHub repository.
2025-05-21 10:02:01 +02:00
Thomas Moraine
a49b27bff7 docs(airgap): fix broken link to xoa check (#8602)
Correct a malformed link to the Support -> XOA Support -> XOA check section in the XO documentation, ensuring Docusaurus builds the doc properly.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-20 16:42:02 +02:00
Thomas Moraine
4432e64b6c docs(troubleshooting): integrate general_troubleshooting (#8560)
The General Troubleshooting page is not listed in the sidebar and contains minimal content, making it suitable to be merged into the existing Troubleshooting page, which is already accessible. Consequently, the standalone General Troubleshooting page is no longer needed and is being removed.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-20 14:28:05 +02:00
Enée DI IORIO
adb490db41 fix(xo-server/signin): logo size on signin screen on Safari (#8572)
Fixes #8301
2025-05-20 14:27:25 +02:00
OlivierFL
e83f90937d fix(xo-core/vts-quick-info-row): handle long values in slot, add tooltip for key, add missing mobile styles (#8596) 2025-05-20 11:09:46 +02:00
Enée DI IORIO
14ce24fa8b feat(xo-lite/vm): create system page (#8547) 2025-05-20 10:40:17 +02:00
Thomas Moraine
21d2379462 docs(manage_infrastructure): document software RAID health check (#8576)
While Software RAID is provided as-is, Xen Orchestra allows users to monitor the health of their software RAID arrays.

This includes a dedicated status interface and alert messages for any issues.

This information was previously documented in the Xen Orchestra 5.102 release blog post, and is now integrated into the XO technical documentation.

This update ensures users have a single reference point for technical information, eliminating the need to search through blog posts.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-20 10:23:48 +02:00
mathieuRA
9a833ba15a feat(@xen-orchestra/rest-api): connect/disconnect a server 2025-05-19 16:46:08 +02:00
mathieuRA
4c8c34caab fix(xo-server/server): harmonize status checks in connect/disconnect 2025-05-19 16:46:08 +02:00
Florent BEAUCHAMP
15538b4f6b fix(@xen-orchestra/xapi): really stop xapi task 2025-05-19 16:37:57 +02:00
Florent BEAUCHAMP
75bdd0c4ab fix(@xen-orchestra/xapi): race condition on xapi task start 2025-05-19 16:37:57 +02:00
Florent BEAUCHAMP
b149e233ab fix(@xen-orchestra/xapi): update progress every percent 2025-05-19 16:37:57 +02:00
OlivierFL
d9087118cb feat(xo-core): add VtsEnabledState component (#8582) 2025-05-19 15:28:27 +02:00
p-bo
e3bda4488f docs(contributing): add Translations section (#8531) 2025-05-19 08:52:48 +02:00
Florent BEAUCHAMP
41e5a33cfe feat(backups): use generator instead of streams for backup and replication (#8432)
use generators instead of stream for backup and replication
2025-05-16 14:24:09 +02:00
Sebastian CZECH
5cadece9b1 fix(xo-6/vm-creation): better vifs handling (#8499) 2025-05-16 11:36:53 +02:00
Enée DI IORIO
a43292642b feat(web-core): create VtsCopyButton component (#8532) 2025-05-16 10:02:19 +02:00
OlivierFL
85b18e1d54 feat(xo-core): add VtsColumns component (#8579) 2025-05-15 10:46:43 +02:00
Thomas Moraine
95e72a8482 docs: fix links to docs and pricing thoughout the code (#8558) 2025-05-14 09:20:53 +02:00
Thomas Moraine
e652c5b341 doc(XO): Explain Differential restores (#8520)
Differential restores were mentioned in the XO blog (release 5.89)
but not in the XO technical documentation.
This commit explains in the technical doc what differential restores are
and how to perform one from the XO interface.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-05-14 08:55:17 +02:00
Enée DI IORIO
af03cfdb3c feat(xo-6/vm): create system page (#8522) 2025-05-13 13:57:55 +02:00
Enée DI IORIO
85c65a9ea0 feat(xo-6/treeview): collapse treeview when pool/host/vm is clicked (#8556) 2025-05-13 12:58:32 +02:00
Sebastian CZECH
bd1eb1fbb9 feat(web-core): update vtsLoadingHero Component (#8559) 2025-05-13 12:35:47 +02:00
b-Nollet
47bdf40e23 fix(xo-server-perf-alert): don't monitor non-running VMs and hosts 2025-05-13 11:36:14 +02:00
b-Nollet
b341f91bbb fix(xo-server-perf-alert): fixing configuration schema 2025-05-13 11:36:14 +02:00
Bastien Nollet
b9fc6cbbee feat(xo-server-auth-oidc): update dependency (#8555)
* feat(xo-server-auth-oidc): update dependency

* changelog
2025-05-12 17:25:42 +02:00
Pierre Donias
26ee92b2a7 fix(xo-server/Redis): properly delete IDs from Redis when multiple are removed (#8571)
Fixes Zammad#37604
Introduced by 36b94f745d

Since version 4, Redis' Node library doesn't support passing multiple flat
arguments to its methods to perform an action on multiple entries. It expects
an array instead.
2025-05-12 16:54:10 +02:00
Florent BEAUCHAMP
1fc52d73e7 fix(fs/s3): mirror full backup bigger han 50GB from encrypted source (#8570)
we must compute a relevant partSize when uploading a file bigger than 50G
bigger partSize means more memory consumption, but we are limited to
upload 10K chunk of partSize bytes

this commit will ensure there is an estimate of the size from encrpted remote
and pass this estimate to the FullRemoteWriter

from ticket 38031
2025-05-12 16:48:18 +02:00
Mathieu
7d116c1b76 feat(@xen-orchestra/rest-api): ability to add a server (#8564)
* feat(@xen-orchestra/rest-api): ability to add a server

* changelog
2025-05-12 16:36:04 +02:00
Thierry Goettelmann
a61450c2d7 feat(web-core): create VtsSelect, VtsOption and composables (#8438) 2025-05-12 15:18:00 +02:00
Thierry Goettelmann
0d65ae1568 fix(web-core): sidebar z-index (#8568) 2025-05-12 10:48:01 +02:00
Bastien Nollet
255ef06acc feat(lite): 0.10.1 (#8567) 2025-05-07 10:32:29 +02:00
Bastien Nollet
7fa77a3e75 feat: release 5.106.2 (#8566) 2025-05-07 10:01:13 +02:00
Bastien Nollet
ab56924b1d feat: technical release (#8563) 2025-05-06 12:39:57 +02:00
Florent BEAUCHAMP
14fce18f97 fix(xo-web): better handling of free and trial users (#8557)
- don't check licence for users with a running trial
- don't check licence for users with a free of from source plan
2025-05-06 11:25:22 +02:00
Joris K
14411866ac fix(xo-lite): add default value when the value of firmware is undefined (#8562) 2025-05-06 10:46:23 +02:00
Joris K
8fdd68addc feat(xo-lite): add possibility to add some tags (#8515) 2025-05-06 10:45:09 +02:00
Joris K
8d39fb654a feat(xo-lite): add affinity host field in vm creation, added pbd store, type and translation (#8486) 2025-05-05 17:09:07 +02:00
Thierry Goettelmann
b0099a98f8 feat(web-core): enhance useCollection composable (#8526) 2025-05-05 16:16:25 +02:00
Bastien Nollet
80e7273994 feat: release 5.106.1 (#8554) 2025-04-30 17:29:25 +02:00
Bastien Nollet
f9e58a6918 feat: technical release (#8552) 2025-04-30 16:05:08 +02:00
Florent BEAUCHAMP
c0ae2d7d87 fix(xo-web): better handling of strange licences (#8551) 2025-04-30 15:37:00 +02:00
Bastien Nollet
4b5a273e22 feat(lite): 0.10.0 (#8550) 2025-04-30 15:01:16 +02:00
Bastien Nollet
3bb59002c6 feat: release 5.106.0 (#8548) 2025-04-30 14:17:57 +02:00
Bastien Nollet
57ae9e7566 feat: technical release (#8546) 2025-04-30 10:12:56 +02:00
Pierre Donias
aa99af22d4 fix(CHANGELOG): add missing @xen-orchestra/web to packages to release (#8545)
Introduced by #8542
2025-04-30 09:38:40 +02:00
Joris K
1613293f46 feat(xo-lite): add topology field in vm creation (#8491) 2025-04-29 16:50:16 +02:00
Pierre Donias
2ebffdf9e2 fix(lite,web): use VtsInputWrapper to show input labels (#8542)
Introduced by #8436
2025-04-29 15:45:36 +02:00
Mathieu
2ea30b1899 feat(xo-server-web-hooks): handle office 365 connector format (#8498)
See Zammad#36742

Microsoft teams webhook requires a payload in the office 365 connector format.
2025-04-29 12:04:57 +02:00
Florent BEAUCHAMP
9c92f3a561 feat(license): better handling of expiring licenses (#8523) 2025-04-29 11:39:14 +02:00
Mathieu
374bd22f7b fix(xo-server): fix possible race condition at VIF level on VM creation (#8541) 2025-04-29 11:00:36 +02:00
Thomas Moraine
eae00400b8 doc(XO): Remove orphan Plugins page (#8539)
The page https://docs.xen-orchestra.com/plugins is not referenced in the navigation bar
 and duplicates the content in the https://docs.xen-orchestra.com/architecture#plugins page.
As a result, this commit deletes the Plugins page.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-04-29 10:55:54 +02:00
MlssFrncJrg
18c9259982 feat(@xen-orchestra/rest-api): expose get group and get groups (#8496) 2025-04-29 10:27:59 +02:00
Florent BEAUCHAMP
11050ca6d0 feat(v2v): resume import 2025-04-29 10:17:28 +02:00
Florent BEAUCHAMP
8756d12b8b fix(vmware-explorer): correctly handle stream and buffer
following dependence update 34e8ff6bae
2025-04-29 10:17:28 +02:00
MlssFrncJrg
93394508de feat(@xen-orchestra/rest-api): expose get networks and get network (#8497) 2025-04-29 09:42:19 +02:00
Bastien Nollet
ba8516d2d3 feat: technical release (#8537) 2025-04-28 16:20:12 +02:00
MlssFrncJrg
ae44845c09 feat(@xen-orchestra/rest-api): expose get user and get users (#8494) 2025-04-28 15:11:12 +02:00
Cyrille G.
88ccb60b60 feat(hub/recipes): update kubernetes version list to use Microk8s version (#8530)
feat(hub/recipes): update kubernetes version list to use Microk8s versions
2025-04-28 12:14:22 +02:00
Thomas Moraine
f879728ee9 docs(manage_infrastructure): document usage-report plugin (#8533)
The usage-reports plugin was not covered at all in the Xen Orchestra technical documentation.

This improvement explains how to get usage reports from your resources, by enabling and setting up the plugin.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-04-28 10:30:48 +02:00
OlivierFL
47b2a45548 chore(xo-core/docs): update guidelines (#8519) 2025-04-25 17:25:41 +02:00
Enée DI IORIO
404f5a3d88 feat(web-stack/host-header): add host master icon in host header (#8512) 2025-04-25 16:12:58 +02:00
OlivierFL
c3a5fefa02 feat(xo-lite/host): add dashboard view (#8504) 2025-04-25 15:35:37 +02:00
Florent BEAUCHAMP
34e8ff6bae fix: update following dependabot (#8509) 2025-04-25 15:05:11 +02:00
Mathieu
f9838c51d9 fix(xo-server): fix videoram not correctly parsed if defined in platform (#8524)
fix videoram not correctly parsed if defined in platform
2025-04-25 08:32:48 +02:00
Bastien Nollet
9ed551f87d feat: technical release (#8528)
* feat(@xen-orchestra/fs): 4.5.0

* feat(@vates/types): 1.2.0

* feat(@xen-orchestra/audit-core): 0.4.0

* feat(@xen-orchestra/backups): 0.59.0

* feat(@xen-orchestra/backups-cli): 1.0.30

* feat(@xen-orchestra/immutable-backups): 1.0.18

* feat(@xen-orchestra/web-core): 0.19.0

* feat(@xen-orchestra/proxy): 0.29.17

* feat(@xen-orchestra/rest-api): 0.4.0

* feat(@xen-orchestra/web): 0.16.0

* feat(xo-server): 5.176.1

* feat(xo-server-audit): 0.14.0

* feat(xo-web): 5.172.0

* chore(CHANGELOG): update next
2025-04-24 15:16:31 +02:00
Nathanaël
b5dd90f731 feat(web-stack/i18n): update Xen Orchestra 6 (#8465) 2025-04-24 10:24:04 +02:00
Bastien Nollet
d7e64028ec feat(xo-server-audit): audit import (#8474) 2025-04-23 11:03:29 +02:00
Pierre Donias
f17dde1021 fix(xo-web): do not show VM creator when user is not admin (#8503)
Fixes #8463
Introduced by #7276
2025-04-23 09:28:27 +02:00
Julien Fontanet
5c386c1987 feat(xo-web/host/networks): PIFs can be filtered by network names
Internal request: https://team.vates.fr/vates/pl/fgh4irbsi3f65xpzpyh4xe16za
2025-04-22 16:58:20 +02:00
Julien Fontanet
6f0f506d31 fix(CHANGELOG.unreleased): fix Markdown 2025-04-22 16:58:20 +02:00
Enée DI IORIO
058e43c692 feat(web-core): update UiInfo component (#8513) 2025-04-22 14:01:57 +02:00
mathieuRA
355d582965 feat(@xen-orchestra/rest-api): expose get messages and get message 2025-04-22 10:27:46 +02:00
mathieuRA
bc4df1872e feat(@xen-orchestra/rest-api): expose get alarms and get alarm 2025-04-22 10:27:46 +02:00
mathieuRA
d2e5f4213e feat(@vates/types): add XoMessage and XoAlarm 2025-04-22 10:27:46 +02:00
Mathieu
41b56a7fa8 fix(xo-server/createVm): fix DEVICE_ALREADY_EXISTS (#8473)
Introduced by 04dd9e9c40
See [mm](https://team.vates.fr/vates/pl/xn49jke9sfb7byt3k94ngjgq8a)
zammad#36543
2025-04-22 09:56:31 +02:00
Thomas Moraine
8a7d7f5748 docs(continuous_replication): rename to incremental_replication (#8514)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-04-22 09:27:54 +02:00
Thomas Moraine
48ca9597ff docs(load_balancing): explain how to find the load balancer plugin (#8511)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-04-22 08:49:38 +02:00
Thomas Moraine
9d24901300 doc(manage_infrastructure): add link to the V2V section of the XCP-ng doc (#8502)
The XCP-ng doc has been recently updated with more details on how to migrate from VMware to a Vates environment,
with a choice of methods including V2V within Xen Orchestra.

As a result, a mention of V2V is added to the XO doc, with a link to the relevant section in the XCP-ng doc.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-04-18 11:52:18 +02:00
Florent BEAUCHAMP
72f3c9f755 Update CHANGELOG.unreleased.md
Co-authored-by: Bastien Nollet <150058367+b-Nollet@users.noreply.github.com>
2025-04-16 08:45:06 +02:00
Florent BEAUCHAMP
44658110e1 fix(fs): better handling of rmtree EPERM errors
from ticket 37120
an EPERM error during a rmtree , called by the cleanup at the end
of a metdatadat backup, will trigger a ENOTDIR error
this can be caused by a misconfigured/failing immutable backup
2025-04-16 08:45:06 +02:00
Florent BEAUCHAMP
f461eff69a fix(fs): better handling of remote without VMs
remote without any VM ( either empty remote of config only remote)
are flooding the logs with errors like

Error: ENOENT: no such file or directory, scandir '/run/xo-server/mounts/f0952d37-294a-4d5e-8ba5-565e9932b4a7/xo-vm-backups'
2025-04-16 08:45:06 +02:00
Thierry Goettelmann
c609c58398 feat(web-core): don't force collection properties to be computed (#8510) 2025-04-15 16:24:19 +02:00
Florent BEAUCHAMP
e71c17bde3 chore: update dependencies (#8508)
chore: update dependencies
2025-04-15 13:49:15 +02:00
Thierry Goettelmann
06d62e9c28 feat(web-core): create useCollection composable (#8447) 2025-04-14 17:28:38 +02:00
mathieuRA
8e90ad487c feat(@xen-orchestra/rest-api): expose schedule/run 2025-04-14 13:37:09 +02:00
mathieuRA
17b95a8a8f feat(@xen-orchestra/rest-api): expose get schedules and get schedule 2025-04-14 13:37:09 +02:00
mathieuRA
11d78db88d feat(@vates/types): expose XoSchedule type 2025-04-14 13:37:09 +02:00
MlssFrncJrg
748a2ff860 feat(xo-web/dashboard): display snapshots older than 30 days (#8487)
Fixes #8258
2025-04-14 09:39:01 +02:00
MlssFrncJrg
83a69fd00f feat(@xen-orchestra/rest-api): expose get pools and get pool (#8490) 2025-04-11 13:22:27 +02:00
Thomas Moraine
6b89d30e29 Doc: Explain what 'Prevent migration' does (#8222) 2025-04-10 16:04:22 +02:00
Mathieu
5c88f9ee82 feat(xo-web/vm): rename 'disable migration' to 'prevent migration' (#8500)
introduced by dba08f0f
see https://xcp-ng.org/forum/topic/10206/block-migraton-option-on-the-vm-s-advanced-tab/14
related to #8222
2025-04-10 16:00:36 +02:00
René Paw Christensen
0ed5b7c788 docs(backups): exclude disks (#8493)
I have checked the source code, and it uses a "Contains" and not some kind of "StartsWith" to check whether the disk name should be excluded.

I think it is important to clarify that it is possible to place the "[NOBAK]" label after the disk name, which might help some to maintain their naming convention.
2025-04-09 16:59:38 +02:00
Mathieu
dba08f0fac feat(xo-web/vm): rename 'block migration' to 'disable migration' (#8492)
Introduced by 11a801c
Related to #8222
2025-04-09 10:46:30 +02:00
OlivierFL
18d8a29175 fix(xo-6/vm-creation): remove TS errors from type-check (#8472)
- Updated VM creation code to match the TS typing and remove errors in `type-check`
- Refactored code
- Simplified and improved business logic
- Improved naming
2025-04-08 16:56:16 +02:00
Thierry Goettelmann
838564b570 feat(web-core): update UiInput (#8436) 2025-04-08 16:26:08 +02:00
Mathieu
f04a469797 fix(@xen-orchestra/rest-api): fix unbrand type (#8480) 2025-04-08 11:52:28 +02:00
Mathieu
b32dcc2dcb feat(@xen-orchestra/rest-api): swagger interface qol (#8484) 2025-04-08 11:40:17 +02:00
mathieuRA
8128846ea4 feat(@xen-orchestra/rest-api): expose get vifs and get vif 2025-04-07 12:09:11 +02:00
mathieuRA
0dac0c212a feat(@vates/types): add XoVif type 2025-04-07 12:09:11 +02:00
Pierre Donias
dac9aab269 fix(xo-web/acls): disable ACL feature on plans <Enterprise (#8470)
Introduced by #3774
Introduced by #8412

ACLs feature is only available for XOA plans Enterprise and Premium. The
feature is properly disabled on the main ACL config page but was still
available from a VM's Advanced page and from the VM creation form.
2025-04-07 11:32:52 +02:00
Joris K
cf8065e56e feat(web-core): add alert component (#8459) 2025-04-07 11:29:04 +02:00
Olivier Lambert
e896ce6182 chore(docs): update Docusaurus to 3.7 (#8479)
Signed-off-by: Olivier Lambert <olivier.lambert@vates.fr>
2025-04-05 20:15:49 +02:00
Mathieu
224c840147 feat(lite): 0.9.1 (#8475) 2025-04-02 14:32:26 +02:00
Mathieu
ec78209f65 fix(web-core): fix _s is undefined (#8471)
Introduced by ac2f4e9
2025-04-01 16:48:35 +02:00
Sebastian CZECH
fd67016657 feat(web-core): circle progress bar component (#8402) 2025-04-01 14:01:22 +02:00
Mathieu
a420a95c09 feat(lite): 0.9.0 (#8468)
* feat(lite): 0.9.0
2025-03-31 16:44:41 +02:00
Mathieu
1b23812ddc feat: release 5.105 (#8467) 2025-03-31 16:31:53 +02:00
Mathieu
5c390d76e9 feat: technical release (#8466)
* feat(@vates/types): 1.1.1

* feat(@xen-orchestra/web-core): 0.18.0

* feat(@xen-orchestra/rest-api): 0.3.0

* feat(@xen-orchestra/web): 0.15.0

* feat(xo-server): 5.176.0

* feat(xo-server-backup-reports): 1.5.1

* feat(xo-web): 5.171.0

* chore(CHANGELOG): update next
2025-03-31 15:10:21 +02:00
Sebastian CZECH
82ed2bbf8c feat(xo-6): VM creation (#8324) 2025-03-31 14:49:03 +02:00
Joris K
3f565ff4a8 feat(xo-lite): VM creation (#8317) 2025-03-31 11:12:18 +02:00
Nathanaël
6d99331f26 feat(web-stack/i18n): update Xen Orchestra 6 (#8396) 2025-03-28 17:26:42 +01:00
MlssFrncJrg
b88e5c8e8f feat(@xen-orchestra/rest-api): expose get VM snapshots and get VM snapshot (#8453) 2025-03-28 16:36:31 +01:00
MlssFrncJrg
edc2591ce5 feat(@xen-orchestra/rest-api): expose get VM templates and get VM template (#8450) 2025-03-28 16:06:37 +01:00
MlssFrncJrg
2ff482ccad feat(@xen-orchestra/rest-api): expose get VM controllers and get VM controller (#8454) 2025-03-28 15:02:41 +01:00
OlivierFL
ad8f8fe0a4 fix(xo-6/host): ram usage progress bar not handling values properly (#8461) 2025-03-28 10:10:37 +01:00
MlssFrncJrg
873fe76d26 feat(xo-server): set new XAPI platform flag for nested virtualization (#8395)
set new XAPI platform flag for nested virtualization
2025-03-28 09:15:47 +01:00
Mathieu
782a93cdf8 feat(xo-server/xostor): handle XOSTOR on RPU process (#8455) 2025-03-27 12:25:06 +01:00
Mathieu
890766636a fix(xo-server/rest-api): return 404 if backup log do not exist (#8457) 2025-03-27 12:19:22 +01:00
OlivierFL
d77b195213 feat(xo-6/host): add dashboard view (#8398) 2025-03-27 09:52:51 +01:00
Mathieu
60b0b35eaa feat: technical release (#8458) 2025-03-26 15:50:59 +01:00
Joris K
6f578c0302 feat(xo-6/vm): add VIFs information in side panel (#8443) 2025-03-25 16:53:55 +01:00
Florent BEAUCHAMP
a6265fba0f fix(xo-web): remove spec message (#8452)
introduced by dca3f39
2025-03-25 16:50:32 +01:00
Mathieu
85fbdb1cd5 fix(@xen-orchestra/rest-api): remove unused return type (#8449) 2025-03-25 14:12:41 +01:00
Mathieu
d3c655bd49 feat(@xen-orchestra/rest-api): expose get servers and get server (#8385)
Implement the mecanism to expose non XAPI object endpoints:

    Added a new type, NonXapiXoRecord, which represents all XO objects that are not XAPI objects (e.g., users, servers, groups, etc.).
    Split XapiXoController to create BaseController, allowing code reuse between XapiXoController and the new XoController.
    BaseController exposes sendObjects and createAction (unchanged) and enforces subclasses to define the getObject and getObjects methods.
    XoController requires subclasses to implement getAllCollectionObjects and getCollectionObject, as these are used in its getObjects and getObject methods.
    filter and limit are handled by xo-server for XAPI objects. XoController implements its own filter and limit mechanisms for all non XAPI object in getObjects

And finally expose /rest/v0/servers and /rest/v0/servers/<server-id>🥳
2025-03-25 09:38:28 +01:00
Thierry Goettelmann
05d1552c7f feat(web-core): create usePagination composable (#8267) 2025-03-24 17:58:21 +01:00
Thierry Goettelmann
3a80bdfb36 feat(web-core): update VtsLoadingHero logic (#8437) 2025-03-24 17:35:48 +01:00
mathieuRA
39f4ad494d feat(@xen-orchestra/rest-api): expose get vdi-snapshots and get vdi-snapshot 2025-03-24 16:37:17 +01:00
mathieuRA
3aeab1585b feat(@xen-orchestra/rest-api): expose get vdis and get vdi 2025-03-24 16:37:17 +01:00
mathieuRA
2851bcbc5c feat(@vates/types): add XoVdi(-snapshot|unmanaged) types 2025-03-24 16:37:17 +01:00
Florent BEAUCHAMP
bb554a0ddd fix(@xen-orchestra/xapi): remove automatic disabling of cbt chain on export failure (#8446)
introduced by 2a2c966
zammad#35683
2025-03-24 14:34:05 +01:00
Julien Fontanet
f9de5b7e3a feat(README): add translation status and link 2025-03-24 11:59:48 +01:00
Florent BEAUCHAMP
86961aa782 fix(fs): improve compatibility with backblaze (#8393)
Fix `Unsupported header 'x-amz-checksum-mode' received for this API call.`
on backblaze/cloudlfare object storage
from version 3.729, aws sdk send headers that aren't supported yet by backblaze
2025-03-24 11:06:45 +01:00
Joris K
3aa36f907c feat(xo-6/vm): display VIFs in VM network tab (#8442) 2025-03-21 17:43:28 +01:00
Joris K
be44d75f43 feat(xo-lite/vm): display VIFs in VM network tab (#8441) 2025-03-21 16:00:41 +01:00
Sebastian CZECH
a04e58d0a5 feat(xo-6): add sidebar to host networks view (#8287) 2025-03-20 15:48:44 +01:00
OlivierFL
54e00924ed feat(xo-core): add UiProgressBar component (#8410) 2025-03-20 11:05:18 +01:00
Mathieu
f830315a3e fix(@xen-orchestra/rest-api): remove mutualization of query params (#8424)
Mutualiztion of query params require to also mutualize examples.
Introduced by 0951d56
2025-03-19 09:15:18 +01:00
Mathieu
8cc6b33ca1 fix(@vates/types): enhance xen-api and xo types (#8434) 2025-03-19 09:05:50 +01:00
Bastien Nollet
4f969adbe8 feat(xo-server-audit): log warning when audit log chain is broken (#8439) 2025-03-19 09:04:03 +01:00
Thierry Goettelmann
4f46c68aaa feat(web-core): create VtsInputWrapper component (#8435) 2025-03-17 12:03:32 +01:00
Thierry Goettelmann
9b56d93073 feat(web-core): create useRanked composable (#8431) 2025-03-14 17:23:45 +01:00
Thierry Goettelmann
9b93a7d9b3 feat(web-core): create useMapper composable (#8430) 2025-03-14 17:11:45 +01:00
Mathieu
2d062a301e fix(@xen-orchestra/lite): fix JSONRPC request type (#8421) 2025-03-14 15:23:44 +01:00
Thierry Goettelmann
7fd4528eae feat(web-core): recreate UiDropdown component from DS (#8418) 2025-03-13 12:09:39 +01:00
Thierry Goettelmann
ac2f4e9f32 chore(web-stack): update deps (#8428) 2025-03-13 11:54:36 +01:00
Mathieu
1d4b04c777 feat(@xen-orchestra/rest-api): expose get vbd and get vbds (#8404) 2025-03-13 09:41:52 +01:00
Florent BEAUCHAMP
e16f9bfa91 fix(v2v): assert error on import delta from esxi < 7.5 (#8422)
it happens when the source disk is not aligned with the vhd block size ( 2MB)
this PR will read more data into the grain directory / grain tables, but
this data won't be used since we use the virtual size to compute which
grain to read

from ticket 33018
2025-03-12 17:47:11 +01:00
Pierre Donias
9c27b53dfd fix(netbox/name-dedup): perform a case-insensitive name comparison (#8413)
Netbox doesn't allow 2 VM names to be equal within the same cluster even if they
don't have the same case.
2025-03-11 17:03:20 +01:00
Thomas Moraine
763e5f082d docs(backups): Microsoft ReFS is unsupported (#8423)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-03-11 16:16:09 +01:00
Pierre Donias
8a0604c274 feat(netbox): support Netbox v4.2 (#8417)
Fixes #8280
Fixes #7645
See Zammad#34699
See https://xcp-ng.org/forum/topic/10236/netbox-version-4-2-1-not-supported
See https://github.com/netbox-community/netbox/releases/tag/v4.2.0
2025-03-11 15:35:53 +01:00
Mathieu
ca84af4eda feat(@xen-orchestra/rest-api): migrate vms/:id/actions/start (#8379) 2025-03-11 12:50:42 +01:00
Mathieu
57056b2298 Add XoSr type + expose /rest/v0/srs and /rest/v0/srs/:id (#8419)
* feat(@vates/types): add XoSr type

* feat(@xen-orchestra/rest-api): expose get srs and get sr
2025-03-11 11:18:38 +01:00
Florent BEAUCHAMP
517a0c7b6b fix(backups): handle case when a new disk is added to a replicated VM (#8400)
* fix(backups): handle case when a new disk is added to a replicated VM

* changelog

* changelog
2025-03-11 10:31:56 +01:00
Mathieu
0951d5606d feat(@xen-orchestra/rest-api): mutualize code for better qol (#8401)
* feat(@xen-orchestra/rest-api): mutualize code for better qol

* fix after rebase

* use queries instead of query(s)
2025-03-11 09:16:37 +01:00
Thomas Moraine
d74828017a doc(XO): Add Amazon S3 to the list of supported remotes (#8407)
doc(XO): Add Amazon S3 to list of supported remotes

Amazon S3 remotes have been supported for a while,
but there was no section mentioning it in the Backups → Remotes doc.
This is now fixed

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-03-11 09:00:31 +01:00
Pierre Donias
1bd7bd6661 feat(xo-web,xo-server/createVm): ability to assign ACLs to VM during creation (#8412)
Fixes #6996
2025-03-10 17:10:46 +01:00
Mathieu
6816d6e759 fix(CHANGELOG.unreleased.md): fix extra space (#8420) 2025-03-10 11:29:34 +01:00
Pierre Donias
8fd8e3dff5 fix(netbox): fetch Netbox version even if version check is disabled (#8416)
See Zammad#34699
2025-03-10 09:52:59 +01:00
Bastien Nollet
37fbb7edb8 docs(perf-alert): functional description (#8414) 2025-03-07 16:04:53 +01:00
Bastien Nollet
9e7e4298ab fix(perf-alert): preventing alerts sent endlessly every minute (#8408)
Introduced by b1ce62f
2025-03-07 15:38:58 +01:00
Mathieu
f310575d0c fix(xo-server/createVm): fix OTHER_OPERATION_IN_PROGRESS (#8399)
Introduced by 04dd9e9
2025-03-07 15:27:57 +01:00
Julien Fontanet
5a501d9ee2 fix(xo-server): clarify session duration validity (#8411)
Related to zammad#35588
2025-03-07 14:04:15 +01:00
mathieuRA
37444afa12 fix(xo-server/rest-api): on VM import SR ID is no longer ignored 2025-03-07 12:10:30 +01:00
mathieuRA
31b049963f fix(@xen-orchestra/xapi/VM): throws a nice error when migrating VM without SR or default SR 2025-03-07 12:10:30 +01:00
mathieuRA
76e23ecdcc feat(@xen-orchestra/rest-api): expose hosts/:id/stats 2025-03-06 16:56:38 +01:00
mathieuRA
93706d70c9 feat(@xen-orchestra/rest-api): expose get hosts and get host 2025-03-06 16:56:38 +01:00
mathieuRA
a5866bbb6a feat(@vates/types): add XoHost type 2025-03-06 16:56:38 +01:00
Mathieu
034d9b5eca feat(@xen-orchestra/rest-api): expose VM stats (#8359) 2025-03-06 15:06:28 +01:00
Mathieu
a415c452ef fix(@xen-orchestra/rest-api): fix null values not displayed as nullable (#8406) 2025-03-06 09:23:51 +01:00
OlivierFL
adc5bea153 feat: release 5.104.1 (#8405) 2025-03-04 16:49:47 +01:00
OlivierFL
600d8d9e85 feat: technical release (#8403) 2025-03-04 15:37:15 +01:00
Florent BEAUCHAMP
82f0894fec fix(xapi): add missing changelog entry (#8397) 2025-03-04 13:19:52 +01:00
Florent BEAUCHAMP
90f8f9cff4 feat(vhd-lib): handle broken vhd directory named as aliases (#8292) 2025-03-04 09:55:04 +01:00
Florent BEAUCHAMP
cf0331391b fix(backups): handle undefined remote name in restore description (#8367) 2025-03-04 08:39:11 +01:00
Florent BEAUCHAMP
2a2c966126 fix(backups): disable CBT when CBT is unusable (#8313) 2025-03-03 11:41:39 +01:00
Julien Fontanet
39613ff2fa feat(xo-server/vdi.migrate): returns the new UUID
See https://team.vates.fr/vates/pl/169jwdqkeiys8boftay745iony
2025-02-28 11:18:39 +01:00
Sebastian CZECH
9033577406 feat(xo-6): add sidebar to pool networks view (#8286) 2025-02-28 10:18:46 +01:00
OlivierFL
6125348529 feat(lite): 0.8.0 (#8392) 2025-02-27 14:51:44 +01:00
OlivierFL
b59125cf5a feat: release 5.104.0 (#8391) 2025-02-27 14:26:02 +01:00
OlivierFL
73c9f74a45 feat: technical release (#8389) 2025-02-27 11:48:59 +01:00
OlivierFL
6a21e5525a feat(xo-core): update UiInput and UiTextArea components (#8349) 2025-02-27 11:03:55 +01:00
Sebastian CZECH
e0338c33d7 fix(xo-server): add pifs bond master of (#8368) 2025-02-27 10:49:59 +01:00
Joris K
e905817ea5 fix(xo-lite): add changelog (#8386) 2025-02-27 10:49:13 +01:00
Thomas Moraine
b0ab26b77e docs(backups): Microsoft Data Deduplication and Logical Disk Manager are unsupported (#8382)
Also, replace the screenshot of the file restore feature with an example that uses Linux instead of a Microsoft/NTFS resource

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-02-27 10:32:38 +01:00
Pierre Donias
82daa3550f fix(xo-web/tab-disks): wrong PropTypes on AttachDisk's vbds (#8387) 2025-02-27 10:27:18 +01:00
Pierre Donias
db4d394449 feat(xo-web/vm/disks): allow Self Service users to attach disks to their VMs (#8384)
See Zammad#30630
2025-02-27 10:19:51 +01:00
Joris K
8063f438d9 feat(xo-lite/host): display pif information in side panel / add pif metrics store (#8186) 2025-02-27 09:33:05 +01:00
OlivierFL
b3d66497b9 feat: technical release (#8383) 2025-02-26 16:34:07 +01:00
Mathieu
e567a3b358 feat(xo-server/rest-api): expose vms/hosts stats (#8378)
`GET /rest/v0/vms/f26eb0a5-1d91-4682-ae58-96df405a3af6/stats`
`GET /rest/v0/hosts/f26eb0a5-1d91-4682-ae58-96df405a3af6/stats`
2025-02-26 12:01:03 +01:00
Mathieu
468732cdba fix(xo-server/rest-api): do not show route twice (#8377) 2025-02-26 11:55:55 +01:00
MlssFrncJrg
13bda9812e feat(xo-server/rest-api): ability to update a user (#8343) 2025-02-26 10:03:29 +01:00
OlivierFL
ff8a020fa2 feat(web-stack): update typography (#8320) 2025-02-26 09:30:44 +01:00
OlivierFL
d1c65756be feat(web-stack/i18n): merge translation files into single file (#8380) 2025-02-26 09:00:18 +01:00
Nathanaël
905e3cc943 feat(web-stack/i18n): update translations (#8294) 2025-02-25 17:57:35 +01:00
Joris K
5a21bdfe10 feat(xo-lite/network): add side panel informations and some trad (#8150) 2025-02-25 16:16:30 +01:00
Dan Pollak
a7446ae4af fix(xo-server-audit): ignore additional API calls (#8353) 2025-02-25 15:58:46 +01:00
Julien Fontanet
d46c871b06 fix(xo-server/joinPool): remove useless and bogus obfuscation
Username was obfuscated instead of password.

Obfuscation is now properly done in `xen-api`.
2025-02-25 13:44:14 +01:00
Julien Fontanet
7cc89012d7 fix(xen-api): obfuscate password for pool.join{,_force}
Fixes zammad#35148
2025-02-25 13:44:14 +01:00
Julien Fontanet
bd8a1b25ed fix(xo-cli): timeouts with legacy JSON-RPC API
Fixes zammad#34473
2025-02-25 10:30:01 +01:00
OlivierFL
f18b010588 feat(web-stack): update "info" and "brand" colors usages (#8345) 2025-02-24 16:30:18 +01:00
Mathieu
ac2ff9b38d fix(@vates/types): add missing VM-template in XapiXoRecord (#8376)
Introduced by 0ef95d9
2025-02-24 15:54:19 +01:00
MlssFrncJrg
1a3cd3e2b9 feat(xo-server/rest-api): ability to delete user by its ID (#8283) 2025-02-24 14:46:26 +01:00
OlivierFL
f25c67d5a8 feat: technical release (#8375) 2025-02-24 10:48:54 +01:00
Pierre Donias
821c25f864 fix(generator-toolbox): normalize (#8374) 2025-02-24 10:12:19 +01:00
Mathieu
5910a47780 fix(@xen-orchestra/rest-api): rename example files to not be ignored by npm (#8373)
Introduced by 780e0bb

`.npmignore` ignores all `examples/` folders and all `*.example.*` files
Rename Open API examples as `*.oa-example.mts`
2025-02-24 09:51:05 +01:00
OlivierFL
749f063dc6 fix: bump versions of packages with wrong dependencies (#8371)
Introduced by 4eed730a09

Due to an issue with bump-pkg script, some packages were previously published on
NPM before their dependencies' versions were updated. This commit simply bumps
the versions of those packages to publish the correct list of dependencies.
2025-02-21 17:04:25 +01:00
OlivierFL
4eed730a09 feat: technical release (#8370) 2025-02-21 15:29:00 +01:00
Stephane
42ca53f80c feat(@xen-orchestra/xapi): smart reboot improvements (#8333)
feat(xapi): smart reboot improvements
2025-02-21 11:21:41 +01:00
Julien Fontanet
6b8167a2fc docs(installation): add missing openssl dependency 2025-02-21 10:50:08 +01:00
Mathieu
780e0bbefa feat(@xen-orchestra/rest-api): expose get vms and get vm (#8356)
@vates/types Added an export to the root of the lib because TSOA requires importing the type from the root library to generate the OpenAPI specification
    @vates/types Tuples ([number, number]) throw errors when generating the OpenAPI specification. They have been updated to number[]
    @vates/types Created a XapiXoRecord to be able to differentiate between XO types that come from xapi-object-to-xo and XO types that come from XO collections
    xo-server Added getObjectsByType to avoid iterating over all XAPI objects when we know what type of object we want
    Branded is not a valid type for the OpenAPI spec. I created a Unbrand type, that convert all Branded to string . (Use Unbrand only for OpenAPI specification definition to maintain Branded type safety)
    Added another error middleware to catch TSOA errors and throw XO errors
    Added a README.md to have consistency of order in the use of decorators
2025-02-21 10:31:57 +01:00
Bastien Nollet
b2ba5abacf docs(fuse-vhd): document cli file restoration (#8355)
Document how to restore a file from a VHD with fuse-vhd CLI.
This will allow users to restore by themselves large files that make the restore fail when done from the UI.
2025-02-21 10:26:12 +01:00
Pierre Donias
695b3d76e8 fix(xo-web): empty list of options in selects (#8363)
Introduced by a386680d90
Fixes #8361
See https://github.com/bvaughn/react-virtualized/issues/1871

react-virtualized@9.22.6 seems to be breaking old versions of React
Error in browser console: `TypeError: p.createRef is not a function`
2025-02-20 17:08:52 +01:00
Mathieu
6f5b97f7f3 feat(@xen-orchestra/rest-api): setup simple auth middleware (#8327)
Configure dependency injection + configure authentication middleware for openapi (copy of what actually exists in the current REST API. Will be improved later when implementing ACL/resource set)
2025-02-20 16:07:09 +01:00
OlivierFL
db3f702235 fix(web-stack): rollback vue-tsc version (#8362)
Rollback `vue-tsc` version to `2.1.10`, to fix broken `yarn type-check` and CI.
2025-02-20 13:04:43 +01:00
Bastien Nollet
fb02bf07f6 fix(@vates/task): ensure compatibility between library versions (#8347) 2025-02-19 17:44:34 +01:00
Florent BEAUCHAMP
9723075253 feat(generator): create a toolbox (#8295) 2025-02-18 17:23:51 +01:00
MlssFrncJrg
4b8cdf8043 feat(xo-server/rest-api): ability to create user (#8282) 2025-02-18 16:54:02 +01:00
Florent BEAUCHAMP
397e8b6ed7 fix(xo-server-test): normalize package 2025-02-18 16:45:23 +01:00
Florent BEAUCHAMP
da332715f6 doc(sdn-controller): update readme 2025-02-18 16:45:23 +01:00
Florent BEAUCHAMP
08c47da2b6 fix(rest-api): normalize package 2025-02-18 16:45:23 +01:00
Florent BEAUCHAMP
aa27e3ba46 fix(fatfs): normalize package 2025-02-18 16:45:23 +01:00
Julien Fontanet
a386680d90 chore: update dev deps 2025-02-18 11:05:22 +01:00
Julien Fontanet
6e508b03d8 fix(xo-server-audit): ignore host.getBiosInfo
Introduced by d5217f92f

Related to zammad#34890
2025-02-18 09:19:32 +01:00
Julien Fontanet
2aa7c012f1 fix(xo-server-audit): ignore host.getMdadmHealth
Introduced by c41ae0527

Related to zammad#34890
2025-02-18 09:13:47 +01:00
Julien Fontanet
18fec2a0af fix(CHANGELOG.unreleased): fix Markdown
Introduced by 137837cda
2025-02-18 09:10:56 +01:00
David Johnston
be6b73dcb5 docs: fix links to cloud-init (#8354)
Introduced by a89c31c75

Co-authored-by: David Johnston <david@johnstons.net>
2025-02-18 08:58:37 +01:00
Thomas Moraine
a89c31c75b docs: add page to explain VM templates (#8340)
A forum user suggested changes for better understanding of VM templates.
A new page has been created just for templates,
with Create, Read, Update, Delete (CRUD) sections.

Also, the Cloud-init/Cloudbase-init section of the Advanced page has been moved
to this new page.

This should make it easier for users to get all useful information on templates
in a single document.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-02-17 10:06:30 +01:00
Julien Fontanet
51b06b1177 docs(xoa): always use HTTPS and wget --no-verbose
`--no-verbose-` is better than `--quite` because it does not hide errors.
2025-02-17 09:36:04 +01:00
Florent BEAUCHAMP
c0d434b612 fix(v2v): Cannot read properties of undefined (reading 'map') with empty datastore (#8311) 2025-02-17 09:35:42 +01:00
Thomas Moraine
b390f36deb doc(XO): Update encryption algorithm transition guidance (#8350)
Update the Xen Orchestra documentation to guide users
on transitioning from AES-256-GCM to ChaCha20-Poly1305 encryption,
solving an issue where users could encounter warnings due to mixed
encryption algorithms in remote storage.
Fix [this]((https://xcp-ng.org/forum/topic/10453/remote-encryption-algorithm)
2025-02-17 09:32:10 +01:00
Mathieu
1983025403 fix(@vates/types): normalize package (#8332) 2025-02-17 09:22:07 +01:00
OlivierFL
9e29c98735 feat(xo-core): update treeview components colors (#8326) 2025-02-17 09:18:00 +01:00
Florent BEAUCHAMP
66e677d7cb feat(V2V/powerOff): handle queued state when stopping the VM (#8328)
zammad#34451
2025-02-14 17:16:50 +01:00
OlivierFL
ecd7d624a0 feat(xo-core): update UiTablePagination component (#8344) 2025-02-14 16:20:24 +01:00
Florent BEAUCHAMP
5219d47fd0 test(vhd-lib): improve ci (#8335) 2025-02-14 15:05:34 +01:00
Mathieu
b7a056dfaf feat(@xen-orchestra/rest-api): add error middlware (#8323) 2025-02-14 14:54:44 +01:00
Mathieu
a5831f8a58 fix(xo-server/rest-api): restore legacy rest-api doc (#8346) 2025-02-14 11:43:41 +01:00
Thomas Moraine
ef636a9821 docs(users): add troubleshooting steps for LDAP group sync issues (#8312)
Some users weren't able to sync all LDAP groups with XO.
Adding what to check to troubleshoot the issue.
Also, refreshing the style and presentation of the LDAP section in the Users page
2025-02-14 09:20:35 +01:00
Nathanaël
987e969103 docs(airgap): replace curl by wget to avoid download errors (#8227)
cURL configuration in old XCP-ng/XenServer hosts is not compatible with https://xoa.io, use wget instead.
2025-02-13 14:40:39 +01:00
MlssFrncJrg
7615a6c5f8 feat(xo-server/rest-api): ability to remove user from a group (#8336) 2025-02-13 12:51:29 +01:00
MlssFrncJrg
a0b1ac9388 feat(xo-server/rest-api): ability to add user in a group (#8334) 2025-02-13 12:36:46 +01:00
MlssFrncJrg
4c6797d278 feat(xo-server/rest-api): ability to update group's name (#8278) 2025-02-13 12:25:02 +01:00
MlssFrncJrg
4b244daebd feat(xo-server/rest-api): ability to delete group (#8277) 2025-02-13 11:45:21 +01:00
MlssFrncJrg
2994b9a327 feat(xo-server/rest-api): ability to create group (#8276) 2025-02-13 11:08:10 +01:00
Mathieu
137837cdab fix(sdn-controller): fix no PIF found when creating private network (#8319)
Fix #8027 zammad#34140
2025-02-12 17:07:40 +01:00
OlivierFL
1fd74a29b9 feat(xo-core): update UiCheckbox and UiRadioButton components (#8342) 2025-02-12 15:26:51 +01:00
Mathieu
877ca82600 feat(@xen-orchestra/rest-api): initial setup for swagger (#8316) 2025-02-12 14:09:22 +01:00
OlivierFL
5dbb529126 feat(xo-core): update UiCounter component (#8337) 2025-02-12 11:55:18 +01:00
OlivierFL
78c3b40762 feat(xo-core): update Button components (#8329) 2025-02-12 11:25:07 +01:00
OlivierFL
47ee8799f3 feat(xo-core): update UiCardTitle and UiCardSubtitle components (#8338) 2025-02-12 11:07:00 +01:00
OlivierFL
8f877962f3 feat(xo-core): update VtsIcon component brand color (#8325) 2025-02-11 17:06:55 +01:00
b-Nollet
832634f284 chore(xo-server): upgrade hashy version (#8304) 2025-02-11 15:50:07 +01:00
Sebastian CZECH
6b6a9a4942 feat(xo-6): dashboard mobile layout (#8268) 2025-02-11 15:11:58 +01:00
OlivierFL
87551ca7b8 feat(xo-core): update UiLink component (#8331) 2025-02-11 13:57:10 +01:00
Julien Fontanet
decf1ebf3e feat(normalize-packages): Node defaults to >=18
See https://github.com/vatesfr/xen-orchestra/pull/8332/files#r1950603611
2025-02-11 11:37:27 +01:00
OlivierFL
aeb22636c7 feat(xo-core): update scrollbars color (#8330) 2025-02-11 09:39:31 +01:00
Thomas Moraine
82473fdf37 docs(sdn_controller): remove XCP-ng 8.0 and prior (obsolete) (#8322)
XCP-ng 8.0 and 7.6 are references in multiple sections.

These versions are obsolete, nobody should be using SDN Controller on anything older than XCP-ng 8.2.

As a result, references to XCP-ng 8.0 and older can be removed safely.

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-02-10 17:19:25 +01:00
Truong
f692c25638 VM Description in backup report (#8253)
Sometime, the name does not provide enough information about the VM, adding more with Description, we will know more which VM has issue with backup.

Co-authored-by: b-Nollet <150058367+b-Nollet@users.noreply.github.com>
2025-02-10 17:05:06 +01:00
OlivierFL
6b30fb50c4 feat(xo-core): update color "info" values (#8314) 2025-02-10 15:10:38 +01:00
Mathieu
0ef95d9911 feat(@vates/types): create @vates/types lib (#8308) 2025-02-10 10:16:39 +01:00
Thomas Moraine
37aa941796 docs(sdn-controller): various improvements (#8318) 2025-02-09 00:33:40 +01:00
Jonas
d907129e82 docs(users): using Google for SAML auth (#8296) 2025-02-07 12:46:57 +01:00
Thomas Moraine
57fe8aec51 docs(users): authentication with auth-oidc plugin (#8230)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-02-07 12:44:24 +01:00
Sebastian CZECH
90188726e3 feat(lite/release): add changelog to GitHub release description (#8265) 2025-02-07 11:18:09 +01:00
Sebastian CZECH
564a2af879 feat(web-core): migrate UiResource(s) to VtsResource(s) (#8315) 2025-02-06 11:08:37 +01:00
b-Nollet
13488b41b1 feat(lite): 0.7.1 (#8310) 2025-02-04 16:37:53 +01:00
b-Nollet
3e335a3741 feat: release 5.103.1 (#8309) 2025-02-04 16:09:19 +01:00
b-Nollet
ac015305d7 feat: technical release (#8307)
* feat(@xen-orchestra/web-core): 0.13.0

* feat(@xen-orchestra/web): 0.9.0

* feat(xo-server): 5.170.0

* chore(CHANGELOG): update next
2025-02-04 14:48:46 +01:00
Mathieu
936bdaac45 fix(web-core): fix UiStackedBar percent calculation (#8306)
Introduced by 14da422
2025-02-04 13:30:46 +01:00
OlivierFL
0960f8d8d3 fix(lite/host): improve console retrieval (#8305) 2025-02-04 10:17:18 +01:00
Mathieu
6ae05398d7 feat(XO6/dashboard): display size used by replications (#8300) 2025-02-04 10:15:11 +01:00
Stephane
e1b1fcd948 fix(xo-server): fix calculate size replication in sr (#8302)
Introduced by 90a33ea
2025-02-03 17:35:57 +01:00
Florent BEAUCHAMP
7579b3359c docs(async-each): improve the js doc (#8293) 2025-02-03 13:00:25 +01:00
Thomas Moraine
dfbdcd23f2 docs: update XO logo & require Debian 12 (#8263)
Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-02-03 12:48:49 +01:00
Thomas Moraine
683f5f61d3 docs: remove references to XOSAN (legacy) (#8299)
Since XOSAN is now legacy and XOSTOR has taken its place, we are removing XOSAN from the Xen Orchestra doc.

Links to XOSAN docs are replaced with links to XOSTOR (from the XCP-ng doc).

Signed-off-by: Thomas Moraine <thomas.moraine@vates.tech>
2025-02-03 09:28:53 +01:00
b-Nollet
c8c9f77d45 feat(xo-server): remember server's pool name and description (#8206)
Remember server's pool name and description, and display the pool name as server default label. The server label can be deleted (since 81e7e07) to get back to the default pool name value.

We did multiple commits to keep the original changes around, but I would advise not to review by commit.

XO-437
2025-02-03 08:41:38 +01:00
Mathieu
7aa51f20c9 fix(xo-server/VM): do not try to resize vdi if vdi.size is undefined (#8291) 2025-02-03 08:35:13 +01:00
b-Nollet
494ea4509f feat(lite): 0.7.0 (#8290) 2025-01-30 16:39:46 +01:00
b-Nollet
4296ca7e9b feat: release 5.103.0 (#8289) 2025-01-30 13:58:52 +01:00
b-Nollet
437e438672 feat: technical release (#8288) 2025-01-30 11:54:42 +01:00
Julien Fontanet
81e7e07312 fix(xo-server,xo-web): allow deleting server's label 2025-01-30 10:27:37 +01:00
Mathieu
05dd9238b8 fix(xo-server/test): use mock.timers for getFromAsyncCache test (#8279)
introduced by 1eeff13

use mock.timers to avoid false negative.
https://nodejs.org/dist/v23.6.1/docs/api/test.html#timers
2025-01-30 08:21:56 +01:00
b-Nollet
aae8b6b1d8 fix(@xen-orchestra/backups): avoid undefined target (#8275) 2025-01-29 17:43:26 +01:00
Sebastian CZECH
097aa5a584 feat(xo-6): add host network view (#8198) 2025-01-29 16:29:41 +01:00
Nathanaël
062dd7561f feat(web-stack/i18n): translations update from Weblate (#8178) 2025-01-29 14:41:03 +01:00
Joris K
2fe2ef49db fix(xo-lite,xo-6): issue with status in pool network table (#8284)
Fix issue with how status is calculated in pool table
2025-01-29 12:23:35 +01:00
Joris K
7862952cf6 fix(xo-lite): issue with wording in host pif table (#8285) 2025-01-29 12:18:02 +01:00
Sebastian CZECH
76c3f7472f feat(xo-6): add pool network view (#8182) 2025-01-29 09:54:06 +01:00
Thomas Moraine
35e8af6313 docs(advanced): disk health monitoring (#8264)
Disk health monitoring from XO was available since XO v5.87.
It's now documented as part of the Management -> Advanced features section.
2025-01-29 09:53:01 +01:00
Joris K
3e69d4c84b feat(xo-lite/host): add host network tab and pif table / status component … (#8180) 2025-01-28 16:22:58 +01:00
Stephane
7e3b7367f1 fix(backups): backup worker inspect failed: address already in use (#8197) 2025-01-28 15:50:45 +01:00
Pierre Donias
42b32eb079 feat: technical release (#8274) 2025-01-28 11:43:52 +01:00
Florent BEAUCHAMP
bf874bce7c fix(xo-server/getAllUnhealthyVdiChainsLength): better handling of vdi not in cache (#8273) 2025-01-28 10:32:22 +01:00
Florent BEAUCHAMP
989b3888ee feat(backups): don't use checksum if not needed (#8270)
* feat(backups): don't use checksum if not needed

encrypted backups are already authenticated, this guarantee that
a readble file has not been modified
thus, no need to compute a relatively slow hash is encryption is already done
2025-01-28 10:30:15 +01:00
MlssFrncJrg
b519e25601 fix(xo-web): in storage creation, display error when selecting SR type (#8250) 2025-01-28 10:02:03 +01:00
Florent BEAUCHAMP
2677b8ca38 fix(backups): weekly ltr retention last week of year (#8269)
the year computation use the locale year computation, whereas the week 
was using the iso week computation
2025-01-28 08:19:16 +01:00
Florent BEAUCHAMP
5024bd765b test: fix ci (#8271)
* test(xo-server/asynccache): more time to let the test run
* test(vhd-lib/openvhd): concurrency on openvhd tests
2025-01-27 16:27:52 +01:00
Joris K
6761274a16 feat(xo-lite/network): implementation of network tab and add network/pif store (#8147) 2025-01-27 16:21:46 +01:00
Thomas Moraine
512af62f7f docs(backups): long term retention (GFS) (#8223) 2025-01-27 15:38:05 +01:00
Thomas Moraine
4123ae731f docs(backups): encryption algorithms (#8266)
Explain how backups are encrypted by Xen Orchestra,
what each encryption algorithm does,
and how it works with Amazon S3
2025-01-27 11:52:39 +01:00
Stephane
90a33ead6d feat(xo-server): calculate size replication in sr (#8262) 2025-01-27 11:49:37 +01:00
Florent BEAUCHAMP
a49864abfb fix(V2V/Vsan): better handling of multiple VSAN (#8243) 2025-01-24 11:34:50 +01:00
Sebastian CZECH
1f4ec8d0e1 feat(xo-6): add console fullscreen action (#8238) 2025-01-23 15:00:22 +01:00
Mathieu
3e615f725b fix(xapi): VDI_destroyCloudInitConfig wait 5 minutes before removing the VDI (#8247) 2025-01-23 13:09:43 +01:00
Mathieu
9af58185cf fix(xo-server, xo-web): fix install patches and RPU on XS8 (#8241) 2025-01-22 15:58:18 +01:00
Sebastian CZECH
2b63829e91 feat(web-core): inverse the logic of border props in MenuList.vue (#8246) 2025-01-22 15:34:56 +01:00
Sebastian CZECH
300bb18a64 feat(web-core): focus on console (#8235) 2025-01-22 15:14:09 +01:00
Sebastian CZECH
42f205e473 feat(xo-6): switch to language based on xo5 cookie (#8242) 2025-01-22 14:55:01 +01:00
Thierry Goettelmann
fe5276217f fix(web-core): useRouteQuery composable type issue (#8261) 2025-01-22 09:04:59 +01:00
Julien Fontanet
1765600437 fix(xo-server-audit): ignore host.getIpmiSensors
Introduced by e30f28907
2025-01-21 09:07:09 +01:00
Stephane
f0680df1e1 feat(backups): add encryption chacha20-poly1305, allow file larger than 64GB on encrypted remote (#8237)
This will also incite users to create new remote with the chacha20-poly1305 instead of aes-256-gcm that will continue to work on exusting remote
2025-01-20 20:10:34 +01:00
Sebastian CZECH
6d34cf67fb feat(web-core): move chart lib from xo-lite to web-core (#8248) 2025-01-20 15:15:46 +01:00
Sebastian CZECH
9c97ac903f feat(xo-6): add Ctrl+Alt+Del (#8239)
functionality to console
2025-01-20 14:56:46 +01:00
OlivierFL
a96d5e64de docs(xo-core): update guidelines (#8194) 2025-01-20 11:44:49 +01:00
b-Nollet
4744071098 fix(usage-report): avoid report failure when previous stats are invalid (#8240) 2025-01-20 11:43:02 +01:00
b-Nollet
dc9dbd9018 fix(xo-web): display mirror backup transfer size (#8224) 2025-01-20 11:40:31 +01:00
b-Nollet
6405eeb1b5 fix(xo-server): throw when remote uses encryption without data blocks (#8244) 2025-01-20 11:38:42 +01:00
Stephane
7c666d1156 fix(backups): fix metadata.isVhdDifferencing key computation (#8216)
This PR fix metadata.isVhdDifferencing where an object was used instead of a string to set the filename.
2025-01-20 10:55:56 +01:00
Sebastian CZECH
7ca6829c27 feat(web-core): standardize console component between xo-lite and xo-6 (#8245) 2025-01-20 10:25:30 +01:00
Florent BEAUCHAMP
97cd50af44 test(backups): fix parallel test (#8257) 2025-01-20 10:16:43 +01:00
David Johnston
5bfd462616 feat(web-stack): add Spanish translation (#8220) 2025-01-20 09:03:41 +01:00
Florent BEAUCHAMP
2b964576f2 test(vhd-lib): fix ci (#8255)
Assertion messages can now contain extra info since Node 20.18.1
2025-01-17 11:50:59 +01:00
MlssFrncJrg
d044dda59a fix(xo-web/SelectTag): list SR tags (#8251)
See https://xcp-ng.org/forum/topic/9953
2025-01-16 15:22:42 +01:00
Julien Fontanet
11a4ceddce chore: update dev deps 2025-01-15 14:46:20 +01:00
Thierry Goettelmann
b97268727c feat(web-core,lite,xo6): add useDisabled composable and replace DisabledContext usage (#8133) 2025-01-13 16:30:24 +01:00
Sebastian CZECH
3a21290fde feat(web-core): add loading state on console (#8226) 2025-01-09 14:43:09 +01:00
Julien Fontanet
299a109eb6 fix(CHANGELOG): fix date
Introduced by 4235e9816
2025-01-09 14:28:28 +01:00
Julien Fontanet
4235e98166 fix(CHANGELOG): add missing date
Introduced by 281ccbb8b
2025-01-09 12:03:04 +01:00
Julien Fontanet
281ccbb8ba feat: release 5.102.1 2025-01-09 11:42:32 +01:00
Julien Fontanet
7053fc4a08 feat(xo-server-backup-reports): 1.4.4 2025-01-09 10:31:12 +01:00
b-Nollet
cd2f74cd63 fix(xo-server-backup-reports): fix undefined function in partial (#8229)
In some failure cases, backup reports were not sent because of an error during handlebars compilation.
The `formatDate` function was incorrectly passed from partial to partial causing the `executeFunction` helper to execute `undefined` as a function (the `vmFailure` helper used default `formatDate=./formatDate` instead of `formatDate=../formatDate`, the `..` being necessary because of the `#each` loop)


Introduced by aa9c49ce6a
2025-01-08 17:25:01 +01:00
Thomas Moraine
6d836df6bf docs(xoa): NTP synchronization with systemd-timesyncd (#8217)
On recent versions of Xen Orchestra, we switched to systemd-timesyncd for NTP management.
XOA documentation is updated to reflect this change.
2025-01-08 09:07:50 +01:00
Joris K
93a11cfb28 fix(lite): fix issue due to update dev deps (#8218) 2025-01-06 11:31:57 +01:00
Julien Fontanet
fd9c9b214a chore: update dev deps 2024-12-31 12:17:18 +01:00
Julien Fontanet
34c1cce029 fix(CHANGELOG): add 5.102.0 Highlights
Introduced by 320a61323
2024-12-30 13:56:14 +01:00
Julien Fontanet
320a61323c feat: release 5.102.0 2024-12-30 13:38:05 +01:00
Mathieu
db9c85df7a feat: technical release (#8214) 2024-12-20 17:34:32 +01:00
Mathieu
c4104b2d58 chore(CHANGELOG.unreleased.md): add missing @xen-orchestra/xapi entry (#8213) 2024-12-20 17:24:11 +01:00
Mathieu
79847a9129 feat: technical release (#8212) 2024-12-20 16:18:43 +01:00
Pierre Donias
0ec86e409c chore(CHANGELOG.unreleased.md): add missing XO 6 entry (#8211) 2024-12-20 16:04:54 +01:00
MlssFrncJrg
c41ae05275 feat(xo-server,xo-web): in host advanced tab, display mdadm status (#8190)
Fixes #7634
2024-12-20 15:59:38 +01:00
Paloma
9af2463922 feat(xo6/dashboard): add Pool Status component to dashboard (#7800) 2024-12-20 15:57:26 +01:00
Pierre Donias
22f9b3598d feat(xo-server/signin): temporary design matching XO 6 color palette (#8209) 2024-12-20 15:56:16 +01:00
MlssFrncJrg
97e7b9e5fe feat(xo-server/xo-web): in dashboard view, display more alarms (#8199) 2024-12-20 15:47:34 +01:00
Mathieu
87cfa649d3 fix(xo-server): fix 'HANDLE_INVALID' when creating VM (#8208)
Introduced by 04dd9e9
2024-12-20 15:23:03 +01:00
Sebastian CZECH
a945888e63 feat: technical release (#8207) 2024-12-20 09:34:02 +01:00
b-Nollet
4833c143de docs(backups): describe config (#8169) 2024-12-19 18:09:31 +01:00
MlssFrncJrg
8c8519f02d fix(xo-web): fix 'Pool is undefined' when creating a private network (#8188) 2024-12-19 17:02:29 +01:00
Mathieu
8ddd7b5290 feat(xo-web/VM/advanced): ability to manage XenStore entries (#8174)
See Zammad#26951
2024-12-19 16:13:10 +01:00
Mathieu
2b679c6cc1 feat(xo-server/rest): add pools status in the /dashboard endpoint (#8203) 2024-12-19 15:47:27 +01:00
Thomas Moraine
2f2a0aeed0 docs: cloudbase-init documentation (#8173)
Xen Orchestra now supports Cloudbase-init (for Windows VMs),
on top of the already-supported Cloud-init (for Linux VMs).
The Cloud-init section is therefore expanded to mention Cloudbase-init,
and we explain how to create a template for Windows VMs using Cloudbase-init.
2024-12-19 14:51:38 +01:00
OlivierFL
68168647aa fix(xo-core/UiInfo): issue with typography and add prop to handle text wrap (#8205) 2024-12-19 10:37:58 +01:00
Joris K
fd7d6b7ad7 feat(web-core): add table-pagination component (#8164) 2024-12-19 10:12:09 +01:00
Sebastian CZECH
086a42f38d feat(core): create connection status component (#8204) 2024-12-18 15:09:15 +01:00
Sebastian CZECH
d864cb57e0 feat: technical release (#8202) 2024-12-18 14:53:31 +01:00
OlivierFL
ee76c2c481 feat(xo-core): update UiLabel component to v1 (#8187) 2024-12-18 11:54:31 +01:00
Joris K
28cd54780d fix(xo-lite): fix issue with persistent scrollbar (#8191)
* Introduced by 21f0643

* change padding and add class layout to fix issue with persistent scrollbar

* reduction of the size of the icon (in the center of the nav bar), when reducing the screen, to avoid the double scrollbar
2024-12-18 09:29:20 +01:00
Florent BEAUCHAMP
e5acbe7a32 fix(backups): use callAsync instead of call for CBT enabling/disabling (#8184)
enabling and disabling CBT can take a while, and can timeout
with xapi.call().
2024-12-17 14:01:50 +01:00
Joris K
8bfd864ed8 feat(web-core): update UiInput component (#8117) 2024-12-17 11:25:34 +01:00
Mathieu
3c0a5df8e8 feat(xo-server, xo-web/patches): List missing patches for XenServer >= 8.4 (#8183) 2024-12-17 09:31:36 +01:00
Florent BEAUCHAMP
14da4fb8df VMs with this tag xo:no-health-check or xo:no-health-check=REASON will not be tested by health check (#8189) 2024-12-16 17:03:06 +01:00
Mathieu
5a933ed9ef fix(xo-server): fix 'no object with ...' during VM creation (#8195)
fix(xo-server): fix 'no object with during VM creation
2024-12-16 16:48:46 +01:00
Sebastian CZECH
56a18eba9a feat: technical release (#8196) 2024-12-16 11:02:22 +01:00
Stephane
1aef44bca5 feat(xo-web): merge backups synchronously (#8177) 2024-12-16 09:33:44 +01:00
Mathieu
04dd9e9c40 feat(xo-server/rest): ability to manage VDIs using REST API when creating VM (#8167) 2024-12-13 15:36:16 +01:00
Florent BEAUCHAMP
4a54685829 feat(xo-web): add rolling pool reboot and update to the plannable jobs (#8185) 2024-12-13 15:29:48 +01:00
Julien Fontanet
1bc0f8f245 fix(xapi/VM_destroy): use callAsync when appropriate
Related to zammad#32397
2024-12-11 17:38:29 +01:00
Julien Fontanet
02b067e1c5 fix(xapi/VM_create): fix destroy on failure 2024-12-11 17:38:29 +01:00
Joris K
e263f891ff feat(web-core): added UiDropdownButton component (#8076) 2024-12-11 13:43:20 +01:00
Stephane
7132b119c7 fix(xo-server): vdi_not_in_map error on migration (#8179)
Fix VDI_NOT_IN_MAP error on migration

XP-535
2024-12-11 11:46:32 +01:00
Sebastian CZECH
eb4b2c00ce feat(xo6): add network store (#8142) 2024-12-11 09:31:46 +01:00
Mathieu
5a88a48146 fix(xo-server): pool.installPatches correctly check for hosts permission (#8176)
Fix zammad#32199

pool.installPatches check user permissions on hosts if the pool is not passed.
2024-12-10 16:09:10 +01:00
Sebastian CZECH
c7657a5489 feat(web-core): remove aliasing from DonutChart (#8175) 2024-12-10 10:09:34 +01:00
Thierry Goettelmann
708b9b5bc8 feat(web-core): new menu management system (#8123) 2024-12-09 10:02:54 +01:00
Julien Fontanet
c08f84bf04 feat(xen-api): improve debug logs (#8155)
For `callAsync('VM.start', 'OpaqueRef:9a533a13-64bf-4755-ad6a-9b0f67d686ca', false, false)`, before:

```
xen-api DEBUG root@xcp1.company.net: Async.VM.start(...) [19ms] ==> string
xen-api DEBUG root@xcp1.company.net: task.destroy(...) [72ms] ==> string
```

After:

```
xen-api DEBUG root@xcp1.company.net: Async.VM.start started {
  callId: 'dtzkldk8t3f',
  args: [
    '* session id *',
    'OpaqueRef:9a533a13-64bf-4755-ad6a-9b0f67d686ca',
    false,
    false
  ]
}
xen-api DEBUG root@xcp1.company.net: Async.VM.start succeeded after 41ms {
  callId: 'dtzkldk8t3f',
  result: 'OpaqueRef:93a41f8e-005b-4c5b-a4b3-bf9d279f2827'
}
xen-api DEBUG root@xcp1.company.net: watching task { ref: 'OpaqueRef:93a41f8e-005b-4c5b-a4b3-bf9d279f2827' }
xen-api DEBUG root@xcp1.company.net: task succeeded { ref: 'OpaqueRef:93a41f8e-005b-4c5b-a4b3-bf9d279f2827', result: '' }
xen-api DEBUG root@xcp1.company.net: task.destroy started {
  callId: 'ngmpet66yj',
  args: [
    '* session id *',
    'OpaqueRef:93a41f8e-005b-4c5b-a4b3-bf9d279f2827'
  ]
}
xen-api DEBUG root@xcp1.company.net: task.destroy succeeded after 52ms { callId: 'ngmpet66yj', result: '' }
```
2024-12-06 18:21:36 +01:00
Julien Fontanet
d67a2ade37 fix(lite/deploy): download XVA from http://xoa.io/xva
Fixes https://xcp-ng.org/forum/post/86439

Other deploy methods (shell and vates.tech) uses this endpoint.

It should no longer be necessary to use the HTTP/1.0 special http://xoa.io:8888 endpoint.
2024-12-04 11:53:01 +01:00
Thierry Goettelmann
568e14f7ee feat(xo-stack): introduces job system (#8112)
New Job System that provides handling of asynchronous operations with built-in state management and identity-based concurrency control.

- Type-safe job definitions with typed arguments
- Concurrency control through identity tracking
- Built-in state management (`isRunning`, `canRun`, `errorMessage`)
- Argument validation
2024-12-04 08:41:28 +01:00
Thierry Goettelmann
c87d7a9eaf feat(web-core): new VtsLink component (#8000) 2024-12-04 08:40:01 +01:00
Sebastian CZECH
69347e9a4b feat(web-core): create tags list component (#8165) 2024-12-03 15:45:32 +01:00
Sebastian CZECH
bfb5ecc270 feat(web-core): add state for empty table (#8153) 2024-12-03 15:12:44 +01:00
Sebastian CZECH
6b2efe7039 feat(web-core): add no selection state component (#8170) 2024-12-03 14:34:03 +01:00
Joris K
e87334c0de feat(lite): 0.6.0 (#8172) 2024-11-29 15:15:12 +01:00
Joris K
427394f63f feat: release 5.101.0 (#8171) 2024-11-29 14:39:35 +01:00
Pierre Donias
2fda4130fe fix(web-core/VtsLayoutSidebar): remove bottom padding to match DS (#8168)
Introduced by #7589
2024-11-29 09:53:59 +01:00
Joris K
3b4e772eac feat: technical release (#8166)
* feat(vhd-lib): 4.11.2

* feat(@xen-orchestra/xapi): 7.8.0

* feat(@xen-orchestra/backups): 0.55.0

* feat(@xen-orchestra/backups-cli): 1.0.26

* feat(@xen-orchestra/immutable-backups): 1.0.14

* feat(@xen-orchestra/web-core): 0.7.0

* feat(@xen-orchestra/proxy): 0.29.6

* feat(@xen-orchestra/web): 0.5.0

* feat(xo-server): 5.164.0

* feat(xo-web): 5.163.0

* chore(CHANGELOG): update next
2024-11-28 16:21:17 +01:00
Florent BEAUCHAMP
511e2f70d1 fix(xo-web/sr): fix iso SR creation (#8159) 2024-11-28 15:12:19 +01:00
Mathieu
b41764405e feat(xo-server,xo-web/host): replace 2crsi-plugin.py -> ipmitool.py (#8144)
`2crsi-plugin` will be removed in favor of `ipmitool`. See https://github.com/xcp-ng/xcp-ng-xapi-plugins/pull/48
2024-11-28 14:36:53 +01:00
Stephane
11a801c129 feat(xo-web): ability to block/unblock migration (#8129)
Fixes https://project.vates.tech/vates-global/projects/70ab2907-1ac3-4e7d-831f-a8752c36474d/issues/b8c25c6d-40ba-4cb6-8a6c-33d887692525
2024-11-28 14:35:04 +01:00
Pierre Donias
07f8468317 feat(xo-web/backup): long-term retention settings (#8141) 2024-11-28 12:34:19 +01:00
Stephane
ba679a24c1 feat:(xo-server/host,xo-web): allow bypassing blocked migration in maintenance mode (#8149)
[host.setMaintenanceMode(true)] Allow bypassing blocked migration

in the UI

    detect the error
    display a modal indicating which VM cannot be migrated and asking if it should be bypassed
    if it should, retry the call and pass vmsToForceMigrate

in xo-server

    unblock migration for VMs in vmsToForceMigrate

XO-390
2024-11-28 11:46:12 +01:00
b-Nollet
10eafb493f fix(vhd-lib): return accurate merge size (#8156) 2024-11-28 11:38:46 +01:00
Sebastian CZECH
5219e41a64 feat(web-core): create VtsCardRowKeyValue component (#8148) 2024-11-28 11:31:39 +01:00
Florent BEAUCHAMP
fa97887d7e Feat(backups): support VTPMs content backup/restore (#8139) 2024-11-28 11:25:06 +01:00
OlivierFL
c5570c1e15 feat(xo-6): add 404 page (#8145) 2024-11-28 10:12:05 +01:00
MlssFrncJrg
d5217f92f9 feat(xo-server, xo-web): in host general tab, display 2CRSI BIOS update (#8146) 2024-11-27 14:40:51 +01:00
Mathieu
4082f12ad3 feat(xo-server): ability to manage VIFs using REST API when creating a VM (#8137) 2024-11-27 14:38:07 +01:00
Joris K
01cc733cac feat: technical release (#8163) 2024-11-27 11:01:05 +01:00
Florent BEAUCHAMP
49d5f273f2 fix(backups): update yarn.lock (#8160)
introduced by e80b39e417
2024-11-26 15:57:11 +01:00
Sebastian CZECH
904273f48b feat(xo-lite): display host console (#8136) 2024-11-26 14:48:23 +01:00
Florent BEAUCHAMP
e80b39e417 feat(backups): implement long term retention (#7999)
* feat(backups): implement long terme retention

long term retention sometimes called GFS ( Grand Father / Father / Son)
is a way to promote some backup to be kept on a long time

that way , the user can use the find the best equilibrium between
storage and security

This commit add the code mechanics to identify backup that
can be deleted safely. It is intended to use with a form
that ask the user for the number of day, week, month, and year
for which XO will keep the most recent

It extends the actual system of keeping the n most recent backup

Keep in mind that the backup promoted by week and month can be decaled
2024-11-26 14:39:39 +01:00
Sebastian CZECH
96769322a7 feat(xo-6): add state for panel to stateHero (#8124) 2024-11-26 11:27:47 +01:00
Julien Fontanet
be05b69d41 test(task): compat with Node >= 20.18.1
Introduced by ba3753ab1
2024-11-26 10:57:05 +01:00
Mathieu
a22e4a6340 fix(xo-server): support of cloudbase-init (#8154) 2024-11-26 10:01:29 +01:00
p-bo
aecc5f6aa9 fix(eslint): exclude "cs" locale for XO front projects (#8102)
Fix ESLint errors for missing `cs` locale translation keys.
2024-11-26 09:36:05 +01:00
p-bo
b2ac0d3abc feat(web-core): add Czech to i18n config (#8101) 2024-11-26 09:25:59 +01:00
p-bo
ad9a05b03e feat(web-core): add czech translation (#8100) 2024-11-26 09:24:44 +01:00
p-bo
65d98eb5a9 feat(xo-6): add czech translation (#8099) 2024-11-26 09:23:43 +01:00
p-bo
1bc3d5c1bd feat(xo-lite): add czech translation (#8098) 2024-11-26 09:22:04 +01:00
Mathieu
fa974f920c feat(web-stack): implement actions and clipboard for VM console (#8125) 2024-11-25 17:39:02 +01:00
Joris K
87b7016669 feat: technical release (#8157)
* feat(@xen-orchestra/fs): 4.3.0

* feat(@xen-orchestra/web-core): 0.5.0

* feat(@xen-orchestra/proxy): 0.29.5

* feat(@xen-orchestra/web): 0.3.2

* feat(xo-server): 5.162.0

* feat(xo-server-perf-alert): 0.6.0

* feat(xo-web): 5.162.0

* chore(CHANGELOG): update next
2024-11-25 14:58:35 +01:00
OlivierFL
21f0643c4d feat(xo-6/header): update user menu button (#8143) 2024-11-22 09:13:01 +01:00
Stephane
7445acdafe chore(xo-server-test): add app-conf (#8093)
Use app-conf to get xo-server hostname and port.
2024-11-21 17:38:42 +01:00
b-Nollet
1e98a3ed26 feat(@xen-orchestra/fs): add getSizeOnDisk function (#8138)
Split getSize in two functions and have it return a more accurate value without any ivLength magic and encryption padding
2024-11-21 15:44:05 +01:00
Florent BEAUCHAMP
a5ad395b33 fix(xo-web/New SR): better handling of ipv6 when creating a nfs iso SR (#8134) 2024-11-21 15:17:03 +01:00
Thierry Goettelmann
86c45ef3de docs(web-core): update documentation structure (#8135) 2024-11-20 15:04:53 +01:00
MlssFrncJrg
9939cee832 feat(xo-server): in proxies tab, display current version (#8104)
* feat(xo-server): in proxies tab, display current version
2024-11-18 17:07:20 +01:00
Sebastian CZECH
b120f5486c feat(xo-lite): add links to user menu (#8114) 2024-11-18 16:53:47 +01:00
Joris K
c72e6ab66e feat(web-core) add UiRadioButtonGroup component (#8096) 2024-11-18 16:36:27 +01:00
OlivierFL
7c68ff83cf feat(xo-lite/header): update user menu button (#8109) 2024-11-18 16:35:07 +01:00
OlivierFL
2a8acd2770 fix(xo-lite/stories): bad custom-event name case (#8140) 2024-11-18 16:25:19 +01:00
MlssFrncJrg
6825b24108 fix(xo-server-perf-alert): fix no writable SRs being monitored (#8113) 2024-11-18 10:15:09 +01:00
Julien Fontanet
0603b63035 chore: update dev deps 2024-11-15 19:08:37 +01:00
Stephane
99c56d282b fix(xen-orchestra/fs): nfs port (#8085)
XO-375

In "remotes", fix nfs port if specified.
The problem : port was specified in url, when it should be specified as an option.

Options already exist. It should continue to work as before.
2024-11-15 14:19:49 +01:00
OlivierFL
29b4c0a764 fix(xo-lite/dashboard): add min-width to hosts patches container (#8108)
Set a minimum width for the "Patches" and "Status" cards to align with the design system and allocate enough space for displaying data when it is being loaded.
2024-11-15 12:41:34 +01:00
Joris K
b81e83c619 fix(web-core): changing variable name due to new guidelines (#8131) 2024-11-15 11:18:47 +01:00
Mathieu
d7d4b40d66 feat(xo-server/xostor): do not install/update packages in airgap environement (#8105) 2024-11-15 09:14:49 +01:00
Thierry Goettelmann
a3340a7a7e feat(lite,core,web): control domain store, refactor context access (#8130) 2024-11-15 09:14:28 +01:00
Mathieu
91bfdf54ec fix(xo-web/host/network): do not PIF.reconfigure_ipv6 if IPv6 is an empty string (#8119)
See https://team.vates.fr/vates/pl/utda1cc3p3roiknt5y4yn3xqjo
Introduced by 1becccf
2024-11-15 09:13:20 +01:00
Sebastian CZECH
317a6587d3 feat(xo-6): add panel component (#8122) 2024-11-15 09:10:39 +01:00
Joris K
d229e2b82e feat(web-core): add UiCheckboxGroup component (#8094) 2024-11-15 09:07:40 +01:00
Joris K
36bab99a10 feat(web-core): add UiToggle component (#8084) 2024-11-15 09:03:28 +01:00
Joris K
2dafb3a1ec feat(web-core): added UiTableActions component (#8072) 2024-11-15 09:00:57 +01:00
Joris K
09b4246207 feat(web-core): added UiRadioButton component (#8067) 2024-11-15 08:56:48 +01:00
Joris K
92d504012a feat(web-core): added UiTopBottomTable component and some trad (#8055) 2024-11-15 08:54:25 +01:00
Julien Fontanet
cd6a856986 feat: release 5.100.2 2024-11-14 17:49:58 +01:00
Julien Fontanet
2f20370aec feat(xo-web): 5.161.0 2024-11-14 16:34:46 +01:00
Julien Fontanet
e5abd5c390 feat(xo-server): 5.161.0 2024-11-14 16:34:14 +01:00
Julien Fontanet
834c32f1da feat(@xen-orchestra/proxy): 0.29.4 2024-11-14 16:33:13 +01:00
Julien Fontanet
b46598f2b1 feat(@xen-orchestra/backups): 0.54.3 2024-11-14 16:32:48 +01:00
Julien Fontanet
d317e70282 feat(@xen-orchestra/xapi): 7.7.1 2024-11-14 16:30:46 +01:00
Julien Fontanet
f9c7aa92f9 feat(@xen-orchestra/log): 0.7.1 2024-11-14 16:28:42 +01:00
Julien Fontanet
fc57a7f9be feat(xo-server/api): ability to capture all logs for a call
The goal of this new feature is to help developers investigate issues by
allowing them to easily gather more information.

When enabled, all logs emitted in a given API call are stored in a file
(`${tmpdir}/xo-api-${date}-${method}.log`).

Administrators can use the special `_log` param to request it:

```sh
xo-cli vm.start id=$id _log=json:true

xo-cli vm.start id=$id _log=failure
```

Or it can be enabled for all calls to a method in xo-server's configuration:

```toml
[api.logs]
'vm.start' = 'failure'
```
2024-11-14 16:00:15 +01:00
Julien Fontanet
9abfc1509c feat(log/captureLogs): possibility to forward to fallback transport 2024-11-14 16:00:15 +01:00
Nathanaël
224c09ed57 docs: migrate from VuePress 1.4 to Docusaurus 3.6 (#8078)
Migrate docs from VuePress wich is not maintained anymore, to Docusaurus, which is maintained and also used fro XCP-ng docs.

---------

Co-authored-by: Thomas Moraine <thomas.moraine@vates.tech>
2024-11-14 10:09:28 +01:00
Julien Fontanet
10a82b07a9 fix(backups,xapi): use PV_drivers_detected instead of PV_drivers_version.major
Fixes zammad#27432
Fixes zammad#29040
2024-11-14 09:42:34 +01:00
Florent BEAUCHAMP
d6e76f4558 fix(backups): force delta chain length at zero for base backup (#8126)
from ticket 31268
probably caused by a combination of restore/clone of a VM
2024-11-14 07:44:53 +01:00
Sebastian CZECH
75a19e7ea0 feat(web-core): add UiToaster component (#8095) 2024-11-13 16:08:56 +01:00
MlssFrncJrg
05c4e8ea8a feat(xo-web/VM/Advanced): nested virtualization warning tooltip (#8107) 2024-11-13 10:11:48 +01:00
Thierry Goettelmann
ec63244ada chore(web stack): update dependencies (Vue 3.5, TS 5.6) (#8111)
- Update Vue `3.4` to `3.5`
- Update TypeScript `5.3` to `5.6` 
- Update Pinia `2.1` to `2.2`
- Update `vite.config.ts` to import paths with `fileURLToPath` and `URL` instead of `resolve`
- Update `size.util.ts` to use named imports from `human-format`
- Fix TS error in `vite.config.ts`
- Fix TS error in `story-param.ts`
- Fix TS error in `UiCardNumbers.vue`
- Fix TS error in `tree-node-base.ts`
2024-11-13 10:05:22 +01:00
Julien Fontanet
bc5182b3ca chore: format with Prettier 2024-11-13 09:39:34 +01:00
Florent BEAUCHAMP
ce16eb5ee4 fix(@xen-orchestra/xapi): use callAsync for VDI_listChangedBlocks (#8120) 2024-11-12 16:44:21 +01:00
Joris K
c7ddf33bcf feat(web-core): added UiCheckbox component (#8064) 2024-11-12 15:24:35 +01:00
Julien Fontanet
02f34c18e6 feat(log/levels): expose names, values and resolve() 2024-11-12 10:37:44 +01:00
Sebastian CZECH
86accbf912 feat(xo-6): add host console (#8103) 2024-11-12 08:43:11 +01:00
MlssFrncJrg
efee92dbdf fix(xo-web/Editable/Text): trim spaces (#8115) 2024-11-08 15:59:19 +01:00
MlssFrncJrg
28735191bc feat(xo-web): add documentation link when the host TLS key is too small (#8110) 2024-11-08 12:55:54 +01:00
Florent BEAUCHAMP
96abd49646 feat: release 5.100.1 (#8118) 2024-11-07 16:23:01 +01:00
Florent BEAUCHAMP
d8c4b60b63 feat: technical release (#8116) 2024-11-07 15:38:43 +01:00
Florent BEAUCHAMP
41bc59bdf4 fix(nbd): connect to only one host at a time per disk (#8086)
connecting to multiple host in parallel sometimes lead to a race condition in xapi-nbd while updating the sm_config property of the vdi. This lead to VDI that are not disconnected, thus VDI_IN_USE error at the next step of the backup

from : https://xcp-ng.org/forum/topic/9864/vdi-staying-connected-to-dom0-when-using-nbd-backups/46?_=1730797966321
2024-11-07 14:49:57 +01:00
Florent BEAUCHAMP
a8fd967576 fix(xo-remote-parser): encode username (#8106)
from ticket 30845
2024-11-07 14:43:57 +01:00
Julien Fontanet
9de714b5d6 feat(xo-web,xo-server): hint numeric for OTP inputs 2024-11-07 11:17:31 +01:00
Mathieu
a4ba695125 feat(web-core): new UiTextarea component (#7993) 2024-11-06 15:32:45 +01:00
Joris_K
7e4c33b2f7 feat(web-core): update the UiButton component to follow the new guidelines (#8049) 2024-11-06 11:17:00 +01:00
MlssFrncJrg
bb51de262d feat(xo-web): in health tab, hide PVS accelerator in orphan VDIs (#8039)
Fixes #7938
2024-11-06 10:52:55 +01:00
OlivierFL
4a7a2b74e0 feat(web-stack): use new guidelines for web-core components (#8069) 2024-11-05 15:33:46 +01:00
OlivierFL
804af1dc68 feat(web-stack): update normal colors to info and add brand colors (#8054) 2024-11-05 09:46:14 +01:00
Julien Fontanet
3a0155b464 fix(proxy/system.getServerVersion): fix description 2024-11-04 16:41:16 +01:00
b-Nollet
ff1189ef69 feat(lite): 0.5.0 (#8092) 2024-10-31 13:57:41 +01:00
b-Nollet
350fae90eb feat: release 5.100.0 (#8091) 2024-10-31 13:03:38 +01:00
b-Nollet
4fc97a572e feat: technical release (#8090) 2024-10-31 11:30:41 +01:00
Julien Fontanet
f077ccb09a fix(xo-server): ensure group name unicity 2024-10-31 10:49:45 +01:00
Julien Fontanet
8ffd7f993c fix(xo-server/Users): properly check email unicity (#8089)
Replaces #8088

Introduced by f2fe7731d

This commit introduce two new `Collection/Redis` protected async methods:

- `_beforeAdd(model)`: called before a new model is added
- `_beforeUpdate(model, previous)`: called before a model is updated

If the method throws, the corresponding operation is aborted.
2024-10-31 10:38:56 +01:00
b-Nollet
34bccbda56 feat: technical release (#8087) 2024-10-30 16:06:56 +01:00
Julien Fontanet
07ad2ca201 feat(backups): add debugs to file restore 2024-10-30 13:36:59 +01:00
Julien Fontanet
f1a7436a90 fix(xo-cli rest): don't alter unprefixed response 2024-10-30 13:36:59 +01:00
Stephane
7c9e1439a9 fix(xen-orchestra/fs): error creating nfs encrypted remote (#8081)
XO-386

When adding a nfs remote with encryption, the remote directory must be empty, then we create metadata.json and encryption.json on it.
If not, we fail to test these json files and the user receive an error "file not found: metadata.json" which is not understandable.

In this case, this PR return a message explaining the problem.
2024-10-30 13:14:37 +01:00
Pierre Donias
9ec7462a04 feat(netbox): synchronize description and comments (#8083) 2024-10-30 10:03:38 +01:00
Florent BEAUCHAMP
73e170e849 fix(Restore): ignore cbt_medata disk when doing differential restores (#8082)
differential restore works by reusing local data of a snapshot
linked to a delta chain on the remote
cbt_metadata don't have the disks data , thus are not eligible to
be used  for differential restores

from  https://xcp-ng.org/forum/topic/9728/problem-with-differential-restore/8
2024-10-30 09:59:13 +01:00
Pierre Donias
10150e5902 feat(xo-web/acls): ability to filter objects by tags (#8068)
See Zammad#24820
2024-10-29 15:55:08 +01:00
Julien Fontanet
30e6d4b4f1 feat(xo-web/new-vm): new cloud-init template var {index} 2024-10-29 15:16:19 +01:00
Florent BEAUCHAMP
b018e5acb3 feat(vmware): keep connection alive (#7839)
this lead to failing transfer when powering off the VM , since this is the
first api call after the export, that can take hours. The error code is a 500

We do a dummy vmware api call every 15 minutes, to ensure the session stays
up.

ticket 25980 and 29939
2024-10-29 13:45:43 +01:00
Stephane
f2fe7731d9 fix(xo-server): user can set his email to an already used email (#8062)
user can set his email to an already used email

    add a check, if email already exists, throw an error

XO-323
2024-10-29 13:41:56 +01:00
Mathieu
d89fb329ef feat(xo-server/rest-api): create_vm cloud init support (#8070) 2024-10-29 12:05:26 +01:00
Joris_K
5b34022d1d feat(web-core): add UiTitle component (#8046) 2024-10-29 11:55:26 +01:00
Julien Fontanet
297b9b2025 feat(task/{failure,success}): ensure not called during run
Introduced by ba3753ab1
2024-10-29 08:34:48 +01:00
Julien Fontanet
53266ec8f6 chore: don't auto build before running tests
This does not integrate well with Turbo and slows down the CI.
2024-10-28 17:06:44 +01:00
Julien Fontanet
163e80b6c5 feat(ci): test with Node 20 2024-10-28 16:49:59 +01:00
b-Nollet
04b3fc26fb feat: technical release (#8079) 2024-10-28 16:42:40 +01:00
Julien Fontanet
c0b61d5f67 fix(ci): correctly cache Turbo 2024-10-28 16:40:49 +01:00
Julien Fontanet
2da3721d83 chore(ci): use actions/checkout/v4 2024-10-28 16:38:23 +01:00
Julien Fontanet
0cf1d52935 chore(ci): separate steps with new lines 2024-10-28 16:37:13 +01:00
Julien Fontanet
41e847a32f chore: use native node:test instead of test package 2024-10-28 16:33:21 +01:00
Julien Fontanet
14e9059cb3 test(fs): fix broken tests 2024-10-28 15:43:14 +01:00
Mathieu
58bace558e fix(xo-server/rest-api): fix "/users/me" redirection (#8075)
fix(xo-server/rest-api): fix  redirection
2024-10-28 13:57:59 +01:00
Julien Fontanet
40fc999a3a feat(xen-api/call): add duration to error 2024-10-28 11:31:23 +01:00
Julien Fontanet
8116535b1b fix(CHANGELOG.unreleased): remove empty line
Introduced by ba3753ab1
2024-10-28 11:31:23 +01:00
Pierre Donias
95e5f50ce7 Revert "feat(xo-web/XOA update): display "Downgrade" when trial is over" (#8074)
This reverts commit c6f3b2b1ce.

Showing "Downgrade" after a trial has ended can be confusing.
2024-10-28 11:13:30 +01:00
Florent BEAUCHAMP
d1cdf6c0c5 fix(backup/incremental): clean vm before starting the transfert
especially in case of mirror backup, the cost of a backup repo in
an invalid state exceeds the cost of a retransfer
2024-10-28 11:06:46 +01:00
Florent BEAUCHAMP
bc74a0bd42 chore(backup): fix typo 2024-10-28 11:06:46 +01:00
Florent BEAUCHAMP
0eb50099af revert(backup): do not call updateuuid
commit ac8659021f

chaining must be redone since the path of the parent can change
from alias to non alias or the opposite
2024-10-28 11:06:46 +01:00
Pierre Donias
65fe1d83be feat(lite/xoa-deploy): configure custom NTP servers (#8059)
Add NTP servers to xenstore so that XO can automatically configure them on first start.
2024-10-28 11:05:24 +01:00
Mathieu
8c85a4657b feat(xo-server/rest-api): implement authentication tokens route (#8065) 2024-10-25 15:11:28 +02:00
Florent BEAUCHAMP
f236238c73 fix(backups): keep only the last snapshot across all delta schedules (#8051) 2024-10-25 11:29:57 +02:00
Joris_K
3d681f868a feat(web-core): add actions title component (#8045) 2024-10-25 11:23:18 +02:00
Julien Fontanet
c79efa0fe8 docs(xml-rpc): don't normalize or trim whitespaces when parsing XML 2024-10-24 11:21:42 +02:00
Julien Fontanet
bc5fa0f3f5 fix(xo-cli rest --json): output ndjson if response is ndjson 2024-10-24 11:21:42 +02:00
Florent BEAUCHAMP
fa9f865494 fix(Backups/cleanVm): handle missing vhd file of an alias (#8053) 2024-10-24 10:34:47 +02:00
Julien Fontanet
ba3753ab1a feat(task): add start, success & failure methods (#8061)
* feat(task): add start, success & failure methods

Allow managing the task manually instead of using `.run()` and `.runInside()`.
2024-10-22 17:08:57 +02:00
Stephane
a71e78fdbc chore(xo-server-test): cleanup and rewrite user tests (#8048) 2024-10-22 17:08:17 +02:00
Julien Fontanet
a3cb9d5619 feat(fs/cli): new method cat
```sh
xo-fs "$remote" cat "$file1" "$file2"
```
2024-10-22 17:01:47 +02:00
Julien Fontanet
cc1d492510 feat(fs/cli): ability to call a method directly from CLI
Example with `mkdir(path)`:

```sh
xo-fs "$remote" mkdir "$path"
```
2024-10-22 17:01:47 +02:00
Florent BEAUCHAMP
d0b7d305a2 fix(backups): VDI_INCOMPATIBLE_TYPE error (#8043)
See https://help.vates.tech/#knowledge_base/1/locale/en-us/answer/135
2024-10-22 15:09:50 +02:00
Julien Fontanet
c0bc294886 feat(xo-web/home/vms): ability to filter by MAC addresses
Fixes https://team.vates.fr/vates/pl/7xju4kwb6bra8nxupqxfhbiupc
2024-10-22 14:42:06 +02:00
Florent BEAUCHAMP
ac8659021f fix(backup/mirror): do not call updateuuid 2024-10-21 17:06:02 +02:00
Florent BEAUCHAMP
6756c9de99 fix(backups): ensure checkBaseVdis is called on all delta backup
before this commit checkbasevdis is not called if there are no disks
this leads to an erronous error message `checkbasevdi must be called
before updateUuidAndChain for incremental backups` instead of a
message on the missing vhd
this wille trigger  'A differential VHD must have a parent' instead
2024-10-21 17:06:02 +02:00
Florent BEAUCHAMP
56f3d9d7a9 fix(backup/mirror): homogenize differental vhd computation 2024-10-21 17:06:02 +02:00
Julien Fontanet
649add3ab3 fix(xo-server-audit): ignore host.isPubKeyTooShort
Fixes https://xcp-ng.org/forum/post/84464
2024-10-21 11:16:21 +02:00
1923 changed files with 88976 additions and 23739 deletions

View File

@@ -105,6 +105,8 @@ module.exports = {
],
},
],
'no-useless-constructor': 'off',
'@typescript-eslint/no-useless-constructor': 'error',
'no-void': ['error', { allowAsStatement: true }],
'n/no-missing-import': 'off', // using 'import' plugin instead, to support TS aliases
'no-redeclare': 'off', // automatically checked by the TypeScript compiler
@@ -169,7 +171,6 @@ module.exports = {
'vue/no-empty-component-block': 'error',
'vue/no-multiple-objects-in-class': 'error',
'vue/no-ref-object-reactivity-loss': 'error',
'vue/no-required-prop-with-default': 'error',
'vue/no-static-inline-styles': 'error',
'vue/no-template-target-blank': 'error',
'vue/no-undef-components': ['error', { ignorePatterns: ['RouterLink', 'RouterView', 'I18nT'] }],
@@ -190,18 +191,14 @@ module.exports = {
// Specific rules for XO i18n-related files
{
files: [
'@xen-orchestra/lite/**/*.{vue,ts,json}',
'@xen-orchestra/web/**/*.{vue,ts,json}',
'@xen-orchestra/lite/**/*.{vue,ts}',
'@xen-orchestra/web/**/*.{vue,ts}',
'@xen-orchestra/web-core/**/*.{vue,ts,json}',
],
extends: ['plugin:@intlify/vue-i18n/base'],
settings: {
'vue-i18n': {
localeDir: [
'@xen-orchestra/lite/src/locales/*.json',
'@xen-orchestra/web/src/locales/*.json',
'@xen-orchestra/web-core/lib/locales/*.json',
],
localeDir: ['@xen-orchestra/web-core/lib/locales/*.json'],
messageSyntaxVersion: '^9.9.0',
},
},
@@ -219,13 +216,25 @@ module.exports = {
'@intlify/vue-i18n/no-raw-text': [
'error',
{
ignoreText: ['Xen Orchestra Lite', 'Xen Orchestra', 'XO Lite', 'XCP-ng', 'XO 5', '404', '⚠️'],
ignoreText: [
'Xen Orchestra Lite',
'Xen Orchestra',
'Xen Orchestra Appliance',
'XO Lite',
'XCP-ng',
'XO 5',
'404',
'⚠️',
],
},
],
'@intlify/vue-i18n/no-v-html': 'error',
'@intlify/vue-i18n/valid-message-syntax': 'error',
'@intlify/vue-i18n/no-duplicate-keys-in-locale': 'error',
'@intlify/vue-i18n/no-missing-keys-in-other-locales': ['error', { ignoreLocales: ['de', 'fa'] }],
'@intlify/vue-i18n/no-missing-keys-in-other-locales': [
'error',
{ ignoreLocales: ['de', 'fa', 'cs', 'es', 'sv', 'it', 'ru', 'uk', 'nl'] },
],
},
},
// Specific rules for XO dev-related files
@@ -261,6 +270,8 @@ module.exports = {
},
],
ignorePatterns: ['@vates/fatfs/'],
parserOptions: {
ecmaVersion: 13,
sourceType: 'script',

View File

@@ -40,8 +40,8 @@ body:
- type: markdown
attributes:
value: |
- Don't forget to [read this first](https://xen-orchestra.com/docs/community.html)
- As well as follow [this guide](https://xen-orchestra.com/docs/community.html#report-a-bug)
- Don't forget to [read this first](https://docs.xen-orchestra.com/community)
- As well as follow [this guide](https://docs.xen-orchestra.com/community#report-a-bug)
- type: input
id: xo-sources-commit-number
attributes:

View File

@@ -1,38 +1,50 @@
name: Continous Integration
name: Continuous Integration
on: push
jobs:
CI:
runs-on: ubuntu-latest
steps:
# https://github.com/actions/checkout
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Install packages
run: |
sudo apt-get update
sudo apt-get install -y curl qemu-utils python3-vmdkstream git libxml2-utils libfuse2 nbdkit
# https://turbo.build/repo/docs/guides/ci-vendors/github-actions#caching-with-github-actionscache
- name: Cache Turbo
# https://github.com/actions/cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: '**/node_modules/.cache/turbo'
key: ${{ runner.os }}-turbo-cache
path: '.turbo'
key: ${{ runner.os }}-turbo-${{ github.sha }}
restore-keys: |
${{ runner.os }}-turbo-
# https://github.com/actions/setup-node
- name: Setup Node environment
# https://github.com/actions/setup-node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
cache: 'yarn'
- name: Install project dependencies
run: yarn
- name: Ensure packages are sorted in CHANGELOG.unreleased.md
run: ./scripts/gen-deps-list.js --check-order > /dev/null
- name: Ensure yarn.lock is up-to-date
run: git diff --exit-code yarn.lock
- name: Build the project
run: yarn build
- name: Unit tests
run: yarn test-unit
- name: Lint tests
run: yarn test-lint
- name: Integration tests
run: sudo yarn test-integration

2
.gitignore vendored
View File

@@ -7,6 +7,8 @@
/@vates/*/node_modules/
/@xen-orchestra/*/dist/
/@xen-orchestra/*/node_modules/
/@xen-orchestra/rest-api/open-api/spec/swagger.json
/@xen-orchestra/rest-api/src/open-api/routes/routes.ts
/packages/*/dist/
/packages/*/node_modules/

View File

@@ -16,7 +16,7 @@ Returns a promise wich rejects as soon as a call to `iteratee` throws or a promi
- `concurrency`: a number which indicates the maximum number of parallel call to `iteratee`, defaults to `10`. The value `0` means no concurrency limit.
- `signal`: an abort signal to stop the iteration
- `stopOnError`: wether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
- `stopOnError`: whether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
```js
import { asyncEach } from '@vates/async-each'

View File

@@ -34,7 +34,7 @@ Returns a promise wich rejects as soon as a call to `iteratee` throws or a promi
- `concurrency`: a number which indicates the maximum number of parallel call to `iteratee`, defaults to `10`. The value `0` means no concurrency limit.
- `signal`: an abort signal to stop the iteration
- `stopOnError`: wether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
- `stopOnError`: whether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
```js
import { asyncEach } from '@vates/async-each'

View File

@@ -11,8 +11,8 @@ class AggregateError extends Error {
/**
* @template Item
* @param {Iterable<Item>} iterable
* @param {(item: Item, index: number, iterable: Iterable<Item>) => Promise<void>} iteratee
* @param {Iterable<Item>|AsyncIterable<Item>} iterable
* @param {(item: Item, index: number, iterable: Iterable<Item>|AsyncIterable<Item>) => Promise<void>} iteratee
* @returns {Promise<void>}
*/
exports.asyncEach = function asyncEach(iterable, iteratee, { concurrency = 10, signal, stopOnError = true } = {}) {

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it, beforeEach } = require('test')
const { describe, it, beforeEach } = require('node:test')
const assert = require('assert').strict
const { spy } = require('sinon')

View File

@@ -30,10 +30,9 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
},
"devDependencies": {
"sinon": "^18.0.0",
"test": "^3.2.1"
"sinon": "^18.0.0"
}
}

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const assert = require('assert')
const { coalesceCalls } = require('./')

View File

@@ -31,9 +31,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.2.1"
"test": "node --test"
}
}

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const assert = require('node:assert').strict
const { compose } = require('./')

View File

@@ -20,9 +20,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.2.1"
"test": "node --test"
}
}

View File

@@ -1,7 +1,7 @@
'use strict'
const assert = require('assert')
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const { decorateClass, decorateWith, decorateMethodsWith, perInstance } = require('./')

View File

@@ -26,9 +26,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.2.1"
"test": "node --test"
}
}

View File

@@ -7,7 +7,7 @@
* @param {Array|Buffer|string} data1 - The first data array or buffer to compare.
* @param {T} data2 - The second data array or buffer to compare.
* @param {(index: number, diff: T) => void} [cb] - The callback function to invoke for each difference. If not provided, an array of differences will be returned.
* @returns {Array<number|T>|undefined} - An array of differences if no callback is provided, otherwise undefined.
* @returns {Array<number|T>|undefined} - An array of differences if no callback is provided; otherwise, undefined.
*/
module.exports = function diff(data1, data2, cb) {
let result

View File

@@ -1,7 +1,7 @@
'use strict'
const assert = require('node:assert/strict')
const test = require('test')
const test = require('node:test')
const diff = require('./index.js')

View File

@@ -28,9 +28,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.3.0"
"test": "node --test"
}
}

View File

@@ -14,7 +14,7 @@ import { deduped } from '@vates/disposable/deduped'
// the connection with the passed host will be established once at the first call, then, it will be shared with the next calls
const getConnection = deduped(async function (host)) {
const connection = new Connection(host)
return new Disposabe(connection, () => connection.close())
return new Disposable(connection, () => connection.close())
}, host => [host])
```

View File

@@ -32,7 +32,7 @@ import { deduped } from '@vates/disposable/deduped'
// the connection with the passed host will be established once at the first call, then, it will be shared with the next calls
const getConnection = deduped(async function (host)) {
const connection = new Connection(host)
return new Disposabe(connection, () => connection.close())
return new Disposable(connection, () => connection.close())
}, host => [host])
```

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const { useFakeTimers, spy, assert } = require('sinon')
const { createDebounceResource } = require('./debounceResource')

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const { spy, assert } = require('sinon')
const { deduped } = require('./deduped')

View File

@@ -14,22 +14,21 @@
"url": "https://vates.fr"
},
"license": "ISC",
"version": "0.1.5",
"version": "0.1.6",
"engines": {
"node": ">=8.10"
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
},
"dependencies": {
"@vates/multi-key-map": "^0.2.0",
"@xen-orchestra/async-map": "^0.1.2",
"@xen-orchestra/log": "^0.6.0",
"@xen-orchestra/log": "^0.7.1",
"ensure-array": "^1.0.0"
},
"devDependencies": {
"sinon": "^18.0.0",
"test": "^3.2.1"
"sinon": "^18.0.0"
}
}

1
@vates/fatfs/.npmignore Symbolic link
View File

@@ -0,0 +1 @@
../../scripts/npmignore

127
@vates/fatfs/README.md Normal file
View File

@@ -0,0 +1,127 @@
# @vates/fatfs
This is a fork of the original library [natevw/fatfs](https://github.com/natevw/fatfs).
## Why?
This fork was created to add a missing feature in the original library: the ability to create labels (createLabel).
The original library did not support this functionality, which was required to make Cloudbase-Init work on windows VMs.
See: https://github.com/natevw/fatfs/issues/30, https://github.com/natevw/fatfs/pull/31
A standalone FAT16/FAT32 implementation that takes in a block-access interface and exposes something quite similar to `require('fs')` (i.e. the node.js built-in [Filesystem API](http://nodejs.org/api/fs.html)).
## Installation
`npm install fatfs`
## Example
```js
var fatfs = require('fatfs'),
fs = fatfs.createFileSystem(exampleDriver) // see below
fs.stat('autoexec.bat', function (e, stats) {
if (e) console.error(e)
else console.log(stats)
})
// TODO: open a file and write to it or something…
```
## API
- `fs = fatfs.createFileSystem(vol, [opts], [cb])` — Simply pass in a block driver (see below) mapped to a FAT partition somewhere, and get back an instance of an [`fs`](http://nodejs.org/api/fs.html). An options dictionary can be provided, details are in the next section. You may also optionally provide a callback `cb(err)` which will be automatically registered for the on `'ready'` or `'error'` event.
- `'ready'` event — fired on `fs` when initial volume information has been determined and the API is ready to use. It is safe to call other `fs` methods before this fires **only if** you are sure the first sector will be readable and represents a valid FAT volume.
- `'error'` event — fired if initialization fails for whatever reason.
### Filesystem options
The `opts` dictionary you pass to `fatfs.createFileSystem` can contain any of the following options:
- `ro` — Enables readonly mode if `true`. It defaults to `false`, but if your volume driver does not provide a `writeSectors` method it will be overridden to `true`.
- `noatime` — The FAT filesystem can track the last access time (just a date, actually) but this means every read operation would also incur some write overhead. Defaults to `true`, meaning by default access times will **not** be updated on reads. Set this to `false` to track access times.
- `modmode` — chooses how `fs.chmod` (and the mode field from `fs.stat`–family calls) should map FAT attributes to POSIX permissions. Set to the number `0111` to map the readonly flag to the user's write bit being unset, and the archive/system/hidden flags to the user/group/other executable bits respectively. Set to the number `07000` to map the readonly flag to _all_ write bits being unset, and the archive/system/hidden flags to the sticky/setgid/setuid bits respectively. Set to `null` for readonly mapping. Defaults to `0111`.
- `umask` — any bits _set_ in this octal number will be _unset_ in the 'mode' field from `fs.stat`–family calls. It does not affect anything else. Defaults to `process.umask()`, or `0022` if that is unavailable.
- `uid` — This value will be returned as the 'uid' stat field. It does not affect anything else. Defaults to `process.getuid()`, or `0` if that is unavailable.
- `gid` — This value will be returned as the 'gid' stat field. It does not affect anything else. Defaults to `process.getgid()`, or `0` if that is unavailable.
(Note that these are similar to the options you could use with a POSIX `mount` operation.)
And that's it! The [rest of the API](http://nodejs.org/api/fs.html) (`fs.readdir`, `fs.open`, `fs.createReadStream`, `fs.appendFile`, etc.) is as documented by the node.js project.
Well, sort of…
## Caveats
### Temporary
- **BETA** **BETA** **BETA**. Seriously, this is a _brand new_, _from scratch_, _completely unproven_ filesystem implementation. It does not have full automated test coverage, and it has not been manually tested very much either. Please, please, please, **make sure you have a backup** of any important drive/image/card you unleash this upon.
- A few methods are not quite implemented, either: `fs.rename`, `fs.unlink` and `fs.rmdir`, as well as `fs.watchFile`/`fs.unwatchFile` and `fs.watch`. These are Coming Soon™.
- There are several internal housekeeping items (redundant FAT tables, extra FAT32 information, etc.) that are not done. These do not seem to affect interop, but you may see warnings when repairing a filesystem written by this module.
- Oh, and not to scare you, but if an IO error happens while writing, the library usually just bails — bubbling an error up to your callback as if it were a hot potato. Although some attempt has been made to do separate writes in the safest order (e.g. allocating an additional file cluster, then appending data into it, and then finally updating the file's size), but this behavior has not been thoroughly audited for all operations. There's certainly no attempt to retry/cleanup/rollback if a multi-step change runs into trouble partway through.
### As-planned
Some of the differences between `fatfs` and the node.js `fs` module are "by design" for architectural simplicity and/or due to underlying FAT limitations.
- There are no `fs.*Sync` methods. (The volume driver is async, not to mention that supporting a separate \*Sync codepath would be an enormous duplication of effort of dubious value.)
- This module does [almost] no read/write caching. This should be done in your volume driver, but see notes below.
- You'll need multiple `createFileSystem` instances for multiple volumes; paths are relative to each, and don't share a namespace.
- The FAT filesystem has no concept of symlinks, and hardlinks are not really an intentional feature. You will get an ENOSYS-like error when trying to create either type of link.
## "Volume driver" API
To use 'fatfs', you must provide a driver object with the following properties/methods:
- `driver.sectorSize` — number of bytes per sector on this device
- `driver.numSectors` — count of sectors available on this media
- `driver.readSectors(i, dest, cb)` — Fill `dest` with data starting at the `i`th sector and notify `cb(e)` when finished. You may assume `dest.length` is a multiple of `driver.sectorSize`.
- `driver.writeSectors(i, data, cb)` — (optional) Write `data` starting at the `i`th sector and notify `cb(e)` when finished. You may assume `data.length` is a multiple of `driver.sectorSize`.
If you do not provide a `writeSectors` method, then `fatfs` will work in readonly mode. Pretty simple, eh? And the 'fatfs' module makes a good effort to check the parameters passed to your driver methods!
**TBD:** to facilitate proper cache handling, this module might add an optional `driver.flush(cb)` method at some point in the future.
Here's an example taken from code used to run this module's own tests:
```js
// NOTE: this assumes image at `path` has no partition table.
// If it did, you'd need to translate positions, natch…
var fs = require('fs')
exports.createDriverSync = function (path, opts) {
opts || (opts = {})
var secSize = 512,
ro = opts.readOnly || false,
fd = fs.openSync(path, ro ? 'r' : 'r+'),
s = fs.fstatSync(fd)
return {
sectorSize: secSize,
numSectors: s.size / secSize,
readSectors: function (i, dest, cb) {
if (dest.length % secSize) throw Error('Unexpected buffer length!')
fs.read(fd, dest, 0, dest.length, i * secSize, function (e, n, d) {
cb(e, d)
})
},
writeSectors: ro
? null
: function (i, data, cb) {
if (data.length % secSize) throw Error('Unexpected buffer length!')
fs.write(fd, data, 0, data.length, i * secSize, function (e) {
cb(e)
})
},
}
}
```
## License
© 2014 Nathan Vander Wilt.
Funding for this work was provided by Technical Machine, Inc.
Reuse under your choice of:
- [BSD-2-Clause](http://opensource.org/licenses/BSD-2-Clause)
- [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)

60
@vates/fatfs/cache.js Normal file
View File

@@ -0,0 +1,60 @@
var _ = require("./helpers.js");
exports.wrapDriver = function (volume, opts) {
opts = _.extend({
maxSectors: 2048
}, opts);
var cache = {},
advice = 'NORMAL',
secSize = volume.sectorSize;
function _freezeBuffer(b) {
var f = _.allocBuffer(b.length);
b.copy(f);
return f;
}
function addToCache(i, data) {
if (advice === 'SEQUENTIAL' || advice === 'NOREUSE') return;
data = _freezeBuffer(data);
cache[i] = data;
//if (data.length > secSize) addToCache(i+1, data.slice(secSize));
while (data.length > secSize) {
data = data.slice(secSize);
cache[++i] = data;
}
// simple highest-sectors-lose eviction policy for now
Object.keys(cache).sort().slice(opts.maxSectors).forEach(function (x) {
delete cache[x];
});
_.log(_.log.DBG, "Cache now contains:", Object.keys(cache).join(','));
}
return {
sectorSize: volume.sectorSize,
numSectors: volume.numSectors,
advice: function (val) {
if (!arguments.length) return advice;
else advice = val;
if (advice === 'SEQUENTIAL' || advice === 'NOREUSE') cache = {};
return this;
},
readSectors: function (i, dest, cb) {
// TODO: handle having partial parts of dest!
if (i in cache && dest.length === secSize) {
cache[i].copy(dest);
setImmediate(cb);
} else volume.readSectors(i, dest, function (e) {
if (e) cb(e);
else addToCache(i, dest), cb();
});
},
writeSectors: (!volume.writeSectors) ? null : function (i, data, cb) {
volume.writeSectors(i, data, function (e) {
if (e) cb(e);
else addToCache(i, data), cb();
});
}
};
};

287
@vates/fatfs/chains.js Normal file
View File

@@ -0,0 +1,287 @@
var S = require("./structs.js"),
_ = require("./helpers.js");
function _baseChain(vol) {
var chain = {};
chain.sectorSize = vol._sectorSize;
function posFromOffset(off) {
var secSize = chain.sectorSize,
offset = off % secSize,
sector = (off - offset) / secSize;
return {sector:sector, offset:offset};
}
var sectorCache = vol._makeCache();
Object.defineProperty(chain, 'cacheAdvice', {
enumerable: true,
get: function () { return sectorCache.advice(); },
set: function (v) { sectorCache.advice(v); }
});
chain._vol_readSectors = vol._readSectors.bind(vol, sectorCache);
chain._vol_writeSectors = vol._writeSectors.bind(vol, sectorCache);
// cb(error, bytesRead, buffer)
chain.readFromPosition = function (targetPos, buffer, cb) {
if (typeof targetPos === 'number') targetPos = posFromOffset(targetPos);
if (typeof buffer === 'number') buffer = _.allocBuffer(buffer);
/* NOTE: to keep our contract with the volume driver, we need to read on _full_ sector boundaries!
So we divide the read into [up to] three parts: {preface, main, trailer}
This is kind of unfortunate, but in practice should often still be reasonably efficient. */
if (targetPos.offset) chain.readSectors(targetPos.sector, _.allocBuffer(chain.sectorSize), function (e,d) {
if (e || !d) cb(e, 0, buffer);
else { // copy preface into `buffer`
var dBeg = targetPos.offset,
dEnd = dBeg + buffer.length;
d.copy(buffer, 0, dBeg, dEnd);
if (dEnd > d.length) readMain();
else cb(null, buffer.length, buffer);
}
}); else readMain();
function readMain() {
var prefaceLen = targetPos.offset && (chain.sectorSize - targetPos.offset),
trailerLen = (buffer.length - prefaceLen) % chain.sectorSize,
mainSector = (prefaceLen) ? targetPos.sector + 1 : targetPos.sector,
mainBuffer = (trailerLen) ? buffer.slice(prefaceLen, -trailerLen) : buffer.slice(prefaceLen);
if (mainBuffer.length) chain.readSectors(mainSector, mainBuffer, function (e,d) {
if (e || !d) cb(e, prefaceLen, buffer);
else if (!trailerLen) cb(null, buffer.length, buffer);
else readTrailer();
}); else readTrailer();
function readTrailer() {
var trailerSector = mainSector + (mainBuffer.length / chain.sectorSize);
chain.readSectors(trailerSector, _.allocBuffer(chain.sectorSize), function (e,d) {
if (e || !d) cb(e, buffer.length-trailerLen, buffer);
else {
d.copy(buffer, buffer.length-trailerLen, 0, trailerLen);
cb(null, buffer.length, buffer);
}
});
}
}
};
// cb(error)
chain.writeToPosition = function (targetPos, data, cb) {
_.log(_.log.DBG, "WRITING", data.length, "bytes at", targetPos, "in", this.toJSON(), data);
if (typeof targetPos === 'number') targetPos = posFromOffset(targetPos);
var prefaceBuffer = (targetPos.offset) ? data.slice(0, chain.sectorSize-targetPos.offset) : null;
if (prefaceBuffer) _modifySector(targetPos.sector, targetPos.offset, prefaceBuffer, function (e) {
if (e) cb(e);
else if (prefaceBuffer.length < data.length) writeMain();
else cb();
}); else writeMain();
function writeMain() {
var prefaceLen = (prefaceBuffer) ? prefaceBuffer.length : 0,
trailerLen = (data.length - prefaceLen) % chain.sectorSize,
mainSector = (prefaceLen) ? targetPos.sector + 1 : targetPos.sector,
mainBuffer = (trailerLen) ? data.slice(prefaceLen, -trailerLen) : data.slice(prefaceLen);
if (mainBuffer.length) chain.writeSectors(mainSector, mainBuffer, function (e) {
if (e) cb(e);
else if (!trailerLen) cb();
else writeTrailer();
}); else writeTrailer();
function writeTrailer() {
var trailerSector = mainSector + (mainBuffer.length / chain.sectorSize),
trailerBuffer = data.slice(data.length-trailerLen); // WORKAROUND: https://github.com/tessel/runtime/issues/721
_modifySector(trailerSector, 0, trailerBuffer, cb);
}
}
function _modifySector(sec, off, data, cb) {
chain.readSectors(sec, _.allocBuffer(chain.sectorSize), function (e, orig) {
if (e) return cb(e);
orig || (orig = _.allocBuffer(chain.sectorSize, 0));
data.copy(orig, off);
chain.writeSectors(sec, orig, cb);
});
}
};
return chain;
};
exports.clusterChain = function (vol, firstCluster, _parent) {
var chain = _baseChain(vol),
cache = [firstCluster];
chain.firstCluster = firstCluster;
function _cacheIsComplete() {
return cache[cache.length-1] === 'eof';
}
function extendCacheToInclude(i, cb) { // NOTE: may `cb()` before returning!
if (i < cache.length) cb(null, cache[i]);
else if (_cacheIsComplete()) cb(null, 'eof');
else vol.fetchFromFAT(cache[cache.length-1], function (e,d) {
if (e) cb(e);
else if (typeof d === 'string' && d !== 'eof') cb(S.err.IO());
else {
cache.push(d);
extendCacheToInclude(i, cb);
}
});
}
function expandChainToLength(clusterCount, cb) {
if (!_cacheIsComplete()) throw Error("Must be called only when cache is complete!");
else cache.pop(); // remove 'eof' entry until finished
function addCluster(clustersNeeded, lastCluster) {
if (!clustersNeeded) cache.push('eof'), cb();
else vol.allocateInFAT(lastCluster, function (e, newCluster) {
if (e) cb(e);
else vol.storeToFAT(lastCluster, newCluster, function (e) {
if (e) return cb(e);
cache.push(newCluster);
addCluster(clustersNeeded-1, newCluster);
});
});
}
addCluster(clusterCount - cache.length, cache[cache.length - 1]);
}
function shrinkChainToLength(clusterCount, cb) {
if (!_cacheIsComplete()) throw Error("Must be called only when cache is complete!");
else cache.pop(); // remove 'eof' entry until finished
function removeClusters(count, cb) {
if (!count) cache.push('eof'), cb();
else vol.storeToFAT(cache.pop(), 'free', function (e) {
if (e) cb(e);
else removeClusters(count - 1, cb);
});
}
// NOTE: for now, we don't remove the firstCluster ourselves; we should though!
if (clusterCount) removeClusters(cache.length - clusterCount, cb);
else removeClusters(cache.length - 1, cb);
}
// [{firstSector,numSectors},{firstSector,numSectors},…]
function determineSectorGroups(sectorIdx, numSectors, alloc, cb) {
var sectorOffset = sectorIdx % vol._sectorsPerCluster,
clusterIdx = (sectorIdx - sectorOffset) / vol._sectorsPerCluster,
numClusters = Math.ceil((numSectors + sectorOffset) / vol._sectorsPerCluster),
chainLength = clusterIdx + numClusters;
extendCacheToInclude(chainLength-1, function (e,c) {
if (e) cb(e);
else if (c === 'eof' && alloc) expandChainToLength(chainLength, function (e) {
if (e) cb(e);
else _determineSectorGroups();
});
else _determineSectorGroups();
});
function _determineSectorGroups() {
// …now we have a complete cache
var groups = [],
_group = null;
for (var i = clusterIdx; i < chainLength; ++i) {
var c = (i < cache.length) ? cache[i] : 'eof';
if (c === 'eof') break;
else if (_group && c !== _group._nextCluster) {
groups.push(_group);
_group = null;
}
if (!_group) _group = {
_nextCluster: c+1,
firstSector: vol._firstSectorOfCluster(c) + sectorOffset,
numSectors: vol._sectorsPerCluster - sectorOffset
}; else {
_group._nextCluster += 1;
_group.numSectors += vol._sectorsPerCluster;
}
sectorOffset = 0; // only first group is offset
}
if (_group) groups.push(_group);
cb(null, groups, i === chainLength);
}
}
chain.readSectors = function (i, dest, cb) {
var groupOffset = 0, groupsPending;
determineSectorGroups(i, dest.length / chain.sectorSize, false, function (e, groups, complete) {
if (e) cb(e);
else if (!complete) groupsPending = -1, _pastEOF(cb);
else if ((groupsPending = groups.length)) groups.forEach(function (group) {
var groupLength = group.numSectors * chain.sectorSize,
groupBuffer = dest.slice(groupOffset, groupOffset += groupLength);
chain._vol_readSectors(group.firstSector, groupBuffer, function (e,d) {
if (e && groupsPending !== -1) groupsPending = -1, cb(e);
else if (--groupsPending === 0) cb(null, dest);
});
});
else cb(null, dest); // 0-length destination case
});
};
// TODO: does this handle NOSPC condition?
chain.writeSectors = function (i, data, cb) {
var groupOffset = 0, groupsPending;
determineSectorGroups(i, data.length / chain.sectorSize, true, function (e, groups) {
if (e) cb(e);
else if ((groupsPending = groups.length)) groups.forEach(function (group) {
var groupLength = group.numSectors * chain.sectorSize,
groupBuffer = data.slice(groupOffset, groupOffset += groupLength);
chain._vol_writeSectors(group.firstSector, groupBuffer, function (e) {
if (e && groupsPending !== -1) groupsPending = -1, cb(e);
else if (--groupsPending === 0) cb();
});
});
else cb(); // 0-length data case
});
};
chain.truncate = function (numSectors, cb) {
extendCacheToInclude(Infinity, function (e,c) {
if (e) return cb(e);
var currentLength = cache.length-1,
clustersNeeded = Math.ceil(numSectors / vol._sectorsPerCluster);
if (clustersNeeded < currentLength) shrinkChainToLength(clustersNeeded, cb);
else if (clustersNeeded > currentLength) expandChainToLength(clustersNeeded, cb);
else cb();
});
};
chain.toJSON = function () {
return {firstCluster:firstCluster};
};
return chain;
};
exports.sectorChain = function (vol, firstSector, numSectors) {
var chain = _baseChain(vol);
chain.firstSector = firstSector;
chain.numSectors = numSectors;
chain.readSectors = function (i, dest, cb) {
if (i < numSectors) chain._vol_readSectors(firstSector+i, dest, cb);
else _pastEOF(cb);
};
chain.writeSectors = function (i, data, cb) {
if (i < numSectors) chain._vol_writeSectors(firstSector+i, data, cb);
else _.delayedCall(cb, S.err.NOSPC());
};
chain.truncate = function (i, cb) {
_.delayedCall(cb, S.err.INVAL());
};
chain.toJSON = function () {
return {firstSector:firstSector, numSectors:numSectors};
};
return chain;
};
// NOTE: used with mixed feelings, broken out to mark uses
function _pastEOF(cb) { _.delayedCall(cb, null, null); }

372
@vates/fatfs/dir.js Normal file
View File

@@ -0,0 +1,372 @@
var S = require("./structs.js"),
_ = require("./helpers.js");
var dir = exports;
dir.iterator = function (dirChain, opts) {
opts || (opts = {});
var cache = {buffer:null, n: null};
function getSectorBuffer(n, cb) {
if (cache.n === n) cb(null, cache.buffer);
else cache.n = cache.buffer = null, dirChain.readSectors(n, _.allocBuffer(dirChain.sectorSize), function (e,d) {
if (e) cb(e);
else if (!d) return cb(null, null);
else {
cache.n = n;
cache.buffer = d;
getSectorBuffer(n, cb);
}
});
}
var secIdx = 0,
off = {bytes:0},
long = null;
function getNextEntry(cb) {
if (off.bytes >= dirChain.sectorSize) {
secIdx += 1;
off.bytes -= dirChain.sectorSize;
}
var entryPos = {chain:dirChain, sector:secIdx, offset:off.bytes};
getSectorBuffer(secIdx, function (e, buf) {
if (e) return cb(S.err.IO());
else if (!buf) return cb(null, null, entryPos);
var entryIdx = off.bytes,
signalByte = buf[entryIdx];
if (signalByte === S.entryDoneFlag) return cb(null, null, entryPos);
else if (signalByte === S.entryFreeFlag) {
off.bytes += S.dirEntry.size;
long = null;
if (opts.includeFree) return cb(null, {_free:true,_pos:entryPos}, entryPos);
else return getNextEntry(cb); // usually just skip these
}
var attrByte = buf[entryIdx+S.dirEntry.fields.Attr.offset],
entryType = (attrByte === S.longDirFlag) ? S.longDirEntry : S.dirEntry_simple;
var entry = entryType.valueFromBytes(buf, off);
entry._pos = entryPos;
_.log(_.log.DBG, "entry:", entry, secIdx, entryIdx);
if (entryType === S.longDirEntry) {
var firstEntry;
if (entry.Ord & S.lastLongFlag) {
firstEntry = true;
entry.Ord &= ~S.lastLongFlag;
long = {
name: -1,
sum: entry.Chksum,
_rem: entry.Ord-1,
_arr: []
}
}
if (firstEntry || long && entry.Chksum === long.sum && entry.Ord === long._rem--) {
var S_lde_f = S.longDirEntry.fields,
namepart = entry.Name1;
if (entry.Name1.length === S_lde_f.Name1.size/2) {
namepart += entry.Name2;
if (entry.Name2.length === S_lde_f.Name2.size/2) {
namepart += entry.Name3;
}
}
long._arr.push(namepart);
if (!long._rem) {
long.name = long._arr.reverse().join('');
delete long._arr;
delete long._rem;
}
} else long = null;
} else if ((attrByte & 0x08) === 0) { // NOTE: checks `!entry.Attr.volume_id`
var bestName = null;
if (long && long.name) {
var pos = entryIdx + S.dirEntry.fields['Name'].offset,
sum = _.checksumName(buf, pos);
if (sum === long.sum) bestName = long.name;
}
if (!bestName) {
if (signalByte === S.entryIsE5Flag) entry.Name.filename = '\u00E5'+entry.Name.filename.slice(1);
var nam = entry.Name.filename.replace(/ +$/, ''),
ext = entry.Name.extension.replace(/ +$/, '');
// TODO: lowercase bits http://en.wikipedia.org/wiki/8.3_filename#Compatibility
// via NTRes, bits 0x08 and 0x10 http://www.fdos.org/kernel/fatplus.txt.1
bestName = (ext) ? nam+'.'+ext : nam;
}
entry._name = bestName;
// OPTIMIZATION: avoid processing any fields for non-matching entries
// TODO: we could make this automatic via getters, but…?
var _entryBuffer = buf.slice(off.bytes-S.dirEntry.size, off.bytes);
entry._full = function () {
var _entry = S.dirEntry.valueFromBytes(_entryBuffer);
_.extend(entry, _entry);
entry._size = entry.FileSize;
entry._firstCluster = (entry.FstClusHI << 16) + entry.FstClusLO;
return entry;
};
long = null;
return cb(null, entry, entryPos);
} else long = null;
getNextEntry(cb);
});
}
function iter(cb) {
getNextEntry(cb);
return iter; // TODO: previous value can't be re-used, so why make caller re-assign?
}
return iter;
};
function _updateEntry(vol, entry, newStats) {
if ('size' in newStats) entry._size = entry.FileSize = newStats.size;
if ('_touch' in newStats) newStats.archive = newStats.atime = newStats.mtime = true;
if ('archive' in newStats) entry.Attr.archive = true; // TODO: also via newStats.mode?
var _now;
function applyDate(d, prefix, timeToo, tenthToo) {
if (d === true) d = _now || (_now = new Date());
entry[prefix+'Date'] = {year:d.getFullYear()-1980, month:d.getMonth()+1, day:d.getDate()};
if (timeToo) {
entry[prefix+'Time'] = {hours:d.getHours(), minutes:d.getMinutes(), seconds_2:d.getSeconds()>>>1};
if (tenthToo) {
var msec = (d.getSeconds() % 2)*1000 + d.getMilliseconds();
entry[prefix+'TimeTenth'] = Math.floor(msec / 100);
}
}
}
if ('ctime' in newStats) applyDate(newStats.ctime, 'Crt', true, true);
if ('mtime' in newStats) applyDate(newStats.mtime, 'Wrt', true);
if ('atime' in newStats) applyDate(newStats.atime, 'LstAcc');
if ('mode' in newStats) {
entry.Attr.directory = (newStats.mode & S._I.FDIR) ? true : false;
entry.Attr.volume_id = (newStats.mode & S._I.FREG) ? false : true;
if (vol.opts.modmode === 0111) {
entry.Attr.archive = (newStats.mode & S._I.XUSR) ? true : false;
entry.Attr.system = (newStats.mode & S._I.XGRP) ? true : false;
entry.Attr.hidden = (newStats.mode & S._I.XOTH) ? true : false;
entry.Attr.readonly = (newStats.mode & S._I.WUSR) ? false : true;
} else if (vol.opts.modmode === 07000) {
entry.Attr.archive = (newStats.mode & S._I.SVTX) ? true : false;
entry.Attr.system = (newStats.mode & S._I.SGID) ? true : false;
entry.Attr.hidden = (newStats.mode & S._I.SUID) ? true : false;
entry.Attr.readonly = (
newStats.mode & S._I.WUSR ||
newStats.mode & S._I.WGRP ||
newStats.mode & S._I.WOTH
) ? false : true;
}
}
if ('firstCluster' in newStats) {
entry.FstClusLO = newStats.firstCluster & 0xFFFF;
entry.FstClusHI = newStats.firstCluster >>> 16;
entry._firstCluster = newStats.firstCluster;
}
return entry;
}
dir.makeStat = function (vol, entry) {
var stats = {}; // TODO: return an actual `instanceof fs.Stat` somehow?
stats.isFile = function () {
return (!entry.Attr.volume_id && !entry.Attr.directory);
};
stats.isDirectory = function () {
return entry.Attr.directory;
};
stats.isBlockDevice = function () { return false; }
stats.isCharacterDevice = function () { return false; }
stats.isSymbolicLink = function () { return false; }
stats.isFIFO = function () { return false; }
stats.isSocket = function () { return false; }
stats.size = entry.FileSize;
stats.blksize = vol._sectorsPerCluster*vol._sectorSize;
stats.blocks = Math.ceil(stats.size / stats.blksize) || 1;
stats.nlink = 1;
stats.mode = S._I.RUSR | S._I.RGRP | S._I.ROTH;
if (!entry.Attr.readonly) stats.mode |= S._I.WUSR | S._I.WGRP | S._I.WOTH;
if (entry.Attr.directory) stats.mode |= S._I.FDIR;
else if (!entry.Attr.volume_id) stats.mode |= S._I.FREG;
// NOTE: discussion at https://github.com/natevw/fatfs/issues/7
if (vol.opts.modmode === 0111) {
// expose using executable bits, like Samba
if (entry.Attr.archive) stats.mode |= S._I.XUSR;
if (entry.Attr.system) stats.mode |= S._I.XGRP;
if (entry.Attr.hidden) stats.mode |= S._I.XOTH;
} else if (vol.opts.modmode === 07000) {
// expose using setXid/sticky bits, like MKS
if (entry.Attr.archive) stats.mode |= S._I.SVTX;
if (entry.Attr.system) stats.mode |= S._I.SGID;
if (entry.Attr.hidden) stats.mode |= S._I.SUID;
}
stats.mode &= ~vol.opts.umask;
stats.uid = vol.opts.uid;
stats.gid = vol.opts.gid;
function extractDate(prefix) {
var date = entry[prefix+'Date'],
time = entry[prefix+'Time'] || {hours:0, minutes:0, seconds_2:0},
secs = time.seconds_2 * 2,
sect = entry[prefix+'TimeTenth'] || 0;
if (sect > 100) {
secs += 1;
sect -= 100;
}
return new Date(date.year+1980, date.month-1, date.day, time.hours, time.minutes, secs, sect*100);
}
stats.atime = extractDate('LstAcc');
stats.mtime = extractDate('Wrt');
stats.ctime = extractDate('Crt');
entry = { // keep immutable copy (with only the fields we need)
Attr: _.extend({},entry.Attr),
};
return stats;
};
dir.init = function (vol, dirInfo, cb) {
var dirChain = dirInfo.chain,
isRootDir = ('numSectors' in dirChain), // HACK: all others would be a clusterChain
initialCluster = _.allocBuffer(dirChain.sectorSize*vol._sectorsPerCluster),
entriesOffset = {bytes:0};
initialCluster.fill(0);
function writeEntry(name, clusterNum) {
while (name.length < 8) name += " ";
S.dirEntry.bytesFromValue(_updateEntry(vol, {
Name: {filename:name, extension:" "},
Attr: {directory:true}
}, {firstCluster:clusterNum, _touch:true,ctime:true}), initialCluster, entriesOffset);
}
if (!isRootDir) {
writeEntry(".", dirChain.firstCluster);
writeEntry("..", dirInfo.parent.chain.firstCluster);
};
dirChain.writeToPosition(0, initialCluster, cb);
};
dir.addFile = function (vol, dirChain, entryInfo, opts, cb) {
if (typeof opts === 'function') {
cb = opts;
opts = {};
}
var name = entryInfo.name,
entries = [], mainEntry;
entries.push(mainEntry = {
Name: _.shortname(name),
Attr: {directory:opts.dir||false},
_name: name
});
if (1 || mainEntry.Name._lossy) { // HACK: always write long names until `._lossy` is more useful!
var workaroundTessel427 = ('\uFFFF'.length !== 1);
if (workaroundTessel427) throw Error("Your JS runtime does not have proper Unicode string support. (If Tessel, is your firmware up-to-date?)");
// name entries should be 0x0000-terminated and 0xFFFF-filled
var S_lde_f = S.longDirEntry.fields,
ENTRY_CHUNK_LEN = (S_lde_f.Name1.size + S_lde_f.Name2.size + S_lde_f.Name3.size)/2,
partialLen = name.length % ENTRY_CHUNK_LEN,
paddingNeeded = partialLen && (ENTRY_CHUNK_LEN - partialLen);
if (paddingNeeded--) name += '\u0000';
while (paddingNeeded-- > 0) name += '\uFFFF';
// now fill in as many entries as it takes
var off = 0,
ord = 1;
while (off < name.length) entries.push({
Ord: ord++,
Name1: name.slice(off, off+=S_lde_f.Name1.size/2),
Attr_raw: S.longDirFlag,
Chksum: null,
Name2: name.slice(off, off+=S_lde_f.Name2.size/2),
Name3: name.slice(off, off+=S_lde_f.Name3.size/2)
});
entries[entries.length - 1].Ord |= S.lastLongFlag;
}
if (entryInfo.tail) {
var name = mainEntry.Name.filename,
suffix = '~'+entryInfo.tail,
endIdx = name.indexOf(' '),
sufIdx = (~endIdx) ? Math.min(endIdx, name.length-suffix.length) : name.length-suffix.length;
if (sufIdx < 0) return cb(S.err.NAMETOOLONG()); // TODO: would EXIST be more correct?
mainEntry.Name.filename = name.slice(0,sufIdx)+suffix+name.slice(sufIdx+suffix.length);
_.log(_.log.DBG, "Shortname amended to:", mainEntry.Name);
}
vol.allocateInFAT(dirChain.firstCluster || 2, function (e,fileCluster) {
if (e) return cb(e);
var nameBuf = S.dirEntry.fields['Name'].bytesFromValue(mainEntry.Name),
nameSum = _.checksumName(nameBuf);
// TODO: finalize initial properties… (via `opts.mode` instead?)
_updateEntry(vol, mainEntry, {firstCluster:fileCluster, size:0, ctime:true,_touch:true});
mainEntry._pos = _.adjustedPos(vol, entryInfo.target, S.dirEntry.size*(entries.length-1));
entries.slice(1).forEach(function (entry) {
entry.Chksum = nameSum;
});
entries.reverse();
if (entryInfo.lastEntry) entries.push({});
var entriesData = _.allocBuffer(S.dirEntry.size*entries.length),
dataOffset = {bytes:0};
entries.forEach(function (entry) {
var entryType = ('Ord' in entry) ? S.longDirEntry : S.dirEntry;
entryType.bytesFromValue(entry, entriesData, dataOffset);
});
_.log(_.log.DBG, "Writing", entriesData.length, "byte directory entry", mainEntry, "into", dirChain.toJSON(), "at", entryInfo.target);
dirChain.writeToPosition(entryInfo.target, entriesData, function (e) {
// TODO: if we get error, what/should we clean up?
if (e) cb(e);
else cb(null, mainEntry, vol.chainForCluster(fileCluster, dirChain));
});
});
};
dir.findInDirectory = function (vol, dirChain, name, opts, cb) {
var matchName = name.toUpperCase(),
tailName = (opts.prepareForCreate) ? _.shortname(name) : null,
maxTail = 0;
function processNext(next) {
next = next(function (e, d, entryPos) {
if (e) cb(e);
else if (!d) cb(S.err.NOENT(), {tail:maxTail, target:entryPos, lastEntry:true});
else if (d._free) processNext(next); // TODO: look for long enough reusable run
else if (d._name.toUpperCase() === matchName) return cb(null, d._full());
else if (!opts.prepareForCreate) processNext(next);
else {
var dNum = 1,
dName = d.Name.filename,
dTail = dName.match(/(.*)~(\d+)/);
if (dTail) {
dNum = +dTail[2];
dName = dTail[1];
}
if (tailName.extension === d.Name.extension &&
tailName.filename.indexOf(dName) === 0)
{
maxTail = Math.max(dNum+1, maxTail);
}
processNext(next);
}
});
}
processNext(dir.iterator(dirChain, {includeFree:(0 && opts.prepareForCreate)}));
};
dir.updateEntry = function (vol, entry, newStats, cb) {
if (!entry._pos || !entry._pos.chain) throw Error("Entry source unknown!");
var entryPos = entry._pos,
newEntry = _updateEntry(vol, entry, newStats),
data = S.dirEntry.bytesFromValue(newEntry);
_.log(_.log.DBG, "UPDATING ENTRY", newStats, newEntry, entryPos, data);
// TODO: if write fails, then entry becomes corrupt!
entryPos.chain.writeToPosition(entryPos, data, cb);
};

206
@vates/fatfs/helpers.js Normal file
View File

@@ -0,0 +1,206 @@
var S = require("./structs.js"),
_xok = require('xok');
// ponyfills for older node.js
exports.allocBuffer = Buffer.alloc || function (len, val) {
var b = Buffer(len);
if (arguments.length > 1) b.fill(val);
return b;
};
exports.bufferFrom = Buffer.from || function (arg0, arg1) {
return (arguments.length > 1) ? Buffer(arg0, arg1) : Buffer(arg0);
};
// flag for WORKAROUND: https://github.com/tessel/beta/issues/380
exports.workaroundTessel380 = !Buffer.from && function () {
var b = Buffer([0]),
s = b.slice(0);
return ((s[0] = 0xFF) !== b[0]);
}();
// WORKAROUND: https://github.com/tessel/beta/issues/433
var oldslice;
if (!Buffer.alloc && Buffer(5).slice(10).length < 0) oldslice = Buffer.prototype.slice, Buffer.prototype.slice = function (s, e) {
if (s > this.length) s = this.length;
// ~WORKAROUND: https://github.com/tessel/beta/issues/434
return (arguments.length > 1) ? oldslice.call(this, s, e) : oldslice.call(this, s);
}
exports.absoluteSteps = function (path) {
var steps = [];
path.split('/').forEach(function (str) {
// NOTE: these should actually be fine, just wasteful…
if (str === '..') steps.pop();
else if (str && str !== '.') steps.push(str);
});
return steps.map(exports.longname);
};
exports.absolutePath = function (path) {
return '/'+exports.absoluteSteps(path).join('/');
};
exports.parseFlags = function (flags) {
// read, write, append, create, truncate, exclusive
var info, _dir; // NOTE: there might be more clever ways to "parse", but…
if (flags[0] === '\\') {
// internal flag used internally to `fs.open` directories without `S.err.ISDIR()`
flags = flags.slice(1);
_dir = true;
}
switch (flags) {
case 'r': info = {read:true, write:false, create:false}; break;
case 'r+': info = {read:true, write:true, create:false}; break;
case 'rs': info = {read:true, write:false, create:false, sync:true}; break;
case 'rs+': info = {read:true, write:true, create:false, sync:true}; break;
case 'w': info = {read:false, write:true, create:true, truncate:true}; break;
case 'wx': info = {read:false, write:true, create:true, exclusive:true}; break;
case 'w+': info = {read:true, write:true, create:true, truncate:true}; break;
case 'wx+': info = {read:true, write:true, create:true, exclusive:true}; break;
case 'a': info = {read:false, write:true, create:true, append:true}; break;
case 'ax': info = {read:false, write:true, create:true, append:true, exclusive:true}; break;
case 'a+': info = {read:true, write:true, create:true, append:true}; break;
case 'ax+': info = {read:true, write:true, create:true, append:true, exclusive:true}; break;
default: throw Error("Uknown mode: "+flags); // TODO: throw as `S.err.INVAL`
}
if (info.sync) throw Error("Mode not implemented."); // TODO: what would this require of us?
if (_dir) info._openDir = true;
return info;
};
// TODO: these are great candidates for special test coverage!
var _snInvalid = /[^A-Z0-9$%'-_@~`!(){}^#&.]/g; // NOTE: '.' is not valid but we split it away
exports.shortname = function (name) {
var lossy = false;
// TODO: support preservation of case for otherwise non-lossy name!
name = name.toUpperCase().replace(/ /g, '').replace(/^\.+/, '');
name = name.replace(_snInvalid, function () {
lossy = true;
return '_';
});
var parts = name.split('.'),
basis3 = parts.pop(),
basis8 = parts.join('');
if (!parts.length) {
basis8 = basis3;
basis3 = ' ';
}
if (basis8.length > 8) {
basis8 = basis8.slice(0,8);
// NOTE: technically, spec's "lossy conversion" flag is NOT set by excess length.
// But since lossy conversion and truncated names both need a numeric tail…
lossy = true;
} else while (basis8.length < 8) basis8 += ' ';
if (basis3.length > 3) {
basis3 = basis3.slice(0,3);
lossy = true;
} else while (basis3.length < 3) basis3 += ' ';
return {filename:basis8, extension:basis3, _lossy:lossy};
return {basis:[basis8,basis3], lossy:lossy};
};
//shortname("autoexec.bat") => {basis:['AUTOEXEC','BAT'],lossy:false}
//shortname("autoexecutable.batch") => {basis:['AUTOEXEC','BAT'],lossy:true}
// TODO: OS X stores `shortname("._.Trashes")` as ['~1', 'TRA'] — should we?
var _lnInvalid = /[^a-zA-Z0-9$%'-_@~`!(){}^#&.+,;=[\] ]/g;
exports.longname = function (name) {
name = name.trim().replace(/\.+$/, '').replace(_lnInvalid, function (c) {
if (c.length > 1) throw Error("Internal problem: unexpected match length!");
if (c.charCodeAt(0) > 127) return c;
else throw Error("Invalid character "+JSON.stringify(c)+" in name.");
lossy = true;
return '_';
});
if (name.length > 255) throw Error("Name is too long.");
return name;
};
function nameChkSum(sum, c) {
return ((sum & 1) ? 0x80 : 0) + (sum >>> 1) + c & 0xFF;
}
// WORKAROUND: https://github.com/tessel/beta/issues/335
function reduceBuffer(buf, start, end, fn, res) {
// NOTE: does not handle missing `res` like Array.prototype.reduce would
for (var i = start; i < end; ++i) {
res = fn(res, buf[i]);
}
return res;
}
exports.checksumName = function (buf,off) {
off || (off = 0);
var len = S.dirEntry.fields['Name'].size;
return reduceBuffer(buf, off, off+len, nameChkSum, 0);
};
/* comparing C rounding trick from FAT spec with Math.ceil
function tryBoth(d) {
var a = ((D.RootEntCnt * 32) + (D.BytsPerSec - 1)) / D.BytsPerSec >>> 0,
b = Math.ceil((D.RootEntCnt * 32) / D.BytsPerSec);
if (b !== a) console.log("try", b, a, (b === a) ? '' : '*');
return (b === a);
}
// BytsPerSec — "may take on only the following values: 512, 1024, 2048 or 4096"
[512, 1024, 2048, 4096].forEach(function (bps) {
// RootEntCnt — "a count that when multiplied by 32 results in an even multiple of BPB_BytsPerSec"
for (var evenMultiplier = 0; evenMultiplier < 1024*1024*16; evenMultiplier += 2) {
var rec = (bps * evenMultiplier) / 32;
tryBoth({RootEntCnt:rec, BytsPerSec:bps});
}
});
*/
exports.fmtHex = function (n, ff) {
return (1+ff+n).toString(16).slice(1);
};
exports.delayedCall = function (fn) {
if (!fn) throw Error("No function provided!"); // debug aid
var ctx = this,
args = Array.prototype.slice.call(arguments, 1);
setImmediate(function () {
fn.apply(ctx, args);
});
};
exports.adjustedPos = function (vol, pos, bytes) {
var _pos = {
chain: pos.chain,
sector: pos.sector,
offset: pos.offset + bytes
}, secSize = vol._sectorSize;
while (_pos.offset >= secSize) {
_pos.sector += 1;
_pos.offset -= secSize;
}
return _pos;
};
exports.extend = _xok;
var _prevDbg = Date.now(),
_thresh = 50;
function log(level) {
if (level < log.level) return;
var now = Date.now(),
diff = now - _prevDbg;
arguments[0] = ((diff < _thresh) ? " " : '') + diff.toFixed(0) + "ms";
console.log.apply(console, arguments);
_prevDbg = now;
}
log.DBG = -4;
log.INFO = -3;
log.WARN = -2;
log.ERR = -1;
log.level = log.WARN;
exports.log = log;

View File

@@ -0,0 +1,25 @@
var fs = require('fs');
exports.createDriverSync = function (path, opts) {
opts || (opts = {});
var secSize = 512,
ro = opts.readOnly || false,
fd = fs.openSync(path, (ro) ? 'r' : 'r+'),
s = fs.fstatSync(fd);
return {
sectorSize: secSize,
numSectors: s.size / secSize,
readSectors: function (i, dest, cb) {
fs.read(fd, dest, 0, dest.length, i*secSize, function (e,n,d) {
cb(e,d);
});
},
writeSectors: (ro) ? null : function (i, data, cb) {
fs.write(fd, data, 0, data.length, i*secSize, function (e) {
cb(e);
});
}
};
};

771
@vates/fatfs/index.js Normal file
View File

@@ -0,0 +1,771 @@
var events = require('events'),
streams = require('stream'),
fifolock = require('fifolock'),
S = require('./structs.js'),
_ = require('./helpers.js')
//_.log.level = _.log.DBG;
exports.createFileSystem = function (volume, opts, cb) {
if (typeof opts === 'function') {
cb = opts
opts = null
}
opts = _.extend(
{
// c.f. https://www.kernel.org/doc/Documentation/filesystems/vfat.txt
ro: false,
noatime: true,
modmode: 0111, // or `07000`
umask: 'umask' in process ? process.umask() : 0022,
uid: 'getuid' in process ? process.getuid() : 0,
gid: 'getgid' in process ? process.getgid() : 0,
},
opts
)
if (!volume.writeSectors) opts.ro = true
if (opts.ro) opts.noatime = true // natch
var fs = new events.EventEmitter(),
vol = null,
dir = require('./dir.js'),
c = require('./chains.js'),
q = fifolock()
var GROUP =
_.log.level < _.log.INFO
? q.TRANSACTION_WRAPPER.bind({
postAcquire: function (proceed) {
_.log(_.log.DBG, '=== Starting GROUP ===')
proceed()
},
preRelease: function (finish) {
_.log(_.log.DBG, '=== Finishing GROUP ===')
finish()
},
})
: q.TRANSACTION_WRAPPER
q.acquire(function (unlock) {
// because of this, callers can start before 'ready'
var d = _.allocBuffer(volume.sectorSize)
volume.readSectors(0, d, function (e) {
if (e) fs.emit('error', e)
else {
try {
init(d)
} catch (e) {
fs.emit('error', e)
unlock()
return
}
fs.emit('ready')
}
unlock()
})
})
if (cb) fs.on('error', cb).on('ready', cb.bind(null, null))
function init(bootSector) {
vol = require('./vol.js').init(volume, opts, bootSector)
fs._dirIterator = dir.iterator.bind(dir)
var entryInfoByPath = {},
baseEntry = {
_refs: 0,
_record: function () {
entryInfoByPath[this.path] = this
if (this.parent) this.parent.retain()
return this
},
retain: function () {
if (!this._refs) this._record()
this._refs += 1
return this
},
release: function () {
this._refs -= 1
if (!this._refs) this._rescind()
},
_rescind: function () {
if (this.parent) this.parent.release()
delete entryInfoByPath[this.path]
},
}
fs._createSharedEntry = function (path, entry, chain, parent) {
return _.extend(Object.create(baseEntry), {
_refs: 0, // WORKAROUND: https://github.com/tessel/beta/issues/455
path: path,
entry: entry,
chain: chain,
parent: parent,
}).retain()
}
fs._createSharedEntry('/', { Attr: { directory: true } }, vol.rootDirectoryChain)
fs._sharedEntryForSteps = function (steps, opts, cb) {
// NOTE: may `cb` before returning!
var path = steps.join('/') || '/',
name = steps.pop(), // n.b.
info = entryInfoByPath[path]
if (info) cb(null, info.retain())
else
fs._sharedEntryForSteps(steps, {}, function (e, parentInfo) {
// n.b. `steps` don't include `name`
if (e) cb(e)
else if (!parentInfo.entry.Attr.directory) cb(S.err.NOTDIR())
else
dir.findInDirectory(vol, parentInfo.chain, name, opts, function (e, entry) {
if (e && !opts.prepareForCreate) cb(e)
else if (e) cb(e, { missingChild: _.extend(entry, { name: name }), parent: parentInfo })
else cb(null, fs._createSharedEntry(path, entry, vol.chainForCluster(entry._firstCluster), parentInfo))
})
})
}
fs._updateEntry = dir.updateEntry.bind(dir, vol)
fs._makeStat = dir.makeStat.bind(dir, vol)
fs._addFile = dir.addFile.bind(dir, vol)
fs._initDir = dir.init.bind(dir, vol)
}
/**** ---- CORE API ---- ****/
// NOTE: we really don't share namespace, but avoid first three anyway…
var fileDescriptors = [null, null, null]
fs.open = function (path, flags, mode, cb, _n_) {
if (typeof mode === 'function') {
_n_ = cb
cb = mode
mode = 0666
}
cb = GROUP(
cb,
function () {
var _fd = { flags: null, entry: null, chain: null, pos: 0 },
f = _.parseFlags(flags)
if (vol.opts.ro && (f.write || f.create || f.truncate)) return _.delayedCall(cb, S.err.ROFS())
else _fd.flags = f
fs._sharedEntryForSteps(_.absoluteSteps(path), { prepareForCreate: f.create }, function (e, info) {
if (e && !(e.code === 'NOENT' && f.create && info)) cb(e)
else if (e)
fs._addFile(info.parent.chain, info.missingChild, { dir: f._openDir }, function (e, newEntry, newChain) {
if (e) cb(e)
else finish(fs._createSharedEntry(_.absolutePath(path), newEntry, newChain, info.parent))
})
else if (info && f.exclusive) cb(S.err.EXIST())
else if (info.entry.Attr.directory && !f._openDir) cb(S.err.ISDIR())
else if (f.write && info.entry.Attr.readonly) cb(S.err.ACCES())
else finish(info)
function finish(fileInfo) {
var fd = fileDescriptors.push(_fd) - 1
_fd.info = fileInfo
_fd.entry = fileInfo.entry
_fd.chain = fileInfo.chain
if (f.append) _fd.pos = _fd.entry._size
if (f._openDir) _fd.chain.cacheAdvice = 'WILLNEED'
if (f.truncate && _fd.entry._size)
fs.ftruncate(
fd,
0,
function (e) {
cb(e, fd)
},
'_nested_'
)
else _.delayedCall(cb, null, fd) // (delay in case fs._sharedEntryForSteps all cached!)
}
})
},
_n_ === '_nested_'
)
}
fs.fstat = function (fd, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.read) _.delayedCall(cb, S.err.BADF())
else _.delayedCall(cb, null, fs._makeStat(_fd.entry))
},
_n_ === '_nested_'
)
}
fs.futimes = function (fd, atime, mtime, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.write) _.delayedCall(cb, S.err.BADF())
// NOTE: ctime would get touched on POSIX; but we map that to create time!
else fs._updateEntry(_fd.entry, { atime: atime || true, mtime: mtime || true }, cb)
},
_n_ === '_nested_'
)
}
fs.fchmod = function (fd, mode, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.write) _.delayedCall(cb, S.err.BADF())
else {
mode &= S._I._chmoddable
if (_fd.entry.Attr.directory) mode |= S._I.FDIR
else if (!_fd.entry.Attr.volume_id) mode |= S._I.FREG
fs._updateEntry(_fd.entry, { mode: mode }, cb)
}
},
_n_ === '_nested_'
)
}
fs.read = function (fd, buf, off, len, pos, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.read) return _.delayedCall(cb, S.err.BADF())
var _pos = pos === null ? _fd.pos : pos,
_len = Math.min(len, _fd.entry._size - _pos),
_buf = buf.slice(off, off + _len)
_fd.chain.readFromPosition(_pos, _buf, function (e, bytes, slice) {
if (_.workaroundTessel380) _buf.copy(buf, off) // WORKAROUND: https://github.com/tessel/beta/issues/380
_fd.pos = _pos + bytes
if (e || vol.opts.noatime) finish(e)
else fs._updateEntry(_fd.entry, { atime: true }, finish)
function finish(e) {
cb(e, bytes, buf)
}
})
},
_n_ === '_nested_'
)
}
fs._readdir = function (fd, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.read) return _.delayedCall(cb, S.err.BADF())
var entryNames = [],
getNextEntry = fs._dirIterator(_fd.chain)
function processNext() {
getNextEntry(function (e, d) {
if (e) cb(e)
else if (!d && !entryNames.length)
cb(null, entryNames) // WORKAROUND: https://github.com/tessel/beta/issues/435
else if (!d)
cb(null, entryNames.sort()) // NOTE: sort not required, but… [simplifies tests for starters!]
else {
if (d._name !== '.' && d._name !== '..') entryNames.push(d._name)
processNext()
}
})
}
processNext()
},
_n_ === '_nested_'
)
}
fs._mkdir = function (fd, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.write) _.delayedCall(cb, S.err.BADF())
else fs._initDir(_fd.info, cb)
},
_n_ === '_nested_'
)
}
fs.write = function (fd, buf, off, len, pos, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.write) return _.delayedCall(cb, S.err.BADF())
var _pos = pos === null || _fd.flags.append ? _fd.pos : pos,
_buf = buf.slice(off, off + len)
if (_pos > _fd.entry._size) {
// TODO: handle huge jumps by zeroing clusters individually?
var padLen = _pos - _fd.entry._size,
padBuf = _.allocBuffer(padLen + _buf.length)
padBuf.fill(0x00, 0, padLen)
_buf.copy(padBuf, padLen)
_pos = _fd.entry._size
_buf = padBuf
}
_fd.chain.writeToPosition(_pos, _buf, function (e) {
_fd.pos = _pos + len
var newSize = Math.max(_fd.entry._size, _fd.pos),
newInfo = { size: newSize, _touch: true }
fs._updateEntry(_fd.entry, newInfo, function (ee) {
cb(e || ee, len, buf)
})
})
},
_n_ === '_nested_'
)
}
fs.ftruncate = function (fd, len, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.write) return _.delayedCall(cb, S.err.BADF())
var newStats = { size: len, _touch: true }
// NOTE: we order operations for best state in case of only partial success
if (len === _fd.entry._size) _.delayedCall(cb)
else if (len < _fd.entry._size)
fs._updateEntry(_fd.entry, newStats, function (e) {
if (e) cb(e)
else _fd.chain.truncate(Math.ceil(len / _fd.chain.sectorSize), cb)
})
// TODO: handle huge file expansions without as much memory pressure
else
_fd.chain.writeToPosition(_fd.entry._size, _.allocBuffer(len - _fd.entry._size, 0x00), function (e) {
if (e) cb(e)
else fs._updateEntry(_fd.entry, newStats, cb)
})
},
_n_ === '_nested_'
)
}
// 'NORMAL', 'SEQUENTIAL', 'RANDOM', 'WILLNEED', 'DONTNEED', 'NOREUSE'
fs._fadviseSync = function (fd, off, len, advice) {
if (off !== 0 || len !== 0) throw Error('Cache advise can currently be given only for whole file!')
var _fd = fileDescriptors[fd]
if (!_fd) throw S.err.BADF()
else _fd.chain.cacheAdvice = advice
}
fs.fsync = function (fd, cb) {
// NOTE: we'll need to flush write cache here once we have one…
var _fd = fileDescriptors[fd]
if (!_fd) _.delayedCall(cb, S.err.BADF())
else _.delayedCall(cb)
}
fs.close = function (fd, cb) {
var _fd = fileDescriptors[fd]
if (!_fd) _.delayedCall(cb, S.err.BADF())
else setTimeout(_fd.info.release.bind(_fd.info), 500), _.delayedCall(cb, (fileDescriptors[fd] = null))
}
/* STREAM WRAPPERS */
var workaroundTessel436
try {
new require('stream').Readable({ encoding: 'utf8' })
new streams.Readable({ encoding: 'utf8' })
} catch (e) {
workaroundTessel436 = true
}
function _createStream(StreamType, path, opts) {
// [NOT REALLY A] WORKAROUND: https://github.com/tessel/beta/issues/436
if (workaroundTessel436 && 'encoding' in opts) {
console.warn('Tessel does not currently support encoding option for Readable streams, discarding!')
delete opts.encoding
}
var fd = opts.fd !== null ? opts.fd : '_opening_',
pos = opts.start,
stream = new StreamType(opts)
if (fd === '_opening_')
fs.open(path, opts.flags, opts.mode, function (e, _fd) {
if (e) {
fd = '_open_error_'
stream.emit('error', e)
} else {
fd = _fd
fs._fadviseSync(fd, 0, 0, 'SEQUENTIAL')
stream.emit('open', fd)
}
})
function autoClose(tombstone) {
// NOTE: assumes caller will clear `fd`
if (opts.autoClose)
fs.close(fd, function (e) {
if (e) stream.emit('error', e)
else stream.emit('close')
})
fd = tombstone
}
if (StreamType === streams.Readable) {
stream._read = function (n) {
var buf
// TODO: optimize to fetch at least a full sector regardless of `n`…
n = Math.min(n, opts.end - pos)
if (fd === '_opening_')
stream.once('open', function () {
stream._read(n)
})
else if (pos > opts.end) stream.push(null)
else if (n > 0)
(buf = _.allocBuffer(n)),
fs.read(fd, buf, 0, n, pos, function (e, n, d) {
if (e) {
autoClose('_read_error_')
stream.emit('error', e)
} else stream.push(n ? d.slice(0, n) : null)
}),
(pos += n)
else stream.push(null)
}
stream.once('end', function () {
autoClose('_ended_')
})
} else if (StreamType === streams.Writable) {
stream.bytesWritten = 0
stream._write = function (data, _enc, cb) {
if (fd === '_opening_')
stream.once('open', function () {
stream._write(data, null, cb)
})
else
fs.write(fd, data, 0, data.length, pos, function (e, n) {
if (e) {
autoClose('_write_error_')
cb(e)
} else {
stream.bytesWritten += n
cb()
}
}),
(pos += data.length)
}
stream.once('finish', function () {
autoClose('_finished_')
})
}
return stream
}
fs.createReadStream = function (path, opts) {
return _createStream(
streams.Readable,
path,
_.extend(
{
start: 0,
end: Infinity,
flags: 'r',
mode: 0666,
encoding: null,
fd: null, // ??? see https://github.com/joyent/node/issues/7708
autoClose: true,
},
opts
)
)
}
fs.createWriteStream = function (path, opts) {
return _createStream(
streams.Writable,
path,
_.extend(
{
start: 0,
flags: 'w',
mode: 0666,
//encoding: null, // see https://github.com/joyent/node/issues/7710
fd: null, // ??? see https://github.com/joyent/node/issues/7708
autoClose: true,
},
opts,
{ decodeStrings: true, objectMode: false }
)
)
}
/* PATH WRAPPERS (albeit the only public interface for some folder operations) */
function _fdOperation(path, opts, fn, cb) {
cb = GROUP(cb, function () {
opts.advice || (opts.advice = 'NORMAL')
fs.open(
path,
opts.flag,
function (e, fd) {
if (e) cb(e)
else
fs._fadviseSync(fd, 0, 0, opts.advice),
fn(fd, function () {
var ctx = this,
args = arguments
fs.close(
fd,
function (closeErr) {
cb.apply(ctx, args)
},
'_nested_'
)
})
},
'_nested_'
)
})
}
fs.stat = fs.lstat = function (path, cb) {
_fdOperation(
path,
{ flag: 'r' },
function (fd, cb) {
fs.fstat(fd, cb, '_nested_')
},
cb
)
}
fs.exists = function (path, cb) {
fs.stat(path, function (err) {
cb(err ? false : true)
})
}
fs.readFile = function (path, opts, cb) {
if (typeof opts === 'function') {
cb = opts
opts = {}
}
opts.flag || (opts.flag = 'r')
opts.advice || (opts.advice = 'NOREUSE')
_fdOperation(
path,
opts,
function (fd, cb) {
fs.fstat(
fd,
function (e, stat) {
if (e) return cb(e)
else {
var buffer = _.allocBuffer(stat.size)
fs.read(
fd,
buffer,
0,
buffer.length,
null,
function (e) {
if (e) cb(e)
else cb(null, opts.encoding ? buffer.toString(opts.encoding) : buffer)
},
'_nested_'
)
}
},
'_nested_'
)
},
cb
)
}
fs.writeFile = function (path, data, opts, cb) {
if (typeof opts === 'function') {
cb = opts
opts = {}
}
opts.flag || (opts.flag = 'w')
opts.advice || (opts.advice = 'NOREUSE')
_fdOperation(
path,
opts,
function (fd, cb) {
if (typeof data === 'string') data = _.bufferFrom(data, opts.encoding || 'utf8')
fs.write(
fd,
data,
0,
data.length,
null,
function (e) {
cb(e)
},
'_nested_'
)
},
cb
)
}
fs.appendFile = function (path, data, opts, cb) {
if (typeof opts === 'function') {
cb = opts
opts = {}
}
opts.flag || (opts.flag = 'a')
fs.writeFile(path, data, opts, cb)
}
fs.truncate = function (path, len, cb) {
_fdOperation(
path,
{ flag: 'r+' },
function (fd, cb) {
fs.ftruncate(fd, len, cb, '_nested_')
},
cb
)
}
fs.readdir = function (path, cb) {
_fdOperation(
path,
{ flag: '\\r' },
function (fd, cb) {
fs._readdir(fd, cb, '_nested_')
},
cb
)
}
fs.mkdir = function (path, mode, cb) {
if (typeof mode === 'function') {
cb = mode
mode = 0777
}
_fdOperation(
path,
{ flag: '\\wx' },
function (fd, cb) {
fs._mkdir(fd, cb, '_nested_')
},
cb
)
}
fs.utimes = function (path, atime, mtime, cb) {
_fdOperation(
path,
{ flag: 'r+' },
function (fd, cb) {
fs.futimes(fd, atime, mtime, cb, '_nested_')
},
cb
)
}
fs.chmod = fs.lchmod = function (path, mode, cb) {
_fdOperation(
path,
{ flag: '\\r+' },
function (fd, cb) {
fs.fchmod(fd, mode, cb, '_nested_')
},
cb
)
}
fs.chown = fs.lchown = function (path, uid, gid, cb) {
_fdOperation(
path,
{ flag: '\\r+' },
function (fd, cb) {
fs.fchown(fd, uid, gid, cb, '_nested_')
},
cb
)
}
/* STUBS */
fs.link = function (src, dst, cb) {
// NOTE: theoretically we _could_ do hard links [with untracked `stat.nlink` count…]
_.delayedCall(cb, S.err.NOSYS())
}
fs.symlink = function (src, dst, type, cb) {
if (typeof type === 'function') {
cb = type
type = null
}
_.delayedCall(cb, S.err.NOSYS())
}
fs.readlink = function (path, cb) {
_fdOperation(
path,
{ flag: '\\r' },
function (fd, cb) {
// the named file is *never* a symbolic link…
// NOTE: we still use _fdOperation for catching e.g. NOENT/NOTDIR errors…
cb(S.err.INVAL())
},
cb
)
}
fs.realpath = function (path, cache, cb) {
if (typeof cache === 'function') {
cb = cache
cache = null
}
if (cache)
_.delayedCall(cb, S.err.NOSYS()) // TODO: what would be involved here?
else
_fdOperation(
path,
{ flag: '\\r' },
function (fd, cb) {
cb(null, _.absolutePath(path))
},
cb
)
}
fs.fchown = function (fd, uid, gid, cb, _n_) {
cb = GROUP(
cb,
function () {
var _fd = fileDescriptors[fd]
if (!_fd || !_fd.flags.write) _.delayedCall(cb, S.err.BADF())
else _.delayedCall(cb, S.err.NOSYS())
},
_n_ === '_nested_'
)
}
// See https://github.com/natevw/fatfs/pull/31/files
fs.createLabel = function (name, cb) {
fs.open(name, 'a', (e, _fd) => {
if (e) {
cb(e)
} else {
let fd = fileDescriptors[_fd]
fd.entry.Attr.volume_id = true
fd.entry.FstClusLO = 0
fd.entry.FstClusHI = 0
fs._updateEntry(fd.entry, {}, cb)
}
})
}
return fs
}

36
@vates/fatfs/make_sample.sh Executable file
View File

@@ -0,0 +1,36 @@
#! /bin/sh
# NOTE: this only works on OS X
# TODO: Linux could use mkfs stuff without attach?
# ./make_sample.sh /tmp/fat16.img FAT16
FILE=$1
: ${FILE:?must be provided as first argument}
TYPE=$2
: ${TYPE:?must be provided as second argument}
SIZE=$3 # in MB
case "$TYPE" in
"FAT12") : ${SIZE:=1} # <128
;;
"FAT16") : ${SIZE:=5} # >4
;;
"FAT32") : ${SIZE:=33} # >32
;;
*) : ${SIZE:=1} # e.g. ExFAT
esac
echo Making $TYPE of $SIZE MB at $FILE
if [[ "$TYPE" = FAT* ]]
then
TYPE="MS-DOS $TYPE"
fi
dd if=/dev/zero of=$FILE bs=1048576 count=$SIZE
DEV=`hdiutil attach $FILE -nomount`
diskutil eraseVolume "$TYPE" "FATFS TEST" $DEV
hdiutil detach $DEV

34
@vates/fatfs/package.json Normal file
View File

@@ -0,0 +1,34 @@
{
"private": false,
"name": "@vates/fatfs",
"version": "0.11.0",
"description": "fs implementation on top of raw FAT16/FAT32 block source",
"main": "index.js",
"scripts": {
"postversion": "npm publish --access public"
},
"repository": {
"directory": "@vates/fatfs",
"type": "git",
"url": "https://github.com/vatesfr/xen-orchestra.git"
},
"keywords": [
"filesystem",
"fs",
"fat",
"fat32",
"fat16"
],
"author": "Vates SAS",
"license": "Apache-2.0",
"bugs": "https://github.com/vatesfr/xen-orchestra/issues",
"homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/fatfs",
"dependencies": {
"fifolock": "^1.0.0",
"struct-fu": "^1.2.1",
"xok": "^1.0.0"
},
"engines": {
"node": ">=18"
}
}

255
@vates/fatfs/structs.js Normal file
View File

@@ -0,0 +1,255 @@
// see http://staff.washington.edu/dittrich/misc/fatgen103.pdf
// and http://www.cse.scu.edu/~tschwarz/COEN252_09/Lectures/FAT.html
var _ = require('struct-fu'),
__ = require("./helpers.js");
var bootBase = _.struct([
_.byte('jmpBoot', 3),
_.char('OEMName', 8),
_.uint16le('BytsPerSec'),
_.uint8('SecPerClus'),
_.uint16le('ResvdSecCnt'), // Rsvd in table, but Resvd in calcs…
_.uint8('NumFATs'),
_.uint16le('RootEntCnt'),
_.uint16le('TotSec16'),
_.uint8('Media'),
_.uint16le('FATSz16'),
_.uint16le('SecPerTrk'),
_.uint16le('NumHeads'),
_.uint32le('HiddSec'),
_.uint32le('TotSec32')
]);
var bootInfo = _.struct([
_.uint8('DrvNum'),
_.uint8('Reserved1'),
_.uint8('BootSig'),
_.uint32le('VolID'),
_.char('VolLab', 11),
_.char('FilSysType', 8)
]);
exports.boot16 = _.struct([
bootBase,
bootInfo
]);
exports.boot32 = _.struct([
bootBase,
_.uint32le('FATSz32'),
_.struct('ExtFlags', [
_.ubit('NumActiveFAT', 4),
_.ubit('_reserved1', 3),
_.bool('MirroredFAT'),
_.ubit('_reserved2', 8)
].reverse()),
_.struct('FSVer', [
_.uint8('Major'),
_.uint8('Minor')
]),
_.uint32le('RootClus'),
_.uint16le('FSInfo'),
_.uint16le('BkBootSec'),
_.byte('Reserved', 12),
bootInfo
]);
var _time = _.struct([
_.ubit('hours',5),
_.ubit('minutes',6),
_.ubit('seconds_2',5)
]), time = {
valueFromBytes: function (buf, off) {
off || (off = {bytes:0});
var _buf = __.bufferFrom([buf[off.bytes+1], buf[off.bytes+0]]),
val = _time.valueFromBytes(_buf);
off.bytes += this.size;
return val;
},
bytesFromValue: function (val, buf, off) {
val || (val = {hours:0, minutes:0, seconds_2:0});
buf || (buf = __.allocBuffer(this.size));
off || (off = {bytes:0});
var _buf = _time.bytesFromValue(val);
buf[off.bytes+1] = _buf[0];
buf[off.bytes+0] = _buf[1];
off.bytes += this.size;
return buf;
},
size: _time.size
};
var _date = _.struct([
_.ubit('year',7),
_.ubit('month',4),
_.ubit('day',5)
]), date = {
valueFromBytes: function (buf, off) {
off || (off = {bytes:0});
var _buf = __.bufferFrom([buf[off.bytes+1], buf[off.bytes+0]]),
val = _date.valueFromBytes(_buf);
off.bytes += this.size;
return val;
},
bytesFromValue: function (val, buf, off) {
val || (val = {year:0, month:0, day:0});
buf || (buf = __.allocBuffer(this.size));
off || (off = {bytes:0});
var _buf = _date.bytesFromValue(val);
buf[off.bytes+1] = _buf[0];
buf[off.bytes+0] = _buf[1];
off.bytes += this.size;
return buf;
},
size: _date.size
};
exports.dirEntry = _.struct([
_.struct('Name', [
_.char('filename',8),
_.char('extension',3)
]),
_.struct('Attr', [
_.bool('readonly'),
_.bool('hidden'),
_.bool('system'),
_.bool('volume_id'),
_.bool('directory'),
_.bool('archive'),
_.ubit('reserved', 2)
].reverse()),
_.byte('NTRes', 1),
_.uint8('CrtTimeTenth'),
_.struct('CrtTime', [time]),
_.struct('CrtDate', [date]),
_.struct('LstAccDate', [date]),
_.uint16le('FstClusHI'),
_.struct('WrtTime', [time]),
_.struct('WrtDate', [date]),
_.uint16le('FstClusLO'),
_.uint32le('FileSize')
]);
exports.entryDoneFlag = 0x00;
exports.entryFreeFlag = 0xE5;
exports.entryIsE5Flag = 0x05;
exports.dirEntry_simple = _.struct([
_.struct('Name', [
_.char('filename',8),
_.char('extension',3)
]),
_.padTo(exports.dirEntry.size)
/*
_.uint8('Attr_raw'),
_.byte('NTRes', 1),
_.byte('Crt_raw', 1+2+2),
_.byte('Lst_raw', 2),
_.uint16le('FstClusHI'),
_.byte('Wrt_raw', 2+2),
_.uint16le('FstClusLO'),
_.uint32le('FileSize')
*/
]);
exports.lastLongFlag = 0x40;
exports.longDirFlag = 0x0F;
exports.longDirEntry = _.struct([
_.uint8('Ord'),
_.char16le('Name1', 10),
_.uint8('Attr_raw'),
_.uint8('Type'),
_.uint8('Chksum'),
_.char16le('Name2', 12),
_.uint16le('FstClusLO'),
_.char16le('Name3', 4)
]);
if (exports.longDirEntry.size !== exports.dirEntry.size) throw Error("Structs ain't right!");
exports.fatField = {
'fat12': _.struct('Status', [
_.ubit('field0bc', 8),
_.ubit('field1c', 4),
_.ubit('field0a', 4),
_.ubit('field1ab', 8),
]),
'fat16': _.uint16le('Status'),
'fat32': _.uint32le('Status') // more properly this 4 bits reserved + uint28le
};
exports.fatPrefix = {
'fat12': 0xF00,
'fat16': 0xFF00,
'fat32': 0x0FFFFF00
};
exports.fatStat = {
free: 0x00,
_undef: 0x01,
rsvMin: 0xF0,
bad: 0xF7,
eofMin: 0xF8,
eof: 0xFF
};
exports._I = {
RUSR: 0400,
WUSR: 0200,
XUSR: 0100,
RGRP: 0040,
WGRP: 0020,
XGRP: 0010,
ROTH: 0004,
WOTH: 0002,
XOTH: 0001,
SUID: 04000,
SGID: 02000,
SVTX: 01000,
FDIR: 040000,
FREG: 0100000,
};
exports._I.RWXU = exports._I.RUSR | exports._I.WUSR | exports._I.XUSR;
exports._I.RWXG = exports._I.RGRP | exports._I.WGRP | exports._I.XGRP;
exports._I.RWXO = exports._I.ROTH | exports._I.WOTH | exports._I.XOTH;
exports._I._sss = exports._I.SUID | exports._I.SGID | exports._I.SVTX;
exports._I._chmoddable = exports._I.RWXU | exports._I.RWXG | exports._I.RWXO | exports._I._sss;
var _errors = {
IO: "Input/output error",
NOENT: "No such file or directory",
INVAL: "Invalid argument",
EXIST: "File exists",
NAMETOOLONG: "Filename too long",
NOSPC: "No space left on device",
NOSYS: "Function not supported",
ROFS: "ROFLCopter file system",
NOTDIR: "Not a directory",
BADF: "Bad file descriptor",
EXIST: "File exists",
ISDIR: "Is a directory",
ACCES: "Permission denied",
NOSYS: "Function not implemented",
_TODO: "Not implemented yet!"
};
exports.err = {};
Object.keys(_errors).forEach(function (sym) {
var msg = _errors[sym];
exports.err[sym] = function () {
var e = new Error(msg);
e.code = sym;
return e;
};
});

338
@vates/fatfs/test.js Normal file
View File

@@ -0,0 +1,338 @@
// can be called from CLI with image type, absolute path to an image, or, required as a module
var _ = require("./helpers.js");
var type = process.argv[2];
if (module.parent) exports.startTests = startTests;
else if (!type) throw "Usage: node test [FAT12|FAT16|FAT32|ExFAT|…|/path/to/image]";
else if (type[0] === '/') testWithImage(type);
else {
var uniq = Math.random().toString(36).slice(2),
IMG = require('os').tmpdir()+"fatfs-test-"+uniq+".img";
require('child_process').exec("./make_sample.sh "+JSON.stringify(IMG)+" "+JSON.stringify(type), function (e,out,err) {
if (e) throw e;
console.warn(err.toString());
//console.log(out.toString());
testWithImage(IMG);
//console.log("open", IMG);
//return;
require('fs').unlink(IMG, function (e) {
if (e) console.warn("Error cleaning up test image", e);
});
});
}
function testWithImage(imagePath) {
var vol = require("./img_volume.js").createDriverSync(imagePath);
startTests(vol);
}
function startTests(vol, waitTime) {
var fatfs = require("./"),
fs = fatfs.createFileSystem(vol, {umask:0020, uid:99, gid:42});
waitTime || (waitTime = 0.5e3);
[
'mkdir','readdir',
//'rename','unlink','rmdir',
'close','open','fsync',
'ftruncate','truncate',
'write','read','readFile','writeFile', 'appendFile',
'chown','lchown','fchown',
'chmod','lchmod', 'fchmod',
'utimes','futimes',
'stat','lstat','fstat','exists',
'link','symlink','readlink','realpath',
//'watchFile','unwatchFile','watch'
].forEach(function (method) { assert(method in fs, "fs."+method+" has implementation."); });
var BASE_DIR = "/fat_test-"+Math.random().toFixed(20).slice(2),
FILENAME = "Simple File.txt",
TEXTDATA = "Hello world!";
var isReady = false;
fs.on('ready', function () {
assert(isReady = true, "Driver is ready.");
}).on('error', function (e) {
assert(e, "If fs driver fires 'error' event, it should include error object.");
assert(false, "…but driver should not error when initializing in our case.");
});
setTimeout(function () {
assert(isReady, "Driver fired ready event in timely fashion.");
}, waitTime);
fs.readdir("/", function (e,files) {
assert(isReady, "Method completed after 'ready' event.");
assert(!e, "No error reading root directory.");
assert(Array.isArray(files), "Got a list of files: "+files);
});
fs.mkdir(BASE_DIR, function (e) {
assert(!e, "No error from fs.mkdir");
fs.readdir(BASE_DIR, function (e,arr) {
assert(!e, "No error from fs.readdir");
assert(arr.length === 0 , "No files in BASE_DIR yet.");
});
var file = [BASE_DIR,FILENAME].join('/');
fs.writeFile(file, TEXTDATA, function (e) {
assert(!e, "No error from fs.writeFile");
startStreamTests();
fs.realpath(file, function (e,path) {
assert(!e, "No error from basic fs.realpath call.");
assert(path === file, "We already had the real path.");
});
fs.realpath([BASE_DIR,".","garbage",".","..",FILENAME].join('/'), function (e,path) {
assert(!e, "No error from fluffy fs.realpath call.");
assert(path === file, "Fixed fluffy path matches normal one.");
});
fs.realpath([BASE_DIR,"non","existent","path"].join('/'), function (e) {
assert(e, "Expected error calling fs.realpath on non-existent file.");
});
fs.readdir(BASE_DIR, function (e, arr) {
assert(!e, "Still no error from fs.readdir");
assert(arr.length === 2, "Test directory contains two files."); // (ours + startStreamTests's)
assert(arr[0] === FILENAME, "Filename is correct.");
fs.stat(file, function (e,d) {
assert(!e, "No error from fs.stat");
assert(d.isFile() === true, "Result is a file…");
assert(d.isDirectory() === false, "…and not a directory.");
assert(d.size === Buffer.byteLength(TEXTDATA), "Size matches length of content written.");
});
fs.exists(file, function (bool) {
assert(bool === true, "File exists.");
});
fs.readFile(file, {encoding:'utf8'}, function (e, d) {
assert(!e, "No error from fs.readFile");
assert(d === TEXTDATA, "Data matches what was written.");
});
// now, overwrite the same file and make sure that goes well too
fs.writeFile(file, _.bufferFrom([0x42]), function (e) {
assert(!e, "Still no error from fs.writeFile");
fs.readdir(BASE_DIR, function (e, arr) {
assert(!e, "No error from fs.readdir");
assert(arr.length === 2, "Test directory still contains two files.");
assert(arr[0] === FILENAME, "Filename still correct.");
fs.stat(file, function (e,d) {
assert(!e, "Still no error from fs.stat");
assert(d.isFile() === true, "Result is still a file…");
assert(d.isDirectory() === false, "…and not a directory.");
assert(d.size === 1, "Size matches length of now-truncated content.");
});
fs.readFile(file, function (e, d) {
assert(!e, "Still no error from fs.readFile");
assert(Buffer.isBuffer(d), "Result without encoding is a buffer.");
assert(d.length === 1, "Buffer is correct size.");
assert(d[0] === 0x42, "Buffer content is correct.");
fs.truncate(file, 1025, function (e) {
assert(!e, "No error from fs.truncate (extending)");
fs.readFile(file, function (e, d) {
assert(!e, "Still no error from fs.readFile after extension");
assert(d.length === 1025, "Read after extension is correct size.");
assert(d[0] === 0x42, "First byte is still correct.");
var allZeroes = true;
for (var i = 1, len = d.length; i < len; ++i) if (d[i] !== 0) allZeroes = false;
assert(allZeroes, "Extended portion of file is zero-filled.");
fs.truncate(file, 3, function (e) {
assert(!e, "No error from fs.truncate (shortening)");
fs.readFile(file, function (e, d) {
assert(!e, "Still no error from fs.readFile after shortening.");
assert(d.length === 3, "Read after shortening is correct size.");
assert(d[0] === 0x42, "First byte is still correct.");
assert(d[1] === 0x00, "Second byte is still correct.");
assert(d[2] === 0x00, "Third byte is still correct.");
proceedWithMoreTests();
});
});
});
});
});
});
});
});
});
function proceedWithMoreTests() {
var fd;
fs.open(file, 'r', function (e, _fd) {
assert(!e, "No error from fs.open.");
fd = _fd;
});
var was = "\u0042\u0000\u0000",
str = "abc";
fs.appendFile(file, str, function (e) {
assert(!e, "No error from fs.appendFile.");
assert(fd, "File descriptor opened before appendFile called.");
var buf = _.allocBuffer(str.length);
fs.read(fd, buf, 0, buf.length, was.length, function (e,n,d) {
assert(!e, "No error from fs.read after append.");
assert(n === str.length, "All appended data was readable.");
assert(d === buf, "Buffer returned from fs.read matched what was passed in.");
assert(d.toString() === str, "Correct data found where expected.");
});
});
fs.readFile(file, {encoding:'ascii'}, function (e,d) {
assert(!e, "No error from fs.appendFile.");
assert(d.length === 6, "Read is correct size after append.");
assert(d === was+str, "Read string matches what was written and then appended.");
fs.open(file, 'a', function (e, fd2) {
assert(!e, "No error from second open of file.");
var str2 = "zyx",
buf2 = _.allocBuffer(str2.length+2);
buf2.write(str2, 1);
fs.write(fd2, buf2, 1, buf2.length-2, was.length, function (e,n,d) {
assert(!e, "No error from appending fs.write.");
assert(n === buf2.length-2, "Wrote proper amount from buffer.");
assert(d === buf2, "Returned original buffer.");
buf2.fill(0);
buf2[0] = 0xFF;
fs.read(fd, buf2, 1, buf2.length-1, was.length, function (e,n,d) {
assert(!e, "No error from twice-appended read.");
assert(n === buf2.length-1, "Read proper amount into buffer.");
assert(buf2[0] === 0xFF, "Read left first byte in buffer properly alone.");
assert(d.slice(1).toString() === (str+str2).slice(0, buf2.length-1), "Data was appended, not written at position.");
});
});
});
});
var F = [BASE_DIR,"Manually inspect from time to time, please!.txt"].join('/'),
S = 512,
N = 16,
b = _.allocBuffer(S*N);
for (var i = 0; i < N; ++i) b.slice(S*i, S*i+S).fill(i.toString(16).charCodeAt(0));
fs.writeFile(F, b, function (e) {
assert(!e, "No error from fs.writeFile with counting blocks.");
fs.readFile(F, function (e,d) {
assert(!e, "No error from fs.readFile with counting blocks.");
assert(d.length === b.length, "Readback is correct size");
var matched = true;
for (var i = 0; i < S*N; ++i) if (b[i] !== d[i]) matched = false;
assert(matched, "Readback matches write byte-for-byte");
});
});
fs.stat(F, function (e,d) {
assert(!e, "No error from fs.stat on counting blocks file.");
assert(d.atime instanceof Date && !isNaN(d.atime.getTime()), "Access time is a valid date.");
assert(d.mtime instanceof Date && !isNaN(d.mtime.getTime()), "Modify time is a valid date.");
assert(d.ctime instanceof Date && !isNaN(d.ctime.getTime()), "Change^WCreate time is a valid date.");
var tf = d.ctime.getTime(),
ct = Date.now();
assert(tf - 2*waitTime < ct && ct < tf + 2*waitTime, "Create time is within ± two `waitTime`s of now.");
fs.utimes(F, new Date(2009, 7-1, 2), null, function (e) {
assert(!e, "No error from fs.utimes.");
fs.stat(F, function (e,d2) {
assert(!e, "No fs.stat error after touching timestamps.");
assert(+d.ctime === +d2.ctime, "Create time not changed by fs.utimes");
assert(d2.atime.toString().indexOf("Jul 02 2009 00:00:00") === 4, "Access time set correctly");
var tf = d2.mtime.getTime(),
ct = Date.now();
assert(tf-2e3 < ct && ct < tf+2e3+waitTime, "Modify time is within ± a few seconds of now.");
// NOTE: due to serialization, this can check results of the `fs.chmod` below, too!
assert(!(d2.mode & 0100), "Archive bit is now unset.");
assert(!(d2.mode & 0222), "Writable perms are unset.");
assert(d2.mode & 0100000, "Regular file bit is set.");
});
});
assert(d.uid === 99, "Desired UID applied.");
assert(d.gid === 42, "Desired GID applied.");
assert(d.mode & 0100, "Archive bit is set.");
assert(d.mode & 0200, "Writable perm is set for user.");
assert((d.mode & 0022) === 0002, "Writable perm is only masked out for group.");
fs.chmod(F, 0422, function (e) {
assert(!e, "No error from fs.chmod.");
});
});
fs.chown(F, 99, 256, function (e) {
assert(e && e.code === 'NOSYS', "Expected error from fs.fchown.");
});
}
function startStreamTests() {
var file2 = [BASE_DIR,FILENAME+"2"].join('/'),
outStream = fs.createWriteStream(file2);
var outStreamOpened = false;
outStream.on('open', function (fd) {
outStreamOpened = true;
assert(typeof fd === 'number', "Got file descriptor on fs.createWriteStream open.");
}).on('error', function (e) {
assert(e, "If fs.createWriteStream fires 'error' event, it should include error object.");
assert(false, "But, fs.createWriteStream should not error during these tests.");
});
setTimeout(function () {
assert(outStreamOpened, "outStream fired 'open' event in a timely fashion.");
}, waitTime);
var TEXT_MOD = TEXTDATA.toLowerCase()+"\n",
NUM_REPS = (waitTime <= 1e3) ? 1024 : 16;
outStream.write(TEXT_MOD, 'utf16le');
outStream.write("Ο καλύτερος χρόνος να φυτευτεί ένα \ud83c\udf31 είναι δέκα έτη πριν.", 'utf16le');
outStream.write("La vez del segundo mejor ahora está.\n", 'utf16le');
for (var i = 0; i < NUM_REPS; ++i) outStream.write("123456789\n", 'ascii');
outStream.write("JavaScript how do they work\n", 'utf16le');
outStream.write("The end, almost.\n", 'utf16le');
outStream.end(TEXTDATA, 'utf16le');
var outStreamFinished = false;
outStream.on('finish', function () {
outStreamFinished = true;
var inStream = fs.createReadStream(file2, {start:NUM_REPS*10, encoding:'utf16le', autoClose:false}),
gotData = false, gotEOF = false, inStreamFD = null;
inStream.on('open', function (fd) {
assert(typeof fd === 'number', "Got file descriptor on fs.createReadStream open.");
inStreamFD = fd;
});
inStream.on('data', function (d) {
gotData = true;
assert(typeof d === 'string', "Data returned as string.");
assert(d.slice(d.length-TEXTDATA.length) === TEXTDATA, "End of file matches what was written.");
});
inStream.on('end', function () {
gotEOF = true;
var len = Buffer.byteLength(TEXT_MOD, 'utf16le'),
buf = _.allocBuffer(len);
fs.fsync(inStreamFD, function (e) {
assert(!e, "No error from proper fsync.");
});
fs.fsync('garbage', function (e) {
assert(e, "Expected error from garbage fsync.");
});
fs.read(inStreamFD, buf, 0, len, 0, function (e,n,d) {
assert(!e, "No error reading from beginning of inStream's file descriptor.");
assert(n === len, "Read complete buffer at beginning of inStream's fd.");
assert(d.toString('utf16le') === TEXT_MOD, "Data matches at beginning of inStream's fd.");
fs.close(inStreamFD, function (e) {
assert(!e, "No error closing inStream's fd.");
});
});
});
setTimeout(function () {
assert(gotData, "inStream fired 'data' event in a timely fashion.");
setTimeout(function () {
assert(gotEOF, "inStream fired 'eof' event in a timely fashion.");
}, waitTime);
}, waitTime);
});
setTimeout(function () {
assert(outStreamFinished, "outStream fired 'finish' event in a timely fashion.");
}, 2*waitTime);
}
});
}
function assert(b,msg) { if (!msg) console.warn("no msg", Error().stack); if (!b) throw Error("Assertion failure. "+msg); else console.log(msg); }

165
@vates/fatfs/vol.js Normal file
View File

@@ -0,0 +1,165 @@
var S = require("./structs.js"),
c = require("./chains.js"),
$ = require("./cache.js"),
_ = require("./helpers.js");
exports.init = function (volume, opts, bootSector) {
if (bootSector[510] !== 0x55 || bootSector[511] !== 0xAA) throw Error("Invalid volume signature!");
var isFAT16 = bootSector.readUInt16LE(S.boot16.fields['FATSz16'].offset),
bootStruct = (isFAT16) ? S.boot16 : S.boot32,
BS = bootStruct.valueFromBytes(bootSector);
_.log(_.log.DBG, "Boot sector info:", BS);
bootSector = null; // allow GC
if (!BS.BytsPerSec) throw Error("This looks like an ExFAT volume! (unsupported)");
else if (BS.BytsPerSec !== volume.sectorSize) throw Error("Sector size mismatch with FAT table.");
var FATSz = (isFAT16) ? BS.FATSz16 : BS.FATSz32,
rootDirSectors = Math.ceil((BS.RootEntCnt * 32) / BS.BytsPerSec),
firstDataSector = BS.ResvdSecCnt + (BS.NumFATs * FATSz) + rootDirSectors,
totSec = (BS.TotSec16) ? BS.TotSec16 : BS.TotSec32,
dataSec = totSec - firstDataSector,
countofClusters = Math.floor(dataSec / BS.SecPerClus);
// avoid corrupting sectors from other partitions or whatnot
if (totSec > volume.numSectors) throw Error("Volume size mismatch!");
var fatType;
if (countofClusters < 4085) {
fatType = 'fat12';
} else if (countofClusters < 65525) {
fatType = 'fat16';
} else {
fatType = 'fat32';
}
_.log(_.log.DBG, "rootDirSectors", rootDirSectors, "firstDataSector", firstDataSector, "countofClusters", countofClusters, "=>", fatType);
var vol = {};
vol.opts = opts;
vol._sectorSize = BS.BytsPerSec;
vol._sectorsPerCluster = BS.SecPerClus;
vol._firstSectorOfCluster = function (n) {
return firstDataSector + (n-2)*vol._sectorsPerCluster;
};
vol._makeCache = function () {
return $.wrapDriver(volume);
};
vol._readSectors = function (cache, secNum, dest, cb) {
if (typeof dest === 'function') {
cb = dest;
dest = _.allocBuffer(vol._sectorSize);
}
_.log(_.log.DBG, "vol._readSectors", secNum, dest.length);
if (secNum < volume.numSectors) cache.readSectors(secNum, dest, function (e) { cb(e, dest); });
else throw Error("Invalid sector number!");
};
vol._writeSectors = function (cache, secNum, data, cb) {
_.log(_.log.DBG, "vol._writeSectors", secNum, data.length);
// NOTE: these are internal assertions, public API will get proper `S.err`s
if (data.length % volume.sectorSize) throw Error("Buffer length not a multiple of sector size");
else if (opts.ro) throw Error("Read-only filesystem");
else if (secNum < volume.numSectors) cache.writeSectors(secNum, data, cb);
else throw Error("Invalid sector number!");
};
function fatInfoForCluster(n) {
var entryStruct = S.fatField[fatType],
FATOffset = (fatType === 'fat12') ? Math.floor(n/2) * entryStruct.size : n * entryStruct.size,
SecNum = BS.ResvdSecCnt + Math.floor(FATOffset / BS.BytsPerSec);
EntOffset = FATOffset % BS.BytsPerSec;
return {sector:SecNum-BS.ResvdSecCnt, offset:EntOffset, struct:entryStruct};
}
// TODO: all this FAT manipulation is crazy inefficient! needs read caching *and* write caching
// …the best place for cache might be in `volume` handler, though. add a `flush` method to that spec?
// TODO: how should we handle redundant FATs? mirror every write? just ignore completely? copy-on-eject?
var fatChain = c.sectorChain(vol, BS.ResvdSecCnt, FATSz);
fatChain.cacheAdvice = 'RANDOM';
vol.fetchFromFAT = function (clusterNum, cb) {
var info = fatInfoForCluster(clusterNum);
fatChain.readFromPosition(info, info.struct.size, function (e,n,d) {
if (e) return cb(e);
var status = info.struct.valueFromBytes(d), prefix;
if (fatType === 'fat12') {
if (clusterNum % 2) {
status = (status.field1ab << 4) + status.field1c;
} else {
status = (status.field0a << 8) + status.field0bc;
}
}
else if (fatType === 'fat32') {
status &= 0x0FFFFFFF;
}
var prefix = S.fatPrefix[fatType];
if (status === S.fatStat.free) cb(null, 'free');
else if (status === S.fatStat._undef) cb(null, '-invalid-');
else if (status > prefix+S.fatStat.eofMin) cb(null, 'eof');
else if (status === prefix+S.fatStat.bad) cb(null, 'bad');
else if (status > prefix+S.fatStat.rsvMin) cb(null, 'reserved');
else cb(null, status);
});
};
vol.storeToFAT = function (clusterNum, status, cb) {
if (typeof status === 'string') {
status = S.fatStat[status];
status += S.fatPrefix[fatType];
}
var info = fatInfoForCluster(clusterNum);
// TODO: technically fat32 needs to *preserve* the high 4 bits
if (fatType === 'fat12') fatChain.readFromPosition(info, info.struct.size, function (e,n,d) {
var value = info.struct.valueFromBytes(d);
if (clusterNum % 2) {
value.field1ab = status >>> 4;
value.field1c = status & 0x0F;
} else {
value.field0a = status >>> 8;
value.field0bc = status & 0xFF;
}
var entry = info.struct.bytesFromValue(value);
fatChain.writeToPosition(info, entry, cb);
}); else {
var entry = info.struct.bytesFromValue(status);
fatChain.writeToPosition(info, entry, cb);
}
};
vol.allocateInFAT = function (hint, cb) {
if (typeof hint === 'function') {
cb = hint;
hint = 2; // TODO: cache a better starting point?
}
function searchForFreeCluster(num, cb) {
if (num < countofClusters) vol.fetchFromFAT(num, function (e, status) {
if (e) cb(e);
else if (status === 'free') cb(null, num);
else searchForFreeCluster(num+1, cb);
}); else cb(S.err.NOSPC()); // TODO: try searching backwards from hint…
}
searchForFreeCluster(hint, function (e, clusterNum) {
if (e) cb(e);
else vol.storeToFAT(clusterNum, 'eof', cb.bind(null,null,clusterNum));
});
};
vol.rootDirectoryChain = (isFAT16) ?
c.sectorChain(vol, firstDataSector - rootDirSectors, rootDirSectors) :
c.clusterChain(vol, BS.RootClus);
vol.rootDirectoryChain.cacheAdvice = 'WILLNEED';
vol.chainForCluster = c.clusterChain.bind(c, vol);
vol.chainFromJSON = function (d) {
return ('numSectors' in d) ?
c.sectorChain(vol, d.firstSector, d.numSectors) :
c.clusterChain(vol, d.firstCluster);
};
return vol;
}

View File

@@ -13,7 +13,7 @@ await mount(handler, diskId, mountPoint)
### cli
From the install folder :
From the install folder:
```
cli.mjs <remoteUrl> <vhdPathInRemote> <mountPoint>
@@ -25,4 +25,25 @@ After installing the package
xo-fuse-vhd <remoteUrl> <vhdPathInRemote> <mountPoint>
```
remoteUrl can be found by using cli in `@xen-orchestra/fs` , for example a local remote will have a url like `file:///path/to/remote/root`
The `remoteUrl` can be found using the following command from the XOA CLI, and then picking the right `url` property:
`xo-server-db ls remote`
The `vhdPathInRemote` follows a file structure described in [VM backups](https://github.com/vatesfr/xen-orchestra/blob/master/%40xen-orchestra/backups/docs/VM%20backups/README.md).
## Restore a file from a VHD using `fuse-vhd` CLI
1. Mount a VHD to the Filesystem (see **Usage**).
2. Verify the VHD is Correctly Mounted:
`mount | grep fuse`
3. Get the `START` and `SIZE` of the disk whose file you want to restore. Multiply `START` by 512 (block size) to get the offset value. (`mountedVhdPath` is the `mountPoint` value from earlier, followed by `/vhd0`, for example). Depending on the partition type, you may need to do some additional setup to discover the partitions.
`partx --bytes --output=NR,START,SIZE,NAME,UUID,TYPE --pairs <mountedVhdPath>`
4. Mount the disk. Depending on the partition type, you may need to add some additional options. The `norecovery` option is used for ext3/ext4/xfs file systems; otherwise, remove this option.
`mount --options=loop,ro,norecovery,sizelimit=<SIZE>,offset=<START*512> --source=<mountedVhdPath> --target=<diskMountPoint>`
5. Copy your files from the mounted partition, then unmount the partition.

View File

@@ -29,7 +29,7 @@ await mount(handler, diskId, mountPoint)
### cli
From the install folder :
From the install folder:
```
cli.mjs <remoteUrl> <vhdPathInRemote> <mountPoint>
@@ -41,7 +41,28 @@ After installing the package
xo-fuse-vhd <remoteUrl> <vhdPathInRemote> <mountPoint>
```
remoteUrl can be found by using cli in `@xen-orchestra/fs` , for example a local remote will have a url like `file:///path/to/remote/root`
The `remoteUrl` can be found using the following command from the XOA CLI, and then picking the right `url` property:
`xo-server-db ls remote`
The `vhdPathInRemote` follows a file structure described in [VM backups](https://github.com/vatesfr/xen-orchestra/blob/master/%40xen-orchestra/backups/docs/VM%20backups/README.md).
## Restore a file from a VHD using `fuse-vhd` CLI
1. Mount a VHD to the Filesystem (see **Usage**).
2. Verify the VHD is Correctly Mounted:
`mount | grep fuse`
3. Get the `START` and `SIZE` of the disk whose file you want to restore. Multiply `START` by 512 (block size) to get the offset value. (`mountedVhdPath` is the `mountPoint` value from earlier, followed by `/vhd0`, for example). Depending on the partition type, you may need to do some additional setup to discover the partitions.
`partx --bytes --output=NR,START,SIZE,NAME,UUID,TYPE --pairs <mountedVhdPath>`
4. Mount the disk. Depending on the partition type, you may need to add some additional options. The `norecovery` option is used for ext3/ext4/xfs file systems; otherwise, remove this option.
`mount --options=loop,ro,norecovery,sizelimit=<SIZE>,offset=<START*512> --source=<mountedVhdPath> --target=<diskMountPoint>`
5. Copy your files from the mounted partition, then unmount the partition.
## Contributions

View File

@@ -1,6 +1,6 @@
{
"name": "@vates/fuse-vhd",
"version": "2.1.1",
"version": "2.1.2",
"license": "ISC",
"private": false,
"homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/fuse-vhd",
@@ -19,12 +19,12 @@
},
"main": "./index.mjs",
"dependencies": {
"@xen-orchestra/fs": "^4.1.7",
"@xen-orchestra/log": "^0.6.0",
"@xen-orchestra/fs": "^4.6.2",
"@xen-orchestra/log": "^0.7.1",
"fuse-native": "^2.2.6",
"lru-cache": "^7.14.0",
"promise-toolbox": "^0.21.0",
"vhd-lib": "^4.11.0"
"vhd-lib": "^4.14.0"
},
"bin": {
"xo-fuse-vhd": "./cli.mjs"

View File

@@ -0,0 +1,58 @@
A toolbox to ease the use of generator
### Timeout
wrap a source async generator to have it throw an error when timeout is reached
timeout is a positive number in milliseconds
```js
import { Timeout } from '@vates/generator-toolbox'
const wrappedGenerator = new Timeout(sourceGenerator, timeout)
```
### Throttle
wrap a source async generator to have it respect a max speed ( in bytes per seconds).
speed is either a strictly positive number or a function returning a strictly positive number. A speed change will be used for the next emitted packet.
The source generator must yield object with a length property.
Optimized for small yields regarding to the speed, since it won't split incoming packet.
If the generator reached the max speed it will be paused, limiting memory consumption.
```js
import { Throttle } from '@vates/generator-toolbox'
const wrappedGenerator = new Throttle(sourceGenerator, speed)
```
### Synchronized
Fork a generator. The rules are:
- if the source returns, all the forks return
- if the forks error, all the forks error with the same error
- if a fork returns, it is stopped, but the generator continue with the other
- if a fork errors, it is stopped, but the generator continue with the other
- if all the forks return, the source is stopped
- if all the forks error, the source is errored with the last error
- the source start producing a packet when the fastest forked ask for it
- the source forks get the packet only when all the forks asked for it, no buffer stores in memory
```ts
import { Synchronized } from '@vates/generator-toolbox'
async function consume(generator: AsyncGenerator) {
for await (const val of generator) {
console.log({ val })
}
}
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
await Promise.all([consume(first), consume(second)])
```
Note: you can stop early a generator by calling `generator.return()`, and you can stop in in error by calling `generator.throw(error)`

View File

@@ -0,0 +1 @@
../../scripts/npmignore

View File

@@ -0,0 +1,89 @@
<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->
# @vates/generator-toolbox
[![Package Version](https://badgen.net/npm/v/@vates/generator-toolbox)](https://npmjs.org/package/@vates/generator-toolbox) ![License](https://badgen.net/npm/license/@vates/generator-toolbox) [![PackagePhobia](https://badgen.net/bundlephobia/minzip/@vates/generator-toolbox)](https://bundlephobia.com/result?p=@vates/generator-toolbox) [![Node compatibility](https://badgen.net/npm/node/@vates/generator-toolbox)](https://npmjs.org/package/@vates/generator-toolbox)
## Install
Installation of the [npm package](https://npmjs.org/package/@vates/generator-toolbox):
```sh
npm install --save @vates/generator-toolbox
```
## Usage
A toolbox to ease the use of generator
### Timeout
wrap a source async generator to have it throw an error when timeout is reached
timeout is a positive number in milliseconds
```js
import { Timeout } from '@vates/generator-toolbox'
const wrappedGenerator = new Timeout(sourceGenerator, timeout)
```
### Throttle
wrap a source async generator to have it respect a max speed ( in bytes per seconds).
speed is either a strictly positive number or a function returning a strictly positive number. A speed change will be used for the next emitted packet.
The source generator must yield object with a length property.
Optimized for small yields regarding to the speed, since it won't split incoming packet.
If the generator reached the max speed it will be paused, limiting memory consumption.
```js
import { Throttle } from '@vates/generator-toolbox'
const wrappedGenerator = new Throttle(sourceGenerator, speed)
```
### Synchronized
Fork a generator. The rules are:
- if the source returns, all the forks return
- if the forks error, all the forks error with the same error
- if a fork returns, it is stopped, but the generator continue with the other
- if a fork errors, it is stopped, but the generator continue with the other
- if all the forks return, the source is stopped
- if all the forks error, the source is errored with the last error
- the source start producing a packet when the fastest forked ask for it
- the source forks get the packet only when all the forks asked for it, no buffer stores in memory
```ts
import { Synchronized } from '@vates/generator-toolbox'
async function consume(generator: AsyncGenerator) {
for await (const val of generator) {
console.log({ val })
}
}
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
await Promise.all([consume(first), consume(second)])
```
Note: you can stop early a generator by calling `generator.return()`, and you can stop in in error by calling `generator.throw(error)`
## Contributions
Contributions are _very_ welcomed, either on the documentation or on
the code.
You may:
- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
you've encountered;
- fork and create a pull request.
## License
[MIT](https://spdx.org/licenses/MIT) © [Vates SAS](https://vates.fr)

View File

@@ -0,0 +1,6 @@
// @ts-check
import eslint from '@eslint/js'
import tseslint from 'typescript-eslint'
export default tseslint.config(eslint.configs.recommended, tseslint.configs.recommended)

View File

@@ -0,0 +1,38 @@
{
"name": "@vates/generator-toolbox",
"version": "1.0.4",
"main": "dist/index.mjs",
"license": "MIT",
"private": false,
"type": "module",
"devDependencies": {
"@eslint/js": "^9.19.0",
"rimraf": "^5.0.1",
"@types/node": "^20.6",
"typescript": "~5.6",
"typescript-eslint": "^8.23.0"
},
"scripts": {
"build": "tsc",
"dev": "tsc --watch",
"postversion": "npm publish --access public",
"prebuild": "rimraf dist/",
"predev": "yarn run prebuild",
"test": "tsc && node --test **/*.test.mjs",
"clean": "rimraf dist/"
},
"homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/generator-toolbox",
"bugs": "https://github.com/vatesfr/xen-orchestra/issues",
"repository": {
"directory": "@vates/generator-toolbox",
"type": "git",
"url": "https://github.com/vatesfr/xen-orchestra.git"
},
"author": {
"name": "Vates SAS",
"url": "https://vates.fr"
},
"engines": {
"node": ">=20.18"
}
}

View File

@@ -0,0 +1,3 @@
export { Synchronized } from './synchronized.mjs'
export { Throttle } from './throttle.mjs'
export { Timeout } from './timeout.mjs'

View File

@@ -0,0 +1,157 @@
import assert from 'node:assert'
export class Synchronized<T, TReturn, TNext> {
#source: AsyncGenerator<T, TReturn, TNext>
#forks = new Map<string, Forked<T, TReturn, TNext>>()
#removedForks = new Set<string>()
#waitingForks = new Set<string>()
#started = false
#nextValueForksReady?: {
promise: Promise<IteratorResult<T>>
forksWaitingReject: (error: Error) => void
forksWaitingResolve: () => void
}
constructor(source: AsyncGenerator<T, TReturn, TNext>) {
this.#source = source
}
fork(uid: string): AsyncGenerator<T, TReturn, TNext> {
assert.strictEqual(this.#started, false, `can't create a fork after consuming the data`)
assert.strictEqual(this.#forks.has(uid), false, `a fork with id ${uid} already exists`)
const fork = new Forked<T, TReturn, TNext>(this, uid)
this.#forks.set(uid, fork)
return fork
}
async #resolveWhenAllForksReady(): Promise<IteratorResult<T>> {
if (!this.#nextValueForksReady) {
throw new Error('Can t wait forks if there are noone waiting')
}
const { promise, forksWaitingResolve } = this.#nextValueForksReady
if (this.#waitingForks.size === this.#forks.size) {
// reset value
this.#waitingForks.clear()
this.#nextValueForksReady = undefined
forksWaitingResolve() // for the other forks waiting
}
return promise
}
async next(uid: string): Promise<IteratorResult<T>> {
if (this.#removedForks.has(uid)) {
return { done: true, value: undefined }
}
if (!this.#forks.has(uid)) {
throw new Error(`trying to advance fork ${uid} that is not a fork of this one`)
}
if (this.#waitingForks.has(uid)) {
throw new Error(`Fork ${uid} is already waiting`)
}
this.#started = true
if (this.#nextValueForksReady === undefined) {
let forksWaitingResolve = () => {}
let forksWaitingReject: (reason?: Error) => void = () => {}
const next = this.#source.next().catch(async error => {
const e = new Error(`Error in the source generator ${error.message}`, { cause: error })
forksWaitingReject(e)
// source has failed, kill everything, and stop the forks
for (const uid of [...this.#forks.keys()]) {
await this.remove(uid, error)
}
})
const promise = Promise.all([
next,
new Promise((_resolve, _reject) => {
forksWaitingResolve = () => _resolve(undefined)
forksWaitingReject = _reject
}),
]).then(([_]) => _ as IteratorResult<T>)
this.#nextValueForksReady = { promise, forksWaitingResolve, forksWaitingReject }
}
this.#waitingForks.add(uid)
return this.#resolveWhenAllForksReady()
}
async remove(uid: string, error?: Error): Promise<IteratorResult<T>> {
const fork = this.#forks.get(uid)
if (fork === undefined) {
if (this.#removedForks.has(uid)) {
// already removed
return { done: true, value: undefined }
}
throw new Error(`trying to remove fork with uid ${uid} that is not a fork of this one`)
}
this.#forks.delete(uid)
this.#waitingForks.delete(uid)
this.#removedForks.add(uid)
try {
if (error === undefined) {
await fork.return()
} else {
await fork.throw(error)
}
} catch (cleaningError) {
console.error('Error while cleaning the forked', {
cleaningError,
sourceError: error,
})
}
if (this.#forks.size === 0) {
if (error === undefined) {
await this.#source.return(undefined as TReturn)
} else {
await this.#source.throw(error)
}
// Reject any pending forks waiting for the next value
if (this.#nextValueForksReady) {
this.#nextValueForksReady.forksWaitingReject(new Error('Source generator terminated.', { cause: error }))
this.#nextValueForksReady = undefined
}
// clear state
this.#removedForks.clear()
this.#waitingForks.clear()
} else {
// this fork was maybe blocking the others
if (this.#nextValueForksReady) {
await this.#resolveWhenAllForksReady()
}
}
return { done: true, value: undefined }
}
}
class Forked<T, TReturn, TNext> implements AsyncGenerator<T, TReturn, TNext> {
#parent: Synchronized<T, TReturn, TNext>
#uid: string
constructor(parent: Synchronized<T, TReturn, TNext>, uid: string) {
this.#parent = parent
this.#uid = uid
}
next(): Promise<IteratorResult<T>> {
return this.#parent.next(this.#uid)
}
async return(): Promise<IteratorResult<T>> {
return this.#parent.remove(this.#uid)
}
async throw(e: Error): Promise<IteratorResult<T>> {
return this.#parent.remove(this.#uid, e)
}
async *[Symbol.asyncIterator](): AsyncGenerator<T> {
while (true) {
const res = await this.next()
if (res.done) {
break
}
yield res.value
}
}
}

View File

@@ -0,0 +1,150 @@
import assert from 'node:assert'
import { suite, test } from 'node:test'
import { Synchronized } from './synchronized.mjs'
// eslint-disable-next-line @typescript-eslint/no-unused-vars
async function* makeRangeGenerator(end = Infinity, progress = { yielded: 0 }, onYielded = (val: unknown) => {}) {
for (let i = 0; i < end; i++) {
await new Promise(resolve => setTimeout(resolve, 10))
yield i
onYielded(i)
progress.yielded = i
}
return progress
}
async function consume(
iterable: AsyncGenerator,
delay = 2500,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
onConsumed = (val: unknown, iterable: AsyncGenerator) => Promise.resolve(false)
) {
for await (const val of iterable) {
await new Promise(resolve => setTimeout(resolve, delay))
if (await onConsumed(val, iterable)) {
iterable.return(undefined)
}
}
}
suite('success', () => {
test('if works with multiple consumer', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(3, progress)
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
await Promise.all([consume(first, 50), consume(second, 500)])
assert.strictEqual(progress.yielded, 2)
})
test('if works with one consumer returning', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(10, progress)
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
await new Promise(resolve => setTimeout(resolve, 500))
await Promise.all([
consume(first, 1),
consume(second, 1, async (val: unknown) => {
return Promise.resolve(val === 2)
}),
])
assert.strictEqual(progress.yielded, 9)
})
test('if works with all consumers returning', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(10, progress)
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
await new Promise(resolve => setTimeout(resolve, 500))
await Promise.all([
consume(first, 1, async (val: unknown) => {
return Promise.resolve(val === 5)
}),
consume(second, 1, async (val: unknown) => {
return Promise.resolve(val === 2)
}),
])
assert.strictEqual(progress.yielded, 4)
})
})
suite('error', () => {
test('it fails all if error on source', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(5, progress, (val: unknown) => {
if (val === 2) {
throw new Error('source stop')
}
})
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
await assert.rejects(Promise.all([consume(first, 1), consume(second, 1)]))
assert.strictEqual(progress.yielded, 1)
})
test('it flows until the end if one consumer throws', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(10, progress)
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
const firstConsume = consume(first, 1)
const secondConsume = assert.rejects(() =>
consume(second, 1, async (val: unknown, iterable) => {
if (val === 1) {
await iterable.throw(new Error('error on second'))
}
return false
})
)
await Promise.allSettled([firstConsume, secondConsume])
assert.strictEqual(progress.yielded, 9)
})
test('it throw if ALL consumer throws', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(5, progress)
const forker = new Synchronized(generator)
const first = forker.fork('first')
const second = forker.fork('second')
const firstConsume = consume(first, 1, async (val: unknown, iterable) => {
if (val === 3) {
await iterable.throw(new Error('error on first'))
}
return false
})
const secondConsume = consume(second, 1, async (val: unknown, iterable) => {
if (val === 1) {
await iterable.throw(new Error('error on second'))
}
return false
})
await assert.rejects(Promise.all([firstConsume, secondConsume]))
assert.strictEqual(progress.yielded, 2)
})
test('It should not allow a new fork after the start', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(5, progress)
const forker = new Synchronized(generator)
const first = forker.fork('first')
await first.next()
assert.throws(() => forker.fork('second'))
})
test('It should not allow fork with the same uid', async () => {
const progress = { yielded: 0 }
const generator = makeRangeGenerator(5, progress)
const forker = new Synchronized(generator)
forker.fork('first')
forker.fork('second')
assert.throws(() => forker.fork('first'))
})
})

View File

@@ -0,0 +1,66 @@
import assert from 'node:assert'
/**
*
* This class will throttle the production of a group of generators
*
* limits: depends on the event loop, so don't expect it to be very precise
* works better with more small blocks
* The source generator must yield object with a length property
* Changing the speed will only be takin into account fot the next packets asked
*/
export class Throttle {
#previousSlot = 0
#bytesPerSecond: number | (() => number)
get speed(): number {
let speed: number
if (typeof this.#bytesPerSecond === 'function') {
speed = this.#bytesPerSecond()
} else {
speed = this.#bytesPerSecond
}
assert.ok(speed > 0, `speed must be greater than zero, ${speed} computed`)
return speed
}
constructor(speed: number | (() => number)) {
this.#bytesPerSecond = speed
}
getNextSlot(length: number): { timeout?: ReturnType<typeof setTimeout>; promise?: Promise<unknown> } {
assert.notStrictEqual(length, undefined, `throttled stream need to expose a length property }`)
assert.ok(length > 0, `throttled stream must expose a positive length property , ${length} given }`)
const previous = this.#previousSlot
const nextSlot = Math.round(previous + (length * 1000) / this.speed)
if (nextSlot < Date.now()) {
// we're above the limit, go now
this.#previousSlot = Date.now()
return {}
}
this.#previousSlot = nextSlot
// wait till the next slot
// it won't be extremely precise since the event loop is not
let timeout: ReturnType<typeof setTimeout> | undefined = undefined
const promise = new Promise(function (resolve) {
timeout = setTimeout(resolve, nextSlot - Date.now())
})
return { promise, timeout }
}
async *createThrottledGenerator(source: AsyncGenerator<{ length: number }>): AsyncGenerator<{ length: number }> {
let timeout: ReturnType<typeof setTimeout> | undefined
try {
for await (const value of source) {
const res = this.getNextSlot(value.length)
timeout = res.timeout
// wait for the time slot before yielding the data
if (res.promise !== undefined) {
await res.promise
}
yield value
}
} finally {
clearTimeout(timeout)
}
}
}

View File

@@ -0,0 +1,63 @@
import { Throttle } from './throttle.mjs'
import { suite, test } from 'node:test'
import assert from 'node:assert'
async function* makeGenerator(chunkSize = 1024 * 1024, nbChunks = 100) {
for (let i = 0; i < nbChunks; i++) {
yield Buffer.allocUnsafe(chunkSize)
}
}
async function consumes(generator: AsyncGenerator) {
// eslint-disable-next-line no-empty,@typescript-eslint/no-unused-vars
for await (const data of generator) {
}
}
suite('it throttle one', () => {
test('base test', async () => {
// 10MB/s
const throttler = new Throttle(10 * 1024 * 1024)
const throttled = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 20))
const start = Date.now()
await consumes(throttled)
const end = Date.now()
assert.strictEqual(Math.round((end - start) / 1000), 2)
})
test('variable speed test', async () => {
// 10MB/s
const throttler = new Throttle(() => 10 * 1024 * 1024)
const throttled = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 20))
const start = Date.now()
await consumes(throttled)
const end = Date.now()
assert.strictEqual(Math.round((end - start) / 1000), 2)
})
test('multiple generator test', async () => {
// 10MB/s
const throttler = new Throttle(10 * 1024 * 1024)
const first = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
const second = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
const start = Date.now()
await Promise.all([consumes(first), consumes(second)])
const end = Date.now()
assert.strictEqual(Math.round((end - start) / 1000), 2)
})
test(`it doesn't accept negative value`, async () => {
// 10MB/s
let throttler = new Throttle(-10 * 1024 * 1024)
let generator = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
await assert.rejects(() => consumes(generator))
let index = 5
throttler = new Throttle(() => {
index--
return index > 0 ? 10 * 1024 * 1024 : -10 * 1024 * 1024
})
generator = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
await assert.rejects(() => consumes(generator))
})
})

View File

@@ -0,0 +1,37 @@
import assert from 'node:assert'
export class Timeout<T> implements AsyncGenerator {
#source: AsyncGenerator<T>
#timeout: number
constructor(source: AsyncGenerator<T>, timeout: number) {
assert.ok(timeout > 0, `Timeout value must be positive, ${timeout} received`)
this.#source = source
this.#timeout = timeout
}
async next(): Promise<IteratorResult<T>> {
let timeout: ReturnType<typeof setTimeout>
const promiseTimeout = new Promise((_, reject) => {
timeout = setTimeout(() => {
reject(new Error('Timeout reached '))
}, this.#timeout)
})
const promiseNext = new Promise((resolve, reject) => {
this.#source.next().then(res => {
// ensure timetout won't fire later
clearTimeout(timeout)
resolve(res)
}, reject)
})
// promiseTimeout will never resolve
return Promise.race([promiseNext, promiseTimeout]) as Promise<IteratorResult<T>>
}
return(): Promise<IteratorResult<T>> {
return this.#source.return(undefined)
}
throw(e: Error): Promise<IteratorResult<T>> {
return this.#source.throw(e)
}
[Symbol.asyncIterator](): AsyncGenerator<T> {
return this
}
}

View File

@@ -0,0 +1,67 @@
import { describe, it } from 'node:test'
import assert from 'node:assert'
import { Timeout } from './timeout.mjs'
describe('Timeout class', () => {
it('should reject a timeout with a negative or zero value ', async () => {
// Create a mock async generator that never resolves
const mockGenerator = (async function* () {
yield 1
})()
assert.throws(() => new Timeout(mockGenerator, 0))
assert.throws(() => new Timeout(mockGenerator, -10))
})
it('should resolve with the value from the source generator if it completes before the timeout', async () => {
// Create a mock async generator that resolves immediately
const mockGenerator = (async function* () {
yield 1
})()
const timeout = new Timeout(mockGenerator, 100) // 100ms timeout
const result = await timeout.next()
assert.strictEqual(result.value, 1)
assert.strictEqual(result.done, false)
})
it('should reject with a timeout error if the source generator takes too long', async () => {
// Create a mock async generator that never resolves
// eslint-disable-next-line require-yield
const mockGenerator = (async function* () {
await new Promise(() => {}) // Never resolves
})()
const timeout = new Timeout(mockGenerator, 10) // 10ms timeout
await assert.rejects(timeout.next(), 'Expected timeout error was not thrown')
})
it('should allow iteration using for-await-of', async () => {
// Create a mock async generator that yields values
const mockGenerator: AsyncGenerator<number> = (async function* () {
yield 1
yield 2
yield 3
})()
const timeout = new Timeout(mockGenerator, 100) // 100ms timeout
const results: Array<number> = []
for await (const value of timeout) {
results.push(value as number)
}
assert.deepStrictEqual(results, [1, 2, 3])
})
it('should handle the throw method correctly', async () => {
// Create a mock async generator with a throw method
const mockGenerator = (async function* () {
yield 1
})()
const timeout = new Timeout(mockGenerator, 100) // 100ms timeout
await assert.rejects(timeout.throw(new Error('Test error')), 'Expected error was not thrown')
})
})

View File

@@ -0,0 +1,12 @@
{
"compilerOptions": {
"target": "es2023",
"module": "ESNext",
"moduleResolution": "bundler",
"strict": true,
"declaration": true, // Generates `.d.ts` files for type safety
"outDir": "dist" // Outputs compiled code to the `dist` directory
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist"]
}

View File

@@ -1,4 +1,4 @@
The use for this librariy is to create a composite key from a JSON value, ignoring objects identity and properties order.
The use for this library is to create a composite key from a JSON value, ignoring objects identity and properties order.
The hash algorithm used is intended to be fast and with low collisions and is not guaranteed to be be secure.

View File

@@ -16,7 +16,7 @@ npm install --save @vates/json-hash
## Usage
The use for this librariy is to create a composite key from a JSON value, ignoring objects identity and properties order.
The use for this library is to create a composite key from a JSON value, ignoring objects identity and properties order.
The hash algorithm used is intended to be fast and with low collisions and is not guaranteed to be be secure.

View File

@@ -2,7 +2,7 @@
const { jsonHash } = require('@vates/json-hash')
const assert = require('node:assert/strict')
const test = require('test')
const test = require('node:test')
const cases = [
[null, 'dCNOmK_nSY-12vHzasLXiswzlGT5UHA7jAGYkvmCuQs'],

View File

@@ -23,11 +23,8 @@
"engines": {
"node": ">=14.18.0"
},
"devDependencies": {
"test": "^3.3.0"
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
}
}

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const assert = require('node:assert')
const { MultiKeyMap } = require('./')

View File

@@ -24,9 +24,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.2.1"
"test": "node --test"
}
}

View File

@@ -1,6 +1,6 @@
export const INIT_PASSWD = Buffer.from('NBDMAGIC') // "NBDMAGIC" ensure we're connected to a nbd server
export const OPTS_MAGIC = Buffer.from('IHAVEOPT') // "IHAVEOPT" start an option block
export const NBD_OPT_REPLY_MAGIC = 1100100111001001n // magic received during negociation
export const NBD_OPT_REPLY_MAGIC = 1100100111001001n // magic received during negotiation
export const NBD_OPT_EXPORT_NAME = 1
export const NBD_OPT_ABORT = 2
export const NBD_OPT_LIST = 3

View File

@@ -1,7 +1,7 @@
import assert from 'node:assert'
import { Socket } from 'node:net'
import { connect } from 'node:tls'
import { fromCallback, pRetry, pDelay, pTimeout, pFromCallback } from 'promise-toolbox'
import { pRetry, pDelay, pTimeout, pFromCallback } from 'promise-toolbox'
import { readChunkStrict } from '@vates/read-chunk'
import { createLogger } from '@xen-orchestra/log'
import {
@@ -20,6 +20,7 @@ import {
OPTS_MAGIC,
NBD_CMD_DISC,
} from './constants.mjs'
const { warn } = createLogger('vates:nbd-client')
// documentation is here : https://github.com/NetworkBlockDevice/nbd/blob/master/doc/proto.md
@@ -42,9 +43,9 @@ export default class NbdClient {
// AFAIK, there is no guaranty the server answers in the same order as the queries
// so we handle a backlog of command waiting for response and handle concurrency manually
#waitingForResponse // there is already a listenner waiting for a response
#waitingForResponse // there is already a listener waiting for a response
#nextCommandQueryId = BigInt(0)
#commandQueryBacklog // map of command waiting for an response queryId => { size/*in byte*/, resolve, reject}
#commandQueryBacklog // map of command waiting for a response queryId => { size/*in byte*/, resolve, reject}
#connected = false
#reconnectingPromise
@@ -195,7 +196,7 @@ export default class NbdClient {
}
// send export name we want to access.
// it's implictly closing the negociation phase.
// it's implicitly closing the negotiation phase.
await this.#write(OPTS_MAGIC)
await this.#writeInt32(NBD_OPT_EXPORT_NAME)
const exportNameBuffer = Buffer.from(this.#exportName)
@@ -218,8 +219,22 @@ export default class NbdClient {
}
#write(buffer) {
const promise = fromCallback.call(this.#serverSocket, 'write', buffer)
return pTimeout.call(promise, this.#messageTimeout)
let timeout
const messageTimeout = this.#messageTimeout
const socket = this.#serverSocket
return Promise.race([
new Promise((resolve, reject) => {
timeout = setTimeout(() => {
reject(new Error('timeout'))
}, messageTimeout)
}),
new Promise(resolve =>
socket.write(buffer, () => {
clearTimeout(timeout)
resolve()
})
),
])
}
async #readInt32() {

View File

@@ -30,13 +30,14 @@ export default class MultiNbdClient {
* open nbdConcurrency connections to NBD servers
* it must obtain at least one connection to succeed
* it tries to spread connections on multiple host
*
* @returns {Promise<void>}
*/
async connect() {
const candidates = [...this.#settings]
const promises = []
const baseOptions = this.#options
const _connect = async () => {
const _connect = async () => {
if (candidates.length === 0) {
return
}
@@ -63,13 +64,15 @@ export default class MultiNbdClient {
return _connect()
}
}
// don't connect in parallel since this can lead to race condition
// on distributed systems ( like the NBD server of the XAPI)
for (let i = 0; i < this.#nbdConcurrency; i++) {
promises.push(_connect())
await _connect()
}
await Promise.all(promises)
if (this.#clients.length === 0) {
throw new Error(`Fail to connect to any Nbd client`)
const error = new Error(`Fail to connect to any Nbd client`, { nbdInfos: this.#settings })
error.code = 'NO_NBD_AVAILABLE'
throw error
}
if (this.#clients.length < this.#nbdConcurrency) {
warn(
@@ -78,17 +81,30 @@ export default class MultiNbdClient {
}
}
/**
* @returns {Promise<void>}
*/
async disconnect() {
await asyncEach(this.#clients, client => client.disconnect(), {
stopOnError: false,
})
}
/**
*
* @param {number} index
* @param {number} size
* @returns {Promise<Buffer>}
*/
async readBlock(index, size = NBD_DEFAULT_BLOCK_SIZE) {
const clientId = index % this.#clients.length
return this.#clients[clientId].readBlock(index, size)
}
/**
*
* @param {AsyncGenerator<Buffer>} indexGenerator
*/
async *readBlocks(indexGenerator) {
// default : read all blocks
const readAhead = []

View File

@@ -13,7 +13,7 @@
"url": "https://vates.fr"
},
"license": "ISC",
"version": "3.1.0",
"version": "3.1.4",
"engines": {
"node": ">=14.0"
},
@@ -22,9 +22,9 @@
"@vates/async-each": "^1.0.0",
"@vates/read-chunk": "^1.2.0",
"@xen-orchestra/async-map": "^0.1.2",
"@xen-orchestra/log": "^0.6.0",
"@xen-orchestra/log": "^0.7.1",
"promise-toolbox": "^0.21.0",
"xen-api": "^4.3.1"
"xen-api": "^4.7.3"
},
"devDependencies": {
"tap": "^18.7.0",

View File

@@ -24,7 +24,7 @@ $ npm install node-vsphere-soap --save
## Sample Code
### To connect to a vCenter server:
### To connect to a vCenter server
var nvs = require('node-vsphere-soap');
var vc = new nvs.Client(host, user, password, sslVerify);
@@ -54,7 +54,7 @@ $ npm install node-vsphere-soap --save
- userName - username of authenticated user
- fullName - full name of authenticated user
### To run a command:
### To run a command
var vcCmd = vc.runCommand( commandToRun, arguments );
vcCmd.once('result', function( result, raw, soapHeader) {

View File

@@ -7,7 +7,7 @@
This file creates the Client class
- when the class is instantiated, a connection will be made to the ESXi/vCenter server to verify that the creds are good
- upon a bad login, the connnection will be terminated
- upon a bad login, the connection will be terminated
*/

View File

@@ -1,6 +1,6 @@
{
"name": "@vates/node-vsphere-soap",
"version": "2.1.0",
"version": "2.1.2",
"description": "interface to vSphere SOAP/WSDL from node for interfacing with vCenter or ESXi, forked from node-vsphere-soap",
"main": "lib/client.mjs",
"author": "reedog117",
@@ -11,14 +11,11 @@
},
"bugs": "https://github.com/vatesfr/xen-orchestra/issues",
"dependencies": {
"@xen-orchestra/log": "^0.6.0",
"axios": "^1.4.0",
"@xen-orchestra/log": "^0.7.1",
"axios": "^1.8.0",
"soap": "^1.0.0",
"soap-cookie": "^0.10.1"
},
"devDependencies": {
"test": "^3.3.0"
},
"keywords": [
"vsphere",
"vcenter",

View File

@@ -5,7 +5,7 @@
*/
import assert from 'assert'
import { describe, it } from 'test'
import { describe, it } from 'node:test'
import * as vc from '../lib/client.mjs'

View File

@@ -1,6 +1,6 @@
### Usual workflow
> This section presents how this library should be used to implement a classic two factor authentification.
> This section presents how this library should be used to implement a classic two factor authentication.
#### Setup

View File

@@ -18,7 +18,7 @@ npm install --save @vates/otp
### Usual workflow
> This section presents how this library should be used to implement a classic two factor authentification.
> This section presents how this library should be used to implement a classic two factor authentication.
#### Setup

View File

@@ -1,5 +1,5 @@
import { strict as assert } from 'node:assert'
import test from 'test'
import test from 'node:test'
import {
generateHotp,

View File

@@ -31,9 +31,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.3.0"
"test": "node --test"
}
}

View File

@@ -1,7 +1,7 @@
'use strict'
const assert = require('assert/strict')
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const { every, not, some } = require('./')

View File

@@ -32,9 +32,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.3.0"
"test": "node --test"
}
}

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const assert = require('node:assert').strict
const { Readable } = require('stream')

View File

@@ -25,15 +25,12 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
},
"author": {
"name": "Vates SAS",
"url": "https://vates.fr"
},
"devDependencies": {
"test": "^3.2.1"
},
"dependencies": {
"isutf8": "^4.0.0"
}

View File

@@ -1,6 +1,6 @@
'use strict'
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const assert = require('node:assert').strict
const { Readable } = require('stream')

View File

@@ -31,9 +31,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
},
"devDependencies": {
"test": "^3.3.0"
"test": "node --test"
}
}

View File

@@ -49,21 +49,30 @@ const result = await task.runInside(fn)
// if fn rejects, the task will be marked as failed
// if fn resolves, the task will be marked as succeeded
const result = await task.run(fn)
// manually starts the task
task.start()
// manually finishes the task in success state
task.success(result)
// manually finishes the task in failure state
task.failure(error)
```
Inside a task:
```js
// the abort signal of the current task if any, otherwise is `undefined`
// the abort signal of the current task if any; otherwise, is `undefined`
Task.abortSignal
// sends an info on the current task if any, otherwise does nothing
// sends an info on the current task if any; otherwise, does nothing
Task.info(message, data)
// sends an info on the current task if any, otherwise does nothing
// sends an info on the current task if any; otherwise, does nothing
Task.warning(message, data)
// attaches a property to the current task if any, otherwise does nothing
// attaches a property to the current task if any; otherwise, does nothing
//
// the latest value takes precedence
//
@@ -140,7 +149,7 @@ const onProgress = makeOnProgress({
// This function is called each time a root task or a subtask is updated.
//
// `taskLog.$root` can be used to uncondionally access the root task.
// `taskLog.$root` can be used to unconditionally access the root task.
onTaskUpdate(taskLog) {},
})

View File

@@ -65,21 +65,30 @@ const result = await task.runInside(fn)
// if fn rejects, the task will be marked as failed
// if fn resolves, the task will be marked as succeeded
const result = await task.run(fn)
// manually starts the task
task.start()
// manually finishes the task in success state
task.success(result)
// manually finishes the task in failure state
task.failure(error)
```
Inside a task:
```js
// the abort signal of the current task if any, otherwise is `undefined`
// the abort signal of the current task if any; otherwise, is `undefined`
Task.abortSignal
// sends an info on the current task if any, otherwise does nothing
// sends an info on the current task if any; otherwise, does nothing
Task.info(message, data)
// sends an info on the current task if any, otherwise does nothing
// sends an info on the current task if any; otherwise, does nothing
Task.warning(message, data)
// attaches a property to the current task if any, otherwise does nothing
// attaches a property to the current task if any; otherwise, does nothing
//
// the latest value takes precedence
//
@@ -156,7 +165,7 @@ const onProgress = makeOnProgress({
// This function is called each time a root task or a subtask is updated.
//
// `taskLog.$root` can be used to uncondionally access the root task.
// `taskLog.$root` can be used to unconditionally access the root task.
onTaskUpdate(taskLog) {},
})

View File

@@ -1,7 +1,7 @@
'use strict'
const assert = require('node:assert').strict
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const { makeOnProgress } = require('./combineEvents.js')
const { Task } = require('./index.js')

View File

@@ -29,7 +29,7 @@ class Task {
static get abortSignal() {
const task = getTask()
if (task !== undefined) {
return task.#abortController.signal
return task._abortController.signal
}
}
@@ -65,8 +65,11 @@ class Task {
}
}
#abortController = new AbortController()
#onProgress
// These two properties should not be used outside the class
//
// To ensure compatibility between multiple versions of this lib, they are kept public for now
_abortController = new AbortController()
_onProgress
get id() {
return (this.id = Math.random().toString(36).slice(2))
@@ -86,23 +89,23 @@ class Task {
this.#startData = { properties }
if (onProgress !== undefined) {
this.#onProgress = onProgress
this._onProgress = onProgress
} else {
const parent = getTask()
if (parent !== undefined) {
const { signal } = parent.#abortController
const { signal } = parent._abortController
signal.addEventListener('abort', () => {
this.#abortController.abort(signal.reason)
this._abortController.abort(signal.reason)
})
this.#onProgress = parent.#onProgress
this._onProgress = parent._onProgress
this.#startData.parentId = parent.id
} else {
this.#onProgress = noop
this._onProgress = noop
}
}
const { signal } = this.#abortController
const { signal } = this._abortController
signal.addEventListener('abort', () => {
if (this.status === PENDING) {
this.#maybeStart()
@@ -117,7 +120,7 @@ class Task {
}
abort(reason) {
this.#abortController.abort(reason)
this._abortController.abort(reason)
}
#emit(type, data) {
@@ -126,15 +129,20 @@ class Task {
data.id = this.id
data.timestamp = Date.now()
data.type = type
this.#onProgress(data)
this._onProgress(data)
}
#end(status, result) {
assert.equal(this.#status, PENDING)
assert.equal(this.#running, false)
this.#status = status
this.#emit('end', { status, result })
this.#onProgress = alreadyEnded
this._onProgress = alreadyEnded
this.#status = status
}
failure(error) {
this.#end(FAILURE, error)
}
info(message, data) {
@@ -142,10 +150,8 @@ class Task {
}
#maybeStart() {
const startData = this.#startData
if (startData !== undefined) {
this.#startData = undefined
this.#emit('start', startData)
if (this.#startData !== undefined) {
this.start()
}
}
@@ -170,6 +176,7 @@ class Task {
this.#running = false
return result
} catch (result) {
this.#running = false
this.#end(FAILURE, result)
throw result
}
@@ -181,6 +188,18 @@ class Task {
this.#emit('property', { name, value })
}
start() {
const startData = this.#startData
assert.notEqual(startData, undefined, 'task has already started')
this.#startData = undefined
this.#emit('start', startData)
}
success(result) {
this.#end(SUCCESS, result)
}
warning(message, data) {
assert.equal(this.status, PENDING)

View File

@@ -1,7 +1,7 @@
'use strict'
const assert = require('node:assert').strict
const { describe, it } = require('test')
const { describe, it } = require('node:test')
const { makeOnProgress } = require('./combineEvents.js')
const { Task } = require('./index.js')
@@ -29,7 +29,7 @@ function createTask(opts) {
}
describe('Task', function () {
describe('contructor', function () {
describe('constructor', function () {
it('data properties are passed to the start event', async function () {
const properties = { foo: 0, bar: 1 }
const task = createTask({ properties })
@@ -145,6 +145,43 @@ describe('Task', function () {
})
})
describe('#failure()', function () {
const error = new Error()
it('throws if the task has not started yet', function () {
const task = createTask()
assert.throws(() => task.failure(error), { message: /^task has not started yet\b/ })
})
it('throws if the task is running', function () {
const task = createTask()
task.runInside(noop)
assert.throws(() => task.failure(error), { code: 'ERR_ASSERTION' })
})
it('throws if the task has already finished', function () {
const task = createTask()
task.start()
task.success()
assert.throws(() => task.failure(error), { code: 'ERR_ASSERTION' })
})
it('finishes the task and mark it as failed', function () {
const task = createTask()
task.start()
task.failure(error)
assertEvent(task, {
status: 'failure',
result: error,
type: 'end',
})
})
})
describe('.info()', function () {
it('does nothing when run outside a task', function () {
Task.info('foo')
@@ -225,10 +262,10 @@ describe('Task', function () {
it('throws when the task is not started', function () {
const task = createTask()
assert.throws(() => task.set(name, value), { message: 'task has not started yet' })
assert.throws(() => task.set(name, value), { message: /^task has not started yet\b/ })
})
it(`emits an property message`, async function () {
it(`emits a property message`, async function () {
const task = createTask()
await task.run(async () => {
await Task.run(() => {
@@ -244,12 +281,65 @@ describe('Task', function () {
})
})
describe('#start', function () {
it('starts the task', function () {
const task = createTask()
task.start()
assertEvent(task, { type: 'start' })
})
it('throws when the task has already started', function () {
const task = createTask()
task.start()
assert.throws(() => task.start(), { message: 'task has already started' })
})
})
describe('#success()', function () {
const result = {}
it('throws if the task has not started yet', function () {
const task = createTask()
assert.throws(() => task.success(result), { message: /^task has not started yet\b/ })
})
it('throws if the task is running', function () {
const task = createTask()
task.runInside(noop)
assert.throws(() => task.success(result), { code: 'ERR_ASSERTION' })
})
it('throws if the task has already finished', function () {
const task = createTask()
task.start()
task.success()
assert.throws(() => task.success(result), { code: 'ERR_ASSERTION' })
})
it('finishes the task and mark it as successful', function () {
const task = createTask()
task.start()
task.success(result)
assertEvent(task, {
status: 'success',
result,
type: 'end',
})
})
})
describe('.warning()', function () {
it('does nothing when run outside a task', function () {
Task.warning('foo')
})
it('emits an warning message when run inside a task', async function () {
it('emits a warning message when run inside a task', async function () {
const task = createTask()
await task.run(() => {
Task.warning('foo')
@@ -266,7 +356,7 @@ describe('Task', function () {
describe(`#${type}()`, function () {
it('throws when the task is not started', function () {
const task = createTask()
assert.throws(() => task[type]('foo'), { message: 'task has not started yet' })
assert.throws(() => task[type]('foo'), { message: /^task has not started yet\b/ })
})
it(`emits an ${type} message`, async function () {

View File

@@ -13,16 +13,13 @@
"url": "https://vates.fr"
},
"license": "ISC",
"version": "0.4.1",
"version": "0.6.2",
"engines": {
"node": ">=14"
},
"devDependencies": {
"test": "^3.3.0"
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
},
"exports": {
".": "./index.js",

1
@vates/types/.npmignore Symbolic link
View File

@@ -0,0 +1 @@
../../scripts/npmignore

View File

@@ -0,0 +1,12 @@
// @ts-check
import eslint from '@eslint/js'
import tseslint from 'typescript-eslint'
export default tseslint.config(eslint.configs.recommended, tseslint.configs.recommended, {
ignores: ['dist'],
rules: {
// Allow empty interface for recursive generic typing (E.g. interface XenApiNetworkWrapped)
'@typescript-eslint/no-empty-object-type': 'off',
},
})

52
@vates/types/package.json Normal file
View File

@@ -0,0 +1,52 @@
{
"name": "@vates/types",
"private": false,
"version": "1.10.0",
"main": "./dist/index.mjs",
"exports": {
".": {
"default": "./dist/index.mjs",
"types": "./dist/index.d.mts"
},
"./xo": "./dist/xo.d.mts",
"./xen-api": "./dist/xen-api.d.mts",
"./common": {
"default": "./dist/common.mjs",
"types": "./dist/common.d.mts"
},
"./lib/vates/*": {
"default": "./dist/lib/vates-*.mjs",
"type": "./dist/lib/vates-*.d.mts"
},
"./lib/xen-orchestra/*": {
"default": "./dist/lib/xen-orchestra-*.mjs",
"type": "./dist/lib/xen-orchestra-*.d.mts"
}
},
"type": "module",
"devDependencies": {
"@eslint/js": "^9.19.0",
"typescript": "~5.6.3",
"typescript-eslint": "^8.23.0"
},
"scripts": {
"build": "tsc",
"prepublishOnly": "yarn run build",
"postversion": "npm publish --access public"
},
"license": "AGPL-3.0-or-later",
"homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/types",
"bugs": "https://github.com/vatesfr/xen-orchestra/issues",
"repository": {
"directory": "@vates/types",
"type": "git",
"url": "https://github.com/vatesfr/xen-orchestra.git"
},
"author": {
"name": "Vates SAS",
"url": "https://vates.fr"
},
"engines": {
"node": ">=18.18"
}
}

734
@vates/types/src/common.mts Normal file
View File

@@ -0,0 +1,734 @@
import type { XoHost } from './xo.mjs'
declare const __brand: unique symbol
export type Branded<TBrand extends string, TType = string> = TType & { [__brand]: TBrand }
export const HOST_POWER_STATE = {
RUNNING: 'Running',
HALTED: 'Halted',
UNKNOWN: 'Unknown',
} as const
export type HOST_POWER_STATE = (typeof HOST_POWER_STATE)[keyof typeof HOST_POWER_STATE]
export const TASK_ALLOWED_OPERATIONS = {
CANCEL: 'cancel',
DESTROY: 'destroy',
} as const
export type TASK_ALLOWED_OPERATIONS = (typeof TASK_ALLOWED_OPERATIONS)[keyof typeof TASK_ALLOWED_OPERATIONS]
export const TASK_STATUS_TYPE = {
CANCELLED: 'cancelled',
CANCELLING: 'cancelling',
FAILURE: 'failure',
PENDING: 'pending',
SUCCESS: 'success',
} as const
export type TASK_STATUS_TYPE = (typeof TASK_STATUS_TYPE)[keyof typeof TASK_STATUS_TYPE]
export const EVENT_OPERATION = {
ADD: 'add',
DEL: 'del',
MOD: 'mod',
} as const
export type EVENT_OPERATION = (typeof EVENT_OPERATION)[keyof typeof EVENT_OPERATION]
export const POOL_ALLOWED_OPERATIONS = {
APPLY_UPDATES: 'apply_updates',
CERT_REFRESH: 'cert_refresh',
CLUSTER_CREATE: 'cluster_create',
CONFIGURE_REPOSITORIES: 'configure_repositories',
COPY_PRIMARY_HOST_CERTS: 'copy_primary_host_certs',
DESIGNATE_NEW_MASTER: 'designate_new_master',
EJECT: 'eject',
EXCHANGE_CA_CERTIFICATES_ON_JOIN: 'exchange_ca_certificates_on_join',
EXCHANGE_CERTIFICATES_ON_JOIN: 'exchange_certificates_on_join',
GET_UPDATES: 'get_updates',
HA_DISABLE: 'ha_disable',
HA_ENABLE: 'ha_enable',
SYNC_UPDATES: 'sync_updates',
TLS_VERIFICATION_ENABLE: 'tls_verification_enable',
} as const
export type POOL_ALLOWED_OPERATIONS = (typeof POOL_ALLOWED_OPERATIONS)[keyof typeof POOL_ALLOWED_OPERATIONS]
export const TELEMETRY_FREQUENCY = {
DAILY: 'daily',
MONTHLY: 'monthly',
WEEKLY: 'weekly',
} as const
export type TELEMETRY_FREQUENCY = (typeof TELEMETRY_FREQUENCY)[keyof typeof TELEMETRY_FREQUENCY]
export const UPDATE_SYNC_FREQUENCY = {
DAILY: 'daily',
WEEKLY: 'weekly',
} as const
export type UPDATE_SYNC_FREQUENCY = (typeof UPDATE_SYNC_FREQUENCY)[keyof typeof UPDATE_SYNC_FREQUENCY]
export const AFTER_APPLY_GUIDANCE = {
RESTART_HOST: 'restartHost',
RESTART_HVM: 'restartHVM',
RESTART_PV: 'restartPV',
RESTART_XAPI: 'restartXAPI',
} as const
export type AFTER_APPLY_GUIDANCE = (typeof AFTER_APPLY_GUIDANCE)[keyof typeof AFTER_APPLY_GUIDANCE]
export const UPDATE_AFTER_APPLY_GUIDANCE = {
RESTART_HOST: 'restartHost',
RESTART_HVM: 'restartHVM',
RESTART_PV: 'restartPV',
RESTART_XAPI: 'restartXAPI',
} as const
export type UPDATE_AFTER_APPLY_GUIDANCE = (typeof UPDATE_AFTER_APPLY_GUIDANCE)[keyof typeof UPDATE_AFTER_APPLY_GUIDANCE]
export const LIVEPATCH_STATUS = {
OK: 'ok',
OK_LIVEPATCH_COMPLETE: 'ok_livepatch_complete',
OK_LIVEPATCH_INCOMPLETE: 'ok_livepatch_incomplete',
} as const
export type LIVEPATCH_STATUS = (typeof LIVEPATCH_STATUS)[keyof typeof LIVEPATCH_STATUS]
export const VM_POWER_STATE = {
HALTED: 'Halted',
PAUSED: 'Paused',
RUNNING: 'Running',
SUSPENDED: 'Suspended',
} as const
export type VM_POWER_STATE = (typeof VM_POWER_STATE)[keyof typeof VM_POWER_STATE]
export const UPDATE_GUIDANCES = {
REBOOT_HOST: 'reboot_host',
REBOOT_HOST_ON_KERNEL_LIVEPATCH_FAILURE: 'reboot_host_on_kernel_livepatch_failure',
REBOOT_HOST_ON_LIVEPATCH_FAILURE: 'reboot_host_on_livepatch_failure',
REBOOT_HOST_ON_XEN_LIVEPATCH_FAILURE: 'reboot_host_on_xen_livepatch_failure',
RESTART_DEVICE_MODEL: 'restart_device_model',
RESTART_TOOLSTACK: 'restart_toolstack',
RESTART_VM: 'restart_vm',
} as const
export type UPDATE_GUIDANCES = (typeof UPDATE_GUIDANCES)[keyof typeof UPDATE_GUIDANCES]
export const ON_SOFTREBOOT_BEHAVIOR = {
DESTROY: 'destroy',
PRESERVE: 'preserve',
RESTART: 'restart',
SOFT_REBOOT: 'soft_reboot',
} as const
export type ON_SOFTREBOOT_BEHAVIOR = (typeof ON_SOFTREBOOT_BEHAVIOR)[keyof typeof ON_SOFTREBOOT_BEHAVIOR]
export const ON_NORMAL_EXIT = {
DESTROY: 'destroy',
RESTART: 'restart',
} as const
export type ON_NORMAL_EXIT = (typeof ON_NORMAL_EXIT)[keyof typeof ON_NORMAL_EXIT]
export const VM_OPERATIONS = {
ASSERT_OPERATION_VALID: 'assert_operation_valid',
AWAITING_MEMORY_LIVE: 'awaiting_memory_live',
CALL_PLUGIN: 'call_plugin',
CHANGING_DYNAMIC_RANGE: 'changing_dynamic_range',
CHANGING_MEMORY_LIMITS: 'changing_memory_limits',
CHANGING_MEMORY_LIVE: 'changing_memory_live',
CHANGING_NVRAM: 'changing_NVRAM',
CHANGING_SHADOW_MEMORY: 'changing_shadow_memory',
CHANGING_SHADOW_MEMORY_LIVE: 'changing_shadow_memory_live',
CHANGING_STATIC_RANGE: 'changing_static_range',
CHANGING_VCPUS: 'changing_VCPUs',
CHANGING_VCPUS_LIVE: 'changing_VCPUs_live',
CHECKPOINT: 'checkpoint',
CLEAN_REBOOT: 'clean_reboot',
CLEAN_SHUTDOWN: 'clean_shutdown',
CLONE: 'clone',
COPY: 'copy',
CREATE_TEMPLATE: 'create_template',
CREATE_VTPM: 'create_vtpm',
CSVM: 'csvm',
DATA_SOURCE_OP: 'data_source_op',
DESTROY: 'destroy',
EXPORT: 'export',
GET_BOOT_RECORD: 'get_boot_record',
HARD_REBOOT: 'hard_reboot',
HARD_SHUTDOWN: 'hard_shutdown',
IMPORT: 'import',
MAKE_INTO_TEMPLATE: 'make_into_template',
METADATA_EXPORT: 'metadata_export',
MIGRATE_SEND: 'migrate_send',
PAUSE: 'pause',
POOL_MIGRATE: 'pool_migrate',
POWER_STATE_RESET: 'power_state_reset',
PROVISION: 'provision',
QUERY_SERVICES: 'query_services',
RESUME: 'resume',
RESUME_ON: 'resume_on',
REVERT: 'revert',
REVERTING: 'reverting',
SEND_SYSRQ: 'send_sysrq',
SEND_TRIGGER: 'send_trigger',
SHUTDOWN: 'shutdown',
SNAPSHOT: 'snapshot',
SNAPSHOT_WITH_QUIESCE: 'snapshot_with_quiesce',
START: 'start',
START_ON: 'start_on',
SUSPEND: 'suspend',
UNPAUSE: 'unpause',
UPDATE_ALLOWED_OPERATIONS: 'update_allowed_operations',
} as const
export type VM_OPERATIONS = (typeof VM_OPERATIONS)[keyof typeof VM_OPERATIONS]
export const ON_CRASH_BEHAVIOUR = {
COREDUMP_AND_DESTROY: 'coredump_and_destroy',
COREDUMP_AND_RESTART: 'coredump_and_restart',
DESTROY: 'destroy',
PRESERVE: 'preserve',
RENAME_RESTART: 'rename_restart',
RESTART: 'restart',
} as const
export type ON_CRASH_BEHAVIOUR = (typeof ON_CRASH_BEHAVIOUR)[keyof typeof ON_CRASH_BEHAVIOUR]
export const DOMAIN_TYPE = {
HVM: 'hvm',
PV: 'pv',
PVH: 'pvh',
PV_IN_PVH: 'pv_in_pvh',
UNSPECIFIED: 'unspecified',
} as const
export type DOMAIN_TYPE = (typeof DOMAIN_TYPE)[keyof typeof DOMAIN_TYPE]
export const TRISTATE_TYPE = {
NO: 'no',
UNSPECIFIED: 'unspecified',
YES: 'yes',
} as const
export type TRISTATE_TYPE = (typeof TRISTATE_TYPE)[keyof typeof TRISTATE_TYPE]
export const VMPP_BACKUP_TYPE = {
CHECKPOINT: 'checkpoint',
SNAPSHOT: 'snapshot',
} as const
export type VMPP_BACKUP_TYPE = (typeof VMPP_BACKUP_TYPE)[keyof typeof VMPP_BACKUP_TYPE]
export const VMPP_BACKUP_FREQUENCY = {
DAILY: 'daily',
HOURLY: 'hourly',
WEEKLY: 'weekly',
} as const
export type VMPP_BACKUP_FREQUENCY = (typeof VMPP_BACKUP_FREQUENCY)[keyof typeof VMPP_BACKUP_FREQUENCY]
export const VMPP_ARCHIVE_FREQUENCY = {
ALWAYS_AFTER_BACKUP: 'always_after_backup',
DAILY: 'daily',
NEVER: 'never',
WEEKLY: 'weekly',
} as const
export type VMPP_ARCHIVE_FREQUENCY = (typeof VMPP_ARCHIVE_FREQUENCY)[keyof typeof VMPP_ARCHIVE_FREQUENCY]
export const VMPP_ARCHIVE_TARGET_TYPE = {
CIFS: 'cifs',
NFS: 'nfs',
NONE: 'none',
} as const
export type VMPP_ARCHIVE_TARGET_TYPE = (typeof VMPP_ARCHIVE_TARGET_TYPE)[keyof typeof VMPP_ARCHIVE_TARGET_TYPE]
export const VMSS_FREQUENCY = {
DAILY: 'daily',
HOURLY: 'hourly',
WEEKLY: 'weekly',
} as const
export type VMSS_FREQUENCY = (typeof VMSS_FREQUENCY)[keyof typeof VMSS_FREQUENCY]
export const VMSS_TYPE = {
CHECKPOINT: 'checkpoint',
SNAPSHOT: 'snapshot',
SNAPSHOT_WITH_QUIESCE: 'snapshot_with_quiesce',
} as const
export type VMSS_TYPE = (typeof VMSS_TYPE)[keyof typeof VMSS_TYPE]
export const VM_APPLIANCE_OPERATION = {
CLEAN_SHUTDOWN: 'clean_shutdown',
HARD_SHUTDOWN: 'hard_shutdown',
SHUTDOWN: 'shutdown',
START: 'start',
} as const
export type VM_APPLIANCE_OPERATION = (typeof VM_APPLIANCE_OPERATION)[keyof typeof VM_APPLIANCE_OPERATION]
export const HOST_ALLOWED_OPERATIONS = {
APPLY_UPDATES: 'apply_updates',
ENABLE: 'enable',
EVACUATE: 'evacuate',
POWER_ON: 'power_on',
PROVISION: 'provision',
REBOOT: 'reboot',
SHUTDOWN: 'shutdown',
VM_MIGRATE: 'vm_migrate',
VM_RESUME: 'vm_resume',
VM_START: 'vm_start',
} as const
export type HOST_ALLOWED_OPERATIONS = (typeof HOST_ALLOWED_OPERATIONS)[keyof typeof HOST_ALLOWED_OPERATIONS]
export const LATEST_SYNCED_UPDATES_APPLIED_STATE = {
NO: 'no',
UNKNOWN: 'unknown',
YES: 'yes',
} as const
export type LATEST_SYNCED_UPDATES_APPLIED_STATE =
(typeof LATEST_SYNCED_UPDATES_APPLIED_STATE)[keyof typeof LATEST_SYNCED_UPDATES_APPLIED_STATE]
export const HOST_DISPLAY = {
DISABLED: 'disabled',
DISABLE_ON_REBOOT: 'disable_on_reboot',
ENABLED: 'enabled',
ENABLE_ON_REBOOT: 'enable_on_reboot',
} as const
export type HOST_DISPLAY = (typeof HOST_DISPLAY)[keyof typeof HOST_DISPLAY]
export const HOST_SCHED_GRAN = {
CORE: 'core',
CPU: 'cpu',
SOCKET: 'socket',
} as const
export type HOST_SCHED_GRAN = (typeof HOST_SCHED_GRAN)[keyof typeof HOST_SCHED_GRAN]
export const HOST_NUMA_AFFINITY_POLICY = {
ANY: 'any',
BEST_EFFORT: 'best_effort',
DEFAULT_POLICY: 'default_policy',
} as const
export type HOST_NUMA_AFFINITY_POLICY = (typeof HOST_NUMA_AFFINITY_POLICY)[keyof typeof HOST_NUMA_AFFINITY_POLICY]
export const NETWORK_OPERATIONS = {
ATTACHING: 'attaching',
} as const
export type NETWORK_OPERATIONS = (typeof NETWORK_OPERATIONS)[keyof typeof NETWORK_OPERATIONS]
export const NETWORK_DEFAULT_LOCKING_MODE = {
DISABLED: 'disabled',
UNLOCKED: 'unlocked',
} as const
export type NETWORK_DEFAULT_LOCKING_MODE =
(typeof NETWORK_DEFAULT_LOCKING_MODE)[keyof typeof NETWORK_DEFAULT_LOCKING_MODE]
export const NETWORK_PURPOSE = {
INSECURE_NBD: 'insecure_nbd',
NBD: 'nbd',
} as const
export type NETWORK_PURPOSE = (typeof NETWORK_PURPOSE)[keyof typeof NETWORK_PURPOSE]
export const VIF_OPERATIONS = {
ATTACH: 'attach',
PLUG: 'plug',
UNPLUG: 'unplug',
} as const
export type VIF_OPERATIONS = (typeof VIF_OPERATIONS)[keyof typeof VIF_OPERATIONS]
export const VIF_LOCKING_MODE = {
DISABLED: 'disabled',
LOCKED: 'locked',
NETWORK_DEFAULT: 'network_default',
UNLOCKED: 'unlocked',
} as const
export type VIF_LOCKING_MODE = (typeof VIF_LOCKING_MODE)[keyof typeof VIF_LOCKING_MODE]
export const VIF_IPV4_CONFIGURATION_MODE = {
NONE: 'None',
STATIC: 'Static',
} as const
export type VIF_IPV4_CONFIGURATION_MODE = (typeof VIF_IPV4_CONFIGURATION_MODE)[keyof typeof VIF_IPV4_CONFIGURATION_MODE]
export const VIF_IPV6_CONFIGURATION_MODE = {
NONE: 'None',
STATIC: 'Static',
} as const
export type VIF_IPV6_CONFIGURATION_MODE = (typeof VIF_IPV6_CONFIGURATION_MODE)[keyof typeof VIF_IPV6_CONFIGURATION_MODE]
export const PIF_IGMP_STATUS = {
DISABLED: 'disabled',
ENABLED: 'enabled',
UNKNOWN: 'unknown',
} as const
export type PIF_IGMP_STATUS = (typeof PIF_IGMP_STATUS)[keyof typeof PIF_IGMP_STATUS]
export const IP_CONFIGURATION_MODE = {
DHCP: 'DHCP',
NONE: 'None',
STATIC: 'Static',
} as const
export type IP_CONFIGURATION_MODE = (typeof IP_CONFIGURATION_MODE)[keyof typeof IP_CONFIGURATION_MODE]
export const IPV6_CONFIGURATION_MODE = {
AUTOCONF: 'Autoconf',
DHCP: 'DHCP',
NONE: 'None',
STATIC: 'Static',
} as const
export type IPV6_CONFIGURATION_MODE = (typeof IPV6_CONFIGURATION_MODE)[keyof typeof IPV6_CONFIGURATION_MODE]
export const PRIMARY_ADDRESS_TYPE = {
IPV4: 'IPv4',
IPV6: 'IPv6',
} as const
export type PRIMARY_ADDRESS_TYPE = (typeof PRIMARY_ADDRESS_TYPE)[keyof typeof PRIMARY_ADDRESS_TYPE]
export const BOND_MODE = {
ACTIVE_BACKUP: 'active-backup',
BALANCE_SLB: 'balance-slb',
LACP: 'lacp',
} as const
export type BOND_MODE = (typeof BOND_MODE)[keyof typeof BOND_MODE]
export const STORAGE_OPERATIONS = {
DESTROY: 'destroy',
FORGET: 'forget',
PBD_CREATE: 'pbd_create',
PBD_DESTROY: 'pbd_destroy',
PLUG: 'plug',
SCAN: 'scan',
UNPLUG: 'unplug',
UPDATE: 'update',
VDI_CLONE: 'vdi_clone',
VDI_CREATE: 'vdi_create',
VDI_DATA_DESTROY: 'vdi_data_destroy',
VDI_DESTROY: 'vdi_destroy',
VDI_DISABLE_CBT: 'vdi_disable_cbt',
VDI_ENABLE_CBT: 'vdi_enable_cbt',
VDI_INTRODUCE: 'vdi_introduce',
VDI_LIST_CHANGED_BLOCKS: 'vdi_list_changed_blocks',
VDI_MIRROR: 'vdi_mirror',
VDI_RESIZE: 'vdi_resize',
VDI_SET_ON_BOOT: 'vdi_set_on_boot',
VDI_SNAPSHOT: 'vdi_snapshot',
} as const
export type STORAGE_OPERATIONS = (typeof STORAGE_OPERATIONS)[keyof typeof STORAGE_OPERATIONS]
export const SR_HEALTH = {
HEALTHY: 'healthy',
RECOVERING: 'recovering',
} as const
export type SR_HEALTH = (typeof SR_HEALTH)[keyof typeof SR_HEALTH]
export const VDI_OPERATIONS = {
BLOCKED: 'blocked',
CLONE: 'clone',
COPY: 'copy',
DATA_DESTROY: 'data_destroy',
DESTROY: 'destroy',
DISABLE_CBT: 'disable_cbt',
ENABLE_CBT: 'enable_cbt',
FORCE_UNLOCK: 'force_unlock',
FORGET: 'forget',
GENERATE_CONFIG: 'generate_config',
LIST_CHANGED_BLOCKS: 'list_changed_blocks',
MIRROR: 'mirror',
RESIZE: 'resize',
RESIZE_ONLINE: 'resize_online',
SET_ON_BOOT: 'set_on_boot',
SNAPSHOT: 'snapshot',
UPDATE: 'update',
} as const
export type VDI_OPERATIONS = (typeof VDI_OPERATIONS)[keyof typeof VDI_OPERATIONS]
export const VDI_TYPE = {
CBT_METADATA: 'cbt_metadata',
CRASHDUMP: 'crashdump',
EPHEMERAL: 'ephemeral',
HA_STATEFILE: 'ha_statefile',
METADATA: 'metadata',
PVS_CACHE: 'pvs_cache',
REDO_LOG: 'redo_log',
RRD: 'rrd',
SUSPEND: 'suspend',
SYSTEM: 'system',
USER: 'user',
} as const
export type VDI_TYPE = (typeof VDI_TYPE)[keyof typeof VDI_TYPE]
export const ON_BOOT = {
PERSIST: 'persist',
RESET: 'reset',
} as const
export type ON_BOOT = (typeof ON_BOOT)[keyof typeof ON_BOOT]
export const VBD_OPERATIONS = {
ATTACH: 'attach',
EJECT: 'eject',
INSERT: 'insert',
PAUSE: 'pause',
PLUG: 'plug',
UNPAUSE: 'unpause',
UNPLUG: 'unplug',
UNPLUG_FORCE: 'unplug_force',
} as const
export type VBD_OPERATIONS = (typeof VBD_OPERATIONS)[keyof typeof VBD_OPERATIONS]
export const VBD_TYPE = {
CD: 'CD',
DISK: 'Disk',
FLOPPY: 'Floppy',
} as const
export type VBD_TYPE = (typeof VBD_TYPE)[keyof typeof VBD_TYPE]
export const VBD_MODE = {
RO: 'RO',
RW: 'RW',
} as const
export type VBD_MODE = (typeof VBD_MODE)[keyof typeof VBD_MODE]
export const VTPM_OPERATIONS = {
DESTROY: 'destroy',
} as const
export type VTPM_OPERATIONS = (typeof VTPM_OPERATIONS)[keyof typeof VTPM_OPERATIONS]
export const PERSISTENCE_BACKEND = {
XAPI: 'xapi',
} as const
export type PERSISTENCE_BACKEND = (typeof PERSISTENCE_BACKEND)[keyof typeof PERSISTENCE_BACKEND]
export const CONSOLE_PROTOCOL = {
RDP: 'rdp',
RFB: 'rfb',
VT100: 'vt100',
} as const
export type CONSOLE_PROTOCOL = (typeof CONSOLE_PROTOCOL)[keyof typeof CONSOLE_PROTOCOL]
export const CLS = {
CERTIFICATE: 'Certificate',
HOST: 'Host',
POOL: 'Pool',
PVS_PROXY: 'PVS_proxy',
SR: 'SR',
VDI: 'VDI',
VM: 'VM',
VMPP: 'VMPP',
VMSS: 'VMSS',
} as const
export type CLS = (typeof CLS)[keyof typeof CLS]
export const TUNNEL_PROTOCOL = {
GRE: 'gre',
VXLAN: 'vxlan',
} as const
export type TUNNEL_PROTOCOL = (typeof TUNNEL_PROTOCOL)[keyof typeof TUNNEL_PROTOCOL]
export const SRIOV_CONFIGURATION_MODE = {
MANUAL: 'manual',
MODPROBE: 'modprobe',
SYSFS: 'sysfs',
UNKNOWN: 'unknown',
} as const
export type SRIOV_CONFIGURATION_MODE = (typeof SRIOV_CONFIGURATION_MODE)[keyof typeof SRIOV_CONFIGURATION_MODE]
export const PGPU_DOM0_ACCESS = {
DISABLED: 'disabled',
DISABLE_ON_REBOOT: 'disable_on_reboot',
ENABLED: 'enabled',
ENABLE_ON_REBOOT: 'enable_on_reboot',
} as const
export type PGPU_DOM0_ACCESS = (typeof PGPU_DOM0_ACCESS)[keyof typeof PGPU_DOM0_ACCESS]
export const ALLOCATION_ALGORITHM = {
BREADTH_FIRST: 'breadth_first',
DEPTH_FIRST: 'depth_first',
} as const
export type ALLOCATION_ALGORITHM = (typeof ALLOCATION_ALGORITHM)[keyof typeof ALLOCATION_ALGORITHM]
export const VGPU_TYPE_IMPLEMENTATION = {
GVT_G: 'gvt_g',
MXGPU: 'mxgpu',
NVIDIA: 'nvidia',
NVIDIA_SRIOV: 'nvidia_sriov',
PASSTHROUGH: 'passthrough',
} as const
export type VGPU_TYPE_IMPLEMENTATION = (typeof VGPU_TYPE_IMPLEMENTATION)[keyof typeof VGPU_TYPE_IMPLEMENTATION]
export const PVS_PROXY_STATUS = {
CACHING: 'caching',
INCOMPATIBLE_PROTOCOL_VERSION: 'incompatible_protocol_version',
INCOMPATIBLE_WRITE_CACHE_MODE: 'incompatible_write_cache_mode',
INITIALISED: 'initialised',
STOPPED: 'stopped',
} as const
export type PVS_PROXY_STATUS = (typeof PVS_PROXY_STATUS)[keyof typeof PVS_PROXY_STATUS]
export const SDN_CONTROLLER_PROTOCOL = {
PSSL: 'pssl',
SSL: 'ssl',
} as const
export type SDN_CONTROLLER_PROTOCOL = (typeof SDN_CONTROLLER_PROTOCOL)[keyof typeof SDN_CONTROLLER_PROTOCOL]
export const VUSB_OPERATIONS = {
ATTACH: 'attach',
PLUG: 'plug',
UNPLUG: 'unplug',
} as const
export type VUSB_OPERATIONS = (typeof VUSB_OPERATIONS)[keyof typeof VUSB_OPERATIONS]
export const CLUSTER_OPERATION = {
ADD: 'add',
DESTROY: 'destroy',
DISABLE: 'disable',
ENABLE: 'enable',
REMOVE: 'remove',
} as const
export type CLUSTER_OPERATION = (typeof CLUSTER_OPERATION)[keyof typeof CLUSTER_OPERATION]
export const CLUSTER_HOST_OPERATION = {
DESTROY: 'destroy',
DISABLE: 'disable',
ENABLE: 'enable',
} as const
export type CLUSTER_HOST_OPERATION = (typeof CLUSTER_HOST_OPERATION)[keyof typeof CLUSTER_HOST_OPERATION]
export const CERTIFICATE_TYPE = {
CA: 'ca',
HOST: 'host',
HOST_INTERNAL: 'host_internal',
} as const
export type CERTIFICATE_TYPE = (typeof CERTIFICATE_TYPE)[keyof typeof CERTIFICATE_TYPE]
export const OPAQUE_REF = { EMPTY: 'OpaqueRef:NULL' } as const
export type OPAQUE_REF_NULL = (typeof OPAQUE_REF)['EMPTY']
export const BACKUP_TYPE = { backup: 'backup', metadata: 'metadataBackup', mirror: 'mirrorBackup' } as const
export type BACKUP_TYPE = (typeof BACKUP_TYPE)[keyof typeof BACKUP_TYPE]
// ----- XAPI Stats
type XapiStatsResponse<T> = {
endTimestamp: number
interval: number
stats: T
}
type StatValues = (number | null)[]
type RecordStatValues = Record<string, StatValues>
export type XapiStatsGranularity = 'seconds' | 'minutes' | 'hours' | 'days'
export type XapiHostStatsRaw = {
cpus?: RecordStatValues
ioThroughput?: {
r: RecordStatValues
w: RecordStatValues
}
iops?: {
r: RecordStatValues
w: RecordStatValues
}
iowait?: RecordStatValues
latency?: {
r: RecordStatValues
w: RecordStatValues
}
load?: StatValues
memory?: StatValues
memoryFree?: StatValues
pifs?: {
rx: RecordStatValues
tx: RecordStatValues
}
}
export type XapiHostStats = XapiStatsResponse<XapiHostStatsRaw>
export type XapiVmStatsRaw = {
cpus?: RecordStatValues
cpuUsage?: StatValues
runstateFullrun?: StatValues
runstateFullContention?: StatValues
runstatePartialRun?: StatValues
runstatePartialContention?: StatValues
runstateConcurrencyHazard?: StatValues
runstateBlocked?: StatValues
iops?: {
r: RecordStatValues
w: RecordStatValues
}
memory?: StatValues
memoryFree?: StatValues
memoryTarget?: StatValues
vifs?: {
rx: RecordStatValues
tx: RecordStatValues
}
vifErrors?: {
rx: RecordStatValues
tx: RecordStatValues
}
xvds?: {
w?: RecordStatValues
r?: RecordStatValues
total?: RecordStatValues
}
vbdLatency?: {
w: RecordStatValues
r: RecordStatValues
}
vbdIowait?: RecordStatValues
vbdInflight?: RecordStatValues
vbdAvgquSz?: RecordStatValues
}
export type XapiVmStats = XapiStatsResponse<XapiVmStatsRaw>
export type XapiPoolStats = Record<XoHost['id'], XapiHostStats | { error: Record<string, unknown> }>

View File

@@ -0,0 +1,4 @@
export * from './common.mjs'
export * from './xen-api.mjs'
export * from './xo.mjs'
export * from './lib/xen-orchestra-xapi.mjs'

View File

@@ -0,0 +1,7 @@
import { Branded } from '../common.mjs'
export type Task = {
id: Branded<'task'>
run: <T>(fn: () => T) => Promise<T>
}

View File

@@ -0,0 +1,176 @@
import {
WrappedXenApiRecord,
XenApiHost,
XenApiNetworkWrapped,
XenApiRecord,
XenApiSr,
XenApiTask,
XenApiVdi,
XenApiVm,
XenApiVmWrapped,
} from '../xen-api.mjs'
import type { Readable } from 'node:stream'
import type {
XoGpuGroup,
XoVgpuType,
XoHost,
XoNetwork,
XoPif,
XoSr,
XoUser,
XoVdi,
XoVm,
XoVmTemplate,
} from '../xo.mjs'
export type XcpPatches = {
changelog?: {
author: string
date: number
description: string
}
description: string
license: string
name: string
release: string
size: number
url: string
version: string
}
export type XsPatches = {
conflicts?: string[]
date: string
description: string
documentationUrl?: string
guidances: string
name: string
id?: string
paid?: boolean
requirements?: string[]
upgrade?: boolean
url?: string
uuid?: string
}
export interface Xapi {
call: <ReturnType>(...args: unknown[]) => Promise<ReturnType>
callAsync: <ReturnType>(...args: unknown[]) => Promise<ReturnType>
getField<T extends XenApiRecord, K extends keyof T>(
type: Extract<WrappedXenApiRecord, T>['$type'],
ref: T['$ref'],
field: K
): Promise<T[K]>
createNetwork(
params:
| {
name: string
description?: string
mtu?: number
}
| {
name: string
description?: string
pifId: XoPif['id']
mtu?: number
/* between 0 and 4094 */
vlan: number
}
): Promise<XenApiNetworkWrapped>
deleteNetwork(id: XoNetwork['id']): Promise<void>
listMissingPatches(host: XoHost['id']): Promise<XcpPatches[] | XsPatches[]>
pool_emergencyShutdown(): Promise<void>
resumeVm(id: XoVm['id']): Promise<void>
unpauseVm(id: XoVm['id']): Promise<void>
startVm(
id: XoVm['id'],
opts?: {
bypassMacAddressesCheck?: boolean
force?: boolean
hostId?: XoHost['id']
/**
* if startOnly is true and the VM is not halted, throw VM_BAD_POWER_STATE
* otherwise, unpause/resume the VM
*
* @default false
*/
startOnly?: boolean
}
): Promise<void>
VM_import(
stream: Readable,
srRef?: XenApiSr['$ref'],
onVmCreation?: null | ((vm: XenApiVm) => unknown)
): Promise<XenApiVm['$ref']>
createVm(
templateUuid: XoVmTemplate['uuid'],
metadataVm: {
affinityHost?: XoHost['id']
autoPoweron?: boolean
memory?: number
name_description?: string
name_label: string
nameLabel?: string
clone?: boolean
installRepository?: XoVdi['id'] | '' | null
vdis?: (
| /** Create VDI */ {
name_label: string
size: number
sr?: XoSr['id']
name_description?: string
}
| /** Update VDI*/ {
userdevice: string
name_label?: string
size?: number
sr?: XoSr['id']
name_description?: string
}
| /** Destroy VDI*/ { destroy: true; userdevice: string }
)[]
vifs?: (
| /** Create/update VIF */ {
device?: string
ipv4_allowed?: string[]
ipv6_allowed?: string[]
mac?: string
mtu?: number
network: string
}
| /** Destroy VIF */ { destroy: true; device: string }
)[]
existingVdis?: {
$SR: XoSr['id']
size: number
userdevice: string
}[]
vgpuType?: XoVgpuType['id']
gpuGroup?: XoGpuGroup['id']
copyHostBiosStrings?: boolean
},
checkLimits?: boolean,
creatorId?: XoUser['id'],
opts?: { destroyAllVifs: boolean }
): Promise<XenApiVmWrapped>
VDI_destroyCloudInitConfig(vdiRef: XenApiVdi['$ref'], opts?: { timeLimit?: number }): Promise<void>
VM_createCloudInitConfig(
vmRef: XenApiVm['$ref'],
cloudConfig: string,
opts?: { networkConfig?: string }
): Promise<XoVdi['uuid']>
VM_destroy(
vmRef: XenApiVm['$ref'],
opts?: {
deleteDisks?: boolean
force?: boolean
bypassBlockedOperation?: boolean
forceDeleteDefaultTemplate?: boolean
}
): Promise<void>
getResource(
pathname: string,
params?: { host?: XenApiHost; query?: Record<string, unknown>; task?: boolean | XenApiTask['$ref'] }
): Promise<{ body: Readable }>
isHyperThreadingEnabled(hostId: XoHost['id']): Promise<boolean | null>
}

1372
@vates/types/src/xen-api.mts Normal file

File diff suppressed because it is too large Load Diff

665
@vates/types/src/xo.mts Normal file
View File

@@ -0,0 +1,665 @@
// Types based on xapi-object-to-xo
import type {
BACKUP_TYPE,
Branded,
DOMAIN_TYPE,
HOST_ALLOWED_OPERATIONS,
HOST_POWER_STATE,
IP_CONFIGURATION_MODE,
IPV6_CONFIGURATION_MODE,
NETWORK_OPERATIONS,
PGPU_DOM0_ACCESS,
POOL_ALLOWED_OPERATIONS,
PRIMARY_ADDRESS_TYPE,
STORAGE_OPERATIONS,
VDI_OPERATIONS,
VDI_TYPE,
VIF_LOCKING_MODE,
VM_OPERATIONS,
VM_POWER_STATE,
} from './common.mjs'
type BaseXapiXo = {
$pool: XoPool['id']
/**
* @deprecated use $pool instead
*/
$poolId: XoPool['id']
_xapiRef: string
uuid: string
}
type BaseXoVm = BaseXapiXo & {
$VBDs: XoVbd['id'][]
$VGPUs: XoVgpu['id'][]
$container: XoPool['id'] | XoHost['id']
CPUs: {
max: number
number: number
}
PV_args?: string
VGPUs: XoVgpu['id'][]
VIFs: XoVif['id'][]
VTPMs: XoVtpm['id'][]
addresses: Record<string, string>
affinityHost?: XoHost['id']
attachedPcis?: string[]
auto_poweron: boolean
bios_strings: Record<string, string>
blockedOperations: Record<VM_OPERATIONS, string>
boot: Record<string, string>
coresPerSocket?: number
cpuCap?: number
cpuMask?: number[]
cpuWeight?: number
creation: Record<string, string>
current_operations: Record<string, VM_OPERATIONS>
docker?: {
containers?: string[]
enabled: boolean
info?: string
/** @deprecated */
process?: string
version?: string
}
/**
* @deprecated use isNestedVirtEnabled instead
*/
expNestedHvm: boolean
isNestedVirtEnabled: boolean
hasVendorDevice: boolean
high_availability: string
installTime?: number | null
isFirmwareSupported: boolean
memory: {
dynamic: number[]
size: number
static: number[]
usage?: number
}
mainIpAddress?: string
managementAgentDetected?: boolean
name_description: string
name_label: string
needsVtpm: boolean
nicType?: string
notes?: string
os_version: Record<string, string> | null
other: Record<string, string>
parent?: XoVm['id']
power_state: VM_POWER_STATE
pvDriversDetected?: boolean
pvDriversUpToDate?: boolean
pvDriversVersion?: string
resourceSet?: string
secureBoot: boolean
snapshots: XoVmSnapshot['id'][]
startDelay: number
startTime?: number | null
suspendSr?: XoSr['id']
tags: string[]
vga?: string
videoram?: number
viridian: boolean
virtualizationMode: DOMAIN_TYPE
xenStoreData: Record<string, string>
/**
* @deprecated use pvDriversVersion instead
*/
xentools?:
| false
| {
major: null | number
minor: null | number
version: null | string
}
}
export type XoAlarm = Omit<XoMessage, '$object' | 'body'> & {
body: {
value?: string
name: string
}
object: {
type: XapiXoRecord['type'] | 'unknown'
uuid: XapiXoRecord['uuid']
href?: string
}
}
export type XoBackupRepository = {
benchmarks?: { readRate: number; timestamp: number; writeRate: number }[]
enabled: boolean
error?: Record<string, unknown>
id: Branded<'backup-repository'>
name: string
options?: string
proxy?: XoProxy['id']
url: string
}
export type XoGpuGroup = BaseXapiXo & {
id: Branded<'gpu-group'>
type: 'gpuGroup'
}
export type XoGroup = {
id: Branded<'group'>
name: string
provider?: string
providerGroupId?: string
users: XoUser['id'][]
}
export type XoHost = BaseXapiXo & {
$PBDs: XoPbd['id'][]
$PCIs: XoPci['id'][]
$PGPUs: XoPgpu['id'][]
$PIFs: XoPif['id'][]
PCIs: XoPci['id'][]
PGPUs: XoPgpu['id'][]
PIFs: XoPif['id'][]
/**
* @deprecated use cpus instead
*/
CPUs: Record<string, string>
address: string
agentStartTime: null | number
bios_string: Record<string, string>
build: string
certificates?: {
fingerprint: string
notAfter: number
}[]
chipset_info: {
iommu?: boolean
}
controlDomain?: XoVm['id']
cpus: {
cores?: number
sockets?: number
}
current_operations: Record<string, HOST_ALLOWED_OPERATIONS>
enabled: boolean
hostname: string
hvmCapable: boolean
id: Branded<'host'>
iscsiIqn: string
license_expiry: null | number
license_params: Record<string, string>
license_server: Record<string, string>
logging: Record<string, string>
memory: {
size: number
/**
* @deprecated
*/
total?: number
usage: number
}
multipathing: boolean
name_description: string
name_label: string
otherConfig: Record<string, string>
/**
* @deprecated
*/
patches: XoHostPatch['id'][]
power_state: HOST_POWER_STATE
powerOnMode: string
productBrand: string
rebootRequired: boolean
residentVms: XoVm['id'][]
startTime: null | number
supplementalPacks:
| {
author: string
description: string
guidance: string
hosts: XoHost['id'][]
name: string
size: number
version: string
vdi: XoVdi['id']
}[]
| {
author: string
description: string
name: string
version: string
}[]
tags: string[]
type: 'host'
version: string
zstdSupported: boolean
}
export type XoHostPatch = BaseXapiXo & {
id: Branded<'host_patch'>
type: 'host_patch'
}
export type XoMessage = BaseXapiXo & {
$object: XapiXoRecord['id']
body: string
id: Branded<'message'>
name: string
time: number
type: 'message'
}
export type XoNetwork = BaseXapiXo & {
MTU: number
PIFs: XoPif['id'][]
VIFs: XoVif['id'][]
automatic: boolean
bridge: string
current_operations: Record<string, NETWORK_OPERATIONS>
defaultIsLocked: boolean
id: Branded<'network'>
insecureNbd?: boolean
name_description: string
name_label: string
nbd?: boolean
other_config: Record<string, string>
tags: string[]
type: 'network'
}
export type XoPbd = BaseXapiXo & {
id: Branded<'PBD'>
type: 'PBD'
}
export type XoPci = BaseXapiXo & {
$host?: XoHost['id']
class_name: string
device_name: string
id: Branded<'PCI'>
pci_id: string
type: 'PCI'
}
export type XoPgpu = BaseXapiXo & {
$host: XoHost['id']
$vgpus: XoVgpu['id'][]
dom0Access: PGPU_DOM0_ACCESS
enabledVgpuTypes: XoVgpuType['id'][]
gpuGroup?: XoGpuGroup['id']
host: XoHost['id']
id: Branded<'PGPU'>
isSystemDisplayDevice: boolean
pci?: XoPci['id']
// it seems that supportedVgpuMaxCapcities always return undefined (See: xapi-objet-to-xo)
/**
* @deprecated
*/
supportedVgpuMaxCapcities?: never
supportedVgpuTypes: XoVgpuType['id'][]
type: 'PGPU'
vgpus: XoVgpu['id'][]
}
export type XoPif = BaseXapiXo & {
$host: XoHost['id']
$network: XoNetwork['id']
attached: boolean
bondMaster?: XoPif['id']
bondSalves?: XoPif['id'][]
carrier: boolean
device: string
deviceName?: string
disallowUnplug: boolean
dns: string
gateway: string
id: Branded<'PIF'>
ip: string
ipv6: string[]
ipv6Mode: IPV6_CONFIGURATION_MODE
isBondMaster: boolean
isBondSlave: boolean
mac: string
management: boolean
mode: IP_CONFIGURATION_MODE
mtu: number
netmask: string
physical: boolean
primaryAddressType: PRIMARY_ADDRESS_TYPE
speed?: number
type: 'PIF'
vlan: number
}
export type XoPool = BaseXapiXo & {
auto_poweron: boolean
cpus: {
cores?: number
sockets?: number
}
crashDumpSr?: XoSr['id']
current_operations: Record<string, POOL_ALLOWED_OPERATIONS>
defaultSr?: XoSr['id']
HA_enabled: boolean
haSrs: XoSr['id'][]
id: Branded<'pool'>
master: XoHost['id']
migrationCompression?: boolean
name_description: string
name_label: string
otherConfig: Record<string, string>
platform_version: string
suspendSr?: XoSr['id']
tags: string[]
type: 'pool'
vtpmSupported: boolean
xosanPackInstallationTime: number | null
zstdSupported: boolean
}
export type XoProxy = {
id: Branded<'proxy'>
}
type BaseXoJob = {
id: Branded<'job'>
}
// @TODO: create type for complex matcher
export type XoBackupJob = BaseXoJob & {
compression?: 'native' | 'zstd' | ''
proxy?: XoProxy['id']
mode: 'full' | 'delta'
name?: string
remotes?: {
id: XoBackupRepository['id'] | { __or: XoBackupRepository['id'][] }
}
vms?: {
id: XoVm['id'] | { __or: XoVm['id'][] } | Record<string, unknown>
}
srs: {
id: XoSr['id'] | { __or: XoSr['id'][] }
}
type: BACKUP_TYPE
settings: {
'': {
cbtDestroySnapshotData?: boolean
concurrency?: number
longTermRetention?: {
daily?: { retention: number; settings: Record<string, unknown> }
weekly?: { retention: number; settings: Record<string, unknown> }
monthly?: { retention: number; settings: Record<string, unknown> }
yearly?: { retention: number; settings: Record<string, unknown> }
}
maxExportRate?: number
nbdConcurrency?: number
nRetriesVmBackupFailures?: number
preferNbd?: boolean
timezone?: string
[key: string]: unknown
}
[key: XoSchedule['id']]: {
exportRetention?: number
healthCheckSr?: XoSr['id']
healthCheckVmsWithTags?: string[]
fullInterval?: number
copyRetention?: number
snapshotRetention?: number
cbtDestroySnapshotData?: boolean
[key: string]: unknown
}
}
}
export type XoJob = BaseXoJob & {}
export type XoSchedule = {
cron: string
enabled: boolean
id: Branded<'schedule'>
jobId: (XoJob | XoBackupJob)['id']
name?: string
timezone?: string
}
export type XoServer = {
allowUnauthorized: boolean
enabled: boolean
error?: Record<string, unknown>
host: string
httpProxy?: string
id: Branded<'server'>
label?: string
master?: XoHost['id']
poolId?: XoPool['id']
poolNameDescription?: string
poolNameLabel?: string
readOnly: boolean
status: 'connected' | 'disconnected' | 'connecting'
username: string
}
export type XoSr = BaseXapiXo & {
$PBDs: XoPbd['id'][]
$container: XoPool['id'] | XoHost['id']
VDIs: AnyXoVdi['id'][]
allocationStrategy: 'thin' | 'thick' | 'unknown'
content_type: string
current_operations: Record<string, STORAGE_OPERATIONS>
id: Branded<'SR'>
inMaintenanceMode: boolean
name_description: string
name_label: string
other_config: Record<string, string>
physical_usage: number
shared: boolean
size: number
sm_config: Record<string, string>
SR_type: string
tags: string[]
type: 'SR'
usage: number
}
export type XoSm = BaseXapiXo & {
id: Branded<'SM'>
SM_type: string
vendor: string
name_label: string
name_description: string
configuration: Record<string, string>
features: Record<string, number>
driver_filename: string
required_cluster_stack: string[]
supported_image_formats: string[]
type: 'SM'
}
export type XoUser = {
authProviders?: Record<string, string>
email: string
groups: XoGroup['id'][]
id: Branded<'user'>
name?: string
permission: string
pw_hash?: string
preferences: Record<string, string>
}
export type XoVbd = BaseXapiXo & {
attached: boolean
bootable: boolean
device: string | null
id: Branded<'VBD'>
is_cd_drive: boolean
position: string
read_only: boolean
type: 'VBD'
VDI?: XoVdi['id'] | XoVdiSnapshot['id']
VM: AnyXoVm['id']
}
type BaseXoVdi = BaseXapiXo & {
$SR: XoSr['id']
$VBDs: XoVbd['id'][]
VDI_type: VDI_TYPE
cbt_enabled?: boolean
current_operations: Record<string, VDI_OPERATIONS>
missing: boolean
name_description: string
name_label: string
other_config: Record<string, string>
parent?: XoVdiUnmanaged['id']
image_format?: string
size: number
snapshots: XoVdiSnapshot['id'][]
tags: string[]
usage: number
}
export type XoVdi = BaseXoVdi & {
id: Branded<'VDI'>
type: 'VDI'
}
export type XoVdiSnapshot = BaseXoVdi & {
id: Branded<'VDI-snapshot'>
snapshot_time: number
$snapshot_of?: XoVdi['id']
type: 'VDI-snapshot'
}
export type XoVdiUnmanaged = Omit<BaseXoVdi, '$VBDs'> & {
id: Branded<'VDI-unmanaged'>
type: 'VDI-unmanaged'
/**
* Unmanaged VDI have no VBDs
*/
$VBDs: never[]
}
export type XoVgpu = BaseXapiXo & {
id: Branded<'VGPU'>
type: 'vgpu'
}
export type XoVgpuType = BaseXapiXo & {
id: Branded<'vgpu-type'>
type: 'vgpuType'
}
export type XoVif = BaseXapiXo & {
$VM: XoVm['id']
$network: XoNetwork['id']
allowedIpv4Addresses: string[]
allowedIpv6Addresses: string[]
attached: boolean
device: string
id: Branded<'VIF'>
lockingMode: VIF_LOCKING_MODE
MAC: string
MTU: number
other_config: Record<string, string>
/**
* In kB/s
*/
rateLimit?: number
txChecksumming: boolean
type: 'VIF'
}
export type XoVm = BaseXoVm & {
id: Branded<'VM'>
type: 'VM'
vulnerabilities: { xsa468: boolean | { reason: string; driver?: string; version?: string } }
}
export type XoVmController = BaseXoVm & {
id: Branded<'VM-controller'>
type: 'VM-controller'
}
export type XoVmSnapshot = BaseXoVm & {
$snapshot_of: XoVm['id']
id: Branded<'VM-snapshot'>
snapshot_time: number
suspendVdi?: XoVdi['id']
type: 'VM-snapshot'
}
export type XoVmTemplate = BaseXoVm & {
id: Branded<'VM-template'>
isDefaultTemplate: boolean
template_info: {
arch?: string
disks: {
bootable: true
size: number
SR: string
type: string
}[]
install_methods: string[]
install_repository?: string
}
type: 'VM-template'
}
export type XoVtpm = BaseXapiXo & {
id: Branded<'VTPM'>
type: 'VTPM'
}
export type XapiXoRecord =
| XoAlarm
| XoGpuGroup
| XoHost
| XoMessage
| XoNetwork
| XoPci
| XoPgpu
| XoPif
| XoPool
| XoSr
| XoVbd
| XoVdi
| XoVdiSnapshot
| XoVdiUnmanaged
| XoVgpu
| XoVgpuType
| XoVif
| XoVm
| XoVmController
| XoVmSnapshot
| XoVmTemplate
| XoVtpm
| XoSm
export type NonXapiXoRecord = XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoUser
export type XoRecord = XapiXoRecord | NonXapiXoRecord
export type AnyXoVm = XoVm | XoVmSnapshot | XoVmTemplate | XoVmController
export type AnyXoVdi = XoVdi | XoVdiSnapshot | XoVdiUnmanaged
export type AnyXoJob = XoJob | XoBackupJob

View File

@@ -0,0 +1,12 @@
{
"compilerOptions": {
"outDir": "./dist",
"declaration": true,
"strict": true,
"module": "ESNext",
"target": "ES2022",
"skipLibCheck": true
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist"]
}

View File

@@ -121,7 +121,8 @@ const xml = `
</methodResponse>
`
const tree = parseXml(xml)
// do not normalize or trim whitespaces as it will break string values
const tree = parseXml(xml, { normalize: false, trim: false })
// it can now be passed to the XML-RPC parser
xmlRpcParser.parse(tree)

View File

@@ -139,7 +139,8 @@ const xml = `
</methodResponse>
`
const tree = parseXml(xml)
// do not normalize or trim whitespaces as it will break string values
const tree = parseXml(xml, { normalize: false, trim: false })
// it can now be passed to the XML-RPC parser
xmlRpcParser.parse(tree)

View File

@@ -19,8 +19,7 @@
"node": ">=12"
},
"devDependencies": {
"@vates/xml": "^2.0.0",
"test": "^3.3.0"
"@vates/xml": "^2.0.0"
},
"exports": {
"./formatter": "./formatter.js",
@@ -28,6 +27,6 @@
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
}
}

View File

@@ -6,7 +6,7 @@ const { parseXml } = require('@vates/xml/parse')
const { readFileSync } = require('node:fs')
const { xmlRpcFormatter } = require('@vates/xml-rpc/formatter')
const assert = require('node:assert/strict')
const test = require('test')
const test = require('node:test')
const methodCall = require('./methodCall.js')

View File

@@ -5,7 +5,7 @@ const { parseXml } = require('@vates/xml/parse')
const { readFileSync } = require('node:fs')
const { xmlRpcParser } = require('@vates/xml-rpc/parser')
const assert = require('node:assert/strict')
const test = require('test')
const test = require('node:test')
const methodCall = require('./methodCall.js')

View File

@@ -20,7 +20,7 @@ function main([inputPath = 0]) {
try {
data = JSON.parse(input)
} catch (error) {
// fallback to XML
// fall back to XML
log(parseXml(input))
return
}

View File

@@ -21,15 +21,12 @@
"dependencies": {
"sax": "^1.3.0"
},
"devDependencies": {
"test": "^3.3.0"
},
"exports": {
"./format": "./format.js",
"./parse": "./parse.js"
},
"scripts": {
"postversion": "npm publish --access public",
"test": "node--test"
"test": "node --test"
}
}

View File

@@ -4,7 +4,7 @@ const { formatXml } = require('@vates/xml/format')
const { join } = require('node:path')
const { readFileSync } = require('node:fs')
const assert = require('node:assert/strict')
const test = require('test')
const test = require('node:test')
test('format()', function () {
const xml = String(readFileSync(join(__dirname, 'data.xml')))

Some files were not shown because too many files have changed in this diff Show More