Compare commits

..
Author SHA1 Message Date
jelveh 8462d30048 fix(hosting): disconnect the directory when update gets a null root_dir
puter.hosting.update(name, null) sends root_dir: null, which the driver
stringified into a lookup for a folder named "null" and rejected, so
disassociating a website from a folder's properties always failed.
2026-10-25 23:26:17 -07:00
Nariman Jelveh 21846192d1 feat(dashboard): publish websites and workers from Files in dashboard dialogs (#4342)
* feat(dashboard): publish websites and workers from Files in dashboard dialogs

The Files tab's Publish as website and Publish as Worker actions open
dashboard form dialogs instead of desktop windows: the address field shows
the domain inline and shapes the typed name into a valid one, workers get a
Sandboxed switch, and success shows the live address with copy and open.
Published rows get their badges right away.

The form dialog gains suffix and switch fields and a shared copy row, which
the API token dialog now uses too. The save-account / confirm-email gate
before publishing moves to one helper shared by both flows.

* fix(gui): ask a just-saved account to confirm its email before publishing

Saving a temporary account can leave its email unconfirmed when signup
doesn't require confirmation. The publish gate returned right after the
save, skipping the confirm-email step the old inline checks still ran.

* fix(dashboard): link a published site to the address the server reports

The success screen built https://<name>.<hosting domain>, which is wrong on
a self-hosted instance serving sites over http. Use the address the create
response carries, the one the rest of the GUI shows, and fall back to the
built one only when it's missing.

* fix(dashboard): dim a suffixed field as one box while the form submits

Only the input inside it dimmed, leaving the domain after the name at full
contrast while the field was locked.

* fix(dashboard): point a taken or reserved publish name at the address field

The server's reason showed in the status line, but the field stayed
unmarked and focus stayed on Publish, so changing the name took an extra
click. Mark the field invalid and focus it for the rejections that mean
"pick another name".

* fix(dashboard): type into a suffixed field when its suffix is pressed

The domain after the name is drawn inside the field's box but was a plain
span, so pressing it focused nothing. A press there now focuses the field
with the caret at the end, and the suffix shows a text cursor.

* chore(dashboard): drop a phone width rule the icon buttons never used

The form dialog's phone flex rule sizes these buttons, so the width never
applied; touch screens get 44px from the coarse-pointer min-width.

* fix(dashboard): read an underscore in a website address as a word break

A website name can't hold an underscore, so typing My_Cool Site gave
mycool-site. Underscores now become a hyphen, as spaces do; a worker
name keeps them.

* fix(dashboard): keep the letter when an accented one is typed into a publish address

Café became caf: an accented letter isn't a DNS character, so it was
dropped whole. The accent comes off and the letter stays.

* fix(dashboard): cap a website address at a hostname label's 63 characters

The server takes a 64-character subdomain, but DNS caps a label at 63,
so the site it publishes can't be reached. The field now stops at 63,
as the worker one does.

* fix(dashboard): let a publish address finish composing before shaping it

The address was reshaped on every input, composing included: a dead
key's accent turned into a hyphen before its letter arrived, and IME
text was rewritten under the composition. Composed text is now shaped
once it's in.
2026-10-25 21:34:39 -07:00
Nariman JelvehandClaude Opus 5.5 b9f0c8601d fix(dashboard): eighth adversarial review of Files — bugs, UX, a11y, perf (#4330)
* fix(dashboard): don't preview a file named after an image type, or a failed image

Space on a file named "png" (no extension) opened the image preview over a
broken image: the type was read from the last dot-separated part of the
name, which for an extensionless name is the whole name. It's now read from
the extension.

A preview whose image URL couldn't be fetched left the previous image up
under the newly selected row and raised an unhandled rejection. It now
closes instead.

* fix(dashboard): sort Files names by number, and break size/date ties by name

Names were compared as plain text, so "file10" sorted before "file2" and
"dir10" before "dir2". They now compare as a file manager does, with runs
of digits by value.

Sorting by size or date left rows with the same value (every folder, when
sorting by size) in whatever order the server listed them, and a row added
afterwards (a new folder, a rename) landed after its equals instead of where
a fresh listing would put it. Ties now fall back to the name, in the full
sort and in the single-row insert alike.

The sort also parsed each trashed item's metadata on every comparison; it
now reads each entry's sort key once.

* fix(dashboard): ask about "this item" when permanently deleting one Trash item

The Delete key and the phone selection bar's Delete Permanently asked
"Are you sure you want to permanently delete these items?" for a single
item too. One item now gets the single-item question, as from its own
menu. The three copies of the confirm-and-delete step (Delete key,
selection bar, multi-select menu) are now one.

* fix(dashboard): don't let saved column widths squeeze out an auto-width name

Saved widths too wide for the listing fall back to the defaults, but only
when the Name column had a saved width too. Beside an auto-width name, a
Size or Modified column widened on a large screen kept its width on a
smaller one and squeezed the names to nothing, with the row scrolling
sideways. The check now counts an auto-width name at its 100px minimum.

* fix(dashboard): give Files names a phone's full row, not a desktop column width

A narrow listing drops the columns for two-row rows, where each name has
the row's width. Names were still cut to the Name column's saved width
whenever the saved columns happened to fit, so a 120px column set on a
desktop cut names to about 100px on a phone with 280px to spare.

* fix(fs): refuse to replace a folder that contains the item being moved or copied

Moving or copying an item onto a name taken by one of its own parent
folders, with overwrite, removed that folder recursively first, and the
item went with it. Cutting the inner "photos" out of photos/photos, pasting
it next to the outer one and choosing Replace deleted both folders and
everything in them. Such an overwrite is now refused before anything is
removed.

* fix(dashboard): keep the Files selection when an upload lands in another folder

An upload into a folder other than the one on screen (a drop on a folder
row, a sidebar folder or a crumb, or Upload from a folder's menu) still
listed the folder on screen again when it finished. That cleared whatever
was selected there and left an open menu acting on rows no longer on the
page. Only an upload into the folder on screen refreshes it now.

The Upload picker ran its own copy of the upload flow; it now goes through
the same one as drops.

* fix(dashboard): keep Files rows up while a refresh reads web link and app icons

A refresh of the folder on screen keeps its rows until the new listing is
in, so it doesn't flash blank. But it cleared them before reading the
icons, and a web link's or .app's icon is read from the file over the
network, so in such a folder every re-sort, upload or return to the tab
blanked the pane for those reads. The icons are now read before the rows
are swapped.

* fix(dashboard): Ctrl/Cmd-drag a Files selection as a whole

Pressing Ctrl (Cmd on a Mac) on a row that was already selected took it out
of the selection at once, so a drag starting there collapsed the selection
to that one row: a Ctrl-drag of three files to copy them copied one, under
a ghost that still read "3". The row now leaves the selection when the
button is released without a drag, as in a desktop file manager, and a
drag carries the whole selection.

* fix(dashboard): let Enter open the row the arrow keys moved to in Files

Clicking a sidebar folder, crumb or toolbar button leaves it focused, and
the arrow keys and type-to-select still move the row selection from there.
Enter, Space and the menu key then went to that focused control: after
clicking Documents and pressing Down twice, Enter opened Documents again
and dropped the selection instead of opening the highlighted row. The
listing now takes the focus when these keys move the selection, so the
keys after them act on the rows, and Shift+Tab goes back to the toolbar.

* fix(dashboard): let Files' image preview be cancelled while it loads, and close it with the tab

The preview only counted as open once its image URL had come back (two
round-trips), so nothing could cancel it before then: Escape cleared the
selection and the image popped up anyway, a second Space opened it instead
of closing it, and opening a folder left the old image to appear over the
new one. It now counts as open from the start, so each of those cancels
it.

Browser Back/Forward to another dashboard tab left the preview floating
over that tab, where Escape and Space no longer reach it. A route change
away from Files now closes it, as it does Share and Properties.

* fix(dashboard): keep Files keys off a new folder until the server has made it

A new folder's row goes up with the name editor open before mkdir answers.
Clicks and menus already wait on it, but the keyboard didn't: pressing
Escape and then Delete on a slow connection sent a move for the row's
placeholder and showed "Moving New Folder: Subject does not exist", and
Enter opened the predicted path before it existed. Enter, Delete, Ctrl/Cmd+C
and Ctrl/Cmd+X now skip such a row, as do Cut and Delete in the
multi-select menu and the phone's selection bar.

* fix(dashboard): explain a Files action that fails on the network

A request that fails at the network level is rejected with no message.
New Folder then took its row back with no alert at all, and Restore and
the New menu's files showed "[object XMLHttpRequest]". A failed move from
the clipboard named the item and nothing else. Each now falls back to
"An unknown error occurred."

* fix(dashboard): don't offer Trash folders, or view-only shares' crumbs, as Files drop targets

Inside the Trash a folder row lit up as a drop target and then refused the
drop with an untranslated "Cannot move items into a deleted folder.", and a
crumb inside the Trash took the move, though only Restore may take an item
out of the Trash. A crumb of a folder shared with the user to view only
lit up too, and the drop ended in one refusal per item from the server.

Such folders no longer light up, and a drop on one goes back, as a drop on
a view-only folder row already did. A view-only crumb still opens on a
dwell.

* fix(dashboard): count a new folder, not the old selection, in the Files footer

New Folder selects the new row, but the footer was updated before that and
kept describing what was selected before ("3 items selected"), as did the
phone's selection bar, whose buttons by then acted on the new folder. A
Shift+click also still extended from the old anchor. The footer now
follows the new selection, and the new row is the anchor.

* fix(dashboard): update the Files footer when Enter ends a rename

Ending a rename with Enter selects the row, and then called the desktop
Explorer's footer update, which finds no footer in the dashboard. Renaming
a row from its menu while another was selected left the footer at
"1 item selected" with two rows selected.

* fix(dashboard): stop Files' image preview from running out of read URLs

The preview fetched a read URL for every image it showed, and read URLs
share the access-token allowance of 20 an hour. Stepping through a folder
of images with the arrow keys spent it in seconds, after which the preview
(and any app asking for a read URL) failed for the rest of the hour. The
preview now reads the image directly and shows it from memory, freed when
it closes or moves on, and a held arrow key loads only the image it stops
on.

* fix(dashboard): don't offer to publish a folder the user may not share from Files' folder menus

The background, crumb and sidebar menus offered Publish as Website for any
folder, so in a folder shared with the user to view or edit it opened the
publish dialog only for the server to refuse. Publishing takes the right
sharing does; the item now stays disabled without it, as on a folder row's
own menu.

* fix(dashboard): open a Files folder under its new name when it's opened mid-rename

Double-clicking a folder right after typing its new name (the first click
sends the rename) opened it under the old path, which the rename then
took away: the view sat in a folder that no longer existed, with crumbs
and Back/Forward disagreeing about its name, and New Folder or Upload
there failed. Opening a row (double-click, tap, Enter, or Open from its
menu) now waits for a rename still on its way, and goes by one path.

* fix(dashboard): keep Files' Back/Forward in step with folders moved or trashed

Back and Forward kept a folder's old path after it was moved or deleted,
here or from elsewhere: going into a folder, back out, and dragging it
somewhere else (or deleting it) left Forward leading to "This folder
couldn't be opened", with New Folder and Upload gone. History entries now
follow a moved folder and what is inside it, and a trashed or deleted
one's entries are dropped.

* fix(dashboard): keep screen readers from reading Files' icon file names

The crumbs' separators, the folder sidebar's icons and every row's icon
were images with no alt text, so a screen reader announced each one, by
file name in some ("triangle-right.svg"), between every crumb and before
every name. They are decorative beside the text they sit next to and are
now marked so. The crumb of the folder on screen is marked as the current
page.

* fix(dashboard): make double-click on a Files column divider fit the column

Double-clicking a column divider measured the text in system-ui, but the
listing renders in Inter, and took the cells' padding as 8px a side where
Size and Modified have 10. Right after "fit to content", the longest name
was still cut in the middle and every Modified cell ended in an ellipsis
("40 minutes a…"). Each column is now measured in its cells' own font and
padding.

* fix(dashboard): keep a renamed item among its sharer's in Files → Shared

With Shared sorted by "Shared by", renaming an item shared with the user
to edit placed its row by name alone, so it could land among another
person's items until the listing was loaded again. A row put back in
place now goes by its sharer first there, as the listing does.

* fix(dashboard): keep every item, and empty folders' places, in a downloaded zip

Downloading several items as one zip keyed each by its name, so two items
with the same name (in Files → Shared, two people can each share a
"Notes.txt") came out as one file, the other silently gone. Such names
now get " (1)" and so on in the zip, as a folder does for a duplicate.

Empty folders were put at the top of the zip by their own name, not where
they sat: zipping a folder holding x/y gave "y/" next to "x/". They now
keep their place.

dedupedName moves to helpers/, now that the zip uses it as well.

* fix(dashboard): give Files grid tiles both lines of their name

A tile has room for two lines of name, but names were cut to fit one:
"Quarterly financial report final version.pdf" showed as
"Quarterl…l version.pdf" over an empty second line. A name now shows whole
when it wraps into the two lines, and is cut in the middle, keeping its
extension, only as far as it has to be to fit them.

Where the browser wraps a name can't be told from text widths alone, so
the tiles are written and read back together, one layout a round rather
than one a tile.

* fix(dashboard): keep the Files listing when a refresh can't reach the server

A refresh of the folder on screen that failed for any reason replaced the
listing with "This folder couldn't be opened." and took New Folder and
Upload away. Returning to the tab triggers one, so opening a laptop before
its Wi-Fi reconnected, or a moment's lost connection during a re-sort, left
a folder that was fine looking broken until it was opened again. A refresh
that doesn't reach the server now leaves the rows as they are; one the
server answers with an error (the folder is gone) still says so.

* fix(dashboard): don't drop files added to a Files folder while a new folder is made

While New Folder (or New › file) waited for the server, every item added
to the folder on screen was dropped, not only the one being made, so a
file uploaded from another tab or device in that moment didn't show up
until the folder was listed again. Such items are now held until the
create is done and added then; the create's own comes through as an
update of the row already drawn for it.

* perf(dashboard): refresh Files on return to the browser tab only when Files is showing

Coming back to the browser tab listed the Files folder again even with
another dashboard tab in front, and in Files → Shared that meant every
share all over again. The refresh now waits until Files is next shown.

* fix(dashboard): move the keyboard focus off a Files arrow that disables itself

Pressing Enter on Back to reach the first folder disables Back while it has
the focus, and a disabled arrow is drawn at 10% opacity, focus ring
included, so the keyboard user lost track of where they were. The focus
now moves on to an arrow that still works, or to the listing.

* fix(dashboard): show "can't drop here" when dragging files from the computer where Files takes none

Files dragged in from the computer showed the copy pointer everywhere in
Files, then dropping on the Trash, in Shared, on a folder shared to view
only, or while a folder was loading did nothing. The pointer now shows the
drop isn't possible there.

* fix(dashboard): let Files' type-to-select find names with "i" in a Turkish browser

Typed letters were lower-cased for the browser's language and the names
they're matched against without one. In Turkish, "I" lower-cases to "ı",
so typing it never reached "Invoices". Both are now lower-cased alike.

* fix(dashboard): bring Files' Back/Forward along when a folder rename is undone

Renaming a folder points Back and Forward at its new name, but undoing the
rename left them there: Forward then led to "This folder couldn't be
opened" for a name the folder no longer had. Undo now takes them back to
the old name too.

* fix(dashboard): don't shrink Files → Shared's name column when it's dragged wider

In a narrow Shared listing, "Shared by" is laid out narrower beside a name
column with no set width. Dragging the name's divider gave it a width, at
which "Shared by" sprang back to its own and pushed the name narrower than
it started: dragging right made it 30px smaller, and there it stuck.
Sizing the name now keeps "Shared by" at the width it had on screen.

* docs(fs): note that move and copy never overwrite a folder holding the source

* fix(dashboard): keep the Files drop zone after files dragged in cross a folder row

Leaving a folder row while dragging files in from the computer also took
the highlight off the listing around it, as the row's notice bubbled up to
the listing's own. With the "can't drop here" pointer going by that
highlight, a drop on the listing after crossing a folder row was refused.
The row's notices stay with the row, and the listing goes by whether the
folder takes uploads.

* fix(dashboard): don't let a Files folder wait for ever on a rename to open

Opening a row waits for a rename on its way, which settles in the last
step of the rename's handling. A failure after the rename itself (such as
refreshing the folder's websites) never got there, and the folder then
wouldn't open until it was listed again. Opening waits five seconds at
most.

* docs(fs): drop the note on overwriting a folder that holds the source

The refusal is an edge case, and its error message already explains it.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-25 18:59:24 -07:00
Daniel Salazar 24aac2f6d2 fix: app token (#4338) 2026-10-25 11:50:25 -07:00
Daniel Salazar 1eb4e36cf4 fix: add beta flag to kv share docs to match kvhandle beta status (#4337) 2026-10-25 09:17:12 -07:00
Daniel Salazar 3160b99f11 chore: bump ver (#4335) 2026-10-25 08:24:40 -07:00
Daniel Salazar 589a98b12c feat(kv): share KV prefixes with other users at watch/read/write, and bound what apps can be granted (#4331)
* feat(kv): share key-value prefixes with other users, and bound what apps can be granted

- KV share handles move out of Events into KvShareService, served at /kv/shares
  (the /events/kv-handles routes stay as an alias).
- Shares have watch, read and write levels, encoded in the permission root
  (kv-share, kv-share-read, kv-share-write) with write implying read and watch.
- Every puter.kv method takes optConfig.handle; keys are relative to the shared
  prefix, cursors are sealed, and private entries stay hidden.
- New puter.kv.share, unshare, listShared and listSharedByMe; optional label;
  kv.share.received notice in the app's mailbox only; recipient blocks apply.
- puter.kv.set gains onlyIfAbsent.
- fs and kv events gain viaWorker, and kv events report self from the writer.
- /auth/grant-user-app only accepts canonical permissions from a fixed set of
  families; the consent dialog, puter.perms and docs follow.
- Migrations: kv_share_handles gains revoked_by, label, and grantee and app
  indexes (mysql_mig_49, postgres_mig_38, sqlite 0095).

* fix(kv): never name a private key in a cross-app or handle cursor, and bound flat-permission scans

- Listings of another namespace (cross-app or through a handle) resume after
  the last entry they returned, and their cursors are sealed, bound to the
  namespace or handle, and padded to one length. Old plain cross-app cursors
  are still read when they name the target namespace; other namespaces get 400.
- PermissionStore scans flat permissions a few roots at a time and skips
  roots nested under another root in the same call.
2026-10-25 08:16:19 -07:00
Toshit ChawdaandReynaldi Chernando ec3ad1cb2f docs: easy/medium/hard networking recipes (#4040)
* add net category + http request recipes

* add tcp/tls socket recipes

* add complex recipes

* minor refine

---------

Co-authored-by: Reynaldi Chernando <[email protected]>
2026-10-25 19:22:45 +07:00
Reynaldi ChernandoandDaniel Salazar c7cc64e45c docs: medium events recipes (PUT-1971) (#4333)
* docs: easy events recipe (PUT-1961)

* docs: catch-up-on-notifications events recipe (PUT-1961)

* docs: events recipe corrections from a run against a live server (PUT-1961)

* docs: medium events recipes (PUT-1971)

* docs: simpler wording in medium events recipes (PUT-1971)

* refine

---------

Co-authored-by: Daniel Salazar <[email protected]>
2026-10-25 19:18:55 +07:00
Nariman Jelveh 0c67499dc2 fix(dashboard): serve stale profile pictures to every caller, skip detached roots
While a picture refreshed after its TTL, only the first caller got the
stale answer; every later one waited on the network, so in Files → Shared
one row showed the picture at once and the rest fell back to initials.
paintAvatars now also folds a frame's roots into one pass and skips roots
re-rendered away before the frame, so they fire no lookups.
2026-10-24 19:05:54 -07:00
Nariman Jelveh 34d74d36bd feat(dashboard): show profile pictures on people avatars (#4328)
* feat(dashboard): show profile pictures on people avatars

Avatars that name a person now show that person's profile picture once
it loads, and keep the initial-and-color avatar when there is none:

- Files → Shared: the "Shared by" cell and the people filter chips.
- Share dialog: the owner row and each person with access. Teams,
  invited emails and link shares keep their initial.
- Properties: a new Owner row with avatar for items someone else owns,
  and avatars beside each version's author.

Lookups go through one cache: each person is looked up once and shared
by every avatar of theirs, answers (including "no picture") are kept
for five minutes, at most 100 are kept, and at most four run at once.
Calls made while a listing renders row by row fold into one pass per
frame. The signed-in user's own picture is read from their loaded
profile, so it takes no request and follows changes in the Account tab.
The picture is set as an image's src property, never through markup.

* fix(dashboard): profile picture review — stale refresh, picker avatars, limiter

- Serve a stale picture while a fresh one loads, so a listing re-rendered
  after the cache expires no longer drops everyone back to initials.
- Show pictures on people in the share recipient suggestions, matching the
  rows of the dialog they open from.
- Free a lookup slot when a lookup throws before returning a promise.
- Move profilePictures.js to helpers/, now that a shared helper uses it.
2026-10-24 19:01:05 -07:00
Nariman Jelveh 0bdc2197b0 feat(dashboard): show who shared each item in Files → Shared (#4327)
* feat(dashboard): show who shared each item in the Files tab's Shared view

The Shared view now names the person behind every item:

- List view gets a sortable, resizable "Shared by" column with the
  share modal's initial-and-color avatar. The tooltip names the owner
  too when someone else re-shared the item.
- Grid tiles show the sharer under the item name.
- Narrow listings lead each row's second line with the sharer.
- A people filter above the listing (one chip per sharer, with counts)
  narrows the view to one person. It shows once two or more people have
  shared something, and scrolls sideways on small screens.

Sorting by "Shared by" applies only in the Shared view; other folders
keep sorting by name while it is the saved sort.

* fix(dashboard): keep the name column readable beside "Shared by"

In a listing between the phone layout and about 700px wide, the fixed
160px "Shared by" column squeezed an auto-width name down to a few
characters. Beside an auto-width name, "Shared by" now takes at most 40%
of the room the two split, and resizing it stops at the same width.

* fix(dashboard): keep the "Shared by" header on one line

Narrowed, its two-word label wrapped onto a second line that spilled out
of the 32px header row. It now stays on one line and ends in an
ellipsis, as longer translations need too.

* fix(dashboard): fit "Shared by" to its longest name on double-click

Auto-fitting the column measured names in a font the cell doesn't use
and left out part of its padding, so the longest name still ended in an
ellipsis. It now reads the font, padding, avatar and gap off a rendered
cell.

* fix(dashboard): keep the people filter on coming back to Shared

Opening a folder from a filtered Shared view and going Back reset the
filter to Everyone, so going through one person's folders meant picking
them again each time. The filter now lasts while the user browses what
was shared with them, and clears once they go back to their own files.

* fix(dashboard): update Shared after Remove from Shared

Remove from Shared only took the row away, leaving the people filter
counting the item. Removing the last item of the person filtered to left
a blank pane under a chip that still claimed one. Shared is now listed
again afterwards, which updates the filter, the empty notice and the
footer.

* fix(dashboard): show a notified share past the people filter

Opening a "shared with you" notification, or a share link, while Shared
was filtered to someone else picked out nothing: the item was filtered
away. The filter now gives way to everyone's when it hides an item the
notification or link names.

* fix(dashboard): truncate a long sharer name on phone-width rows

In the two-line row layout, a long username grew the details line past
the row, pushing the date off screen and under the ⋯ button. The name
now ends in an ellipsis, and the line keeps clear of the button as the
name line does.

* perf(dashboard): sort the Shared view by sharer with one collator

Each sharer comparison called localeCompare with options, which builds
a collator per call: sorting 2,000 rows took about 25ms in Chrome. One
shared Intl.Collator orders them the same in under 1ms.

* fix(dashboard): make share avatar initials readable for every name

The initial-and-color avatar drew its letter at too little contrast for
nearly half the hues a username can map to: yellows and greens came out
near 3:1 in light mode, and lower still on a selected row. The letter is
now darker in light mode and lighter in dark mode, reaching 4.5:1 for
every hue on the page, selected rows and the share suggestions' hover
row. The share dialog and the Shared listing change together, so a
person keeps one look.

* fix(dashboard): show every folder when a drag springs into Shared

Dragging an item out of a shared folder and holding it over Up, Back or
the Shared crumb opens Shared to drop into a folder there. The people
filter, which now lasts while browsing shared items, could hide those
folders, and its chips can't be pressed mid-drag. A drag arriving in
Shared now sees everyone's folders.

* fix(dashboard): keep filtering Shared when it can't be listed again

A chip click lists Shared again so its rows are current. When that
request failed, the listing was replaced with "This folder couldn't be
opened" and the chips disappeared, though only a filter had changed. A
filter change now applies to the rows already loaded when the listing
can't be fetched.

* fix(dashboard): return a drag let go over Shared to where it began

A drag that springs into Shared and is let go over the listing rather
than a folder tried to move the items into Shared itself, which is a
query and not a folder: nothing moved, nothing said so, and the user was
left in Shared. Let go over a listing that takes no items, the drag now
goes back to the folder it started in, as the cancel zone does.

* fix(dashboard): don't offer read-only shared folders as drop targets

Folders shared read-only lit up under a drag and took the drop, which
the server then refused with "Forbidden". They no longer light up, and
a drop on one sends the drag back where it began; they still open on a
dwell.

* fix(dashboard): slide a drag back when a read-only folder refuses it

A drop a read-only shared folder refused left the drag chip to vanish
where it was let go, as if something had happened. It now slides back
to where the drag began, as any drop that doesn't land does.
2026-10-24 18:10:27 -07:00
Nariman Jelveh 7759f7afe9 fix(dashboard): seventh adversarial review — bugs, UX, a11y, perf (#4326)
* fix(dashboard): show notification times in Brazilian Portuguese, Ukrainian and Traditional Chinese

The notification panel and toasts handed Puter's language code straight to
Intl, and a few of those codes aren't BCP 47 tags. Brazilian Portuguese
(`br`) is Breton to Intl, so times read "5 munut zo"; Ukrainian (`ua`)
fell back to the browser's default language; and `zhtw` threw, so Taiwan
users got English. Those codes are now mapped to pt-BR, uk and zh-TW
before formatting.

* fix(dashboard): count "yesterday" and "N days ago" in calendar days

Notification times rounded the elapsed hours to whole days, so at 23:30
something from 00:45 the same day read "yesterday", and on Wednesday
morning something from Monday night (34 hours earlier) read "yesterday"
too. Days are now counted from midnight to midnight in the reader's time
zone; anything from today stays in hours.

* fix(dashboard): don't let deploy results crowd notifications out of the panel

The panel listed the 30 newest notification rows and then dropped the
ones it never shows, a worker's deploy results among them. A developer
with 30 deploys since their last share saw "No notifications" and no
badge while the share sat behind them. The listing now asks for up to
200 rows and keeps the newest 30 the panel shows.

* fix(dashboard): keep every unread notification in the panel

The socket replays up to 200 unread notifications on connect, but the
panel's listing held only the 30 newest, and the first refresh after that
dropped the rest: 45 unread read "45" until the panel was opened, then
"30", and "Mark all as read" left the other 15 unread on the server for
the next visit. The panel now keeps unread notifications past the newest
30, up to the 200 a listing returns.

* fix(dashboard): let Undo take back a new Files folder or file

The Files tab creates folders and New › files itself rather than through
the desktop's helpers, and never recorded them for Undo. Undo then
reversed whatever came before: upload notes.txt, create a folder, press
Ctrl+Z, and notes.txt was deleted for good (undoing an upload deletes it
outright, not to Trash) while the new folder stayed. Both now record
themselves, so Undo removes what was just created, as on the desktop.

* fix(dashboard): let Undo take back a Files cut and paste

Pasting cut items in the Files tab moves them itself rather than through
the desktop's move_items, and recorded nothing for Undo. Undo after a
paste reversed the action before it instead, which deletes an upload for
good. The paste now records the move as move_items does, so Undo puts
the items back where they were cut from.

* fix(dashboard): don't drop a Files selection onto one of its own folders

With folders A and B selected, dragging A onto B moved A into B and then
stopped on "Cannot move a directory into itself" for B. Hovering B also
sprang it open mid-drag. A folder row that is part of the drag is no
longer a drop target, so the drag reverts as it does over any other
non-target. A drop elsewhere (a sidebar folder, say) also leaves out the
target folder itself and any folder that holds it.

* fix(dashboard): don't drop a Files refresh asked for during another

A refresh of the folder on screen was ignored while another refresh of
it was loading. Drop two files: when the second finished during the
first's refresh, its own refresh was dropped, the earlier listing (read
before the file existed) was drawn, and the file's item.added was
ignored meanwhile too, so it stayed missing until a manual refresh.
Paste, Refresh and returning to the browser tab could lose items the
same way. A refresh now takes over from one in flight, as opening
another folder already did; a navigation in progress still holds.

* fix(dashboard): keep the phone selection bar after cancelling a delete

In select mode on a phone, tapping Delete permanently and then Cancel
left every item selected but hid the floating action bar, the only way
to act on the selection, until the selection next changed. The same
happened when nothing in the selection could be moved to Trash. The bar
now goes away only once something is actually deleted or trashed.

* fix(dashboard): show the phone selection bar when Select starts with a selection

Uploaded or pasted items arrive selected. Tapping Select on a phone then
turned select mode on with them selected but no floating action bar,
until a row was toggled. Entering select mode now brings the bar up for
the selection it starts with.

* fix(dashboard): give Files footer sizes in the rows' format

The footer used the desktop's byte formatter while the rows use their
own, so a 5-byte file read "5 B" in its row and "5.00 Bytes" below it,
1.5 KB read "1.50 KB", and a folder of folders read "0 Byte". The footer
now formats sizes as the rows do.

* fix(dashboard): title a trashed folder's Properties with its name

Properties from the breadcrumb of a folder opened inside Trash was
titled with the folder's uid, the last segment of its trashed path,
while the crumb itself showed the original name. It now uses that name.

* fix(dashboard): show delete and log-out confirmations without entities

The Files tab's "delete these items permanently?" confirmation and the
dashboard's "close your apps and log out?" one passed HTML-encoded i18n
strings to UIAlert, which encodes its message and button labels again.
In Igbo both questions read "Ị ji n&#039;aka …". These alerts, and the
Files tab's name-conflict and folder-depth ones, now pass plain strings.

* fix(gui): read the Trash's state fresh when updating its icon

refresh_trash_state stats the Trash to pick the empty or full icon, and
its comment calls for a strong read, but it asked for an eventual one.
Once a listing of Home had cached the Trash entry (without `is_empty`),
the stat came back without it: permanently deleting the last items from
Trash in Files left the full-Trash icon up, and other tabs were told the
same. The stat is now strong, as intended.

* fix(dashboard): don't add a Files row to a folder opened meanwhile

A file added from elsewhere (an upload, another tab, an app) is checked
against the folder on screen and then drawn once its icon resolves. A web
link's or app's icon is read from the file, and opening another folder
during that read put the row into the new folder's listing, where it
stayed and opened the file from the old one. The checks now run again
once the icon is in.

* fix(dashboard): let a focused folder or crumb take the Menu key

The Files tab answered the Menu key and Shift+F10 with the selection's
menu wherever focus was. With a file selected and a sidebar folder, a
breadcrumb or Home's Shared row focused, the key opened the file's menu;
with nothing selected it cancelled the browser's contextmenu, so the
focused element opened none. A focused control now gets the browser's
contextmenu event, and its own menu, as with a right-click.

* fix(dashboard): don't drop New Folder during a Files refresh

New Folder did nothing while the folder on screen was refreshing (after
an upload or paste, or on returning to the browser tab). A refresh keeps
the rows up with no spinner, so the click just looked ignored. It now
takes over the refresh and makes the folder once the listing is in;
during a navigation to another folder it is still dropped, as before.

* fix(dashboard): step through Files names on a repeated letter

Type-to-select meant to move past the selected row to the next name with
the same start, but returned early whenever the selected row matched, so
the stepping never ran: with readme, report-a and report-b, pressing "r"
again stayed on readme, and "rr" matched nothing. A repeated letter now
steps through the names it starts, wrapping around, as file managers do;
a longer prefix still stays on a selected row it matches.

* fix(dashboard): open one touch menu per long-press

A long-press on Android fires both contextmenu and taphold. The Files
rows already ignore the second, but a breadcrumb, a sidebar folder,
Home's Shared and Trash rows and the listing's empty space each opened a
second sheet over the first; picking an item or tapping the backdrop
then left the other one up. The touch menu now doesn't open while
another is on screen.

* fix(dashboard): treat Ctrl+click on a Mac as a right-click in Files

On a Mac, Ctrl+click opens the context menu, but the Files rows read it
as a Ctrl-toggle first: Ctrl+clicking one of three selected files
deselected it and the menu then acted on that file alone, and on an
unselected file it was added to the selection. On a Mac it now leaves
the selection alone, as a right-click does; Cmd+click still toggles.

* fix(dashboard): keep arrow keys in the open phone drawer on Apps

With the drawer open over the Apps tab, an arrow key moved focus out of
it to the first app tile behind the scrim, and the next Tab then walked
the page behind it. The open drawer now keeps the arrow keys, as the
notifications panel and dialogs already do.

* fix(dashboard): act once on a held Enter or Space in Apps

Holding Enter on an Apps folder opened it, moved focus to its first app,
and the key's repeats then launched that app; held on the "+" tile, the
repeats picked "Browse the App Center" in the dialog it opened, and held
in the search box they launched the first match again and again. Key
repeats now do nothing on a tile, in the search box or on the add-app
dialog's options.

* fix(dashboard): don't blank the Apps grid when it re-flows on resize

When a resize changed how many columns or rows fit (resizing the window,
collapsing the sidebar, zooming, an Android keyboard), the grid was
rebuilt behind the first load's fade, which waits on page one's icons.
With an icon host that was slow or unreachable the grid went blank for
up to 1.5s each time. A grid already on screen now re-flows at once;
one still loading keeps its fade.

* fix(dashboard): open an app from the add-app dialog at once during a search

"Browse the App Center" and "Build with AI" play an intro from the
app's tile, and wait up to 3s for that tile to appear. With a search
that leaves the app out (the case the "+" tile stays for: a search that
found nothing), the tile never appears, so the app opened only after the
full 3s. The intro now gives up as soon as the search is what hides the
tile, and the app opens straight away.

* fix(dashboard): make the Apps search's clear control a button

The "×" that clears the Apps search was a bare SVG with a click handler:
Tab couldn't reach it, screen readers had nothing to announce, and on a
phone it was a 16px target inside the field. It is now a labelled button
after the field in the Tab order, with a focus ring, and on touch it
hit-tests at 44x44 while keeping its look.

* fix(dashboard): tell screen readers when an Apps search finds nothing

Typing in the Apps search re-renders the grid silently, and the "No apps
match your search" line is drawn into it fresh each time, which screen
readers don't announce. A search that matched nothing gave no feedback
at all. A persistent status region now says so.

* fix(dashboard): keep keyboard focus on an Apps tile across a re-render

The grid is rebuilt wholesale whenever its data or size changes: the
refresh that follows opening the tab, a resize or zoom that changes how
many columns fit, an uninstall that fails. A keyboard user who had
arrowed onto a tile lost focus to <body>, so Enter did nothing and the
next arrow started over from the first tile. Focus now moves to the
same app's or folder's new tile.

* fix(dashboard): don't offer Change username to a temporary account

A temporary account's Account tab offered Change username, whose dialog
asks for an account password the account doesn't have: left empty it
said "All fields are required", and anything typed got a 403 from the
server, which refuses temporary accounts. The button is now left out
until the account is saved, as the Password card already is; saving it
re-renders the tab with the button.

* fix(dashboard): don't offer Change email to a team seat

A team seat's Account tab offered Change email, and after the user
filled in the new address and their password the server refused it:
"Your team set this address. Ask a team admin to change it." The Email
card now shows that note in place of the button, as the Username card
already does for seats.

* fix(dashboard): don't let a slow picture removal undo a newer picture

Saving a profile picture is ordered so an older save can't put its
picture back over a newer one, but Remove picture stood outside that
order. Clicking Remove on a slow connection and then saving a new photo
before the removal answered left the default avatar on screen, and
Remove hidden, while the account had the new photo. A removal now
yields to a picture saved after it.

* fix(dashboard): show placeholders in the Usage headers until they load

The Storage and Resources headers started out as " ·  used of " with the
numbers left blank, and stayed that way when reading the storage space
or the month's usage failed. They now start at "--% · -- used of --",
as Home's cards start at "--", and keep that if the read fails.

* fix(dashboard): write Home's trial dates in the dashboard's language

The free-trial note on Home formats its dates with the browser's
language, not the one chosen in Puter, so with Puter in French and the
browser in English it read "…le Mar 5", and the other way round "First
charge on 5 mars". The dates now follow the dashboard's language. The
notification panel's mapping of Puter's language codes to Intl tags
(Brazilian Portuguese, Ukrainian, Traditional Chinese) moves to
i18n/intlLocale.js so both use it.

* fix(dashboard): write credit and dollar amounts in the dashboard's language

Credits were always formatted with English separators and dollar amounts
with "$" and English separators, so in German Home read "5,000
monatliche Credits", which a German reader takes as five, and Usage
showed "2.5" and "$1,234.50". Both now use the dashboard's language
("5.000", "2,5", "1.234,50 $"); English is unchanged.

* fix(dashboard): say why Create token is off where everyone can read it

When the account's email isn't confirmed, Create token is disabled and
the reason ("Verify your email address to create an API token.") lived
only in a hover tooltip: a disabled button isn't reachable by Tab, a
phone has no hover, and screen readers don't read a plain span's title,
so those users met a dead button with no explanation. The reason now
replaces the card's description while the button is off. The tooltip,
which encoded the already-encoded text again, now uses it as is.

* fix(dashboard): announce that a new API token is shown only once

After a token was created, focus moved to Done and a screen reader read
"Done, button" and nothing else: the done state arrives already filled
in a status region, which isn't announced, and Done is described by the
message only for plain-text results. The token dialog's warning ("Copy
this token now — it won't be shown again…") now describes Done, so it
is read out when focus lands there.

* fix(dashboard): show an email change confirmed in another tab

Confirming a change of email from its link sets the new address and
marks it confirmed, but sends no socket event, unlike confirming a code.
Back in the dashboard the user was re-read on returning to the browser
tab, yet nothing redrew: Account kept the old address under the
username, Create token stayed disabled and Security had no 2FA card
until a reload. Account and Security now redraw after that re-read when
the address or its confirmation changed.

* fix(dashboard): close the share dialog after leaving a share

Someone the owner let share could remove their own row in the share
dialog to leave. The removal went through, but the dialog then reloaded
its access list with the access just given up: the server refused it,
the success line gave way to "Subject does not exist" over an empty
list, and the item stayed in the Shared view until a reload. Leaving
now closes the dialog and refreshes the folder on screen, which drops
the item, as "Remove from Shared" does.

* fix(dashboard): say the access list couldn't load, not that sharing failed

When the share dialog couldn't read who has access (a network error,
which carries no message of its own), it said "Could not share this
item." though nothing had been shared or attempted. It now says "Could
not load who has access."

* fix(dashboard): don't pull focus back after a share change saves

When a change in the share dialog finished saving (a level change, Add
to all, a removal, a share), focus was put back on that row's control or
the add field, wherever the user had gone meanwhile. Someone who changed
a person's level and then started typing a name had the next keystrokes
land on that person's level select, where a matching letter picked
another level and granted it. Focus now goes back only when the save
took it away; focus the user moved elsewhere stays there.

* refactor(gui): move the localized time formatting to i18n/formatTime.js

formatRelativeTime and formatAbsoluteTime lived in the notification
center's module; Files and Properties are about to use them too.

* fix(dashboard): write Files and Properties dates in the dashboard's language

The Files tab's Modified column and Properties' Modified, Created and
version times came from timeago, which has no language but English
registered, so a German dashboard read "3 hours ago" beside "Geändert".
They now use the same localized formatter as the notification panel
("vor 3 Stunden"), which also gives a date past a week rather than
"3 weeks ago". Its formatters are now made once per language, since a
listing formats one date per row.

* fix(dashboard): style the Usage table's Show less button in dark mode

The button's dark variant was written for an `html.dark-mode` class that
nothing sets, so in dark mode it kept its light look: grey text at 3.4:1
on the dark card, a light border, and a light chip on hover. Its rules
move under prefers-color-scheme, as the table's fade overlay already
did.

* fix(dashboard): show the Files breadcrumb separators in dark mode

The chevrons between breadcrumbs are a black stroke at 20% opacity,
which vanishes on the dark header: a nested folder read "Home Documents
Work" with nothing between the names. In dark mode they are now
inverted, like the toolbar's icons.

* fix(dashboard): show the website-link badge on dark Files tiles

In grid view a file inside a published folder carries a link badge: a
black glyph on a disc of the page's background color. In dark mode that
is black on near-black and can't be seen. The badge now gets the white
disc the shortcut and worker badges already have.

* fix(dashboard): skip disabled Back, Forward and Up when tabbing in Files

The Files header's arrows stayed in the Tab order while disabled, drawn
at 10% opacity, which takes their focus ring with them. Tabbing into
Files, the first two stops (Back and Forward, disabled on arrival)
looked like nothing had focus. A disabled arrow now leaves the Tab
order, as a disabled button does, and returns once it can be used.

* fix(dashboard): give the Delete account button an AA-contrast red

The Account tab's Delete account button used the desktop's danger red
(#f00808), which puts its white label at 4.4:1, under the 4.5:1 that
WCAG AA asks of text. It now uses the dashboard dialogs' danger red
(#d90707, 5.3:1) and their darker hover, so the two match.

* fix(dashboard): label collapsed sidebar items for keyboard users too

With the sidebar collapsed, each item shows only its icon, and its name
appeared in a tooltip on mouse hover alone. Tabbing through the sidebar
showed a row of icons with no names. The tooltip now also shows while
an item has keyboard focus.

* fix(dashboard): keep Share and Properties inside the visible screen

Both dialogs capped their height at 85vh (88vh as phone sheets), and vh
is the viewport with the browser's bars hidden. With the bars showing,
on a phone in landscape say, the card plus the overlay's padding was
taller than the screen, and the overlay centers without scrolling: the
title and the buttons were cut off with no way to reach them. Each card
is now also held within its overlay, as the dashboard's dialogs are,
and its body scrolls instead.

* fix(dashboard): outline the off state of the 2FA switch

Off, the switch was a light grey track (#e0e0e0) with a white thumb,
1.3:1 against a white card and 1.2:1 against the amber card the 2FA
toggle sits on while 2FA is off, so the control could barely be seen
where it matters most. WCAG asks 3:1 for a control's boundary. The off
track now carries a 1px slate outline (4.3:1 on the amber card); the
on state is unchanged.

* fix(dashboard): make the keyboard focus ring visible on sidebar, tiles and lists

The sidebar items, the Files folders, crumbs and arrows, the app tiles,
Home's cards and recent apps, the notification rows and the Usage sort
buttons show keyboard focus with a 2px outline and nothing else, drawn
in --select-ring: the selection color at 40% (50% dark), about 1.6:1
against the surfaces it sits on. Keyboard users could hardly tell where
focus was; a focus indicator needs 3:1. Those outlines now use the solid
selection color (3.7:1 on white), as the switch and pager dots already
do. Field halos, which come with a colored border, are unchanged.

* fix(dashboard): bring text in the selection blue up to AA contrast

The selection blue is 3.7:1 against white, and a few places set text in
it or white text on it, under the 4.5:1 that text needs: the active
folder in the Files sidebar, the share dialog's "Add to all" link, the
add-app dialog's Send button, the notification count badge, the drag
count badge, and a breadcrumb whose menu is open. They now use the same
hue darkened to 45% (5.3:1; a lighter one for text in dark mode), from
two new tokens, --select-text and --select-fill.

* fix(dashboard): give the Apps page dots a 24px touch target

The Apps pager's dots, and a folder's, are 17px buttons side by side,
under the 24px a target needs when it has neighbors, so on a phone or
tablet a tap meant for one page often opened the next. On a touch
screen each dot is now 24px around the same 7px dot; mouse layouts are
unchanged.

* fix(dashboard): return from a drag-opened folder while it is still loading

Hovering a dragged file over a folder springs it open. Cancelling the
drag (Escape, the Cancel zone, or a drop outside the listing) is meant
to go back where the drag started, but while the sprung folder was still
loading the return was dropped like any navigation during another, and
the user was left in the folder they had backed out of. The return now
takes over from that load.

* fix(dashboard): drop into a drag-opened folder while it is still loading

When a dragged file springs a folder open, the drop anywhere in the
listing moves it into the folder now shown. Until that folder's listing
arrived, though, the Files tab still counted the folder the drag left as
the one on screen, so a drop in that time was taken as a move to where
the file already was and did nothing. It now goes to the folder being
opened.

* fix(dashboard): say "Incorrect password" when the account password is wrong

The account dialogs showed the server's message as is. A wrong current
password in Change password read "Password mismatch", in English in
every language, beside a dialog that says "New Password and Confirm New
Password do not match" when those two differ, so users corrected the
wrong fields. A wrong code read "Incorrect code." and too many attempts
"Too many requests.", also always in English. These now show the
translated messages the GUI already has, and a wrong password puts the
status on the password field, focused for retyping.

* fix(dashboard): don't send an account change to the value it already has

Change username with the account's own name got "This username is
already taken." and used up one of the hour's password attempts. Change
email with the current address was accepted: it mailed a confirmation
and a change notice to the same inbox, and following the link unlinked
any sign-in provider. Change password to the current password signed
out every other session and mailed a "password changed" notice. Each
dialog now says the value is already the account's and sends nothing.

* fix(dashboard): ask for the new password after a provider-only account sets one

An account that signs in only through a linked provider can set a
password with Change password, after which the server treats it as a
password account. This session's copy still said provider-only, so
Change username, Change email and Delete account went on hiding the
password field and sending the user through the provider's popup until
a reload. The copy now changes with the password.

* fix(dashboard): let Escape cancel a session rename without closing Manage sessions

In Manage sessions (Security), Escape in a session's rename field
cancelled the rename and then closed the whole modal, and Escape in the
search box closed it too, search and all. Escape now cancels the rename
or empties the search, and only an Escape with neither closes the
modal.

* fix(dashboard): show the server's message when a session can't be revoked

Manage sessions put a refused request's raw response body in its alert,
so revoking a session already signed out from another tab read
{"message":"Session not found","code":"not_found"}, and the stale row
stayed listed; a failed rename and "Revoke all other sessions" did the
same. The alerts now show the message itself, and a session found gone
reloads the list.

* fix(dashboard): show 2FA as it is when its dialog closes without success

The Security tab's 2FA toggle assumed nothing had changed whenever its
dialog closed without success. With 2FA turned on in another tab, the
setup here refused ("2FA is already enabled."), the toggle went back to
off, and every retry got the same refusal, with Disable never offered;
a code accepted just as the user closed the setup dialog left the same
state. The tab now re-reads the account and shows its real 2FA state.

* fix(gui): leave Ctrl/Cmd+Z to the text field being typed in

Ctrl/Cmd+Z ran the file Undo wherever focus was, and cancelled the
field's own text undo. Typing a new name (F2) or anything in another
field and pressing it undid the last file action instead; when that was
an upload, the uploaded file was deleted for good. Undo now leaves text
fields alone.

* fix(gui): let Escape on a context menu close only the menu

Escape removed any open context menu and then went on to the Files tab's
own Escape handling, which, finding no menu left, cleared the selection
and closed the image preview. Select three files, open their menu,
press Escape: the menu closed and the selection was gone. When Escape
closes a menu, nothing else now acts on it; a second Escape clears the
selection as before.

* fix(dashboard): close the Files image preview when an app opens over it

The image preview sits above every window, and only a double-click
closed it on the way to an app. Opening the image with Enter, or with
Open or Open With from its menu, started the app underneath the
preview, which went on covering it while keyboard focus moved into the
app, so Space and Escape no longer reached the preview. It now closes
whenever an app window comes on screen.

* fix(dashboard): close the Files image preview when its file goes away

Deleting the previewed image (the Delete key, the menu, the phone
selection bar), moving it, or having it removed from another tab took
its row out of the listing but left the preview up, still showing the
image. The preview now closes with its row; a refresh of the folder,
which redraws the row, keeps it.

* fix(dashboard): download one selected file as itself from the phone selection bar

In select mode, the floating bar's Download zipped whatever was
selected, so a single photo arrived as "photo.jpg.zip" where its own
menu's Download gives "photo.jpg". One selected file now downloads as
itself; folders and several items are still zipped.

* fix(dashboard): don't offer New Folder, Upload or Paste in a view-only share

Inside a folder shared with the user to view only, the Files tab still
showed New Folder and Upload, offered New and Paste in its menu, and
took files dropped on the listing or on a folder in it; each then
failed: an upload window ending in an error, or a new folder row with
its name field open, then taken back with a Forbidden alert. Those are
now left out there, as in Trash. A share whose level isn't known yet
stays as before, the server deciding.

* fix(dashboard): move through Files with Home, End, Page Up and Page Down

The Files listing took the arrow keys but not Home, End, Page Up or Page
Down, and as the listing itself never has focus the browser didn't
scroll it on them either: in a folder of hundreds of items the keyboard
could only step through them one row at a time. Home and End now select
the first and last item, Page Up and Page Down move a screenful, and
Shift extends the selection as with the arrows. With a menu open they
are left to it, as the arrows are.

* fix(dashboard): apply the hidden-files setting to a renamed Files row

With Show hidden off, renaming notes.txt to .notes.txt left the row in
the listing until the folder was next loaded, and with it on the row
wasn't dimmed as other dot-files are; renaming .env to env left it
dimmed. A rename made in another tab did the same. A renamed row now
follows the setting as listing the folder would.

* fix(dashboard): open a recent app once on a double-click

Double-clicking an app under Home's "Recently used" opened it in two new
browser tabs, one per click. The second click of a double-click is now
ignored, as on the Apps tab's tiles.

* fix(dashboard): don't say "No recent apps yet" before Home's list has loaded

Home's "Recently used" card was drawn from the list as it stood when the
page opened, which is empty until the request answers: every visit
first read "No recent apps yet / Apps you use will appear here" and
then swapped in the apps, and if the request failed the card kept
saying there were none. It now stays blank until the list arrives, and
a first load that fails says the apps couldn't be loaded; a list
already shown stays when a later refresh fails.

* fix(dashboard): drop "Save session" when the account was saved in another tab

A temporary account saved in one browser tab stayed temporary-looking
in its other dashboard tabs: Home kept its "Save session" button, which
opened Save Account for an account already saved, and Account and
Security kept their temporary-account layout. Coming back to such a tab
re-reads the account; that now removes the button and redraws the two
tabs when the account is no longer temporary.

* fix(dashboard): let go of the phone drawer when the window widens

With the sidebar open as a drawer below 768px, widening the window past
it (an iPad turned to landscape) drew the sidebar as the desktop one but
left it marked open: Tab stayed trapped in it, so the content couldn't
be reached by keyboard, and the Apps grid ignored the arrow keys, until
an Escape or a click in the content. The drawer now closes when the
window widens, leaving focus where it is.

* fix(dashboard): don't let a #files/<path> link pull Files back to its folder

Files doesn't keep the folder on screen in the URL, but a link like
/dashboard#files/alice/Documents stayed in the address bar once opened.
After the user moved on to Pictures, went to Home and pressed Back, the
browser returned to that link and Files jumped back to Documents; a
reload did the same, and Files' own Back/Forward lost track, as the jump
wasn't recorded in it. The link's path is now consumed once opened, as
a share link's is, and a folder opened from such a link is a step in
Files' history.

* fix(dashboard): close the drawer and Files' dialogs on browser Back and Forward

Browser Back or Forward switched tabs but left whatever was open on
screen: on a phone, Android's Back changed the tab under the open menu
drawer and left it open; in Files, the Share or Properties dialog
stayed up over Home, still acting on Files rows; an open context menu
stayed too. These now close with the tab, as with a sidebar click.

* fix(dashboard): fill Home's storage and usage meters without waiting on the plan

Home read the plan first and only then asked for storage and the month's
usage, so every visit paid for one more round-trip before either meter
filled in. The plan request had no timeout either: one that never
answered kept both meters at "--" and, as later loads wait for the one
in flight, held every later refresh of the cards for the rest of the
session. The three now load side by side, and the plan read gives up
after 15 seconds.

* fix(dashboard): link Home's card headers to their tabs

The headers of Home's cards (Recently used, Usage, Your Plan, Your
Storage, Resources) linked to "#", so opening one in a new browser tab
(middle-click, the browser's menu) showed Apps rather than the tab it
names, and Cmd/Ctrl+click switched tabs in place. They now link to the
tab they open, and a modified click is left to the browser, as on the
sidebar.

* fix(dashboard): prefill the username when saving a session from Home

Home's "Save session" button opened Save Account with an empty username,
so a temporary user had to make one up, while the same action in the
user menu fills in the account's current name and starts at the email
field. Both now open it the same way.

* fix(dashboard): measure Home's storage meter by the amount it shows

On a self-hosted install the storage card names the disk's use (Puter's
files and everything else on it) but filled its meter, and gave its
percentage, from Puter's files alone, so it could read "93 GB used ·
0% of 466 GB". The meter and percentage now come from the same amount
the card shows.

* fix(dashboard): refresh Home's recently used apps on returning to the tab

Recent apps open in a new browser tab, and coming back to the dashboard
refreshed the usage cards but not "Recently used", whose comment said
it followed the same triggers: the app just opened only moved up the
list after switching away from Home and back. Returning to the tab now
re-reads the list too.

* fix(dashboard): leave IME keystrokes to the IME in Apps

Typing Japanese or Chinese in the Apps search or a folder's name, the
keys that drive the input method reached the tab's own handlers:
ArrowDown to pick a candidate moved focus to the first tile and cut the
conversion short, Enter to confirm one named the folder half-written or
launched the first match, and Escape put the old name back. The search
box's Enter meant to skip composition, but read isComposing off jQuery's
event, which never carries it. Keys during composition are now left to
the IME.

* fix(dashboard): leave IME keystrokes to the IME in the share recipient field

With a Japanese or Chinese input method on, even a Latin username is
composed, and the share dialog's recipient field took the keys that
drive it: the arrows moved through its suggestions instead of the IME's
candidates, and Enter to confirm the text picked a suggestion instead.
Keys during composition are now left to the IME.

* fix(dashboard): re-read the Apps layout on returning to its browser tab

The Apps tab read its order and folders only when it was opened, and
saves write its whole copy of them. With the dashboard open in two
browser tabs, a folder made in one was wiped as soon as the other,
showing Apps since before, changed anything (a reorder, a new folder, a
rename), as was the order arranged in the first. The tab now reads the
layout again when its browser tab comes back into view.

* fix(dashboard): undo a drag out of an Apps folder when the drag is cancelled

Dragging an app past the edge of an open folder takes it out, closes the
folder and carries the drag on over the grid, and the removal was saved
right then. Pressing Escape, or the window losing focus, cancels the
drag but left the app out; out of a two-app folder that dissolved the
folder for good, its name with it (dragging the app back made a new
"Folder"). A cancelled drag now puts the folder and the order back.

* fix(gui): show the 2FA setup's confirmations without entities

The 2FA setup window, which the dashboard's Security tab opens, encoded
already-encoded translations for its labels, so in French the two
checkboxes before enabling read "J&apos;ai enregistré mes codes…" and
"Je suis prêt à activer l&apos;A2F". The labels, and the window's other
translated text set the same way, are now encoded once.

* fix(gui): don't leave the 2FA dialogs stuck when a request can't be sent

Turning 2FA on or off from the dashboard's Security tab while offline,
or on a dropped connection, left the dialog busy for good: enabling kept
its spinner up with the code boxes disabled, and disabling kept its
button and password field disabled, with nothing said either way. A
request that gets no answer is now reported like a refused one, and the
dialog can be tried again.

* fix(gui): stop disabling 2FA when the provider sign-in doesn't happen

For an account that signs in through a linked provider, turning 2FA off
opens the provider's sign-in popup. When the popup was closed or
blocked, the dialog showed why for a moment and then sent the request
anyway, whose refusal ("OIDC revalidation required") replaced the
reason. It now stops at the popup's error.
2026-10-24 15:05:56 -07:00
Filip KujundžićandClaude Fable 5.1 bbb780eb31 feat(ai): MiniMax video generation (H3 and Hailuo) (#4309)
* feat(ai): MiniMax video generation (H3 and Hailuo)

Adds a minimax-video-generation provider to the video driver. H3 models go
through MiniMax's v2 task API and are billed per second of output; Hailuo
models go through the v1 API, exchange a file id for a download URL, and
are billed per clip. The shared `minimax` chat key is reused, with the
chat block's `/v1` base URL reduced to its host.

WIDTHxHEIGHT sizes now map onto tiers for catalogs that include a 2k or
4k tier.

Co-Authored-By: Claude Fable 5.1 <[email protected]>

* fix(ai): validate MiniMax video inputs and resolution tiers

---------

Co-authored-by: Claude Fable 5.1 <[email protected]>
2026-10-24 13:49:21 -07:00
Nariman Jelveh 8a55debdae fix(dashboard): sixth adversarial review — bugs, UX, a11y, perf (#4314)
* fix(dashboard): render in the user's saved language

The dashboard never read the account's preferences: only the desktop did,
on boot. Everyone saw it in English whatever language they had chosen,
until the Files tab's Show hidden toggle switched a running session over,
to the browser's language when none was saved, since that was the
fallback the toggle wrote back.

The desktop's preference loading moves into load_user_preferences, which
the dashboard now runs in the background. The first paint uses the
language this browser last loaded, so nothing waits on the read; a saved
language that differs reloads into it, and a changed Show hidden setting
refreshes the open folder. The tab names are read when the sidebar is
drawn rather than when the modules load. A failed read keeps the cached
preferences instead of resetting them to English.

* fix(dashboard): label credit amounts with a key meant for them

Home's allowance and the Usage tab's total and Credits column used the
`credits` key, which the translations render in its acknowledgments sense:
"5,000 Mitwirkende" (contributors) in German, "Авторы" in Russian,
"特别鸣谢" in Chinese. They now use `usage_credits`, which falls back to
English until it is translated, as `monthly_credits` already does.

* fix(dashboard): enable the token and 2FA cards once the email is confirmed

The dashboard had no handler for the `user.email_confirmed` socket event,
and Account and Security pick the token button's state and whether to
offer 2FA when they render. A user who confirmed their email in another
tab, or in this one through the confirmation prompt, kept a disabled
"Create token" and no 2FA card until a reload.

The dashboard now refreshes the user on that event and renders both tabs
again, as it already does after a temporary account is saved.

* fix(dashboard): save only the profile fields that were edited

Edit profile sent both the display name and the bio on every save, taken
from this session's copy of the profile. That copy comes from the cached
user and can be stale (the profile changed on another device) or empty
(the profile read failed), so changing only the bio wrote the old display
name back, and a save from an empty prefill erased the bio.

The dialog now sends just the fields whose value changed from what it
opened with, and closes without a request when nothing did.

* fix(dashboard): don't show storage as 100% while there is room left

Home and Usage rounded the storage share to a whole percent, so an
account at 99.5% or more read "100%" while uploads still fit. The usage
meter already holds at 99% until the allowance is spent; that rule moves
into meterPercent and the storage meters use it too.

* fix(dashboard): keep keyboard focus inside the open phone drawer

Below 768px the sidebar is a modal drawer over a scrim, but opening it
left focus on the menu button, and Tab past its last entry walked into
the dimmed content behind the scrim. Opening it now focuses the current
page's entry, and Tab and Shift+Tab cycle within it while it is open.

* fix(dashboard): tapping into a Files name field edits the name

On a phone or tablet, tapping the name field of a new folder or a rename
(which iOS needs before it shows the keyboard) reached the row's tap
handler, which opened the folder or launched the file and threw the edit
away. A long-press in the field opened the touch sheet instead of
selecting text, and on desktop a right-click in it showed the file menu
instead of the browser's Cut/Copy/Paste.

The row's tap and menu handlers now leave the name field alone.

* fix(dashboard): don't offer Cut on items the user can't move

A file's menu offered Cut on anything that wasn't immutable, and Shared
rows aren't marked immutable. Cutting a file someone shared with you, or
anything inside a read-only shared folder, then pasting it, ended in a
"Forbidden" alert and an emptied clipboard. Cut now needs the same
permission as Delete in that menu, as Ctrl+X and the selection's Cut
already do.

* fix(dashboard): don't paste or upload into the folder being left

Opening a folder clears the listing at once but only moves currentPath
when the new listing arrives. Ctrl+V, a file dropped from the computer
onto the pane, or Paste from the background menu during that wait went
into the folder the user had just left, and since the refresh then
showed the new one, the items seemed to vanish.

Those three now refuse while another folder is loading, as New Folder
already did.

* fix(dashboard): clear the drop highlight when Escape cancels a drag

Escape ends a Files drag with a synthetic mouseup, which jQuery UI
treats as a release outside every target: it fires no `out`, so the
folder row under the pointer kept its dashed drop outline and tint (and
a sidebar folder or breadcrumb its highlight) after the drag was gone.
The Escape branch now takes those off.

* fix(gui): show the "can't rename in Trash" alert without entities

Pressing F2 on a trashed item (on the desktop or in the dashboard's
Files tab) showed "This item can&apos;t be renamed because it&apos;s in
the trash": the message was encoded by i18n and then again by UIAlert.

* fix(gui): show the failed-upload title without entities

The upload progress window writes its error title with innerText, but
was handed the HTML-encoded i18n string, so French showed "Échec de
l&apos;importation des fichiers". The Files tab's two upload paths and
the desktop's now pass the plain string.

* feat(dashboard): open a Files row's menu with the Menu key or Shift+F10

Share, Download, Open With and Properties were reachable only by
pointer: the ⋯ button isn't focusable, and the keyboard's menu keys
fired a contextmenu on <body>, which the listing ignores. Both keys now
open the selection's menu at its row's ⋯ button, where arrow keys and
Enter already work.

* fix(dashboard): let Shift+Arrow shrink a Files selection

Shift+Arrow only ever added the next row, so after Shift+Down twice,
Shift+Up left all three rows selected instead of going back to two. A
run of Shift+Arrows now selects the range from the row it started on to
the cursor, on top of whatever was selected before the run, so moving
back shrinks it. A click or a plain arrow starts a new run.

* fix(dashboard): name folders in the Back/Forward history menus as the crumbs do

Holding Back or Forward listed each folder by its path's basename: `/`
was a blank entry, the Shared view read "shared", Trash stayed in
English, and a trashed folder showed its uid. The menus now use the same
names the breadcrumbs show.

* fix(dashboard): show a shortened Files name in full on hover

Grid tiles and a resized Name column shorten long names in the middle
("Quarterl…draft v2.xlsx"), and nothing showed the rest short of opening
Rename or Properties. A shortened name now carries the full one as its
tooltip.

* fix(dashboard): keep keyboard focus on the Files breadcrumbs

Every listing rebuilds the breadcrumbs, which took a keyboard-focused
crumb with it: pressing Enter on one, or any refresh of the folder while
a crumb had focus, left focus on <body>, and the next Tab started over
from the top of the page. Focus now moves to the same folder's crumb,
or to the one for the folder just opened.

* fix(dashboard): reach Home's Shared and Trash rows from the keyboard

At 480px wide or less (a phone, or a desktop browser zoomed in) the
folder sidebar is hidden and Home lists Shared and Trash as rows instead.
Those rows only had a click handler, so a keyboard user couldn't get to
either. They are now focusable links that open on Enter or Space, with
the sidebar's focus ring.

* fix(dashboard): keep the Files selection across a sort or view change

Sorting by a column, switching between list and grid, or toggling Show
hidden lists the folder again, and the rebuild dropped the selection and
the shift anchor: select three files, sort by Size, and nothing was
selected. Only the refresh on returning to the browser tab carried them
across. That logic is now refreshKeepingSelection, and those three use
it too.

* fix(dashboard): don't drop a folder open during a Files refresh

A refresh of the folder on screen (after an upload or paste, Refresh, a
sort, or returning to the browser tab) set the same "already rendering"
flag that a navigation sets, so double-clicking a folder, a sidebar
folder, a crumb or Back during that round-trip did nothing, with no
spinner to explain it.

Opening another folder now takes over from a refresh in flight; the
refresh notices it was superseded and drops its result. A navigation
during another navigation is still ignored, as before.

* fix(dashboard): keep the Files marquee when an item arrives mid-drag

Adding a row clears the empty-folder notice by removing every non-row
child of the listing, and the selection marquee is one. A file added
from elsewhere (an upload, another tab, an app) while the user was
drawing a selection made the rectangle vanish under the pointer.

* perf(dashboard): don't rewrite unchanged Files names while resizing

Every width change (a window resize, collapsing the sidebar) re-fits the
item names, at most once a frame, and wrote each name's text back even
when it came out the same. Each write invalidated layout for the whole
list. With 300 rows that took ~6.4ms a frame in list view and ~4.9ms in
grid; skipping the unchanged writes brings it to ~0.7ms and ~3.2ms.

* fix(dashboard): tell assistive tech the Files Select toggle's state

The Select button only toggled a class, so a screen reader announced a
plain button with no state; it now carries aria-pressed. Sort and View
open menus and now say so with aria-haspopup.

* fix(dashboard): show a person's strongest grant in the share list

When someone held two grants on one item (the owner gave them view
access, and someone the owner let share gave them edit), the share
dialog showed whichever grant the listing returned first, so their row
could read "Can view" while they could edit. A second grant on the same
item now counts toward the row with the stronger of the two levels.

* fix(dashboard): only offer share controls on grants the user can change

The backend lets an item's owner change or withdraw any share of it,
and anyone else only the grants they issued (or their own access). The
share dialog offered the level select and Remove on every row. Someone
the owner let share who removed a person the owner had added got
"Removed bob" while nothing changed, and lowering their level added a
second grant that changed nothing either.

The access list now records who issued each row's grants. A user who
doesn't own the selection gets the controls only on rows whose grants
they issued all of, plus Remove on their own row to leave; other rows
show their level as a tag.

* fix(dashboard): update Files' shared markers after the share dialog closes

The share dialog marks the Files rows it covers as shared or not from
the listings it reloads after each change, and skipped that whole reload
once it was closed. Closing it while a share or removal was still saving
left the row without its shared marker (or with a stale one) until the
folder was reloaded. The markers are now updated either way; only the
dialog's own list is skipped once it's gone.

* fix(dashboard): mark rows shared after sharing more than 50 at once

The share dialog updates the Files rows' shared markers from the share
listings it reloads after a change, and doesn't reload them for more
than 50 items. Sharing such a selection, with a person or by link,
reported "Shared with bob on 55 items" while no row showed the marker
until the folder was reloaded. Those grants now mark their rows
directly.

* fix(gui): unbind each context menu's mousemove handler with the menu

The submenu-aim code bound a mousemove handler on the document for every
menu and submenu and never removed it. Each one kept its closed menu and
items alive and ran on every mouse move for the rest of the session; ten
right-clicks in Files left five such handlers behind. The handler now
comes off when its menu is removed. Moving diagonally into a submenu
still keeps it open.

* fix(gui): ignore clicks on a context menu's dividers

A divider is an <li> like the items, so a click on one (they're 11px
tall, easy to hit between two items) ran the item handler with no
action behind it and threw "Cannot read properties of undefined". The
item handler now skips dividers; the menu stays open, as a native
menu's separator does.

* fix(dashboard): warn that removing a team removes everyone in it

Removing a team from a single item's share dialog asked "Remove Design's
access to this item?", the wording used for one person. The desktop's
share window adds "Everyone in the team loses it."; the dashboard now
uses that confirmation for teams too.

* fix(dashboard): count folders, not items, in "via N folders"

A person who reaches a multi-item selection through more than one shared
ancestor gets a "via N folders" note in the share dialog, and N was the
number of items reached that way: five files under two shared folders
read "via 5 folders". It is now the number of distinct folders.

* fix(dashboard): don't treat a long tail after a dot as a file extension

Files middle-truncates long names and keeps everything after the last
dot whole as the extension. For "Report v1.2 final draft for the board
meeting" that kept ".2 final draft for the board meeting", so the tile
read "….2 final draft for the board meeting" and lost the start of the
name. Only a short tail without spaces now counts as an extension; this
one shortens to "Report v1.…d meeting".

* fix(dashboard): keep Tab inside the touch context menu

The touch menu sheet is modal, but Tab and Shift+Tab left it for the
page behind the backdrop while it stayed open; closing it then no
longer returned focus, since focus was elsewhere. Tab and Shift+Tab now
move between its items like the arrow keys, wrapping at the ends.

* fix(dashboard): say "the other item" when one item is missing a grant

The share dialog's "Add to all" link told screen readers "Give bob
access to the other 1 items" when the person was missing from a single
item of the selection. That case now has its own singular string.

* fix(dashboard): announce a failed Properties load, on both tabs

When Properties couldn't read the item, the General list showed the
error but stayed aria-busy, so screen readers kept it unannounced, and
the Versions tab stayed blank. The list is no longer busy once the
error shows, and Versions shows the same error.

* perf(dashboard): launch the add-app modal's apps without reloading the grid

"Browse the App Center" and "Build with AI" go through the same intro
as a deep link, which first awaited loadApps(). With the grid already
loaded that started a fresh fetch of every app list and the saved
layout, and the launch waited on it: with an 800ms connection, ~1.35s
before anything opened instead of ~0.1s. The intro now uses the grid
already loaded, and only joins or starts a load when there is none.

* fix(dashboard): don't hide the Apps grid on every search keystroke

Search re-rendered the grid behind the first load's fade-in, which waits
for page one's icons. Each keystroke made fresh <img> elements, so an
icon that was slow or failing (an unreachable icon host) blanked the
whole grid until it settled, about a second per keystroke with a 1s
icon and up to 1.5s if it never answers. Search, its clear button and
entering reorder mode now render the results at once.

* fix(dashboard): stop the Apps pager's dots jumping back mid-flip

A page arrow, a dot, or the wheel starts a smooth scroll and marks the
target page at once, but the scroll handler then read the pages passed
over on the way as the current one. The active dot went forward, back
to the old page, and forward again, and a second click on the arrow
added to the stale page: two quick clicks showed 0 → 1 → 0 → 2 → 1 → 2.

While such a scroll is on its way, the pager (and the open folder's)
now ignores the positions in between, until it arrives or a second has
passed. The user's own scrolling still moves the dots.

* fix(dashboard): keep paging while a dragged app is held at the edge

Holding a dragged tile still at the Apps grid's edge (or an open
folder's) turned one page and stopped: the next dwell only started on
another pointer move, so a mouse held steady stayed on the second page
of three. Once a flip settles, the dwell starts again if the pointer is
still in the edge zone.

* fix(dashboard): don't turn Apps pages on a trackpad pinch

A pinch on a trackpad reaches the page as wheel events with ctrlKey
set, and the Apps grid (and an open folder) read them as a wheel flick
and turned the page while the user zoomed. Those events are now left
alone.

The handlers also called preventDefault() from a listener the app makes
passive, which does nothing and logged a console warning on every wheel
tick; that call is gone, as the scroller has no vertical scroll to stop.

* feat(dashboard): open the first Apps search result on Enter

Typing in the Apps search and pressing Enter did nothing; reaching a
result took ArrowDown and then Enter. Enter in a non-empty search now
opens the first match (or a folder that matches), as launchers do. It
does nothing while an IME composition is open, or when nothing matches.

* fix(dashboard): include an open folder's page dots in its Tab cycle

The open folder keeps Tab inside it, but its list of stops left out the
page dots, which are buttons. Tab never reached them, and once one had
focus (clicking it focuses it) the next Tab walked out of the modal
folder to the page behind. The dots are now part of the cycle.

* feat(dashboard): open an app tile's menu with the Menu key or Shift+F10

An app or folder tile's menu (Open in New Tab, Copy Link, Uninstall,
Remove from Folder; a folder's Rename and Ungroup) opened only on a
right-click or long-press, and browsers don't all turn the keyboard's
menu keys into a contextmenu event (macOS has none). The Menu key and
Shift+F10 on a focused tile now open its menu at the tile, where arrow
keys and Enter work.

* fix(dashboard): keep keyboard focus on the grid after Ungroup

Ungrouping a folder from its menu re-rendered the grid without the
folder's tile, so a keyboard user who had it focused was left on
<body> and the next Tab started from the top of the page. Focus now
moves to the folder's first app, which takes the folder's place.

* fix(dashboard): give links AA contrast in the light theme

Link-colored text (Home's "View more" and "Upgrade", the notification
panel's "Mark all read" and "Retry", Properties' website links, the
token dialog's sessions link) used #5271ff, 4.07:1 on white and 3.97:1
on the content background, under the 4.5:1 AA minimum for text that
size. The light theme's link is now #3d5bd9 (5.7:1), with a darker
hover. Dark mode already passed.

* fix(dashboard): give success text AA contrast in the light theme

Success text (the 2FA "enabled" line, Home's active-plan badge, the
share dialog's confirmations) used #03933a: 4.01:1 on white and 3.80:1
on its green tint, under the 4.5:1 minimum. It is now #15803d (5.02:1
and 4.75:1); the success check icons that share the token darken with
it. Dark mode already passed.

* fix(dashboard): give danger buttons and error text AA contrast

White text on the red fills fell short of 4.5:1: the Apps uninstall
confirm (#e53935, 4.23:1), the delete-account button (#f00808, 4.43:1)
and the Files drag "Cancel" zone (#ef4444, 3.76:1). So did light-theme
danger text on its pink tint (#dc2626 on #fef2f2, 4.41:1), used for
form, share, crop and notification errors and the past-due badge.

The fills are now #d32f2f, #d90707 and #dc2626 (4.8:1 to 5.3:1), each
with a darker hover, and danger text is #b91c1c (5.9:1 on the tint).

* fix(dashboard): give the app feedback dialog's Send button AA contrast

The feedback dialog's primary button (Send, and Close once sent) put
white text on a light-blue gradient, 2.66:1 at the top and 3.42:1 at the
bottom. It now uses the dashboard's primary button colors, which meet
4.5:1 in both themes, like the dialogs around it.

* fix(dashboard): show the drop outline and dwell fill on grid folders

Dragging files over a folder in grid view only tinted it like a
selection: the grid's own border, hover and selected rules out-ranked
the shared drop-target and spring-load rules, and the hover rule's
background shorthand wiped the dwell fill. The folder then opened after
700ms with no sign it was about to. Grid and compact-grid folders now
get the list's dashed outline and filling dwell, with the padding
trimmed to match so the tile doesn't shift.

* fix(dashboard): keep the Files preview and drag ghost above the window

The Space-bar image preview (z-index 9999) and the drag ghost (10000)
are appended to <body>, beside the dashboard window. On a touch-only
tablet with a keyboard every window is pinned to 9999999, so the preview
opened invisibly behind it from the first press; on desktop the
window's z-index climbs with each click and overtakes both in a long
session. Both now sit in the band the sidebar tooltip and the toasts
already use.

* fix(dashboard): give small dashboard controls 44px touch targets

Several controls a phone or tablet user taps were under the 44px
minimum touch size, with nothing enlarging them on a coarse pointer:
the Files toolbar buttons (32px), the touch menu's rows (36px tall),
the drawer's close button (32px), the notifications close (30px), the
Properties close (32px), the feedback dialog's ✕ (30px), the add-app
Back arrow (26px), the Apps modal buttons (34px tall) and the share
dialog's Copy link (38px tall).

Following the earlier touch fixes, the icon buttons keep their look
and get a 44x44 hit area, and the text buttons and menu rows grow to
44px. Mouse and trackpad layouts are unchanged.

* fix(dashboard): keep a landscape phone's notch clear of the dashboard

A phone held sideways and wider than 768px (an iPhone Pro Max, a large
Android) gets the desktop layout, and the page asks for the full screen
with viewport-fit=cover. Nothing in that layout read the side safe-area
insets, so with the notch on the left the sidebar's icons sat under it
(x=24 against a 47px inset), and with it on the right the content's
edge and the toasts did.

The sidebar (open or collapsed) now adds the left inset, and the content
area, including Apps and Files, and the toasts add the right one. The
insets are 0 everywhere else, so other layouts don't change.

* fix(dashboard): size the touch menu and bottom sheets to the visible height

The touch context menu, the app feedback dialog and the profile-photo
crop sheet capped their height in vh. On phones 100vh is the viewport
with the browser bars hidden, so while they show these could be taller
than the screen. The touch menu, which ContextMenu.js keeps inside the
visible height, then ran its last rows off the bottom on a landscape
phone, and the bottom sheets could push their header off the top. They
now cap in dvh, as style.css already does.

* fix(gui): move keyboard focus into the Manage sessions dialog

The sessions dialog is modal but never took focus: opening it from the
keyboard left focus on the button behind the backdrop, and Tab walked
the page underneath instead of the session list. It now focuses its
close button on open, keeps Tab inside, and hands focus back to the
control that opened it when it closes.

* fix(dashboard): return focus after the Security tab's dialogs close

Closing Blocked people, or the 2FA setup or disable dialog opened from
the switch, left keyboard focus on <body>, so the next Tab started at
the top of the page. The 2FA switch also disables itself while its
dialog is up, which drops focus even before then. Focus now goes back
to the button or switch that opened the dialog once it has gone.
2026-10-24 08:30:57 -07:00
Daniel SalazarandReynaldi Chernando f3e8539eaf docs: easy events recipe (PUT-1961) (#3998)
* docs: easy events recipe (PUT-1961)

* docs: catch-up-on-notifications events recipe (PUT-1961)

* docs: notification examples use notif:app-user, which apps can read

* docs: events recipe corrections from a run against a live server (PUT-1961)

* refine and update agents md

---------

Co-authored-by: Reynaldi Chernando <[email protected]>
2026-10-24 15:26:07 +07:00
Nariman Jelveh b3b02b1ebb Fix/dashboard fifth review (#4313)
* fix(dashboard): close the Apps modals and folders only on a press that starts on the backdrop

The uninstall and add-app modals and the open folder closed on any click
whose target was their backdrop. Drag-selecting text in the app request
box and releasing outside the card lands that click on the backdrop, so
the modal and the typed request were thrown away.

The backdrop logic the dashboard dialogs already use moves into
bindBackdropDismiss, and the three Apps overlays use it too.

* fix(dashboard): double-clicking "Add an app" no longer opens App Center

The add-app modal opens under the pointer, so the second click of a
double-click on the "+" tile landed on its first option and launched App
Center (or the AI builder, depending on where the tile sat) without the
user choosing anything. An option now ignores the second click of a
double-click.

* fix(dashboard): act on an app tile once per double-click

A tile acted on every click, so a double-click opened an external app's
site in two browser tabs. Double-clicking an option in the add-app modal
also launched whichever tile sat under the pointer once the modal had
closed (App Center and Recorder together, say). A tile now ignores the
second click of a double-click; the first already launched, focused or
opened what was asked for.

* fix(gui): show app launch refusals in a Puter alert, translated

launchApp reported "You don't have access to …" and "Couldn't open …"
through window.UIAlert, which nothing defines, so both fell through to
the browser's native alert(): a blocking, unstyled, English-only dialog
over the dashboard or desktop. They now use UIAlert directly, with the
text in en.js, and pass the app title unencoded since UIAlert encodes
its message itself.

* fix(dashboard): clicking a toast with nothing to open keeps apps on screen

A toast click brings the dashboard forward before acting on the
notification, hiding every app window. Only share notifications lead
anywhere, so clicking an "events subscription ended" toast (or any other
type) to dismiss it minimized the app the user was working in and showed
a dashboard with nothing to look at. Those toasts now just mark the
notification read.

* fix(dashboard): show an emptied Trash as empty

Emptying the Trash from the Files tab took its rows away but left the
footer on "N items · X MB" and the pane blank, without the empty-folder
notice; the selection bar kept offering actions on rows that were gone.
Emptied from another tab, the listing was cleared with .empty(), which
also dropped the loading overlay and likewise never updated the footer.

Both paths now finish with the empty notice and a fresh footer.

* fix(dashboard): say a folder is empty when its last item goes elsewhere

When another tab, device or app deleted or moved away the last item in
the folder Files was showing, its row faded out and left a blank pane:
the item.removed and item.moved handlers updated the footer but never put
the "folder is empty" notice up. They now do, for rows that were in the
Files listing.

* fix(dashboard): list failed drag-and-drop uploads one per line

The upload-button path was fixed to put each failed item on its own line,
but files dropped onto the listing still joined them with "\n", which
UIAlert's HTML collapses into spaces: every failure ran together on one
line. Both paths now build the message in failedUploadsMessage.

* fix(dashboard): dropping items back into their own folder does nothing

Dropping a selection on the sidebar entry for the folder it came from, or
spring-loading into a folder and coming back to release in the listing,
asked move_items to move every item where it already was, and each one
stopped on a "Cannot move item to its current location" alert in turn.
The breadcrumbs already ignore such a drop; moveDraggedRows now leaves
those rows out too, and a drop with nothing left to move does nothing.

* fix(dashboard): a Ctrl- or Alt-drop on the Trash trashes the items

Ctrl-dragging a file onto the sidebar Trash (or a Trash breadcrumb)
copied it into the Trash: the original stayed put, and the copy carried
no original path, so it was offered Restore and Restore failed. Alt-drops
made shortcuts there the same way.

The four drop handlers' copy/shortcut/move choice moves into
dropRowsInto, which only ever trashes what lands on the Trash.

* fix(dashboard): the first row click after a marquee released outside Files counts

A marquee sets a flag so the click that ends it doesn't clear the new
selection; the listing's click handlers consume it. Released over the
sidebar or outside the window, that click lands elsewhere, the flag
stayed set, and it swallowed the user's next click on a row. The flag now
lapses once the release's own click has had its turn.

* fix(dashboard): Back and Forward follow a folder the user renamed

Open a folder, go back, rename it, then press Forward: history still
held the old path, so Files showed "This folder couldn't be opened", and
the Back/Forward long-press menus listed the old name. A folder renamed
in Files now rebases the history entries in and under it, using the
same path rebase the username-change handler does.

* fix(dashboard): a folder that can't be opened becomes the current folder

When a folder failed to list (deleted elsewhere, share revoked, offline),
Files said "This folder couldn't be opened" but stayed on the previous
folder underneath: history had moved on while the breadcrumbs, sidebar
highlight and New Folder/Upload/Paste still pointed at the old folder,
so a new folder or upload landed somewhere other than where the user
seemed to be.

The tab now moves to the folder it was asked for before showing the
message, and creates nothing in it until it lists again.

* fix(dashboard): double-clicking Save in the photo crop uploads it once

Save closes the crop dialog, but the dialog stays in the page for its
200ms fade-out with its handlers live, so the second click of a
double-click ran Save again and sent the profile picture to the server
twice. Save does nothing once the dialog has closed.
2026-10-23 19:04:36 -07:00
Toshit ChawdaandClaude Opus 5 bdc9aa9e93 Revamp networking api with epoxy try 2 (#3476)
* revamp networking api with epoxy

* update to new epoxy build

* force wisp auth

* emit Error objects from socket 'error' events

main tightened the socket error contract to pass an Error (see
types/modules/networking.d.ts, which documents the reason as
`error.message`); the epoxy rewrite still emitted a bare string,
matching the older `(reason: string)` declaration.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>

* test: cover the epoxy-based networking client

Replaces the coverage lost when the wisp implementation was removed:
PSocket.test.js and PWispHandler.test.js were bound to PWispHandler,
parsers.js, and wispInfo, none of which survive the epoxy rewrite.

  PSocket.test.js  - connect/retry, inbound data, write normalisation,
                     close, and the TLS event remapping. Driven through
                     real ReadableStream/WritableStream pairs so
                     reader locking, cancel, and abort behave as they
                     do in the browser.
  index.test.js    - relay-token exchange (auth header, 401 re-auth and
                     retry, malformed responses) and the epoxy client
                     cache (keying, refresh, in-flight sharing).
  requests.test.js - pFetch delegation, cache invalidation, and the
                     api call logger's request description.
  epoxy.test.js    - the hand-packed wisp password extension payload.

The wasm runtime loader is left to integration coverage; it needs a
network fetch and a browser. createPuterPasswordBuilder is exported so
the byte layout can be tested against an injected fake runtime.

One skipped test records a pre-existing defect: on a failed write,
#readLoop's normal-termination path races #closeStreams and emits
close(false) after an error.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>

* fix: report socket close flags and epoxy init failures accurately

PSocket #readLoop raced the teardown it was being torn down by. A failed
write sets #closing and hands the close event to #closeStreams, which has
to await reader.cancel() and writer.close() before emitting close(true).
That cancel resolves the loop's pending read with {done: true}, so the
loop broke, reached its own #emitClose(false), and set #closed first --
callers were told the socket shut down cleanly right after an error.
The loop now defers the close event whenever a teardown is under way, in
both its normal and its throwing path, and #closeStreams always emits.

getEpoxyClient swallowed every init failure and resolved undefined, so a
dead relay reached callers as "cannot read properties of undefined
(reading 'connect')" instead of its cause. It now re-throws, still
without caching the failed attempt. A socket reports "wasm unavailable"
or "Failed to create relay token (HTTP 503 ...)" and closes with the
error flag set.

Two related cache faults fell out of that rewrite: the in-flight
early-return ignored `refresh`, handing a caller the very attempt it
asked to replace, and it ignored the cache key, so an attempt started
before a token change satisfied a request made after it. Reuse is now
conditional on both.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>

* restore the public API surface dropped in the epoxy revamp

The epoxy rewrite kept the shape of the old networking client but lost
three things callers depend on:

- JSDoc on the exposed methods. Re-added on PSocket (constructor, on,
  addListener, write, close), PTLSSocket and pFetch, along with the
  SocketEvent typedef and a Networking type on netAPI. `on` carries the
  TLS event aliasing docs that used to live on PTLSSocket, since that
  behaviour moved here.

- socket.write's error message, which lost its trailing '!!'. Apps match
  on the message, so it is restored verbatim.

- pFetch's client-side validation. Epoxy reports a bad request as an
  opaque wasm value from deep inside the transport, so the scheme check,
  the Content-Length/body check and the malformed-request TypeError are
  made before a relay is dialled, rejecting with exactly what they
  rejected with before. Validation builds its Request from a clone, or it
  would consume the body epoxy is about to send.

The latter two are what the net API suite asserts on node, browser and
workerd, and it has been failing on all three since the revamp.

addListener takes named parameters so it can be typed, and three unit
tests that pinned pFetch's habit of forwarding unvalidatable input were
updated to the documented behaviour.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>

* update epoxy client to 04e4930

connectionPrefs changed shape: the handshake and its required extension
list are one object now rather than a tuple, and handing the new build
the old form throws part way through the handshake.

The bump is not optional. The previous build cannot reach the current
relay at all: it enforces the required puter password extension even when
a relay answers with a v1 CONTINUE, and fails with "Protocol extensions
not supported" -- which is what puter.cafe answers with today.

Verified against a local relay: fetch, POST bodies, https, raw sockets and
TLS sockets, the last exercising connectTls, whose third parameter became
an options object in this build.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>

* bump epoxy

* dont require ext

* chore(puter.js): update Epoxy runtime to 68c6904

* chore(puter.js): update Epoxy runtime to affd9f5

---------

Co-authored-by: Claude Opus 5 (1M context) <[email protected]>
2026-10-23 16:57:25 -07:00
Nariman Jelveh 21c1e4142e fix(dashboard): fourth adversarial review — bugs, UX, a11y, perf (#4312)
* fix(dashboard): keep Escape working when two share or properties dialogs are open

Each share and properties dialog bound its document keydown under one fixed
namespace, so closing either instance unbound every instance's Escape.
Double-clicking Share… or Properties in the context menu opens two; after
the top one closed, Escape no longer closed the one left behind. Each dialog
now binds under its own namespace.

* fix(dashboard): don't close Properties when a text selection ends on the backdrop

Drag-selecting the path or UID in the properties dialog and releasing over
the dimmed backdrop closed the dialog: the click lands on the overlay when
press and release are on different elements. The backdrop now closes it
only when the press started there, as the share dialog already does.

* fix(dashboard): keep focus in Properties after disassociating one of several websites

With more than one website on an item, disassociating one removed the
focused button and returned early before refocusing the dialog, so focus
fell to the page and the next Tab landed in the dashboard behind the modal.
The dialog takes focus back as soon as the entry is removed.

* fix(dashboard): handle the Properties stat failure instead of leaving it unhandled

puter.fs.stat both calls the error callback and rejects. The properties
dialog rendered the error from the callback but dropped the promise, so
opening it on a deleted item or offline logged an unhandled rejection.

* fix(dashboard): don't double-encode the "anyone" and withheld-invite share rows

The share dialog encodes row names when it renders them, but these two
labels came from i18n() already HTML-encoded, so a translation containing
an apostrophe or ampersand would show its entity text. They're now taken
unencoded like every other row name.

* fix(dashboard): make the touch context menu reachable by assistive tech and keyboard

The touch action sheet had no roles and never took focus: it was appended
at the end of the page, so a screen reader announced nothing on open and
focus stayed on the page behind it. It's now a menu of menuitems (with
separators and submenu popups marked), takes focus on open, gives it back
on close, moves between enabled items with the arrow keys and Home/End,
and shows an inset focus ring for keyboard use. Taps draw no ring.

* fix(dashboard): keep Apps folders and order when a settings read fails

The Apps tab read the saved order, folders and uninstalled-apps list with
`.catch(() => null)`, so a failed read looked like a user who had never
saved any. One flaky request emptied the folders and reset the grid to
the default order, and the next drag or folder edit wrote that loss back
to kv for good.

A failed read now keeps what the session already has (the last
uninstalled-apps list included). Until a read of the order or folders has
succeeded, saves stay in memory instead of overwriting the stored value.

* fix(dashboard): drop the Apps tile a failed deep-link launch drew

Landing on /app/<name> (or choosing an option in the add-app modal) adds
the app's tile before the launch runs, because the launch is what installs
it. When the launch failed — no access, no app token, a thrown error — the
tile stayed for the rest of the session, survived refreshes, and every
click on it failed again.

The launch outcome is now passed to settleDeepLinkLaunch, which takes a
tile it drew back out (and restores a previous uninstall record) when
nothing was launched.

* fix(dashboard): put a re-installed app back in its saved slot

Uninstall keeps the app's name in the saved order so a re-install returns
it to its place, but a deep-link landing appended the tile at the end of
the grid. The install animation played on the last page and the tile then
jumped back to its saved slot on the next refresh. The landing now places
the tile through reconcileAppOrder like every other load.

* fix(dashboard): don't double-encode the add-app launch failure alert

UIAlert encodes its message, so passing it the already-encoded i18n string
showed entities on screen in languages with an apostrophe (French read
"s&apos;est mal passé").

* fix(dashboard): say so when an app tile fails to launch

A tile click whose launch rejected (for example the app lookup failing)
only logged to the console: the icon flourish played, settled, and nothing
opened. It now shows the same alert the add-app modal shows for that
failure.

* fix(dashboard): keep focus inside the Apps modals and return it on close

The uninstall and add-app modals are aria-modal but had no Tab trap, so
Tab walked into the search box and tiles behind the scrim, where typing
filtered the grid under the modal. Closing the add-app modal, and
confirming an uninstall, dropped focus to the page body.

Tab now cycles inside both cards; closing the add-app modal returns focus
to the add tile, and an uninstall leaves focus on the tile that takes the
removed app's slot.

* fix(dashboard): upload from a folder's menu into that folder

Upload in a sidebar or breadcrumb folder's menu opened the shared file
picker, whose handler always uploaded into the folder on screen: files
picked for Pictures while viewing Documents landed in Documents. The menu
now hands its folder to the picker.

* fix(dashboard): no New, Upload or Paste where nothing can be created

New Folder, Upload, the New/Paste/Upload menu items and file drops were
only refused in the Trash itself and the Shared view. Inside a trashed
folder they created items without the metadata Restore needs, and at /
every create failed (an upload there threw before its progress window
existed and showed nothing). One check now covers the Trash, folders in
it, the Shared view and /.

* fix(dashboard): make Paste Into Folder work after a cut

The row menu's Paste Into Folder handed a cut to the desktop's
move_clipboard_items, which finds items by their on-screen elements and
plain-string paths. The Files tab's cut stores {path, uid} objects, so
nothing moved and the clipboard was emptied. The menu now takes a paste
handler, and Paste, Ctrl+V and Paste Into Folder share one.

* fix(dashboard): don't cut or copy trashed items out of the Trash

The single-item menu still offered Cut on trashed items, and Ctrl+C
copied them; pasted elsewhere, they kept their raw name in the Trash, a
uid. Trashed items leave through Restore, which puts the original name
back.

* fix(dashboard): Delete Permanently works in every language

The confirmation compared the clicked button's label with 'Delete', so in
any other locale confirming did nothing. The buttons carry values now.

* fix(dashboard): refresh Files on return after a cancelled rename

Escape, or keeping a name unchanged, hid the rename editor but left its
-active class, and the refresh on returning to the browser tab takes that
class for an open editor: the listing stopped refreshing until the next
navigation.

* fix(dashboard): clear a drop target's highlight after the drop

jQuery UI fires no `out` on drop, so the folder row a selection was
dropped on stayed selected (and went to the Trash with the next Delete),
a sidebar folder stayed highlighted as the current one, and a breadcrumb
kept its drop outline.

* fix(dashboard): listing drops keep working after a drop on a folder row

Dropping files from the computer onto a folder row stopped the native
event before the listing's dragster saw it, leaving its enter state stuck:
later drags didn't highlight the listing, and drops on its background
uploaded nothing.

* fix(dashboard): offer Restore only for items Restore can handle

Selecting files inside a trashed folder offered Restore in the
multi-select menu and the selection bar, which then failed once per item:
only direct children of Trash carry restore metadata. The trashed
multi-select menu also drew two separators in a row.

* fix(dashboard): show names as typed in conflict and move-failure alerts

These alerts html-encoded the file name before UIAlert encoded the
message again, so "R&D.txt" read "R&amp;D.txt". "already exists." is
translatable now too.

* fix(dashboard): list failed uploads one per line

The failed-upload list was joined with newlines, which the alert collapses
onto a single line.

* fix(dashboard): translate the shortcut badge's tooltip

* fix(dashboard): select mode toggles rows with any pointer

In select mode, a stylus or mouse tap on a phone or tablet toggled the row
in pointerdown and again in click, leaving it as it was; in a narrow
desktop window a click replaced the selection and the selection bar never
showed. Select mode now toggles in click for every pointer and shows its
bar whenever it is on.

* fix(dashboard): show items added elsewhere while New › Web Link prompts

The New menu's create wrapper suppressed item.added for as long as it ran,
which for Web Link includes its URL prompt, so files added to the folder
meanwhile never appeared. It now counts only from the actual create. A
create that fails now says so instead of failing silently.

* fix(dashboard): keep the Files spinner under the mobile drawer

The loading overlay sat at the maximum z-index, so on phones it drew over
the open drawer and its scrim and took their taps while a folder loaded.
It only needs to sit above the rows.

* fix(dashboard): don't show a failed usage request as zero usage

getMonthlyUsage() resolves with the error body when the request fails, and
Usage and Home read it as a month with nothing used: $0.00 of $0.00, 0%,
and on Usage an empty table replacing the one already on screen. A body
without a usage report is treated as the failure it is, so the last good
numbers stay and a first load shows the "unavailable" note.

* fix(dashboard): draw Files select-mode accents in the selection color

The checked checkbox, the active Select button and the Done button were
filled with --primary-color, the desktop's text color rather than an
accent: charcoal by default, and white (on white text and ticks) for
anyone whose desktop theme uses light text. They use --select-color, the
accent the rest of the selection already uses.

* fix(dashboard): stop the mobile drawer animating under reduced motion

The reduced-motion override for the drawer, its scrim and the menu button
came before the drawer rules it was meant to cancel, and the open
drawer's rule outranked it too, so the drawer still slid and the scrim
still faded. The override now follows those rules and covers the open
state.

* fix(dashboard): make the toast close button readable in dark mode

Dark mode gave the close button the card color and then inverted the
whole element, which turned the disc light grey and the cross white:
about 1.4:1. Without the background the invert gives the light-mode
button's mirror, a dark disc with a white cross.

* fix(dashboard): leave the temporary-account state once the account is saved

Saving a temporary account from the user menu promoted the user in place
without a reload, but Home kept its Save session warning (reopening the
save dialog for a saved account) and Account and Security stayed without
their password and email cards until the page was reloaded. The dashboard
now reacts to account-saved, which fires after the user is updated.

* fix(dashboard): give the API token field 16px text on touch screens

The coarse-pointer rule that sets the token field to 16px, as the other
dialog inputs are, came before the field's own 13px rule of the same
specificity, so the 13px won and iOS zoomed the page when the field was
focused. The touch rule now follows it.

* fix(dashboard): lighten the General access dropdown arrows in dark mode

The dark-mode chevron override covered the share modal's recipient
selects but not the two General access ones, which kept the darker
light-theme stroke on the dark card.

* fix(dashboard): don't leave the sidebar collapse button shaded after a tap

Its hover style was the sidebar's only one not limited to devices that
hover, so on a wide touch screen (an iPad in landscape) the button kept
its hover shade after being tapped.

* fix(dashboard): refresh the Usage tab when the subscription changes

An upgrade from the Usage tab's own button, or a return from the billing
portal, refreshed Home behind it while the Usage meter and plan button
kept the old allowance until the user left the tab and came back. Usage
now handles puter:subscription:changed while it is showing.

* perf(dashboard): load usage and storage once when the dashboard opens

Home and Usage both load the monthly usage and the storage space when the
dashboard opens, whichever tab it opens on, so every open sent
/metering/usage and /df twice. Overlapping loads now share one request.
Nothing is cached: a load after the shared one settles fetches again.

* fix(dashboard): keep keyboard focus on the Usage table's Show more/less

The table redraws without the button that was pressed, so focus fell back
to the page and the next Tab started from the top. Focus now moves to the
button that replaces it, as the sort headers already do.

* fix(dashboard): give primary buttons readable contrast

The dialogs' primary buttons, the share modal's Share and the photo
crop's Save were filled with the link color under white text: 4.07:1 in
light mode, 3.08:1 in dark, where hover lightened it further to 2.38:1.
They take their own fill now, #4a67f5 (4.62:1) darkening to #3d5bd9
(5.68:1) on hover in both themes; links keep their color.

* fix(dashboard): keep collapsed-sidebar labels above the dashboard

The hover label is attached to body at z-index 1000, while the dashboard
window's z-index climbs with every click (focusWindow raises it). Over a
long session the window passed 1000 and the labels rendered behind it,
so hovering the collapsed sidebar showed nothing.

* fix(dashboard): bring muted and tertiary text up to AA contrast

The muted and tertiary greys carry real information (form hints, file
dates and sizes, share "via" lines, the sidebar's team name,
notification text and times) but fell short of 4.5:1: 2.56:1 and 3.54:1
on white, 3.18:1 and 3.13:1 on dark cards. They now clear it on the
cards and the sidebar in both themes (light #5f6b7d / #707070, dark
#8b95a5 / #94949c). Disabled buttons keep the fainter grey through their
own token, so they still read as disabled.

* fix(dashboard): name the plan on self-hosted installs instead of "--"

A self-hosted install has no /marketplace/subscriptions/current route, and
Home treated its 404 like any failed read, leaving "Your Plan" at "--" for
good. A 404 now shows the plan every account starts on. The upgrade badge
and link, which have nothing to reach there, go too, unless the hosted
upgrade dialog is loaded.

* fix(dashboard): make hover and press feedback visible in dark mode

Dark mode's hover color, #2a2a2a, was 1.05:1 against the #262626 cards
and #252525 sidebar, so hovering a notification or sidebar item and
pressing a touch-menu or drawer item showed next to nothing. #333 sits
as far off them as light mode's hover sits off white, and stays below
the selected item's #3d3d3d.

* fix(dashboard): follow a username change in the Files tab

Changing the username, or saving a temporary account under a chosen
name, moves the home folder. The GUI rewrote data-path attributes and the
path globals, but the Files tab kept its current folder, back/forward
history, clipboard and drawn rows on the old path, so sorting, New
Folder, Upload, Up, Back and the breadcrumbs all failed with "This folder
couldn't be opened" until a reload. update_username_in_gui now announces
the change, and the Files tab moves its paths over and redraws.

* perf(dashboard): lay out only the new row when an item is added to Files

Every item added to the open folder from elsewhere (another tab, an
upload, a move into it) restyled and re-truncated every row in the
listing, so a burst of adds was quadratic in the folder's size: 100 adds
into a 300-item folder took ~800ms of main-thread work. The added row now
takes the listing's column layout on its own (~130ms for the same burst).

* fix(dashboard): open the Sort and View menus at their buttons from the keyboard

Enter or Space on either button fires a click with no coordinates, so the
menu opened at the top-left corner of the screen, far from the button.
A keyboard press now opens it below the button; a pointer click still
opens it at the pointer.

* fix(dashboard): open a breadcrumb's long-press menu as the touch sheet

A breadcrumb's long-press opened the desktop context menu at the event's
pointer position, which a long-press doesn't have, so on tablets the menu
landed wherever an unset position put it. Breadcrumbs now open the same
touch sheet, anchored to the crumb, as the sidebar folders and rows do.

* fix(dashboard): don't drag-move items the user can't move

Delete, Cut and their buttons already leave out shared roots and items in
a read-only share, but dropping them on a folder, a sidebar entry or a
breadcrumb still sent the moves, and each came back as a "Forbidden"
alert. Drag moves now leave those rows out too; copying them still works.

* fix(dashboard): clear "1 item selected" when a double-click opens a file

Opening a file by double-click deselects its row, but the footer kept
saying "1 item selected" with nothing selected.

* fix(dashboard): only the Trash gets the Trash label in breadcrumbs

Any folder named "Trash" was shown with the translated Trash label in the
breadcrumbs, so in German ~/Documents/Trash read as "Papierkorb". The
label now goes on the user's Trash folder only.

* fix(dashboard): name a trashed folder by its old name in the breadcrumbs

A trashed item's name on disk is its uid, so opening a trashed folder
showed a crumb like "ffaff8cb-dcaf-44f7-…" while its row in the Trash
read "Old project". The crumb now uses the name the row shows.

* fix(dashboard): show why Delete Permanently failed and keep the item

delete_item fades the item out before the request; when the request
failed it left the item hidden, as if deleted, and passed the alert the
undefined `responseText` of a puter.js error, which threw. The item now
comes back and the alert shows the error's message.

* fix(dashboard): translate the New menu's Web Link and templates strings

"Web Link", its URL prompt, validation and failure messages, the "User
templates" submenu, and the account prompt before publishing a worker
were hardcoded English in the Files New and item menus.

* fix(gui): stop leaking a document click handler per context menu

Every context menu bound its item-click handler on document, delegated
to its own id, and never unbound it. Each menu opened therefore left a
handler that ran on every later click in the page and kept the menu's
items alive, rows and fs entries included. The handler is now bound on
the menu itself and goes with it. It still returns false, so item clicks
keep not reaching document-level click handlers, as before.

* fix(gui): run a context menu item once on a double-click

The menu stays clickable during its 200ms fade-out, so the second click
of a double-click ran the item again: double-clicking Share… or
Properties in the dashboard opened two stacked dialogs. A menu that has
started closing now ignores item clicks.

* fix(dashboard): drag a select-mode selection from its own rows

Select mode returned from pointerdown before recording whether the
pressed row was already selected, so a drag started from that stale
value: dragging selected rows didn't move them, and a stale "selected"
could let a drag from an unselected row clear the selection. The value is
recorded first now.

* fix(dashboard): leave Files select mode when the window widens past 480px

Select mode's Select and Done buttons only show up to 480px, so turning
it on in a narrow window and widening it left every click toggling rows,
with no way out short of narrowing the window again.
2026-10-23 15:24:02 -07:00
Neal Shah 03e483e372 PUT-2252 (#4311) 2026-10-23 17:33:59 -04:00
Nariman Jelveh 9c90c7afde fix(dashboard): third adversarial review — bugs, UX, a11y, perf (#4310)
* chore(dashboard): add the standard file header where it was missing

* fix(dashboard): rename editor keeps entity-like names; rows follow remote renames

The name editor decoded its already-decoded value a second time, so opening
it on a file such as "R&amp;D.txt" and clicking away renamed it to "R&D.txt".

A rename or update from another tab only patched a row's attributes, while
its open/copy/share handlers kept using the entry they were rendered with;
the row now keeps that entry current and refits its name.

* fix(dashboard): Files selection, preview and Trash/Shared edge cases

- A marquee drag without modifiers now replaces a selection made by click,
  Ctrl+A or the arrow keys instead of adding to it.
- With the image preview open, clicking another image switches to it, and
  moving onto a non-image closes it instead of keeping the old image up.
- Cut (Ctrl+X, multi-select menu) skips trashed items, which leave the Trash
  through Restore; Ctrl+V refuses the Trash and the Shared view like the
  Paste menu item does.
- Drops on the Shared sidebar entry or breadcrumb are refused (the drag
  snaps back) instead of sending writes to a path that isn't a folder.
- The Trash selection bar shows Delete permanently again after a selection
  elsewhere had hidden it.

* fix(dashboard): keep an open rename across refreshes; re-sort renamed rows

A same-folder refresh (an upload or paste finishing, a sort change) rebuilt
every row and silently dropped a rename in progress; the editor now comes
back on the same item with the text and caret the user left.

A renamed row whose new name sorts last stayed where its old name was.

* fix(dashboard): Files columns follow the room the listing has

- Resizing a column past the listing's width clamps it instead of resetting
  every column to the defaults; a window too narrow for the saved widths
  lays out at the defaults but keeps the saved widths for when it widens.
- Columns and grid names re-fit when the window or sidebar resizes the
  listing, not only on the next navigation, and grid names hidden behind
  another tab are fitted when the Files tab is shown.
- Names are measured in the font they render in (the compact grid's is
  smaller), and a column drag relayouts at most once a frame.

* fix(dashboard): Files keyboard and touch edge cases

- The marquee selects file rows only, not the Shared/Trash place rows Home
  shows on narrow screens.
- Row shortcuts stand aside while the touch action sheet is open.
- Breadcrumb long-press opens its menu on iPadOS too.
- A folder rendered before the saved view preferences load uses the
  defaults instead of throwing and blocking navigation.

* fix(dashboard): share and properties modals — focus, Escape, link state

Share modal:
- Escape pressed in a window opened over the modal (a verification or
  upgrade gate) no longer closes the modal underneath.
- Turning the link on or off for a selection too large to list now shows
  the result instead of leaving the control on its old state.
- Opening the link up starts at view access; it no longer reuses a hidden
  mode left over from earlier, which could hand out edit access.
- Focus returns to the select the user changed.

Properties modal:
- Takes focus when it opens, keeps Tab inside, gives focus back on close,
  and leaves Escape to a window opened over it.
- Shows a loading state, and opening Versions on a folder before its
  details load no longer leaves an empty body.
- Disassociate is a real button, ignores repeat clicks while pending,
  reports a failure, and keeps the website badge while other sites remain.
- Tabs carry tab/tabpanel roles; transitions respect reduced motion.

* fix(dashboard): account dialogs, avatar saves and usage figures

- A form dialog ignores Escape and backdrop clicks while its request runs,
  so the outcome isn't lost behind a closed dialog; the close button still
  works.
- A new API token, shown only once, survives a stray click outside the card.
- Copy token works on origins without navigator.clipboard (plain-http
  self-hosts) instead of throwing, falling back to a selected field.
- Saving one profile picture and then another before the first finished
  can no longer leave the first one's picture or failure on screen.
- The storage host bar is clamped to the room left beside Puter's share and
  hides its label when there is no host figure.
- Sub-cent dollar costs read "<$0.01" rather than "$0.00", and the usage
  meter reads 99% until the allowance is actually spent.

* fix(dashboard): Apps folder drag, search, keys and loading

- A drag inside an open folder that is cancelled (Escape, blur) or dropped
  back in place puts the tiles back in their saved order; the cached panel
  markup used to skip the rebuild, and the next drag then saved the
  cancelled move too.
- Search no longer matches substrings of generated app ids, so "app" or a
  single hex letter stops returning every website shortcut.
- Arrow keys and Enter stay with the notifications panel, an account dialog
  or the touch action sheet while one is open over the grid.
- The grid shows after 1.5s even if an icon host never answers.
- Refreshing a grid already on screen keeps the page and skips the fade.
- Rename from a folder's menu focuses the name on touch devices too, and
  the folder dialog's label follows renames and counts the apps shown.
- i18n inserts %% values literally, so a name containing $& or $' no longer
  comes out mangled.

* fix(dashboard): shell navigation, a11y and notification sync

- Missed notifications replayed on load toast as one burst (a few, then a
  summary) instead of one toast each.
- A notification read in another tab while this tab's first listing is in
  flight is no longer shown as unread when that listing lands.
- Focus stays in the notifications panel when Mark all read or Retry hides
  the button that had it.
- The active sidebar tab carries aria-current, and the account button is
  named by the username even while the collapsed sidebar hides it.
- Landing with ?ref= replaces the history entry, so one Back leaves.
- Ctrl/Cmd/Shift-click on a sidebar tab opens it in a new browser tab.
- Recently used keeps the newest list when refreshes overlap, and app names
  are URL-encoded in the links it opens.

* fix(dashboard): focus rings, dark-mode contrast and reduced motion

- App tiles show a focus ring, not only the hover enlargement; Home card
  headers get an inset ring the card's rounded clip can't cut off; the
  Delete account button gets the settings cards' ring.
- Pager arrows are mouse-only (the dots page by keyboard), so invisible
  arrows are no longer Tab stops, and an arrow with no page leaves the
  accessibility tree.
- Dark mode: the Files toolbar's action icons match the nav arrows and stay
  readable on the hover chip, hovered breadcrumbs keep their contrast, and
  the shared-item dot's ring follows the row background.
- The row '⋯' button is visible at rest on touch screens.
- A long username or email wraps inside the profile card.
- The touch action sheet, the Files selection bar and the app feedback
  modal stop scaling/sliding under reduced motion.

* fix(gui): desktop rows store remote renames raw; column resize stays in bounds

- The desktop's item.renamed/item.updated handlers wrote HTML-escaped names
  into data-name, the title and the name editor (and titled windows by an
  undefined uid). They store the raw name now, as rename_file does, so the
  editor shows the real name now that it no longer decodes a second time.
- Resizing a Files column while saved widths are too wide for the listing
  starts from the widths on screen, and a width is held at its column's
  minimum, so a drag or auto-fit can't save a negative width.
- Double-clicking a row closes the image preview, which would otherwise
  float above the app window it opens.
2026-10-23 12:32:33 -07:00
Rasad RegmiandDaniel Salazar acd3df8c1b fix(puter-js): replay the request after a successful token_auth_failed reauth (#3954)
* fix(puter-js): replay the request after a token_auth_failed reauth

A 401 carrying the legacy `token_auth_failed` code opened the sign-in
prompt and then dropped the re-authenticated token on the floor:
`resolveReauth()` fell through to `return null` instead of returning
`{ action: 'replay' }`, so the original call was never re-issued and
rejected with `Unauthorized` even though the new session was valid.

Return the replay verdict the `reauth_required` branch already returns.
Both replay paths stay one-shot (`ctx.done.add('reauth')`,
`spec._replayed`), and the auth gate rejects before the route handler
runs, so a replay has no side effects.

Closes #3953

* fix(puter-js): sign in once when a replayed XHR is refused again

handle_resp ran the reauth flow on the replay's own 401, so a
token_auth_failed that survived the replay reset the fresh token and
opened a second sign-in before rejecting. Treat a replay's 401 as final,
as the 403 verification-gate branch already does.

---------

Co-authored-by: Daniel Salazar <[email protected]>
2026-10-23 00:07:56 -07:00
Daniel Salazar 4729d733bb feat(aws): DynamoDB, Polly and Textract can use the default credential chain (#4307)
`useCredentialChain: true` in `dynamo.aws`, `providers['aws-polly']` or
`providers['aws-textract']` takes credentials from the default AWS chain
instead of static keys, as `s3.s3Config` already does. One provider is shared
and refreshes temporary credentials itself.
2026-10-22 21:31:23 -07:00
Nariman Jelveh 26d843778e feat(dashboard): account dialogs as dashboard modals instead of windows (#4305)
* feat(dashboard): account dialogs as dashboard modals instead of windows

Edit profile, change username, change password, change email, create API
token, and delete account in the Account tab (and change password in the
Security tab) now open as dashboard overlay cards, like the share,
properties, and confirm dialogs, instead of desktop UIWindows. They are
centered cards on desktop and tablet and bottom sheets on phones.

- dashboardOverlay.js: the overlay shell UIDashboardDialog already had
  (reveal, Esc/backdrop/close dismissal, focus trap, focus return), pulled
  out so the new form dialog shares it. It also pins the overlay to the
  visual viewport so iOS's keyboard can't cover a sheet's fields, and
  leaves Esc to a modal opened on top of it.
- UIDashboardFormDialog.js: labelled fields, password show/hide, an
  aria-live status line that marks and focuses the offending field, a busy
  submit button, and a done state.
- postUserProtected.js: the cookie-retry / provider re-sign-in / reauth
  flow the four account windows each carried, in one place.
- Deleting an account is one dialog now (warning plus confirmation) rather
  than two stacked windows.
- Touch: 44px controls, 16px inputs (no iOS focus zoom), no autofocus
  that pops the keyboard mid-animation, form buttons side by side on
  phones, safe-area padding dropped while the keyboard is up.
- The replaced windows had no other callers and are removed with their
  tests, which are ported to the new modules.

* fix(dashboard): a double-click that opens a dialog no longer dismisses it

The second press of the double-click lands on the freshly mounted backdrop
and closed the dialog straight away. Backdrop presses with a click count
above one no longer count toward dismissal.

* fix(dashboard): a failed form submit keeps focus in the dialog

Locking the fields disabled the focused control, which drops focus to the
page, so after an error Enter no longer retried and screen readers lost
their place. The control that had focus gets it back once the fields
unlock, unless the handler moved focus elsewhere in the dialog.

* fix(dashboard): a form error keeps the field it names in view

The status line scrolled the dialog body to the bottom, which on a short
screen (a phone with its keyboard up) left the field being focused and
marked invalid scrolled off the top. The body now scrolls back up just
far enough to show that field.

* fix(gui): a blocked re-sign-in popup fails instead of waiting forever

openRevalidatePopup polled a popup that was never opened, so when the
browser blocked it the account dialog stayed busy indefinitely. It now
rejects straight away and the dialog says the sign-in didn't finish.

* fix(dashboard): password show/hide reads as one action, not a pressed toggle

The button flipped its label between Show and Hide password and also set
aria-pressed, so assistive tech announced "Hide password, pressed" while
the password was showing. It keeps the action label and drops aria-pressed.

* fix(dashboard): screen readers hear a form dialog's success message

The done state arrives as a new status region that already holds its text,
which screen readers don't announce, so after a change succeeded they only
heard "Done, button". The Done button that takes focus is now described by
the message.

* fix(dashboard): requesting an email change no longer sets the cached email

The server only stages the new address until the emailed link is
followed, but the dialog wrote it into window.user.email straight away.
That cached a wrong address for the session and kept refresh_user_data from
updating the Account tab once the change was confirmed, since the two
already matched.

* fix(dashboard): form dialog labels drop the global label shadow

style.css's bare `label` rule gave the field labels a white text-shadow,
which ghosted them on the dark theme, and an extra 3px under each label.

* fix(dashboard): dialog inputs keep a 1px border when focused

style.css's global input :focus rule still set a 2px border width, so a
dialog field's text shifted by a pixel each time it took focus. The focus
ring is the box-shadow; the border stays 1px.

* fix(dashboard): phone dialog inputs stay 16px instead of jumping on focus

On phones style.css's .device-phone input rule outranked the dialog's
16px size at rest, so fields drew at 17px and shrank to 16px the moment
they took focus.

* fix(dashboard): temporary accounts can delete themselves again

The server reports oidc_only for every passwordless account, temporary
ones included, so the shared user-protected helper sent a temporary
account into the linked-provider sign-in, which has no URL for it, and the
deletion never went out. Temporary accounts post directly, as the route
admits them without credentials.
2026-10-22 17:13:50 -07:00
Daniel Salazar 80a9cd85ee fix(ai): chat requests run to their upstream usage report after the caller disconnects (#4302)
- Providers send upstream calls with a driver-owned `upstreamSignal`
  instead of the caller's `abortSignal`. A disconnect detaches the chat
  stream: output stops, the provider keeps reading until the upstream
  reports usage, and that usage is metered.
- A detached stream gets SDK_TIMEOUT_MS to finish. After that the driver
  aborts the upstream, and the stream is metered like any other stream
  that ends without usage.
- The disconnect check also runs right before dispatch.
- The OpenAI stream handlers report usage that arrived before an abort.
- Docs: stopping a stream stops the output, and a request that reached
  the model is billed in full. Detached streams get 10 more minutes.
2026-10-22 16:08:05 -07:00
Nariman Jelveh 63370fcfa5 fix(dashboard): mobile and tablet review — layout, touch, safe areas (#4303)
* fix(dashboard): give narrow Files listings the two-row layout

The two-row rows (name, then size and date) were keyed to a phone-width
viewport, so between 481px and ~930px, where the sidebar and folder column
take their share, the fixed size and modified columns squeezed names to a
few characters. The layout now switches on the listing's own width with a
container query, which phones still meet and wide listings never do.

* fix(dashboard): wrap the Files toolbar onto two rows in narrow listings

On tablets the nav buttons, crumbs and actions sat on one row wider than
the listing, so the sort, view, new-folder and upload buttons ran off the
right edge. Narrow listings now use the phone's two-row toolbar (crumbs
above, buttons below); only the menu-button clearance stays phone-only.

* fix(dashboard): keep a deep folder path on one row with the current folder in view

A long path wrapped the crumbs over several lines on top of the column
headers and pushed the toolbar actions off-screen; where the crumbs already
scrolled (phones), the row opened at the root, hiding the current folder.
The crumbs now scroll within their row and are scrolled to their end on
render and when the tab is shown.

* fix(dashboard): end clipped file names in the list with an ellipsis

With the name column auto-sized, which is always the case on phones and
tablets, a long name was cut off mid-letter with no sign it continued.

* fix(dashboard): keep the Files selection bar under the drawer and sheets

The bar's visible state set z-index 99999999999999999 (clamped to the
maximum), so in phone select mode it drew over the open navigation drawer,
covering the account button, and over the share sheet it opens. Its base
z-index already clears the rows and the footer.

* fix(dashboard): let the last Files rows scroll clear of the phone selection bar

In phone select mode the list's bottom padding only cleared the footer, so
the last row stayed behind the floating action bar even fully scrolled.

* fix(dashboard): keep the phone Files footer and selection bar above the home indicator

The installed app runs edge to edge, so the footer's item count sat under
the iPhone home indicator. The footer now grows by the bottom safe-area
inset, and the list padding and floating action bar move up with it, as
the Apps tab and the dashboard's bottom sheets already do.

* fix(dashboard): clear the home indicator in the item properties sheet

On phones the sheet sits flush with the bottom edge, and unlike the share
sheet it mirrors, its body didn't pad for the bottom safe-area inset, so
the last details scrolled under the iPhone home indicator.

* fix(dashboard): keep the app feedback sheet's buttons above the home indicator

As a phone bottom sheet it sits flush with the bottom edge, so Cancel and
Send ended under the iPhone home indicator.

* fix(dashboard): size the touch context menu as a card on tablets

The touch menu took 90% of the viewport, which on an iPad meant a ~920px
strip with its labels far from the row they belong to. It now stops at
400px, which every phone stays under. Its height is also measured after
the width is set, so the clamp to the viewport uses the real height.

* fix(dashboard): let the Apps modals scroll in a short viewport

The Add-an-app and uninstall cards had no height cap and their overlay
centers without scrolling, so on a landscape phone with the keyboard up
(the viewport resizes for it) the request form's title and buttons sat
off-screen with no way to reach them.

* fix(dashboard): align Account and Security with the other tabs on phones

Below 768px their wrapper added a 16px gutter inside the content area's
own, so both tabs sat 32px in while Home, Apps and Usage (and the menu
button above them) sit at 16px. The extra padding stays for Apps, whose
content area has none.

* fix(dashboard): keep Home's recent apps inside their card on tablets

Each recent app was a fixed 200px inside 1fr columns, whose minimum is
that width, so in the half-width card on a landscape iPad the second
column ran past the card's edge and its name was cut off with the
ellipsis out of view. The rows now shrink with their column.

* fix(dashboard): keep every Files folder reachable in a short viewport

Trash was fixed to the bottom of the viewport, so in a landscape phone or
a short window it sat on top of Public and Videos, while Shared ran below
the column with no way to scroll to it. The folder column now scrolls,
and Trash sits at its foot in the flow: in the same spot when there is
room, after Shared when there isn't.

* fix(dashboard): don't leave Account and Security buttons highlighted after a tap

Their hover background wasn't limited to hover-capable pointers like the
rest of the dashboard's hover styles, so on touch devices a tapped button
(Change Password, Manage Sessions, ...) stayed shaded after its dialog
closed.

* fix(dashboard): give the Files row menu button a full-size touch target

On phones the row's '⋯' is 40x23, right beside a row whose tap opens the
item, so a slightly-off tap opened the file or folder instead of its
menu. In the two-row layout it now has a 44px square hit area on touch
screens.

* fix(dashboard): enlarge the Files back, forward and up touch targets

They were 28px squares on touch screens. On coarse pointers they now take
36px with a matching negative margin, so the toolbar layout is unchanged.

* fix(dashboard): size Home's recent apps card to its apps on phones

Its 310px minimum height matches the square welcome card beside it on
wider screens. In the single-column layout the welcome card drops its
square shape but the minimum stayed, leaving a block of empty card under
a short list of recent apps.

* fix(dashboard): stop clipping app names' descenders on phones and small tablets

Below 768px the tile height budgeted 52px icon + 10px margin + 12px for a
label line that is 15.6px tall, so the bottoms of g, p and y were cut off
in every app name. The tile now has the full line (78px) and the row gap
gives back the 4px, so tiles sit exactly where they did.

* fix(dashboard): show Usage amounts in full on phones

Every Usage table cell ellipsized, numbers included, so on a phone a
token count like 12,345,678 read as "12,345...". Below 480px the units
and cost columns now keep their full width and the resource name is the
one that truncates. Wider layouts are unchanged.

* fix(dashboard): stack Home's recent apps when their card is narrow

In the two-column Home on a portrait tablet (iPad Air and Pro 11 at
820-834px, or 769px windows) the Apps card is about 200px wide, and two
columns of recent apps cut every name to a letter or two. The list now
switches to one column on the card's own width; 1024px and wider keep two.

* fix(dashboard): fit two grid tiles a row in narrow Files listings

Grid view's 170px column minimum left one 330px tile per row on 360px
phones (and in a tablet's narrow listing), so barely two files fit on
screen. Narrow listings now use two equal columns, and the tile's icon
box shrinks with the tile instead of keeping its fixed 150px.

* fix(dashboard): align the Shared and Trash rows' menu button on phones

Item rows get position: relative from jQuery UI draggable, but the Shared
and Trash rows above Home's folders aren't draggable, so their '⋯' was
positioned against the whole list and sat 3px off from every other row's.
2026-10-22 15:39:47 -07:00
Daniel Salazar 631b264c1c test(ai): every AI driver holds and meters at the AI cost factor (#4304)
Image, video, TTS, speech-to-text and voice-changer driver tests run one
request at factor 1 and again with every `ai.cost.factor.*` hook set to
2, and check that both the credit hold and the recorded cost double.
Chat and OCR already had this coverage. A driver that hands a provider
the raw metering service instead of its factored view now fails its
test.

`withAiCostFactorHook` in integrationTestUtil keeps the hook in place
for a callback, since providers record their usage unawaited.
2026-10-22 15:31:15 -07:00
Filip KujundžićandClaude Opus 5.5 809c303117 fix(ai): treat a gateway 4xx with no upstream error body as a route failure (#4301)
Infron (a new-api gateway) answers "bad response status code N" with the
upstream's status when the upstream replied without a JSON error, e.g. a
model the upstream no longer serves. That 4xx was classified as the
caller's bad request, so the request skipped fallback, the dead route
stayed in rotation, and the caller got upstream_bad_request. It now counts
as an upstream failure: fallback runs, the route is marked unhealthy, and
an exhausted chain reports upstream_provider_unavailable. A gateway error
that carries the vendor's own message still stays request-level.

Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-22 15:14:28 -07:00
VonypetandCursor afad53d3f4 feat(gui): add Filipino and restore the language menu (#4263)
The desktop built the language list and never placed it on the user menu, so a saved locale could not be chosen. Register Filipino and show that list.

Co-authored-by: Cursor <[email protected]>
2026-10-22 15:13:43 -07:00
Daniel Salazar 8b8dd19eae fix(teams): refuse to boot when teams_enabled has nothing registering Teams (#4300)
* fix(teams): refuse to boot when teams_enabled has nothing registering Teams

Core's seat checks (team 2FA, seat password reset, email and username
changes, self-delete, the signup placeholder claim) read the team store and
skip when it is absent. With `teams_enabled` on and no extension registering
the store and service, the server now fails at boot instead of serving
without those checks.

- whoami no longer string-matches the extension proxy's "missing property"
  error: with the flag on, the store is always there.
- Tests that turned the flag on without Teams drop it; the puter.js harness
  sets it only under the `teams` capability.
- Drop a stale services/index.ts comment.

* refactor(gui): drop the Teams console styles, which ship with the console now
2026-10-22 15:11:36 -07:00
345 changed files with 34387 additions and 7644 deletions

No files matched your search

+3 -1
View File
@@ -184,10 +184,12 @@ Recipes are tested, copy-pasteable patterns for a task, one layer above the per-
- **Description.** Written for someone who has never heard of Puter. Start with "Learn how to", put the action first, and say what the reader's app gains: "Learn how to add file sharing to your app with Puter.js, so users can share files in their Puter account with other people." No API names, no mechanism, no list of example cases, and no "not just …" contrast.
- **Intro.** Explain the situation and why you'd do this, tied to something the reader already knows ("`puter.kv` is your database in Puter.js"). No "Use this when" bullet list.
- **Structure.** Get to the first working call as early as possible, then add validation, rate limits, and sign-in after it. Explain a Puter concept the first time it appears, such as what `me.puter` is or that `puter.workers.exec()` opens the Puter sign-in window. Split recipes by what the reader needs, not by technique, and give a family of recipes a shared tag.
- **Reading order.** A recipe reads top to bottom. Each code block uses only functions and variables from blocks above it, so the reader never has to search further down the page to understand it. Start with a small version that works, and have each section add one case. When a section changes a function from earlier, show the whole new version of that function there. If the code is built up over several sections, end with a `## Full Code` block that has all of it.
- **Link to the reference for full option lists.** Mention only the options the recipe uses, then link to the function page for the rest ("All the sort options are listed on [`puter.fs.readdir()`](/FS/readdir/)."). A copied list of options, rules, or scopes goes stale when the reference changes.
- **Limits.** Mention a limit only when it's the reason for a pattern the recipe uses, such as one wildcard subscription instead of one per key, and link to [rate-limits-and-quotas.md](src/docs/src/rate-limits-and-quotas.md) or the function page for the number. Leave out limits that code following the recipe never reaches.
- **Code.** Platform-neutral: just the code, with top-level `await`. No `<script>` or `<html>` wrapper, no IIFE.
- **Tradeoffs.** Justify a choice with one scenario the reader can picture right away, in about two short paragraphs, or fold each point into the section where it matters. The description states the benefit only.
- **Notes.** Leave out `## Notes` by default. Use it only to point to an architecturally different approach. A limit goes in the section it applies to; other facts belong on the linked reference page.
- **Notes.** Leave out `## Notes` by default. Use it only to point to an architecturally different approach. A limit the recipe needs goes in the section it applies to, and other facts belong on the linked reference page.
---
+9 -2
View File
@@ -215,7 +215,9 @@
// "bootstrapTables": true,
"path": "",
// Credentials. NOTE: snake_case here, unlike `s3.s3Config` below.
// For dynamodb-local, any non-empty values work.
// For dynamodb-local, any non-empty values work. On AWS,
// `"useCredentialChain": true` uses the default credential chain
// instead of keys.
"aws": {
"access_key": "",
"secret_key": "",
@@ -313,7 +315,8 @@
// The tables ship either way and sit inert; this gates whether `/teams`
// is registered at all, so with it off the paths do not exist rather than
// existing and refusing. It is also the backout: turning it off removes
// the feature without touching data.
// the feature without touching data. Teams ships as an extension; on,
// the server refuses to boot unless one registers it.
"teams_enabled": false,
//
// Live teams one user may own. Soft-deleted ones do not count, so
@@ -430,6 +433,8 @@
"mistral": { "apiKey": "" },
"xai": { "apiKey": "" },
"moonshot": { "apiKey": "" },
// MiniMax. One key powers chat and video generation (H3, Hailuo);
// video calls go to the same host, beside the chat API's `/v1`.
"minimax": {
"apiKey": "",
"apiBaseUrl": "https://api.minimax.io/v1"
@@ -492,6 +497,8 @@
"defaultVoiceId": "",
"speechToSpeechModelId": ""
},
// Both AWS providers also take `"useCredentialChain": true` in place
// of keys, like `dynamo.aws`.
"aws-polly": {
"access_key": "",
"secret_key": "",
+4 -1
View File
@@ -51,7 +51,10 @@ two pages can't be decoded into how fast the table grows; `openCursor` still
reads a plain cursor. What a cursor wraps is an implementation detail per
store:
- DynamoDB-backed lists wrap `LastEvaluatedKey`.
- DynamoDB-backed lists wrap `LastEvaluatedKey`. A kv listing of another
namespace (cross-app or through a share handle) resumes after the last entry
it returned instead, since the scan can stop on a private one, and its cursor
is sealed to that listing and padded to one length.
- SQL-backed lists wrap a keyset position — `(sortValue, id)` of the last
row — and the query seeks past it (`WHERE (col, id) > (?, ?) ORDER BY col,
id`). Any SQL list gaining a cursor must have a deterministic `ORDER BY`
+2 -3
View File
@@ -43,7 +43,6 @@ beforeAll(async () => {
create_shortcut: true,
payment_bypass: true,
},
teams_enabled: true,
} as never);
});
@@ -89,7 +88,7 @@ describe('whoami extension — handleWhoami', () => {
return { seat, team };
};
it('names no team where teams is not installed', async () => {
it('names no team where teams is off', async () => {
const { seat } = await seatOf('Acme Corp');
const { res, captured } = makeRes();
@@ -98,7 +97,7 @@ describe('whoami extension — handleWhoami', () => {
() => handleWhoami(makeReq(), res),
);
// `extension.import` resolves the registry, which has no team.
// Off, so the seat is never looked up.
expect((captured.body as { team?: unknown }).team).toBeUndefined();
});
+1 -1
View File
@@ -19099,7 +19099,7 @@
},
"src/puter-js": {
"name": "@heyputer/puter.js",
"version": "2.6.4",
"version": "2.6.5",
"license": "Apache-2.0",
"dependencies": {
"@heyputer/kv.js": "^0.2.1",
+8 -7
View File
@@ -24,9 +24,8 @@ import type { PuterServer } from './server.ts';
import { createTestUser, setupTestServer } from './testUtil.ts';
/**
* Teams is optional, so core has to work when neither the service nor the
* store is registered. Both are dropped after boot here, which is the shape
* core sees wherever the feature is not installed.
* Teams is optional, so core has to work when neither the service nor the store
* is registered, which is how this test server boots.
*/
describe('core without a teams registration', () => {
let server: PuterServer;
@@ -44,13 +43,9 @@ describe('core without a teams registration', () => {
beforeAll(async () => {
server = await setupTestServer({
teams_enabled: true,
// Without this the allowlist check returns before asking Teams.
teams_allowed_email_domains: ['test.local'],
} as never);
// What the registry looks like where Teams is not installed.
delete (server.services as { team?: unknown }).team;
delete (server.stores as { team?: unknown }).team;
});
afterAll(async () => {
@@ -62,6 +57,12 @@ describe('core without a teams registration', () => {
expect(server.stores.team).toBeUndefined();
});
it('refuses to boot when the config asks for teams', async () => {
await expect(
setupTestServer({ teams_enabled: true } as never),
).rejects.toThrow(/teams_enabled/);
});
it('deletes an account without asking what it was charged for', async () => {
const user = await makeUser();
await expect(
@@ -27,7 +27,7 @@ import { DatabaseClientFactory } from './index.js';
import { SqliteDatabaseClient } from './SqliteDatabaseClient.js';
/** Highest schema version the migration table can reach. */
const CURRENT_SCHEMA_VERSION = 90;
const CURRENT_SCHEMA_VERSION = 91;
/**
* These suites migrate real files on disk. Idle they finish in well under a
@@ -129,6 +129,7 @@ const AVAILABLE_MIGRATIONS: [number, string[]][] = [
[87, ['0092_share-entry-owner.sql']],
[88, ['0093_fsentries-parent-uid-index.sql']],
[89, ['0094_deleted-apps.sql']],
[90, ['0095_kv-share-handle-levels.sql']],
];
export class SqliteDatabaseClient extends AbstractDatabaseClient {
@@ -0,0 +1,50 @@
-- Copyright (C) 2024-present Puter Technologies Inc.
--
-- This file is part of Puter.
--
-- Puter is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as published
-- by the Free Software Foundation, either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see <https://www.gnu.org/licenses/>.
-- Share levels on `kv_share_handles`. See
-- sqlite/0095_kv-share-handle-levels.sql for the rationale. No per-file
-- applied-state tracking, so every step is guarded and a replay does nothing.
CALL _puter_add_col('kv_share_handles', 'revoked_by', '`revoked_by` varchar(8) DEFAULT NULL');
CALL _puter_add_col('kv_share_handles', 'label', '`label` varchar(512) DEFAULT NULL');
DROP PROCEDURE IF EXISTS _puter_add_kv_share_handle_indexes;
DELIMITER //
CREATE PROCEDURE _puter_add_kv_share_handle_indexes()
BEGIN
IF NOT EXISTS (
SELECT 1 FROM INFORMATION_SCHEMA.STATISTICS
WHERE TABLE_SCHEMA = DATABASE()
AND TABLE_NAME = 'kv_share_handles'
AND INDEX_NAME = 'idx_kv_share_handles_grantee'
) THEN
ALTER TABLE `kv_share_handles` ADD INDEX `idx_kv_share_handles_grantee` (`grantee_user_id`, `id`);
END IF;
IF NOT EXISTS (
SELECT 1 FROM INFORMATION_SCHEMA.STATISTICS
WHERE TABLE_SCHEMA = DATABASE()
AND TABLE_NAME = 'kv_share_handles'
AND INDEX_NAME = 'idx_kv_share_handles_app'
) THEN
ALTER TABLE `kv_share_handles` ADD INDEX `idx_kv_share_handles_app` (`app_uid`);
END IF;
END//
DELIMITER ;
CALL _puter_add_kv_share_handle_indexes();
DROP PROCEDURE IF EXISTS _puter_add_kv_share_handle_indexes;
@@ -0,0 +1,29 @@
-- Copyright (C) 2024-present Puter Technologies Inc.
--
-- This file is part of Puter.
--
-- Puter is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as published
-- by the Free Software Foundation, either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see <https://www.gnu.org/licenses/>.
-- Share levels on kv_share_handles. See
-- sqlite/0095_kv-share-handle-levels.sql for the rationale. Idempotent via
-- IF NOT EXISTS; there is no per-file applied-state tracking.
ALTER TABLE kv_share_handles ADD COLUMN IF NOT EXISTS revoked_by VARCHAR(8) DEFAULT NULL;
ALTER TABLE kv_share_handles ADD COLUMN IF NOT EXISTS label VARCHAR(512) DEFAULT NULL;
CREATE INDEX IF NOT EXISTS idx_kv_share_handles_grantee
ON kv_share_handles (grantee_user_id, id);
CREATE INDEX IF NOT EXISTS idx_kv_share_handles_app
ON kv_share_handles (app_uid);
@@ -0,0 +1,35 @@
-- Copyright (C) 2024-present Puter Technologies Inc.
--
-- This file is part of Puter.
--
-- Puter is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as published
-- by the Free Software Foundation, either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see <https://www.gnu.org/licenses/>.
-- What share levels need from `kv_share_handles`. The level itself is not a
-- column: it is the root of the stored `permission`.
--
-- - `revoked_by` : `owner`, `holder` or `system` (the namespace app was
-- deleted). Null while live, and on rows retired before
-- this existed.
-- - `label` : optional owner-set text the holder is shown.
-- - the grantee index serves the holder's listing and their unshare, and
-- the app index retiring a deleted app's handles.
ALTER TABLE `kv_share_handles` ADD COLUMN `revoked_by` TEXT DEFAULT NULL;
ALTER TABLE `kv_share_handles` ADD COLUMN `label` TEXT DEFAULT NULL;
CREATE INDEX IF NOT EXISTS `idx_kv_share_handles_grantee`
ON `kv_share_handles` (`grantee_user_id`, `id`);
CREATE INDEX IF NOT EXISTS `idx_kv_share_handles_app`
ON `kv_share_handles` (`app_uid`);
@@ -188,6 +188,47 @@ describe('DDBClient — item operations', () => {
).toBeUndefined();
});
it('puts only while its condition holds', async () => {
const absent = {
expression: 'attribute_not_exists(#pk)',
names: { '#pk': 'pk' },
};
await client.put(
TABLE,
{ pk: 'u7', sk: 'once', v: 1 },
{
condition: absent,
},
);
await expect(
client.put(
TABLE,
{ pk: 'u7', sk: 'once', v: 2 },
{
condition: absent,
},
),
).rejects.toMatchObject({ name: 'ConditionalCheckFailedException' });
expect(
(await client.get(TABLE, { pk: 'u7', sk: 'once' })).Item?.v,
).toBe(1);
await client.put(
TABLE,
{ pk: 'u7', sk: 'once', v: 3 },
{
condition: {
expression: '#v = :held',
names: { '#v': 'v' },
values: { ':held': 1 },
},
},
);
expect(
(await client.get(TABLE, { pk: 'u7', sk: 'once' })).Item?.v,
).toBe(3);
});
it('fetches keys from several tables in one batch', async () => {
await client.put(TABLE, { pk: 'b1', sk: 'a', v: 1 });
await client.put(TABLE, { pk: 'b1', sk: 'b', v: 2 });
@@ -501,6 +542,19 @@ describe('DDBClient — credentialled configuration', () => {
).toThrow('requires both `access_key` and `secret_key`');
});
it('accepts the credential chain in place of keys', async () => {
const client = new DDBClient({
port: 0,
extensions: [],
dynamo: {
aws: { useCredentialChain: true, region: 'us-west-2' },
endpoint: 'http://127.0.0.1:1',
},
} as unknown as IConfig);
await expect(client.recreateClient()).resolves.toBeUndefined();
});
it('skips table creation on a managed deployment', async () => {
const warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
const client = new DDBClient({
+39 -8
View File
@@ -43,6 +43,10 @@ import { once } from 'node:events';
import { Agent as httpsAgent } from 'node:https';
import { HttpError } from '../../core/http';
import type { IConfig, IDynamoConfig } from '../../types';
import {
awsCredentialsFrom,
type AwsCredentials,
} from '../../util/awsCredentials.js';
import { BoundedTtlMap } from '../../util/boundedTtlMap.js';
import { runWithConcurrencyLimitSettled } from '../../util/concurrency.js';
import { Span } from '../../util/span.js';
@@ -248,7 +252,19 @@ export class DDBClient extends PuterClient {
}
@Span('ddb.put', (table: string) => ({ 'db.table': table }))
async put<T extends Record<string, unknown>>(table: string, item: T) {
async put<T extends Record<string, unknown>>(
table: string,
item: T,
opts?: {
/** Refused (`ConditionalCheckFailedException`) unless it holds. */
condition?: {
expression: string;
names?: Record<string, string>;
values?: Record<string, unknown>;
};
},
) {
const condition = opts?.condition;
const client = await this.#getDocumentClient();
return sendRepairingValues(
item,
@@ -258,6 +274,23 @@ export class DDBClient extends PuterClient {
TableName: table,
Item: itemToWrite,
ReturnConsumedCapacity: 'TOTAL',
...(condition
? {
ConditionExpression: condition.expression,
...(condition.names
? {
ExpressionAttributeNames:
condition.names,
}
: {}),
...(condition.values
? {
ExpressionAttributeValues:
condition.values,
}
: {}),
}
: {}),
}),
),
() => `a put to ${table}`,
@@ -688,17 +721,15 @@ export class DDBClient extends PuterClient {
}
#bindAwsClient() {
const accessKeyId = this.#ddbConfig.aws?.access_key;
const secretAccessKey = this.#ddbConfig.aws?.secret_key;
if (!accessKeyId || !secretAccessKey) {
const credentials = awsCredentialsFrom(this.#ddbConfig.aws);
if (!credentials) {
throw new Error(
'DynamoDB aws config requires both `access_key` and `secret_key`',
'DynamoDB aws config requires both `access_key` and `secret_key`, or `useCredentialChain`',
);
}
this.#bindClient({
credentials: { accessKeyId, secretAccessKey },
credentials,
region: this.#ddbConfig.aws?.region || 'us-west-2',
endpoint: this.#ddbConfig.endpoint,
});
@@ -720,7 +751,7 @@ export class DDBClient extends PuterClient {
region,
endpoint,
}: {
credentials: { accessKeyId: string; secretAccessKey: string };
credentials: AwsCredentials;
region: string;
endpoint?: string;
}) {
+27 -1
View File
@@ -397,6 +397,8 @@ export type EventMap = {
user_id: number;
user_uuid?: string;
stripe_customer_id?: string | null;
/** Apps the account owned, which cascaded away with it. */
appUids?: string[];
};
// ---- Team billing ---- the trigger, never the charge ----
@@ -490,13 +492,33 @@ export type EventMap = {
noShareKeys?: string[];
/** Events handler runs behind the write; see `Actor.handlerDepth`. */
handlerDepth?: number;
/**
* The user who made the change. Differs from `userId` when a share
* holder wrote into the owner's namespace.
*/
actingUserId?: number;
/** Made by a worker session or an events handler; see `viaWorkerOf`. */
viaWorker?: true;
};
/**
* A whole namespace was emptied. Namespace-level on purpose: `flush`'s own
* key enumeration is truncated for a large namespace, so the keys it saw
* are not the keys it removed.
*/
'kv.flushed': { namespace: string; userId: number };
'kv.flushed': {
namespace: string;
userId: number;
actingUserId?: number;
viaWorker?: true;
};
/**
* Share handles stopped being addresses, whoever retired them. `userId` is
* one user who could have subscribed through them, their owner or their
* holder. Listeners end what was made through them even where another grant
* still covers the region. Local, like `permission.revoked`: one region
* settling covers every other.
*/
'kv.share.retired': { handles: string[]; userId: number };
// ---- Notifications ----
/**
@@ -679,6 +701,10 @@ export type EventMap = {
requestHash?: string;
mime: string;
};
// Asked for a request whose host is outside every configured domain. A
// listener that recognises the host sets `result.subdomain` to the site
// it serves; an unclaimed host is answered with a 404.
'site.resolveHost': { host: string; result: { subdomain: string | null } };
// Asked before a hosted file is streamed. A listener that owns the site
// sets `result.allowed = false` to withhold the entry; the visitor then
// sees the same 404 as for a missing file.
@@ -28,7 +28,6 @@ import {
setupPuterTestEnv,
type PuterTestEnv,
} from '../../testUtil.js';
import type { IConfig } from '../../types';
/**
* HTTP-level coverage for `/auth/revoke-own-access-token` — the route that
@@ -424,7 +423,7 @@ describe('2FA enrollment over HTTP', () => {
let env: PuterTestEnv;
beforeAll(async () => {
env = await setupPuterTestEnv({ teams_enabled: true } as IConfig);
env = await setupPuterTestEnv();
}, 120_000);
afterAll(async () => {
@@ -49,7 +49,7 @@ import {
} from '../../core/http/types.js';
import { PuterServer } from '../../server.js';
import { createSecret as otpCreateSecret } from '../../services/auth/OTPUtil.js';
import { kvSharePermission } from '../../services/events/kvShares.js';
import { kvSharePermission } from '../../services/kvShare/kvShares.js';
import { FULL_API_ACCESS } from '../../services/permission/consts.js';
import { setupTestServer } from '../../testUtil.js';
import { resetCardVerificationStatusCache } from '../../util/cardFallback.js';
@@ -2151,7 +2151,7 @@ describe('AuthController grant flows', () => {
},
{ ownerUserId: issuer.id },
);
const permission = `service:tg-app:ii:read`;
const permission = `events:background`;
// The controller's grant call delegates through PermissionService
// (which uses ALS Context.set), so wrap in runWithContext.
const res = makeRes();
@@ -2192,7 +2192,7 @@ describe('AuthController grant flows', () => {
},
{ ownerUserId: issuer.id },
);
const permission = `service:tg-origin-app:ii:read`;
const permission = `events:background`;
const res = makeRes();
await inCtx(issuerActor, () =>
controller.handleGrantUserApp(
@@ -2229,7 +2229,7 @@ describe('AuthController grant flows', () => {
},
{ ownerUserId: issuer.id },
);
const permission = `service:tr-origin-app:ii:read`;
const permission = `events:background`;
await inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
@@ -2294,7 +2294,7 @@ describe('AuthController grant flows', () => {
await inCtx(issuerActor, () =>
controller.handleRevokeUserApp(
makeReq(
{ app_uid: app.uid, permission: 'service:x:ii:read' },
{ app_uid: app.uid, permission: 'events:background' },
{ actor: issuerActor },
),
makeRes(),
@@ -2318,12 +2318,12 @@ describe('AuthController grant flows', () => {
it('grant-user-app: 400 on non-string or oversized origin/app_uid/permission', async () => {
const cases = [
{ origin: { host: 'evil' }, permission: 'service:x:ii:read' },
{ origin: 'https://a.test', permission: ['service:x:ii:read'] },
{ app_uid: 12345, permission: 'service:x:ii:read' },
{ origin: { host: 'evil' }, permission: 'events:background' },
{ origin: 'https://a.test', permission: ['events:background'] },
{ app_uid: 12345, permission: 'events:background' },
{
origin: `https://${'a'.repeat(5000)}.test`,
permission: 'service:x:ii:read',
permission: 'events:background',
},
];
for (const body of cases) {
@@ -2354,7 +2354,7 @@ describe('AuthController grant flows', () => {
{ ownerUserId: target.id },
);
const permission = 'service:squat:ii:read';
const permission = 'events:background';
for (const handler of [
'handleGrantUserApp',
'handleRevokeUserApp',
@@ -2398,7 +2398,7 @@ describe('AuthController grant flows', () => {
{ ownerUserId: target.id },
);
const permission = 'service:squat-beside:ii:read';
const permission = 'events:background';
for (const handler of [
'handleGrantUserApp',
'handleRevokeUserApp',
@@ -2451,7 +2451,7 @@ describe('AuthController grant flows', () => {
{ ownerUserId: issuer.id },
);
const permission = 'service:tp-origin:ii:read';
const permission = 'events:background';
await inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
@@ -2487,7 +2487,7 @@ describe('AuthController grant flows', () => {
},
{ ownerUserId: issuer.id },
);
const permission = 'service:tm-app:ii:read';
const permission = 'events:background';
for (const body of [
{ app_uid: app.uid, permission, meta: 'nope' },
{ app_uid: app.uid, permission, meta: [1, 2] },
@@ -2528,7 +2528,7 @@ describe('AuthController grant flows', () => {
},
{ ownerUserId: issuer.id },
);
const permission = 'service:tb-app:ii:read';
const permission = 'events:background';
const oversized = { blob: 'z'.repeat(5000) };
for (const body of [
{ app_uid: app.uid, permission, extra: oversized },
@@ -2605,26 +2605,278 @@ describe('AuthController grant flows', () => {
expect(res.body).toEqual({});
});
it('grant-user-app: 400 on a `permission` wider than the column it lands in', async () => {
// 300 chars is under the 4096 input cap but over `varchar(255)`, so it
// used to reach the INSERT and fault on MySQL/Postgres. The check runs
// after the rewrite, so this has to be a permission no rewriter
// shortens — and it has to reject before the app is resolved, since
// this uid names no app.
await expect(
it('grant-user-app: grants read and write share delegations on a region, never on the namespace', async () => {
const appName = `tkvl-${uuidv4()}`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestKvShareLevelsApp',
index_url: `https://${appName}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
for (const root of ['kv-share-read', 'kv-share-write']) {
const namespace = `manage:${root}:${issuer.uuid}:${app.uid}`;
await expect(
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{ app_uid: app.uid, permission: namespace },
{ actor: issuerActor },
),
makeRes(),
),
),
).rejects.toMatchObject({ legacyCode: 'invalid_kv_share_prefix' });
const res = makeRes();
await inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{ app_uid: app.uid, permission: `${namespace}:team` },
{ actor: issuerActor },
),
res,
),
);
expect(res.body).toEqual({});
}
const rows = await server.clients.db.read(
'SELECT `permission` FROM `user_to_app_permissions` WHERE `user_id` = ? AND `app_id` = ? ORDER BY `permission`',
[issuer.id, app.id],
);
expect(rows.map((r: { permission: string }) => r.permission)).toEqual([
`manage:kv-share-read:${issuer.uuid}:${app.uid}:team`,
`manage:kv-share-write:${issuer.uuid}:${app.uid}:team`,
]);
});
it('grant-user-app: refuses a share delegation whose region a new share could not name, writing nothing', async () => {
const appName = `tkvc-${uuidv4()}`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestKvShareCharsApp',
index_url: `https://${appName}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
for (const region of ['Team', 'team:Abc', 'caf\u00E9', 'a b'])
await expect(
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{
app_uid: app.uid,
permission: `manage:kv-share-read:${issuer.uuid}:${app.uid}:${region}`,
},
{ actor: issuerActor },
),
makeRes(),
),
),
).rejects.toMatchObject({ legacyCode: 'invalid_kv_share_prefix' });
const rows = await server.clients.db.read(
'SELECT `permission` FROM `user_to_app_permissions` WHERE `user_id` = ? AND `app_id` = ?',
[issuer.id, app.id],
);
expect(rows).toEqual([]);
});
it('grant-user-app: refuses a permission outside the app-grantable families, writing nothing', async () => {
const appName = `tng-${uuidv4()}`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestNotGrantableApp',
index_url: `https://${appName}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
const other = await server.stores.app.create(
{
name: `tng-other-${uuidv4()}`,
title: 'TestNotGrantableOther',
index_url: `https://tng-other-${uuidv4()}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
const refused = [
['driver:puter-image-generation:generate'],
[`user:${target.uuid}:email:read`],
// One bad entry refuses the batch.
['events:background', 'random-string'],
// A share delegation names the app's own namespace only.
[`manage:kv-share:${issuer.uuid}:${other.uid}:rooms`],
];
for (const permissions of refused) {
await expect(
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{ app_uid: app.uid, permissions },
{ actor: issuerActor },
),
makeRes(),
),
),
).rejects.toMatchObject({
statusCode: 400,
legacyCode: 'permission_not_grantable',
});
}
const rows = await server.clients.db.read(
'SELECT 1 FROM `user_to_app_permissions` WHERE `user_id` = ? AND `app_id` = ?',
[issuer.id, app.id],
);
expect(rows).toEqual([]);
});
it('grant-user-app: refuses a non-canonical spelling of a grantable permission', async () => {
const appName = `tnc-${uuidv4()}`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestNonCanonicalApp',
index_url: `https://${appName}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
for (const permission of [
`f\\s:/${issuer.username}/Documents:read`,
`app-root-di\\r:${app.uid}:read`,
`manag\\e:kv-share:${issuer.uuid}:${app.uid}:rooms`,
]) {
await expect(
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{ app_uid: app.uid, permission },
{ actor: issuerActor },
),
makeRes(),
),
),
).rejects.toMatchObject({ legacyCode: 'permission_not_grantable' });
}
});
it('grant-user-app: refuses a share delegation over a prefix no share could be made of, as a share would be', async () => {
const appName = `tkvp-${uuidv4().slice(0, 8)}`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestKvSharePrefixApp',
index_url: `https://${appName}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
for (const root of ['kv-share', 'kv-share-read', 'kv-share-write']) {
// A share grant one character wider than the column.
const head = `${root}:${issuer.uuid}:${app.uid}:`;
const region = 'a'.repeat(256 - head.length);
await expect(
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{
app_uid: app.uid,
permission: `manage:${head}${region}`,
},
{ actor: issuerActor },
),
makeRes(),
),
),
).rejects.toMatchObject({ legacyCode: 'invalid_kv_share_prefix' });
}
});
it('grant-user-app: a share delegation must name the app the request names, by uid, name or origin', async () => {
const appName = `tkvn-${uuidv4()}`;
const origin = `https://${appName}.example.test`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestKvShareNamedApp',
index_url: `${origin}/index.html`,
},
{ ownerUserId: issuer.id },
);
const other = await server.stores.app.create(
{
name: `tkvn-other-${uuidv4()}`,
title: 'TestKvShareNamedOther',
index_url: `https://tkvn-other-${uuidv4()}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
const grant = (requester: Record<string, string>, namespace: string) =>
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{
app_uid: `app-${uuidv4()}`,
permission: `service:${'a'.repeat(300)}:ii:read`,
...requester,
permission: `manage:kv-share:${issuer.uuid}:${namespace}:rooms`,
},
{ actor: issuerActor },
),
makeRes(),
),
);
for (const requester of [{ app_uid: app.name }, { origin }]) {
await grant(requester, app.uid);
await expect(grant(requester, other.uid)).rejects.toMatchObject({
legacyCode: 'permission_not_grantable',
});
}
// The app's name is not its namespace.
await expect(
grant({ app_uid: app.uid }, app.name),
).rejects.toMatchObject({ legacyCode: 'permission_not_grantable' });
const rows = await server.clients.db.read(
'SELECT `permission` FROM `user_to_app_permissions` WHERE `user_id` = ? AND `app_id` = ?',
[issuer.id, app.id],
);
expect(rows.map((r: { permission: string }) => r.permission)).toEqual([
`manage:kv-share:${issuer.uuid}:${app.uid}:rooms`,
]);
});
it('grant-user-app: 400 on a `permission` wider than the column it lands in', async () => {
// Under the 4096 input cap but over `varchar(255)`, so it would reach
// the INSERT and fault on MySQL/Postgres. The check runs after the
// rewrite, so this has to be a grantable permission no rewriter
// shortens.
const appName = `tw-${uuidv4()}`;
const app = await server.stores.app.create(
{
name: appName,
title: 'TestWidthApp',
index_url: `https://${appName}.example.test/index.html`,
},
{ ownerUserId: issuer.id },
);
// The shares it delegates fit, at 255 characters; the consent's own
// `manage:` arm takes it past the column.
const head = `kv-share:${issuer.uuid}:${app.uid}:`;
const permission = `manage:${head}${'a'.repeat(255 - head.length)}`;
await expect(
inCtx(issuerActor, () =>
controller.handleGrantUserApp(
makeReq(
{ app_uid: app.uid, permission },
{ actor: issuerActor },
),
makeRes(),
),
),
).rejects.toMatchObject({ statusCode: 400 });
).rejects.toMatchObject({
statusCode: 400,
legacyCode: 'bad_request',
message: 'Invalid `permission`',
});
});
it('grant-user-app: an oversized permission that a rewriter shortens is accepted', async () => {
@@ -2636,6 +2888,8 @@ describe('AuthController grant flows', () => {
// on "please try again" for any deeply nested file. Exercised here
// through a rewriter of our own, since the real fs rewriter resolves
// the path through the fsentry store and this suite has no entries.
// It rewrites a share delegation only because that is a grantable
// shape no production rewriter touches.
const appName = `tlp-${uuidv4()}`;
const app = await server.stores.app.create(
{
@@ -2646,13 +2900,15 @@ describe('AuthController grant flows', () => {
{ ownerUserId: issuer.id },
);
const prefix = `tlprw-${uuidv4()}`;
const longPermission = `${prefix}:${'a'.repeat(300)}:read`;
const shortPermission = `${prefix}:${uuidv4()}:read`;
// Over the column only by its `manage:` arm, so the shares it
// delegates still fit.
const head = `kv-share:${issuer.uuid}:${app.uid}:`;
const longPermission = `manage:${head}${'a'.repeat(255 - head.length)}`;
const shortPermission = `manage:${head}${uuidv4()}`;
expect(longPermission.length).toBeGreaterThan(255);
expect(shortPermission.length).toBeLessThanOrEqual(255);
server.services.permission.registerRewriter({
id: `test-shorten-${prefix}`,
id: `test-shorten-${app.uid}`,
matches: (permission: string) => permission === longPermission,
rewrite: async () => shortPermission,
});
@@ -2712,7 +2968,8 @@ describe('AuthController grant flows', () => {
{ ownerUserId: issuer.id },
);
const prefix = `conc-${uuidv4()}`;
// A grantable shape no production rewriter touches.
const prefix = `manage:kv-share:${issuer.uuid}:${app.uid}:conc-${uuidv4()}`;
let release: () => void;
let entered: () => void;
const held = new Promise<void>((r) => {
@@ -2740,7 +2997,7 @@ describe('AuthController grant flows', () => {
makeReq(
{
app_uid: app.uid,
permission: `${prefix}:${app.uid}:write`,
permission: `${prefix}:write`,
},
{ actor: issuerActor },
),
@@ -2781,8 +3038,8 @@ describe('AuthController grant flows', () => {
{ ownerUserId: issuer.id },
);
const prefix = `tardrw-${uuidv4()}`;
const pseudoPermission = `${prefix}:${app.uid}:write`;
const prefix = `manage:kv-share:${issuer.uuid}:${app.uid}:tardrw-${uuidv4()}`;
const pseudoPermission = `${prefix}:write`;
const resolvedPermission = `fs:${uuidv4()}:write`;
const NOTHING = 'nothing-in-particular';
server.services.permission.registerRewriter({
@@ -3023,7 +3280,7 @@ describe('AuthController.handleGrantUserApp `create` flag', () => {
// phase A's pre-flight passes, phase C's re-check then fails, so the
// leaf (and its auto-created parent) already exist by the time the
// request unwinds.
const prefix = `rbparent-${uuidv4()}`;
const prefix = `manage:kv-share:${user.uuid}:${appUid}:rbparent-${uuidv4()}`;
let calls = 0;
server.services.permission.registerRewriter({
id: prefix,
@@ -3189,13 +3446,13 @@ describe('AuthController.handleGrantUserApp `create` flag', () => {
).rejects.toMatchObject({ statusCode: 400, legacyCode: 'bad_request' });
});
it('does not apply `create` to a `manage:` grant — 404 unchanged, nothing created', async () => {
it('refuses a `manage:` grant outright, creating nothing', async () => {
const p = path(`manage-missing-${rand()}`);
await expect(
grant({ permission: `manage:fs:${p}:write` }),
).rejects.toMatchObject({
statusCode: 404,
legacyCode: 'subject_does_not_exist',
statusCode: 400,
legacyCode: 'permission_not_grantable',
});
expect(await server.stores.fsEntry.getEntryByPath(p)).toBeFalsy();
});
@@ -3285,7 +3542,7 @@ describe('AuthController.handleGrantUserApp `create` flag', () => {
// (so nothing is rejected before anything is created) but has grown
// too wide by the time phase C re-runs it — modelling a grant that
// only fails once the fs path from the same batch already exists.
const prefix = `rbtest-${uuidv4()}`;
const prefix = `manage:kv-share:${user.uuid}:${appUid}:rbtest-${uuidv4()}`;
let calls = 0;
server.services.permission.registerRewriter({
id: `test-rollback-${prefix}`,
@@ -3326,6 +3583,37 @@ describe('AuthController.handleGrantUserApp `create` flag', () => {
);
});
it('check-permissions answers an app asking about itself through ACL, so a folder grant covers what is inside', async () => {
const dir = path(`acl-self-${rand()}`);
const child = `${dir}/inner`;
await server.services.fs.mkdir(user.id, {
path: child,
createMissingParents: true,
});
expect(await checkAsApp(`fs:${child}:read`)).toBe(false);
await grant({ permission: `fs:${dir}:write`, create: false });
expect(await checkAsApp(`fs:${child}:read`)).toBe(true);
expect(await checkAsApp(`fs:${child}:write`)).toBe(true);
// Another user's home stays out of reach.
expect(await checkAsApp(`fs:/${target.username}/Documents:read`)).toBe(
false,
);
});
it('check-permissions answers an app asking about itself through ACL for a uid too', async () => {
const dir = path(`acl-self-uid-${rand()}`);
const child = await server.services.fs.mkdir(user.id, {
path: `${dir}/inner`,
createMissingParents: true,
});
expect(await checkAsApp(`fs:${child.uuid}:read`)).toBe(false);
await grant({ permission: `fs:${dir}:read`, create: false });
expect(await checkAsApp(`fs:${child.uuid}:read`)).toBe(true);
expect(await checkAsApp(`fs:${child.uuid}:write`)).toBe(false);
});
it('check-permissions on a missing fs path answers false rather than 404ing, without poisoning a mixed batch', async () => {
const missingPath = path(`.checkmissing-${rand()}`);
// A held fs grant: the owning user holds it implicitly (is-owner), so
@@ -4152,9 +4440,9 @@ describe('AuthController.handleCreateAccessToken + handleRevokeAccessToken', ()
['an oversized permission string', ['x'.repeat(4097)]],
[
'an oversized `extra`',
[['service:x:ii:read', { a: 'y'.repeat(5000) }]],
[['events:background', { a: 'y'.repeat(5000) }]],
],
['a non-object `extra`', [['service:x:ii:read', 'nope']]],
['a non-object `extra`', [['events:background', 'nope']]],
['an empty permission string', ['']],
])('rejects %s with 400', async (_label, permissions) => {
await expect(
@@ -7365,6 +7653,88 @@ describe('AuthController.handleCheckPermissions + handleListPermissions', () =>
]);
});
it('check-permissions: answers false for share grants, which name what a holder is never told, but not for their manage arm', async () => {
const { user: owner, actor: ownerActor } = await makeUserAndActor();
const { user: holder, actor: holderActor } = await makeUserAndActor();
const region = `notes-${uuidv4().slice(0, 8)}`;
const grant = `kv-share-read:${owner.uuid}:os-global:${region}`;
await inCtx(ownerActor, () =>
server.services.permission.grantUserUserPermission(
ownerActor,
holder.username,
grant,
),
);
expect(await server.services.permission.check(holderActor, grant)).toBe(
true,
);
const asked = [
grant,
`kv-share:${owner.uuid}:os-global:${region}:inner`,
`kv-share-write:${owner.uuid}:os-global:${region}`,
];
const res = makeRes();
await inCtx(holderActor, () =>
controller.handleCheckPermissions(
makeReq({ permissions: asked }, { actor: holderActor }),
res,
),
);
expect(res.body).toEqual({
permissions: Object.fromEntries(asked.map((p) => [p, false])),
});
// What `puter.perms.check('kvShare', …)` asks.
const manage = `manage:kv-share-read:${owner.uuid}:os-global:${region}`;
const ownerRes = makeRes();
await inCtx(ownerActor, () =>
controller.handleCheckPermissions(
makeReq({ permissions: [manage] }, { actor: ownerActor }),
ownerRes,
),
);
expect(ownerRes.body).toEqual({ permissions: { [manage]: true } });
});
it('check-permissions: answers false for share grants asked by an app actor too', async () => {
const { user: owner, actor: ownerActor } = await makeUserAndActor();
const { user: holder, actor: holderActor } = await makeUserAndActor();
const app = await server.stores.app.create(
{
name: `cpk-${uuidv4()}`,
title: 'TestCheckPermsKvApp',
index_url: 'https://check-perms-kv.example.test/index.html',
},
{ ownerUserId: holder.id },
);
const grant = `kv-share-read:${owner.uuid}:${app.uid}:notes-${uuidv4().slice(0, 8)}`;
await inCtx(ownerActor, () =>
server.services.permission.grantUserUserPermission(
ownerActor,
holder.username,
grant,
),
);
const appActor = makeActor({
user: holderActor.user,
app: { id: app.id, uid: app.uid },
});
// The holder's app in the share's namespace holds it.
expect(await server.services.permission.check(appActor, grant)).toBe(
true,
);
const res = makeRes();
await inCtx(appActor, () =>
controller.handleCheckPermissions(
makeReq({ permissions: [grant] }, { actor: appActor }),
res,
),
);
expect(res.body).toEqual({ permissions: { [grant]: false } });
});
// What lets a permission request settle without a prompt. The second string
// is a consent scope nothing implies, so the first's `true` is the grant.
it('check-permissions: an app-under-user actor sees a grant made to that app', async () => {
@@ -7579,7 +7949,7 @@ describe('AuthController.handleCheckPermissions + handleListPermissions', () =>
},
{ ownerUserId: user.id },
);
const permission = 'service:tl-app:ii:read';
const permission = 'events:background';
await inCtx(actor, () =>
controller.handleGrantUserApp(
makeReq({ app_uid: app.uid, permission, extra: {} }, { actor }),
@@ -10215,7 +10585,7 @@ describe('AuthController — app-data grants', () => {
await expect(
post('handleGrantUserApp', {
app_uid: grantee.uid,
permission: 'app-data:app-nope/:kv:read',
permission: `app-data:app-${uuidv4()}:kv:read`,
}),
).rejects.toMatchObject({ statusCode: 404 });
});
@@ -10282,7 +10652,7 @@ describe('AuthController — app-data grants', () => {
it('leaves unrelated permissions untouched by the new validation', async () => {
const grantee = await makeAppRow();
const permission = 'service:unrelated:ii:read';
const permission = 'events:background';
await post('handleGrantUserApp', {
app_uid: grantee.uid,
permission,
+65 -9
View File
@@ -33,7 +33,7 @@ import {
hasVerifiedPhone,
} from '../../core/http/middleware/gates.js';
import type { Actor } from '../../core/actor.js';
import { isPlainUserActor, makeActor } from '../../core/actor.js';
import { isAppActor, isPlainUserActor, makeActor } from '../../core/actor.js';
import {
checkRateLimit,
consumeRouteRateLimit,
@@ -88,13 +88,16 @@ import {
import { promoteToVerifiedGroup } from '../../util/userProvisioning.js';
import {
assertBoundedManageGrant,
assertNewShareSegments,
assertPrefixFitsAccess,
isKvSharePermission,
} from '../../services/events/kvShares.js';
} from '../../services/kvShare/kvShares.js';
import {
APP_DATA_PERMISSION_PREFIX,
appDataSharingAllowed,
parseAppDataPermission,
} from '../../services/permission/appDataScopes.js';
import { parseAppGrantablePermission } from '../../services/permission/appGrantable.js';
import {
assertCreatablePath,
isOwnHomePath,
@@ -2997,6 +3000,45 @@ export class AuthController extends PuterController {
return typeof permission === 'string' && permission ? [permission] : [];
}
/**
* Refuses any entry outside the families an app can be granted. Anything
* else is a row the backend never checks for an app, or one wider than the
* consent prompt can describe.
*/
async #assertAppGrantable(
actor: Actor,
appIdentifier: string,
list: string[],
): Promise<void> {
const refuse = (entry: string) =>
new HttpError(
400,
`Permission cannot be granted to an app: ${entry}`,
{ legacyCode: 'permission_not_grantable' },
);
let appUid: string | undefined;
for (const entry of list) {
// A delegation over a whole key-value namespace has no bounded
// description; refused with its own code.
assertBoundedManageGrant(entry);
const parsed = parseAppGrantablePermission(entry, actor.user!.uuid);
if (!parsed) throw refuse(entry);
if (parsed.family !== 'kvShare') continue;
// Held to what a new share's prefix may be, so a consent never
// covers shares that could not be made.
assertNewShareSegments(parsed.segments);
assertPrefixFitsAccess(
parsed.ownerUuid,
parsed.appUid,
parsed.segments.join(':'),
parsed.level,
);
// An app shares regions of its own namespace only.
appUid ??= (await this.stores.app.resolveApp(appIdentifier))?.uid;
if (parsed.appUid !== appUid) throw refuse(entry);
}
}
/**
* Gate a cross-app data grant: the target must exist, must not have opted
* out of sharing, and must be named. Also creates the target's AppData
@@ -3175,6 +3217,7 @@ export class AuthController extends PuterController {
}
// 400 on a bad value, before anything else runs. Absent means create.
const create = parseCreateFlag(req.body?.create);
await this.#assertAppGrantable(req.actor!, app_uid, list);
// Validate every entry before writing or creating anything, so a bad
// one in the list cannot leave a partially-granted set behind: the
@@ -3187,10 +3230,6 @@ export class AuthController extends PuterController {
kind: FsCreateKind;
}> = [];
for (const entry of list) {
// A delegation over a whole key-value namespace has no bounded
// description, so it is refused where it is asked for rather than
// prompted for and then refused at use.
assertBoundedManageGrant(entry);
await this.#prepareAppDataGrant(req.actor!, entry);
const plan = await this.#planFsPathCreate(
req.actor!,
@@ -3397,11 +3436,28 @@ export class AuthController extends PuterController {
const unique = [...new Set(permissions)] as string[];
const result: Record<string, boolean> = {};
// `fs:` reaches down a tree, and only ACL walks that.
// A share grant names its owner and prefix, which its holder is never
// told, so asking about one would confirm a guess. `manage:` arms are
// the app's own consent and stay answerable.
const answerable: string[] = [];
for (const permission of unique) {
if (
typeof permission === 'string' &&
isKvSharePermission(permission)
)
result[permission] = false;
else answerable.push(permission);
}
// `fs:` reaches down a tree, and only ACL walks that. An app asking
// about itself gets the same answer, so a grant on a parent folder
// doesn't read as missing and prompt again.
const viaAcl = new Set(
app_uid ? unique.filter((p) => aclAnswerableFsPermission(p)) : [],
app_uid || isAppActor(actor)
? answerable.filter((p) => aclAnswerableFsPermission(p))
: [],
);
const viaScan = unique.filter((p) => !viaAcl.has(p));
const viaScan = answerable.filter((p) => !viaAcl.has(p));
let granted: Map<string, boolean>;
try {
@@ -6,7 +6,6 @@ import {
setupPuterTestEnv,
type PuterTestEnv,
} from '../../testUtil.js';
import type { IConfig } from '../../types.js';
import { installSeatStub } from '../../testFixtures/seatStub.js';
describe('account change second-factor verification', () => {
@@ -15,7 +14,7 @@ describe('account change second-factor verification', () => {
const links = new Map<string, string>();
beforeAll(async () => {
env = await setupPuterTestEnv({ teams_enabled: true } as IConfig);
env = await setupPuterTestEnv();
vi.spyOn(env.server.clients.email, 'send').mockImplementation(
async (to, template, values) => {
if (template === 'email_verification_link')
@@ -154,8 +154,9 @@ export class EventsController extends PuterController {
// -- Cross-user key-value handles --------------------------------
/**
* POST /events/kv-handles — hand another user a watchable region of this
* account's key-value data.
* POST /events/kv-handles — hand another user a region of this account's
* key-value data, `watch` unless the body asks for more. The older name for
* `POST /kv/shares`, keeping its own body and response shapes.
*
* An account session, or an app session holding a `manage:` delegation on
* the region — the service tells those apart and gates each rather than the
@@ -167,12 +168,32 @@ export class EventsController extends PuterController {
subdomain: 'api',
requireAuth: true,
allowAccessToken: true,
requireVerified: true,
})
async mintKvHandle(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
res.json(
await this.services.events.mintKvHandle(actor, bodyRecord(req)),
const body = bodyRecord(req);
const share = await this.services.kvShare.mintKvHandle(
actor,
{
prefix: body.prefix,
recipient: {
username:
typeof body.granteeUsername === 'string'
? body.granteeUsername
: undefined,
uid:
typeof body.granteeUid === 'string'
? body.granteeUid
: undefined,
},
access: body.access,
appUid: body.appUid,
},
// Callers of this route mint again to get the same handle back.
{ defaultAccess: 'watch', keepLevelUnlessNamed: true },
);
res.json({ handle: share.handle, prefix: share.prefix });
}
/**
@@ -189,7 +210,7 @@ export class EventsController extends PuterController {
const actor = this.#requireActor(req);
const query = (req.query ?? {}) as Record<string, unknown>;
const page = await this.services.events.listKvHandles(actor, {
const page = await this.services.kvShare.listKvHandles(actor, {
limit: normalizeLimit(query.limit, {
cap: KV_HANDLE_LIST_LIMIT_CAP,
}),
@@ -198,7 +219,10 @@ export class EventsController extends PuterController {
});
res.json({
items: page.items,
items: page.items.map(({ holderUsername, ...row }) => ({
...row,
granteeUsername: holderUsername,
})),
...(page.cursor ? { cursor: page.cursor } : {}),
...(page.total !== undefined ? { total: page.total } : {}),
});
@@ -217,7 +241,10 @@ export class EventsController extends PuterController {
async revokeKvHandle(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
res.json(
await this.services.events.revokeKvHandle(actor, req.params.handle),
await this.services.kvShare.revokeKvHandle(
actor,
req.params.handle,
),
);
}
+10
View File
@@ -163,6 +163,16 @@ export const EVENTS_ACK_LIMIT = userWindow('events:ack', 600);
*/
export const EVENTS_KV_HANDLE_LIMIT = userWindow('events:kvHandles', 60);
/**
* `kv.share.received` notices per hour, per owner and holder. A share past it
* is still made, without a notice.
*/
export const KV_SHARE_NOTICE_LIMIT = userWindow(
'kvShare:notices',
5,
60 * 60_000,
);
/**
* Live share handles one account may hold out at a time, across every app.
*
+2
View File
@@ -27,6 +27,7 @@ import { EventsController } from './events/EventsController.js';
import { FSController } from './fs/FSController.js';
import { HomepageController } from './homepage/HomepageController.js';
import { HostingController } from './hosting/HostingController.js';
import { KvShareController } from './kvShare/KvShareController.js';
import { LegacyFSController } from './fs/LegacyFSController.js';
import { NotificationController } from './notification/NotificationController.js';
import { OIDCController } from './oidc/OIDCController.js';
@@ -58,6 +59,7 @@ export const puterControllers = {
broadcast: BroadcastController,
notification: NotificationController,
events: EventsController,
kvShare: KvShareController,
share: ShareController,
webdav: WebDAVController,
oidc: OIDCController,
@@ -0,0 +1,478 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { v4 as uuidv4 } from 'uuid';
import {
afterAll,
beforeAll,
beforeEach,
describe,
expect,
it,
vi,
} from 'vitest';
import {
createTestUser,
setupPuterTestEnv,
type PuterTestEnv,
type TestUserCredentials,
} from '../../testUtil.js';
import type { IConfig } from '../../types.js';
import { EVENTS_KV_HANDLE_LIMIT } from '../events/limits.js';
const BOOT_TIMEOUT_MS = 120_000;
const call = (
env: PuterTestEnv,
method: string,
path: string,
token?: string,
body?: unknown,
) =>
fetch(new URL(path, env.apiOrigin), {
method,
headers: {
'content-type': 'application/json',
...(token ? { authorization: `Bearer ${token}` } : {}),
},
...(body === undefined ? {} : { body: JSON.stringify(body) }),
});
const resetBudgets = async (env: PuterTestEnv) => {
for (const name of [env.users.user.username, env.users.other.username]) {
const user = await env.server.stores.user.getByUsername(name);
await env.server.clients.redis.del(
`rate:${EVENTS_KV_HANDLE_LIMIT.scope}:${user!.id}`,
);
}
};
describe('/kv/shares', () => {
let env: PuterTestEnv;
let ownerUuid: string;
const req = (
method: string,
path: string,
token?: string,
body?: unknown,
) => call(env, method, path, token, body);
beforeAll(async () => {
env = await setupPuterTestEnv({
events: { enabled: true, kvHandles: true },
kv: { shareHandles: true },
unlimitedMetering: true,
} as IConfig);
const owner = await env.server.stores.user.getByUsername(
env.users.user.username,
);
ownerUuid = owner!.uuid as string;
}, BOOT_TIMEOUT_MS);
afterAll(async () => {
await env?.shutdown();
});
beforeEach(async () => {
await resetBudgets(env);
});
const shareWithOther = async (body: Record<string, unknown> = {}) => {
const res = await req('POST', '/kv/shares', env.users.user.token, {
prefix: `http-${uuidv4().slice(0, 8)}:`,
recipient: env.users.other.username,
...body,
});
expect(res.status).toBe(200);
return (await res.json()) as Record<string, unknown>;
};
it('shares at read by default and answers in the owner`s shape', async () => {
const shared = await shareWithOther({ label: 'Groceries' });
expect(Object.keys(shared).sort()).toEqual(
[
'access',
'appUid',
'createdAt',
'handle',
'holder',
'label',
'prefix',
].sort(),
);
expect(shared).toMatchObject({
access: 'read',
appUid: null,
holder: env.users.other.username,
label: 'Groceries',
});
});
it('takes the recipient as an object too, and refuses an address', async () => {
await shareWithOther({
recipient: { username: env.users.other.username },
access: 'write',
});
const refused = await req('POST', '/kv/shares', env.users.user.token, {
prefix: 'address:',
recipient: '[email protected]',
});
expect(refused.status).toBe(400);
await expect(refused.json()).resolves.toMatchObject({
code: 'invalid_recipient',
});
});
it('lists what was shared out, and what was shared with the holder without the owner', async () => {
const shared = await shareWithOther({ access: 'write', label: 'Trip' });
const byMe = await req(
'GET',
'/kv/shares?limit=200',
env.users.user.token,
);
const byMePage = (await byMe.json()) as {
items: Array<Record<string, unknown>>;
};
expect(
byMePage.items.find((row) => row.handle === shared.handle),
).toEqual({
handle: shared.handle,
prefix: shared.prefix,
access: 'write',
appUid: null,
holder: env.users.other.username,
label: 'Trip',
createdAt: shared.createdAt,
revokedAt: null,
revokedBy: null,
});
const withMe = await req(
'GET',
'/kv/shares/with-me?limit=200',
env.users.other.token,
);
const withMeText = await withMe.text();
const withMePage = JSON.parse(withMeText) as {
items: Array<Record<string, unknown>>;
};
expect(
withMePage.items.find((row) => row.handle === shared.handle),
).toEqual({
handle: shared.handle,
access: 'write',
appUid: null,
label: 'Trip',
createdAt: shared.createdAt,
});
expect(withMeText).not.toContain(env.users.user.username);
expect(withMeText).not.toContain(ownerUuid);
expect(withMeText).not.toContain(String(shared.prefix));
});
it('lets the holder unshare, and shows the owner they did', async () => {
const shared = await shareWithOther();
const removed = await req(
'DELETE',
`/kv/shares/${shared.handle}`,
env.users.other.token,
);
expect(removed.status).toBe(200);
await expect(removed.json()).resolves.toMatchObject({
handle: shared.handle,
});
const byMe = (await (
await req('GET', '/kv/shares?limit=200', env.users.user.token)
).json()) as { items: Array<Record<string, unknown>> };
expect(
byMe.items.find((row) => row.handle === shared.handle),
).toMatchObject({ revokedBy: 'holder' });
});
it('keeps the owner and prefix out of the holder`s grant audit after they unshare', async () => {
const shared = await shareWithOther({ access: 'write' });
const segment = String(shared.prefix).slice(0, -1);
const other = await env.server.stores.user.getByUsername(
env.users.other.username,
);
// A row an earlier build filed under the holder.
await env.server.stores.permission.auditUserUserPerm({
holder_user_id: other!.id,
issuer_user_id: other!.id,
permission: `kv-share-write:${ownerUuid}:os-global:${segment}`,
action: 'revoke',
reason: 'kv share handle unshared',
});
const removed = await req(
'DELETE',
`/kv/shares/${shared.handle}`,
env.users.other.token,
);
expect(removed.status).toBe(200);
// The revoke is filed under the owner, who granted it.
const auditOf = async (token: string) => {
const res = await req('GET', '/share/audit?limit=200', token);
expect(res.status).toBe(200);
return await res.text();
};
await vi.waitFor(async () => {
const owners = JSON.parse(await auditOf(env.users.user.token)) as {
items: Array<Record<string, unknown>>;
};
expect(owners.items).toContainEqual(
expect.objectContaining({
action: 'revoke',
issuer: env.users.user.username,
holder: env.users.other.username,
permission: expect.stringContaining(segment),
}),
);
});
const holders = await auditOf(env.users.other.token);
expect(holders).not.toContain(ownerUuid);
expect(holders).not.toContain(segment);
});
it('lets the owner revoke', async () => {
const shared = await shareWithOther();
const removed = await req(
'DELETE',
`/kv/shares/${shared.handle}`,
env.users.user.token,
);
expect(removed.status).toBe(200);
});
it('answers anyone else, and an unknown handle, with the same 404', async () => {
const shared = await shareWithOther();
const stranger = await createTestUser(env.server, {
username: `kvs-${uuidv4().slice(0, 8)}`,
password: 'pw-test-1234',
});
const strangers = await req(
'DELETE',
`/kv/shares/${shared.handle}`,
stranger.token,
);
const unknownHandle = `kvh-${uuidv4()}`;
const unknown = await req(
'DELETE',
`/kv/shares/${unknownHandle}`,
env.users.user.token,
);
expect(strangers.status).toBe(404);
expect(unknown.status).toBe(404);
const a = (await strangers.json()) as Record<string, unknown>;
const b = (await unknown.json()) as Record<string, unknown>;
expect(a.code).toBe(b.code);
expect(a.message).toBe(`No such handle: ${shared.handle}`);
expect(b.message).toBe(`No such handle: ${unknownHandle}`);
});
it('turns an anonymous caller away', async () => {
const res = await req('GET', '/kv/shares');
expect(res.status).toBeGreaterThanOrEqual(400);
});
});
describe('/events/kv-handles beside /kv/shares', () => {
let env: PuterTestEnv;
beforeAll(async () => {
env = await setupPuterTestEnv({
events: { enabled: true, kvHandles: true },
kv: { shareHandles: true },
unlimitedMetering: true,
} as IConfig);
}, BOOT_TIMEOUT_MS);
afterAll(async () => {
await env?.shutdown();
});
it('keeps its own request and response shapes, at watch by default', async () => {
const minted = await call(
env,
'POST',
'/events/kv-handles',
env.users.user.token,
{
granteeUsername: env.users.other.username,
prefix: 'alias-shape:',
},
);
expect(minted.status).toBe(200);
const body = (await minted.json()) as Record<string, unknown>;
expect(body).toEqual({ handle: body.handle, prefix: 'alias-shape:' });
const listed = (await (
await call(
env,
'GET',
'/events/kv-handles?limit=200',
env.users.user.token,
)
).json()) as { items: Array<Record<string, unknown>> };
const row = listed.items.find((one) => one.handle === body.handle);
expect(row).toMatchObject({
prefix: 'alias-shape:',
appUid: 'os-global',
granteeUsername: env.users.other.username,
access: 'watch',
revokedBy: null,
});
expect(row).not.toHaveProperty('holder');
// The alias revoke stays the owner's: the holder is told it is absent.
const byHolder = await call(
env,
'DELETE',
`/events/kv-handles/${body.handle}`,
env.users.other.token,
);
expect(byHolder.status).toBe(404);
});
it('hands back a share it finds at the level it has, unless the body names one', async () => {
const shared = (await (
await call(env, 'POST', '/kv/shares', env.users.user.token, {
prefix: 'alias-keep:',
recipient: env.users.other.username,
access: 'write',
})
).json()) as Record<string, unknown>;
const accessOf = async () => {
const listed = (await (
await call(
env,
'GET',
'/kv/shares?limit=200',
env.users.user.token,
)
).json()) as { items: Array<Record<string, unknown>> };
return listed.items.find((one) => one.handle === shared.handle)
?.access;
};
const mintAlias = (extra: Record<string, unknown> = {}) =>
call(env, 'POST', '/events/kv-handles', env.users.user.token, {
granteeUsername: env.users.other.username,
prefix: 'alias-keep:',
...extra,
});
const again = await mintAlias();
expect(again.status).toBe(200);
await expect(again.json()).resolves.toEqual({
handle: shared.handle,
prefix: 'alias-keep:',
});
expect(await accessOf()).toBe('write');
expect((await mintAlias({ access: 'read' })).status).toBe(200);
expect(await accessOf()).toBe('read');
});
});
/**
* Sharing asks for a confirmed email and nothing else. Booted with an SMS
* provider configured, so a phone requirement would bite here if one were ever
* added to these routes.
*/
describe('verification on the mint routes', () => {
let env: PuterTestEnv;
beforeAll(async () => {
env = await setupPuterTestEnv({
events: { enabled: true, kvHandles: true },
kv: { shareHandles: true },
unlimitedMetering: true,
strict_email_verification_required: true,
prelude: { apiKey: 'test-key' },
} as IConfig);
}, BOOT_TIMEOUT_MS);
afterAll(async () => {
await env?.shutdown();
});
const makeUser = async (
patch: Record<string, unknown> = {},
): Promise<TestUserCredentials> => {
const username = `kvv${uuidv4().slice(0, 8)}`;
const creds = await createTestUser(env.server, {
username,
password: 'pw-test-1234',
});
if (Object.keys(patch).length > 0) {
const row = await env.server.stores.user.getByUsername(username);
await env.server.stores.user.update(row!.id, patch);
}
return creds;
};
const mintBoth = (owner: TestUserCredentials, prefix: string) =>
Promise.all([
call(env, 'POST', '/kv/shares', owner.token, {
prefix: `${prefix}a:`,
recipient: env.users.other.username,
}),
call(env, 'POST', '/events/kv-handles', owner.token, {
prefix: `${prefix}b:`,
granteeUsername: env.users.other.username,
}),
]);
it('refuses an account whose email is not confirmed, on both routes', async () => {
const owner = await makeUser();
for (const res of await mintBoth(owner, 'unconfirmed')) {
expect(res.status).toBe(403);
await expect(res.json()).resolves.toMatchObject({
code: 'account_is_not_verified',
});
}
});
it('lets a confirmed account share with no phone and no card', async () => {
const owner = await makeUser({
email: `kvv-${uuidv4().slice(0, 8)}@example.invalid`,
email_confirmed: 1,
});
for (const res of await mintBoth(owner, 'confirmed'))
expect(res.status).toBe(200);
});
it('never gates listing or unsharing', async () => {
const owner = await makeUser();
for (const path of ['/kv/shares', '/kv/shares/with-me'])
expect((await call(env, 'GET', path, owner.token)).status).toBe(
200,
);
const removed = await call(
env,
'DELETE',
`/kv/shares/kvh-${uuidv4()}`,
owner.token,
);
expect(removed.status).toBe(404);
});
});
@@ -0,0 +1,172 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import type { Request, Response } from 'express';
import type { Actor } from '../../core/actor.js';
import { Controller, Delete, Get, Post } from '../../core/http/decorators.js';
import { HttpError } from '../../core/http/HttpError.js';
import { bodyRecord } from '../../core/http/requestBody.js';
import { parseKvShareRecipient } from '../../services/kvShare/kvShares.js';
import type { KvShareHandleListOptions } from '../../stores/events/KvShareHandleStore.js';
import { KV_HANDLE_LIST_LIMIT_CAP } from '../../stores/events/KvShareHandleStore.js';
import { KV_GLOBAL_APP_KEY } from '../../stores/systemKv/SystemKVStore.js';
import { normalizeLimit } from '../../util/pagination.js';
import { EVENTS_LIST_LIMIT } from '../events/limits.js';
import { PuterController } from '../types.js';
/** The app-less namespace is no app, so the wire says `null` for it. */
const publicAppUid = (appUid: string): string | null =>
appUid === KV_GLOBAL_APP_KEY ? null : appUid;
const pageOptions = (req: Request): KvShareHandleListOptions => {
const query = (req.query ?? {}) as Record<string, unknown>;
return {
limit: normalizeLimit(query.limit, { cap: KV_HANDLE_LIST_LIMIT_CAP }),
cursor: typeof query.cursor === 'string' ? query.cursor : undefined,
includeTotal: query.includeTotal === 'true',
};
};
/**
* Sharing a region of one account's key-value data with another account.
*
* Gated like the events surface: `subdomain: 'api'` plus `allowAccessToken`,
* with app-ness decided from `effectiveApp` in the service, which is where the
* owner, holder, delegation and namespace rules live. Only sharing asks for a
* confirmed email; listing, revoking and unsharing only narrow or report.
*/
@Controller('/kv')
export class KvShareController extends PuterController {
/**
* POST /kv/shares — share a region with another account, `read` unless the
* body asks otherwise. Sharing the same region with the same account again
* changes its level or label in place.
*/
@Post('/shares', {
subdomain: 'api',
requireAuth: true,
allowAccessToken: true,
requireVerified: true,
})
async share(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
const body = bodyRecord(req);
const share = await this.services.kvShare.mintKvHandle(
actor,
{
prefix: body.prefix,
recipient: parseKvShareRecipient(body.recipient),
access: body.access,
appUid: body.appUid,
label: body.label,
},
{ defaultAccess: 'read' },
);
res.json({
handle: share.handle,
prefix: share.prefix,
access: share.access,
appUid: publicAppUid(share.appUid),
holder: share.holderUsername,
label: share.label,
createdAt: share.createdAt,
});
}
/** GET /kv/shares — what this account has shared out, retired included. */
@Get('/shares', {
subdomain: 'api',
requireAuth: true,
allowAccessToken: true,
rateLimit: EVENTS_LIST_LIMIT,
})
async listSharedByMe(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
const page = await this.services.kvShare.listKvHandles(
actor,
pageOptions(req),
);
res.json({
items: page.items.map((row) => ({
handle: row.handle,
prefix: row.prefix,
access: row.access,
appUid: publicAppUid(row.appUid),
holder: row.holderUsername,
label: row.label,
createdAt: row.createdAt,
revokedAt: row.revokedAt,
revokedBy: row.revokedBy,
})),
...(page.cursor ? { cursor: page.cursor } : {}),
...(page.total !== undefined ? { total: page.total } : {}),
});
}
/** GET /kv/shares/with-me — live shares this account holds. */
@Get('/shares/with-me', {
subdomain: 'api',
requireAuth: true,
allowAccessToken: true,
rateLimit: EVENTS_LIST_LIMIT,
})
async listSharedWithMe(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
const page = await this.services.kvShare.listKvSharesWithMe(
actor,
pageOptions(req),
);
res.json({
items: page.items.map((row) => ({
handle: row.handle,
access: row.access,
appUid: publicAppUid(row.appUid),
label: row.label,
createdAt: row.createdAt,
})),
...(page.cursor ? { cursor: page.cursor } : {}),
...(page.total !== undefined ? { total: page.total } : {}),
});
}
/**
* DELETE /kv/shares/:handle — the owner revokes, the holder gives it up,
* and anyone else is told it is not there.
*/
@Delete('/shares/:handle', {
subdomain: 'api',
requireAuth: true,
allowAccessToken: true,
})
async unshare(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
res.json(
await this.services.kvShare.removeKvShare(actor, req.params.handle),
);
}
#requireActor(req: Request): Actor {
const actor = req.actor;
if (!actor?.user)
throw new HttpError(401, 'Unauthorized', {
legacyCode: 'unauthorized',
});
return actor;
}
}
+26
View File
@@ -23,6 +23,7 @@ import {
makeActor,
SYSTEM_ACTOR,
userRelatedActor,
viaWorkerOf,
type Actor,
} from './actor';
@@ -111,3 +112,28 @@ describe('assertResolvedActor', () => {
);
});
});
describe('viaWorkerOf', () => {
const user = { uuid: 'u-1', id: 1 };
it('reads a worker session or an events handler as server-side', () => {
expect(
viaWorkerOf(
makeActor({ user, session: { uid: 's-1', kind: 'worker' } }),
),
).toBe(true);
expect(viaWorkerOf(makeActor({ user, handlerDepth: 1 }))).toBe(true);
});
it('reads a browser session, an app or no actor at all as not', () => {
expect(
viaWorkerOf(
makeActor({ user, session: { uid: 's-1', kind: 'web' } }),
),
).toBe(false);
expect(viaWorkerOf(makeActor({ user, app: { uid: 'app-1' } }))).toBe(
false,
);
expect(viaWorkerOf(undefined)).toBe(false);
});
});
+7
View File
@@ -239,3 +239,10 @@ export const userRelatedActor = (actor: Actor): Actor => {
/** How many events handler runs led to a write by this actor. */
export const handlerDepthOf = (actor: Actor | undefined | null): number =>
actor?.handlerDepth ?? 0;
/**
* Whether a write by this actor was made by server-side code running as the
* account: a worker session, or an events handler.
*/
export const viaWorkerOf = (actor: Actor | undefined | null): boolean =>
actor?.session?.kind === 'worker' || handlerDepthOf(actor) > 0;
+7
View File
@@ -67,6 +67,12 @@ export interface KnownContextFields {
* receive stops early and is never metered.
*/
abortSignal: AbortSignal;
/**
* Aborts the chat driver's upstream request. A client disconnect doesn't
* fire it: the upstream bills a request it has accepted either way, so the
* driver lets it finish and meters what it reports.
*/
upstreamSignal: AbortSignal;
/**
* When true, `ChatCompletionDriver.complete` treats a request-level
* upstream 4xx as final instead of falling back to another provider — set
@@ -84,6 +90,7 @@ const KNOWN_KEY_FLAGS: Record<keyof KnownContextFields, true> = {
requestId: true,
driverName: true,
abortSignal: true,
upstreamSignal: true,
strictUpstreamErrors: true,
};
const KNOWN_KEYS: ReadonlySet<string> = new Set(Object.keys(KNOWN_KEY_FLAGS));
@@ -128,6 +128,18 @@ describe('createWwwRedirect', () => {
expect(next).toHaveBeenCalledTimes(1);
});
it('leaves www. alone on a host outside our domains', () => {
const req = makeReq({
subdomains: ['com', 'example', 'www'],
host: 'www.example.com',
});
(req as Request & { is_custom_domain?: boolean }).is_custom_domain =
true;
const { out, next } = run(createWwwRedirect(config), req);
expect(out.redirectArgs).toBeUndefined();
expect(next).toHaveBeenCalledTimes(1);
});
it("passes through when config.domain isn't configured (no target to redirect to)", () => {
const { out, next } = run(
createWwwRedirect({} as IConfig),
@@ -879,6 +891,18 @@ describe('createNativeAppStatic', () => {
const withRoot = () =>
createNativeAppStatic({ native_apps_root: root } as unknown as IConfig);
it('leaves a native app name alone on a host outside our domains', async () => {
const req = staticReq({
subdomains: ['com', 'example', 'editor'],
path: '/index.html',
});
(req as Request & { is_custom_domain?: boolean }).is_custom_domain =
true;
const { out, next } = await runStatic(withRoot(), req);
expect(out.sent).toBeUndefined();
expect(next).toHaveBeenCalledTimes(1);
});
it('is a no-op when native_apps_root is unset', async () => {
const { out, next } = await runStatic(
createNativeAppStatic(config),
@@ -207,6 +207,8 @@ const dispatchClaimed = async (
export const createWwwRedirect = (config: IConfig): RequestHandler => {
const domain = (config.domain ?? '').toLowerCase();
return (req, res, next) => {
// `www.` on a host outside our domains belongs to that host's site.
if (req.is_custom_domain) return next();
const active = req.subdomains?.[req.subdomains.length - 1] ?? '';
if (active !== 'www') return next();
if (!domain) return next();
@@ -305,6 +307,7 @@ export const createNativeAppStatic = (config: IConfig): RequestHandler => {
return (_req, _res, next) => next();
}
return async (req, res, next) => {
if (req.is_custom_domain) return next();
const active = (
req.subdomains?.[req.subdomains.length - 1] ?? ''
).toLowerCase();
@@ -950,7 +950,8 @@ describe('resolvePrivateIdentity', () => {
expect(out.userUid).toBeUndefined();
});
it('accepts an app-issued access token minted for the target app', async () => {
it('ignores an app-issued access token even for the target app', async () => {
// A scoped token (e.g. a read URL) is not the account, whoever issued it.
const user = await makeUser();
const targetUid = `app-target-${uuidv4()}`;
const issuer = makeActor({
@@ -970,11 +971,11 @@ describe('resolvePrivateIdentity', () => {
sessionCookieName: 'puter_auth_token',
expectedAppUid: targetUid,
});
expect(out.source).toBe('session-cookie');
expect(out.userUid).toBe(user.uuid);
expect(out.source).toBe('none');
expect(out.userUid).toBeUndefined();
});
it('still accepts a user-issued access token, which is portable', async () => {
it('ignores a user-issued scoped access token', async () => {
const user = await makeUser();
const issuer = makeActor({ user: { uuid: user.uuid } });
const out = await resolvePrivateIdentity({
@@ -983,7 +984,46 @@ describe('resolvePrivateIdentity', () => {
actor: makeActor({
user: { uuid: user.uuid },
accessToken: { uid: `tok-${uuidv4()}`, issuer },
session: { uid: 'sess-1' },
}),
}),
authService,
sessionCookieName: 'puter_auth_token',
expectedAppUid: `app-target-${uuidv4()}`,
});
expect(out.source).toBe('none');
expect(out.userUid).toBeUndefined();
});
it('ignores a scoped access token when the host has no app', async () => {
const user = await makeUser();
const issuer = makeActor({ user: { uuid: user.uuid } });
const out = await resolvePrivateIdentity({
req: reqOf({
cookies: {},
actor: makeActor({
user: { uuid: user.uuid },
accessToken: { uid: `tok-${uuidv4()}`, issuer },
}),
}),
authService,
sessionCookieName: 'puter_auth_token',
});
expect(out.source).toBe('none');
});
it('accepts a full-access token, which holds the account', async () => {
const user = await makeUser();
const issuer = makeActor({ user: { uuid: user.uuid } });
const out = await resolvePrivateIdentity({
req: reqOf({
cookies: {},
actor: makeActor({
user: { uuid: user.uuid },
accessToken: {
uid: `tok-${uuidv4()}`,
issuer,
fullAccess: true,
},
}),
}),
authService,
@@ -25,7 +25,7 @@ import {
} from '../../../services/auth/AuthService';
import type { AppStore } from '../../../stores/app/AppStore.js';
import type { IConfig } from '../../../types';
import type { Actor } from '../../actor';
import { isAccessTokenActor, isAccountContext, type Actor } from '../../actor';
/**
* Support helpers for the private-app access gate — ported from v1's
@@ -196,10 +196,12 @@ export async function resolveOwnedAppForHostedSite(opts: {
appStore: Pick<AppStore, 'listOwnedByIndexUrlCandidates'>;
config: PrivateHostingConfig;
requirePrivate?: boolean;
/** Match against this hosting-domain host instead of the request's. */
host?: string;
}): Promise<AppLike | null> {
if (!opts.site?.user_id) return null;
const host = normalizeHost(opts.req.hostname);
const host = normalizeHost(opts.host ?? opts.req.hostname);
if (!host) return null;
const hostedSubdomain = subdomainFromHost(host, [
@@ -215,7 +217,7 @@ export async function resolveOwnedAppForHostedSite(opts: {
const hostCandidates = new Set<string>();
hostCandidates.add(host);
const headerHost =
typeof opts.req.headers?.host === 'string'
!opts.host && typeof opts.req.headers?.host === 'string'
? opts.req.headers.host.trim().toLowerCase()
: '';
if (headerHost) hostCandidates.add(headerHost);
@@ -458,11 +460,15 @@ export async function resolvePrivateIdentity(opts: {
* "No app anywhere in the chain" is the portable case, so read `effectiveApp` —
* an app-issued access token has no `app` of its own and would otherwise pass
* as a plain session on any private host.
*
* A scoped access token (a read URL, whoever issued it) is never the account
* here: the hosted cookie minted from it would outlive the token's revocation.
*/
function actorMatchesExpectedApp(
actor: Actor,
expectedAppUid: string | undefined,
): boolean {
if (isAccessTokenActor(actor) && !isAccountContext(actor)) return false;
if (!expectedAppUid) return true;
const app = actor.effectiveApp;
if (!app) return true;
@@ -1030,6 +1030,133 @@ describe('createPuterSiteMiddleware — site.access.check', () => {
});
});
describe('createPuterSiteMiddleware — hosts outside the configured domains', () => {
const claims = new Map<string, string>();
const resolveHost = (
_key: string,
data: { host: string; result: { subdomain: string | null } },
) => {
const sub = claims.get(data.host);
if (sub) data.result.subdomain = sub;
};
beforeAll(() => {
server.clients.event.on('site.resolveHost', resolveHost as never);
});
afterAll(() => {
server.clients.event.off('site.resolveHost', resolveHost as never);
});
const customReq = (hostname: string, path = '/index.html') => {
const req = makeReq({ hostname, path });
(req as Request & { is_custom_domain?: boolean }).is_custom_domain =
true;
return req;
};
const makeSite = async (opts: { suspended?: boolean } = {}) => {
const owner = await makeUserWithHome();
const homePath = `/${owner.username}`;
const homeEntry = await server.stores.fsEntry.getEntryByPath(homePath);
const sub = `cust-${Math.random().toString(36).slice(2, 8)}`;
await server.stores.subdomain.create({
userId: owner.id,
subdomain: sub,
rootDirId: homeEntry!.id,
});
await writeFile(
owner.id,
`${homePath}/index.html`,
Buffer.from('<html>custom</html>'),
'text/html',
);
if (opts.suspended) {
await server.stores.user.update(owner.id, { suspended: 1 });
}
const host = `${sub}.example.test`;
claims.set(host, sub);
return { owner, sub, host };
};
it('serves the claimed site on its host', async () => {
const { host } = await makeSite();
const { out, next } = await runMiddleware(
buildMiddleware(),
customReq(host),
);
await new Promise<void>((resolve) => setImmediate(resolve));
expect(next).not.toHaveBeenCalled();
expect(out.statusCode).toBe(200);
expect(String(out.body)).toBe('<html>custom</html>');
});
it('404s an unclaimed host instead of falling through to the API/GUI', async () => {
const { out, next } = await runMiddleware(
buildMiddleware(),
customReq('nobody-claims-this.example.test'),
);
expect(next).not.toHaveBeenCalled();
expect(out.statusCode).toBe(404);
expect(out.body).toBe('Site not found');
});
it('404s when a listener throws', async () => {
const host = 'throws.example.test';
const boom = (_key: string, data: { host: string }) => {
if (data.host === host) throw new Error('boom');
};
server.clients.event.on('site.resolveHost', boom as never);
try {
const { out, next } = await runMiddleware(
buildMiddleware(),
customReq(host),
);
expect(next).not.toHaveBeenCalled();
expect(out.statusCode).toBe(404);
} finally {
server.clients.event.off('site.resolveHost', boom as never);
}
});
it('404s a claimed site whose owner is suspended', async () => {
const { host } = await makeSite({ suspended: true });
const { out } = await runMiddleware(buildMiddleware(), customReq(host));
expect(out.statusCode).toBe(404);
expect(out.body).toBe('Subdomain not found');
});
it('404s a private app rather than serving it ungated', async () => {
const { owner, sub, host } = await makeSite();
await server.clients.db.write(
'INSERT INTO `apps` (`uid`, `name`, `title`, `index_url`, `owner_user_id`, `is_private`) VALUES (?, ?, ?, ?, ?, ?)',
[
`app-${uuidv4()}`,
sub,
sub,
`http://${sub}.site.puter.localhost/`,
owner.id,
1,
],
);
const { out } = await runMiddleware(buildMiddleware(), customReq(host));
expect(out.statusCode).toBe(404);
expect(out.body).toBe('Site not found');
expect(out.redirected).toBeUndefined();
expect(out.cookies).toEqual({});
});
it('passes the host through untouched when custom domains are not flagged', async () => {
const { host } = await makeSite();
const { out, next } = await runMiddleware(
buildMiddleware(),
makeReq({ hostname: host }),
);
expect(next).toHaveBeenCalledTimes(1);
expect(out.statusCode).toBeUndefined();
});
});
describe('createPuterSiteMiddleware — .puter_site_config', () => {
const setupSiteWithConfig = async (config: unknown) => {
const owner = await makeUserWithHome();
@@ -1254,12 +1381,7 @@ describe('createPuterSiteMiddleware — .puter_site_config', () => {
errors: { '404': { file: '/index.html', status: 200 } },
});
const body = Buffer.from('real-page');
await writeFile(
owner.id,
`${homePath}/page.html`,
body,
'text/html',
);
await writeFile(owner.id, `${homePath}/page.html`, body, 'text/html');
const mw = buildMiddleware();
const { res, out } = makeRes();
@@ -1373,9 +1495,9 @@ describe('createPuterSiteMiddleware — .puter_site_config', () => {
// SPA fallback still fires → cache served the deleted config.
expect(second.out.statusCode).toBe(200);
expect(
(second.out.body as Buffer | undefined)?.equals(body),
).toBe(true);
expect((second.out.body as Buffer | undefined)?.equals(body)).toBe(
true,
);
});
it('ignores `errors` entries with status codes outside 4xx/5xx', async () => {
+63 -20
View File
@@ -61,12 +61,12 @@ import {
* - Private-app gate via `app.privateAccess.check` — marketplace extension
* decides; default is denied + redirect to `app-center`
* - Range / ETag / Last-Modified passthrough via `fsEntry.readContent`
* - Hosts outside the configured domains (`custom_domains_enabled`) map to a site
* via `site.resolveHost`; unclaimed ones 404. Public sites only.
*
* Deferred (not yet implemented):
*
* - `.at` username-based sites (UUIDv5-keyed `/user/Public`).
* - Custom domains (subdomains table `domain` column) — requires host validation
* to allow arbitrary hostnames first.
*
* Site config:
*
@@ -228,29 +228,60 @@ export const createPuterSiteMiddleware = (
if (!host) return next();
const matched = matchHostingDomain(host);
if (!matched) return next();
// A host outside every configured domain. Listeners may map it to a
// site; an unclaimed one is answered here rather than falling through
// to the API/GUI routers.
const isCustomHost = !matched && Boolean(req.is_custom_domain);
if (!matched && !isCustomHost) return next();
// Bare hosting domain (e.g. `puter.site`) → redirect to the main site.
if (host === matched) {
if (domain) {
res.redirect(302, `${req.protocol}://${domain}`);
let subdomain: string;
if (isCustomHost) {
const resolveEvent = {
host,
result: { subdomain: null as string | null },
};
try {
await layers.clients.event.emitAndWait(
'site.resolveHost',
resolveEvent,
{},
);
} catch {
resolveEvent.result.subdomain = null;
}
const claimed = resolveEvent.result.subdomain;
if (typeof claimed !== 'string' || !claimed) {
res.status(404).type('text/plain').send('Site not found');
return;
}
res.status(404).type('text/plain').send('Subdomain not found');
return;
}
subdomain = claimed;
} else {
const hostingDomain = matched as string;
// Bare hosting domain (e.g. `puter.site`) → redirect to the main site.
if (host === hostingDomain) {
if (domain) {
res.redirect(302, `${req.protocol}://${domain}`);
return;
}
res.status(404).type('text/plain').send('Subdomain not found');
return;
}
// `host` is `<prefix>.<matched>`; subdomain is the left-most label.
const prefix = host.slice(0, host.length - matched.length - 1);
const subdomain = prefix.split('.')[0] || '';
// `host` is `<prefix>.<matched>`; subdomain is the left-most label.
const prefix = host.slice(
0,
host.length - hostingDomain.length - 1,
);
subdomain = prefix.split('.')[0] || '';
if (!subdomain || subdomain === 'www') {
if (domain) {
res.redirect(302, `${req.protocol}://${domain}`);
if (!subdomain || subdomain === 'www') {
if (domain) {
res.redirect(302, `${req.protocol}://${domain}`);
return;
}
res.status(404).type('text/plain').send('Subdomain not found');
return;
}
res.status(404).type('text/plain').send('Subdomain not found');
return;
}
const site = (await layers.stores.subdomain.getBySubdomain(
@@ -286,6 +317,11 @@ export const createPuterSiteMiddleware = (
site: { user_id: site.user_id },
appStore: layers.stores.app,
config: hostingCfg,
// App index URLs name the hosting-domain address, not the
// custom host the visitor used.
host: isCustomHost
? `${subdomain}.${hostingDomains[0]}`
: undefined,
}),
);
const rootLookup =
@@ -300,7 +336,14 @@ export const createPuterSiteMiddleware = (
const isPrivateApp = Boolean(associatedApp?.is_private);
const privateApp = isPrivateApp ? associatedApp : null;
if (isPrivateApp) {
if (isCustomHost) {
// The private-app gate and its cookies are bound to the private
// hosting domain, so these hosts serve public sites only.
if (isPrivateApp) {
res.status(404).type('text/plain').send('Site not found');
return;
}
} else if (isPrivateApp) {
// Private apps must run on the private hosting domain. If a
// visitor arrives via the public domain (puter.site), redirect
// them to the equivalent private-host URL so the cookie scope
@@ -448,7 +491,7 @@ export const createPuterSiteMiddleware = (
res.redirect(302, cleanPath);
return;
}
} else if (privateHostingDomains.has(matched)) {
} else if (privateHostingDomains.has(matched as string)) {
// Non-private content landed on the private hosting domain —
// mirror of the private redirect above. Covers two cases:
// - a paid app that just flipped to free (is_private 1→0)
@@ -35,7 +35,7 @@ describe('chat cancellation over HTTP', () => {
let env: PuterTestEnv;
let restoreFetch: () => void;
let actor: Actor;
let onRequest: (res: ServerResponse) => void;
let onRequest: (res: ServerResponse, body: string) => void;
beforeAll(async () => {
upstream = createServer((req, res) => {
@@ -44,8 +44,12 @@ describe('chat cancellation over HTTP', () => {
res.end(JSON.stringify({ models: [{ name: 'cancel-test' }] }));
return;
}
req.resume();
req.once('end', () => onRequest(res));
let body = '';
req.setEncoding('utf8');
req.on('data', (chunk: string) => {
body += chunk;
});
req.once('end', () => onRequest(res, body));
});
await new Promise<void>((resolve) =>
upstream.listen(0, '127.0.0.1', resolve),
@@ -143,24 +147,137 @@ describe('chat cancellation over HTTP', () => {
);
};
const usage = { prompt_tokens: 3, completion_tokens: 5, total_tokens: 8 };
const responsesUsage = {
input_tokens: 3,
output_tokens: 5,
total_tokens: 8,
input_tokens_details: { cached_tokens: 0 },
output_tokens_details: { reasoning_tokens: 0 },
};
const response = {
id: 'resp_1',
object: 'response',
status: 'completed',
output: [
{
type: 'message',
id: 'msg_1',
role: 'assistant',
status: 'completed',
content: [
{ type: 'output_text', text: 'done', annotations: [] },
],
},
],
usage: responsesUsage,
};
const sse = (events: unknown[]) =>
events.map((event) => `data: ${JSON.stringify(event)}\n\n`).join('');
/**
* A complete upstream answer, with usage, in the shape the request asked
* for.
*/
const finishAnswer = (res: ServerResponse, body: string) => {
const stream = (JSON.parse(body) as { stream?: boolean }).stream;
const responses = res.req.url === '/v1/responses';
if (!stream) {
res.setHeader('Content-Type', 'application/json');
res.end(
JSON.stringify(
responses
? response
: {
id: 'chatcmpl_1',
object: 'chat.completion',
created: 0,
model: 'cancel-test',
choices: [
{
index: 0,
message: {
role: 'assistant',
content: 'done',
},
finish_reason: 'stop',
},
],
usage,
},
),
);
return;
}
if (!res.headersSent)
res.setHeader('Content-Type', 'text/event-stream');
res.end(
responses
? sse([
{ type: 'response.output_text.delta', delta: 'done' },
{ type: 'response.completed', response },
])
: `${sse([
{
id: 'chatcmpl_1',
object: 'chat.completion.chunk',
choices: [
{
index: 0,
delta: { content: 'done' },
finish_reason: 'stop',
},
],
},
{
id: 'chatcmpl_1',
object: 'chat.completion.chunk',
choices: [],
usage,
},
])}data: [DONE]\n\n`,
);
};
/**
* Whether a usage entry the upstream reported, not an estimate, was
* recorded.
*/
const meteredReportedUsage = (spy: ReturnType<typeof vi.spyOn>) =>
spy.mock.calls
.flatMap((call) => (call[1] as { usageType: string }[]) ?? [])
.some(
(u) =>
!u.usageType.includes('estimated_') &&
/completion|output_tokens/.test(u.usageType),
);
it.each(
routes.flatMap((route) =>
[false, true].map((stream) => ({ route, stream })),
),
)(
'cancels upstream while waiting for headers: $route (stream=$stream)',
'bills an upstream the caller left while waiting for headers: $route (stream=$stream)',
async ({ route, stream }) => {
let upstreamClosed = false;
let upstreamRes!: ServerResponse;
let upstreamBody = '';
let upstreamClosedEarly = false;
let received!: () => void;
const ready = new Promise<void>((resolve) => {
received = resolve;
});
onRequest = (res) => {
onRequest = (res, body) => {
upstreamRes = res;
upstreamBody = body;
res.once('close', () => {
upstreamClosed = true;
if (!res.writableFinished) upstreamClosedEarly = true;
});
received();
};
const metered = vi.spyOn(
env.server.services.metering,
'batchIncrementUsages',
);
const abort = new AbortController();
const request = call(route, abort.signal, stream).catch(
(error: unknown) => error,
@@ -176,36 +293,50 @@ describe('chat cancellation over HTTP', () => {
);
}),
]);
abort.abort();
expect(await request).toMatchObject({ name: 'AbortError' });
await new Promise((resolve) => setTimeout(resolve, 100));
expect(upstreamClosedEarly).toBe(false);
expect(
await env.server.services.metering.getOutstandingHolds(
actor,
),
).toBeGreaterThan(0);
abort.abort();
expect(await request).toMatchObject({ name: 'AbortError' });
await expect.poll(() => upstreamClosed).toBe(true);
finishAnswer(upstreamRes, upstreamBody);
await expect
.poll(() =>
env.server.services.metering.getOutstandingHolds(actor),
)
.toBe(0);
expect(upstreamClosedEarly).toBe(false);
expect(meteredReportedUsage(metered)).toBe(true);
} finally {
abort.abort();
metered.mockRestore();
upstream.closeAllConnections();
}
},
);
it.each(routes)(
'cancels an idle upstream after partial output: %s',
'bills an upstream the caller left after partial output: %s',
async (route) => {
let upstreamClosed = false;
onRequest = (res) => {
let upstreamRes!: ServerResponse;
let upstreamBody = '';
let upstreamClosedEarly = false;
onRequest = (res, body) => {
upstreamRes = res;
upstreamBody = body;
res.once('close', () => {
upstreamClosed = true;
if (!res.writableFinished) upstreamClosedEarly = true;
});
writeText(res);
};
const metered = vi.spyOn(
env.server.services.metering,
'batchIncrementUsages',
);
const abort = new AbortController();
try {
const response = await call(route, abort.signal);
@@ -219,14 +350,20 @@ describe('chat cancellation over HTTP', () => {
text += new TextDecoder().decode(chunk.value);
}
abort.abort();
await expect.poll(() => upstreamClosed).toBe(true);
await new Promise((resolve) => setTimeout(resolve, 100));
expect(upstreamClosedEarly).toBe(false);
finishAnswer(upstreamRes, upstreamBody);
await expect
.poll(() =>
env.server.services.metering.getOutstandingHolds(actor),
)
.toBe(0);
expect(upstreamClosedEarly).toBe(false);
expect(meteredReportedUsage(metered)).toBe(true);
} finally {
abort.abort();
metered.mockRestore();
upstream.closeAllConnections();
}
},
@@ -47,7 +47,8 @@ import { ChatCompletionDriver } from './ChatCompletionDriver.js';
import { clearUnhealthyRoutes, isRouteUnhealthy } from './utils/providerHealth.js';
import { FakeChatProvider } from './providers/FakeChatProvider.js';
import type { IChatCompleteResult } from './types.js';
import { type AIChatStream, ChatStreamAbortedError } from './utils/Streaming.js';
import { SDK_TIMEOUT_MS } from './utils/sdkClient.js';
import type { AIChatStream } from './utils/Streaming.js';
let server: PuterServer;
@@ -905,7 +906,7 @@ describe('ChatCompletionDriver when the caller hangs up', () => {
).toBe(true);
});
it('stops the generation and gives the hold back', async () => {
it('keeps generating after the hang-up and bills the reported usage', async () => {
const actor = freeUser() as never;
const metering = server.services.metering;
const abort = new AbortController();
@@ -914,6 +915,7 @@ describe('ChatCompletionDriver when the caller hangs up', () => {
resume = r;
});
let providerError: unknown;
let finished = false;
vi.spyOn(FakeChatProvider.prototype, 'complete').mockResolvedValueOnce(
streamOf(async ({ chatStream }) => {
@@ -921,8 +923,13 @@ describe('ChatCompletionDriver when the caller hangs up', () => {
block.addText('first');
await paused;
try {
// An upstream still generating: keeps writing until told.
for (let i = 0; i < 1000; i++) block.addText('more');
// An upstream still generating after the caller left.
for (let i = 0; i < 1000; i++) {
await chatStream.waitForDrain();
block.addText('more');
}
chatStream.end({ input_tokens: 3, output_tokens: 1001 });
finished = true;
} catch (e) {
providerError = e;
throw e;
@@ -930,6 +937,7 @@ describe('ChatCompletionDriver when the caller hangs up', () => {
}) as never,
);
const metered = vi.spyOn(metering, 'batchIncrementUsages');
const events = vi.spyOn(server.clients.event, 'emit');
const { stream } = (await withTestActor(() => {
Context.set('abortSignal', abort.signal);
@@ -950,15 +958,120 @@ describe('ChatCompletionDriver when the caller hangs up', () => {
}
await new Promise((r) => setTimeout(r, 20));
expect(providerError).toBeInstanceOf(ChatStreamAbortedError);
// Nobody is listening, so no error line is written for the abort.
expect(body).not.toContain('"type":"error"');
// The hold goes back once the usage write lands.
expect(providerError).toBeUndefined();
expect(finished).toBe(true);
// Nothing reaches a caller who has gone, including the usage line.
expect(body).not.toContain('more');
expect(body).not.toContain('"type":"usage"');
await vi.waitFor(async () =>
expect(await metering.getOutstandingHolds(actor)).toBe(0),
);
expect(
meteredUsages(metered).some((u) =>
u.usageType.includes('estimated_'),
),
).toBe(false);
expect(
events.mock.calls.some(
([key, data]) =>
key === 'ai.prompt.cost-calculated' &&
(data as { usage?: { output_tokens?: number } }).usage
?.output_tokens === 1001,
),
).toBe(true);
});
it('bills a stream whose caller left before the first token', async () => {
const actor = freeUser() as never;
const abort = new AbortController();
vi.spyOn(FakeChatProvider.prototype, 'complete').mockImplementationOnce(
async () => {
// The caller hangs up while the upstream is still answering.
abort.abort();
return streamOf(async ({ chatStream }) => {
chatStream
.message()
.contentBlock({ type: 'text' })
.addText('answer');
chatStream.end({ input_tokens: 3, output_tokens: 2 });
});
},
);
const events = vi.spyOn(server.clients.event, 'emit');
const { stream } = (await withTestActor(() => {
Context.set('abortSignal', abort.signal);
return driver.complete({
model: 'priced',
messages: [{ role: 'user', content: 'go' }],
stream: true,
});
}, actor)) as unknown as { stream: Readable };
await drain(stream);
expect(
events.mock.calls.some(
([key, data]) =>
key === 'ai.prompt.cost-calculated' &&
(data as { usage?: { output_tokens?: number } }).usage
?.output_tokens === 2,
),
).toBe(true);
await vi.waitFor(async () =>
expect(await server.services.metering.getOutstandingHolds(actor)).toBe(0),
);
});
it('cuts off an upstream that outlives its caller by the SDK timeout', async () => {
const actor = freeUser() as never;
const metering = server.services.metering;
const abort = new AbortController();
let upstreamAborted = false;
vi.spyOn(FakeChatProvider.prototype, 'complete').mockResolvedValueOnce(
streamOf(async ({ chatStream }) => {
chatStream
.message()
.contentBlock({ type: 'text' })
.addText('x'.repeat(400));
const signal = Context.get('upstreamSignal')!;
// A stalled upstream: no more chunks until it's cut off.
await new Promise((_resolve, reject) => {
signal.addEventListener('abort', () => {
upstreamAborted = true;
reject(signal.reason);
});
});
}) as never,
);
const metered = vi.spyOn(metering, 'batchIncrementUsages');
const timers = vi.spyOn(globalThis, 'setTimeout');
const { stream } = (await withTestActor(() => {
Context.set('abortSignal', abort.signal);
return driver.complete({
model: 'priced',
messages: [{ role: 'user', content: 'go' }],
stream: true,
});
}, actor)) as unknown as { stream: Readable };
abort.abort();
const limit = timers.mock.calls.find(
([, ms]) => ms === SDK_TIMEOUT_MS,
);
expect(limit).toBeDefined();
await new Promise((r) => setTimeout(r, 20));
expect(upstreamAborted).toBe(false);
(limit![0] as () => void)();
await drain(stream);
expect(upstreamAborted).toBe(true);
expect(
meteredUsages(metered).some((u) =>
u.usageType.endsWith('estimated_output_tokens'),
),
).toBe(true);
await vi.waitFor(async () =>
expect(await metering.getOutstandingHolds(actor)).toBe(0),
);
// What was generated before the hang-up is still charged.
expect(metered).toHaveBeenCalled();
});
});
@@ -116,6 +116,7 @@ import {
UNHEALTHY_TTL_SEC,
} from './utils/providerHealth.js';
import { CATALOG_TTL_MS } from './utils/cachedRemoteCatalog.js';
import { SDK_TIMEOUT_MS } from './utils/sdkClient.js';
import { fromFinishReason } from './utils/stopReason.js';
import { AIChatStream } from './utils/Streaming.js';
import {
@@ -680,6 +681,10 @@ export class ChatCompletionDriver extends PuterDriver {
throw new HttpError(401, 'Authentication required', {
legacyCode: 'unauthorized',
});
// The caller hanging up stops nothing that has reached an upstream: it
// would bill the request anyway, so it runs to its usage report.
const upstream = new AbortController();
Context.set('upstreamSignal', upstream.signal);
// AI charges recorded in this request before the completion started.
const priorCharges = requestAiCosts().length;
@@ -880,6 +885,8 @@ export class ChatCompletionDriver extends PuterDriver {
if (!useFakeProvider) {
await this.#resolvePuterPaths(attemptProvider, args, actor);
}
// Last point where a caller who left costs nothing.
abortSignal?.throwIfAborted();
return attemptProvider.complete(
{
...args,
@@ -1042,10 +1049,20 @@ export class ChatCompletionDriver extends PuterDriver {
const init = res.init_chat_stream;
const cleanup = res.finally_fn;
// Providers also receive this signal to cancel while waiting for output.
const abortStream = () => chatStream.abort();
if (abortSignal?.aborted) abortStream();
else abortSignal?.addEventListener('abort', abortStream);
// A caller who leaves stops getting output, but the upstream keeps
// going until it reports usage, with as long to finish as a
// non-streaming completion gets.
let detachedLimit: ReturnType<typeof setTimeout> | undefined;
const detachStream = () => {
chatStream.detach();
detachedLimit = setTimeout(
() => upstream.abort(),
SDK_TIMEOUT_MS,
);
detachedLimit.unref?.();
};
if (abortSignal?.aborted) detachStream();
else abortSignal?.addEventListener('abort', detachStream);
// Intercept `chatStream.end(usage)` to fire complete + cost events
// (mirrors the non-streaming branch). Clone usage so providers that
@@ -1069,9 +1086,9 @@ export class ChatCompletionDriver extends PuterDriver {
enrichedUsage.cost = charged();
}
}
// A cancelled stream isn't a completion, but whatever it
// metered still gets its cost row.
if (!chatStream.aborted) {
// A completion nobody received isn't announced, but it still
// gets its cost row.
if (!chatStream.detached) {
this.clients.event.emit(
'ai.prompt.complete',
{
@@ -1138,13 +1155,13 @@ export class ChatCompletionDriver extends PuterDriver {
(async () => {
try {
await init({ chatStream });
if (!chatStream.aborted && !passthrough.writableEnded) {
if (!passthrough.writableEnded) {
throw new Error('Stream ended before completion');
}
} catch (e) {
if (!chatStream.aborted) {
if (!chatStream.detached) {
const attempt = toAttempt(model.id, model.provider!, e);
passthrough.write(
chatStream.write(
`${JSON.stringify({
type: 'error',
message: sanitizeUpstreamMessage(
@@ -1160,7 +1177,8 @@ export class ChatCompletionDriver extends PuterDriver {
passthrough.end();
} finally {
clearInterval(renewHold);
abortSignal?.removeEventListener('abort', abortStream);
clearTimeout(detachedLimit);
abortSignal?.removeEventListener('abort', detachStream);
// Providers report usage the moment they meter it (see
// `AIChatStream.reportUsage`); a stream that never got
// there was never charged for.
@@ -25,10 +25,10 @@ import { AIChatStream } from '../utils/Streaming.js';
import { FakeChatProvider } from './FakeChatProvider.js';
describe('fake chat streaming lifecycle', () => {
it('cancels the simulated delay before writing output', async () => {
it('cancels the simulated delay when the upstream signal aborts', async () => {
await withTestActor(async () => {
const abort = new AbortController();
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
const result = await new FakeChatProvider().complete({
model: 'fake',
stream: true,
@@ -59,7 +59,7 @@ describe('fake chat streaming lifecycle', () => {
.map((line) => JSON.parse(line));
expect(events.map((event) => event.type)).toEqual(['text', 'usage']);
});
it('does not write after the chat stream was aborted independently', async () => {
it('finishes without writing after the caller detaches', async () => {
const result = await new FakeChatProvider().complete({
model: 'fake',
stream: true,
@@ -67,8 +67,9 @@ describe('fake chat streaming lifecycle', () => {
});
const stream = new PassThrough();
const chatStream = new AIChatStream({ stream });
chatStream.abort();
chatStream.detach();
await result.init_chat_stream!({ chatStream });
expect(stream.readableLength).toBe(0);
expect(stream.writableEnded).toBe(true);
});
});
@@ -101,12 +101,11 @@ export class FakeChatProvider implements IChatProvider {
chatStream: AIChatStream;
}) => {
await delay(500, undefined, {
signal: Context.get('abortSignal'),
signal: Context.get('upstreamSignal'),
});
const response = await resp;
if (chatStream.aborted) return;
await chatStream.waitForDrain();
chatStream.stream.write(
chatStream.write(
`${JSON.stringify({
type: 'text',
text: response.message.content[0].text,
@@ -175,7 +175,7 @@ export class OpenAICompatProvider implements IChatProvider {
}
}
const actor = Context.get('actor');
const signal = Context.get('abortSignal');
const signal = Context.get('upstreamSignal');
let messages = args.messages;
if (
@@ -311,7 +311,7 @@ export class AzureChatProvider implements IChatProvider {
const completion = await this.#openAi.chat.completions.create(
completionParams,
{ signal: Context.get('abortSignal') },
{ signal: Context.get('upstreamSignal') },
);
return OpenAiUtil.handle_completion_output({
@@ -326,7 +326,7 @@ export class AzureResponsesProvider implements IChatProvider {
const completion = await this.#openAi.responses.create(
completionParams,
{ signal: Context.get('abortSignal') },
{ signal: Context.get('upstreamSignal') },
);
return OpenAiUtil.handle_completion_output_responses_api({
usage_calculator: ({
@@ -320,7 +320,7 @@ describe('ClaudeProvider.complete request shape', () => {
};
it.each([false, true])(
'passes cancellation to the SDK with stream=%s',
'passes the upstream signal to the SDK with stream=%s',
async (stream) => {
const { provider } = makeProvider();
const abort = new AbortController();
@@ -328,7 +328,7 @@ describe('ClaudeProvider.complete request shape', () => {
messagesStreamMock.mockReturnValueOnce(makeStreamLike([]));
else messagesCreateMock.mockResolvedValueOnce(baseResponse);
await withTestActor(() => {
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
return provider.complete({
model: 'claude-sonnet-4-6',
messages: [{ role: 'user', content: 'hi' }],
@@ -389,10 +389,10 @@ export class ClaudeProvider implements IChatProvider {
if (args.stream) {
const completion = usesBeta
? this.anthropic.beta.messages.stream(sdkParams as never, {
signal: Context.get('abortSignal'),
signal: Context.get('upstreamSignal'),
})
: this.anthropic.messages.stream(sdkParams as never, {
signal: Context.get('abortSignal'),
signal: Context.get('upstreamSignal'),
});
// Subscribed before the request is awaited: the SDK only queues
// events for iterators that already exist.
@@ -432,10 +432,10 @@ export class ClaudeProvider implements IChatProvider {
try {
const msg = await (usesBeta
? this.anthropic.beta.messages.create(sdkParams as never, {
signal: Context.get('abortSignal'),
signal: Context.get('upstreamSignal'),
})
: this.anthropic.messages.create(sdkParams as never, {
signal: Context.get('abortSignal'),
signal: Context.get('upstreamSignal'),
}));
const { usage, costs, details, advisorModel } = this.#meter(
(msg as Message).usage,
@@ -337,11 +337,11 @@ describe('gemini-4-argon catalog and routing', () => {
});
});
it('does not call Google when the request was already cancelled', async () => {
it('does not call Google when the upstream signal already aborted', async () => {
const abort = new AbortController();
abort.abort();
const error = await withTestActor(() => {
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
return makeProvider().complete({
model: 'gemini-4-argon',
messages: [{ role: 'user', content: 'hi' }],
@@ -213,12 +213,12 @@ describe('GroqAIProvider.complete request shape', () => {
usage: { prompt_tokens: 1, completion_tokens: 1 },
};
it('passes the request cancellation signal to the SDK', async () => {
it('passes the upstream signal to the SDK', async () => {
const { provider } = makeProvider();
const abort = new AbortController();
createMock.mockResolvedValueOnce(baseCompletion);
await withTestActor(() => {
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
return provider.complete({
model: 'openai/gpt-oss-20b',
messages: [{ role: 'user', content: 'hi' }],
@@ -229,19 +229,19 @@ describe('MistralAIProvider.complete request shape', () => {
usage: { promptTokens: 1, completionTokens: 1 },
};
it('passes the request cancellation signal to the SDK', async () => {
it('passes the upstream signal to the SDK', async () => {
const { provider } = makeProvider();
const abort = new AbortController();
completeMock.mockResolvedValueOnce(baseCompletion);
await withTestActor(() => {
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
return provider.complete({
model: 'mistral-small-latest',
messages: [{ role: 'user', content: 'hi' }],
});
});
// Bounded by the SDK timeout as well, and still cancelled with the
// request.
// Bounded by the SDK timeout as well, and still aborted with the
// upstream signal.
const signal: AbortSignal = completeMock.mock.calls[0][1]?.signal;
expect(signal.aborted).toBe(false);
abort.abort();
@@ -243,8 +243,8 @@ export class MistralAIProvider implements IChatProvider {
// signal is passed; a stream is bounded by its caller instead.
{
signal: stream
? Context.get('abortSignal')
: withSdkTimeout(Context.get('abortSignal')),
? Context.get('upstreamSignal')
: withSdkTimeout(Context.get('upstreamSignal')),
},
);
} catch (e) {
@@ -927,7 +927,7 @@ describe('OpenAiChatProvider.complete error mapping', () => {
describe('provider request cancellation', () => {
it.each([false, true])(
'passes cancellation to the SDK with stream=%s',
'passes the upstream signal to the SDK with stream=%s',
async (stream) => {
const { provider } = makeProvider();
const abort = new AbortController();
@@ -945,7 +945,7 @@ describe('provider request cancellation', () => {
},
);
await withTestActor(() => {
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
return provider.complete({
model: 'gpt-4o-mini',
messages: [{ role: 'user', content: 'hi' }],
@@ -250,7 +250,7 @@ export class OpenAiChatProvider implements IChatProvider {
const completion = await this.#openAi.chat.completions.create(
completionParams,
{ signal: Context.get('abortSignal') },
{ signal: Context.get('upstreamSignal') },
);
return OpenAiUtil.handle_completion_output({
@@ -307,7 +307,7 @@ export class OpenAiResponsesChatProvider implements IChatProvider {
const completion = await this.#openAi.responses.create(
completionParams,
{ signal: Context.get('abortSignal') },
{ signal: Context.get('upstreamSignal') },
);
return OpenAiUtil.handle_completion_output_responses_api({
usage_calculator: ({ usage, webSearchCalls, setUsageCosts }) => {
@@ -97,10 +97,10 @@ export class XAIProvider implements IChatProvider {
}
: {}),
} as ChatCompletionCreateParams,
{ signal: Context.get('abortSignal') },
{ signal: Context.get('upstreamSignal') },
);
} catch (e) {
if (!Context.get('abortSignal')?.aborted) {
if (!Context.get('upstreamSignal')?.aborted) {
console.log('XAI AI process_input_messages error: ', e);
}
throw e;
@@ -651,8 +651,9 @@ export const create_chat_stream_handler =
}
}
Context.get('abortSignal')?.throwIfAborted();
if (!finish_reason && !last_usage) {
// Some SDKs end an aborted stream as if it were complete.
Context.get('upstreamSignal')?.throwIfAborted();
throw new Error('Stream ended before completion');
}
@@ -824,8 +825,11 @@ export const create_chat_stream_handler_responses_api =
}
}
Context.get('abortSignal')?.throwIfAborted();
if (!completed) throw new Error('Stream ended before completion');
if (!completed) {
// Some SDKs end an aborted stream as if it were complete.
Context.get('upstreamSignal')?.throwIfAborted();
throw new Error('Stream ended before completion');
}
// TODO DS: this is a bit too abstracted... this is basically just doing the metering now
// Missing usage is left undefined rather than fed to the calculator —
@@ -1919,7 +1919,7 @@ describe('cancelled upstream iterators', () => {
const harness = makeCapturingChatStream();
await expect(
withTestActor(() => {
Context.set('abortSignal', abort.signal);
Context.set('upstreamSignal', abort.signal);
return handler({
completion,
usage_calculator: usageCalculator,
@@ -1932,6 +1932,58 @@ describe('cancelled upstream iterators', () => {
expect(usageCalculator).not.toHaveBeenCalled();
},
);
it.each([
[
'chat completions',
create_chat_stream_handler,
[
{ choices: [{ delta: { content: 'partial' } }] },
{
choices: [],
usage: { prompt_tokens: 3, completion_tokens: 5 },
},
],
],
[
'responses',
create_chat_stream_handler_responses_api,
[
{ type: 'response.output_text.delta', delta: 'partial' },
{
type: 'response.completed',
response: {
status: 'completed',
usage: { input_tokens: 3, output_tokens: 5 },
},
},
],
],
])(
'meters %s usage that arrived before the caller left',
async (_name, handler, chunks) => {
const abort = new AbortController();
const usageCalculator = vi.fn(() => ({ output_tokens: 5 }));
const completion = {
async *[Symbol.asyncIterator]() {
yield* chunks;
abort.abort();
},
};
const harness = makeCapturingChatStream();
await withTestActor(() => {
Context.set('abortSignal', abort.signal);
return handler({
completion,
usage_calculator: usageCalculator,
})({ chatStream: harness.chatStream });
});
expect(usageCalculator).toHaveBeenCalledTimes(1);
expect(harness.chatStream.reportedUsage).toEqual({
output_tokens: 5,
});
},
);
});
+27 -47
View File
@@ -169,9 +169,9 @@ export class AIChatStream {
*/
reportedUsage = null;
/** Set once the caller has gone away; see `abort`. */
aborted = false;
abortController = new AbortController();
/** Set once the caller has gone away; see `detach`. */
detached = false;
#detachController = new AbortController();
/**
* Stop/usage/context-management state for the end-of-stream `usage` line,
@@ -199,28 +199,31 @@ export class AIChatStream {
}
/**
* Stop accepting output after cancellation; providers cancel their requests
* too.
* Stop writing output once the caller has gone away. The provider keeps
* reading its upstream, so the usage the upstream reports still gets
* metered.
*/
abort() {
this.aborted = true;
this.abortController.abort();
detach() {
this.detached = true;
this.#detachController.abort();
}
/** False once nothing will read the output. */
#writable() {
return !this.detached && !this.stream.destroyed;
}
async waitForDrain() {
this.#assertOpen();
if (!this.stream.writableNeedDrain) return;
if (!this.#writable() || !this.stream.writableNeedDrain) return;
await new Promise((resolve, reject) => {
const signal = this.#detachController.signal;
const cleanup = () => {
this.stream.removeListener('drain', onDrain);
this.stream.removeListener('close', onAbort);
this.stream.removeListener('drain', onDone);
this.stream.removeListener('close', onDone);
this.stream.removeListener('error', onError);
this.abortController.signal.removeEventListener(
'abort',
onAbort,
);
signal.removeEventListener('abort', onDone);
};
const onDrain = () => {
const onDone = () => {
cleanup();
resolve();
};
@@ -228,28 +231,16 @@ export class AIChatStream {
cleanup();
reject(error);
};
const onAbort = () => onError(new ChatStreamAbortedError());
this.stream.once('drain', onDrain);
this.stream.once('close', onAbort);
this.stream.once('drain', onDone);
this.stream.once('close', onDone);
this.stream.once('error', onError);
this.abortController.signal.addEventListener('abort', onAbort, {
once: true,
});
if (this.stream.destroyed || this.aborted) onAbort();
else if (!this.stream.writableNeedDrain) onDrain();
signal.addEventListener('abort', onDone, { once: true });
if (!this.#writable() || !this.stream.writableNeedDrain) onDone();
});
this.#assertOpen();
}
#assertOpen() {
if (this.aborted) throw new ChatStreamAbortedError();
}
/** @param {string} text */
countOutput(text) {
// Tool-call input arrives through here and is only written when the
// block ends, so a long tool call has to notice the abort here too.
this.#assertOpen();
if (typeof text === 'string') this.outputChars += text.length;
}
@@ -279,9 +270,8 @@ export class AIChatStream {
* @param {{ alreadyCounted?: boolean }} [opts]
*/
writeChunk(chunk, { alreadyCounted = false } = {}) {
this.#assertOpen();
if (!alreadyCounted) this.outputChars += payloadChars(chunk);
this.stream.write(`${JSON.stringify(chunk)}\n`);
if (this.#writable()) this.stream.write(`${JSON.stringify(chunk)}\n`);
}
/**
@@ -384,8 +374,7 @@ export class AIChatStream {
*/
end(usage, extra) {
this.reportUsage(usage);
// Usage still counts after an abort; only the line has no reader.
if (!this.aborted) {
if (this.#writable()) {
const stop = this.stop;
const finish_reason = stop?.reason
? toFinishReason(stop.reason)
@@ -436,16 +425,7 @@ export class AIChatStream {
return new AIChatMessageStream(this);
}
write(...args) {
this.#assertOpen();
return this.stream.write(...args);
}
}
/** Thrown into a provider's read loop once its caller has gone away. */
export class ChatStreamAbortedError extends Error {
constructor() {
super('Chat stream aborted: the caller disconnected');
this.name = 'ChatStreamAbortedError';
if (this.#writable()) this.stream.write(...args);
}
}
@@ -25,7 +25,6 @@ import Streaming, {
AIChatStream,
AIChatTextStream,
AIChatToolUseStream,
ChatStreamAbortedError,
} from './Streaming.js';
// AIChatStream + friends emit newline-delimited JSON to an underlying
@@ -189,26 +188,27 @@ describe('AIChatStream stop + usage-detail reporting', () => {
});
});
// ── Abort ──────────────────────────────────────────────────────────
// -- Detach --
describe('AIChatStream.abort', () => {
it('throws into the next text, reasoning or tool-call write', () => {
describe('AIChatStream.detach', () => {
it('stops writing but keeps counting output', () => {
const h = makeHarness();
const text = h.chatStream.message().contentBlock({ type: 'text' });
const tool = h.chatStream
.message()
.contentBlock({ type: 'tool_use', id: 't', name: 'f' });
h.chatStream.abort();
expect(() => text.addText('x')).toThrow(ChatStreamAbortedError);
expect(() => text.addReasoning('x')).toThrow(ChatStreamAbortedError);
expect(() => tool.addPartialJSON('{')).toThrow(ChatStreamAbortedError);
expect(() => h.chatStream.write('raw')).toThrow(ChatStreamAbortedError);
h.chatStream.detach();
text.addText('abc');
text.addReasoning('de');
tool.addPartialJSON('{}');
h.chatStream.write('raw');
expect(h.chatStream.outputChars).toBe(7);
expect(h.rawChunks()).toEqual([]);
});
it('still records usage and ends the stream, writing nothing', () => {
const h = makeHarness();
h.chatStream.abort();
h.chatStream.detach();
h.chatStream.end({ output_tokens: 3 });
expect(h.chatStream.reportedUsage).toEqual({ output_tokens: 3 });
expect(h.rawChunks()).toEqual([]);
@@ -448,16 +448,25 @@ describe('AIChatStream backpressure', () => {
sink.destroy();
});
it.each(['abort', 'close', 'error'])('releases a drain wait on %s', async (event) => {
it.each(['detach', 'close'])('releases a drain wait on %s', async (event) => {
const sink = new Writable({ highWaterMark: 1, write() {} });
const chatStream = new AIChatStream({ stream: sink });
chatStream.writeChunk({ type: 'text', text: 'hello' });
const waiting = chatStream.waitForDrain();
const rejected = expect(waiting).rejects.toThrow(event === 'error' ? 'failed' : 'Chat stream aborted');
if (event === 'abort') chatStream.abort();
else if (event === 'error') sink.destroy(new Error('failed'));
if (event === 'detach') chatStream.detach();
else sink.destroy();
await rejected;
await waiting;
expect(sink.listenerCount('drain')).toBe(0);
await chatStream.waitForDrain();
});
it('rejects a drain wait when the writable errors', async () => {
const sink = new Writable({ highWaterMark: 1, write() {} });
const chatStream = new AIChatStream({ stream: sink });
chatStream.writeChunk({ type: 'text', text: 'hello' });
const waiting = chatStream.waitForDrain();
sink.destroy(new Error('failed'));
await expect(waiting).rejects.toThrow('failed');
expect(sink.listenerCount('drain')).toBe(0);
});
});
@@ -45,6 +45,7 @@ import { runWithContext } from '../../core/context.js';
import { type Actor, SYSTEM_ACTOR } from '../../core/actor.js';
import { PuterServer } from '../../server.js';
import { setupTestServer } from '../../testUtil.js';
import { withAiCostFactorHook } from '../integrationTestUtil.js';
import { generateDefaultFsentries } from '../../util/userProvisioning.js';
import { CLOUDFLARE_IMAGE_GENERATION_MODELS } from './providers/cloudflare/models.js';
import cloudflareModelSearchFixture from './providers/cloudflare/fixtures/model-search.json';
@@ -1645,3 +1646,34 @@ it.each([undefined, null, '', ' ', 42, {}])(
});
},
);
describe('ImageGenerationDriver cost factor', () => {
it('holds and meters at the AI cost factor', async () => {
const reserveSpy = vi.spyOn(server.services.metering, 'reserveCredits');
const usageSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
);
const generate = async (charges: number) => {
openaiImagesGenerateMock.mockResolvedValueOnce({
data: [{ url: 'https://oai/img.png' }],
});
await withActor(() =>
driver.generate({ model: 'gpt-image-2', prompt: 'hi' }),
);
await vi.waitFor(() =>
expect(usageSpy).toHaveBeenCalledTimes(charges),
);
};
await generate(1);
await withAiCostFactorHook(server.clients.event, 2, () => generate(2));
const costs = (call: number) =>
usageSpy.mock.calls[call]![1].map((u) => u.costOverride!);
expect(costs(0).length).toBeGreaterThan(0);
expect(costs(1)).toEqual(costs(0).map((c) => Math.round(c * 2)));
const held = reserveSpy.mock.calls.map(([, amount]) => amount);
expect(held[0]).toBeGreaterThan(0);
expect(held).toEqual([held[0], Math.round(held[0]! * 2)]);
});
});
+9 -14
View File
@@ -27,6 +27,10 @@ import { Mistral } from '@mistralai/mistralai';
import { Actor } from '../../core/actor.js';
import { Context } from '../../core/context.js';
import { HttpError } from '../../core/http/HttpError.js';
import {
awsCredentialsFrom,
type AwsCredentials,
} from '../../util/awsCredentials.js';
import { mimeFromName } from '../../util/fileSigning.js';
import {
assertActorHasCredits,
@@ -293,11 +297,7 @@ export class OCRDriver extends PuterDriver {
// Textract state — one client per region.
#textractClients: Record<string, TextractClient> = {};
#awsConfig: {
accessKeyId?: string;
secretAccessKey?: string;
region?: string;
} | null = null;
#awsConfig: { credentials: AwsCredentials; region: string } | null = null;
/** DetectDocumentText rates per region, from AWS's public price list. */
#textractRates = textractRates(OCR_COSTS[TEXTRACT_PAGE_USAGE_TYPE]);
@@ -314,16 +314,14 @@ export class OCRDriver extends PuterDriver {
Record<string, unknown> | undefined;
const textractAws = (textract?.aws ?? textract) as
Record<string, unknown> | undefined;
const textractAccessKey = textractAws?.access_key as string | undefined;
const textractSecretKey = textractAws?.secret_key as string | undefined;
const textractCredentials = awsCredentialsFrom(textractAws);
const textractRegion =
(textractAws?.region as string | undefined) ??
(textract?.region as string | undefined) ??
DEFAULT_TEXTRACT_REGION;
if (textractAccessKey && textractSecretKey) {
if (textractCredentials) {
this.#awsConfig = {
accessKeyId: textractAccessKey,
secretAccessKey: textractSecretKey,
credentials: textractCredentials,
region: textractRegion,
};
// Warm the configured region so the cost report has its rate.
@@ -460,10 +458,7 @@ export class OCRDriver extends PuterDriver {
const cached = this.#textractClients[region];
if (cached) return cached;
const client = new TextractClient({
credentials: {
accessKeyId: this.#awsConfig!.accessKeyId!,
secretAccessKey: this.#awsConfig!.secretAccessKey!,
},
credentials: this.#awsConfig!.credentials,
region,
});
this.#textractClients[region] = client;
@@ -48,7 +48,11 @@ import type { MeteringService } from '../../services/metering/MeteringService.js
import { setupTestServer } from '../../testUtil.js';
import { generateDefaultFsentries } from '../../util/userProvisioning.js';
import type { VoiceChangerDriver } from './VoiceChangerDriver.js';
import { callerError, readStreamResult } from '../integrationTestUtil.js';
import {
callerError,
readStreamResult,
withAiCostFactorHook,
} from '../integrationTestUtil.js';
import { VOICE_CHANGER_COSTS } from './costs.js';
const { webFetchMock } = vi.hoisted(() => ({ webFetchMock: vi.fn() }));
@@ -352,6 +356,35 @@ describe('VoiceChangerDriver.convert success path', () => {
expect(cost).toBe(perSecond * expectedSeconds);
});
it('holds and meters at the AI cost factor', async () => {
const { actor } = await makeUser();
const usageType = 'elevenlabs:eleven_multilingual_sts_v2:second';
const metered = () =>
incrementUsageSpy.mock.calls
.filter(([, type]) => type === usageType)
.map(([, , , cost]) => cost);
const convert = async (charges: number) => {
fetchSpy.mockResolvedValueOnce(
okResponse(new ArrayBuffer(8), 'audio/mpeg'),
);
await readStreamResult(
await withActor(actor, () =>
driver.convert({
audio: dataUrl(Buffer.alloc(32_000), 'audio/mpeg'),
}),
),
);
await vi.waitFor(() => expect(metered()).toHaveLength(charges));
};
await convert(1);
await withAiCostFactorHook(server.clients.event, 2, () => convert(2));
const [base, factored] = metered();
expect(factored).toBe(base! * 2);
const held = hasCreditsSpy.mock.calls.map(([, amount]) => amount);
expect(held).toEqual([base, base! * 2]);
});
it('meters nothing when ElevenLabs breaks off before any audio', async () => {
const { actor } = await makeUser();
fetchSpy.mockResolvedValueOnce(
@@ -49,6 +49,7 @@ import { PuterServer } from '../../server.js';
import type { MeteringService } from '../../services/metering/MeteringService.js';
import { setupTestServer } from '../../testUtil.js';
import { generateDefaultFsentries } from '../../util/userProvisioning.js';
import { withAiCostFactorHook } from '../integrationTestUtil.js';
import type { SpeechToTextDriver } from './SpeechToTextDriver.js';
import { SPEECH_TO_TEXT_COSTS } from './costs.js';
@@ -682,6 +683,34 @@ describe('SpeechToTextDriver metering', () => {
const creditCall = hasCreditsSpy.mock.calls[0]!;
expect(creditCall[1]).toBe(expected);
});
it('holds and meters at the AI cost factor', async () => {
const { actor } = await makeUser();
const usageType = 'openai:gpt-transcribe:second';
const metered = () =>
incrementUsageSpy.mock.calls
.filter(([, type]) => type === usageType)
.map(([, , , cost]) => cost);
const transcribe = async (charges: number) => {
transcriptionsCreateMock.mockResolvedValueOnce({ text: 'x' });
await withActor(actor, () =>
driver.transcribe({
file: dataUrl(Buffer.alloc(32000, 0), 'audio/mp3'),
model: 'gpt-transcribe',
}),
);
await vi.waitFor(() => expect(metered()).toHaveLength(charges));
};
await transcribe(1);
await withAiCostFactorHook(server.clients.event, 2, () =>
transcribe(2),
);
const [base, factored] = metered();
expect(factored).toBe(base! * 2);
const held = hasCreditsSpy.mock.calls.map(([, amount]) => amount);
expect(held).toEqual([base, base! * 2]);
});
});
// ── Error paths ─────────────────────────────────────────────────────
@@ -44,6 +44,10 @@ import { runWithContext } from '../../core/context.js';
import { SYSTEM_ACTOR } from '../../core/actor.js';
import { PuterServer } from '../../server.js';
import { setupTestServer } from '../../testUtil.js';
import {
readStreamResult,
withAiCostFactorHook,
} from '../integrationTestUtil.js';
import type { TTSDriver } from './TTSDriver.js';
import pollyPriceList from './providers/awsPolly/fixtures/us-west-2.json';
@@ -688,3 +692,40 @@ describe('TTSDriver.synthesize error mapping', () => {
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
});
describe('TTSDriver cost factor', () => {
it('holds and meters at the AI cost factor', async () => {
const incrementUsageSpy = vi.spyOn(
server.services.metering,
'incrementUsage',
);
const hasCreditsSpy = vi.spyOn(
server.services.metering,
'hasEnoughCredits',
);
const metered = () =>
incrementUsageSpy.mock.calls.map(([, , , cost]) => cost!);
const synthesize = async (charges: number) => {
openaiSpeechCreateMock.mockResolvedValueOnce(openaiAudioResponse());
await readStreamResult(
await withActor(() =>
driver.synthesize({
text: 'hello there',
provider: 'openai',
}),
),
);
await vi.waitFor(() => expect(metered()).toHaveLength(charges));
};
await synthesize(1);
await withAiCostFactorHook(server.clients.event, 2, () =>
synthesize(2),
);
const [base, factored] = metered();
expect(base).toBeGreaterThan(0);
expect(factored).toBe(Math.round(base! * 2));
const held = hasCreditsSpy.mock.calls.map(([, amount]) => amount);
expect(held).toEqual([base, Math.round(base! * 2)]);
});
});
+4 -5
View File
@@ -19,6 +19,7 @@
import { Context } from '../../core/context.js';
import { HttpError } from '../../core/http/HttpError.js';
import { awsCredentialsFrom } from '../../util/awsCredentials.js';
import type { DriverStreamResult } from '../meta.js';
import { PuterDriver } from '../types.js';
import {
@@ -241,15 +242,13 @@ export class TTSDriver extends PuterDriver {
const polly = providers['aws-polly'];
const pollyAws = (polly?.aws ?? polly) as
Record<string, unknown> | undefined;
const pollyAccessKey = pollyAws?.access_key as string | undefined;
const pollySecretKey = pollyAws?.secret_key as string | undefined;
if (pollyAccessKey && pollySecretKey) {
const pollyCredentials = awsCredentialsFrom(pollyAws);
if (pollyCredentials) {
register(
'aws-polly',
() =>
new AWSPollyTTSProvider(m, {
access_key: pollyAccessKey,
secret_key: pollySecretKey,
credentials: pollyCredentials,
region: (pollyAws?.region ?? polly?.region) as
string | undefined,
}),
@@ -101,8 +101,7 @@ const aiMetering = () =>
const makeProvider = (region?: string) =>
new AWSPollyTTSProvider(aiMetering(), {
access_key: 'AKIA-TEST',
secret_key: 'secret',
credentials: { accessKeyId: 'AKIA-TEST', secretAccessKey: 'secret' },
region,
});
@@ -27,6 +27,7 @@ import {
} from '@aws-sdk/client-polly';
import { HttpError } from '../../../../core/http/HttpError.js';
import { Context } from '../../../../core/context.js';
import type { AwsCredentials } from '../../../../util/awsCredentials.js';
import type { AiMeteringService } from '../../../util/aiCostFactor.js';
import type { DriverStreamResult } from '../../../meta.js';
import { SAMPLE_AUDIO_URL } from '../../../util/testMode.js';
@@ -83,8 +84,7 @@ export class AWSPollyTTSProvider implements ITTSProvider {
constructor(
private readonly meteringService: AiMeteringService,
private readonly config: {
access_key: string;
secret_key: string;
credentials: AwsCredentials;
region?: string;
},
) {
@@ -115,10 +115,7 @@ export class AWSPollyTTSProvider implements ITTSProvider {
}
this.clients[resolvedRegion] = new PollyClient({
credentials: {
accessKeyId: cfg.access_key,
secretAccessKey: cfg.secret_key,
},
credentials: cfg.credentials,
region: resolvedRegion,
});
@@ -46,6 +46,7 @@ import { type Actor, SYSTEM_ACTOR } from '../../core/actor.js';
import { PuterServer } from '../../server.js';
import type { MeteringService } from '../../services/metering/MeteringService.js';
import { setupTestServer } from '../../testUtil.js';
import { withAiCostFactorHook } from '../integrationTestUtil.js';
import { generateDefaultFsentries } from '../../util/userProvisioning.js';
import { TOGETHER_VIDEO_GENERATION_MODELS } from './providers/together/models.js';
import type { VideoGenerationDriver } from './VideoGenerationDriver.js';
@@ -102,6 +103,11 @@ beforeAll(async () => {
// block, so this one alone must not register a provider.
'gemini-video-generation': { apiKey: 'gem-key' },
kling: { apiKey: 'kling-key' },
// The chat block's base URL ends in `/v1`; video must drop it.
minimax: {
apiKey: 'mm-key',
apiBaseUrl: 'https://api.minimax.io/v1',
},
},
} as never);
driver = server.drivers.aiVideo as unknown as VideoGenerationDriver;
@@ -506,6 +512,54 @@ describe('VideoGenerationDriver.generate provider routing', () => {
]);
});
it.each([
'minimax-h3',
'minimax/minimax-h3',
'minimax:minimax/minimax-h3',
])('routes %s to the MiniMax provider from the shared minimax key', async (model) => {
const fetchSpy = vi.spyOn(globalThis, 'fetch');
fetchSpy.mockResolvedValueOnce(
new Response(JSON.stringify({ task_id: 'mm-task' })),
);
fetchSpy.mockResolvedValueOnce(
new Response(
JSON.stringify({
task: {
id: 'mm-task',
status: 'succeeded',
content: { url: 'https://minimax/out.mp4' },
usage: { output_seconds: 5 },
},
}),
),
);
const result = await withActor(() =>
driver.generate({ prompt: 'hi', model } as never),
);
expect(result).toBe('https://minimax/out.mp4');
expect(String(fetchSpy.mock.calls[0]![0])).toBe(
'https://api.minimax.io/v2/video_generation',
);
expect(togetherVideosCreateMock).not.toHaveBeenCalled();
});
it('lists the MiniMax models under the minimax-video-generation provider', async () => {
const minimax = (await driver.models()).filter(
(m) => m.provider === 'minimax-video-generation',
);
expect(minimax.map((m) => m.id).sort()).toEqual([
'minimax-h3',
'minimax-h3-highspeed',
'minimax-h3-lite',
'minimax-h3-max',
'minimax-hailuo-02',
'minimax-hailuo-2.3',
'minimax-hailuo-2.3-fast',
]);
});
it('routes a known togetherai:minimax/video-01-director id to the Together provider', async () => {
togetherVideosCreateMock.mockResolvedValueOnce({ id: 'tg-job' });
togetherVideosRetrieveMock.mockResolvedValueOnce({
@@ -947,6 +1001,49 @@ describe('VideoGenerationDriver.generate puter_output_path', () => {
// ── Size unification ───────────────────────────────────────────────
describe('VideoGenerationDriver.generate size unification', () => {
it.each(['912x512', '512x912'])(
'selects and bills Hailuo 02 at 512p for %s',
async (size) => {
const fetchSpy = vi.spyOn(globalThis, 'fetch');
const incrementUsageSpy = vi.spyOn(
server.services.metering,
'incrementUsage',
);
fetchSpy.mockResolvedValueOnce(
new Response(JSON.stringify({ task_id: 'mm-task' })),
);
fetchSpy.mockResolvedValueOnce(
new Response(JSON.stringify({
status: 'Success',
file_id: 'file-1',
})),
);
fetchSpy.mockResolvedValueOnce(
new Response(JSON.stringify({
file: { download_url: 'https://minimax/out.mp4' },
})),
);
await withActor(() => driver.generate({
prompt: 'a ball rolls',
model: 'minimax-hailuo-02',
size,
input_reference: 'https://example.com/first.png',
} as never));
const body = JSON.parse(
fetchSpy.mock.calls[0]![1]!.body as string,
);
expect(body.resolution).toBe('512P');
expect(incrementUsageSpy).toHaveBeenCalledWith(
SYSTEM_ACTOR,
'minimax-video-generation:minimax-hailuo-02:per-video:512p:6',
1,
10 * 1_000_000,
);
},
);
it('maps a WIDTHxHEIGHT size onto a tier plus aspect ratio for tier-based models', async () => {
completeTogetherJob();
@@ -980,6 +1077,77 @@ describe('VideoGenerationDriver.generate size unification', () => {
expect('ratio' in sent).toBe(false);
});
it('treats a catalog with a 2k or 4k tier as tier-based', async () => {
const fetchSpy = vi.spyOn(globalThis, 'fetch');
fetchSpy.mockResolvedValueOnce(
new Response(
JSON.stringify({
code: 0,
data: { id: 'kl-task', status: 'submitted' },
}),
),
);
fetchSpy.mockResolvedValueOnce(
new Response(
JSON.stringify({
code: 0,
data: [
{
id: 'kl-task',
status: 'succeeded',
outputs: [
{
type: 'video',
url: 'https://kling/out.mp4',
duration: '5',
},
],
},
],
}),
),
);
await withActor(() =>
driver.generate({
prompt: 'hi',
model: 'kling-3.0',
size: '1080x1920',
} as never),
);
const sent = JSON.parse(
(fetchSpy.mock.calls[0]![1] as RequestInit).body as string,
);
expect(sent.settings.resolution).toBe('1080p');
expect(sent.settings.aspect_ratio).toBe('9:16');
fetchSpy.mockResolvedValueOnce(
new Response(JSON.stringify({ task_id: 'mm-task' })),
);
fetchSpy.mockResolvedValueOnce(
new Response(
JSON.stringify({
task: {
id: 'mm-task',
status: 'succeeded',
content: { url: 'https://minimax/out.mp4' },
},
}),
),
);
await withActor(() =>
driver.generate({
prompt: 'hi',
model: 'minimax-h3-lite',
size: '854x480',
} as never),
);
const sentToMiniMax = JSON.parse(
(fetchSpy.mock.calls[2]![1] as RequestInit).body as string,
);
expect(sentToMiniMax.resolution).toBe('480P');
expect(sentToMiniMax.ratio).toBe('16:9');
});
it('fills width/height from a WIDTHxHEIGHT size for pixel-sized models', async () => {
completeTogetherJob();
@@ -1025,3 +1193,31 @@ describe('VideoGenerationDriver.generate size unification', () => {
expect('height' in second).toBe(false);
});
});
describe('VideoGenerationDriver cost factor', () => {
it('holds and meters at the AI cost factor', async () => {
const incrementUsageSpy = vi.spyOn(
server.services.metering,
'incrementUsage',
);
const reserveSpy = vi.spyOn(server.services.metering, 'reserveCredits');
const metered = () =>
incrementUsageSpy.mock.calls.map(([, , , cost]) => cost!);
const generate = async (charges: number) => {
completeTogetherJob();
await withActor(() =>
driver.generate({ prompt: 'hi', model: DEFAULT_MODEL } as never),
);
await vi.waitFor(() => expect(metered()).toHaveLength(charges));
};
await generate(1);
await withAiCostFactorHook(server.clients.event, 2, () => generate(2));
const [base, factored] = metered();
expect(base).toBeGreaterThan(0);
expect(factored).toBe(Math.round(base! * 2));
const held = reserveSpy.mock.calls.map(([, amount]) => amount);
expect(held[0]).toBeGreaterThan(0);
expect(held).toEqual([held[0], Math.round(held[0]! * 2)]);
});
});
@@ -41,6 +41,7 @@ import { readProviderKey } from '../util/providerRegistry.js';
import { BytePlusVideoProvider } from './providers/byteplus/BytePlusVideoProvider.js';
import { GeminiVideoProvider } from './providers/gemini/GeminiVideoProvider.js';
import { KlingVideoProvider } from './providers/kling/KlingVideoProvider.js';
import { MiniMaxVideoProvider } from './providers/minimax/MiniMaxVideoProvider.js';
import { TogetherVideoProvider } from './providers/together/TogetherVideoProvider.js';
import type {
IGenerateVideoParams,
@@ -50,7 +51,9 @@ import type {
const DEFAULT_PROVIDER = 'together-video-generation';
const isResolutionTier = (value: string): boolean => /^\d{3,4}p$/i.test(value);
/** A resolution tier such as `720p`, `2k` or `4k`, as opposed to pixels. */
const isResolutionTier = (value: string): boolean =>
/^(\d{3,4}p|\dk)$/i.test(value);
const parsePixelSize = (
value: string | undefined,
@@ -63,14 +66,15 @@ const parsePixelSize = (
};
/** Resolution tier of the shorter side, e.g. 1920x1080 and 1080x1920 → 1080p. */
const tierForPixels = ({
width,
height,
}: {
width: number;
height: number;
}) => {
const tierForPixels = (
{ width, height }: { width: number; height: number },
dimensions: readonly string[],
) => {
const shortSide = Math.min(width, height);
const exactTier = dimensions.find(
(tier) => tier.toLowerCase() === `${shortSide}p`,
);
if (exactTier) return exactTier;
if (shortSide <= 480) return '480p';
if (shortSide <= 720) return '720p';
if (shortSide <= 1080) return '1080p';
@@ -81,7 +85,7 @@ const tierForPixels = ({
* Driver implementing the `puter-video-generation` interface.
*
* Manages multiple upstream providers (Together, BytePlus/Seedance, Gemini,
* Kling) and handles model resolution, provider routing, and parameter
* Kling, MiniMax) and handles model resolution, provider routing, and parameter
* normalisation. Each provider is a plain `IVideoProvider` -- the driver
* instantiates them from config on boot.
*
@@ -98,6 +102,7 @@ export class VideoGenerationDriver extends PuterDriver {
'byteplus-video-generation',
'gemini-video-generation',
'kling-video-generation',
'minimax-video-generation',
];
readonly isDefault = true;
@@ -293,7 +298,7 @@ export class VideoGenerationDriver extends PuterDriver {
const catalogIsTiers = model.dimensions.every(isResolutionTier);
const wanted =
catalogIsTiers && requestedPixels
? tierForPixels(requestedPixels)
? tierForPixels(requestedPixels, model.dimensions)
: requestedResolution;
// Case-insensitive so '4K' matches a catalog entry spelled '4k';
@@ -468,6 +473,26 @@ export class VideoGenerationDriver extends PuterDriver {
{ stores: this.stores, fs: this.services.fs },
);
}
// Falls back to the shared `minimax` (ai-chat) key. The chat block's
// `apiBaseUrl` names the chat API under `/v1`; the provider keeps its
// host, since the video API lives beside it.
const minimaxVideoCfg = providers['minimax-video-generation'] as
Record<string, unknown> | undefined;
const minimaxSharedCfg = providers['minimax'] as
Record<string, unknown> | undefined;
const minimaxKey = readProviderKey(minimaxVideoCfg, minimaxSharedCfg);
if (minimaxKey) {
this.#providers['minimax-video-generation'] =
new MiniMaxVideoProvider(
{
apiKey: minimaxKey,
apiBaseUrl: (minimaxVideoCfg?.apiBaseUrl ??
minimaxSharedCfg?.apiBaseUrl) as string | undefined,
},
m,
);
}
}
// -- Model map -----------------------------------------------------------
@@ -0,0 +1,66 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* Integration test for the MiniMax video provider.
*
* Generates a 4s 480P clip on minimax-h3-lite ($0.10). Skipped when
* `PUTER_TEST_AI_MINIMAX_API_KEY` is unset.
*/
import { describe, expect, it } from 'vitest';
import {
makeMeteringStub,
optionalEnv,
skipUnlessEnv,
withTestActor,
} from '../../../integrationTestUtil.js';
import { MiniMaxVideoProvider } from './MiniMaxVideoProvider.js';
const ENV_VAR = 'PUTER_TEST_AI_MINIMAX_API_KEY';
// Task-based generation can take a couple of minutes.
const VIDEO_TIMEOUT_MS = 5 * 60 * 1000;
describe.skipIf(skipUnlessEnv(ENV_VAR))(
'MiniMaxVideoProvider (integration)',
() => {
it(
'generates a video URL from minimax-h3-lite',
{ timeout: VIDEO_TIMEOUT_MS },
async () => {
const provider = new MiniMaxVideoProvider(
{ apiKey: optionalEnv(ENV_VAR)! },
makeMeteringStub(),
);
const url = await withTestActor(() =>
provider.generate({
model: 'minimax-h3-lite',
prompt: 'a red ball rolls to the right',
resolution: '480p',
seconds: 4,
}),
);
expect(typeof url).toBe('string');
expect((url as string).startsWith('https://')).toBe(true);
},
);
},
);
@@ -0,0 +1,876 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* Offline unit tests for MiniMaxVideoProvider.
*
* Boots a real PuterServer and constructs the provider against the live wired
* `MeteringService`. MiniMax's task APIs are called through global `fetch`,
* which is stubbed as the network boundary.
*/
import {
afterAll,
afterEach,
beforeAll,
beforeEach,
describe,
expect,
it,
vi,
type MockInstance,
} from 'vitest';
import type { MeteringService } from '../../../../services/metering/MeteringService.js';
import { PuterServer } from '../../../../server.js';
import { setupTestServer } from '../../../../testUtil.js';
import { withTestActor } from '../../../integrationTestUtil.js';
import { withAiCostFactor } from '../../../util/aiCostFactor.js';
import type { IGenerateVideoParams } from '../../types.js';
import { MiniMaxVideoProvider } from './MiniMaxVideoProvider.js';
import { MINIMAX_VIDEO_GENERATION_MODELS } from './models.js';
// -- Test harness ----------------------------------------------------
let server: PuterServer;
let fetchSpy: MockInstance<typeof fetch>;
let remainingUsageSpy: MockInstance<MeteringService['getRemainingUsage']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
server = await setupTestServer();
});
afterAll(async () => {
await server?.shutdown();
});
const aiMetering = () =>
withAiCostFactor(
server.services.metering,
server.clients.event,
'ai-video',
);
const makeProvider = (config: { apiKey?: string; apiBaseUrl?: string } = {}) =>
new MiniMaxVideoProvider(
{
apiKey: config.apiKey ?? 'test-key',
...(config.apiBaseUrl ? { apiBaseUrl: config.apiBaseUrl } : {}),
pollIntervalMs: 1,
},
aiMetering(),
);
beforeEach(() => {
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
remainingUsageSpy = vi.spyOn(server.services.metering, 'getRemainingUsage');
remainingUsageSpy.mockResolvedValue(Number.MAX_SAFE_INTEGER);
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
incrementUsageSpy.mockResolvedValue({} as never);
});
afterEach(() => {
vi.restoreAllMocks();
});
const jsonResponse = (body: unknown, status = 200) =>
new Response(JSON.stringify(body), {
status,
headers: { 'content-type': 'application/json' },
});
const ok = { status_code: 0, status_msg: 'success' };
const h3Task = (overrides: Record<string, unknown> = {}) => ({
id: 'task-1',
model: 'MiniMax-H3',
status: 'succeeded',
content: { url: 'https://minimax.example/out.mp4' },
resolution: '768P',
duration: 5,
usage: { output_seconds: 5 },
...overrides,
});
/** Queue the v2 create response followed by task query responses. */
const mockH3Flow = (...polled: unknown[]) => {
fetchSpy.mockResolvedValueOnce(jsonResponse({ task_id: 'task-1' }));
for (const task of polled) {
fetchSpy.mockResolvedValueOnce(jsonResponse({ task }));
}
};
const hailuoTask = (status: string, fileId = 'file-1') => ({
task_id: 'task-1',
status,
file_id: status === 'Success' ? fileId : '',
base_resp: ok,
});
/** Queue the v1 create, query and file retrieve responses. */
const mockHailuoFlow = (...polled: unknown[]) => {
fetchSpy.mockResolvedValueOnce(
jsonResponse({ task_id: 'task-1', base_resp: ok }),
);
for (const task of polled) {
fetchSpy.mockResolvedValueOnce(jsonResponse(task));
}
fetchSpy.mockResolvedValueOnce(
jsonResponse({
file: {
file_id: 1,
download_url: 'https://minimax.example/hailuo.mp4',
},
base_resp: ok,
}),
);
};
const sentUrl = (callIndex = 0) => String(fetchSpy.mock.calls[callIndex]![0]);
const sentBody = (callIndex = 0): Record<string, any> =>
JSON.parse(
(fetchSpy.mock.calls[callIndex]![1] as RequestInit).body as string,
);
const generate = (params: Partial<IGenerateVideoParams>) =>
withTestActor(() =>
makeProvider().generate({ prompt: 'a ball rolls', ...params }),
);
const rate = (id: string, key: string) =>
MINIMAX_VIDEO_GENERATION_MODELS.find((m) => m.id === id)!.costs![key]!;
// -- Construction / catalog ------------------------------------------
describe('MiniMaxVideoProvider construction and catalog', () => {
it('throws when no apiKey is supplied', () => {
expect(
() => new MiniMaxVideoProvider({ apiKey: '' }, aiMetering()),
).toThrow(/API key/i);
});
it('defaults to MiniMax H3 and lists the seven models', () => {
const provider = makeProvider();
expect(provider.getDefaultModel()).toBe('minimax-h3');
expect(provider.models().map((m) => m.id)).toEqual([
'minimax-h3',
'minimax-h3-highspeed',
'minimax-h3-lite',
'minimax-h3-max',
'minimax-hailuo-2.3',
'minimax-hailuo-2.3-fast',
'minimax-hailuo-02',
]);
expect(fetchSpy).not.toHaveBeenCalled();
});
});
// -- H3 request shape ------------------------------------------------
describe('MiniMaxVideoProvider.generate H3 request shape', () => {
it('creates a v2 task with a ratio and polls it', async () => {
mockH3Flow(h3Task());
const result = await generate({
model: 'minimax-h3-lite',
seconds: 6,
size: '480p',
width: 1080,
height: 1920,
});
expect(result).toBe('https://minimax.example/out.mp4');
expect(sentUrl()).toBe('https://api.minimax.io/v2/video_generation');
const init = fetchSpy.mock.calls[0]![1] as RequestInit & {
headers: Record<string, string>;
};
expect(init.method).toBe('POST');
expect(init.headers.Authorization).toBe('Bearer test-key');
expect(sentBody()).toEqual({
model: 'MiniMax-H3-Lite',
content: [{ type: 'text', text: 'a ball rolls' }],
duration: 6,
resolution: '480P',
ratio: '9:16',
});
expect(sentUrl(1)).toBe(
'https://api.minimax.io/v2/query/video_generation/task-1',
);
});
it('sends the model name as MiniMax spells it and 2K upper-cased', async () => {
mockH3Flow(h3Task());
await generate({ model: 'MiniMax:minimax/minimax-h3', size: '2K' });
expect(sentBody()).toMatchObject({
model: 'MiniMax-H3',
resolution: '2K',
duration: 5,
});
});
it('defaults the ratio to 16:9 and ignores ratios MiniMax lacks', async () => {
mockH3Flow(h3Task());
await generate({ model: 'minimax-h3', width: 1000, height: 300 });
expect(sentBody().ratio).toBe('16:9');
});
it('sends frames with roles and no ratio', async () => {
mockH3Flow(h3Task());
await generate({
model: 'minimax-h3',
input_reference: 'data:image/png;base64,AAAA',
last_frame: 'https://example.com/last.png',
width: 1920,
height: 1080,
});
const body = sentBody();
expect(body.content).toEqual([
{ type: 'text', text: 'a ball rolls' },
{
type: 'image_url',
image_url: { url: 'data:image/png;base64,AAAA' },
role: 'first_frame',
},
{
type: 'image_url',
image_url: { url: 'https://example.com/last.png' },
role: 'last_frame',
},
]);
expect('ratio' in body).toBe(false);
});
it('takes a last frame on its own', async () => {
mockH3Flow(h3Task());
await generate({
model: 'minimax-h3',
last_frame: 'https://example.com/last.png',
});
expect(
sentBody().content.map((c: { role?: string }) => c.role),
).toEqual([undefined, 'last_frame']);
});
it('wraps raw base64 as a PNG data URI', async () => {
mockH3Flow(h3Task());
await generate({ model: 'minimax-h3', input_reference: 'BBBB' });
expect(sentBody().content[1].image_url.url).toBe(
'data:image/png;base64,BBBB',
);
});
it('sends references with a ratio', async () => {
mockH3Flow(h3Task());
await generate({
model: 'minimax-h3-max',
reference_images: ['https://example.com/a.png', 'CCCC'],
width: 4,
height: 3,
});
const body = sentBody();
expect(body.content).toEqual([
{ type: 'text', text: 'a ball rolls' },
{
type: 'image_url',
image_url: { url: 'https://example.com/a.png' },
role: 'reference_image',
},
{
type: 'image_url',
image_url: { url: 'data:image/png;base64,CCCC' },
role: 'reference_image',
},
]);
expect(body.ratio).toBe('4:3');
});
it("drops the chat API's /v1 from a base URL override", async () => {
mockH3Flow(h3Task());
await withTestActor(() =>
makeProvider({
apiBaseUrl: 'https://api.minimaxi.com/v1/',
}).generate({ prompt: 'hi' }),
);
expect(sentUrl()).toBe('https://api.minimaxi.com/v2/video_generation');
});
it('keeps polling while the task is queued or running', async () => {
mockH3Flow(
h3Task({ status: 'queued', content: undefined, usage: {} }),
h3Task({ status: 'running', content: undefined, usage: {} }),
h3Task(),
);
const result = await generate({});
expect(result).toBe('https://minimax.example/out.mp4');
expect(fetchSpy).toHaveBeenCalledTimes(4);
});
it('treats a rate-limited poll as a missed poll', async () => {
fetchSpy.mockResolvedValueOnce(jsonResponse({ task_id: 'task-1' }));
fetchSpy.mockResolvedValueOnce(
jsonResponse(
{
type: 'error',
error: {
type: 'rate_limit_error',
message: 'rate limit (1002)',
},
},
429,
),
);
fetchSpy.mockResolvedValueOnce(jsonResponse({ task: h3Task() }));
const result = await generate({});
expect(result).toBe('https://minimax.example/out.mp4');
expect(fetchSpy).toHaveBeenCalledTimes(3);
});
it('returns the sample clip in test mode without calling MiniMax', async () => {
const result = await generate({ test_mode: true });
expect(result).toBe('https://assets.puter.site/txt2vid.mp4');
expect(fetchSpy).not.toHaveBeenCalled();
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
});
// -- Hailuo request shape --------------------------------------------
describe('MiniMaxVideoProvider.generate Hailuo request shape', () => {
it('creates a v1 task, polls it and exchanges the file id for a URL', async () => {
mockHailuoFlow(hailuoTask('Preparing'), hailuoTask('Success'));
const result = await generate({
model: 'minimax-hailuo-2.3',
seconds: 10,
width: 1920,
height: 1080,
});
expect(result).toBe('https://minimax.example/hailuo.mp4');
expect(sentUrl()).toBe('https://api.minimax.io/v1/video_generation');
expect(sentBody()).toEqual({
model: 'MiniMax-Hailuo-2.3',
prompt: 'a ball rolls',
duration: 10,
resolution: '768P',
});
expect(sentUrl(1)).toBe(
'https://api.minimax.io/v1/query/video_generation?task_id=task-1',
);
expect(sentUrl(3)).toBe(
'https://api.minimax.io/v1/files/retrieve?file_id=file-1',
);
});
it('falls back to 6 seconds at 1080p, which takes no 10-second clip', async () => {
mockHailuoFlow(hailuoTask('Success'));
await generate({
model: 'minimax-hailuo-2.3-fast',
seconds: 10,
size: '1080p',
input_reference: 'https://example.com/first.png',
});
expect(sentBody()).toMatchObject({
model: 'MiniMax-Hailuo-2.3-Fast',
duration: 6,
resolution: '1080P',
first_frame_image: 'https://example.com/first.png',
});
});
it.each(['768p', '1080p'])('sends first and last frames at %s', async (size) => {
mockHailuoFlow(hailuoTask('Success'));
await generate({
model: 'minimax-hailuo-02',
size,
input_reference: 'DDDD',
last_frame: 'https://example.com/last.png',
});
expect(sentBody()).toEqual({
model: 'MiniMax-Hailuo-02',
prompt: 'a ball rolls',
duration: 6,
resolution: size.toUpperCase(),
first_frame_image: 'data:image/png;base64,DDDD',
last_frame_image: 'https://example.com/last.png',
});
});
});
// -- Validation ------------------------------------------------------
describe('MiniMaxVideoProvider.generate rejects invalid input before calling MiniMax', () => {
it.each<[string, Partial<IGenerateVideoParams>]>([
['a blank prompt', { prompt: ' ' }],
[
'a prompt over 7000 characters on H3',
{ model: 'minimax-h3', prompt: 'x'.repeat(7001) },
],
[
'a prompt over 2000 characters on Hailuo',
{ model: 'minimax-hailuo-2.3', prompt: 'x'.repeat(2001) },
],
[
'a source video',
{ model: 'minimax-h3', input_video: 'https://example.com/v.mp4' },
],
[
'reference images on Hailuo',
{
model: 'minimax-hailuo-02',
reference_images: ['https://example.com/r.png'],
},
],
[
'reference images with a first frame on H3',
{
model: 'minimax-h3',
input_reference: 'https://example.com/f.png',
reference_images: ['https://example.com/r.png'],
},
],
[
'more than 5 images on H3',
{
model: 'minimax-h3',
reference_images: Array(6).fill('https://example.com/r.png'),
},
],
[
'more than 2 images on H3 Max',
{
model: 'minimax-h3-max',
reference_images: Array(3).fill('https://example.com/r.png'),
},
],
[
'a last frame on Hailuo 2.3',
{
model: 'minimax-hailuo-2.3',
input_reference: 'https://example.com/f.png',
last_frame: 'https://example.com/l.png',
},
],
[
'a last frame without a first frame on Hailuo 02',
{
model: 'minimax-hailuo-02',
last_frame: 'https://example.com/l.png',
},
],
[
'512p without a first frame on Hailuo 02',
{ model: 'minimax-hailuo-02', size: '512p' },
],
[
'a missing first frame on Hailuo 2.3 Fast',
{ model: 'minimax-hailuo-2.3-fast' },
],
[
'512p with first and last frames on Hailuo 02',
{
model: 'minimax-hailuo-02',
size: '512p',
input_reference: 'https://example.com/first.png',
last_frame: 'https://example.com/last.png',
},
],
[
'a non-string image',
{ model: 'minimax-h3', input_reference: 42 as never },
],
[
'a non-array reference_images',
{ model: 'minimax-h3', reference_images: 'x' as never },
],
])('rejects %s', async (_label, params) => {
fetchSpy.mockRejectedValue(new Error('Unexpected MiniMax request'));
const reserveCreditsSpy = vi.spyOn(
server.services.metering,
'reserveCredits',
);
await expect(generate(params)).rejects.toMatchObject({
statusCode: 400,
legacyCode: 'bad_request',
});
expect(fetchSpy).not.toHaveBeenCalled();
expect(reserveCreditsSpy).not.toHaveBeenCalled();
});
it('accepts a 7000-character prompt on H3', async () => {
mockH3Flow(h3Task());
await generate({ model: 'minimax-h3', prompt: 'x'.repeat(7000) });
expect(fetchSpy).toHaveBeenCalled();
});
it('accepts five images on H3', async () => {
mockH3Flow(h3Task());
await generate({
model: 'minimax-h3',
reference_images: Array(5).fill('https://example.com/r.png'),
});
expect(sentBody().content).toHaveLength(6);
});
});
// -- Billing ---------------------------------------------------------
describe('MiniMaxVideoProvider billing', () => {
it.each<[Partial<IGenerateVideoParams>, string, string, number]>([
[
{ model: 'minimax-h3', seconds: 5 },
'minimax-h3',
'per-second:768p',
5,
],
[
{ model: 'minimax-h3', seconds: 8, size: '2k' },
'minimax-h3',
'per-second:2k',
8,
],
[
{ model: 'minimax-h3-lite', seconds: 4, size: '480p' },
'minimax-h3-lite',
'per-second:480p',
4,
],
])(
'meters %o per second under its cost key',
async (params, id, key, secs) => {
mockH3Flow(
h3Task({ duration: secs, usage: { output_seconds: secs } }),
);
await generate(params);
expect(incrementUsageSpy).toHaveBeenCalledTimes(1);
const [, usageType, amount, cost] =
incrementUsageSpy.mock.calls[0]!;
expect(usageType).toBe(`minimax-video-generation:${id}:${key}`);
expect(amount).toBe(secs);
expect(cost).toBeCloseTo(secs * rate(id, key) * 1_000_000);
},
);
it('bills the seconds of output the task reports', async () => {
mockH3Flow(h3Task({ duration: 5, usage: { output_seconds: 4 } }));
await generate({ model: 'minimax-h3', seconds: 5 });
const [, , amount, cost] = incrementUsageSpy.mock.calls[0]!;
expect(amount).toBe(4);
expect(cost).toBeCloseTo(4 * 8 * 1_000_000);
});
it('bills the requested seconds when the task reports no usage', async () => {
mockH3Flow(h3Task({ duration: undefined, usage: undefined }));
await generate({ model: 'minimax-h3', seconds: 7 });
expect(incrementUsageSpy.mock.calls[0]![2]).toBe(7);
});
it('shortens an H3 clip to what the balance buys', async () => {
remainingUsageSpy.mockResolvedValue(6 * 8 * 1_000_000);
mockH3Flow(h3Task({ duration: 6, usage: { output_seconds: 6 } }));
await generate({ model: 'minimax-h3', seconds: 10 });
expect(sentBody().duration).toBe(6);
});
it('rejects with insufficient_funds before creating an H3 task it cannot afford', async () => {
remainingUsageSpy.mockResolvedValue(1000);
await expect(generate({ model: 'minimax-h3' })).rejects.toMatchObject({
statusCode: 402,
});
expect(fetchSpy).not.toHaveBeenCalled();
});
it.each<[Partial<IGenerateVideoParams>, string, string]>([
[
{ model: 'minimax-hailuo-2.3', seconds: 10 },
'minimax-hailuo-2.3',
'per-video:768p:10',
],
[
{ model: 'minimax-hailuo-02', size: '1080p' },
'minimax-hailuo-02',
'per-video:1080p:6',
],
[
{
model: 'minimax-hailuo-02',
size: '512p',
seconds: 10,
input_reference: 'https://example.com/f.png',
},
'minimax-hailuo-02',
'per-video:512p:10',
],
])('meters a Hailuo clip %o as one video', async (params, id, key) => {
mockHailuoFlow(hailuoTask('Success'));
await generate(params);
const [, usageType, amount, cost] = incrementUsageSpy.mock.calls[0]!;
expect(usageType).toBe(`minimax-video-generation:${id}:${key}`);
expect(amount).toBe(1);
expect(cost).toBe(rate(id, key) * 1_000_000);
});
it('rejects with insufficient_funds before creating a Hailuo task it cannot afford', async () => {
remainingUsageSpy.mockResolvedValue(1000);
await expect(
generate({ model: 'minimax-hailuo-2.3' }),
).rejects.toMatchObject({
statusCode: 402,
legacyCode: 'insufficient_funds',
});
expect(fetchSpy).not.toHaveBeenCalled();
});
});
// -- Failures --------------------------------------------------------
describe('MiniMaxVideoProvider failures', () => {
it.each(['failed', 'cancelled'])(
'maps a %s H3 task to upstream_failed and meters nothing',
async (status) => {
mockH3Flow(
h3Task({
status,
content: undefined,
error: { code: '1000', message: 'unknown error' },
}),
);
await expect(generate({})).rejects.toMatchObject({
statusCode: 502,
legacyCode: 'upstream_failed',
});
expect(incrementUsageSpy).not.toHaveBeenCalled();
},
);
it('maps an H3 task failed by the content filter to moderation_flagged', async () => {
mockH3Flow(
h3Task({
status: 'failed',
content: undefined,
error: {
code: '1026',
message: 'video description contains sensitive content',
},
}),
);
await expect(generate({})).rejects.toMatchObject({
statusCode: 400,
code: 'moderation_flagged',
});
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('carries a v2 parameter rejection with its status and code', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse(
{
type: 'error',
error: {
type: 'bad_request_error',
message:
'invalid params, model MiniMax-H3-Lite does not support resolution 2K (2013)',
http_code: '400',
},
},
400,
),
);
await expect(generate({})).rejects.toMatchObject({
status: 400,
code: '2013',
provider: 'minimax',
});
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('reports a model MiniMax no longer serves as upstream_failed', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse(
{
type: 'error',
error: {
type: 'bad_request_error',
message:
'invalid params, this model is not supported by /v2/video_generation (2013)',
},
},
400,
),
);
await expect(generate({})).rejects.toMatchObject({
statusCode: 502,
legacyCode: 'upstream_failed',
});
});
it('hides the auth message behind a 401', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse(
{
type: 'error',
error: {
type: 'authorized_error',
message:
'login fail: carry the key in Authorization (1004)',
},
},
401,
),
);
await expect(generate({})).rejects.toMatchObject({
status: 401,
message: 'MiniMax rejected the API key',
});
});
it('surfaces an empty balance as status 402 with the MiniMax code', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse(
{
type: 'error',
error: {
type: 'insufficient_balance_error',
message: 'insufficient balance (1008)',
},
},
402,
),
);
await expect(generate({})).rejects.toMatchObject({
status: 402,
code: '1008',
provider: 'minimax',
});
});
it('maps a content block at submit to moderation_flagged', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse(
{
type: 'error',
error: {
type: 'unprocessable_entity_error',
message: 'input new_sensitive (1026)',
},
},
422,
),
);
await expect(generate({})).rejects.toMatchObject({
statusCode: 400,
code: 'moderation_flagged',
});
});
it('reads a v1 verdict out of base_resp under HTTP 200', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse({
task_id: '',
base_resp: {
status_code: 1008,
status_msg: 'insufficient balance',
},
}),
);
await expect(
generate({ model: 'minimax-hailuo-2.3' }),
).rejects.toMatchObject({
status: 402,
code: '1008',
provider: 'minimax',
});
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('reports a Hailuo model MiniMax no longer serves as upstream_failed', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse({
task_id: '',
base_resp: {
status_code: 2013,
status_msg: 'invalid params, incorrect model param input',
},
}),
);
await expect(
generate({ model: 'minimax-hailuo-2.3' }),
).rejects.toMatchObject({
statusCode: 502,
legacyCode: 'upstream_failed',
});
});
it('maps a failed Hailuo task to upstream_failed and meters nothing', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse({ task_id: 'task-1', base_resp: ok }),
);
fetchSpy.mockResolvedValueOnce(jsonResponse(hailuoTask('Fail')));
await expect(
generate({ model: 'minimax-hailuo-2.3' }),
).rejects.toMatchObject({
statusCode: 502,
legacyCode: 'upstream_failed',
});
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('maps a Hailuo clip removed by the output filter to moderation_flagged', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse({ task_id: 'task-1', base_resp: ok }),
);
fetchSpy.mockResolvedValueOnce(
jsonResponse({
task_id: 'task-1',
status: 'Fail',
base_resp: {
status_code: 1027,
status_msg: 'output new_sensitive',
},
}),
);
await expect(
generate({ model: 'minimax-hailuo-2.3' }),
).rejects.toMatchObject({
statusCode: 400,
code: 'moderation_flagged',
});
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('fails when the finished H3 task has no video', async () => {
mockH3Flow(h3Task({ content: {} }));
await expect(generate({})).rejects.toThrow(/video URL/);
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('fails when the Hailuo file has no download URL', async () => {
fetchSpy.mockResolvedValueOnce(
jsonResponse({ task_id: 'task-1', base_resp: ok }),
);
fetchSpy.mockResolvedValueOnce(jsonResponse(hailuoTask('Success')));
fetchSpy.mockResolvedValueOnce(
jsonResponse({ file: { file_id: 1 }, base_resp: ok }),
);
await expect(generate({ model: 'minimax-hailuo-2.3' })).rejects.toThrow(
/video URL/,
);
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
});
@@ -0,0 +1,690 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import type { Actor } from '../../../../core/actor.js';
import { Context } from '../../../../core/context.js';
import { HttpError } from '../../../../core/http/HttpError.js';
import { insufficientCreditsError } from '../../../../services/metering/enforcement.js';
import type { CreditHold } from '../../../../services/metering/types.js';
import type { AiMeteringService } from '../../../util/aiCostFactor.js';
import { readBoundedBody } from '../../../util/fileInput.js';
import { toUrlOrDataUri } from '../../../util/imageInput.js';
import { sanitizeUpstreamMessage } from '../../../util/upstreamErrors.js';
import { capSecondsToRemainingCredits } from '../../creditCap.js';
import type { IGenerateVideoParams, IVideoModel } from '../../types.js';
import { VideoProvider } from '../VideoProvider.js';
import {
pollUntilSettled,
VIDEO_HOLD_TTL_MS,
videoJobFailure,
} from '../polling.js';
import {
MINIMAX_VIDEO_GENERATION_MODELS,
MINIMAX_VIDEO_SPECS,
type MiniMaxVideoSpec,
} from './models.js';
const DEFAULT_TEST_VIDEO_URL = 'https://assets.puter.site/txt2vid.mp4';
const DEFAULT_BASE_URL = 'https://api.minimax.io';
const DEFAULT_MODEL = 'minimax-h3';
const DEFAULT_POLL_INTERVAL_MS = 5_000;
const REQUEST_TIMEOUT_MS = 60_000;
const MAX_RESPONSE_BYTES = 1024 * 1024;
const PROVIDER = 'minimax';
const ASPECT_RATIOS = ['21:9', '16:9', '4:3', '1:1', '3:4', '9:16'];
const DEFAULT_ASPECT_RATIO = '16:9';
// MiniMax's business codes, from the trailing "(NNNN)" of a v2 error message
// or `base_resp.status_code` of a v1 reply.
// https://platform.minimax.io/docs/api-reference/errorcode
const AUTH_CODES = new Set([1004, 2049]);
const BALANCE_CODES = new Set([1008, 2053, 2056, 2067]);
const RATE_LIMIT_CODES = new Set([1002, 1039, 1041, 1045]);
const MODERATION_CODES = new Set([1026, 1027]);
const MODEL_UNAVAILABLE_CODES = new Set([2022, 2061, 2068, 2069]);
const INVALID_PARAM_CODES = new Set([2013, 2014]);
/** A 2013 about the model itself, which means the catalog has drifted. */
const UNSUPPORTED_MODEL_PATTERN =
/this model is not supported|incorrect model param/i;
type MiniMaxVideoConfig = {
apiKey: string;
apiBaseUrl?: string;
/** Test hook: polling cadence for task status checks. */
pollIntervalMs?: number;
};
interface MiniMaxEnvelope {
base_resp?: { status_code?: number; status_msg?: string };
error?: { type?: string; message?: string; http_code?: string };
}
interface H3Task {
id: string;
status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled';
content?: { url?: string };
error?: { code?: string; message?: string };
duration?: number;
usage?: { output_seconds?: number };
}
interface HailuoTask {
task_id?: string;
status?: 'Preparing' | 'Queueing' | 'Processing' | 'Success' | 'Fail';
file_id?: string;
}
const badRequest = (message: string) =>
new HttpError(400, message, { legacyCode: 'bad_request' });
const present = (value: unknown): boolean =>
value !== undefined && value !== null;
const statusForCode = (code: number, httpStatus: number): number => {
if (AUTH_CODES.has(code)) return 401;
if (BALANCE_CODES.has(code)) return 402;
if (RATE_LIMIT_CODES.has(code)) return 429;
if (INVALID_PARAM_CODES.has(code)) return 400;
return httpStatus >= 400 ? httpStatus : 502;
};
/** The code a v2 error message ends with, e.g. "invalid params (2013)". */
const parseCode = (message: string): number | undefined => {
const match = message.match(/\((\d{4,5})\)\s*$/);
return match ? Number.parseInt(match[1], 10) : undefined;
};
/** A request MiniMax refused, shaped for `translateProviderError`. */
const minimaxError = (
code: number | undefined,
message: string,
status: number,
): Error => {
// A model MiniMax doesn't serve is Puter's pick, so the catalog has
// drifted from MiniMax's: our fault, not the caller's, and worth
// someone's attention.
if (
code !== undefined &&
(MODEL_UNAVAILABLE_CODES.has(code) ||
(code === 2013 && UNSUPPORTED_MODEL_PATTERN.test(message)))
) {
return new HttpError(
502,
'MiniMax does not support the model Puter requested',
{
legacyCode: 'upstream_failed',
alarmSeverity: 'warning',
fields: {
provider: PROVIDER,
upstreamCode: String(code),
upstreamMessage: sanitizeUpstreamMessage(message),
},
},
);
}
if (code !== undefined && MODERATION_CODES.has(code)) {
return new HttpError(
400,
sanitizeUpstreamMessage(message) ||
'MiniMax rejected the request under its content policy',
{
legacyCode: 'bad_request',
code: 'moderation_flagged',
fields: { provider: PROVIDER, upstreamCode: String(code) },
},
);
}
// MiniMax's auth messages point at its own console; the caller can't act
// on them.
const isAuthFailure = code !== undefined && AUTH_CODES.has(code);
return Object.assign(
new Error(isAuthFailure ? 'MiniMax rejected the API key' : message),
{
status:
code === undefined
? status >= 400
? status
: 502
: statusForCode(code, status),
code: code === undefined ? undefined : String(code),
provider: PROVIDER,
},
);
};
/**
* MiniMax video generation (H3 and Hailuo).
*
* H3 models go through the v2 task API: a `content` list of text, frames and
* references creates a task that is polled until it leaves queued/running, and
* the clip's URL comes back on the task. Billing is per second of output at a
* rate set by resolution. Hailuo models go through the v1 API, which takes a
* prompt and frame images, is polled on its own status endpoint and hands back
* a file id to exchange for a download URL. They are billed per clip, by
* resolution and length.
* https://platform.minimax.io/docs/api-reference/video-generation-v2-create
*/
export class MiniMaxVideoProvider extends VideoProvider {
#apiKey: string;
#baseUrl: string;
#pollIntervalMs: number;
#meteringService: AiMeteringService;
constructor(
config: MiniMaxVideoConfig,
meteringService: AiMeteringService,
) {
super();
if (!config.apiKey) {
throw new Error('MiniMax video generation requires an API key');
}
this.#apiKey = config.apiKey;
// The shared chat block's base URL ends in the chat API's `/v1`; the
// video API lives beside it on the same host.
this.#baseUrl = (config.apiBaseUrl ?? DEFAULT_BASE_URL)
.replace(/\/+$/, '')
.replace(/\/v1$/, '');
this.#pollIntervalMs =
config.pollIntervalMs ?? DEFAULT_POLL_INTERVAL_MS;
this.#meteringService = meteringService;
}
getDefaultModel(): string {
return DEFAULT_MODEL;
}
models(): IVideoModel[] {
return MINIMAX_VIDEO_GENERATION_MODELS;
}
async generate(params: IGenerateVideoParams): Promise<unknown> {
const {
prompt,
model: requestedModel,
seconds,
duration,
size,
resolution,
width,
height,
input_reference: inputReference,
last_frame: lastFrame,
reference_images: referenceImages,
input_video: inputVideo,
test_mode: testMode,
} = params ?? {};
if (typeof prompt !== 'string' || !prompt.trim()) {
throw badRequest('prompt must be a non-empty string');
}
const model = this.#getModel(requestedModel);
const spec = MINIMAX_VIDEO_SPECS[model.id];
if (prompt.length > spec.maxPromptChars) {
throw badRequest(
`${model.id} takes a prompt of at most ${spec.maxPromptChars} characters`,
);
}
if (present(inputVideo)) {
throw badRequest(`${model.id} does not accept a source video`);
}
const resolutionKey = this.#resolution(size ?? resolution, model);
const firstFrame = this.#image(inputReference, 'input_reference');
const endFrame = this.#image(lastFrame, 'last_frame');
const references = this.#references(referenceImages);
this.#checkInputs(spec, model, resolutionKey, {
firstFrame,
endFrame,
references,
});
if (testMode) {
return DEFAULT_TEST_VIDEO_URL;
}
const actor = Context.get('actor') as Actor | undefined;
if (!actor) {
throw new HttpError(401, 'Authentication required', {
legacyCode: 'unauthorized',
});
}
const requestedSeconds =
this.#coerceSeconds(seconds ?? duration) ??
model.durationSeconds![0];
const aspectRatio = this.#aspectRatio(width, height);
const images = { firstFrame, endFrame, references };
if (spec.api === 'v2') {
return this.#generateH3(actor, model, spec, {
prompt,
resolutionKey,
requestedSeconds,
aspectRatio,
...images,
});
}
return this.#generateHailuo(actor, model, spec, {
prompt,
resolutionKey,
requestedSeconds,
...images,
});
}
// -- H3 (v2 task API, per second) ---------------------------------------
async #generateH3(
actor: Actor,
model: IVideoModel,
spec: MiniMaxVideoSpec,
input: {
prompt: string;
resolutionKey: string;
requestedSeconds: number;
aspectRatio: string | undefined;
firstFrame?: string;
endFrame?: string;
references: string[];
},
): Promise<string> {
const costKey = `per-second:${input.resolutionKey}`;
const centsPerSecond = model.costs?.[costKey];
if (!centsPerSecond) {
throw new Error(
`No pricing configured for video model ${model.id} at ${costKey}`,
);
}
const usageType = `minimax-video-generation:${model.id}:${costKey}`;
const { seconds: cappedSeconds, hold } =
await capSecondsToRemainingCredits({
metering: this.#meteringService,
actor,
usageType,
perSecondMicroCents: centsPerSecond * 1_000_000,
requestedSeconds: input.requestedSeconds,
allowedSeconds: model.durationSeconds,
});
try {
const content: Array<Record<string, unknown>> = [
{ type: 'text', text: input.prompt },
];
if (input.firstFrame) {
content.push({
type: 'image_url',
image_url: { url: input.firstFrame },
role: 'first_frame',
});
}
if (input.endFrame) {
content.push({
type: 'image_url',
image_url: { url: input.endFrame },
role: 'last_frame',
});
}
for (const url of input.references) {
content.push({
type: 'image_url',
image_url: { url },
role: 'reference_image',
});
}
const body: Record<string, unknown> = {
model: spec.apiModel,
content,
duration: cappedSeconds,
resolution: input.resolutionKey.toUpperCase(),
};
// A clip from frames takes their shape; MiniMax requires a ratio
// for everything else.
if (!input.firstFrame && !input.endFrame) {
body.ratio = input.aspectRatio ?? DEFAULT_ASPECT_RATIO;
}
const created = await this.#request<{ task_id?: string }>(
'POST',
'/v2/video_generation',
body,
);
if (!created.task_id) {
throw new Error('MiniMax response did not include a task id');
}
const task = await pollUntilSettled<H3Task>({
provider: PROVIDER,
providerLabel: 'MiniMax',
intervalMs: this.#pollIntervalMs,
fetch: async () => {
const { task } = await this.#request<{ task?: H3Task }>(
'GET',
`/v2/query/video_generation/${encodeURIComponent(created.task_id!)}`,
);
if (!task) {
throw new Error('MiniMax task query returned no task');
}
return task;
},
isPending: (task) =>
task.status === 'queued' || task.status === 'running',
});
if (task.status !== 'succeeded') {
throw videoJobFailure(
PROVIDER,
task.error?.message || `Video generation ${task.status}`,
task.error?.code,
);
}
const url = task.content?.url;
if (typeof url !== 'string' || !url.trim()) {
throw new Error('MiniMax response did not include a video URL');
}
// MiniMax bills the seconds of output the task reports.
const outputSeconds = task.usage?.output_seconds ?? task.duration;
const billedSeconds =
typeof outputSeconds === 'number' &&
Number.isFinite(outputSeconds) &&
outputSeconds > 0
? Math.max(1, Math.round(outputSeconds))
: cappedSeconds;
await this.#meteringService.incrementUsage(
actor,
usageType,
billedSeconds,
Math.round(billedSeconds * centsPerSecond * 1_000_000),
);
return url;
} finally {
await hold.release();
}
}
// -- Hailuo (v1 API, per clip) ------------------------------------------
async #generateHailuo(
actor: Actor,
model: IVideoModel,
spec: MiniMaxVideoSpec,
input: {
prompt: string;
resolutionKey: string;
requestedSeconds: number;
firstFrame?: string;
endFrame?: string;
},
): Promise<string> {
// A clip length the resolution doesn't offer falls back to the first
// one it does, the way the driver treats any unsupported duration.
const offered = (secs: number) =>
model.costs?.[`per-video:${input.resolutionKey}:${secs}`];
const clipSeconds = offered(input.requestedSeconds)
? input.requestedSeconds
: model.durationSeconds!.find(offered)!;
const costKey = `per-video:${input.resolutionKey}:${clipSeconds}`;
const centsPerVideo = model.costs![costKey]!;
const usageType = `minimax-video-generation:${model.id}:${costKey}`;
const microCents = centsPerVideo * 1_000_000;
const hold: CreditHold | null =
await this.#meteringService.reserveAiCredits(
actor,
usageType,
microCents,
{ ttlMs: VIDEO_HOLD_TTL_MS },
);
if (!hold) {
throw insufficientCreditsError();
}
try {
const body: Record<string, unknown> = {
model: spec.apiModel,
prompt: input.prompt,
duration: clipSeconds,
resolution: input.resolutionKey.toUpperCase(),
};
if (input.firstFrame) body.first_frame_image = input.firstFrame;
if (input.endFrame) body.last_frame_image = input.endFrame;
const created = await this.#request<{ task_id?: string }>(
'POST',
'/v1/video_generation',
body,
);
if (!created.task_id) {
throw new Error('MiniMax response did not include a task id');
}
const task = await pollUntilSettled<HailuoTask>({
provider: PROVIDER,
providerLabel: 'MiniMax',
intervalMs: this.#pollIntervalMs,
fetch: () =>
this.#request<HailuoTask>(
'GET',
`/v1/query/video_generation?task_id=${encodeURIComponent(created.task_id!)}`,
),
isPending: (task) =>
task.status === 'Preparing' ||
task.status === 'Queueing' ||
task.status === 'Processing',
});
if (task.status !== 'Success' || !task.file_id) {
throw videoJobFailure(
PROVIDER,
'MiniMax video generation failed',
);
}
// The clip is a file in MiniMax's store; its download link is
// minted on request and works for an hour.
const { file } = await this.#request<{
file?: { download_url?: string };
}>(
'GET',
`/v1/files/retrieve?file_id=${encodeURIComponent(task.file_id)}`,
);
const url = file?.download_url;
if (typeof url !== 'string' || !url.trim()) {
throw new Error('MiniMax response did not include a video URL');
}
await this.#meteringService.incrementUsage(
actor,
usageType,
1,
microCents,
);
return url;
} finally {
await hold.release();
}
}
// -- Validation ---------------------------------------------------------
#checkInputs(
spec: MiniMaxVideoSpec,
model: IVideoModel,
resolutionKey: string,
inputs: {
firstFrame?: string;
endFrame?: string;
references: string[];
},
) {
const { firstFrame, endFrame, references } = inputs;
if (spec.firstFrameRequired && !firstFrame) {
throw badRequest(`${model.id} requires an input_reference image`);
}
if (endFrame && !spec.lastFrame) {
throw badRequest(`${model.id} does not support last_frame`);
}
if (endFrame && !firstFrame && spec.api === 'v1') {
throw badRequest(
'last_frame requires a first-frame image via input_reference',
);
}
if (references.length > 0) {
if (!spec.references) {
throw badRequest(
`${model.id} does not support reference_images`,
);
}
if (firstFrame || endFrame) {
throw badRequest(
'reference_images cannot be combined with input_reference or last_frame',
);
}
}
const imageCount =
(firstFrame ? 1 : 0) + (endFrame ? 1 : 0) + references.length;
if (imageCount > spec.maxImages) {
throw badRequest(
`${model.id} takes at most ${spec.maxImages} image(s), frames and references together`,
);
}
if (
spec.imageOnlyResolutions?.includes(resolutionKey) &&
(!firstFrame || endFrame)
) {
throw badRequest(
`${model.id} renders ${resolutionKey} only from an input_reference image without last_frame`,
);
}
}
async #request<T>(
method: 'GET' | 'POST',
path: string,
body?: Record<string, unknown>,
): Promise<T> {
const response = await fetch(`${this.#baseUrl}${path}`, {
method,
headers: {
Authorization: `Bearer ${this.#apiKey}`,
...(body ? { 'Content-Type': 'application/json' } : {}),
},
...(body ? { body: JSON.stringify(body) } : {}),
signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS),
});
const raw = await readBoundedBody(response, MAX_RESPONSE_BYTES, () =>
minimaxError(undefined, 'MiniMax response too large', 502),
);
let payload: MiniMaxEnvelope = {};
try {
const parsed: unknown = JSON.parse(raw.toString('utf8'));
if (parsed && typeof parsed === 'object') {
payload = parsed as MiniMaxEnvelope;
}
} catch {
// Not JSON; the status alone decides.
}
// A v1 reply carries its verdict in `base_resp` under HTTP 200; a v2
// reply uses the HTTP status and an OpenAI-style `error`.
const v1Code = payload.base_resp?.status_code;
if (typeof v1Code === 'number' && v1Code !== 0) {
throw minimaxError(
v1Code,
payload.base_resp?.status_msg ||
`MiniMax request failed (code ${v1Code})`,
response.status,
);
}
if (!response.ok) {
const message =
payload.error?.message ||
`MiniMax request failed (status ${response.status})`;
throw minimaxError(parseCode(message), message, response.status);
}
return payload as unknown as T;
}
#getModel(requestedModel?: string): IVideoModel {
const wanted = (requestedModel ?? '').trim().toLowerCase();
return (
MINIMAX_VIDEO_GENERATION_MODELS.find(
(m) =>
m.id === wanted ||
m.puterId === wanted ||
m.aliases?.includes(wanted),
) ??
MINIMAX_VIDEO_GENERATION_MODELS.find((m) => m.id === DEFAULT_MODEL)!
);
}
#resolution(candidate: unknown, model: IVideoModel): string {
const tiers = model.dimensions!;
if (typeof candidate === 'string') {
const wanted = candidate.trim().toLowerCase();
if (tiers.includes(wanted)) return wanted;
}
return tiers[0];
}
/** An image as MiniMax takes it: a URL or a data URI. */
#image(value: unknown, label: string): string | undefined {
if (!present(value)) return undefined;
if (typeof value !== 'string' || !value.trim()) {
throw badRequest(
`${label} must be an image URL, data URI or base64`,
);
}
return toUrlOrDataUri(value);
}
#references(value: unknown): string[] {
if (!present(value)) return [];
if (!Array.isArray(value)) {
throw badRequest('reference_images must be an array');
}
return value.map((image) => this.#image(image, 'reference_images')!);
}
#coerceSeconds(value: unknown): number | undefined {
const numeric =
typeof value === 'string' ? Number.parseInt(value, 10) : value;
return typeof numeric === 'number' &&
Number.isFinite(numeric) &&
numeric > 0
? Math.round(numeric)
: undefined;
}
/** Snap width/height to one of MiniMax's aspect ratios. */
#aspectRatio(width?: number, height?: number): string | undefined {
if (
typeof width !== 'number' ||
typeof height !== 'number' ||
!Number.isFinite(width) ||
!Number.isFinite(height) ||
width <= 0 ||
height <= 0
) {
return undefined;
}
const gcd = (a: number, b: number): number =>
b === 0 ? a : gcd(b, a % b);
const w = Math.round(width);
const h = Math.round(height);
const d = gcd(w, h) || 1;
const candidate = `${w / d}:${h / d}`;
// Other ratios are left to the 16:9 default.
return ASPECT_RATIOS.includes(candidate) ? candidate : undefined;
}
}
@@ -0,0 +1,234 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import type { IVideoModel } from '../../types.js';
/** MiniMax-specific model behavior the shared IVideoModel shape can't carry. */
export interface MiniMaxVideoSpec {
/** The model name as MiniMax spells it on the wire. */
apiModel: string;
/**
* `v2`: the H3 task API, billed per second of output. `v1`: the Hailuo API,
* billed per clip, whose result is fetched through a file id.
*/
api: 'v1' | 'v2';
/**
* Frames and reference images together. MiniMax charges per image above
* this quota, so more are refused rather than billed.
*/
maxImages: number;
/** Whether `reference_images` are taken (H3 reference-to-video). */
references: boolean;
firstFrameRequired?: boolean;
lastFrame: boolean;
/** Resolutions MiniMax renders only from a first frame. */
imageOnlyResolutions?: string[];
maxPromptChars: number;
}
// Duration ladder for the driver's normalization: element 0 is the fallback
// default, the rest enumerate the model's contiguous valid range.
const seconds = (def: number, min: number, max: number): number[] => [
def,
...Array.from({ length: max - min + 1 }, (_, i) => min + i).filter(
(s) => s !== def,
),
];
// Prices from https://platform.minimax.io/docs/guides/pricing-video. H3 models
// are per second of output, keyed `per-second:<resolution>`; Hailuo models are
// per clip, keyed `per-video:<resolution>:<seconds>`, and a key's absence means
// the model doesn't offer that combination. `default-duration-per-video` is
// the default clip at the default resolution, for cross-provider sorting and
// display only.
export const MINIMAX_VIDEO_GENERATION_MODELS: IVideoModel[] = [
{
id: 'minimax-h3',
puterId: 'minimax:minimax/minimax-h3',
name: 'MiniMax H3',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-second:768p': 8,
'per-second:2k': 13,
'default-duration-per-video': 40,
},
durationSeconds: seconds(5, 4, 15),
dimensions: ['768p', '2k'],
fps: [24],
},
{
id: 'minimax-h3-highspeed',
puterId: 'minimax:minimax/minimax-h3-highspeed',
name: 'MiniMax H3 Highspeed',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-second:768p': 6,
'default-duration-per-video': 30,
},
durationSeconds: seconds(5, 4, 15),
dimensions: ['768p'],
fps: [24],
},
{
id: 'minimax-h3-lite',
puterId: 'minimax:minimax/minimax-h3-lite',
name: 'MiniMax H3 Lite',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-second:768p': 4,
'per-second:480p': 2.5,
'default-duration-per-video': 20,
},
durationSeconds: seconds(5, 4, 15),
dimensions: ['768p', '480p'],
fps: [24],
},
{
id: 'minimax-h3-max',
puterId: 'minimax:minimax/minimax-h3-max',
name: 'MiniMax H3 Max',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-second:768p': 8,
'per-second:480p': 5,
'default-duration-per-video': 40,
},
durationSeconds: seconds(5, 5, 15),
dimensions: ['768p', '480p'],
fps: [24],
},
{
id: 'minimax-hailuo-2.3',
puterId: 'minimax:minimax/minimax-hailuo-2.3',
name: 'MiniMax Hailuo 2.3',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-video:768p:6': 28,
'per-video:768p:10': 56,
'per-video:1080p:6': 49,
'default-duration-per-video': 28,
},
durationSeconds: [6, 10],
dimensions: ['768p', '1080p'],
fps: [24],
},
{
id: 'minimax-hailuo-2.3-fast',
puterId: 'minimax:minimax/minimax-hailuo-2.3-fast',
name: 'MiniMax Hailuo 2.3 Fast',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-video:768p:6': 19,
'per-video:768p:10': 32,
'per-video:1080p:6': 33,
'default-duration-per-video': 19,
},
durationSeconds: [6, 10],
dimensions: ['768p', '1080p'],
fps: [24],
},
{
id: 'minimax-hailuo-02',
puterId: 'minimax:minimax/minimax-hailuo-02',
name: 'MiniMax Hailuo 02',
costs_currency: 'usd-cents',
output_cost_key: 'default-duration-per-video',
costs: {
'per-video:768p:6': 28,
'per-video:768p:10': 56,
'per-video:1080p:6': 49,
'per-video:512p:6': 10,
'per-video:512p:10': 15,
'default-duration-per-video': 28,
},
durationSeconds: [6, 10],
dimensions: ['768p', '1080p', '512p'],
fps: [24],
},
];
// Capabilities per https://platform.minimax.io/docs/api-reference/video-generation-v2-create
// (H3) and the text-, image- and frames-to-video pages under
// https://platform.minimax.io/docs/api-reference/video-generation-t2v (Hailuo).
export const MINIMAX_VIDEO_SPECS: Record<string, MiniMaxVideoSpec> = {
'minimax-h3': {
apiModel: 'MiniMax-H3',
api: 'v2',
maxImages: 5,
references: true,
lastFrame: true,
maxPromptChars: 7000,
},
'minimax-h3-highspeed': {
apiModel: 'MiniMax-H3-Highspeed',
api: 'v2',
maxImages: 5,
references: true,
lastFrame: true,
maxPromptChars: 7000,
},
'minimax-h3-lite': {
apiModel: 'MiniMax-H3-Lite',
api: 'v2',
maxImages: 5,
references: true,
lastFrame: true,
maxPromptChars: 7000,
},
'minimax-h3-max': {
apiModel: 'MiniMax-H3-Max',
api: 'v2',
maxImages: 2,
references: true,
lastFrame: true,
maxPromptChars: 7000,
},
'minimax-hailuo-2.3': {
apiModel: 'MiniMax-Hailuo-2.3',
api: 'v1',
maxImages: 1,
references: false,
lastFrame: false,
maxPromptChars: 2000,
},
'minimax-hailuo-2.3-fast': {
apiModel: 'MiniMax-Hailuo-2.3-Fast',
api: 'v1',
maxImages: 1,
references: false,
firstFrameRequired: true,
lastFrame: false,
maxPromptChars: 2000,
},
'minimax-hailuo-02': {
apiModel: 'MiniMax-Hailuo-02',
api: 'v1',
maxImages: 2,
references: false,
lastFrame: true,
imageOnlyResolutions: ['512p'],
maxPromptChars: 2000,
},
};
@@ -30,6 +30,7 @@
* a test file.
*/
import type { EventClient } from '../clients/event/EventClient.js';
import { translateProviderError } from '../controllers/drivers/DriverController.js';
import type { Actor } from '../core/actor.js';
import { SYSTEM_ACTOR, makeActor } from '../core/actor.js';
@@ -60,6 +61,23 @@ export const skipUnlessEnv = (name: string): boolean => !optionalEnv(name);
*/
export const INTEGRATION_TEST_TIMEOUT_MS = 90_000;
/** Runs `fn` with every AI driver's cost factor hooked to `factor`. */
export const withAiCostFactorHook = async <T>(
events: EventClient,
factor: number,
fn: () => Promise<T>,
): Promise<T> => {
const hook = (_key: string, event: { factor: number }) => {
event.factor = factor;
};
events.on('ai.cost.factor.*', hook);
try {
return await fn();
} finally {
events.off('ai.cost.factor.*', hook);
}
};
/**
* Returns a no-op MeteringService stub. Real metering would write to DynamoDB /
* Redis, which integration tests for AI providers don't care about — we just
File diff suppressed because it is too large. Load diff
@@ -14,7 +14,10 @@ import {
APP_DATA_KV_METHOD_OPS,
appDataPermission,
} from '../../services/permission/appDataScopes.ts';
import { kvNamespace } from '../../stores/systemKv/SystemKVStore.ts';
import { createTestUser, setupTestServer } from '../../testUtil.ts';
import type { IConfig } from '../../types.ts';
import { sealCursor, unsealCursor } from '../../util/pagination.ts';
import { KV_COSTS } from './costs.ts';
import type { KVStoreDriver } from './KVStoreDriver.ts';
import {
@@ -1552,6 +1555,301 @@ describe('KVStoreDriver', () => {
expect(own).toContain('token');
});
// -- Cross-app cursors ----------------------------------------------
const secret = () =>
(target as unknown as { config: IConfig }).config.jwt_secret_v2;
/** A cursor as the server reads it, its key decoded, or null. */
const opened = (cursor: string) => {
const payload = unsealCursor(cursor, secret());
return payload
? {
...payload,
k: Buffer.from(String(payload.k), 'base64url').toString(
'utf8',
),
}
: null;
};
/** Everything a cursor shows to the server and to a base64 decoder. */
const revealed = (cursor: string) =>
[
JSON.stringify(opened(cursor)),
Buffer.from(cursor, 'base64').toString('utf8'),
Buffer.from(cursor, 'base64url').toString('utf8'),
].join('\n');
const encode = (payload: unknown) =>
Buffer.from(JSON.stringify(payload)).toString('base64');
type Page = { items: string[]; cursor?: string; total?: number };
const writeAs = (
actorForCall: Actor,
key: string,
disableSharing = false,
) =>
inCtx(
() =>
target.set({
key,
value: key,
...(disableSharing
? { optConfig: { disableSharing: true } }
: {}),
}),
actorForCall,
);
it('resumes a cross-app page after a private entry it skipped, padding every cursor to one length', async () => {
const { owner, calendar, contacts, calendarActor, contactsActor } =
await setup();
await writeAs(contactsActor, 'a-hidden-oauth-token-name', true);
await writeAs(contactsActor, 'b');
await writeAs(contactsActor, 'c-a-much-longer-public-key-name');
await grant(owner, calendar.uid, appDataPermission(contacts.uid));
const page = (cursor?: string) =>
crossApp(calendarActor, contacts.uid, (optConfig) =>
target.list({
as: 'keys',
limit: 1,
...(cursor ? { cursor } : {}),
optConfig,
}),
) as Promise<Page>;
// The scan's first row is the private one.
const first = await page();
expect(first.items).toEqual(['b']);
expect(revealed(first.cursor!)).not.toContain('hidden-oauth');
expect(opened(first.cursor!)?.k).toBe('b');
const second = await page(first.cursor);
expect(second.items).toEqual(['c-a-much-longer-public-key-name']);
expect(second.cursor!.length).toBe(first.cursor!.length);
});
// Over a thousand writes and reads: slow when the whole suite runs.
it('pads a cursor left on a long run of private entries to the same length', async () => {
const { owner, calendar, contacts, calendarActor, contactsActor } =
await setup();
// More than one call reads past, so the page ends on a hidden row.
const hidden = Array.from(
{ length: 1100 },
(_, i) => `h-hidden-${String(i).padStart(4, '0')}`,
);
for (let at = 0; at < hidden.length; at += 1000)
await inCtx(
() =>
target.batchPut({
items: hidden
.slice(at, at + 1000)
.map((key) => ({ key, value: 1 })),
optConfig: { disableSharing: true },
}),
contactsActor,
);
await writeAs(contactsActor, 'z');
await grant(owner, calendar.uid, appDataPermission(contacts.uid));
const keys: string[] = [];
const cursors: string[] = [];
let emptyPages = 0;
let cursor: string | undefined;
for (let pages = 0; pages < 10; pages++) {
const page = (await crossApp(
calendarActor,
contacts.uid,
(optConfig) =>
target.list({
as: 'keys',
limit: 1,
...(cursor ? { cursor } : {}),
optConfig,
}),
)) as Page;
keys.push(...page.items);
if (page.items.length === 0) emptyPages++;
cursor = page.cursor;
if (!cursor) break;
cursors.push(cursor);
expect(
Buffer.from(cursor, 'base64').toString('utf8'),
).not.toContain('h-hidden');
}
expect(keys).toEqual(['entry', 'z']);
expect(emptyPages).toBeGreaterThan(0);
expect(new Set(cursors.map((c) => c.length)).size).toBe(1);
}, 30_000);
describe('paging a namespace with private entries in it', () => {
// Lengths differ, so an unpadded cursor would show which it is.
const PUBLIC = [
'entry',
'k1',
'k3-longer',
'k4',
'k6-longest-of-all',
];
const PRIVATE = ['k2', 'k5', 'k7', 'k8'];
const seeded = async () => {
const fixture = await setup();
for (const key of PUBLIC.slice(1))
await writeAs(fixture.contactsActor, key);
for (const key of PRIVATE)
await writeAs(fixture.contactsActor, key, true);
await grant(
fixture.owner,
fixture.calendar.uid,
appDataPermission(fixture.contacts.uid),
);
return fixture;
};
it.each(
[false, true].flatMap((reverse) =>
[false, true].map((includeTotal) => ({
reverse,
includeTotal,
})),
),
)(
'returns every public entry once, reverse $reverse, includeTotal $includeTotal',
async ({ reverse, includeTotal }) => {
const { contacts, calendarActor } = await seeded();
const keys: string[] = [];
const lengths = new Set<number>();
let cursor: string | undefined;
let pages = 0;
do {
const page = (await crossApp(
calendarActor,
contacts.uid,
(optConfig) =>
target.list({
as: 'keys',
limit: 2,
...(reverse ? { reverse } : {}),
...(includeTotal ? { includeTotal } : {}),
...(cursor ? { cursor } : {}),
optConfig,
}),
)) as Page;
keys.push(...page.items);
if (includeTotal)
expect(page.total).toBe(PUBLIC.length);
cursor = page.cursor;
if (cursor) {
lengths.add(cursor.length);
const position = opened(cursor);
expect(position).not.toBeNull();
expect(PRIVATE).not.toContain(position!.k);
}
pages++;
} while (cursor && pages < 10);
expect(keys).toEqual(
reverse ? [...PUBLIC].reverse() : PUBLIC,
);
expect(lengths.size).toBe(1);
},
);
it('still reads a plain cursor from before they were sealed, and seals the next one', async () => {
const { owner, contacts, calendarActor } = await seeded();
const namespace = kvNamespace(owner.user.uuid!, contacts.uid);
const list = (cursor: unknown, limit = 10) =>
crossApp(calendarActor, contacts.uid, (optConfig) =>
target.list({ as: 'keys', limit, cursor, optConfig }),
) as Promise<Page>;
expect(
(await list(encode({ namespace, key: 'k1' }))).items,
).toEqual(PUBLIC.slice(2));
expect(
(
await list(
encode({
reverse: true,
key: { namespace, key: 'k4' },
}),
)
).items,
).toEqual(PUBLIC.slice(0, 3).reverse());
const next = await list(encode({ namespace, key: 'k1' }), 1);
expect(next.items).toEqual(['k3-longer']);
expect(opened(next.cursor!)).toMatchObject({ k: 'k3-longer' });
});
it('refuses a plain or sealed cursor for another namespace', async () => {
const { owner, calendar, contacts, calendarActor } =
await seeded();
const other = await makeRealApp(owner.user.id!);
await writeAs(asApp(owner, other), 'k1');
await writeAs(asApp(owner, other), 'k2');
await grant(owner, calendar.uid, appDataPermission(other.uid));
const fromOther = (
(await crossApp(calendarActor, other.uid, (optConfig) =>
target.list({ as: 'keys', limit: 1, optConfig }),
)) as Page
).cursor!;
await writeAs(calendarActor, 'own-1');
await writeAs(calendarActor, 'own-2');
const ownCursor = (
(await inCtx(
() => target.list({ as: 'keys', limit: 1 }),
calendarActor,
)) as Page
).cursor!;
const elsewhere = kvNamespace(owner.user.uuid!, other.uid);
const stranger = kvNamespace('someone-else', contacts.uid);
const forged: unknown[] = [
fromOther,
encode({ namespace: elsewhere, key: 'k1' }),
encode({ namespace: stranger, key: 'k1' }),
{ namespace: elsewhere, key: 'k1' },
encode({
reverse: true,
key: { namespace: elsewhere, key: 'k1' },
}),
encode({
namespace: kvNamespace(owner.user.uuid!, contacts.uid),
key: 'k1',
extra: true,
}),
sealCursor({ id: 1 }, secret()),
sealCursor(
{
s: elsewhere,
k: Buffer.from('k1').toString('base64url'),
},
secret(),
),
ownCursor,
];
for (const cursor of forged)
await expect(
crossApp(calendarActor, contacts.uid, (optConfig) =>
target.list({
as: 'keys',
limit: 1,
cursor,
optConfig,
}),
),
JSON.stringify(cursor),
).rejects.toMatchObject({
statusCode: 400,
message: 'invalid kv: cursor',
});
});
});
it('refuses cross-app writes and deletes against a private entry', async () => {
const { owner, calendar, contacts, calendarActor, contactsActor } =
await setup();
+550 -78
View File
@@ -32,9 +32,29 @@ import {
appDataPermission,
appDataSharingAllowed,
} from '../../services/permission/appDataScopes.js';
import type { KVOpts, KVUsage } from '../../stores/systemKv/SystemKVStore.js';
import {
KV_GLOBAL_APP_KEY,
KV_MAX_KEY_BYTES,
kvNamespace,
type KVOpts,
type KVUsage,
} from '../../stores/systemKv/SystemKVStore.js';
import { KV_SHARE_HANDLE_WIDTHS } from '../../stores/events/columnWidths.js';
import { assertActorHasCredits } from '../../services/metering/enforcement.js';
import { normalizeLimit } from '../../util/pagination.js';
import { isKvHandleId } from '../../services/events/subjects.js';
import {
KV_HANDLE_KEY_MAX_BYTES,
KV_SHARE_PREFIX_MAX_BYTES,
kvHandlesDisabled,
kvShareLevelForMethod,
kvSharePermission,
} from '../../services/kvShare/kvShares.js';
import {
decodeCursor,
normalizeLimit,
sealCursor,
unsealCursor,
} from '../../util/pagination.js';
import { KV_COSTS } from './costs.js';
import {
KV_MAX_BATCH_PUT_ITEMS,
@@ -42,16 +62,143 @@ import {
KV_MAX_LIST_LIMIT,
} from './limits.js';
/** `optConfig` as every KV method takes it. */
interface KvOptConfig {
/** Another app's namespace, which the user let this app reach. */
appUuid?: string;
/** Writes the entry private to the app that wrote it. */
disableSharing?: boolean;
/**
* A share handle: the call reaches that region of its owner's data, with
* keys relative to it.
*/
handle?: string;
/** `set` only: write only when no live entry holds the key. */
onlyIfAbsent?: boolean;
}
/**
* Every KV method's argument object, as far as option resolution cares: the
* namespace override, plus the expiry parameters that can delete an entry.
*/
type KvCallArgs = {
optConfig?: { appUuid?: string; disableSharing?: boolean };
optConfig?: KvOptConfig;
expireAt?: unknown;
ttl?: unknown;
};
/**
* Store options plus, for a call through a share handle, the handle and its
* region's prefix: keys go in under it and come back out relative to it.
*/
type DriverKvOpts = KVOpts & { handle?: string; handlePrefix?: string };
type KvListResult =
| unknown[]
| { items: unknown[]; cursor?: string; total?: number };
/**
* A listing of another namespace, cross-app or through a handle: what its
* cursors are sealed to, the namespace a position rebuilds in, and the prefix
* its keys are relative to.
*/
interface ForeignListing {
bind: string;
namespace: string;
prefix: string;
/** Cross-app cursors were plain before they were sealed. */
acceptsPlain: boolean;
}
/**
* Plaintext bytes a foreign listing's cursor is padded to: a key at the store's
* limit in base64url, plus room for the binding and the envelope.
*/
const FOREIGN_CURSOR_BYTES = Math.ceil((KV_MAX_KEY_BYTES * 4) / 3) + 256;
/** Whether `value` is a store position, `{ namespace, key }`, in `namespace`. */
const isPositionIn = (value: unknown, namespace: string): boolean => {
if (!value || typeof value !== 'object' || Array.isArray(value))
return false;
const { namespace: named, key, ...rest } = value as Record<string, unknown>;
return (
named === namespace &&
typeof key === 'string' &&
Object.keys(rest).length === 0
);
};
// -- Share-handle errors ----------------------------------------------
/**
* Unknown, retired, not the caller's, owner gone or suspended, or namespace app
* deleted: one body for all of them, so no call can tell them apart.
*/
const handleNotFound = (): HttpError =>
new HttpError(404, 'kv: no such share handle', {
legacyCode: 'kv_handle_not_found',
});
/** Only ever told to the handle's holder. */
const handleAccessDenied = (): HttpError =>
new HttpError(403, 'kv: this share handle does not allow this call', {
legacyCode: 'kv_handle_access_denied',
});
const handleOptionInvalid = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'kv_handle_option_invalid' });
const handleKeyInvalid = (): HttpError =>
new HttpError(
400,
`kv: a key used with a share handle must be a non-empty string of at most ${KV_HANDLE_KEY_MAX_BYTES} bytes`,
{ legacyCode: 'kv_handle_key_invalid' },
);
/** The key limit, so no pattern length can tell how long the prefix is. */
const handlePatternInvalid = (): HttpError =>
new HttpError(
400,
`kv: a pattern used with a share handle may be at most ${KV_HANDLE_KEY_MAX_BYTES} bytes`,
{ legacyCode: 'kv_handle_key_invalid' },
);
const invalidCursor = (): HttpError =>
new HttpError(400, 'invalid kv: cursor', { legacyCode: 'bad_request' });
/** A stored key outside the handle's region, which a scan can't return. */
const outsideRegion = (): HttpError =>
new HttpError(500, 'kv: internal error', { legacyCode: 'internal_error' });
const viaHandle = (args?: KvCallArgs): boolean =>
args?.optConfig?.handle !== undefined && args.optConfig.handle !== null;
/** `onlyIfAbsent` as a boolean, refusing anything else a raw body sends. */
const parseOnlyIfAbsent = (value: unknown): boolean => {
if (value === undefined || value === null || value === false) return false;
if (value === true) return true;
throw new HttpError(400, 'kv: onlyIfAbsent must be a boolean', {
legacyCode: 'bad_request',
});
};
/**
* A store error with every stored key it names put back the way the caller
* named it, so the handle's prefix never leaves in a message.
*/
const relativizeError = (
err: unknown,
prefix: string,
keys: readonly string[],
): unknown => {
if (!(err instanceof Error) || typeof err.message !== 'string') return err;
let message = err.message;
for (const key of keys)
message = message.split(`${prefix}${key}`).join(key);
if (message !== err.message) err.message = message;
return err;
};
/**
* Methods that stay available to an account with nothing left of its budget.
* Each one only ever reduces what the account is storing, and turning those
@@ -141,13 +288,25 @@ export class KVStoreDriver extends PuterDriver {
}));
}
#coerceKey(key: unknown): string {
/**
* A key as the caller sent it. Through a handle it is relative to the
* region, and held to the handle's own fixed limit.
*/
#coerceKey(key: unknown, args?: KvCallArgs): string {
if (key === null || key === undefined) {
throw new HttpError(400, 'Missing `key`', {
legacyCode: 'bad_request',
}); // legacyCode for backward compatibility with old error handling in controllers
}
const str = typeof key === 'string' ? key : String(key);
if (viaHandle(args)) {
if (
str === '' ||
Buffer.byteLength(str, 'utf8') > KV_HANDLE_KEY_MAX_BYTES
)
throw handleKeyInvalid();
return str;
}
if (str === '')
throw new HttpError(400, 'Missing `key`', {
legacyCode: 'bad_request',
@@ -155,7 +314,38 @@ export class KVStoreDriver extends PuterDriver {
return str;
}
async #opts(method: string, args: KvCallArgs): Promise<KVOpts> {
/** The key as stored: through a handle, placed under its prefix. */
#storeKey(key: string, opts: DriverKvOpts): string {
return opts.handlePrefix === undefined
? key
: `${opts.handlePrefix}${key}`;
}
/** A stored key as a handle's caller names it; fails closed outside it. */
#relativeKey(key: unknown, prefix: string): string {
if (typeof key !== 'string' || !key.startsWith(prefix))
throw outsideRegion();
return key.slice(prefix.length);
}
/**
* Run one store call. Through a handle, an error naming a stored key names
* the caller's relative key instead.
*/
async #inRegion<T>(
opts: DriverKvOpts,
keys: readonly string[],
call: () => Promise<T>,
): Promise<T> {
if (opts.handlePrefix === undefined) return call();
try {
return await call();
} catch (err) {
throw relativizeError(err, opts.handlePrefix, keys);
}
}
async #opts(method: string, args: KvCallArgs): Promise<DriverKvOpts> {
const actor = Context.get('actor') as Actor | undefined;
// Every method resolves its options here first, so this is the one
@@ -170,6 +360,8 @@ export class KVStoreDriver extends PuterDriver {
);
}
if (viaHandle(args)) return this.#handleOpts(actor, method, args);
const appUuid = args.optConfig?.appUuid;
// Through the issuer chain, not `actor.app`: an access-token actor
// carries no app of its own, so keying off `app` would read a token an
@@ -198,6 +390,214 @@ export class KVStoreDriver extends PuterDriver {
return { actor, namespaceAppUuid: appUuid };
}
/**
* A call through a share handle, resolved to the owner's namespace. The
* handle row only names the region and whose it is; the grant, checked here
* on every call, is the authority. One check covers every key of the call,
* since they all sit under the handle's prefix.
*/
async #handleOpts(
actor: Actor | undefined,
method: string,
args: KvCallArgs,
): Promise<DriverKvOpts> {
if (this.config.kv?.shareHandles !== true) throw kvHandlesDisabled();
const optConfig = args.optConfig ?? {};
const level = kvShareLevelForMethod(method);
if (optConfig.appUuid || optConfig.disableSharing)
throw handleOptionInvalid(
'kv: `handle` cannot be combined with `appUuid` or `disableSharing`',
);
if (level === null)
throw handleOptionInvalid(
`kv: \`${method}\` is not available through a share handle`,
);
const handle: unknown = optConfig.handle;
if (typeof handle !== 'string')
throw handleOptionInvalid('kv: `handle` must be a string');
const userId = actor?.user?.id;
if (
!actor ||
typeof userId !== 'number' ||
handle.length > KV_SHARE_HANDLE_WIDTHS.handle.max ||
!isKvHandleId(handle)
)
throw handleNotFound();
const live = await this.stores.kvShareHandle.getLive(handle);
if (!live || live.ownerSuspended) throw handleNotFound();
const { row, ownerUuid } = live;
// Bound to its grantee: a handle id is an address, not a bearer
// credential, so another holder's overlapping grant doesn't reach it.
if (userId !== row.granteeUserId && userId !== row.ownerUserId)
throw handleNotFound();
// Side by side, so the app lookup costs no round trip of its own.
const [appGone, allowed] = await Promise.all([
row.appUid === KV_GLOBAL_APP_KEY
? false
: this.stores.app.getByUid(row.appUid).then((app) => !app),
this.services.permission.check(
actor,
kvSharePermission(ownerUuid, row.appUid, row.keyPrefix, level),
),
]);
if (appGone) throw handleNotFound();
if (!allowed) {
// Asked only on the way out: whoever can still watch the region
// is its holder, and only they may learn the level is too low.
const holds = await this.services.permission.check(
actor,
kvSharePermission(
ownerUuid,
row.appUid,
row.keyPrefix,
'watch',
),
);
throw holds ? handleAccessDenied() : handleNotFound();
}
// Past the cap only a watch handle can be, reached through a wider
// grant; the fixed key limit holders are shown assumes the cap.
if (
Buffer.byteLength(row.keyPrefix, 'utf8') > KV_SHARE_PREFIX_MAX_BYTES
)
throw handleAccessDenied();
return {
actor,
namespaceUser: { uuid: ownerUuid, id: row.ownerUserId },
namespaceAppUuid: row.appUid,
handle,
handlePrefix: row.keyPrefix,
};
}
/** Set when a listing covers another namespace, cross-app or by handle. */
#foreignListing(opts: DriverKvOpts): ForeignListing | undefined {
if (opts.handle !== undefined)
return {
bind: opts.handle,
namespace: kvNamespace(
opts.namespaceUser!.uuid,
opts.namespaceAppUuid!,
),
prefix: opts.handlePrefix!,
acceptsPlain: false,
};
if (!opts.namespaceAppUuid) return undefined;
const namespace = kvNamespace(
opts.actor!.user.uuid!,
opts.namespaceAppUuid,
);
return { bind: namespace, namespace, prefix: '', acceptsPlain: true };
}
/**
* A foreign listing's cursor as a store position, rebuilt in the listing's
* own namespace and region. Only a cursor sealed to this listing opens, or
* a plain cross-app one naming the same namespace.
*/
#cursorIn(
cursor: unknown,
listing: ForeignListing,
): Record<string, unknown> | undefined {
if (cursor === undefined || cursor === null) return undefined;
if (typeof cursor === 'string') {
if (cursor.trim() === '') return undefined;
const sealed = unsealCursor(
cursor.trim(),
this.config.jwt_secret_v2,
);
if (sealed) {
const { s, k, r, ...rest } = sealed;
if (
s !== listing.bind ||
typeof k !== 'string' ||
(r !== undefined && r !== true) ||
Object.keys(rest).length > 0
)
throw invalidCursor();
const position = {
namespace: listing.namespace,
key: `${listing.prefix}${Buffer.from(k, 'base64url').toString('utf8')}`,
};
return r ? { reverse: true, key: position } : position;
}
} else if (typeof cursor !== 'object') throw invalidCursor();
if (!listing.acceptsPlain) throw invalidCursor();
const plain = decodeCursor(
cursor as string | Record<string, unknown>,
'kv: cursor',
);
if (plain === undefined || isPositionIn(plain, listing.namespace))
return plain;
const { reverse, key, ...rest } = plain;
if (
reverse === true &&
Object.keys(rest).length === 0 &&
isPositionIn(key, listing.namespace)
)
return plain;
throw invalidCursor();
}
/**
* The store's next-page position, sealed to the listing and padded to one
* length, with its key relative to the region.
*/
#cursorOut(cursor: string, listing: ForeignListing): string | undefined {
const decoded = decodeCursor(cursor);
const reverse = decoded?.reverse === true;
const position = (reverse ? decoded?.key : decoded) as
| { namespace?: unknown; key?: unknown }
| undefined;
if (position?.namespace !== listing.namespace) throw outsideRegion();
const key = this.#relativeKey(position.key, listing.prefix);
return sealCursor(
{
s: listing.bind,
k: Buffer.from(key, 'utf8').toString('base64url'),
...(reverse ? { r: true } : {}),
},
this.config.jwt_secret_v2,
{ padTo: FOREIGN_CURSOR_BYTES },
);
}
/** A foreign listing as its caller sees it: keys relative, cursor sealed. */
#foreignResult(
res: KvListResult,
as: string | undefined,
listing: ForeignListing,
): KvListResult {
const { prefix } = listing;
const relative = (items: unknown[]): unknown[] => {
if (as === 'values' || prefix === '') return items;
if (as === 'keys')
return items.map((key) => this.#relativeKey(key, prefix));
return items.map((entry) => {
const { key, value } = entry as {
key: unknown;
value: unknown;
};
return { key: this.#relativeKey(key, prefix), value };
});
};
if (Array.isArray(res)) return relative(res);
const cursor = res.cursor
? this.#cursorOut(res.cursor, listing)
: undefined;
return {
items: relative(res.items),
...(cursor ? { cursor } : {}),
...(res.total !== undefined ? { total: res.total } : {}),
};
}
async #assertCrossAppKvAccess(
actor: Actor,
targetAppUid: string,
@@ -322,7 +722,7 @@ export class KVStoreDriver extends PuterDriver {
async get(args: {
key: unknown;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const { key } = args;
if (key === undefined || key === null) {
@@ -343,45 +743,55 @@ export class KVStoreDriver extends PuterDriver {
if (Array.isArray(key)) {
if (key.length === 0) return [];
const coerced = key.map((k) => this.#coerceKey(k));
const { res, usage } = await this.stores.kv.get(
{ key: coerced },
opts,
const coerced = key.map((k) => this.#coerceKey(k, args));
const { res, usage } = await this.#inRegion(opts, coerced, () =>
this.stores.kv.get(
{ key: coerced.map((k) => this.#storeKey(k, opts)) },
opts,
),
);
this.#meter(opts.actor, usage);
return res;
}
const { res, usage } = await this.stores.kv.get(
{ key: this.#coerceKey(key) },
opts,
const coerced = this.#coerceKey(key, args);
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.get({ key: this.#storeKey(coerced, opts) }, opts),
);
this.#meter(opts.actor, usage);
return res;
}
/**
* `false` only for an `onlyIfAbsent` write that found a live entry, which
* is left as it was.
*/
async set(args: {
key: unknown;
value: unknown;
expireAt?: number | null;
optConfig?: { appUuid?: string; disableSharing?: boolean };
optConfig?: KvOptConfig;
}): Promise<boolean> {
const { key, value, expireAt } = args;
const coerced = this.#coerceKey(key);
const coerced = this.#coerceKey(key, args);
if (value === undefined)
throw new HttpError(400, 'Missing `value`', {
legacyCode: 'bad_request',
}); // legacyCode for backward compatibility with old error handling in controllers
const onlyIfAbsent = parseOnlyIfAbsent(args.optConfig?.onlyIfAbsent);
const opts = await this.#opts('set', args);
const { res, usage } = await this.stores.kv.set(
{
key: coerced,
value,
expireAt,
disableSharing: args.optConfig?.disableSharing,
},
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.set(
{
key: this.#storeKey(coerced, opts),
value,
expireAt,
disableSharing: args.optConfig?.disableSharing,
onlyIfAbsent,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -389,7 +799,7 @@ export class KVStoreDriver extends PuterDriver {
async batchPut(args: {
items: Array<{ key: string; value: unknown; expireAt?: number | null }>;
optConfig?: { appUuid?: string; disableSharing?: boolean };
optConfig?: KvOptConfig;
}): Promise<boolean> {
const { items } = args;
if (!Array.isArray(items) || items.length === 0) {
@@ -404,17 +814,27 @@ export class KVStoreDriver extends PuterDriver {
{ legacyCode: 'bad_request' },
);
}
// A batch write takes no condition, so it can't promise this per item.
if (parseOnlyIfAbsent(args.optConfig?.onlyIfAbsent)) {
throw new HttpError(
400,
'kv: onlyIfAbsent is not available on a batch write',
{ legacyCode: 'invalid_request' },
);
}
const coerced = items.map((item) => ({
key: this.#coerceKey(item.key),
key: this.#coerceKey(item.key, args),
value: item.value,
expireAt: item.expireAt,
}));
const opts = await this.#opts('batchPut', args);
// Per-item expiry, which the top-level scan in `#opts` cannot see.
// Per-item expiry, which the top-level scan in `#opts` cannot see. A
// handle's `write` level already carries expiries.
if (
opts.namespaceAppUuid &&
opts.handlePrefix === undefined &&
coerced.some(
(item) => item.expireAt !== undefined && item.expireAt !== null,
)
@@ -424,12 +844,20 @@ export class KVStoreDriver extends PuterDriver {
opts.namespaceAppUuid,
);
}
const { res, usage } = await this.stores.kv.batchPut(
{
items: coerced,
disableSharing: args.optConfig?.disableSharing,
},
const { res, usage } = await this.#inRegion(
opts,
coerced.map((item) => item.key),
() =>
this.stores.kv.batchPut(
{
items: coerced.map((item) => ({
...item,
key: this.#storeKey(item.key, opts),
})),
disableSharing: args.optConfig?.disableSharing,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -437,11 +865,13 @@ export class KVStoreDriver extends PuterDriver {
async del(args: {
key: unknown;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<boolean> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
const opts = await this.#opts('del', args);
const { res, usage } = await this.stores.kv.del({ key: coerced }, opts);
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.del({ key: this.#storeKey(coerced, opts) }, opts),
);
this.#meter(opts.actor, usage);
return res;
}
@@ -455,7 +885,7 @@ export class KVStoreDriver extends PuterDriver {
includeTotal?: boolean;
fetchUntilFull?: boolean;
reverse?: boolean;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const opts = await this.#opts('list', args);
// Naming what it holds is how an account with nothing left decides what
@@ -469,6 +899,14 @@ export class KVStoreDriver extends PuterDriver {
this.config,
);
}
const handlePrefix = opts.handlePrefix;
const listing = this.#foreignListing(opts);
if (
handlePrefix !== undefined &&
typeof args.pattern === 'string' &&
Buffer.byteLength(args.pattern, 'utf8') > KV_HANDLE_KEY_MAX_BYTES
)
throw handlePatternInvalid();
const { res, usage } = await this.stores.kv.list(
{
as: args.as,
@@ -476,20 +914,26 @@ export class KVStoreDriver extends PuterDriver {
cap: KV_MAX_LIST_LIMIT,
label: 'kv: limit',
}),
cursor: args.cursor,
cursor: listing
? this.#cursorIn(args.cursor, listing)
: args.cursor,
pattern: args.pattern,
offset: args.offset,
includeTotal: args.includeTotal,
fetchUntilFull: args.fetchUntilFull,
reverse: args.reverse,
...(handlePrefix === undefined
? {}
: { keyPrefix: handlePrefix }),
},
opts,
);
this.#meter(opts.actor, usage);
return res;
if (!listing) return res;
return this.#foreignResult(res as KvListResult, args.as, listing);
}
async flush(args: { optConfig?: { appUuid?: string } }): Promise<boolean> {
async flush(args: { optConfig?: KvOptConfig }): Promise<boolean> {
const opts = await this.#opts('flush', args);
const { res, usage } = await this.stores.kv.flush(opts);
this.#meter(opts.actor, usage);
@@ -499,9 +943,9 @@ export class KVStoreDriver extends PuterDriver {
async incr(args: {
key: unknown;
pathAndAmountMap: Record<string, number>;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (
!args.pathAndAmountMap ||
typeof args.pathAndAmountMap !== 'object'
@@ -511,9 +955,14 @@ export class KVStoreDriver extends PuterDriver {
});
}
const opts = await this.#opts('incr', args);
const { res, usage } = await this.stores.kv.incr(
{ key: coerced, pathAndAmountMap: args.pathAndAmountMap },
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.incr(
{
key: this.#storeKey(coerced, opts),
pathAndAmountMap: args.pathAndAmountMap,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -522,9 +971,9 @@ export class KVStoreDriver extends PuterDriver {
async decr(args: {
key: unknown;
pathAndAmountMap: Record<string, number>;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (
!args.pathAndAmountMap ||
typeof args.pathAndAmountMap !== 'object'
@@ -534,9 +983,14 @@ export class KVStoreDriver extends PuterDriver {
});
}
const opts = await this.#opts('decr', args);
const { res, usage } = await this.stores.kv.decr(
{ key: coerced, pathAndAmountMap: args.pathAndAmountMap },
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.decr(
{
key: this.#storeKey(coerced, opts),
pathAndAmountMap: args.pathAndAmountMap,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -545,18 +999,23 @@ export class KVStoreDriver extends PuterDriver {
async expireAt(args: {
key: unknown;
timestamp: number;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<boolean> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (typeof args.timestamp !== 'number') {
throw new HttpError(400, '`timestamp` must be a number', {
legacyCode: 'bad_request',
});
}
const opts = await this.#opts('expireAt', args);
const { res, usage } = await this.stores.kv.expireAt(
{ key: coerced, timestamp: args.timestamp },
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.expireAt(
{
key: this.#storeKey(coerced, opts),
timestamp: args.timestamp,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -565,18 +1024,20 @@ export class KVStoreDriver extends PuterDriver {
async expire(args: {
key: unknown;
ttl: number;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<boolean> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (typeof args.ttl !== 'number') {
throw new HttpError(400, '`ttl` must be a number (seconds)', {
legacyCode: 'bad_request',
});
}
const opts = await this.#opts('expire', args);
const { res, usage } = await this.stores.kv.expire(
{ key: coerced, ttl: args.ttl },
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.expire(
{ key: this.#storeKey(coerced, opts), ttl: args.ttl },
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -586,22 +1047,24 @@ export class KVStoreDriver extends PuterDriver {
key: unknown;
pathAndValueMap: Record<string, unknown>;
ttl?: number | null;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (!args.pathAndValueMap || typeof args.pathAndValueMap !== 'object') {
throw new HttpError(400, 'Missing or invalid `pathAndValueMap`', {
legacyCode: 'bad_request',
});
}
const opts = await this.#opts('update', args);
const { res, usage } = await this.stores.kv.update(
{
key: coerced,
pathAndValueMap: args.pathAndValueMap,
ttl: args.ttl,
},
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.update(
{
key: this.#storeKey(coerced, opts),
pathAndValueMap: args.pathAndValueMap,
ttl: args.ttl,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -610,18 +1073,23 @@ export class KVStoreDriver extends PuterDriver {
async add(args: {
key: unknown;
pathAndValueMap: Record<string, unknown>;
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (!args.pathAndValueMap || typeof args.pathAndValueMap !== 'object') {
throw new HttpError(400, 'Missing or invalid `pathAndValueMap`', {
legacyCode: 'bad_request',
});
}
const opts = await this.#opts('add', args);
const { res, usage } = await this.stores.kv.add(
{ key: coerced, pathAndValueMap: args.pathAndValueMap },
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.add(
{
key: this.#storeKey(coerced, opts),
pathAndValueMap: args.pathAndValueMap,
},
opts,
),
);
this.#meter(opts.actor, usage);
return res;
@@ -630,23 +1098,27 @@ export class KVStoreDriver extends PuterDriver {
async remove(args: {
key: unknown;
paths: string[];
optConfig?: { appUuid?: string };
optConfig?: KvOptConfig;
}): Promise<unknown> {
const coerced = this.#coerceKey(args.key);
const coerced = this.#coerceKey(args.key, args);
if (!Array.isArray(args.paths) || args.paths.length === 0) {
throw new HttpError(400, 'Missing or invalid `paths`', {
legacyCode: 'bad_request',
});
}
const opts = await this.#opts('remove', args);
const { res, usage } = await this.stores.kv.remove(
{ key: coerced, paths: args.paths },
opts,
const { res, usage } = await this.#inRegion(opts, [coerced], () =>
this.stores.kv.remove(
{ key: this.#storeKey(coerced, opts), paths: args.paths },
opts,
),
);
this.#meter(opts.actor, usage);
// The result is the entry's value, so a delete-only grant gets none.
// The result is the entry's value, so a delete-only grant gets none. A
// handle's `write` level reads too.
if (
opts.namespaceAppUuid &&
opts.handlePrefix === undefined &&
!(await this.services.permission.check(
opts.actor!,
appDataPermission(opts.namespaceAppUuid, 'kv', 'get'),
@@ -36,6 +36,7 @@ import {
} from '../../services/notification/notificationAudience.js';
import {
NOTIFICATION_VALUE_MAX_BYTES,
OUTSIDE_ACCOUNT_MAILBOX_TYPES,
resolveNotificationWrite,
type NotificationTypeName,
} from '../../services/notification/notificationTypes.js';
@@ -221,7 +222,13 @@ export class NotificationDriver extends PuterDriver {
scope: MailboxScope | null;
filter?: string;
onlyUnacknowledged?: boolean;
excludeTypes?: readonly string[];
} = { limit, scope };
// The whole mailbox, or a slice naming no app, is the desktop's view of
// it, which leaves out the types only an app has a use for. A slice
// naming the app still returns them.
if (scope === null || scope.appUid === undefined)
query.excludeTypes = OUTSIDE_ACCOUNT_MAILBOX_TYPES;
switch (predicateName) {
case 'unseen':
@@ -573,6 +573,24 @@ describe('SubdomainDriver.update field handling', () => {
expect(cleared.associated_app).toBeNull();
});
it('disconnects the directory when root_dir is null', async () => {
const { actor } = await makeUser();
const name = uniqueName('unlink');
await createSubdomain(actor, name);
// The shape `puter.hosting.update(name, null)` sends.
const updated = (await withActor(actor, () =>
driver.update({
id: { subdomain: name },
object: { root_dir: null },
}),
)) as Record<string, unknown>;
expect(updated.root_dir).toBeNull();
const row = await server.stores.subdomain.getBySubdomain(name);
expect(row?.root_dir_id ?? null).toBeNull();
});
it('rejects repointing root_dir at a path that does not exist', async () => {
const { actor } = await makeUser();
const created = await createSubdomain(actor, uniqueName('badroot'));
@@ -357,7 +357,10 @@ export class SubdomainDriver extends PuterDriver {
// Subdomain name is immutable — strip if provided
const patch: Record<string, unknown> = {};
if (object.root_dir !== undefined) {
// A null root_dir disconnects the directory; the site stays reserved.
if (object.root_dir === null) {
patch.root_dir_id = null;
} else if (object.root_dir !== undefined) {
const rootDirPath = expandTildePath(
String(object.root_dir),
actor.user.username,
+5 -2
View File
@@ -441,6 +441,7 @@ describe('PuterServer host header validation — permissive modes', () => {
allow_no_host_header: false,
custom_domains_enabled: true,
allow_nipio_domains: true,
static_hosting_domain: 'site.puter.localhost',
} as unknown as IConfig,
{ listen: true },
);
@@ -450,11 +451,13 @@ describe('PuterServer host header validation — permissive modes', () => {
await server?.shutdown();
});
it('lets an unknown host through when custom domains are enabled', async () => {
it('hands an unknown host to site hosting when custom domains are enabled', async () => {
const res = await rawRequest(port, '/', {
host: 'my-own-domain.example',
});
expect(res.status).not.toBe(400);
// No site claims it, so it 404s instead of reaching the GUI.
expect(res.status).toBe(404);
expect(res.body).toBe('Site not found');
});
it('accepts nip.io hosts when they are opted in', async () => {
+14
View File
@@ -210,6 +210,20 @@ export class PuterServer {
[this.#config, this.clients, this.stores, this.services],
);
// Core's seat rules skip silently without Teams, so asking for it with
// nothing registered refuses to boot rather than serve without them.
if (
this.#config.teams_enabled === true &&
!(
(this.stores as { team?: unknown }).team &&
(this.services as { team?: unknown }).team
)
) {
throw new Error(
'`teams_enabled` is on, but no extension registered the team store and service',
);
}
// Wire the rate-limiter to its configured backend now that clients
// and stores exist. Memory is the default; `redis` needs a redis
// client, `kv` needs the system KV store (DynamoDB-backed).
@@ -51,8 +51,9 @@ import {
EVENTS_UNSUBSCRIBE_VERB,
type DeliveryEnvelope,
type EventSocket,
type KvDispatchOptions,
} from './EventsService.js';
import { kvSharePermission } from './kvShares.js';
import { kvSharePermission } from '../kvShare/kvShares.js';
import { FILTER_EVALUATIONS_PER_EVENT } from './matcher.js';
import { SUBSCRIPTION_CACHE_TTL_MS } from './subscriptionCache.js';
import { kvAnchorToken } from './subjects.js';
@@ -203,6 +204,15 @@ let handles: Map<string, KvShareHandle>;
const kvShareHandleStore = {
getByHandle: async (handle: string) => handles.get(handle) ?? null,
getLive: async (handle: string) => {
const row = handles.get(handle);
if (!row || row.revokedAt !== null) return null;
return {
row,
ownerUuid: `user-${row.ownerUserId}`,
ownerSuspended: false,
};
},
};
/** Apps the cross-app gate can be asked about, and what they share. */
@@ -2108,6 +2118,7 @@ it('sends only the projected shape, never an internal row', async () => {
'subject',
'ts',
'uid',
'viaWorker',
]);
expect(sent[0].envelope.event).not.toHaveProperty('userId');
});
@@ -2554,6 +2565,47 @@ describe('delivering a kv change', () => {
expect(sent).toEqual([]);
});
it('tells a subscriber the change was theirs only when they made it', async () => {
vi.useFakeTimers();
await subscribeKv(`kv:${OWN_APP}:cart`);
const write = (options: KvDispatchOptions) =>
service.dispatchKv(
{
userId,
namespace: `v1:user-${userId}:${OWN_APP}`,
keys: ['cart'],
op: 'set',
},
options,
);
// One window each: writes to one key inside a window coalesce.
for (const options of [
{ actingUserId: userId },
{ actingUserId: userId + 1 },
{},
{ actingUserId: userId, viaWorker: true },
]) {
await write(options);
await vi.advanceTimersByTimeAsync(EVENTS_COALESCE_WINDOW_MS + 1);
}
expect(
sent.map(({ envelope }) => {
const { self, viaWorker } = envelope.event as {
self: boolean;
viaWorker: boolean;
};
return { self, viaWorker };
}),
).toEqual([
{ self: true, viaWorker: false },
{ self: false, viaWorker: false },
{ self: false, viaWorker: false },
{ self: true, viaWorker: true },
]);
});
it('sends only the projected shape', async () => {
vi.useFakeTimers();
await subscribeKv(`kv:${OWN_APP}:cart`);
@@ -2569,6 +2621,7 @@ describe('delivering a kv change', () => {
'seq',
'subject',
'ts',
'viaWorker',
]);
});
});
@@ -2843,6 +2896,7 @@ describe('the cross-app kv gate', () => {
'seq',
'subject',
'ts',
'viaWorker',
]);
});
@@ -2951,8 +3005,10 @@ describe('cross-user kv handles', () => {
appUid: OWN_APP,
keyPrefix: PREFIX,
permission,
label: null,
createdAt: 0,
revokedAt: null,
revokedBy: null,
...overrides,
};
handles.set(row.handle, row);
+136 -531
View File
@@ -31,9 +31,6 @@ import {
EVENTS_HANDLER_DEPTH,
EVENTS_HANDLER_PUBLISH_BATCH,
EVENTS_HANDLER_PUBLISH_LIMIT,
EVENTS_KV_HANDLE_LIMIT,
EVENTS_KV_HANDLES_PER_APP,
EVENTS_KV_HANDLES_PER_USER,
EVENTS_KV_FILTER_EVALUATIONS_PER_EVENT,
EVENTS_KV_MATCHED_SUBSCRIPTIONS_PER_EVENT,
EVENTS_KV_VALUE_MAX_BYTES,
@@ -53,7 +50,6 @@ import {
isAccessTokenActor,
isAccountContext,
makeActor,
userRelatedActor,
type Actor,
} from '../../core/actor.js';
import { HttpError, isHttpError } from '../../core/http/HttpError.js';
@@ -62,15 +58,12 @@ import type {
ReanchorInput,
SuspendedReason,
} from '../../stores/events/DurableSubscriptionStore.js';
import type { LiveKvShareHandle } from '../../stores/events/KvShareHandleStore.js';
import {
DurableQuotaRaceLost,
HANDLER_SETTLE_BATCH,
isSuspendedReason,
} from '../../stores/events/DurableSubscriptionStore.js';
import type {
KvShareHandle,
KvShareHandleListOptions,
} from '../../stores/events/KvShareHandleStore.js';
import {
HANDLER_NAME_MAX_LENGTH,
hashContent,
@@ -98,10 +91,7 @@ import {
type SubscriptionTarget,
} from '../../stores/events/types.js';
import type { FSEntry } from '../../stores/fs/FSEntry.js';
import {
KV_GLOBAL_APP_KEY,
parseKvNamespace,
} from '../../stores/systemKv/SystemKVStore.js';
import { parseKvNamespace } from '../../stores/systemKv/SystemKVStore.js';
import { awaitLater } from '../../util/concurrency.js';
import {
openCursor,
@@ -111,13 +101,17 @@ import {
import type { AclMode, ResourceDescriptor } from '../acl/ACLService.js';
import { resolveNode } from '../fs/resolveNode.js';
import { maskUnderAnchor } from '../fs/sharePathMask.js';
import { assertActorHasCredits } from '../metering/enforcement.js';
import { actorPlanId, assertActorHasCredits } from '../metering/enforcement.js';
import {
canViewNotification,
notificationRowScope,
ownedAppUids,
} from '../notification/notificationAudience.js';
import { notificationsFoldInEnabled } from '../notification/notificationSocket.js';
import {
inAccountMailbox,
OUTSIDE_ACCOUNT_MAILBOX_TYPES,
} from '../notification/notificationTypes.js';
import {
appSocketRoom,
type SocketSpecifier,
@@ -196,18 +190,10 @@ import {
} from './registry.js';
import { SubscriptionCache } from './subscriptionCache.js';
import {
assertBoundedManageGrant,
assertShareableAppUid,
assertShareablePermission,
assertShareablePrefix,
kvShareAppDelegateImplicator,
kvShareGrantCovers,
kvShareManageNamespaceRoot,
kvShareManagePermission,
kvShareOwnerImplicator,
kvSharePermission,
relativeToKvShareRoot,
} from './kvShares.js';
} from '../kvShare/kvShares.js';
import {
KV_MATCH_SEPARATOR,
NOTIF_MATCH_SEPARATOR,
@@ -216,6 +202,7 @@ import {
isKvToken,
isNotifToken,
kvHandleFromSubject,
notifMatchSpansEveryApp,
parseSubject,
type FsOp,
type ParsedSubject,
@@ -432,35 +419,6 @@ export interface DurableSubscriptionView extends SubscriptionView {
suspendedReason: string | null;
}
/** Body of the handle-minting surface. The grantee is named either way. */
export interface MintKvHandleRequest {
granteeUsername?: unknown;
granteeUid?: unknown;
appUid?: unknown;
prefix?: unknown;
}
/**
* What minting returns. Only the handle and the region it covers: the owner
* already knows the rest, and the grantee is handed this verbatim, so anything
* else here would be something the handle exists to not say.
*/
export interface MintedKvHandle {
handle: string;
prefix: string;
}
/**
* One handle as its owner sees it, revoked ones included — they are the record
* of what was shared and when it stopped.
*/
export interface KvShareHandleView extends MintedKvHandle {
appUid: string;
granteeUsername: string | null;
createdAt: number;
revokedAt: number | null;
}
export type VerbAck<T extends object> =
| ({ ok: true } & T)
| { ok: false; error: { code: string; message: string } };
@@ -576,6 +534,8 @@ export interface FsDispatchOptions {
actingUserId?: number;
/** Handler runs behind the write; see `Actor.handlerDepth`. */
handlerDepth?: number;
/** The write was made by server-side code; see `viaWorkerOf`. */
viaWorker?: boolean;
/** Present only for a move: where the entry lived before it, lazily. */
movedFrom?: {
path: string;
@@ -596,6 +556,8 @@ export interface FsDispatchOptions {
export interface KvDispatchOptions {
/** Who performed the write, for the `self` flag. */
actingUserId?: number;
/** The write was made by server-side code; see `viaWorkerOf`. */
viaWorker?: boolean;
/** See {@link FsDispatchOptions.forwarded}. */
forwarded?: true;
/** Carried over from the emitting region so both copies share one id/ts. */
@@ -633,6 +595,9 @@ export interface KvDispatchInput {
noShareKeys?: readonly string[];
/** Handler runs behind the write; see `Actor.handlerDepth`. */
handlerDepth?: number;
/** Who made the change; the listener hands it on as an option. */
actingUserId?: number;
viaWorker?: true;
}
interface RouteLimits {
@@ -831,19 +796,6 @@ const handlerAppRequired = (): HttpError =>
legacyCode: 'events_handler_app_required',
});
/**
* Listing and revoking are the owner's, and an app's only where the handle is
* the app's own: its namespace, its user, and a delegation it still holds.
* Anything else — another app, a token an app issued, a handle outside the
* namespace — reads as somebody else's surface.
*/
const handleOwnerOnly = (): HttpError =>
new HttpError(
403,
'Only the account, or the app whose namespace this is, may manage share handles',
{ legacyCode: 'events_kv_handle_owner_only' },
);
/** A scoped token, whoever issued it: neither the account nor the app. */
const eventsWorkerOwnerOnly = (): HttpError =>
new HttpError(
@@ -852,62 +804,6 @@ const eventsWorkerOwnerOnly = (): HttpError =>
{ legacyCode: 'events_worker_owner_only' },
);
/**
* An app minting is delegation, and the `manage:` grant on the region is the
* consent for it. Without one there is nothing authorizing the app to dispose
* of its user's data, whatever the user themselves could do here.
*/
const handleNotDelegated = (): HttpError =>
new HttpError(
403,
'This app has not been given permission to share this data',
{ legacyCode: 'events_kv_handle_not_delegated' },
);
/**
* A delegation is the app's to hold, not to pass on: a token it minted may
* carry the `manage:` permission and still not mint through it. The user's own
* token is not this case — it acts for the user, who needs no delegation.
*/
const handleAccessTokenForbidden = (): HttpError =>
new HttpError(403, 'An access token may not mint a share handle', {
legacyCode: 'forbidden',
});
/**
* An app addresses exactly one key-value namespace — its own, under its user —
* so that is the only one it can hand a region of out.
*/
const handleOutsideNamespace = (): HttpError =>
new HttpError(403, 'An app may only share its own key-value data', {
legacyCode: 'events_kv_handle_outside_namespace',
});
/**
* A temporary account holds no share handles: the grant outlives the session
* that made it, and there is no account left behind it to take one back.
*/
const kvHandleNeedsAccount = (): HttpError =>
new HttpError(403, 'A temporary account may not share its key-value data', {
legacyCode: 'events_kv_handle_requires_account',
});
/**
* Past a handle ceiling. One code for both of them — the remedy is the same,
* revoke something — with the message saying which one it was.
*/
const handleQuotaReached = (
limit: number,
scope: 'account' | 'app',
): HttpError =>
new HttpError(
409,
scope === 'app'
? `An app may hold out ${limit} share handles for one account`
: `An account may hold out ${limit} share handles at a time`,
{ legacyCode: 'events_kv_handle_limit_reached' },
);
/**
* Deploying an app's code is the developer's, and an app token cannot borrow
* its user's ownership of some other app. Same answer for an app that is not
@@ -1474,6 +1370,17 @@ export class EventsService extends PuterService {
});
});
// A retired handle is a dead address: what was made through it ends,
// even where another grant still covers the region. Awaited by the
// emitter, so a revoke returns once its subscriptions are settled.
this.clients.event.on('kv.share.retired', async (_key, data) => {
try {
await this.settleRetiredKvHandles(data);
} catch (err) {
console.warn('[events] retired-handle settle failed', err);
}
});
// A deleted app's rows can never deliver again — the grant identity
// they are re-checked under no longer resolves — so they are torn
// down rather than left to cost their holder an anchor slot forever.
@@ -1507,9 +1414,17 @@ export class EventsService extends PuterService {
// a service. Same posture as the FS hook: post-commit, and nothing here
// can fail the write that produced it.
this.clients.event.on('kv.mutated', (_key, data) => {
void this.dispatchKv(data as KvDispatchInput).catch((err) => {
console.warn('[events] kv dispatch failed', err);
});
const input = data as KvDispatchInput;
void (async () => {
try {
await this.dispatchKv(input, {
actingUserId: input.actingUserId,
viaWorker: input.viaWorker === true,
});
} catch (err) {
console.warn('[events] kv dispatch failed', err);
}
})();
});
// Emitted once the row is written, so a delivery never names a
@@ -1520,19 +1435,6 @@ export class EventsService extends PuterService {
});
});
// Owning a key-value namespace is holding every share grant over it,
// which is what lets its owner mint a handle on their own data.
this.services.permission.registerImplicator(kvShareOwnerImplicator());
// Lets an app-under-user actor exercise a share grant its user holds,
// scoped to the app the grant's namespace names.
this.services.permission.registerImplicator(
kvShareAppDelegateImplicator({
userHolds: (actor, permission) =>
this.services.permission.check(actor, permission),
}),
);
this.#armExpirySweep();
this.#armPendingSweep();
this.#armCreditSweep();
@@ -1934,15 +1836,8 @@ export class EventsService extends PuterService {
}
/** The plan this actor is on, or `null` where there are no plans. */
async #planId(actor: Actor): Promise<string | null> {
const metering = this.services.metering;
if (!metering) return null;
try {
return (await metering.getActorSubscription(actor)).id;
} catch (err) {
console.warn('[events] could not resolve a plan', err);
return null;
}
#planId(actor: Actor): Promise<string | null> {
return actorPlanId(this.services.metering, actor);
}
/**
@@ -2047,11 +1942,16 @@ export class EventsService extends PuterService {
);
// One extra row answers "is there another page" without a count.
// The generic slice is the desktop's view of the mailbox, so it leaves
// out the types kept off the desktop, as the live delivery does.
const rows = await this.stores.notification.listScoped(user.id, {
audience: scope.audience,
appUid: scope.appUid,
after: Number.isFinite(cursored) ? cursored : null,
limit: limit + 1,
...(scope.appUid === undefined
? { excludeTypes: OUTSIDE_ACCOUNT_MAILBOX_TYPES }
: {}),
});
const page = rows.slice(0, limit);
@@ -2399,373 +2299,6 @@ export class EventsService extends PuterService {
return { appUid, removed, suspended };
}
// -- Cross-user key-value handles --------------------------------
/**
* Hand another user a watchable region of this account's key-value data.
*
* Two writes, in this order: the grant, which is the authorization and
* carries its own `manage:` check and its own refusal to grant to yourself,
* and then the handle, which is only a name for it. A handle whose grant
* never landed would be a name for nothing; a grant whose handle never
* landed is unaddressable, since a handle is the only thing that can name
* this family.
*
* An app may mint too, bounded the way sharing bounds an app handing out
* its user's files: authority is the user's, asked of the user behind the
* actor and never of the app, and reach is what the credential itself
* holds. Here reach is structural — an app addresses one namespace — so it
* is asserted rather than worked out, and the app's own consent to delegate
* is a `manage:` grant on the region.
*/
async mintKvHandle(
actor: Actor,
request: MintKvHandleRequest,
): Promise<MintedKvHandle> {
if (!this.enabled) throw disabled();
if (!this.kvHandlesEnabled) throw kvShareHandleDisabled();
const owner = actor.user;
if (!owner?.uuid || owner.id === undefined) throw disabled();
// `undefined` is an app that could not be resolved, not the absence of
// one — reading it as an account session is what would hand an app a
// surface bounded on the app it is acting as.
const app = actor.effectiveApp;
if (app === undefined) throw handleOwnerOnly();
// An account's surface is the account's, and a token scoped to less
// than its issuer holds is not the account. A token an app issued is
// refused by the delegation check below, which has its own answer.
if (app === null && !isAccountContext(actor)) throw handleOwnerOnly();
// The budget is the user's, so an app spends its user's slots rather
// than a machine-rate allowance of its own.
await this.#spendHandleBudget(owner.id);
const keyPrefix = assertShareablePrefix(request?.prefix);
const appUid = this.#mintNamespace(app, request);
const grantee = await this.#resolveGrantee(request);
const permission = assertShareablePermission(
kvSharePermission(owner.uuid, appUid, keyPrefix),
);
// Before the idempotent answer below, or an app that lost its
// delegation could read back a handle it may no longer hand out.
if (app) await this.#assertKvShareDelegated(actor, permission);
// Resolved before the idempotent answer below, so a plan that holds
// none is refused whatever it asks for. Kept behind the delegation
// check above: an app with no delegation must not learn anything
// about the account's plan.
const quota = await this.#handleQuota(actor);
// The same region minted again for the same grantee is the same
// capability, not a second one — handing back what already exists is
// what keeps two handles from ever sharing one permission row. The
// ceiling counts slots, and this takes none, so it is not asked.
const existing = await this.stores.kvShareHandle.findLive({
ownerUserId: owner.id,
granteeUserId: grantee.id,
appUid,
keyPrefix,
});
if (existing)
return { handle: existing.handle, prefix: existing.keyPrefix };
await this.#assertHandleCeiling(owner.id, appUid, quota);
// The user behind the app, so the authority checked is theirs and the
// issuer recorded is them. Which app acted is carried separately: it
// belongs on the audit row, not in the grant's authority.
await this.services.permission.grantUserUserPermission(
userRelatedActor(actor),
grantee.username,
permission,
{},
{ reason: 'kv share handle', appUid: app?.uid },
);
const row = await this.stores.kvShareHandle.mint({
ownerUserId: owner.id,
granteeUserId: grantee.id,
appUid,
keyPrefix,
permission,
});
return { handle: row.handle, prefix: row.keyPrefix };
}
/**
* Which namespace a mint may name. An app reaches `v1:<user>:<its own app>`
* and nothing else, so a request naming another one is refused rather than
* quietly minted somewhere the app cannot even write.
*/
#mintNamespace(
app: Actor['effectiveApp'],
request: MintKvHandleRequest,
): string {
const named = parseAppUid(request?.appUid);
if (!app) return assertShareableAppUid(named ?? KV_GLOBAL_APP_KEY);
if (named !== null && named !== app.uid) throw handleOutsideNamespace();
return app.uid;
}
/**
* Whether this app was given the region to hand out. The `manage:` grant is
* the user's consent, and prefix implication makes one taken on a region
* cover the keys beneath it — so a handle deeper than the consent is still
* inside it, and one above it is not.
*/
async #assertKvShareDelegated(
actor: Actor,
permission: string,
): Promise<void> {
// Consequential enough to require the app's own session, whatever a
// token it minted happens to carry.
if (isAccessTokenActor(actor)) throw handleAccessTokenForbidden();
// The consent surface refuses a namespace-root delegation because no
// prompt can describe it; refused here too, so a row written any other
// way cannot authorize a mint.
assertBoundedManageGrant(kvShareManagePermission(permission));
const delegated = await this.services.permission.canManagePermission(
actor,
permission,
);
if (!delegated) throw handleNotDelegated();
// `canManagePermission` walks ancestors, so a namespace-root grant
// written by any path other than the consent surface would otherwise
// authorize a mint anywhere in the namespace, bounded region or not.
const unbounded = await this.services.permission.check(
actor,
kvShareManageNamespaceRoot(permission),
);
if (unbounded) throw handleNotDelegated();
}
/**
* Take a shared region back.
*
* The grant goes first — the subtree with it, since a deeper grant would
* leave access to part of a region that has just been withdrawn — and the
* handle is retired after. Removing the grant is what actually settles the
* subscriptions, and it is the only half that stops delivery, so it is the
* half that must not be able to fail after the other has succeeded. In that
* order both steps are idempotent and a failure anywhere is a retry: the
* reverse leaves a handle nothing can address standing on a grant
* everything still passes, and no way to try again.
*
* Not gated on the feature flag. Withdrawing access only ever narrows, and
* an install that turned handles off must still be able to retire the ones
* it has.
*/
async revokeKvHandle(
actor: Actor,
handle: unknown,
): Promise<{ handle: string; revokedAt: number }> {
if (!this.enabled) throw disabled();
const owner = actor.user;
if (owner?.id === undefined) throw disabled();
// `undefined` is an app that could not be resolved, not the absence of
// one — reading it as an account session is what would hand an app the
// account's whole surface.
const app = actor.effectiveApp;
if (app === undefined) throw handleOwnerOnly();
// A delegation is the app's to hold, not to pass on, so a token an app
// issued is refused here as it is on the mint path — and a user's own
// token acts for the user only when it carries the user's whole reach.
if (isAccessTokenActor(actor) && !isAccountContext(actor))
throw handleOwnerOnly();
await this.#spendHandleBudget(owner.id);
const named = typeof handle === 'string' ? handle : '';
const share = await this.stores.kvShareHandle.getByHandle(named);
// Unknown and somebody else's read the same way, so revoking cannot be
// used to find out that a handle exists.
if (!share || share.ownerUserId !== owner.id)
throw unknownKvShareHandle(named);
// An app reaches one namespace, so a handle outside it is not its to
// take back — checked after the owner test, which must answer first.
if (app && share.appUid !== app.uid) throw handleOwnerOnly();
// The same consent the mint took: a withdrawn delegation withdraws the
// app's surface on the region with it.
if (app) await this.#assertKvShareDelegated(actor, share.permission);
const grantee = await this.stores.user.getById(share.granteeUserId);
if (!grantee?.username)
throw new HttpError(500, 'The grantee of this handle is gone', {
legacyCode: 'internal_error',
});
await this.services.permission.revokeUserUserPermissionSubtree(
userRelatedActor(actor),
grantee.username,
share.permission,
{ reason: 'kv share handle revoked', appUid: app?.uid },
);
const revoked = await this.stores.kvShareHandle.retire(named, owner.id);
if (!revoked?.revokedAt) throw unknownKvShareHandle(named);
// A narrower handle to the same grantee shares this one's permission
// row whenever its region nests under it, and the subtree revoke
// above just withdrew that row — so its grant is already gone even
// though its own row still reads live.
await this.#retireCoveredHandles(revoked);
return { handle: revoked.handle, revokedAt: revoked.revokedAt };
}
/**
* Every other live handle to this grantee that the just-withdrawn grant
* covered. Coverage runs on the permission string, whose third component is
* the namespace app uid, so a covered handle is always inside the same
* one.
*/
async #retireCoveredHandles(revoked: KvShareHandle): Promise<void> {
const siblings =
await this.stores.kvShareHandle.listLiveForOwnerAndGrantee(
revoked.ownerUserId,
revoked.granteeUserId,
);
await Promise.all(
siblings
.filter((row) =>
kvShareGrantCovers(revoked.permission, row.permission),
)
.map((row) =>
this.stores.kvShareHandle.retire(
row.handle,
revoked.ownerUserId,
),
),
);
}
/**
* What this account has shared out of its key-value data, retired handles
* included: they are the only record of what was shared and when it
* stopped. The grantee has no listing of their own — what they hold is the
* handle they were given.
*/
async listKvHandles(
actor: Actor,
options: KvShareHandleListOptions = {},
): Promise<PageResult<KvShareHandleView>> {
if (!this.enabled) throw disabled();
const owner = actor.user;
if (owner?.id === undefined) throw disabled();
const app = actor.effectiveApp;
if (app === undefined) throw handleOwnerOnly();
if (isAccessTokenActor(actor) && !isAccountContext(actor))
throw handleOwnerOnly();
// An app sees its own namespace and nothing else; an account session
// sees across apps, which is what makes the account the surface for a
// row whose app is long gone. Listing disposes of nothing, so the gate
// is app-ness and the namespace rather than the region's delegation.
const page = await this.stores.kvShareHandle.listForOwner(owner.id, {
limit: options.limit,
cursor: options.cursor,
includeTotal: options.includeTotal,
appUid: app?.uid ?? null,
});
const grantees = await this.stores.user.getByIds([
...new Set(page.items.map((row) => row.granteeUserId)),
]);
return {
...page,
items: page.items.map((row) => ({
handle: row.handle,
prefix: row.keyPrefix,
appUid: row.appUid,
granteeUsername:
grantees.get(row.granteeUserId)?.username ?? null,
createdAt: row.createdAt,
revokedAt: row.revokedAt,
})),
};
}
/** Who a mint is for. Named by username or uuid; unknown reads as absent. */
async #resolveGrantee(
request: MintKvHandleRequest,
): Promise<{ id: number; username: string }> {
const username =
typeof request?.granteeUsername === 'string'
? request.granteeUsername.trim()
: '';
const uid =
typeof request?.granteeUid === 'string'
? request.granteeUid.trim()
: '';
if (!username && !uid)
throw badRequest(
'Name the grantee with `granteeUsername` or `granteeUid`',
'bad_request',
);
const user = username
? await this.stores.user.getByUsername(username)
: await this.stores.user.getByUuid(uid);
if (!user?.username || user.id === undefined)
throw new HttpError(404, 'user_does_not_exist', {
legacyCode: 'subject_does_not_exist',
});
return { id: user.id, username: user.username };
}
/**
* How many handles this caller's plan lets the account hold out, in total
* and in one namespace. Resolved before the idempotent answer on the mint
* path, so a plan that may hold none is refused whatever it asks for.
*
* A deployment with no metering has no plans to read, and is held to the
* paid caps.
*/
async #handleQuota(actor: Actor): Promise<TieredQuota> {
const plan = await this.#planId(actor);
if (plan !== null && limitFor(EVENTS_KV_HANDLES_PER_USER, plan) === 0)
throw kvHandleNeedsAccount();
return {
perUser: limitFor(EVENTS_KV_HANDLES_PER_USER, plan),
perApp: limitFor(EVENTS_KV_HANDLES_PER_APP, plan),
};
}
/**
* Whether this account may hold out another share handle, in total and in
* the namespace this mint names. Retired ones do not count: the row stays
* as the record of what was shared, not as a slot. Check-then-act: two
* mints racing past it can both proceed, which the mint budget bounds well
* enough for an abuse backstop.
*/
async #assertHandleCeiling(
userId: number,
appUid: string,
quota: TieredQuota,
): Promise<void> {
const live = await this.stores.kvShareHandle.countLiveForOwner(
userId,
appUid,
);
if (live.total >= quota.perUser)
throw handleQuotaReached(quota.perUser, 'account');
// The global namespace is the account's own shelf rather than an
// app's, so the account cap is its only bound — which is also what
// keeps that cap reachable without naming a namespace.
if (appUid !== KV_GLOBAL_APP_KEY && live.forApp >= quota.perApp)
throw handleQuotaReached(quota.perApp, 'app');
}
async #spendHandleBudget(userId: number): Promise<void> {
const ok = await checkRateLimit(
`${EVENTS_KV_HANDLE_LIMIT.scope}:${userId}`,
EVENTS_KV_HANDLE_LIMIT.limit,
EVENTS_KV_HANDLE_LIMIT.window,
);
if (!ok) throw tooManyCalls();
}
// -- Suspension --------------------------------------------------
/**
@@ -3547,9 +3080,11 @@ export class EventsService extends PuterService {
* keyspace that is matters: the row is indexed under the **owner**, because
* a write only ever knows whose namespace it touched.
*
* Authority is the grant, never the handle: an actor holding the mirrored
* permission may subscribe, and one who does not is told the handle is not
* there rather than that it is theirs to want.
* Authority is the grant, never the handle: an actor holding the grant at
* any level may subscribe, and one who does not is told the handle is not
* there rather than that it is theirs to want. The handle is also bound to
* its holder, so another user whose own grant overlaps the region cannot
* use it.
*/
async #resolveKvHandleSubscribe(
actor: Actor,
@@ -3561,17 +3096,31 @@ export class EventsService extends PuterService {
const share = await this.stores.kvShareHandle.getByHandle(handle);
if (!share || share.revokedAt !== null)
throw unknownKvShareHandle(handle);
const held = await kvSharedRegionAuthorized(
actor,
share.permission,
this.#kvShareDeps(),
);
if (!held) throw unknownKvShareHandle(handle);
if (
actor.user?.id !== share.granteeUserId &&
actor.user?.id !== share.ownerUserId
)
throw unknownKvShareHandle(handle);
const owner = await this.stores.user.getById(share.ownerUserId);
if (!owner?.uuid) throw unknownKvShareHandle(handle);
// Watching is the lowest level, so every level answers it; storing it
// rather than the handle's own grant is what lets a level change leave
// the subscription alone.
const watch = kvSharePermission(
owner.uuid,
share.appUid,
share.keyPrefix,
'watch',
);
const held = await kvSharedRegionAuthorized(
actor,
watch,
this.#kvShareDeps(),
);
if (!held) throw unknownKvShareHandle(handle);
const anchor = resolveKvHandleAnchor(parsed, {
ownerUserUuid: owner.uuid,
appUid: share.appUid,
@@ -3590,7 +3139,7 @@ export class EventsService extends PuterService {
ownerUserId: share.ownerUserId,
// The grant string rather than a mode: it is what a revoke names,
// and what the delivery re-check asks again.
permission: share.permission,
permission: watch,
subject: anchor.subject,
};
}
@@ -3716,6 +3265,7 @@ export class EventsService extends PuterService {
id: options.id ?? randomUUID(),
ts: options.ts ?? Date.now(),
handlerDepth: options.handlerDepth,
viaWorker: options.viaWorker === true,
};
const { local, remote } =
@@ -3733,6 +3283,7 @@ export class EventsService extends PuterService {
family: 'fs',
ownerUserId,
actingUserId: options.actingUserId,
...(context.viaWorker ? { viaWorker: true as const } : {}),
id: context.id,
ts: context.ts,
fs: {
@@ -3823,6 +3374,7 @@ export class EventsService extends PuterService {
id: options.forwarded && options.id ? options.id : randomUUID(),
ts,
handlerDepth: input.handlerDepth,
viaWorker: options.viaWorker === true,
...(noShareKeys.has(kvKey) ? { noShare: true as const } : {}),
}));
const carried: Array<{ value: unknown } | undefined> = [];
@@ -3865,6 +3417,9 @@ export class EventsService extends PuterService {
family: 'kv',
ownerUserId,
actingUserId: options.actingUserId,
...(context.viaWorker
? { viaWorker: true as const }
: {}),
id: context.id,
ts: context.ts,
kv: {
@@ -3931,7 +3486,7 @@ export class EventsService extends PuterService {
subject,
context,
forKey,
ownerUserId,
options.actingUserId,
(matched) =>
this.#kvStillAuthorized(
matched,
@@ -4032,6 +3587,7 @@ export class EventsService extends PuterService {
ancestors: async () => item.fs!.movedFrom!.ancestors,
},
actingUserId: item.actingUserId,
viaWorker: item.viaWorker === true,
forwarded: true,
id: item.id,
ts: item.ts,
@@ -4068,6 +3624,7 @@ export class EventsService extends PuterService {
},
{
actingUserId: item.actingUserId,
viaWorker: item.viaWorker === true,
forwarded: true,
id: item.id,
ts: item.ts,
@@ -4123,10 +3680,14 @@ export class EventsService extends PuterService {
);
if (watched.length === 0) return;
const rows = await this.stores.eventSubscription.getForTokens(
const fetched = await this.stores.eventSubscription.getForTokens(
userId,
watched,
);
// A subscription naming no app is the desktop's view of the mailbox.
const rows = inAccountMailbox(context.type)
? fetched
: fetched.filter((row) => !notifMatchSpansEveryApp(row.match));
if (rows.length === 0) return;
await this.#route(subject, context, rows, userId, (matched) =>
@@ -4494,14 +4055,27 @@ export class EventsService extends PuterService {
}
/**
* Whether one row's holder may still watch the region it was made on.
*
* Held in the cross-event cache under the row's anchor, which for a shared
* region is the whole of what it can address: nothing above the handle is
* nameable, so the answer does not vary by key and one evaluation covers
* every event under it until a grant or a revoke moves the generation.
* Whether one row's holder may still watch the region it was made on. The
* handle must be live and theirs, so a retired one goes silent within the
* handle cache's lifetime even where a wider grant covers the region. The
* grant check doesn't vary by key, so it's cached under the row's anchor.
*/
async #kvShareHolds(row: DispatchSubscription): Promise<boolean> {
const handle = kvHandleFromSubject(row.subject);
if (handle === null) return false;
let live: LiveKvShareHandle | null;
try {
live = await this.stores.kvShareHandle.getLive(handle);
} catch {
return false;
}
if (
!live ||
(live.row.granteeUserId !== row.holderUserId &&
live.row.ownerUserId !== row.holderUserId)
)
return false;
const identity = await this.#grantIdentity(row);
if (!identity) return false;
@@ -4673,6 +4247,37 @@ export class EventsService extends PuterService {
return suspended.length;
}
/**
* Take out of service every durable subscription one user, the share's
* owner or its holder, made through these share handles, with their
* backlogs. One holder-index read, bounded by the user's subscription cap.
* Session rows are left to the delivery re-check, which reads the handle's
* liveness.
*/
async settleRetiredKvHandles(retired: {
handles: readonly string[];
userId: number;
}): Promise<number> {
if (!this.enabled || retired.handles.length === 0) return 0;
const held = await this.stores.durableSubscription.listActiveForHolder(
retired.userId,
null,
{ includeSuspended: true },
);
const handles = new Set(retired.handles);
const settling = held.filter((row) => {
const handle = kvHandleFromSubject(row.subject);
return handle !== null && handles.has(handle);
});
if (settling.length === 0) return 0;
const suspended = await this.#suspend(settling, 'permission_revoked', {
override: RESUMABLE_REASONS,
});
await this.#notifyEnded(suspended, 'permission_revoked');
return suspended.length;
}
/**
* Revoke the reused `events:handlers` worker session for (holder, app), if
* one was ever minted. Best-effort: a lookup or revoke failure must not
@@ -224,6 +224,7 @@ describe('an app connection', () => {
'subject',
'ts',
'uid',
'viaWorker',
]);
});
@@ -81,6 +81,8 @@ export interface ForwardEvent {
ownerUserId: number;
/** Who caused it, so `self` is right on the far side. */
actingUserId?: number;
/** Made by server-side code, so `viaWorker` is right on the far side. */
viaWorker?: true;
/** The emitter's event id and timestamp, kept so the two copies match. */
id: string;
ts: number;
+52 -1
View File
@@ -2044,6 +2044,34 @@ describe('a kv value crossing to another region', () => {
expect(eventsIn(west)[0].kv).toMatchObject({ value: { items: 3 } });
});
it('carries who wrote it, so `self` and `viaWorker` hold on the far side', async () => {
const west = makeRegion('west', ['east'], forwardCfg);
const east = makeRegion('east', ['west'], forwardCfg);
await subscribeKv(east, 'socket-writer');
await announced(east);
await west.events.dispatchKv(
{
userId,
namespace: `v1:user-${userId}:${APP}`,
keys: ['cart'],
op: 'set',
},
{ actingUserId: userId + 1, viaWorker: true },
);
await posted(west);
await arrived(east);
expect(eventsIn(west)[0]).toMatchObject({
actingUserId: userId + 1,
viaWorker: true,
});
expect(east.sent[0].event).toMatchObject({
self: false,
viaWorker: true,
});
});
});
describe('a session subscription in another region', () => {
@@ -2058,10 +2086,33 @@ describe('a session subscription in another region', () => {
await dispatch(west);
await arrived(east);
expect(east.sent[0].event).toMatchObject({ op: 'write', self: true });
expect(east.sent[0].event).toMatchObject({
op: 'write',
self: true,
viaWorker: false,
});
expect(west.sent).toEqual([]);
});
it('carries a server-side write as one on the far side', async () => {
const west = makeRegion('west', ['east'], forwardCfg);
const east = makeRegion('east', ['west'], forwardCfg);
await subscribeSession(east);
await posted(east);
await west.events.dispatchFs('fs.write.file', entry(), {
actingUserId: userId,
viaWorker: true,
ancestors: async () => ancestors(),
});
await arrived(east);
expect(east.sent[0].event).toMatchObject({
self: true,
viaWorker: true,
});
});
it('delivers to a subscriber who is not the writer', async () => {
const west = makeRegion('west', ['east'], forwardCfg);
const east = makeRegion('east', ['west'], forwardCfg);
@@ -42,7 +42,10 @@ import { runWithContext } from '../../core/context.js';
import { setupPuterTestEnv, type PuterTestEnv } from '../../testUtil.js';
import type { IConfig } from '../../types.js';
import type { DeliveryEnvelope } from './EventsService.js';
import { kvShareManagePermission, kvSharePermission } from './kvShares.js';
import {
kvShareManagePermission,
kvSharePermission,
} from '../kvShare/kvShares.js';
const BOOT_TIMEOUT_MS = 120_000;
const SOCKET_ID = 'kv-delegate-socket';
@@ -64,6 +67,7 @@ let appId: number;
let appActor: Actor;
const events = () => env.server.services.events;
const shares = () => env.server.services.kvShare;
const permissions = () => env.server.services.permission;
const settled = (count = 1) =>
@@ -111,11 +115,15 @@ const undelegate = (prefix = PREFIX) =>
);
const mint = (request: Record<string, unknown> = {}, actor = appActor) =>
events().mintKvHandle(actor, {
granteeUsername: guest.username,
prefix: PREFIX,
...request,
});
shares().mintKvHandle(
actor,
{
prefix: PREFIX,
...request,
recipient: { username: guest.username },
},
{ defaultAccess: 'watch' },
);
const clearRows = async () => {
await env.server.clients.db.write(`DELETE FROM \`${TABLE}\``, []);
@@ -191,7 +199,7 @@ describe('an app minting without consent', () => {
legacyCode: 'events_kv_handle_not_delegated',
});
// The share itself is untouched: what was refused is the app asking.
const page = await events().listKvHandles(owner.actor, { limit: 100 });
const page = await shares().listKvHandles(owner.actor, { limit: 100 });
expect(page.items).toContainEqual(
expect.objectContaining({ handle, revokedAt: null }),
);
@@ -405,14 +413,14 @@ describe('an app minting with consent', () => {
it('shows up in the owner`s listing of what they have shared out', async () => {
const { handle } = await mint();
const page = await events().listKvHandles(owner.actor, { limit: 100 });
const page = await shares().listKvHandles(owner.actor, { limit: 100 });
expect(page.items).toContainEqual(
expect.objectContaining({
handle,
prefix: PREFIX,
appUid,
granteeUsername: guest.username,
holderUsername: guest.username,
revokedAt: null,
}),
);
@@ -454,7 +462,7 @@ describe('a handle an app minted', () => {
handlerName: 'onChange',
});
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
await vi.waitFor(
async () => {
const [row] = (await env.server.clients.db.pread(
@@ -540,7 +548,7 @@ describe('a grantee subscribing through their own app actor', () => {
await settled();
expect(delivered[0].subId).toBe(sub.subId);
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
delivered.length = 0;
await appWrites(`${PREFIX}live:2`, 2);
@@ -573,7 +581,7 @@ describe('an app managing what it minted', () => {
handlerName: 'onChange',
});
await events().revokeKvHandle(appActor, handle);
await shares().revokeKvHandle(appActor, handle);
await vi.waitFor(
async () => {
const [row] = (await env.server.clients.db.pread(
@@ -592,7 +600,7 @@ describe('an app managing what it minted', () => {
),
).resolves.toBe(false);
const page = await events().listKvHandles(owner.actor, { limit: 100 });
const page = await shares().listKvHandles(owner.actor, { limit: 100 });
expect(
page.items.find((one) => one.handle === handle)?.revokedAt,
).toBeTypeOf('number');
@@ -607,10 +615,10 @@ describe('an app managing what it minted', () => {
const prefix = `${PREFIX}session-in-app-${uuidv4().slice(0, 8)}:`;
const { handle } = await mint({ appUid, prefix }, owner.actor);
const revoked = await events().revokeKvHandle(appActor, handle);
const revoked = await shares().revokeKvHandle(appActor, handle);
expect(revoked.handle).toBe(handle);
const page = await events().listKvHandles(owner.actor, { limit: 100 });
const page = await shares().listKvHandles(owner.actor, { limit: 100 });
expect(
page.items.find((one) => one.handle === handle)?.revokedAt,
).toBeTypeOf('number');
@@ -624,7 +632,7 @@ describe('an app managing what it minted', () => {
);
await expect(
events().revokeKvHandle(appActor, handle),
shares().revokeKvHandle(appActor, handle),
).rejects.toMatchObject({ legacyCode: 'events_kv_handle_owner_only' });
});
@@ -647,7 +655,7 @@ describe('an app managing what it minted', () => {
});
await expect(
events().revokeKvHandle(siblingActor, handle),
shares().revokeKvHandle(siblingActor, handle),
).rejects.toMatchObject({ legacyCode: 'events_kv_handle_owner_only' });
});
@@ -665,7 +673,7 @@ describe('an app managing what it minted', () => {
});
await expect(
events().revokeKvHandle(tokenActor, handle),
shares().revokeKvHandle(tokenActor, handle),
).rejects.toMatchObject({ legacyCode: 'events_kv_handle_owner_only' });
});
@@ -679,12 +687,12 @@ describe('an app managing what it minted', () => {
await undelegate(prefix);
await expect(
events().revokeKvHandle(appActor, handle),
shares().revokeKvHandle(appActor, handle),
).rejects.toMatchObject({
legacyCode: 'events_kv_handle_not_delegated',
});
const page = await events().listKvHandles(owner.actor, {
const page = await shares().listKvHandles(owner.actor, {
limit: 100,
});
expect(
@@ -698,7 +706,7 @@ describe('an app managing what it minted', () => {
await mint({ appUid: 'os-global', prefix: sessionPrefix }, owner.actor);
await mint({ prefix: appPrefix });
const appPage = await events().listKvHandles(appActor, {
const appPage = await shares().listKvHandles(appActor, {
limit: 100,
includeTotal: true,
});
@@ -708,7 +716,7 @@ describe('an app managing what it minted', () => {
false,
);
const ownerPage = await events().listKvHandles(owner.actor, {
const ownerPage = await shares().listKvHandles(owner.actor, {
limit: 100,
includeTotal: true,
});
@@ -721,7 +729,7 @@ describe('an app managing what it minted', () => {
const key = `rate:${EVENTS_KV_HANDLE_LIMIT.scope}:${owner.id}`;
const before = await env.server.clients.redis.zcard(key);
await events().revokeKvHandle(appActor, handle);
await shares().revokeKvHandle(appActor, handle);
const after = await env.server.clients.redis.zcard(key);
expect(after).toBe(before + 1);
@@ -729,14 +737,14 @@ describe('an app managing what it minted', () => {
it('answers another user`s handle in the same namespace as absent, not as forbidden', async () => {
const prefix = `cross-user-${uuidv4().slice(0, 8)}:`;
const { handle } = await events().mintKvHandle(guest.actor, {
granteeUsername: owner.username,
appUid,
prefix,
});
const { handle } = await shares().mintKvHandle(
guest.actor,
{ recipient: { username: owner.username }, appUid, prefix },
{ defaultAccess: 'watch' },
);
await expect(
events().revokeKvHandle(appActor, handle),
shares().revokeKvHandle(appActor, handle),
).rejects.toMatchObject({ legacyCode: 'subject_does_not_exist' });
});
@@ -744,7 +752,7 @@ describe('an app managing what it minted', () => {
const prefix = `${PREFIX}revoke-audit-probe-${uuidv4().slice(0, 8)}:`;
const { handle } = await mint({ prefix });
await events().revokeKvHandle(appActor, handle);
await shares().revokeKvHandle(appActor, handle);
const row = await vi.waitFor(async () => {
const [found] = (await env.server.clients.db.pread(
@@ -60,6 +60,7 @@ let stranger: TestUser;
let delivered: DeliveryEnvelope[];
const events = () => env.server.services.events;
const shares = () => env.server.services.kvShare;
const settled = (count = 1) =>
vi.waitFor(() => expect(delivered.length).toBeGreaterThanOrEqual(count), {
@@ -88,10 +89,11 @@ const ownerWrites = (key: string, value: unknown): Promise<unknown> =>
);
const mint = (prefix = PREFIX) =>
events().mintKvHandle(owner.actor, {
granteeUsername: guest.username,
prefix,
});
shares().mintKvHandle(
owner.actor,
{ prefix, recipient: { username: guest.username } },
{ defaultAccess: 'watch' },
);
/** A durable `single` row, which is the only kind that holds a backlog. */
const subscribeDurable = async (handle: string) =>
@@ -182,7 +184,7 @@ describe('revoking a handle', () => {
);
expect(await ownerWatches()).toBe(true);
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
await suspendedRow(sub.subId);
// The anchor leaves the *owner's* watched set, which is the keyspace a
@@ -211,7 +213,7 @@ describe('revoking a handle', () => {
await settled();
expect(delivered[0].subId).toBe(sub.subId);
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
delivered.length = 0;
await ownerWrites(`${PREFIX}live:2`, 2);
@@ -229,16 +231,21 @@ describe('revoking a handle', () => {
const settle = vi.spyOn(events(), 'settleRevokedGrant');
try {
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
await suspendedRow(sub.subId);
// One announcement, one settle pass, one indexed read of the
// holder's rows — no lookup keyed on the handle anywhere.
// One grant settle for the holder, and a retired-handle settle
// for each side, each a single indexed read of that user's rows —
// no lookup keyed on the handle anywhere.
expect(settle).toHaveBeenCalledTimes(1);
expect(byHolder).toHaveBeenCalledTimes(1);
expect(byHolder).toHaveBeenCalledWith(guest.id, null, {
includeSuspended: true,
});
expect(
byHolder.mock.calls.map(([userId]) => userId).sort(),
).toEqual([guest.id, guest.id, owner.id].sort());
for (const call of byHolder.mock.calls)
expect(call.slice(1)).toEqual([
null,
{ includeSuspended: true },
]);
} finally {
byHolder.mockRestore();
settle.mockRestore();
@@ -250,7 +257,7 @@ describe('revoking a handle', () => {
const { handle } = await mint();
const deeper = await mint(`${PREFIX}messages:`);
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
// The subtree goes with the region: a grant left underneath would keep
// access to part of what was just taken back.
@@ -271,12 +278,12 @@ describe('revoking a handle', () => {
const deeper = await mint(`${PREFIX}messages:`);
expect((await countLive()).total).toBe(before.total + 2);
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
// The deeper handle's grant died with the subtree revoke above (proven
// by the sibling case), so its row reading live would disagree with
// reality — both in the listing and in the slot it appears to hold.
const page = await events().listKvHandles(owner.actor, {
const page = await shares().listKvHandles(owner.actor, {
limit: 100,
});
const deeperRow = page.items.find((one) => one.handle === deeper.handle);
@@ -289,9 +296,9 @@ describe('revoking a handle', () => {
const { handle } = await mint();
const sibling = await mint('workspace:other:');
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
const page = await events().listKvHandles(owner.actor, {
const page = await shares().listKvHandles(owner.actor, {
limit: 100,
});
const siblingRow = page.items.find(
@@ -303,7 +310,7 @@ describe('revoking a handle', () => {
it('lets a fresh handle over the same region work, and leaves the old one dead', async () => {
await clearRows();
const first = await mint();
await events().revokeKvHandle(owner.actor, first.handle);
await shares().revokeKvHandle(owner.actor, first.handle);
const second = await mint();
expect(second.handle).not.toBe(first.handle);
@@ -334,7 +341,7 @@ describe('revoking a handle', () => {
: owner.actor;
await expect(
events().revokeKvHandle(actor, handle),
shares().revokeKvHandle(actor, handle),
).rejects.toMatchObject({
legacyCode: 'subject_does_not_exist',
});
@@ -345,8 +352,8 @@ describe('revoking a handle', () => {
// between them leaves a retry to finish the job — which only works if
// reaching a retired handle again succeeds.
const { handle } = await mint();
const first = await events().revokeKvHandle(owner.actor, handle);
const again = await events().revokeKvHandle(owner.actor, handle);
const first = await shares().revokeKvHandle(owner.actor, handle);
const again = await shares().revokeKvHandle(owner.actor, handle);
expect(again).toEqual(first);
});
@@ -365,7 +372,7 @@ describe('revoking a handle', () => {
.spyOn(store, 'retire')
.mockRejectedValueOnce(new Error('write failed'));
await expect(
events().revokeKvHandle(owner.actor, handle),
shares().revokeKvHandle(owner.actor, handle),
).rejects.toThrow('write failed');
failing.mockRestore();
@@ -377,7 +384,7 @@ describe('revoking a handle', () => {
expect(delivered).toEqual([]);
// And the retry converges rather than answering "no such handle".
const revoked = await events().revokeKvHandle(owner.actor, handle);
const revoked = await shares().revokeKvHandle(owner.actor, handle);
expect(revoked.handle).toBe(handle);
expect(await retire(handle, owner.id)).toMatchObject({
revokedAt: revoked.revokedAt,
@@ -398,7 +405,7 @@ describe('revoking a handle', () => {
});
await expect(
events().revokeKvHandle(appActor, handle),
shares().revokeKvHandle(appActor, handle),
).rejects.toMatchObject({
legacyCode: 'events_kv_handle_owner_only',
});
@@ -408,9 +415,9 @@ describe('revoking a handle', () => {
describe('the owner`s handle listing', () => {
it('shows what was shared, retired handles included', async () => {
const { handle } = await mint();
await events().revokeKvHandle(owner.actor, handle);
await shares().revokeKvHandle(owner.actor, handle);
const page = await events().listKvHandles(owner.actor, {
const page = await shares().listKvHandles(owner.actor, {
includeTotal: true,
});
const row = page.items.find((one) => one.handle === handle);
@@ -418,7 +425,9 @@ describe('the owner`s handle listing', () => {
expect(row).toMatchObject({
prefix: PREFIX,
appUid: 'os-global',
granteeUsername: guest.username,
holderUsername: guest.username,
access: 'watch',
revokedBy: 'owner',
});
expect(row?.revokedAt).toBeTypeOf('number');
expect(page.total).toBe(page.items.length + (page.cursor ? 1 : 0));
@@ -426,7 +435,7 @@ describe('the owner`s handle listing', () => {
it('shows the grantee nothing of the owner`s', async () => {
await mint();
const page = await events().listKvHandles(guest.actor);
const page = await shares().listKvHandles(guest.actor);
expect(page.items).toEqual([]);
});
@@ -434,11 +443,11 @@ describe('the owner`s handle listing', () => {
await mint();
await mint();
const first = await events().listKvHandles(owner.actor, { limit: 1 });
const first = await shares().listKvHandles(owner.actor, { limit: 1 });
expect(first.items).toHaveLength(1);
expect(first.cursor).toBeTypeOf('string');
const second = await events().listKvHandles(owner.actor, {
const second = await shares().listKvHandles(owner.actor, {
limit: 1,
cursor: first.cursor,
});
@@ -46,7 +46,7 @@ import {
import type { IConfig } from '../../types.js';
import { DEFAULT_FREE_SUBSCRIPTION } from '../metering/consts.js';
import type { DeliveryEnvelope } from './EventsService.js';
import { kvSharePermission } from './kvShares.js';
import { kvSharePermission } from '../kvShare/kvShares.js';
import { isKvHandleId, kvAnchorToken } from './subjects.js';
const BOOT_TIMEOUT_MS = 120_000;
@@ -68,6 +68,7 @@ let stranger: TestUser;
let delivered: DeliveryEnvelope[];
const events = () => env.server.services.events;
const shares = () => env.server.services.kvShare;
const settled = (count = 1) =>
vi.waitFor(() => expect(delivered.length).toBeGreaterThanOrEqual(count), {
@@ -97,14 +98,34 @@ const ownerWrites = (key: string, value: unknown): Promise<unknown> =>
);
const mint = (
request: Record<string, unknown> = {},
{
granteeUsername = guest.username,
...request
}: Record<string, unknown> = {},
actor: Actor = owner.actor,
) =>
events().mintKvHandle(actor, {
granteeUsername: guest.username,
prefix: PREFIX,
...request,
});
shares().mintKvHandle(
actor,
{
prefix: PREFIX,
...request,
recipient: { username: granteeUsername as string },
},
{ defaultAccess: 'watch' },
);
/** An app row under a fresh uid, since a share may only name an app that exists. */
const registerApp = async (
on: PuterTestEnv = env,
ownerUserId: number = owner.id,
): Promise<string> => {
const uid = `app-${uuidv4()}`;
await on.server.clients.db.write(
'INSERT INTO `apps` (`uid`, `name`, `title`, `index_url`, `owner_user_id`) VALUES (?, ?, ?, ?, ?)',
[uid, uid, uid, `https://${uid}.example/`, ownerUserId],
);
return uid;
};
const clearRows = async () => {
await env.server.clients.db.write(`DELETE FROM \`${TABLE}\``, []);
@@ -148,7 +169,12 @@ describe('minting a handle', () => {
const minted = await mint();
expect(isKvHandleId(minted.handle)).toBe(true);
expect(minted).toEqual({ handle: minted.handle, prefix: PREFIX });
expect(minted).toMatchObject({
handle: minted.handle,
prefix: PREFIX,
access: 'watch',
holderUsername: guest.username,
});
const wire = JSON.stringify(minted);
expect(wire).not.toContain(owner.uuid);
expect(wire).not.toContain(owner.username);
@@ -299,7 +325,8 @@ describe('minting a handle', () => {
});
it('lets a paid namespace fill the account cap and then refuses other namespaces', async () => {
const namespace = 'app-perapp-probe';
const namespace = await registerApp();
const another = await registerApp();
try {
for (let i = 0; i < EVENTS_KV_HANDLES_PER_APP.limit; i++) {
const prefix = `perapp:${i}:`;
@@ -318,20 +345,20 @@ describe('minting a handle', () => {
legacyCode: 'events_kv_handle_limit_reached',
});
await expect(
mint({ appUid: 'app-another-probe', prefix: 'still:room:' }),
mint({ appUid: another, prefix: 'still:room:' }),
).rejects.toMatchObject({
legacyCode: 'events_kv_handle_limit_reached',
});
} finally {
await env.server.clients.db.write(
'DELETE FROM `kv_share_handles` WHERE `owner_user_id` = ? AND `app_uid` IN (?, ?)',
[owner.id, namespace, 'app-another-probe'],
[owner.id, namespace, another],
);
}
});
it('hands back an existing handle at the cap, taking no slot', async () => {
const namespace = 'app-idempotent-probe';
const namespace = await registerApp();
const prefix = 'idempotent:cap:';
try {
const first = await mint({ appUid: namespace, prefix });
@@ -749,7 +776,7 @@ describe('what a plan lets an account hold', () => {
it('holds a free account to the free per-app cap, with room left in the account cap', async () => {
await setEmail(`${tiered.users.user.username}@example.invalid`);
const namespace = 'app-tiered-free-probe';
const namespace = await registerApp(tiered, tieredUserId);
const cap =
EVENTS_KV_HANDLES_PER_APP.bySubscription[DEFAULT_FREE_SUBSCRIPTION];
const grantee = await tiered.server.stores.user.getByUsername(
@@ -783,7 +810,7 @@ describe('what a plan lets an account hold', () => {
// another namespace still succeeds.
const accepted = await mintTiered(
'still:room:',
'app-tiered-free-other',
await registerApp(tiered, tieredUserId),
);
expect(accepted.status).toBe(200);
});
@@ -1,451 +0,0 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { v4 as uuidv4 } from 'uuid';
import { describe, expect, it, vi } from 'vitest';
import type { Actor } from '../../core/actor.js';
import { HttpError } from '../../core/http/HttpError.js';
import { PermissionUtil } from '../permission/permissionUtil.js';
import {
assertBoundedManageGrant,
assertShareableAppUid,
assertShareablePermission,
assertShareablePrefix,
keyPrefixSegments,
kvShareAppDelegateImplicator,
kvShareGrantCovers,
kvShareManagePermission,
kvShareOwnerImplicator,
kvSharePermission,
mintKvHandleId,
normalizeKeyPrefix,
relativeToKvShareRoot,
} from './kvShares.js';
import { isKvHandleId, kvHandleFromSubject } from './subjects.js';
const OWNER = '2a1b0c9d-0000-4000-8000-000000000001';
const OTHER = '2a1b0c9d-0000-4000-8000-000000000002';
const APP = 'app-1234';
const OTHER_APP = 'app-5678';
const userActor = (uuid: string): Actor =>
({ user: { uuid }, effectiveApp: null }) as unknown as Actor;
const appActor = (uuid: string, appUid: string): Actor =>
({
user: { uuid },
app: { uid: appUid },
effectiveApp: { uid: appUid },
}) as unknown as Actor;
describe('the share permission family', () => {
it('names the owner, the app and the granted prefix', () => {
expect(kvSharePermission(OWNER, APP, 'workspace:abc:')).toBe(
`kv-share:${OWNER}:${APP}:workspace:abc`,
);
});
it('makes key segments components, so a deeper key is a descendant', () => {
const granted = kvSharePermission(OWNER, APP, 'workspace:abc:');
const deeper = kvSharePermission(
OWNER,
APP,
'workspace:abc:messages:1',
);
// The exploder walks parents of the string being checked, so implication
// over key segments needs nothing of its own.
expect(deeper.startsWith(`${granted}:`)).toBe(true);
});
it('escapes a `:` inside a component rather than splitting on it', () => {
const permission = kvSharePermission(OWNER, 'app:odd', 'cart:');
expect(PermissionUtil.split(permission)).toEqual([
'kv-share',
OWNER,
'app:odd',
'cart',
]);
});
it('reads a withdrawn grant as covering itself and everything under it', () => {
const granted = kvSharePermission(OWNER, APP, 'workspace:abc:');
expect(kvShareGrantCovers(granted, granted)).toBe(true);
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OWNER, APP, 'workspace:abc:messages:'),
),
).toBe(true);
// A sibling that merely shares a text prefix is a different region.
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OWNER, APP, 'workspace:abcdef:'),
),
).toBe(false);
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OTHER, APP, 'workspace:abc:'),
),
).toBe(false);
// Coverage never crosses namespaces: the app uid is what keeps a
// revoke inside the one the handle was minted in.
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OWNER, OTHER_APP, 'workspace:abc:messages:'),
),
).toBe(false);
});
it('never reads a withdrawn child as covering its own parent', () => {
// Revoking the deeper of two grants must not read as covering the
// shallower one — coverage only ever runs downward.
const child = kvSharePermission(OWNER, APP, 'workspace:abc:messages:');
const parent = kvSharePermission(OWNER, APP, 'workspace:abc:');
expect(kvShareGrantCovers(child, parent)).toBe(false);
});
});
describe('granted prefixes', () => {
it('always ends on the key delimiter', () => {
expect(normalizeKeyPrefix('workspace:abc')).toBe('workspace:abc:');
expect(normalizeKeyPrefix('workspace:abc:')).toBe('workspace:abc:');
expect(keyPrefixSegments('workspace:abc:')).toEqual([
'workspace',
'abc',
]);
});
it.each([
['', 'the whole namespace'],
[':', 'delimiters only'],
['workspace:*', 'a pattern'],
['workspace:a?c', 'a single-character pattern'],
// Normalizing would drop the empty segment and grant `a:b:` instead —
// a region other than the one asked for.
['workspace::abc:', 'an empty key segment'],
[':workspace:abc:', 'a leading empty segment'],
// `escape_permission_component` leaves `\\` alone while escaping `:`,
// so the stored prefix and the permission string would disagree and
// the share would silently never fire.
['work\\space:abc:', 'a backslash'],
])('refuses %s (%s)', (prefix) => {
let thrown: unknown;
try {
assertShareablePrefix(prefix);
} catch (err) {
thrown = err;
}
expect(thrown).toBeInstanceOf(HttpError);
expect((thrown as HttpError).legacyCode).toBe(
'invalid_kv_share_prefix',
);
});
it('refuses a region too deep to fit the grant column', () => {
const deep = kvSharePermission(OWNER, APP, 'a'.repeat(300));
expect(() => assertShareablePermission(deep)).toThrow(HttpError);
expect(
assertShareablePermission(
kvSharePermission(OWNER, APP, 'workspace:abc:'),
),
).toBeTypeOf('string');
});
it('keeps the trailing delimiter optional', () => {
expect(assertShareablePrefix('workspace:abc')).toBe('workspace:abc:');
expect(assertShareablePrefix('workspace:abc:')).toBe('workspace:abc:');
});
});
describe('granted namespaces', () => {
it('takes an app uid, and the app-less namespace', () => {
expect(assertShareableAppUid(APP)).toBe(APP);
expect(assertShareableAppUid('os-global')).toBe('os-global');
});
it('refuses one past the column it is stored in', () => {
// A longer one reaches the insert as a write the column cannot hold.
let thrown: unknown;
try {
assertShareableAppUid('a'.repeat(41));
} catch (err) {
thrown = err;
}
expect(thrown).toBeInstanceOf(HttpError);
expect((thrown as HttpError).statusCode).toBe(400);
});
it('takes both shapes a real app uid comes in', () => {
// Minted (`app-<uuidv4>`) and derived from an origin (`app-<uuidv5>`)
// — 40 characters either way, which is the column exactly.
const minted = `app-${uuidv4()}`;
expect(assertShareableAppUid(minted)).toBe(minted);
expect(minted).toHaveLength(40);
});
it('refuses a handle, which shares the slot but is not a namespace', () => {
expect(() => assertShareableAppUid(mintKvHandleId())).toThrow(
HttpError,
);
});
it('refuses anything else short enough to fit the column', () => {
// The slot ends up in a subject and in a permission string, so a
// namespace carrying a delimiter of either grammar is refused before
// it can be composed into one.
for (const uid of [
'os-globals',
'workspace:abc',
'app',
'app-',
'app-a:b',
'app-a#b',
'v1:someone:app-x',
'',
])
expect(() => assertShareableAppUid(uid)).toThrow(HttpError);
});
});
describe('keys inside a granted region', () => {
const permission = kvSharePermission(OWNER, APP, 'workspace:abc:');
it('are named relative to the granted root', () => {
expect(
relativeToKvShareRoot(permission, 'workspace:abc:messages:1'),
).toBe('messages:1');
});
it('read as outside when they are', () => {
expect(
relativeToKvShareRoot(permission, 'workspace:abcdef:x'),
).toBeNull();
expect(relativeToKvShareRoot(permission, 'workspace:abc')).toBeNull();
});
});
describe('a delegation request', () => {
const region = kvShareManagePermission(
kvSharePermission(OWNER, APP, 'workspace:abc:'),
);
it('is the manage arm of the grant it would let an app issue', () => {
expect(region).toBe(`manage:kv-share:${OWNER}:${APP}:workspace:abc`);
expect(assertBoundedManageGrant(region)).toBe(region);
});
it.each([
['manage:kv-share', 'the family itself'],
[`manage:kv-share:${OWNER}`, 'an owner and no namespace'],
[`manage:kv-share:${OWNER}:${APP}`, 'a whole namespace'],
])('refuses %s (%s)', (permission) => {
let thrown: unknown;
try {
assertBoundedManageGrant(permission);
} catch (err) {
thrown = err;
}
expect(thrown).toBeInstanceOf(HttpError);
expect((thrown as HttpError).legacyCode).toBe(
'invalid_kv_share_prefix',
);
});
it('leaves permissions from other families alone', () => {
const unrelated = `manage:fs:${OWNER}:write`;
expect(assertBoundedManageGrant(unrelated)).toBe(unrelated);
// The read arm of this family is not a delegation, so it is not this
// check's to bound.
expect(assertBoundedManageGrant(`kv-share:${OWNER}:${APP}`)).toBeTypeOf(
'string',
);
});
});
describe('handle ids', () => {
it('are told apart from an app uid in the same slot', () => {
const handle = mintKvHandleId();
expect(isKvHandleId(handle)).toBe(true);
expect(isKvHandleId(APP)).toBe(false);
expect(isKvHandleId('kvh-')).toBe(false);
});
it('carry nothing about the owner', () => {
const handle = mintKvHandleId();
expect(handle).not.toContain(OWNER);
expect(mintKvHandleId()).not.toBe(handle);
});
it('are recoverable from the subject a row stored', () => {
const handle = mintKvHandleId();
expect(kvHandleFromSubject(`kv:${handle}:messages:*`)).toBe(handle);
expect(kvHandleFromSubject(`kv:${APP}:messages:*`)).toBeNull();
expect(kvHandleFromSubject(`fs:${handle}:write`)).toBeNull();
});
});
describe('the owner implicator', () => {
const implicator = kvShareOwnerImplicator();
const permission = kvSharePermission(OWNER, APP, 'workspace:abc:');
it('answers the share family and its manage arm', () => {
expect(implicator.matches(permission)).toBe(true);
expect(implicator.matches(`manage:${permission}`)).toBe(true);
expect(implicator.matches(`fs:${OWNER}:read`)).toBe(false);
});
it('holds for the owner named in the permission, and nobody else', () => {
expect(
implicator.check({ actor: userActor(OWNER), permission }),
).toEqual({});
expect(
implicator.check({
actor: userActor(OWNER),
permission: `manage:${permission}`,
}),
).toEqual({});
expect(
implicator.check({ actor: userActor(OTHER), permission }),
).toBeUndefined();
});
it('reads the owner past a `manage` key segment', () => {
// Stripping every `manage:` rather than the leading one would rewrite
// the string the owner is read out of.
const nested = kvSharePermission(OWNER, APP, 'manage:secrets:');
expect(implicator.matches(nested)).toBe(true);
expect(
implicator.check({ actor: userActor(OWNER), permission: nested }),
).toEqual({});
expect(
implicator.check({ actor: userActor(OTHER), permission: nested }),
).toBeUndefined();
});
it('never answers for an app or a token acting through the owner', () => {
const appActor = {
user: { uuid: OWNER },
app: { uid: APP },
} as unknown as Actor;
expect(
implicator.check({ actor: appActor, permission }),
).toBeUndefined();
});
});
describe('the app delegate implicator', () => {
const permission = kvSharePermission(OWNER, APP, 'workspace:abc:');
it('answers the share family, never its manage arm, nor other families', () => {
const implicator = kvShareAppDelegateImplicator({
userHolds: vi.fn(),
});
expect(implicator.matches(permission)).toBe(true);
expect(implicator.matches(`manage:${permission}`)).toBe(false);
expect(implicator.matches(`fs:${OWNER}:read`)).toBe(false);
});
it("grants when the actor's own app matches the namespace app and the user holds the grant", async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = appActor(OWNER, APP);
await expect(implicator.check({ actor, permission })).resolves.toEqual(
{},
);
expect(userHolds).toHaveBeenCalledTimes(1);
const [calledActor, calledPermission] = userHolds.mock.calls[0];
expect(calledActor.app).toBeUndefined();
expect(calledActor.effectiveApp).toBeNull();
expect(calledActor.user).toEqual({ uuid: OWNER });
expect(calledPermission).toBe(permission);
});
it('refuses when the user does not hold the grant', async () => {
const implicator = kvShareAppDelegateImplicator({
userHolds: vi.fn().mockResolvedValue(false),
});
await expect(
implicator.check({ actor: appActor(OWNER, APP), permission }),
).resolves.toBeUndefined();
});
it("refuses when the actor's app differs from the namespace app", async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
await expect(
implicator.check({
actor: appActor(OWNER, OTHER_APP),
permission,
}),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
it('refuses a plain user actor with no app', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
await expect(
implicator.check({ actor: userActor(OWNER), permission }),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
it('refuses an access-token actor', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = {
user: { uuid: OWNER },
app: { uid: APP },
accessToken: { uid: 't' },
} as unknown as Actor;
await expect(
implicator.check({ actor, permission }),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
it('refuses a permission with no key segments or no app', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = appActor(OWNER, APP);
await expect(
implicator.check({
actor,
permission: PermissionUtil.join('kv-share', OWNER, APP),
}),
).resolves.toBeUndefined();
await expect(
implicator.check({
actor,
permission: PermissionUtil.join('kv-share', OWNER),
}),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
});
-327
View File
@@ -1,327 +0,0 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { randomUUID } from 'node:crypto';
import {
type Actor,
isAppActor,
isPlainUserActor,
userRelatedActor,
} from '../../core/actor.js';
import { HttpError } from '../../core/http/HttpError.js';
import { KV_SHARE_HANDLE_WIDTHS } from '../../stores/events/columnWidths.js';
import { KV_GLOBAL_APP_KEY } from '../../stores/systemKv/SystemKVStore.js';
import {
MANAGE_PERM_PREFIX,
PERMISSION_MAX_LEN,
} from '../permission/consts.js';
import type { PermissionImplicator } from '../permission/permissionUtil.js';
import { PermissionUtil } from '../permission/permissionUtil.js';
import {
isKvHandleId,
KV_HANDLE_PREFIX,
KV_KEY_SEPARATOR,
} from './subjects.js';
/**
* Letting one user watch a region of another's key-value namespace.
*
* The grant is an ordinary user-to-user permission, which is the whole point:
* `manage:` answers "may I delegate this", the exploder's prefix implication
* makes a grant on `workspace:abc:` answer every key beneath it, and revocation
* settling and the delivery re-check key off the stored string exactly as they
* do for a shared folder. Putting the ACL on the key-value item instead would
* take part in none of that, and would tax every write to the item besides.
*
* The permission names the owner, so its components are the three things a
* shared region is:
*
* kv-share:<ownerUserUuid>:<appUid>:<keySegment>...
*
* Key segments are components rather than one escaped blob because that is what
* makes prefix implication work without a rule of its own: the check a deep key
* runs is a descendant of the grant string, and the existing parent walk finds
* it. The grantee never sees this string — the handle is the name on the wire.
*/
/** Root of the cross-user key-value share namespace. */
export const KV_SHARE_PERMISSION_PREFIX = 'kv-share';
/** Width of the `app_uid` column the handle row stores its namespace in. */
export const KV_SHARE_APP_UID_MAX_LENGTH = KV_SHARE_HANDLE_WIDTHS.appUid.max;
export const mintKvHandleId = (): string =>
`${KV_HANDLE_PREFIX}${randomUUID()}`;
/** The key segments a prefix contributes to a permission string. */
export const keyPrefixSegments = (keyPrefix: string): string[] =>
keyPrefix.split(KV_KEY_SEPARATOR).filter((segment) => segment.length > 0);
/**
* A granted prefix as it is stored: always ending on the key delimiter, so
* `keyPrefix + relative` is a whole key and the region never accidentally
* includes the key that names it.
*/
export const normalizeKeyPrefix = (keyPrefix: string): string => {
const segments = keyPrefixSegments(keyPrefix);
return segments.length === 0
? ''
: `${segments.join(KV_KEY_SEPARATOR)}${KV_KEY_SEPARATOR}`;
};
export const kvSharePermission = (
ownerUserUuid: string,
appUid: string,
keyPrefix: string,
): string =>
PermissionUtil.join(
KV_SHARE_PERMISSION_PREFIX,
ownerUserUuid,
appUid,
...keyPrefixSegments(keyPrefix),
);
export const isKvSharePermission = (permission: string): boolean =>
permission === KV_SHARE_PERMISSION_PREFIX ||
permission.startsWith(`${KV_SHARE_PERMISSION_PREFIX}:`);
/**
* Whether withdrawing `revoked` takes `held` with it. Prefix implication read
* backwards: a grant answers every check at or beneath it, so withdrawing it
* puts every one of those in question.
*/
export const kvShareGrantCovers = (revoked: string, held: string): boolean =>
held === revoked || held.startsWith(`${revoked}:`);
/** The granted root a share grant names, read back as a key prefix. */
export const kvShareGrantPrefix = (permission: string): string =>
normalizeKeyPrefix(
PermissionUtil.split(permission).slice(3).join(KV_KEY_SEPARATOR),
);
/**
* A key inside a granted region, named the way its holder addresses it, or
* `null` for one outside. The handle is the granted root, so everything the
* holder is shown is relative to it — an absolute key would name a namespace
* they cannot address and were never told about.
*/
export const relativeToKvShareRoot = (
permission: string,
key: string,
): string | null => {
const prefix = kvShareGrantPrefix(permission);
if (!prefix || !key.startsWith(prefix)) return null;
return key.slice(prefix.length);
};
// -- Minting input ----------------------------------------------------
export const invalidPrefix = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'invalid_kv_share_prefix' });
export const invalidAppUid = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'bad_request' });
/**
* The region a handle may be minted on. A pattern is refused because a handle
* names a region rather than selecting within one, and the namespace root is
* refused because a handle over everything the app holds is not a bounded
* capability — it is the app's data, and sharing that is a different decision
* with a different consent.
*/
export const assertShareablePrefix = (keyPrefix: unknown): string => {
if (typeof keyPrefix !== 'string')
throw invalidPrefix('`prefix` must be a string');
if (keyPrefix.includes('*') || keyPrefix.includes('?'))
throw invalidPrefix('A share prefix is a key prefix, not a pattern');
// `escape_permission_component` escapes `:` as `\C` but leaves `\` alone,
// so a prefix carrying one desynchronizes the stored `key_prefix` from the
// permission string and the share silently never fires.
if (keyPrefix.includes('\\'))
throw invalidPrefix('A share prefix may not contain a backslash');
// Normalizing drops empty segments, so `a::b:` would silently become a
// grant on `a:b:` — a region other than the one asked for. Refused rather
// than rewritten; only the trailing delimiter is optional.
const written = keyPrefix.split(KV_KEY_SEPARATOR);
if (written[written.length - 1] === '') written.pop();
if (written.some((segment) => segment === ''))
throw invalidPrefix('A share prefix may not have an empty key segment');
const normalized = normalizeKeyPrefix(keyPrefix);
if (normalized === '')
throw invalidPrefix('A share prefix may not be the whole namespace');
return normalized;
};
/**
* The shape every app uid takes, minted or derived from an origin. Narrow on
* purpose: `:` and `#` delimit the anchor token and permission grammars, so
* excluding them matters as much as excluding the handle prefix does.
*/
const APP_UID_SHAPE = /^app-[A-Za-z0-9_-]{1,64}$/;
/** Fixed namespaces with no app of their own. */
const FIXED_KV_NAMESPACES: readonly string[] = [KV_GLOBAL_APP_KEY];
/**
* The namespace a handle may be minted over: the caller's own app slot, or the
* app-less one. Bounded by the column that stores it, shaped like a real app
* uid or one of the platform's fixed namespaces, and never handle-shaped, since
* the two share the app slot of a `kv:` subject.
*/
export const assertShareableAppUid = (appUid: string): string => {
if (appUid.length > KV_SHARE_APP_UID_MAX_LENGTH)
throw invalidAppUid(
`\`appUid\` may not exceed ${KV_SHARE_APP_UID_MAX_LENGTH} characters`,
);
if (isKvHandleId(appUid))
throw invalidAppUid('A share handle does not name a namespace');
if (!APP_UID_SHAPE.test(appUid) && !FIXED_KV_NAMESPACES.includes(appUid))
throw invalidAppUid('`appUid` does not name a namespace');
return appUid;
};
/**
* The grant a mint would issue, refused when it would not fit the column every
* permission table declares. Key prefixes run to a kilobyte and permissions do
* not, so the real bound on how deep a region may be is this one.
*/
export const assertShareablePermission = (permission: string): string => {
if (permission.length > PERMISSION_MAX_LEN)
throw invalidPrefix(
`A share prefix must leave the grant under ${PERMISSION_MAX_LEN} characters`,
);
return permission;
};
// -- Delegation -------------------------------------------------------
/** The delegation arm of a share grant: authority to hand the region out. */
export const kvShareManagePermission = (permission: string): string =>
PermissionUtil.join(
MANAGE_PERM_PREFIX,
...PermissionUtil.split(permission),
);
export const KV_SHARE_MANAGE_PREFIX = `${MANAGE_PERM_PREFIX}:${KV_SHARE_PERMISSION_PREFIX}`;
export const isKvShareManagePermission = (permission: string): boolean =>
permission === KV_SHARE_MANAGE_PREFIX ||
permission.startsWith(`${KV_SHARE_MANAGE_PREFIX}:`);
/**
* A delegation must name a subtree. Consent on the namespace root reads as "let
* this app hand out anything it has stored for you", which is not a bounded
* capability and so is not something a prompt can put to a user.
*/
export const assertBoundedManageGrant = (permission: string): string => {
if (!isKvShareManagePermission(permission)) return permission;
const [, , owner, appUid, ...segments] = PermissionUtil.split(permission);
if (!owner || !appUid || segments.length === 0)
throw invalidPrefix(
'A share delegation must name a region, not the whole namespace',
);
return permission;
};
/**
* The unbounded `manage:` grant a bounded delegation's own permission descends
* from. The consent surface refuses to ever write this row, but
* `canManagePermission` walks ancestors to decide "may I delegate this", so if
* it exists by any other path it would silently authorize a mint anywhere in
* the namespace — this is what lets the mint path notice it regardless.
*/
export const kvShareManageNamespaceRoot = (permission: string): string => {
const [, owner, appUid] = PermissionUtil.split(permission);
return PermissionUtil.join(
MANAGE_PERM_PREFIX,
KV_SHARE_PERMISSION_PREFIX,
owner,
appUid,
);
};
// -- Permission rules -------------------------------------------------
/**
* The permission a `manage:` arm delegates over. Only the leading component is
* stripped: a key segment may itself be `manage`, and taking those out would
* change which string the owner is read from.
*/
const withoutManageArm = (permission: string): string =>
permission.startsWith(`${MANAGE_PERM_PREFIX}:`)
? permission.slice(MANAGE_PERM_PREFIX.length + 1)
: permission;
/**
* Owning the namespace is holding every share grant over it, and being able to
* issue them. Without this the owner cannot mint a handle on their own data:
* `grantUserUserPermission` asks `canManagePermission` first, and there is no
* row anywhere saying a user may manage what is already theirs.
*
* Restricted to plain user actors, as the filesystem's `is-owner` is. An app
* disposing of a region of its user's namespace is delegation, which is the
* `manage:` grant's job rather than this one's.
*/
export const kvShareOwnerImplicator = (): PermissionImplicator => ({
id: 'kv-share-is-owner',
shortcut: true,
matches: (permission: string): boolean =>
isKvSharePermission(withoutManageArm(permission)),
check: ({ actor, permission }): unknown => {
if (!isPlainUserActor(actor)) return undefined;
const uuid = actor.user?.uuid;
if (!uuid) return undefined;
const owner = PermissionUtil.split(withoutManageArm(permission))[1];
return owner === uuid ? {} : undefined;
},
});
/**
* Letting an app-under-user actor exercise a `kv-share:` grant its user holds,
* bounded to the app the grant's namespace names.
*
* Only the read arm is matched — never `manage:kv-share:…` — because answering
* the manage arm here would read as the unbounded namespace-root delegation and
* break minting for everyone (see `kvShareManageNamespaceRoot`). The
* namespace-app check keeps one app from reading a region shared with another
* app of the same user.
*/
export const kvShareAppDelegateImplicator = (deps: {
userHolds: (actor: Actor, permission: string) => Promise<boolean>;
}): PermissionImplicator => ({
id: 'kv-share-app-delegate',
shortcut: true,
matches: (permission: string): boolean => isKvSharePermission(permission),
check: async ({ actor, permission }): Promise<unknown> => {
if (!isAppActor(actor)) return undefined;
const app = actor.effectiveApp;
if (!app?.uid) return undefined;
const [, owner, namespaceApp, ...segments] =
PermissionUtil.split(permission);
if (!owner || !namespaceApp || segments.length === 0) return undefined;
if (namespaceApp !== app.uid) return undefined;
return (await deps.userHolds(userRelatedActor(actor), permission))
? {}
: undefined;
},
});
+24 -1
View File
@@ -43,10 +43,20 @@ const PROJECTED_KEYS = [
'subject',
'ts',
'uid',
'viaWorker',
];
/** A KV event names a key where an FS event names a node. */
const PROJECTED_KV_KEYS = ['id', 'key', 'op', 'self', 'seq', 'subject', 'ts'];
const PROJECTED_KV_KEYS = [
'id',
'key',
'op',
'self',
'seq',
'subject',
'ts',
'viaWorker',
];
const entry = {
id: 42,
@@ -195,11 +205,24 @@ describe('the kv subject', () => {
op: 'set',
key: 'cart:items',
self: true,
viaWorker: false,
ts: 1_700_000_002,
seq: 0,
});
});
it('says whether server-side code made the change, on kv and fs alike', () => {
expect(
subject().project({ ...kvDelivery, viaWorker: true }),
).toMatchObject({ viaWorker: true });
expect(
lookupFsSubject('fs.write.file')!.project({
...delivery,
viaWorker: true,
}),
).toMatchObject({ viaWorker: true });
});
it('names the namespace app, never the namespace itself', () => {
const projected = subject().project(kvDelivery) as Record<
string,
+15
View File
@@ -64,6 +64,11 @@ export interface ProjectedFsEvent extends ProjectedEventBase {
path: string;
/** Present only on a `move` a subscribed folder lost the node from. */
from?: string;
/**
* The change was made by server-side code running as the account (a worker,
* or an events handler) rather than by the account directly.
*/
viaWorker: boolean;
}
/**
@@ -80,6 +85,8 @@ export interface ProjectedKvEvent extends ProjectedEventBase {
* value is small enough to inline; an `expire` never carries one.
*/
value?: unknown;
/** See {@link ProjectedFsEvent.viaWorker}. */
viaWorker: boolean;
}
/**
@@ -142,6 +149,8 @@ export interface EventContextBase {
ts: number;
/** Handler runs behind the change. Never projected. */
handlerDepth?: number;
/** Made by server-side code running as the account; see `viaWorkerOf`. */
viaWorker?: boolean;
}
/** What dispatch knows about one committed filesystem change. */
@@ -284,6 +293,7 @@ const fsProject =
path: delivery.entry.path,
...(delivery.movedFrom ? { from: delivery.movedFrom.path } : {}),
self: delivery.self,
viaWorker: delivery.viaWorker === true,
ts: delivery.ts,
seq: delivery.seq,
});
@@ -309,6 +319,7 @@ const kvProject = (delivery: KvDeliveryContext): ProjectedKvEvent => ({
key: delivery.kvKey,
...(delivery.value !== undefined ? { value: delivery.value } : {}),
self: delivery.self,
viaWorker: delivery.viaWorker === true,
ts: delivery.ts,
seq: delivery.seq,
});
@@ -429,6 +440,10 @@ export const UNPUBLISHED_INTERNAL_EVENTS = [
event: 'kv.flushed',
reason: 'No subject addresses "the whole namespace went": the grammar anchors on a key or a prefix, and fanning a flush out per key would report keys a truncated enumeration never saw.',
},
{
event: 'kv.share.retired',
reason: 'A share handle stopping is not a change to any key; it ends the subscriptions made through the handle rather than being delivered to them.',
},
] as const satisfies readonly UnpublishedInternalEvent[];
// Every `fs.*`/`kv.*`/`notif.*` bus key needs a decision. A new key that is in
+4
View File
@@ -194,6 +194,10 @@ export const notifMatchOn = (
audience: NotificationAudience | string,
): string => `${ref}${NOTIF_MATCH_SEPARATOR}${audience}`;
/** Whether a notif filter spans every app: a session's generic slice. */
export const notifMatchSpansEveryApp = (match: string | null): boolean =>
match?.startsWith(`*${NOTIF_MATCH_SEPARATOR}`) === true;
/** Which family a stored row belongs to, without re-parsing its subject. */
export const isKvToken = (token: string): boolean =>
token.startsWith(KV_TOKEN_PREFIX);
@@ -425,6 +425,7 @@ describe('the call an owed delivery makes', () => {
'subject',
'ts',
'uid',
'viaWorker',
]);
expect(call.body.event).toMatchObject({
path: `${anchor}/note.txt`,
+38
View File
@@ -4749,6 +4749,25 @@ describe('FSService move', () => {
expect(await readBack(overwritten)).toBe('winner');
});
it('refuses to overwrite a directory the moved entry sits inside', async () => {
const outer = await fs.mkdir(user.userId, {
path: `${user.home}/Documents/nest/photos/photos`,
createMissingParents: true,
});
await writeFile(user, `${user.home}/Documents/nest/photos/photos/a.txt`, 'keep');
const nest = (await entryAt(user, '/Documents/nest'))!;
const refused = await caught(() =>
fs.move(user.userId, {
source: outer,
destinationParent: nest,
overwrite: true,
}),
);
expect(refused.statusCode).toBe(400);
expect(await entryAt(user, '/Documents/nest/photos/photos/a.txt')).toBeTruthy();
});
/**
* Reproduce an occupant arriving after the collision probe: the probe
* misses it (a concurrent move, or a replica that hasn't caught up) and the
@@ -5038,6 +5057,25 @@ describe('FSService copy', () => {
).toBe('cannot_copy_directory_into_itself');
});
it('refuses to overwrite a directory the copied entry sits inside', async () => {
const inner = await fs.mkdir(user.userId, {
path: `${user.home}/Documents/cp-nest/photos/photos`,
createMissingParents: true,
});
await writeFile(user, `${user.home}/Documents/cp-nest/photos/photos/a.txt`, 'keep');
const nest = (await entryAt(user, '/Documents/cp-nest'))!;
const refused = await caught(() =>
fs.copy(user.userId, {
source: inner,
destinationParent: nest,
overwrite: true,
}),
);
expect(refused.statusCode).toBe(400);
expect(await entryAt(user, '/Documents/cp-nest/photos/photos/a.txt')).toBeTruthy();
});
it('handles a destination collision by conflict, overwrite or dedupe', async () => {
const destination = (await entryAt(user, '/Desktop'))!;
const source = await writeFile(
+33 -12
View File
@@ -41,6 +41,7 @@ import {
isAccountContext,
isAppActor,
isPlainUserActor,
viaWorkerOf,
} from '../../core/actor.js';
import { Context } from '../../core/context.js';
import { HttpError } from '../../core/http/HttpError.js';
@@ -3672,18 +3673,17 @@ export class FSService extends PuterService {
updates.filter(isValid),
);
let next = 0;
return updates.map(
(update): PromiseSettledResult<FSEntry> =>
isValid(update)
? stored[next++]
: {
status: 'rejected',
reason: new HttpError(
400,
'Invalid file entry identifier for thumbnail update',
{ legacyCode: 'bad_request' },
),
},
return updates.map((update): PromiseSettledResult<FSEntry> =>
isValid(update)
? stored[next++]
: {
status: 'rejected',
reason: new HttpError(
400,
'Invalid file entry identifier for thumbnail update',
{ legacyCode: 'bad_request' },
),
},
);
}
@@ -4794,6 +4794,7 @@ export class FSService extends PuterService {
const actor = Context.get('actor') as Actor | undefined;
const actingUserId = actor?.user?.id;
const handlerDepth = handlerDepthOf(actor);
const viaWorker = viaWorkerOf(actor);
const movedFromChain = movedFrom && {
path: movedFrom.path,
ancestors: () => fsEntry.getAncestorChain(movedFrom.path),
@@ -4807,6 +4808,7 @@ export class FSService extends PuterService {
events.dispatchFs(key, entry, {
actingUserId,
handlerDepth,
viaWorker,
ancestors: () => ancestors(entry),
...(movedFromChain
? { movedFrom: movedFromChain }
@@ -4987,6 +4989,7 @@ export class FSService extends PuterService {
if (collision && collision.uuid !== source.uuid) {
name = await this.#resolveMoveCollision(
userId,
source,
collision,
destinationParent,
name,
@@ -5039,6 +5042,7 @@ export class FSService extends PuterService {
if (raced && raced.uuid !== source.uuid) {
name = await this.#resolveMoveCollision(
userId,
source,
raced,
destinationParent,
name,
@@ -5101,6 +5105,7 @@ export class FSService extends PuterService {
*/
async #resolveMoveCollision(
userId: number,
source: FSEntry,
occupant: FSEntry,
destinationParent: FSEntry,
name: string,
@@ -5112,6 +5117,7 @@ export class FSService extends PuterService {
return this.#findDedupedName(destinationParent, name);
}
if (input.overwrite) {
this.#assertNotReplacingAncestor(source, occupant);
await this.remove(userId, { entry: occupant, recursive: true });
return name;
}
@@ -5127,6 +5133,20 @@ export class FSService extends PuterService {
});
}
/**
* Refuse to overwrite a directory the source sits inside: removing it would
* take the source down with it.
*/
#assertNotReplacingAncestor(source: FSEntry, occupant: FSEntry): void {
if (occupant.isDir && source.path.startsWith(`${occupant.path}/`)) {
throw new HttpError(
400,
`Cannot replace \`${occupant.name}\`: it contains the item being moved or copied`,
{ legacyCode: 'bad_request' },
);
}
}
/**
* Copy an entry to a new parent. For directories, walks descendants and
* issues S3 CopyObject + DB inserts. Thumbnail URLs on entries ride along
@@ -5196,6 +5216,7 @@ export class FSService extends PuterService {
if (collision) {
if (input.overwrite) {
this.#assertNotReplacingAncestor(source, collision);
await this.remove(userId, {
entry: collision,
recursive: true,
+5 -1
View File
@@ -33,6 +33,7 @@ import { EventForwardService } from './events/EventForwardService';
import { EventsService } from './events/EventsService';
import { AppFeedbackService } from './feedback/AppFeedbackService';
import { FSService } from './fs/FSService';
import { KvShareService } from './kvShare/KvShareService';
import { ServerHealthService } from './health/ServerHealthService';
import { PuterHomepageService } from './homepage/PuterHomepageService';
import { LocalWorkerService } from './localworker/LocalWorkerService';
@@ -74,6 +75,7 @@ declare module './types' {
suggestedApps: SuggestedAppsService;
app: AppService;
socket: SocketService;
kvShare: KvShareService;
events: EventsService;
eventForward: EventForwardService;
notification: NotificationService;
@@ -121,7 +123,6 @@ export const puterServices = {
// Declared after `fs` — account teardown tears the user's filesystem down
// first.
userAccount: UserAccountService,
// Leaf: team + user stores only.
// Reaches `team` and `socket` at call time only.
signup: SignupService,
// AppPermissionService + SubdomainPermissionService register permission
@@ -135,6 +136,9 @@ export const puterServices = {
// Reaches `auth` and `permission` at call time only.
app: AppService,
socket: SocketService,
// Registers the share-grant implicators with `permission`, and reaches
// `permission`, `metering` and `notification` at call time only.
kvShare: KvShareService,
// Delivers through `socket` and resolves paths through `fs`, so it follows
// both; `fs` reaches back for dispatch at call time only.
events: EventsService,
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,365 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* Withdrawing a share against a replica that lags the primary, and the MySQL
* matching rules a share's grants and rows meet. Runs on SQLite, and also on
* MySQL when `PUTER_TEST_MYSQL_PORT` names one.
*/
import { fileURLToPath } from 'node:url';
import mysql from 'mysql2/promise';
import { v4 as uuidv4 } from 'uuid';
import {
afterAll,
beforeAll,
beforeEach,
describe,
expect,
it,
vi,
} from 'vitest';
import { EVENTS_KV_HANDLE_LIMIT } from '../../controllers/events/limits.js';
import { makeActor, type Actor } from '../../core/actor.js';
import { runWithContext } from '../../core/context.js';
import { setupPuterTestEnv, type PuterTestEnv } from '../../testUtil.js';
import type { IConfig } from '../../types.js';
import {
kvShareGrantAtEveryLevel,
kvSharePermission,
type KvShareAccess,
} from './kvShares.js';
const BOOT_TIMEOUT_MS = 300_000;
const GLOBAL = 'os-global';
const MYSQL = {
host: '127.0.0.1',
port: Number(process.env.PUTER_TEST_MYSQL_PORT ?? 3307),
user: 'root',
password: 'puter',
};
const MIGRATIONS = fileURLToPath(
new URL('../../clients/database/migrations/mysql', import.meta.url),
);
const ENGINES = [
'sqlite',
...(process.env.PUTER_TEST_MYSQL_PORT ? ['mysql'] : []),
] as const;
interface TestUser {
actor: Actor;
username: string;
id: number;
uuid: string;
}
describe.each(ENGINES)('key-value shares on %s', (engine) => {
const database = `kv_share_${Date.now().toString(36)}`;
let env: PuterTestEnv;
let owner: TestUser;
let guest: TestUser;
const db = () => env.server.clients.db;
const shares = () => env.server.services.kvShare;
const permissions = () => env.server.services.permission;
const handles = () => env.server.stores.kvShareHandle;
const flat = () => env.server.stores.permission;
const userFor = async (username: string): Promise<TestUser> => {
const row = await env.server.stores.user.getByUsername(username);
return {
actor: makeActor({ user: row as never }),
username,
id: row!.id,
uuid: row!.uuid as string,
};
};
const region = (label: string) => `${label}-${uuidv4().slice(0, 8)}:`;
const share = (prefix: string, access: KvShareAccess) =>
shares().mintKvHandle(
owner.actor,
{ prefix, recipient: { username: guest.username }, access },
{ defaultAccess: 'read' },
);
const grantRows = async (prefix: string) =>
(
await db().pread(
'SELECT `permission` FROM `user_to_user_permissions` ' +
'WHERE `holder_user_id` = ? AND `permission` IN (?, ?, ?)',
[
guest.id,
...kvShareGrantAtEveryLevel(
kvSharePermission(owner.uuid, GLOBAL, prefix),
),
],
)
).map((row) => String(row.permission));
/**
* From here until the returned function runs, replica reads see the grant
* table as it is now and primary reads see it as it really is.
*/
const lagReplica = async () => {
await db().write('DROP TABLE IF EXISTS `u2u_lagging`');
await db().write(
'CREATE TABLE `u2u_lagging` AS SELECT * FROM `user_to_user_permissions`',
);
const read = db().read.bind(db());
const replica = vi
.spyOn(db(), 'read')
.mockImplementation((query, params) =>
read(
query.replaceAll(
'`user_to_user_permissions`',
'`u2u_lagging`',
),
params,
),
);
// SQLite's own primary read goes through `read`, so route it past the
// lagging view explicitly.
const primary = vi
.spyOn(db(), 'pread')
.mockImplementation((query, params) => read(query, params));
return async () => {
replica.mockRestore();
primary.mockRestore();
await db().write('DROP TABLE `u2u_lagging`');
};
};
/** No row, no flat entry, and no write reaching a later nested share. */
const expectWithdrawn = async (prefix: string) => {
expect(await grantRows(prefix)).toEqual([]);
expect(
await flat().getFlatUserPerms(
guest.id,
kvShareGrantAtEveryLevel(
kvSharePermission(owner.uuid, GLOBAL, prefix),
),
),
).toEqual([]);
const nested = await share(`${prefix}nested:`, 'watch');
await expect(
runWithContext({ actor: guest.actor }, () =>
env.server.drivers.kvStore.set({
key: 'k',
value: 1,
optConfig: { handle: nested.handle },
}),
),
).rejects.toMatchObject({ legacyCode: 'kv_handle_access_denied' });
};
beforeAll(async () => {
const flags = {
events: { enabled: true, kvHandles: true },
kv: { shareHandles: true },
unlimitedMetering: true,
};
if (engine === 'mysql') {
const admin = await mysql.createConnection(MYSQL);
await admin.query(`CREATE DATABASE \`${database}\``);
await admin.end();
env = await setupPuterTestEnv({
...flags,
database: {
engine: 'mysql',
...MYSQL,
database,
migrationPaths: [MIGRATIONS],
},
} as never);
} else {
env = await setupPuterTestEnv(flags as IConfig);
}
owner = await userFor(env.users.user.username);
guest = await userFor(env.users.other.username);
}, BOOT_TIMEOUT_MS);
afterAll(async () => {
await env?.shutdown();
if (engine !== 'mysql') return;
const admin = await mysql.createConnection(MYSQL);
await admin.query(`DROP DATABASE IF EXISTS \`${database}\``);
await admin.end();
});
beforeEach(async () => {
for (const user of [owner, guest])
await env.server.clients.redis.del(
`rate:${EVENTS_KV_HANDLE_LIMIT.scope}:${user.id}`,
);
});
describe('an owner revoke while the replica lags', () => {
it('withdraws a share minted inside the lag', async () => {
const prefix = region('lag-mint');
const thaw = await lagReplica();
try {
const { handle } = await share(prefix, 'write');
await shares().removeKvShare(owner.actor, handle);
} finally {
await thaw();
}
await expectWithdrawn(prefix);
});
it('withdraws the write grant of a read share raised inside the lag', async () => {
const prefix = region('lag-raise');
const { handle } = await share(prefix, 'read');
const thaw = await lagReplica();
try {
await share(prefix, 'write');
await shares().removeKvShare(owner.actor, handle);
} finally {
await thaw();
}
await expectWithdrawn(prefix);
});
it('clears a flat entry under the region that no row backs', async () => {
const prefix = region('orphan');
const { handle } = await share(prefix, 'read');
const orphan = kvSharePermission(
owner.uuid,
GLOBAL,
`${prefix}deep:`,
'write',
);
await flat().setFlatUserPerm(guest.id, orphan, {
permission: orphan,
issuer_user_id: owner.id,
deleted: false,
});
await shares().removeKvShare(owner.actor, handle);
expect(await flat().getFlatUserPerms(guest.id, [orphan])).toEqual(
[],
);
});
});
describe('matching a share`s prefix', () => {
it('finds a live share by its exact bytes only', async () => {
const prefix = region('exact');
await share(prefix, 'read');
const input = {
ownerUserId: owner.id,
granteeUserId: guest.id,
appUid: GLOBAL,
keyPrefix: prefix,
};
expect(await handles().findLive(input)).not.toBeNull();
expect(
await handles().findLive({
...input,
keyPrefix: prefix.toUpperCase(),
}),
).toBeNull();
});
it.skipIf(engine !== 'mysql')(
'uses no operator MySQL warns is deprecated, whatever the connection charset',
async () => {
const pread = vi.spyOn(db(), 'pread');
let call: unknown[] | undefined;
try {
await handles().findLive({
ownerUserId: owner.id,
granteeUserId: guest.id,
appUid: GLOBAL,
keyPrefix: region('warn'),
});
call = pread.mock.calls.find(([query]) =>
query.includes('`key_prefix`'),
);
} finally {
pread.mockRestore();
}
expect(call).toBeDefined();
// The text protocol, so the statement is parsed (and warned
// about) as it runs.
const connection = await mysql.createConnection({
...MYSQL,
database,
charset: 'LATIN1_SWEDISH_CI',
});
try {
await connection.query(
String(call![0]),
call![1] as never[],
);
const [warnings] = await connection.query('SHOW WARNINGS');
expect(warnings).toEqual([]);
} finally {
await connection.end();
}
},
);
});
describe('revoking a grant the database spells differently', () => {
it.skipIf(engine !== 'mysql')(
'clears the flat entry under the spelling it removed',
async () => {
const tag = uuidv4().slice(0, 8);
const stored = kvSharePermission(
owner.uuid,
GLOBAL,
`Notes-${tag}:`,
'read',
);
const asked = kvSharePermission(
owner.uuid,
GLOBAL,
`notes-${tag}:`,
'read',
);
await permissions().grantUserUserPermission(
owner.actor,
guest.username,
stored,
);
expect(await permissions().check(guest.actor, stored)).toBe(
true,
);
const removed = await permissions().revokeUserUserPermissions(
owner.actor,
guest.username,
[asked],
);
expect(removed).toEqual([stored]);
expect(
await flat().getFlatUserPerms(guest.id, [stored]),
).toEqual([]);
expect(await permissions().check(guest.actor, stored)).toBe(
false,
);
},
);
});
});
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,549 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* What the recipient of a key-value share sees and controls: the notification
* that tells their app a share arrived, kept off their desktop, and the share
* blocks that refuse one.
*/
import { v4 as uuidv4 } from 'uuid';
import {
afterAll,
beforeAll,
beforeEach,
describe,
expect,
it,
vi,
} from 'vitest';
import {
EVENTS_COALESCE_WINDOW_MS,
EVENTS_KV_HANDLE_LIMIT,
KV_SHARE_NOTICE_LIMIT,
} from '../../controllers/events/limits.js';
import { makeActor, type Actor } from '../../core/actor.js';
import { runWithContext } from '../../core/context.js';
import { setupPuterTestEnv, type PuterTestEnv } from '../../testUtil.js';
import type { IConfig } from '../../types.js';
import type { DeliveryEnvelope } from '../events/EventsService.js';
import type { KvShareAccess } from './kvShares.js';
const BOOT_TIMEOUT_MS = 120_000;
interface TestUser {
actor: Actor;
username: string;
id: number;
uuid: string;
}
/** One server, its two users, and a fresh app the owner can share data of. */
const bootEnv = (config: Record<string, unknown>) => {
const state = {
env: null as unknown as PuterTestEnv,
owner: null as unknown as TestUser,
guest: null as unknown as TestUser,
};
const userFor = async (username: string): Promise<TestUser> => {
const row = await state.env.server.stores.user.getByUsername(username);
return {
actor: makeActor({ user: row as never }),
username,
id: row!.id,
uuid: row!.uuid as string,
};
};
beforeAll(async () => {
state.env = await setupPuterTestEnv({
events: { enabled: true, kvHandles: true },
kv: { shareHandles: true },
unlimitedMetering: true,
...config,
} as IConfig);
state.owner = await userFor(state.env.users.user.username);
state.guest = await userFor(state.env.users.other.username);
}, BOOT_TIMEOUT_MS);
afterAll(async () => {
await state.env?.shutdown();
});
beforeEach(async () => {
for (const user of [state.owner, state.guest])
await state.env.server.clients.redis.del(
`rate:${EVENTS_KV_HANDLE_LIMIT.scope}:${user.id}`,
);
await state.env.server.clients.redis.del(
`rate:${KV_SHARE_NOTICE_LIMIT.scope}:${state.owner.id}:${state.guest.id}`,
);
});
const makeApp = async () => {
const name = `kv-recipient-${uuidv4().slice(0, 8)}`;
return state.env.server.stores.app.create(
{
name,
title: 'Recipient App',
index_url: `https://${name}.example.test/index.html`,
},
{ ownerUserId: state.owner.id },
);
};
const share = (
prefix: string,
access: KvShareAccess,
opts: { appUid?: string; label?: unknown } = {},
) =>
state.env.server.services.kvShare.mintKvHandle(
state.owner.actor,
{
prefix,
recipient: { username: state.guest.username },
access,
...(opts.appUid ? { appUid: opts.appUid } : {}),
...(opts.label !== undefined ? { label: opts.label } : {}),
},
{ defaultAccess: 'read' },
);
/** The holder's share notifications naming one handle. */
const notificationsFor = async (handle: string) =>
(
await state.env.server.clients.db.pread(
'SELECT `uid`, `app_uid`, `audience`, `value` FROM `notification` ' +
"WHERE `user_id` = ? AND `type` = 'kv.share.received'",
[state.guest.id],
)
)
.map((row) => ({
uid: String(row.uid),
appUid: row.app_uid,
audience: row.audience,
value: (typeof row.value === 'string'
? JSON.parse(row.value)
: row.value) as Record<string, unknown>,
}))
.filter((row) => row.value.handle === handle);
return { state, makeApp, share, notificationsFor };
};
const region = (label: string) => `${label}-${uuidv4().slice(0, 8)}:`;
describe('the share notification', () => {
const { state, makeApp, share, notificationsFor } = bootEnv({});
it('reaches the holder once, in the app the data belongs to, without the owner', async () => {
const app = await makeApp();
const prefix = region('notify');
const shared = await share(prefix, 'write', {
appUid: app.uid,
label: 'Groceries',
});
const rows = await notificationsFor(shared.handle);
expect(rows).toHaveLength(1);
expect(rows[0]).toMatchObject({
appUid: app.uid,
audience: 'app-user',
});
expect(rows[0].value).toEqual({
type: 'kv.share.received',
handle: shared.handle,
access: 'write',
label: 'Groceries',
createdAt: shared.createdAt,
});
const wire = JSON.stringify(rows);
expect(wire).not.toContain(state.owner.uuid);
expect(wire).not.toContain(state.owner.username);
expect(wire).not.toContain(prefix);
});
it('is not sent again for a re-share, a level change or a label change', async () => {
const app = await makeApp();
const prefix = region('again');
const { handle } = await share(prefix, 'read', { appUid: app.uid });
await share(prefix, 'read', { appUid: app.uid });
await share(prefix, 'write', { appUid: app.uid });
await share(prefix, 'write', { appUid: app.uid, label: 'Renamed' });
expect(await notificationsFor(handle)).toHaveLength(1);
});
it('is sent at most five times an hour per owner and holder, and the share is made anyway', async () => {
const app = await makeApp();
const prefix = region('churn');
const handles: string[] = [];
for (let i = 0; i < KV_SHARE_NOTICE_LIMIT.limit + 2; i++) {
const { handle } = await share(prefix, 'read', { appUid: app.uid });
handles.push(handle);
await state.env.server.services.kvShare.removeKvShare(
state.owner.actor,
handle,
);
}
expect(new Set(handles).size).toBe(handles.length);
const counts = await Promise.all(
handles.map(
async (handle) => (await notificationsFor(handle)).length,
),
);
expect(counts.reduce((sum, n) => sum + n, 0)).toBe(
KV_SHARE_NOTICE_LIMIT.limit,
);
expect(counts.slice(KV_SHARE_NOTICE_LIMIT.limit)).toEqual([0, 0]);
});
it('is not sent for a share with no app', async () => {
const { handle } = await share(region('global'), 'read');
expect(await notificationsFor(handle)).toEqual([]);
});
it('never reaches the desktop wire, and the mint stands when it fails', async () => {
const app = await makeApp();
const emit = vi.spyOn(state.env.server.clients.event, 'emit');
try {
const { handle } = await share(region('wire'), 'read', {
appUid: app.uid,
});
const [row] = await notificationsFor(handle);
const pushed = emit.mock.calls.filter(
([key, data]) =>
key === 'outer.gui.notif.message' &&
JSON.stringify(data).includes(row.uid),
);
expect(pushed).toEqual([]);
} finally {
emit.mockRestore();
}
const notify = vi
.spyOn(state.env.server.services.notification, 'notify')
.mockRejectedValueOnce(new Error('mailbox down'));
try {
await expect(
share(region('failing'), 'read', { appUid: app.uid }),
).resolves.toMatchObject({ access: 'read' });
} finally {
notify.mockRestore();
}
});
it('stays out of the whole-mailbox listing, but not out of the app`s slice', async () => {
const app = await makeApp();
const { handle } = await share(region('select'), 'read', {
appUid: app.uid,
});
const [row] = await notificationsFor(handle);
const select = (actor: Actor, args: Record<string, unknown> = {}) =>
runWithContext({ actor }, () =>
state.env.server.drivers.notifications.select(args),
) as Promise<Array<{ uid: unknown }>>;
const uids = (rows: Array<{ uid: unknown }>) =>
rows.map((one) => one.uid);
expect(uids(await select(state.guest.actor))).not.toContain(row.uid);
expect(
uids(
await select(state.guest.actor, { subject: 'notif:app-user' }),
),
).not.toContain(row.uid);
expect(
uids(
await select(state.guest.actor, {
subject: `notif:${app.uid}:app-user`,
}),
),
).toContain(row.uid);
const appActor = makeActor({
user: state.guest.actor.user as never,
app: { uid: app.uid, id: app.id },
});
expect(uids(await select(appActor))).toContain(row.uid);
});
it('is left out of the unread replay a desktop gets on connecting', async () => {
const app = await makeApp();
const { handle } = await share(region('replay'), 'read', {
appUid: app.uid,
});
const [row] = await notificationsFor(handle);
const emit = vi.spyOn(state.env.server.clients.event, 'emit');
try {
state.env.server.clients.event.emit(
'web.socket.user-connected',
{ user: { id: state.guest.id } } as never,
{},
);
// The replay is debounced by two seconds.
await new Promise((resolve) => setTimeout(resolve, 2_300));
const replayed = emit.mock.calls.filter(
([key, data]) =>
key === 'outer.gui.notif.unreads' &&
JSON.stringify(data).includes(row.uid),
);
expect(replayed).toEqual([]);
} finally {
emit.mockRestore();
}
});
});
describe('the share notification with notification dispatch on', () => {
const { state, makeApp, share, notificationsFor } = bootEnv({
events: {
enabled: true,
kvHandles: true,
notificationsFoldIn: true,
},
});
it('reaches the app`s notif:app-user subscription and never the desktop', async () => {
const app = await makeApp();
const delivered: DeliveryEnvelope[] = [];
state.env.server.services.events.onDelivered = (envelope) =>
delivered.push(envelope);
const appActor = makeActor({
user: state.guest.actor.user as never,
app: { uid: app.uid, id: app.id },
});
await state.env.server.services.events.subscribe(
appActor,
'kv-recipient-socket',
{ subject: 'notif:app-user' },
);
const send = vi.spyOn(state.env.server.services.socket, 'send');
try {
const { handle } = await share(region('folded'), 'read', {
appUid: app.uid,
});
const [row] = await notificationsFor(handle);
await vi.waitFor(
() =>
expect(
delivered.some(
(one) =>
(one.event as { uid?: string }).uid === row.uid,
),
).toBe(true),
{ timeout: EVENTS_COALESCE_WINDOW_MS * 12, interval: 25 },
);
const desktop = send.mock.calls.filter(
([, key, data]) =>
key === 'notif.message' &&
JSON.stringify(data).includes(row.uid),
);
expect(desktop).toEqual([]);
} finally {
send.mockRestore();
await state.env.server.services.events.reapSocket(
state.guest.id,
'kv-recipient-socket',
);
}
});
it('stays out of the desktop`s own notif:app-user feed, live and fetched', async () => {
const events = state.env.server.services.events;
const app = await makeApp();
const delivered: DeliveryEnvelope[] = [];
events.onDelivered = (envelope) => delivered.push(envelope);
const appActor = makeActor({
user: state.guest.actor.user as never,
app: { uid: app.uid, id: app.id },
});
const { sub: desktopSub } = await events.subscribe(
state.guest.actor,
'kv-recipient-desktop',
{ subject: 'notif:app-user' },
);
const { sub: appSub } = await events.subscribe(
appActor,
'kv-recipient-app',
{ subject: 'notif:app-user' },
);
const deliveredTo = (subId: string, uid: string) =>
delivered.some(
(one) =>
one.subId === subId &&
(one.event as { uid?: string }).uid === uid,
);
// Deliveries on one subject within the coalesce window collapse to the
// last, so each notification is waited out before the next is sent.
const waitFor = (check: () => boolean) =>
vi.waitFor(() => expect(check()).toBe(true), {
timeout: EVENTS_COALESCE_WINDOW_MS * 12,
interval: 25,
});
try {
const { handle } = await share(region('desktop'), 'read', {
appUid: app.uid,
});
const [row] = await notificationsFor(handle);
await waitFor(() => deliveredTo(appSub.subId, row.uid));
// Another app-user row about the same app still reaches the desktop.
const ended = (await state.env.server.services.notification.notify(
[state.guest.id],
{ title: 'Subscription ended' },
{ type: 'app.events.ended', appUid: app.uid },
))!;
await waitFor(() => deliveredTo(desktopSub.subId, ended));
expect(deliveredTo(desktopSub.subId, row.uid)).toBe(false);
const fetched = async (subject: string) =>
(
await events.fetchMissed(state.guest.actor, { subject })
).items.map((item) => item.uid);
const generic = await fetched('notif:app-user');
expect(generic).toContain(ended);
expect(generic).not.toContain(row.uid);
expect(await fetched(`notif:${app.uid}:app-user`)).toContain(
row.uid,
);
} finally {
for (const socketId of ['kv-recipient-desktop', 'kv-recipient-app'])
await events.reapSocket(state.guest.id, socketId);
}
});
});
describe('recipient share blocks', () => {
const { state, makeApp, share, notificationsFor } = bootEnv({});
it('refuse a share from a sender the recipient blocked', async () => {
await state.env.server.stores.userBlock.create(
state.guest.id,
state.owner.id,
);
try {
const app = await makeApp();
await expect(
share(region('blocked'), 'read', { appUid: app.uid }),
).rejects.toMatchObject({
statusCode: 403,
legacyCode: 'recipient_not_accepting_shares',
});
const listed =
await state.env.server.services.kvShare.listKvHandles(
state.owner.actor,
{ limit: 200 },
);
expect(
listed.items.filter((row) => row.appUid === app.uid),
).toEqual([]);
} finally {
await state.env.server.stores.userBlock.deleteByPair(
state.guest.id,
state.owner.id,
);
}
});
it('refuse a share when the recipient refuses everyone', async () => {
await state.env.server.stores.user.updateMetadata(state.guest.id, {
blockAllShares: true,
});
try {
await expect(share(region('all'), 'watch')).rejects.toMatchObject({
legacyCode: 'recipient_not_accepting_shares',
});
} finally {
await state.env.server.stores.user.updateMetadata(state.guest.id, {
blockAllShares: false,
});
}
});
it('leave a share made before the block to be narrowed, its label cleared, and revoked', async () => {
const app = await makeApp();
const prefix = region('before');
const { handle } = await share(prefix, 'write', {
appUid: app.uid,
label: 'Before',
});
await state.env.server.stores.userBlock.create(
state.guest.id,
state.owner.id,
);
try {
await expect(
share(prefix, 'read', { appUid: app.uid, label: null }),
).resolves.toMatchObject({
handle,
access: 'read',
label: null,
});
await expect(
state.env.server.services.kvShare.removeKvShare(
state.owner.actor,
handle,
),
).resolves.toMatchObject({ handle });
// Still only the notification from before the block.
expect(await notificationsFor(handle)).toHaveLength(1);
} finally {
await state.env.server.stores.userBlock.deleteByPair(
state.guest.id,
state.owner.id,
);
}
});
it.each([
['a raised level', { access: 'write' as const }],
['a new label', { label: 'Later' }],
[
'a lower level with a new label',
{ access: 'watch' as const, label: 'Later' },
],
])('refuse %s on a share made before the block', async (_name, change) => {
const app = await makeApp();
const prefix = region('raise');
const { handle } = await share(prefix, 'read', { appUid: app.uid });
await state.env.server.stores.userBlock.create(
state.guest.id,
state.owner.id,
);
try {
await expect(
share(prefix, 'access' in change ? change.access : 'read', {
appUid: app.uid,
...('label' in change ? { label: change.label } : {}),
}),
).rejects.toMatchObject({
legacyCode: 'recipient_not_accepting_shares',
});
const row =
await state.env.server.stores.kvShareHandle.getByHandle(handle);
expect(row).toMatchObject({ revokedAt: null, label: null });
expect(row?.permission.startsWith('kv-share-read:')).toBe(true);
} finally {
await state.env.server.stores.userBlock.deleteByPair(
state.guest.id,
state.owner.id,
);
}
});
});
@@ -0,0 +1,868 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { v4 as uuidv4 } from 'uuid';
import { describe, expect, it, vi } from 'vitest';
import type { Actor } from '../../core/actor.js';
import { HttpError } from '../../core/http/HttpError.js';
import { PermissionUtil } from '../permission/permissionUtil.js';
import {
assertBoundedManageGrant,
assertNewShareSegments,
assertPrefixFitsAccess,
assertShareableAppUid,
assertShareablePrefix,
isKvShareManagePermission,
isKvSharePermission,
keyPrefixSegments,
KV_SHARE_PREFIX_MAX_BYTES,
kvShareAccessOf,
kvShareAppDelegateImplicator,
kvShareGrantAtEveryLevel,
kvShareGrantCovers,
kvShareGrantPrefix,
kvShareLevelForMethod,
kvShareLevelsExploder,
kvShareManageNamespaceRoots,
kvShareManagePermission,
kvShareOwnerImplicator,
kvSharePermission,
mintKvHandleId,
normalizeKeyPrefix,
parseKvShareAccess,
parseKvShareLabel,
parseKvShareRecipient,
relativeToKvShareRoot,
withKvShareAccess,
} from './kvShares.js';
import { APP_DATA_KV_METHOD_OPS } from '../permission/appDataScopes.js';
import { isKvHandleId, kvHandleFromSubject } from '../events/subjects.js';
const OWNER = '2a1b0c9d-0000-4000-8000-000000000001';
const OTHER = '2a1b0c9d-0000-4000-8000-000000000002';
const APP = 'app-1234';
const OTHER_APP = 'app-5678';
const userActor = (uuid: string): Actor =>
({ user: { uuid }, effectiveApp: null }) as unknown as Actor;
const appActor = (uuid: string, appUid: string): Actor =>
({
user: { uuid },
app: { uid: appUid },
effectiveApp: { uid: appUid },
}) as unknown as Actor;
describe('the share permission family', () => {
it('names the owner, the app and the granted prefix', () => {
expect(kvSharePermission(OWNER, APP, 'workspace:abc:')).toBe(
`kv-share:${OWNER}:${APP}:workspace:abc`,
);
});
it('makes key segments components, so a deeper key is a descendant', () => {
const granted = kvSharePermission(OWNER, APP, 'workspace:abc:');
const deeper = kvSharePermission(
OWNER,
APP,
'workspace:abc:messages:1',
);
// The exploder walks parents of the string being checked, so implication
// over key segments needs nothing of its own.
expect(deeper.startsWith(`${granted}:`)).toBe(true);
});
it('escapes a `:` inside a component rather than splitting on it', () => {
const permission = kvSharePermission(OWNER, 'app:odd', 'cart:');
expect(PermissionUtil.split(permission)).toEqual([
'kv-share',
OWNER,
'app:odd',
'cart',
]);
});
it('reads a withdrawn grant as covering itself and everything under it', () => {
const granted = kvSharePermission(OWNER, APP, 'workspace:abc:');
expect(kvShareGrantCovers(granted, granted)).toBe(true);
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OWNER, APP, 'workspace:abc:messages:'),
),
).toBe(true);
// A sibling that merely shares a text prefix is a different region.
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OWNER, APP, 'workspace:abcdef:'),
),
).toBe(false);
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OTHER, APP, 'workspace:abc:'),
),
).toBe(false);
// Coverage never crosses namespaces: the app uid is what keeps a
// revoke inside the one the handle was minted in.
expect(
kvShareGrantCovers(
granted,
kvSharePermission(OWNER, OTHER_APP, 'workspace:abc:messages:'),
),
).toBe(false);
});
it('never reads a withdrawn child as covering its own parent', () => {
// Revoking the deeper of two grants must not read as covering the
// shallower one — coverage only ever runs downward.
const child = kvSharePermission(OWNER, APP, 'workspace:abc:messages:');
const parent = kvSharePermission(OWNER, APP, 'workspace:abc:');
expect(kvShareGrantCovers(child, parent)).toBe(false);
});
});
describe('granted prefixes', () => {
it('always ends on the key delimiter', () => {
expect(normalizeKeyPrefix('workspace:abc')).toBe('workspace:abc:');
expect(normalizeKeyPrefix('workspace:abc:')).toBe('workspace:abc:');
expect(keyPrefixSegments('workspace:abc:')).toEqual([
'workspace',
'abc',
]);
});
it.each([
['', 'the whole namespace'],
[':', 'delimiters only'],
['workspace:*', 'a pattern'],
['workspace:a?c', 'a single-character pattern'],
// Normalizing would drop the empty segment and grant `a:b:` instead —
// a region other than the one asked for.
['workspace::abc:', 'an empty key segment'],
[':workspace:abc:', 'a leading empty segment'],
// `escape_permission_component` leaves `\\` alone while escaping `:`,
// so the stored prefix and the permission string would disagree and
// the share would silently never fire.
['work\\space:abc:', 'a backslash'],
])('refuses %s (%s)', (prefix) => {
let thrown: unknown;
try {
assertShareablePrefix(prefix);
} catch (err) {
thrown = err;
}
expect(thrown).toBeInstanceOf(HttpError);
expect((thrown as HttpError).legacyCode).toBe(
'invalid_kv_share_prefix',
);
});
it('refuses a region too deep to fit the grant column', () => {
expect(() =>
assertPrefixFitsAccess(OWNER, APP, 'a'.repeat(300), 'watch'),
).toThrow(HttpError);
expect(
assertPrefixFitsAccess(OWNER, APP, 'workspace:abc:', 'watch'),
).toBe(kvSharePermission(OWNER, APP, 'workspace:abc:'));
});
it('keeps the trailing delimiter optional', () => {
expect(assertShareablePrefix('workspace:abc')).toBe('workspace:abc:');
expect(assertShareablePrefix('workspace:abc:')).toBe('workspace:abc:');
});
});
describe('granted namespaces', () => {
it('takes an app uid, and the app-less namespace', () => {
expect(assertShareableAppUid(APP)).toBe(APP);
expect(assertShareableAppUid('os-global')).toBe('os-global');
});
it('refuses one past the column it is stored in', () => {
// A longer one reaches the insert as a write the column cannot hold.
let thrown: unknown;
try {
assertShareableAppUid('a'.repeat(41));
} catch (err) {
thrown = err;
}
expect(thrown).toBeInstanceOf(HttpError);
expect((thrown as HttpError).statusCode).toBe(400);
});
it('takes both shapes a real app uid comes in', () => {
// Minted (`app-<uuidv4>`) and derived from an origin (`app-<uuidv5>`)
// — 40 characters either way, which is the column exactly.
const minted = `app-${uuidv4()}`;
expect(assertShareableAppUid(minted)).toBe(minted);
expect(minted).toHaveLength(40);
});
it('refuses a handle, which shares the slot but is not a namespace', () => {
expect(() => assertShareableAppUid(mintKvHandleId())).toThrow(
HttpError,
);
});
it('refuses anything else short enough to fit the column', () => {
// The slot ends up in a subject and in a permission string, so a
// namespace carrying a delimiter of either grammar is refused before
// it can be composed into one.
for (const uid of [
'os-globals',
'workspace:abc',
'app',
'app-',
'app-a:b',
'app-a#b',
'v1:someone:app-x',
'',
])
expect(() => assertShareableAppUid(uid)).toThrow(HttpError);
});
});
describe('keys inside a granted region', () => {
const permission = kvSharePermission(OWNER, APP, 'workspace:abc:');
it('are named relative to the granted root', () => {
expect(
relativeToKvShareRoot(permission, 'workspace:abc:messages:1'),
).toBe('messages:1');
});
it('read as outside when they are', () => {
expect(
relativeToKvShareRoot(permission, 'workspace:abcdef:x'),
).toBeNull();
expect(relativeToKvShareRoot(permission, 'workspace:abc')).toBeNull();
});
});
describe('a delegation request', () => {
const region = kvShareManagePermission(
kvSharePermission(OWNER, APP, 'workspace:abc:'),
);
it('is the manage arm of the grant it would let an app issue', () => {
expect(region).toBe(`manage:kv-share:${OWNER}:${APP}:workspace:abc`);
expect(assertBoundedManageGrant(region)).toBe(region);
});
it.each([
['manage:kv-share', 'the family itself'],
[`manage:kv-share:${OWNER}`, 'an owner and no namespace'],
[`manage:kv-share:${OWNER}:${APP}`, 'a whole namespace'],
])('refuses %s (%s)', (permission) => {
let thrown: unknown;
try {
assertBoundedManageGrant(permission);
} catch (err) {
thrown = err;
}
expect(thrown).toBeInstanceOf(HttpError);
expect((thrown as HttpError).legacyCode).toBe(
'invalid_kv_share_prefix',
);
});
it('leaves permissions from other families alone', () => {
const unrelated = `manage:fs:${OWNER}:write`;
expect(assertBoundedManageGrant(unrelated)).toBe(unrelated);
// The read arm of this family is not a delegation, so it is not this
// check's to bound.
expect(assertBoundedManageGrant(`kv-share:${OWNER}:${APP}`)).toBeTypeOf(
'string',
);
});
});
describe('handle ids', () => {
it('are told apart from an app uid in the same slot', () => {
const handle = mintKvHandleId();
expect(isKvHandleId(handle)).toBe(true);
expect(isKvHandleId(APP)).toBe(false);
expect(isKvHandleId('kvh-')).toBe(false);
});
it('carry nothing about the owner', () => {
const handle = mintKvHandleId();
expect(handle).not.toContain(OWNER);
expect(mintKvHandleId()).not.toBe(handle);
});
it('are recoverable from the subject a row stored', () => {
const handle = mintKvHandleId();
expect(kvHandleFromSubject(`kv:${handle}:messages:*`)).toBe(handle);
expect(kvHandleFromSubject(`kv:${APP}:messages:*`)).toBeNull();
expect(kvHandleFromSubject(`fs:${handle}:write`)).toBeNull();
});
});
describe('the owner implicator', () => {
const implicator = kvShareOwnerImplicator();
const permission = kvSharePermission(OWNER, APP, 'workspace:abc:');
it('answers the share family and its manage arm', () => {
expect(implicator.matches(permission)).toBe(true);
expect(implicator.matches(`manage:${permission}`)).toBe(true);
expect(implicator.matches(`fs:${OWNER}:read`)).toBe(false);
});
it('holds for the owner named in the permission, and nobody else', () => {
expect(
implicator.check({ actor: userActor(OWNER), permission }),
).toEqual({});
expect(
implicator.check({
actor: userActor(OWNER),
permission: `manage:${permission}`,
}),
).toEqual({});
expect(
implicator.check({ actor: userActor(OTHER), permission }),
).toBeUndefined();
});
it('reads the owner past a `manage` key segment', () => {
// Stripping every `manage:` rather than the leading one would rewrite
// the string the owner is read out of.
const nested = kvSharePermission(OWNER, APP, 'manage:secrets:');
expect(implicator.matches(nested)).toBe(true);
expect(
implicator.check({ actor: userActor(OWNER), permission: nested }),
).toEqual({});
expect(
implicator.check({ actor: userActor(OTHER), permission: nested }),
).toBeUndefined();
});
it('never answers for an app or a token acting through the owner', () => {
const appActor = {
user: { uuid: OWNER },
app: { uid: APP },
} as unknown as Actor;
expect(
implicator.check({ actor: appActor, permission }),
).toBeUndefined();
});
});
describe('the app delegate implicator', () => {
const permission = kvSharePermission(OWNER, APP, 'workspace:abc:');
it('answers the share family, never its manage arm, nor other families', () => {
const implicator = kvShareAppDelegateImplicator({
userHolds: vi.fn(),
});
expect(implicator.matches(permission)).toBe(true);
expect(implicator.matches(`manage:${permission}`)).toBe(false);
expect(implicator.matches(`fs:${OWNER}:read`)).toBe(false);
});
it("grants when the actor's own app matches the namespace app and the user holds the grant", async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = appActor(OWNER, APP);
await expect(implicator.check({ actor, permission })).resolves.toEqual(
{},
);
expect(userHolds).toHaveBeenCalledTimes(1);
const [calledActor, calledPermission] = userHolds.mock.calls[0];
expect(calledActor.app).toBeUndefined();
expect(calledActor.effectiveApp).toBeNull();
expect(calledActor.user).toEqual({ uuid: OWNER });
expect(calledPermission).toBe(permission);
});
it('refuses when the user does not hold the grant', async () => {
const implicator = kvShareAppDelegateImplicator({
userHolds: vi.fn().mockResolvedValue(false),
});
await expect(
implicator.check({ actor: appActor(OWNER, APP), permission }),
).resolves.toBeUndefined();
});
it("refuses when the actor's app differs from the namespace app", async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
await expect(
implicator.check({
actor: appActor(OWNER, OTHER_APP),
permission,
}),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
it('refuses a plain user actor with no app', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
await expect(
implicator.check({ actor: userActor(OWNER), permission }),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
it('refuses an access-token actor', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = {
user: { uuid: OWNER },
app: { uid: APP },
accessToken: { uid: 't' },
} as unknown as Actor;
await expect(
implicator.check({ actor, permission }),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
it('asks the user once for a deep option and the ancestors its check already asked', async () => {
const userHolds = vi.fn().mockResolvedValue(false);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = appActor(OWNER, APP);
const memo = new Map<string, unknown>();
const deep = kvSharePermission(OWNER, APP, 'a:b:c:', 'read');
for (const permission of [
deep,
kvSharePermission(OWNER, APP, 'a:b:c:', 'write'),
kvSharePermission(OWNER, APP, 'a:b:', 'read'),
kvSharePermission(OWNER, APP, 'a:', 'write'),
])
await expect(
implicator.check({ actor, permission, memo }),
).resolves.toBeUndefined();
expect(userHolds).toHaveBeenCalledTimes(1);
// A lower level, or a region beside it, is a question of its own.
await implicator.check({
actor,
permission: kvSharePermission(OWNER, APP, 'a:b:', 'watch'),
memo,
});
await implicator.check({
actor,
permission: kvSharePermission(OWNER, APP, 'a:x:', 'read'),
memo,
});
expect(userHolds).toHaveBeenCalledTimes(3);
// Nothing carries over to another scan.
await implicator.check({ actor, permission: deep });
expect(userHolds).toHaveBeenCalledTimes(4);
});
it('refuses a permission with no key segments or no app', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const implicator = kvShareAppDelegateImplicator({ userHolds });
const actor = appActor(OWNER, APP);
await expect(
implicator.check({
actor,
permission: PermissionUtil.join('kv-share', OWNER, APP),
}),
).resolves.toBeUndefined();
await expect(
implicator.check({
actor,
permission: PermissionUtil.join('kv-share', OWNER),
}),
).resolves.toBeUndefined();
expect(userHolds).not.toHaveBeenCalled();
});
});
/** The refusal a call threw, for asserting on its code. */
const refusal = (fn: () => unknown): HttpError => {
try {
fn();
} catch (err) {
if (err instanceof HttpError) return err;
throw err;
}
throw new Error('expected a refusal');
};
describe('share levels', () => {
const REGION = 'workspace:abc:';
it('put the level in the root, leaving watch grants as they were', () => {
expect(kvSharePermission(OWNER, APP, REGION)).toBe(
`kv-share:${OWNER}:${APP}:workspace:abc`,
);
expect(kvSharePermission(OWNER, APP, REGION, 'read')).toBe(
`kv-share-read:${OWNER}:${APP}:workspace:abc`,
);
expect(kvSharePermission(OWNER, APP, REGION, 'write')).toBe(
`kv-share-write:${OWNER}:${APP}:workspace:abc`,
);
});
it('read the level back off any root, and nothing else as the family', () => {
for (const access of ['watch', 'read', 'write'] as const) {
const permission = kvSharePermission(OWNER, APP, REGION, access);
expect(isKvSharePermission(permission)).toBe(true);
expect(kvShareAccessOf(permission)).toBe(access);
expect(kvShareGrantPrefix(permission)).toBe(REGION);
expect(
relativeToKvShareRoot(permission, `${REGION}messages:1`),
).toBe('messages:1');
}
expect(isKvSharePermission(`kv-shared:${OWNER}`)).toBe(false);
expect(isKvSharePermission(`kv-share-admin:${OWNER}`)).toBe(false);
expect(kvShareAccessOf(`fs:${OWNER}:read`)).toBeNull();
});
it('swap only the root when moving a grant between levels', () => {
const read = kvSharePermission(OWNER, APP, REGION, 'read');
expect(withKvShareAccess(read, 'write')).toBe(
kvSharePermission(OWNER, APP, REGION, 'write'),
);
expect(kvShareGrantAtEveryLevel(read)).toEqual([
kvSharePermission(OWNER, APP, REGION, 'watch'),
read,
kvSharePermission(OWNER, APP, REGION, 'write'),
]);
});
it('cover a region withdrawn at one level at every level', () => {
const writeRegion = kvSharePermission(OWNER, APP, REGION, 'write');
const watchInside = kvSharePermission(OWNER, APP, `${REGION}messages:`);
expect(kvShareGrantCovers(writeRegion, watchInside)).toBe(true);
expect(
kvShareGrantCovers(
kvSharePermission(OWNER, APP, REGION, 'read'),
kvSharePermission(OWNER, APP, REGION, 'write'),
),
).toBe(true);
// Still never upward, and never across namespaces.
expect(kvShareGrantCovers(watchInside, writeRegion)).toBe(false);
expect(
kvShareGrantCovers(
writeRegion,
kvSharePermission(OWNER, OTHER_APP, REGION, 'write'),
),
).toBe(false);
// Nothing outside the family is ever covered.
expect(kvShareGrantCovers(writeRegion, `fs:${OWNER}:read`)).toBe(false);
});
});
describe('the level ladder exploder', () => {
const exploder = kvShareLevelsExploder();
const at = (access: 'watch' | 'read' | 'write') =>
kvSharePermission(OWNER, APP, 'workspace:abc:', access);
it('lets a check at a level be answered by every level above it', async () => {
expect(await exploder.explode({ permission: at('watch') })).toEqual([
at('watch'),
at('read'),
at('write'),
]);
expect(await exploder.explode({ permission: at('read') })).toEqual([
at('read'),
at('write'),
]);
expect(exploder.matches(at('write'))).toBe(false);
});
it('ladders a manage arm the same way', async () => {
expect(
await exploder.explode({ permission: `manage:${at('read')}` }),
).toEqual([`manage:${at('read')}`, `manage:${at('write')}`]);
});
it('never ladders a string with no key segment', async () => {
for (const permission of [
PermissionUtil.join('kv-share', OWNER, APP),
PermissionUtil.join('manage', 'kv-share-read', OWNER, APP),
PermissionUtil.join('kv-share', OWNER),
'kv-share',
])
expect(await exploder.explode({ permission })).toEqual([
permission,
]);
});
it('leaves other families alone', () => {
expect(exploder.matches(`fs:${OWNER}:read`)).toBe(false);
expect(exploder.matches(`app-data:${APP}:kv:read`)).toBe(false);
});
});
describe('the level a driver method needs', () => {
it('is read for get and list, and write for every other mapped op', () => {
expect(kvShareLevelForMethod('get')).toBe('read');
expect(kvShareLevelForMethod('list')).toBe('read');
for (const method of [
'set',
'batchPut',
'add',
'incr',
'decr',
'update',
'del',
'remove',
'expire',
'expireAt',
])
expect(kvShareLevelForMethod(method)).toBe('write');
});
it('refuses flush and anything the op table does not name', () => {
expect(kvShareLevelForMethod('flush')).toBeNull();
expect(kvShareLevelForMethod('toString')).toBeNull();
expect(kvShareLevelForMethod('somethingNew')).toBeNull();
});
it('covers every method the op table knows', () => {
for (const [method, op] of Object.entries(APP_DATA_KV_METHOD_OPS))
expect(kvShareLevelForMethod(method) === null).toBe(op === null);
});
});
describe('share request parsing', () => {
it('takes the three levels and a fallback, and refuses anything else', () => {
expect(parseKvShareAccess(undefined, 'read')).toBe('read');
expect(parseKvShareAccess(null, 'watch')).toBe('watch');
expect(parseKvShareAccess('write', 'read')).toBe('write');
for (const value of ['delete', 'WRITE', '', 2, {}])
expect(
refusal(() => parseKvShareAccess(value, 'read')).legacyCode,
).toBe('kv_share_access_invalid');
});
it('caps a prefix at what the grant column leaves for its owner, app and level', () => {
const owner = uuidv4();
const app = `app-${uuidv4()}`;
// 255 less the root, the owner uuid, the app uid and two separators.
const longest = { watch: 169, read: 164, write: 163 } as const;
for (const access of ['watch', 'read', 'write'] as const) {
const fits = `${'a'.repeat(longest[access] - 1)}:`;
const over = `${'a'.repeat(longest[access])}:`;
expect(
assertPrefixFitsAccess(owner, app, fits, access),
).toHaveLength(255);
const refused = refusal(() =>
assertPrefixFitsAccess(owner, app, over, access),
);
expect(refused.legacyCode).toBe('invalid_kv_share_prefix');
expect(refused.message).toContain(`${longest[access]} characters`);
}
// The app-less namespace has a shorter name, so more room.
expect(() =>
assertPrefixFitsAccess(
owner,
'os-global',
`${'a'.repeat(193)}:`,
'write',
),
).not.toThrow();
});
it('holds a multibyte read or write prefix to the byte cap', () => {
const multibyte = `${'é'.repeat(KV_SHARE_PREFIX_MAX_BYTES / 2)}:`;
expect(
refusal(() => assertPrefixFitsAccess(OWNER, APP, multibyte, 'read'))
.legacyCode,
).toBe('invalid_kv_share_prefix');
expect(() =>
assertPrefixFitsAccess(OWNER, APP, multibyte, 'watch'),
).not.toThrow();
});
it('takes a recipient as a username or an object, never an address', () => {
expect(parseKvShareRecipient(' alice ')).toEqual({
username: 'alice',
});
expect(parseKvShareRecipient({ username: 'alice' })).toEqual({
username: 'alice',
});
expect(parseKvShareRecipient({ uid: OWNER })).toEqual({ uid: OWNER });
for (const value of [
'[email protected]',
{ username: 'a@b' },
'',
{},
[],
42,
null,
undefined,
])
expect(refusal(() => parseKvShareRecipient(value)).legacyCode).toBe(
'invalid_recipient',
);
});
it('trims a label, reads empty as none, and keeps absent apart from null', () => {
expect(parseKvShareLabel(undefined)).toBeUndefined();
expect(parseKvShareLabel(null)).toBeNull();
expect(parseKvShareLabel(' ')).toBeNull();
expect(parseKvShareLabel(' Japan 2027 · from dan ')).toBe(
'Japan 2027 · from dan',
);
});
it.each([
['a control character', 'trip\u0007'],
['a newline', 'trip\nplans'],
['a line separator', 'trip\u2028plans'],
['a paragraph separator', 'trip\u2029plans'],
['a bidi override', 'trip\u202Eplans'],
['a bidi isolate', 'trip\u2067plans'],
['a left-to-right mark', 'trip\u200Eplans'],
['a right-to-left mark', 'trip\u200Fplans'],
['an Arabic letter mark', 'trip\u061Cplans'],
['a zero-width space', 'trip\u200Bplans'],
['a zero-width joiner', 'trip\u200Dplans'],
['a zero-width non-joiner', 'trip\u200Cplans'],
['a word joiner', 'trip\u2060plans'],
['a soft hyphen', 'trip\u00ADplans'],
['a byte order mark', 'trip\uFEFFplans'],
['a tag character', 'trip\u{E0041}plans'],
['an interlinear annotation anchor', 'trip\uFFF9plans'],
['four combining marks on one character', 'e\u0301\u0302\u0303\u0304'],
['a non-string', 42],
['too many characters', 'x'.repeat(129)],
['too many bytes', '😀'.repeat(129)],
])('refuses a label with %s', (_case, value) => {
expect(refusal(() => parseKvShareLabel(value)).legacyCode).toBe(
'kv_share_label_invalid',
);
});
it('holds a new share`s key segments to lowercase letters, digits, `_`, `.` and `-`', () => {
expect(() =>
assertNewShareSegments(['room_1.a-b', 'x9']),
).not.toThrow();
for (const segment of ['Room', 'café', 'a b', 'a*', 'ß', 'İ'])
expect(
refusal(() => assertNewShareSegments(['ok', segment]))
.legacyCode,
).toBe('invalid_kv_share_prefix');
});
it('takes a label at the character cap', () => {
expect(parseKvShareLabel('x'.repeat(128))).toBe('x'.repeat(128));
});
it('takes up to three combining marks on a character, and emoji with a variation selector', () => {
expect(parseKvShareLabel('e\u0301\u0302\u0303 caf\u00E9')).toBe(
'e\u0301\u0302\u0303 caf\u00E9',
);
expect(parseKvShareLabel('Trip \u2764\uFE0F')).toBe(
'Trip \u2764\uFE0F',
);
});
});
describe('delegations at every level', () => {
it('are bounded the same way at every level', () => {
for (const access of ['watch', 'read', 'write'] as const) {
const region = kvShareManagePermission(
kvSharePermission(OWNER, APP, 'workspace:abc:', access),
);
expect(isKvShareManagePermission(region)).toBe(true);
expect(assertBoundedManageGrant(region)).toBe(region);
const root = PermissionUtil.join(
'manage',
access === 'watch' ? 'kv-share' : `kv-share-${access}`,
OWNER,
APP,
);
expect(
refusal(() => assertBoundedManageGrant(root)).legacyCode,
).toBe('invalid_kv_share_prefix');
}
});
it('name the namespace root at every level for the unbounded check', () => {
expect(
kvShareManageNamespaceRoots(
kvSharePermission(OWNER, APP, 'workspace:abc:', 'read'),
),
).toEqual([
`manage:kv-share:${OWNER}:${APP}`,
`manage:kv-share-read:${OWNER}:${APP}`,
`manage:kv-share-write:${OWNER}:${APP}`,
]);
});
it('are answered for the owner at every level, and never by the app delegate', () => {
const owner = kvShareOwnerImplicator();
const delegate = kvShareAppDelegateImplicator({ userHolds: vi.fn() });
for (const access of ['read', 'write'] as const) {
const permission = kvSharePermission(
OWNER,
APP,
'workspace:abc:',
access,
);
expect(owner.matches(permission)).toBe(true);
expect(owner.matches(`manage:${permission}`)).toBe(true);
expect(
owner.check({ actor: userActor(OWNER), permission }),
).toEqual({});
expect(
owner.check({ actor: userActor(OTHER), permission }),
).toBeUndefined();
expect(delegate.matches(permission)).toBe(true);
expect(delegate.matches(`manage:${permission}`)).toBe(false);
}
});
it('let a holder`s app use a read or write grant only in its own namespace', async () => {
const userHolds = vi.fn().mockResolvedValue(true);
const delegate = kvShareAppDelegateImplicator({ userHolds });
const permission = kvSharePermission(
OWNER,
APP,
'workspace:abc:',
'write',
);
await expect(
delegate.check({ actor: appActor(OTHER, APP), permission }),
).resolves.toEqual({});
await expect(
delegate.check({ actor: appActor(OTHER, OTHER_APP), permission }),
).resolves.toBeUndefined();
await expect(
delegate.check({
actor: appActor(OTHER, OTHER_APP),
permission: kvSharePermission(
OWNER,
'os-global',
'workspace:abc:',
'read',
),
}),
).resolves.toBeUndefined();
});
});
+628
View File
@@ -0,0 +1,628 @@
/*
* Copyright (C) 2024-present Puter Technologies Inc.
*
* This file is part of Puter.
*
* Puter is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { randomUUID } from 'node:crypto';
import {
type Actor,
isAppActor,
isPlainUserActor,
userRelatedActor,
} from '../../core/actor.js';
import { HttpError } from '../../core/http/HttpError.js';
import { KV_SHARE_HANDLE_WIDTHS } from '../../stores/events/columnWidths.js';
import {
KV_GLOBAL_APP_KEY,
KV_MAX_KEY_BYTES,
} from '../../stores/systemKv/SystemKVStore.js';
import {
MANAGE_PERM_PREFIX,
PERMISSION_MAX_LEN,
} from '../permission/consts.js';
import { APP_DATA_KV_METHOD_OPS } from '../permission/appDataScopes.js';
import type {
PermissionExploder,
PermissionImplicator,
} from '../permission/permissionUtil.js';
import { PermissionUtil } from '../permission/permissionUtil.js';
import {
isKvHandleId,
KV_HANDLE_PREFIX,
KV_KEY_SEPARATOR,
} from '../events/subjects.js';
/**
* Letting one user watch, read or write a region of another's key-value
* namespace.
*
* The grant is an ordinary user-to-user permission, which is the whole point:
* `manage:` answers "may I delegate this", the exploder's prefix implication
* makes a grant on `workspace:abc:` answer every key beneath it, and revocation
* settling and the delivery re-check key off the stored string exactly as they
* do for a shared folder. Putting the ACL on the key-value item instead would
* take part in none of that, and would tax every write to the item besides.
*
* The permission names the owner, so its components are the three things a
* shared region is, under a root that names the access level:
*
* kv-share:<ownerUserUuid>:<appUid>:<keySegment>... watch
* kv-share-read:<ownerUserUuid>:<appUid>:<keySegment>... read
* kv-share-write:<ownerUserUuid>:<appUid>:<keySegment>... write
*
* The level is in the root rather than a component so the permission system
* enforces it, and so the strings `kv-share:` grants already use keep their
* meaning.
*
* Key segments are components rather than one escaped blob because that is what
* makes prefix implication work without a rule of its own: the check a deep key
* runs is a descendant of the grant string, and the existing parent walk finds
* it. The grantee never sees this string — the handle is the name on the wire.
*/
/** Root of the cross-user key-value share namespace, at the watch level. */
export const KV_SHARE_PERMISSION_PREFIX = 'kv-share';
/** Access levels, lowest first. Each implies the ones before it. */
export const KV_SHARE_ACCESS_LEVELS = ['watch', 'read', 'write'] as const;
export type KvShareAccess = (typeof KV_SHARE_ACCESS_LEVELS)[number];
const KV_SHARE_ROOTS: Record<KvShareAccess, string> = {
watch: KV_SHARE_PERMISSION_PREFIX,
read: `${KV_SHARE_PERMISSION_PREFIX}-read`,
write: `${KV_SHARE_PERMISSION_PREFIX}-write`,
};
/** The permission root a level is granted under. */
export const kvShareRoot = (access: KvShareAccess): string =>
KV_SHARE_ROOTS[access];
const ACCESS_BY_ROOT = new Map<string, KvShareAccess>(
KV_SHARE_ACCESS_LEVELS.map((access) => [KV_SHARE_ROOTS[access], access]),
);
/**
* Byte ceiling on a `read` or `write` prefix, which the fixed relative-key
* limit assumes. The grant column binds first for every prefix a new share may
* name; this one only bites on a multibyte prefix shared before that rule.
*/
export const KV_SHARE_PREFIX_MAX_BYTES = 256;
/**
* Longest key a call through a handle may name, relative to the handle, in
* UTF-8 bytes: what the store's key limit leaves after the longest prefix, so
* the limit a holder hits says nothing about how long the prefix is.
*/
export const KV_HANDLE_KEY_MAX_BYTES =
KV_MAX_KEY_BYTES - KV_SHARE_PREFIX_MAX_BYTES;
/** Width of the `app_uid` column the handle row stores its namespace in. */
export const KV_SHARE_APP_UID_MAX_LENGTH = KV_SHARE_HANDLE_WIDTHS.appUid.max;
export const mintKvHandleId = (): string =>
`${KV_HANDLE_PREFIX}${randomUUID()}`;
/** The key segments a prefix contributes to a permission string. */
export const keyPrefixSegments = (keyPrefix: string): string[] =>
keyPrefix.split(KV_KEY_SEPARATOR).filter((segment) => segment.length > 0);
/**
* A granted prefix as it is stored: always ending on the key delimiter, so
* `keyPrefix + relative` is a whole key and the region never accidentally
* includes the key that names it.
*/
export const normalizeKeyPrefix = (keyPrefix: string): string => {
const segments = keyPrefixSegments(keyPrefix);
return segments.length === 0
? ''
: `${segments.join(KV_KEY_SEPARATOR)}${KV_KEY_SEPARATOR}`;
};
export const kvSharePermission = (
ownerUserUuid: string,
appUid: string,
keyPrefix: string,
access: KvShareAccess = 'watch',
): string =>
PermissionUtil.join(
KV_SHARE_ROOTS[access],
ownerUserUuid,
appUid,
...keyPrefixSegments(keyPrefix),
);
/** The family root a permission starts with, or `null` outside the family. */
const kvShareRootOf = (permission: string): string | null => {
const end = permission.indexOf(':');
const head = end === -1 ? permission : permission.slice(0, end);
return ACCESS_BY_ROOT.has(head) ? head : null;
};
export const isKvSharePermission = (permission: string): boolean =>
kvShareRootOf(permission) !== null;
/** The access level a share grant carries, or `null` outside the family. */
export const kvShareAccessOf = (permission: string): KvShareAccess | null => {
const root = kvShareRootOf(permission);
return root === null ? null : (ACCESS_BY_ROOT.get(root) ?? null);
};
/** The same grant at another level: only the root changes. */
export const withKvShareAccess = (
permission: string,
access: KvShareAccess,
): string => {
const root = kvShareRootOf(permission);
if (root === null) return permission;
return `${KV_SHARE_ROOTS[access]}${permission.slice(root.length)}`;
};
/** The grant at every level, for withdrawing a region whatever it was. */
export const kvShareGrantAtEveryLevel = (permission: string): string[] =>
KV_SHARE_ACCESS_LEVELS.map((access) =>
withKvShareAccess(permission, access),
);
/**
* Whether withdrawing `revoked` takes `held` with it. Prefix implication read
* backwards: a grant answers every check at or beneath it, so withdrawing it
* puts every one of those in question. Compared below the root, because a
* region withdrawn at one level is in question at every level.
*/
export const kvShareGrantCovers = (revoked: string, held: string): boolean => {
const revokedRoot = kvShareRootOf(revoked);
const heldRoot = kvShareRootOf(held);
if (revokedRoot === null || heldRoot === null) return false;
const region = revoked.slice(revokedRoot.length);
const inside = held.slice(heldRoot.length);
return inside === region || inside.startsWith(`${region}:`);
};
/**
* The level a key-value driver method needs through a share, or `null` for a
* method no share reaches. Derived from the cross-app op table, so a method
* missing from it fails closed.
*/
export const kvShareLevelForMethod = (method: string): KvShareAccess | null => {
if (!Object.prototype.hasOwnProperty.call(APP_DATA_KV_METHOD_OPS, method))
return null;
const op = APP_DATA_KV_METHOD_OPS[method];
if (op === null) return null;
return op === 'get' || op === 'list' ? 'read' : 'write';
};
/** The granted root a share grant names, read back as a key prefix. */
export const kvShareGrantPrefix = (permission: string): string =>
normalizeKeyPrefix(
PermissionUtil.split(permission).slice(3).join(KV_KEY_SEPARATOR),
);
/**
* A key inside a granted region, named the way its holder addresses it, or
* `null` for one outside. The handle is the granted root, so everything the
* holder is shown is relative to it — an absolute key would name a namespace
* they cannot address and were never told about.
*/
export const relativeToKvShareRoot = (
permission: string,
key: string,
): string | null => {
const prefix = kvShareGrantPrefix(permission);
if (!prefix || !key.startsWith(prefix)) return null;
return key.slice(prefix.length);
};
/**
* `kv.shareHandles` is off: no `read` or `write` shares, and no calls through
* one.
*/
export const kvHandlesDisabled = (): HttpError =>
new HttpError(
403,
'Sharing key-value data for reading or writing is not available',
{ legacyCode: 'kv_handles_disabled' },
);
// -- Minting input ----------------------------------------------------
export const invalidPrefix = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'invalid_kv_share_prefix' });
const invalidAccess = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'kv_share_access_invalid' });
/** The level a mint asks for, `fallback` when it names none. */
export const parseKvShareAccess = (
value: unknown,
fallback: KvShareAccess,
): KvShareAccess => {
if (value === undefined || value === null) return fallback;
if (
typeof value !== 'string' ||
!(KV_SHARE_ACCESS_LEVELS as readonly string[]).includes(value)
)
throw invalidAccess('`access` must be `watch`, `read` or `write`');
return value as KvShareAccess;
};
/**
* The grant a share of `keyPrefix` at `access` would issue, refused with
* `invalid_kv_share_prefix` when it would not fit the permission column. The
* room left depends on the owner uuid, the app uid and the level's root, so the
* longest prefix differs per namespace and level.
*/
export const assertPrefixFitsAccess = (
ownerUuid: string,
appUid: string,
keyPrefix: string,
access: KvShareAccess,
): string => {
const permission = kvSharePermission(ownerUuid, appUid, keyPrefix, access);
const prefix = normalizeKeyPrefix(keyPrefix);
const room = PERMISSION_MAX_LEN - (permission.length - prefix.length);
const overBytes =
access !== 'watch' &&
Buffer.byteLength(prefix, 'utf8') > KV_SHARE_PREFIX_MAX_BYTES;
if (permission.length > PERMISSION_MAX_LEN || overBytes)
throw invalidPrefix(
`With \`${access}\` access, a share prefix in this namespace may be at most ${room} characters` +
(access === 'watch'
? ''
: ` and ${KV_SHARE_PREFIX_MAX_BYTES} bytes`),
);
return permission;
};
const invalidRecipient = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'invalid_recipient' });
/** Who a share is for, as a username or a user uuid. */
export interface KvShareRecipient {
username?: string;
uid?: string;
}
/**
* A recipient as `POST /kv/shares` takes it: a username, `{ username }` or `{
* uid }`. An address is refused rather than looked up, so email recipients can
* later mean what they mean for file shares.
*/
export const parseKvShareRecipient = (value: unknown): KvShareRecipient => {
const named = (username: unknown): KvShareRecipient => {
if (typeof username !== 'string' || username.trim() === '')
throw invalidRecipient('`recipient` must name a user');
if (username.includes('@'))
throw invalidRecipient(
'`recipient` must be a username, not an email address',
);
return { username: username.trim() };
};
if (typeof value === 'string') return named(value);
if (value && typeof value === 'object' && !Array.isArray(value)) {
const { username, uid } = value as Record<string, unknown>;
if (username !== undefined) return named(username);
if (typeof uid === 'string' && uid.trim() !== '')
return { uid: uid.trim() };
}
throw invalidRecipient(
'`recipient` must be a username, `{ username }` or `{ uid }`',
);
};
const invalidLabel = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'kv_share_label_invalid' });
export const KV_SHARE_LABEL_MAX_CHARS = 128;
export const KV_SHARE_LABEL_MAX_BYTES = 512;
/**
* Control and format characters (bidi marks, overrides and isolates, zero-width
* characters, BOM, tags) and line or paragraph separators.
*/
const LABEL_FORBIDDEN = /[\p{Cc}\p{Cf}\p{Zl}\p{Zp}]/u;
/** Combining marks a label may stack on one character. */
export const KV_SHARE_LABEL_MAX_COMBINING_MARKS = 3;
const LABEL_MARK_RUN = new RegExp(
`\\p{M}{${KV_SHARE_LABEL_MAX_COMBINING_MARKS + 1},}`,
'u',
);
/**
* An owner-set label. `undefined` leaves the stored one alone, `null` clears
* it, and a string that trims to nothing reads as `null`.
*/
export const parseKvShareLabel = (
value: unknown,
): string | null | undefined => {
if (value === undefined) return undefined;
if (value === null) return null;
if (typeof value !== 'string')
throw invalidLabel('`label` must be a string');
const label = value.trim();
if (label === '') return null;
if (LABEL_FORBIDDEN.test(label))
throw invalidLabel(
'`label` may not contain control, formatting, line-break or text-direction characters',
);
if (LABEL_MARK_RUN.test(label))
throw invalidLabel(
`\`label\` may not stack more than ${KV_SHARE_LABEL_MAX_COMBINING_MARKS} combining marks on one character`,
);
if (
[...label].length > KV_SHARE_LABEL_MAX_CHARS ||
Buffer.byteLength(label, 'utf8') > KV_SHARE_LABEL_MAX_BYTES
)
throw invalidLabel(
`\`label\` may not exceed ${KV_SHARE_LABEL_MAX_CHARS} characters or ${KV_SHARE_LABEL_MAX_BYTES} bytes`,
);
return label;
};
export const invalidAppUid = (message: string): HttpError =>
new HttpError(400, message, { legacyCode: 'bad_request' });
/**
* The region a handle may be minted on. A pattern is refused because a handle
* names a region rather than selecting within one, and the namespace root is
* refused because a handle over everything the app holds is not a bounded
* capability — it is the app's data, and sharing that is a different decision
* with a different consent.
*/
export const assertShareablePrefix = (keyPrefix: unknown): string => {
if (typeof keyPrefix !== 'string')
throw invalidPrefix('`prefix` must be a string');
if (keyPrefix.includes('*') || keyPrefix.includes('?'))
throw invalidPrefix('A share prefix is a key prefix, not a pattern');
// `escape_permission_component` escapes `:` as `\C` but leaves `\` alone,
// so a prefix carrying one desynchronizes the stored `key_prefix` from the
// permission string and the share silently never fires.
if (keyPrefix.includes('\\'))
throw invalidPrefix('A share prefix may not contain a backslash');
// Normalizing drops empty segments, so `a::b:` would silently become a
// grant on `a:b:` — a region other than the one asked for. Refused rather
// than rewritten; only the trailing delimiter is optional.
const written = keyPrefix.split(KV_KEY_SEPARATOR);
if (written[written.length - 1] === '') written.pop();
if (written.some((segment) => segment === ''))
throw invalidPrefix('A share prefix may not have an empty key segment');
const normalized = normalizeKeyPrefix(keyPrefix);
if (normalized === '')
throw invalidPrefix('A share prefix may not be the whole namespace');
return normalized;
};
const NEW_SHARE_SEGMENT = /^[a-z0-9_.-]+$/;
/**
* The key segments a new share or share consent may name. One spelling per
* region, so no two grants differ only in case or accents, which some databases
* compare as equal. Existing shares are not held to it.
*/
export const assertNewShareSegments = (segments: readonly string[]): void => {
if (segments.some((segment) => !NEW_SHARE_SEGMENT.test(segment)))
throw invalidPrefix(
'A share prefix may only contain lowercase letters (a-z), digits, `_`, `.` and `-` between its `:` separators',
);
};
/** A new share over a prefix that an existing share spells differently. */
export const kvSharePrefixCaseConflict = (): HttpError =>
invalidPrefix(
'This user already has a share of a prefix that differs from this one only in letter case',
);
/**
* The shape every app uid takes, minted or derived from an origin. Narrow on
* purpose: `:` and `#` delimit the anchor token and permission grammars, so
* excluding them matters as much as excluding the handle prefix does.
*/
export const APP_UID_SHAPE = /^app-[A-Za-z0-9_-]{1,64}$/;
/** Fixed namespaces with no app of their own. */
const FIXED_KV_NAMESPACES: readonly string[] = [KV_GLOBAL_APP_KEY];
/**
* The namespace a handle may be minted over: the caller's own app slot, or the
* app-less one. Bounded by the column that stores it, shaped like a real app
* uid or one of the platform's fixed namespaces, and never handle-shaped, since
* the two share the app slot of a `kv:` subject.
*/
export const assertShareableAppUid = (appUid: string): string => {
if (appUid.length > KV_SHARE_APP_UID_MAX_LENGTH)
throw invalidAppUid(
`\`appUid\` may not exceed ${KV_SHARE_APP_UID_MAX_LENGTH} characters`,
);
if (isKvHandleId(appUid))
throw invalidAppUid('A share handle does not name a namespace');
if (!APP_UID_SHAPE.test(appUid) && !FIXED_KV_NAMESPACES.includes(appUid))
throw invalidAppUid('`appUid` does not name a namespace');
return appUid;
};
// -- Delegation -------------------------------------------------------
/** The delegation arm of a share grant: authority to hand the region out. */
export const kvShareManagePermission = (permission: string): string =>
PermissionUtil.join(
MANAGE_PERM_PREFIX,
...PermissionUtil.split(permission),
);
export const isKvShareManagePermission = (permission: string): boolean =>
PermissionUtil.isManage(permission) &&
isKvSharePermission(permission.slice(MANAGE_PERM_PREFIX.length + 1));
/**
* A delegation must name a subtree. Consent on the namespace root reads as "let
* this app hand out anything it has stored for you", which is not a bounded
* capability and so is not something a prompt can put to a user.
*/
export const assertBoundedManageGrant = (permission: string): string => {
if (!isKvShareManagePermission(permission)) return permission;
const [, , owner, appUid, ...segments] = PermissionUtil.split(permission);
if (!owner || !appUid || segments.length === 0)
throw invalidPrefix(
'A share delegation must name a region, not the whole namespace',
);
return permission;
};
/**
* The unbounded `manage:` grants, one per level, that a bounded delegation's
* own permission sits in. The consent surface refuses to ever write these rows,
* but `canManagePermission` walks ancestors to decide "may I delegate this", so
* one that exists by any other path would silently authorize a mint anywhere in
* the namespace. This is what lets the mint path notice it regardless.
*/
export const kvShareManageNamespaceRoots = (permission: string): string[] => {
const [, owner, appUid] = PermissionUtil.split(permission);
return KV_SHARE_ACCESS_LEVELS.map((access) =>
PermissionUtil.join(
MANAGE_PERM_PREFIX,
KV_SHARE_ROOTS[access],
owner,
appUid,
),
);
};
// -- Permission rules -------------------------------------------------
/**
* The level ladder: a check at one level is also answered by a grant at any
* level above it, `manage:` arms included. Only a string with at least one key
* segment is laddered, so no level of a namespace-root grant answers another.
*/
export const kvShareLevelsExploder = (): PermissionExploder => ({
id: 'kv-share-levels',
matches: (permission: string): boolean => {
const access = kvShareAccessOf(
PermissionUtil.stripManageArms(permission),
);
return access !== null && access !== 'write';
},
explode: ({ permission }): string[] => {
const grant = PermissionUtil.stripManageArms(permission);
const arms = permission.slice(0, permission.length - grant.length);
const access = kvShareAccessOf(grant);
// Owner, app, and at least one key segment after the root.
if (access === null || grant.split(':').length < 4) return [permission];
const above = KV_SHARE_ACCESS_LEVELS.slice(
KV_SHARE_ACCESS_LEVELS.indexOf(access) + 1,
);
return [
permission,
...above.map(
(level) => `${arms}${withKvShareAccess(grant, level)}`,
),
];
},
});
/**
* The permission a `manage:` arm delegates over. Only the leading component is
* stripped: a key segment may itself be `manage`, and taking those out would
* change which string the owner is read from.
*/
const withoutManageArm = (permission: string): string =>
permission.startsWith(`${MANAGE_PERM_PREFIX}:`)
? permission.slice(MANAGE_PERM_PREFIX.length + 1)
: permission;
/**
* Owning the namespace is holding every share grant over it, and being able to
* issue them. Without this the owner cannot mint a handle on their own data:
* `grantUserUserPermission` asks `canManagePermission` first, and there is no
* row anywhere saying a user may manage what is already theirs.
*
* Restricted to plain user actors, as the filesystem's `is-owner` is. An app
* disposing of a region of its user's namespace is delegation, which is the
* `manage:` grant's job rather than this one's.
*/
export const kvShareOwnerImplicator = (): PermissionImplicator => ({
id: 'kv-share-is-owner',
shortcut: true,
matches: (permission: string): boolean =>
isKvSharePermission(withoutManageArm(permission)),
check: ({ actor, permission }): unknown => {
if (!isPlainUserActor(actor)) return undefined;
const uuid = actor.user?.uuid;
if (!uuid) return undefined;
const owner = PermissionUtil.split(withoutManageArm(permission))[1];
return owner === uuid ? {} : undefined;
},
});
/** Scan memo key for the grants a user check already refused. */
const DELEGATE_REFUSED = 'kv-share-app-delegate:refused';
/**
* Whether a check of `asked` also asks `option`: `option` is `asked` or an
* ancestor of it, at the same level or above.
*/
const kvShareCheckReaches = (asked: string, option: string): boolean => {
const askedAccess = kvShareAccessOf(asked);
const optionAccess = kvShareAccessOf(option);
if (askedAccess === null || optionAccess === null) return false;
return (
KV_SHARE_ACCESS_LEVELS.indexOf(optionAccess) >=
KV_SHARE_ACCESS_LEVELS.indexOf(askedAccess) &&
kvShareGrantCovers(option, asked)
);
};
/**
* Letting an app-under-user actor exercise a share grant its user holds, at any
* level, bounded to the app the grant's namespace names.
*
* Only the grant itself is matched — never `manage:kv-share…` — because
* answering the manage arm here would read as the unbounded namespace-root
* delegation and break minting for everyone (see
* `kvShareManageNamespaceRoots`). The namespace-app check keeps one app from
* reading a region shared with another app of the same user.
*/
export const kvShareAppDelegateImplicator = (deps: {
userHolds: (actor: Actor, permission: string) => Promise<boolean>;
}): PermissionImplicator => ({
id: 'kv-share-app-delegate',
shortcut: true,
matches: (permission: string): boolean => isKvSharePermission(permission),
check: async ({ actor, permission, memo }): Promise<unknown> => {
if (!isAppActor(actor)) return undefined;
const app = actor.effectiveApp;
if (!app?.uid) return undefined;
const [, owner, namespaceApp, ...segments] =
PermissionUtil.split(permission);
if (!owner || !namespaceApp || segments.length === 0) return undefined;
if (namespaceApp !== app.uid) return undefined;
// A scan offers the deepest option first, and the user check of one
// also asks its ancestors at its level or above, so its refusal
// answers those without asking again.
const refused = memo?.get(DELEGATE_REFUSED) as string[] | undefined;
if (refused?.some((asked) => kvShareCheckReaches(asked, permission)))
return undefined;
if (await deps.userHolds(userRelatedActor(actor), permission))
return {};
memo?.set(DELEGATE_REFUSED, [...(refused ?? []), permission]);
return undefined;
},
});
Loaded 100 of 345 files, more files were not shown because too many files have changed in this diff. Show more