Compare commits

..
Author SHA1 Message Date
Nariman Jelveh 08a1a24dfe fix(homepage): serve the shell for /@<user>/<path>
Only /@<user> was routed, so a link to something inside a user's Public
folder fell through to the not-found redirect and landed on / without
opening anything. The GUI already opens the folder in Files, or the
file in its app, once the shell is served.
2026-11-04 11:40:47 -07:00
Nariman Jelveh 620a94c7fc refactor(gui): remove the desktop; every boot opens the dashboard
The desktop (UIDesktop, the taskbar, toolbar, start menu, search, task
manager, welcome, QR and wallpaper windows) is gone. Every boot outside an
auth popup opens the dashboard, including iframe embeds and URLs that used
to load the desktop:

- `/desktop`, `/desktop/app/<name>` redirect to `/` and `/app/<name>`,
  keeping the query; the GUI also drops the prefix if one reaches it.
- `/@<user>/<path>` and `/show/<path>` open the folder in Files, or the
  file in its app. `/show` no longer carries a boot hook naming a GUI
  global that no longer exists, which had stopped the GUI booting.
- `/settings` opens Home; `?app=explorer[&path=]` opens Files.
- `/?download=<url>` keeps its confirm-and-save-to-Desktop flow.

The window system stays: the dashboard, its apps and the file pickers
run on it. Snapping, the taskbar-height layout math and the folder
layout/sort endpoints are untouched. The backend drops the
`/set-desktop-bg` and `/update-taskbar-items` endpoints and the
`taskbar_items` and `desktop_bg_*` user fields (columns kept).
2026-11-04 10:57:52 -07:00
557 changed files with 12847 additions and 44080 deletions

No files matched your search

+2 -6
View File
@@ -176,10 +176,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v7
# Missing when the PR leg failed; `coverage (pr)` already reports that.
- name: Download PR coverage
id: pr-coverage
continue-on-error: true
uses: actions/download-artifact@v8
with:
name: puterjs-coverage-pr
@@ -189,7 +186,6 @@ jobs:
# base run) — then report without the comparison column.
- name: Download base coverage
id: base-coverage
if: steps.pr-coverage.outcome == 'success'
continue-on-error: true
uses: actions/download-artifact@v8
with:
@@ -197,7 +193,7 @@ jobs:
path: coverage-base
- name: Report coverage on PR
if: steps.pr-coverage.outcome == 'success' && steps.base-coverage.outcome == 'success'
if: steps.base-coverage.outcome == 'success'
uses: davelosert/vitest-coverage-report-action@v2
with:
name: puter.js SDK
@@ -206,7 +202,7 @@ jobs:
json-summary-compare-path: coverage-base/coverage-summary.json
- name: Report coverage on PR (no base comparison)
if: steps.pr-coverage.outcome == 'success' && steps.base-coverage.outcome != 'success'
if: steps.base-coverage.outcome != 'success'
uses: davelosert/vitest-coverage-report-action@v2
with:
name: puter.js SDK
+1 -31
View File
@@ -159,42 +159,13 @@ The reference has two kinds of page:
An overview page answers "what is this API and is it what I need?", and a function page answers "how exactly does this call behave?". A change to one function usually only touches that function's page, so a new `kv.list()` option goes in `KV/list.md` without a matching update to `KV.md`. Don't copy a function's options, limits, or edge cases onto the overview page for completeness. Where a detail goes is a judgment call, not a hard rule: update the overview when a change affects how someone would describe the API as a whole.
When you add a page, add it to [src/docs/src/sidebar.js](src/docs/src/sidebar.js) under its area, or it won't show up in the navigation.
**Sidebar order.** Order the API areas in the sidebar by how often developers use them, most common first. Overview stays first and Objects stays last. Inside an area, order the pages by use too, and keep pages that make up one feature next to each other, such as `share()`, `unshare()`, `listShared()`, and `listSharedByMe()`. A group goes where its most-used page would go. A helper that only supports another function, such as `listModels()` for `chat()`, goes by its own use. Put create, list, get, update, and delete in that order, and constants such as `MAX_KEY_SIZE` last. The function list on the area's overview page uses the sidebar's order. When you add a runnable example, add its HTML to `src/docs/src/playground/examples/<slug>.html`, register the slug in [src/docs/src/examples.js](src/docs/src/examples.js), and link the code block to it by putting the slug after the language with a semicolon (` ```html;kv-set `).
### Function page layout
A function page opens with one sentence that says what the function does, in its own paragraph, such as "Given a prompt, generate an image using AI." Put any more detail in the paragraphs after it.
After the intro, a function page has these `##` sections, in this order:
1. Syntax
2. Parameters
3. Return value
4. Errors, if the function has any
5. Sections for specific topics, if the page needs them, with `## Model-specific features` last
6. Examples
[chat.md](src/docs/src/AI/chat.md) follows this layout.
- **Options as a table.** Document an options object as a table with Option, Type, and Description columns. Give each option its own row, even when two options go together, such as `width` and `height`. Order the rows by how often developers use them, most common first, without group rows. In chat.md that's the core options, then reasoning, tools, response handling, request control, and output.
- **Common options in the table, model-specific behavior in its own section.** A page whose function works with many models or providers, such as [chat.md](src/docs/src/AI/chat.md) and [txt2img.md](src/docs/src/AI/txt2img.md), splits its options this way:
- **The options table** under Parameters lists the options that work with every model, and describes each one the way it works for every model.
- **`## Model-specific features`**, the last section before Examples, covers everything else. It has a `###` for each model family or provider, named after it, such as "OpenAI models" or "Cloudflare models". Under it go the options only some models accept, and the common options a model handles differently, such as a narrower range, other allowed values, or an option it ignores.
- **Write there only what's different.** A `###` lists an option only when that model or provider adds it or handles it differently. An option that works the same everywhere stays out, even if the provider supports it, and a model or provider with nothing different gets no `###`.
- **Model-specific features is the only place for model-specific details.** Every limit, format, allowed value, default, price, or quirk that applies to some models goes there, in that model's or provider's `###`, and nowhere else. The options table and topic sections (such as Image inputs or Video input) describe what's true for every model and link to Model-specific features for the rest. Don't add a table or sentence there that compares providers or repeats a model's limits. Each copy is another source of truth to keep in sync, and copies drift when a model changes.
- **Link the two.** Directly under the options table, put `Some models accept additional options or handle these options differently. See [Model-specific features](#model-specific-features).` A row whose option behaves differently on some models can also end with `See [Model-specific features](#model-specific-features).`
- **A long topic gets its own `##` section.** When explaining an option or feature takes more than a sentence or two, such as function calling or output dimensions, give it a section between Errors and Examples and link to it from the options table. This keeps the reference sections short.
- **Usage patterns are examples.** A way of using the API, such as stopping a stream, goes in a runnable example that the relevant section links to ("See the [stop a stream example](/playground/ai-chat-stop-stream/)."), not in a section of its own.
- **Each example has a `###` heading** under `## Examples`, so every example shows in the table of contents.
When you add a page, add it to [src/docs/src/sidebar.js](src/docs/src/sidebar.js) under its area, or it won't show up in the navigation. When you add a runnable example, add its HTML to `src/docs/src/playground/examples/<slug>.html`, register the slug in [src/docs/src/examples.js](src/docs/src/examples.js), and link the code block to it by putting the slug after the language with a semicolon (` ```html;kv-set `).
### Writing docs
These apply to reference pages and recipes alike.
- **Document the developer-facing side only.** The reader is building on top of puter.js, so cover what affects their code: signatures, defaults, return shapes, errors, limits, and behavior they can observe. Leave out internal workings (which service handles the call, storage layout, caching, retries) unless they change what the developer has to do. [rate-limits-and-quotas.md](src/docs/src/rate-limits-and-quotas.md) is the exception: it publishes every limit, including timeouts and caps that come from how the backend works.
- **Document Puter as it runs on puter.com.** The docs are for developers building on production Puter. Leave out behavior that only happens on a self-hosted or differently configured server, such as a provider that isn't set up there.
- **Describe the current state.** Docs aren't a changelog. Write how the API behaves now, without "now", "no longer", "existing code is unaffected", or other wording that compares it to an older version.
- **Verify before you document.** Run the calls you describe against a running Puter instead of inferring behavior from the source.
- **Write plainly.** Use the literal words a developer would say out loud, with contractions and everyday words. No idioms or figurative verbs ("walk away from something shared with you" → "remove your own access", "nothing to page through" → "without pagination"). No formal register ("present only while more pages remain" → "includes a `cursor` if there are more pages to load"). Prefer dev terms such as atomic, concurrent, and insertion order.
@@ -202,7 +173,6 @@ These apply to reference pages and recipes alike.
- **Describe behavior directly.** No quoted inner-voice phrases. Write "`isNew` is `true` when the person did not have access before", not "this tells 'I just gave this to someone' from 'they already had it'".
- **Keep references easy to follow.** Name what a list or code block belongs to in the sentence directly above it. Name a thing once and keep that name. Introduce an actor as "a user" before giving them a role: "A user can create a team. The user who creates the team becomes its owner."
- **Sentence mechanics.** Never start a sentence with inline code: write "To store data, use the [`set()`](/KV/set/) method." Link every inline mention of an API to its page, every time. No em dashes, and no colons or semicolons mid-sentence; a colon that introduces a code block is fine.
- **No `##` or `###` headings inside tabs.** The table of contents lists every `##` and `###` heading on the page, including the ones in a hidden tab (an `example-content` block switched by the `example-group` pills), so its links lead to content the reader can't see. Put the heading above the tabs, or use `####` inside a tab, which the table of contents skips.
- **Show the correct way.** No "don't" and no wrong-way-first examples, in recipes and playground examples alike. Mention a wrong approach only when developers already hit it in practice, and state how it fails as a fact: "`add()` reads a plain object as a path map, so the call rejects with …".
### Recipes
-171
View File
@@ -1,171 +0,0 @@
# Embedded app browser
`GET /embed/apps` on the deployment's main GUI origin renders the same app browser
as the dashboard's Apps tab, without the desktop or dashboard navigation.
It supports search, paging, saved folders, and saved ordering. It uses the same
installed-app and recommendation data as the dashboard, including the user's
removed recommendations. Editing, adding, reordering, renaming, and uninstalling
are disabled. Selecting an app opens it in a new browser tab at its own URL, the
same way the dashboard does, and the host page stays open. The app's token isn't
put in the URL: the app's SDK asks the embed for it once the tab loads, so the
embed must still be open then. If the iframe is removed first, the app falls back
to its normal sign-in. Apps that need the desktop (built-in and godmode apps,
private apps the user can't open, or a failed token request) open `/app/<name>`
on the GUI origin, cut off from the embed. Website shortcuts open their external
destination with no opener.
The embed follows the OS's light or dark setting. A host with a fixed theme adds
`theme=dark` or `theme=light` to the fragment (`#user=<uuid>&theme=dark`), since
Chromium doesn't pass an iframe's `color-scheme` on to the page inside it.
Apps opened from the embed carry `utm_source=puter.com&utm_medium=referral&utm_campaign=app_browser_embed`;
the desktop and dashboard send `utm_campaign=desktop` and `utm_campaign=dashboard`.
## Session and framing
The embed shows the GUI session only to the user the host page is signed in as.
The host names that user's `uuid` (from `puter.auth.getUser()`) in the iframe
URL's fragment, as `/embed/apps#user=<uuid>`. The embed reads the session, asks
`/whoami` which user it belongs to, and shows the signed-out view unless the two
match. So a host that names no user, a malformed one, or a user other than the
session's, gets the signed-out view, and so does a session the API refuses. A
failed `/whoami` check shows the error state. The fragment never reaches the
server and can only narrow what the embed shows: naming the session's own user
gives the same view as a direct visit to the GUI. Changing the fragment of a
loaded embed reloads it.
The embed reads the existing GUI session from local storage on its own origin.
If that storage holds no session, the embed gets the session from the GUI origin's session cookie through
`/get-gui-token`. This matters in Safari, which gives a framed origin separate
local storage under each top-level origin, so even a sibling subdomain's iframe
can't see the GUI's stored token. The session cookie is still sent, because the
host is on the same site. The embed doesn't write that token back to storage. It
does not create accounts, show a login dialog, or accept a token from its parent.
Being signed in on a subdomain alone does not create a session on the main GUI
origin.
Without a session it can show, the embed shows the recommended apps (`RecommendedAppsService`)
that the server put in the page, and nothing else: no installed apps, folders, or
saved order, and no puter.js. Selecting one opens it at the same URL a signed-in
launch uses, with no opener and no token on offer, so the app signs in on its own.
Apps that need the desktop open `/app/<name>`. If the page carries no recommended
apps, or a load fails, the embed displays an unavailable/error state.
The route's `Content-Security-Policy: frame-ancestors` allows the GUI origin and
the embedding page's origin when it is exactly one label under `config.domain`
with the scheme and port from `config.origin`. Subdomains the server answers
itself (`api`, `dav`, `js`, `www`, the native-app hosts, and the host of
`api_base_url`) and the user-content hosting domains (`static_hosting_domain`,
`private_app_hosting_domain`, and their `_alt` variants) are refused. For
example, `https://puter.com` permits `https://spreadsheet.puter.com` but not
`https://api.puter.com`, and `http://puter.localhost:4100` permits
`http://spreadsheet.puter.localhost:4100` but not
`http://someone.site.puter.localhost:4100`. The embedding page is read from the
iframe request's referrer, so the host must not suppress it (the browser default
`strict-origin-when-cross-origin` is enough). All ancestors in a nested iframe
chain must be allowed. Other GUI routes retain `X-Frame-Options: SAMEORIGIN`.
The embed accepts no query parameters. Requests with a query string redirect to
the same embed path so SDK bootstrap parameters cannot override the session or API
origin. The host needs to allow the GUI origin in its own `frame-src` CSP if it
sets one. If sandboxing the iframe, allow scripts, same-origin storage, popups,
and popups to escape the sandbox.
## Host integration
A first-party app that signs in with puter.js can place `<puter-user-menu>` from
the SDK in its header instead (see `src/puter-js/src/ui/components.md`). It opens
this embed with the signed-in user named and closes it when the app's sign-in
changes. The rest of this section is for a host that builds the iframe itself.
The iframe can be shown whether or not the user is signed in. Create it when
“More apps” is opened, naming the signed-in user in its fragment, and remove it
on close so reopening loads current apps and preferences. Remove it when the
host's own sign-in changes too, such as on sign-out, so an open embed doesn't
keep the previous user. The host owns the modal and close control;
there is no parent messaging API and no app list or credential is sent to it.
The app browser fills its iframe and responds to its size. It shows a spinner until its apps load.
This example assumes `puterOrigin` comes from the host app's deployment
settings. Translate the button and frame labels using the host app's
localization system.
```html
<button id="more-apps" type="button">More apps</button>
<dialog id="apps-dialog" aria-label="More apps">
<button id="close-apps" type="button">Close</button>
<div id="apps-frame"></div>
</dialog>
<style>
#apps-dialog { padding: 12px; width: min(900px, 90vw); }
#apps-frame iframe { width: 100%; height: min(650px, 75vh); border: 0; }
</style>
<script type="module">
const puterOrigin = 'https://puter.com'; // Use this deployment's configured origin.
const dialog = document.querySelector('#apps-dialog');
const container = document.querySelector('#apps-frame');
const trigger = document.querySelector('#more-apps');
trigger.addEventListener('click', async () => {
const url = new URL('/embed/apps', puterOrigin);
// Signed out, the embed shows the recommended apps.
const user = puter.auth.isSignedIn() ? await puter.auth.getUser().catch(() => null) : null;
if (user) url.hash = `user=${encodeURIComponent(user.uuid)}`;
const frame = document.createElement('iframe');
frame.title = 'Your apps';
frame.src = url.href;
container.replaceChildren(frame);
dialog.showModal();
});
document.querySelector('#close-apps').addEventListener('click', () => dialog.close());
dialog.addEventListener('close', () => {
container.replaceChildren();
trigger.focus();
});
</script>
```
## Implementation
`createAppBrowser` in `src/gui/src/UI/Dashboard/AppBrowser.js` owns the shared UI
and data behavior; its `guestApps` option is the signed-out list. `TabApps.js`
injects desktop actions. `appsEmbed.js` supplies new-tab launching through
`launchAppInTab` (signed in) and `guestAppLaunchUrl` (signed out) in
`src/gui/src/helpers/appTabLaunch.js`, which build the same app URL as
`launch_app`, and loads only the embed entry, its SDK, and shared styles. `embedHostUser` in
`src/gui/src/helpers/embedHostUser.js` reads the host's user from the fragment, and
`embedHostTheme.js` beside it applies the host's theme.
The normal GUI webpack build emits `bundle.min.js`, `apps-embed.min.js`, and `feedback-embed.min.js`.
The `/embed/apps` route puts the recommended list in the page's config as
`guestApps`. No puter.js API or app-list endpoint changes are needed.
## Feedback dialog
`GET /embed/feedback` is the app feedback dialog (`puter.ui.showFeedbackDialog()`)
for a first-party page, with the same framing rules, query redirect, and
host-user binding as `/embed/apps`. It sends the feedback for the framing
page's origin, which the server reads from the referrer and pins with
`frame-ancestors`; opened top-level, it does nothing. Its page is transparent
so the dialog's own scrim covers the host.
puter.js uses it on a page one label under the GUI origin when the page is
signed in, framing it in a modal `<dialog>` that stays hidden until the embed
is ready. The embed posts `{ msg: 'feedbackEmbed', state }` to its parent
(`loading`, then `ready` or `unavailable`) and finally
`{ msg: 'feedbackDialogClosed', sent }`. It reports `unavailable` without the
named user's session, or while that user's email still needs confirming, and
puter.js then uses the `/action/send-feedback` popup, which can sign in. So does
a frame that never answers, such as one the host's CSP blocks. `feedbackEmbed.js`
is the entry, sharing `embedSession` in `src/gui/src/helpers/embedSession.js`
with the app browser; `showFeedbackEmbed` in `src/puter-js/src/lib/guiEmbed.js`
is the host side.
## Checks
Run the GUI component/browser tests (with the SDK bundle built and Playwright
Chromium installed), and the backend route tests:
```sh
npx vitest run --config src/gui/vitest.config.js src/gui/src/UI/Dashboard/AppBrowser src/feedbackEmbed
npx vitest run src/puter-js/src/lib/guiEmbed.test.js src/puter-js/src/modules/UI.showFeedbackDialog.test.js
npx vitest run --config src/backend/vitest.config.ts src/backend/server.test.ts
```
+6 -7
View File
@@ -1,6 +1,6 @@
# Browser push client
Puter's desktop shows pushes through `/sw.js`. Core shows Settings → Notifications only when the `pushEnabled` gui param is `true`; core never sets it. The worker is registered only when push is turned on in the browser, and a load removes one left without a subscription. A backend extension that delivers pushes sets it with `services.homepage.setGuiParam('pushEnabled', true)` and can load its own code into the worker with `services.homepage.registerServiceWorkerScript(path)`.
Puter's desktop shows pushes through `/sw.js`. Core registers it, and shows Settings → Notifications, only when the `pushEnabled` gui param is `true`; core never sets it. A backend extension that delivers pushes sets it with `services.homepage.setGuiParam('pushEnabled', true)` and can load its own code into the worker with `services.homepage.registerServiceWorkerScript(path)`.
Core subscribes the browser to a push service only when the server also publishes `pushWebPushKey` (see [Built-in Web Push client](#built-in-web-push-client)), and it has no `/push/*` routes of its own. The device, app, preference and subscription endpoints below come from that extension. On a deployment without one, such as most self-hosted servers, they answer core's plain 404 (`code: 'not_found'`), which `puter.notifications` reports as `push_unavailable` and the Notifications tab shows as unavailable. A device the extension can't find is `device_not_found`.
@@ -22,13 +22,12 @@ When the browser replaces the subscription (`pushsubscriptionchange`), `sw.js` p
Before a notification is pushed, the server asks the open clients whether they received it live. It sends `notif.receipt` with `{ uid }` on the user's sockets for the app that sent it, or on the desktop's sockets for Puter's own notifications. The SDK remembers the uids its page received through `onNotification()`, `onPush()` or the desktop's feed, and answers once its page has that notification, or with `{ received: false }` when it never gets it. The server waits up to 5 seconds (`notificationAckTimeoutMs`).
An answer carries `visibilityState` and `focused` as they were when the page received the notification. Pages never show a browser notification themselves; pushes do.
An answer carries `visibilityState`, `focused` and `showsOwn`, the last being whether the page shows the notification itself. A website page shows it itself when it is hidden or unfocused, has an `onPush()` handler and notification permission, and no other tab of the same site is focused. Inside the desktop, the desktop shows it, and an app's `onPush()` result is never shown as a browser notification.
- An answer from a page that was visible and focused stops the push (`handled` on `notif.delivery.settled`). An older client that doesn't send `focused` counts while visible.
- Otherwise the notification is pushed, to every browser the user subscribed. A website's pushes go only to the browsers that subscribed through its own worker, never to Puter's `/sw.js`. An app inside the desktop pushes through `/sw.js`, which shows the app's name and icon.
- A client that can't answer, such as an older puter.js, doesn't hold the push back.
The ask reaches only the sockets in the asking region. So that other regions hear about a page too, a page that receives a notification live while visible and focused also sends `notif.handled` with `{ uid }` on the socket it came on. Core relays it as the node-local `notif.handled` event with the socket's user and app, at most 60 a minute per user; an extension that delivers pushes decides what to do with it.
- An answer from a page that is visible and focused, or that shows the notification itself, stops the push.
- Otherwise the notification is pushed. A website's pushes go only to the browsers that subscribed through its own worker, never to Puter's `/sw.js`. An app inside the desktop pushes through `/sw.js`, which shows the app's name and icon.
- A hidden desktop tab shows no banner, so answers only from hidden desktop tabs don't stop a push of Puter's own notifications.
- A client that can't answer, such as an older puter.js, holds the push back while it is connected.
## Registering
+5 -10
View File
@@ -257,8 +257,6 @@ describe('whoami extension — handleWhoami', () => {
expect(body.created_ts).toBeGreaterThan(0);
// `directories` is only sent to user actors — confirm it’s present.
expect(body.directories).toBeDefined();
// taskbar_items is only sent to user actors.
expect(body).toHaveProperty('taskbar_items');
});
it('reports the SMS-to-card fallback only once a send has opened it', async () => {
@@ -322,7 +320,7 @@ describe('whoami extension — handleWhoami', () => {
expect(flags.payment_bypass).toBeUndefined();
});
it('strips desktop_bg_*, created_ts and human_readable_age fields for app actors', async () => {
it('strips created_ts and human_readable_age fields for app actors', async () => {
const user = await seedUser();
const { res, captured } = makeRes();
@@ -340,9 +338,6 @@ describe('whoami extension — handleWhoami', () => {
expect(body.app_name).toBe('app-test-actor');
// is_user_token is stripped for app actors.
expect(body.is_user_token).toBeUndefined();
expect(body.desktop_bg_url).toBeUndefined();
expect(body.desktop_bg_color).toBeUndefined();
expect(body.desktop_bg_fit).toBeUndefined();
expect(body.human_readable_age).toBeUndefined();
// Account age, in either form, is not exposed to apps.
expect(body.created_ts).toBeUndefined();
@@ -432,7 +427,7 @@ describe('whoami extension — handleWhoami', () => {
});
});
it('cannot add taskbar_items for an app actor, which core omits', async () => {
it('cannot add directories for an app actor, which core omits', async () => {
const user = await seedUser();
const body = await whoamiWithListener(
makeActor({
@@ -440,11 +435,11 @@ describe('whoami extension — handleWhoami', () => {
app: { uid: 'app-test-actor' },
}),
(_key, event) => {
event.details.taskbar_items = [{ name: 'injected' }];
event.details.directories = { '/injected': 'x' };
},
);
expect(body).not.toHaveProperty('taskbar_items');
expect(body).not.toHaveProperty('directories');
});
});
@@ -525,7 +520,7 @@ describe('whoami extension — handleWhoami', () => {
expect(body.otp_secret).toBeUndefined();
expect(body.signup_ip).toBeUndefined();
// Not just absent as a key — the values must not appear anywhere
// in the payload (nested under metadata, taskbar items, …).
// in the payload (nested under metadata, …).
const serialized = JSON.stringify(body);
expect(serialized).not.toContain('5551234567');
expect(serialized).not.toContain('fp_ABC123');
+3 -17
View File
@@ -1,6 +1,5 @@
import { Context } from '@heyputer/backend/src/core';
import { extension } from '@heyputer/backend/src/extensions';
import { APP_ICON_SIZES } from '@heyputer/backend/src/util/appIcon.js';
import {
buildUserDetails,
scrubSensitive,
@@ -26,7 +25,7 @@ const APP_VISIBLE_LISTENER_KEYS: ReadonlySet<string> = new Set([
]);
export const handleWhoami = async (
req: Request,
_req: Request,
res: Response,
): Promise<void> => {
const actor = Context.get('actor');
@@ -54,19 +53,10 @@ export const handleWhoami = async (
return;
}
const rawIconSize =
typeof req.query?.icon_size === 'string'
? Number(req.query.icon_size)
: undefined;
const iconSize =
rawIconSize !== undefined && APP_ICON_SIZES.includes(rawIconSize)
? rawIconSize
: undefined;
const details = await buildUserDetails(
user,
{ config: extension.config, clients, stores, services },
{ isUser, iconSize, noIcons: !iconSize },
{ isUser },
);
details.human_readable_age = user.timestamp
? timeago.format(new Date(user.timestamp as string))
@@ -81,9 +71,6 @@ export const handleWhoami = async (
delete details.email;
delete details.unconfirmed_email;
}
delete details.desktop_bg_url;
delete details.desktop_bg_color;
delete details.desktop_bg_fit;
delete details.human_readable_age;
delete details.created_ts;
delete details.is_user_token;
@@ -121,8 +108,7 @@ export const handleWhoami = async (
}
const subscription = details.subscription as
| { offering?: Record<string, unknown> }
| undefined;
{ offering?: Record<string, unknown> } | undefined;
if (subscription?.offering) {
delete subscription.offering.group;
delete subscription.offering.benefits;
@@ -318,13 +318,3 @@ describe('AbstractDatabaseClient — SQL generation', () => {
);
});
});
it('builds an insert for batchWrite and shares it with insert', async () => {
const client = new FixtureDatabaseClient([]);
const entry = client.insertEntry('widget', { name: "reader's", enabled: true });
expect(entry.values).toEqual(["reader's", true]);
expect(entry.statement).toContain('VALUES (?, ?)');
await client.insert('widget', { name: "reader's", enabled: true });
expect(client.writes).toEqual([{ query: entry.statement, params: entry.values }]);
});
+7 -16
View File
@@ -110,23 +110,14 @@ export class AbstractDatabaseClient extends PuterClient {
tableName: string,
data: Record<string, unknown>,
): Promise<WriteResult> {
const entry = this.insertEntry(tableName, data);
return this.write(
entry.statement + this.returningIdClause(),
entry.values,
);
}
/** An insert that can join other writes in a transaction. */
insertEntry(tableName: string, data: Record<string, unknown>): BatchEntry {
const cols = Object.keys(data);
return {
statement:
`INSERT INTO ${this.quoteIdentifier(tableName)} ` +
`(${cols.map((c) => this.quoteIdentifier(c)).join(', ')}) ` +
`VALUES (${cols.map(() => '?').join(', ')})`,
values: Object.values(data),
};
const values = Object.values(data);
const sql =
`INSERT INTO ${this.quoteIdentifier(tableName)} ` +
`(${cols.map((c) => this.quoteIdentifier(c)).join(', ')}) ` +
`VALUES (${cols.map(() => '?').join(', ')})` +
this.returningIdClause();
return this.write(sql, values);
}
/** Whether `read()` goes to a separate replica rather than the primary. */
+11 -48
View File
@@ -117,7 +117,7 @@ export type EventMap = {
model_used: string;
service_used: string;
intended_service: string;
model_details?: {
model_details: {
id: string;
provider: string;
input_cost_key: string;
@@ -200,16 +200,6 @@ export type EventMap = {
};
// ---- Auth / signup ----
/**
* Which signup methods are open, emitted via `emitAndWait` before every
* signup and whenever the GUI reads the provider list. A listener sets
* `oidcOnly` to refuse form and temp signups, leaving OIDC and team
* provisioning open; `message` is what a refused form signup is told.
*/
'puter.signup.policy': {
oidcOnly: boolean;
message: string | null;
};
'puter.signup.validate': {
allow: boolean;
email?: string;
@@ -556,14 +546,6 @@ export type EventMap = {
'kv.share.retired': { handles: string[]; userId: number };
// ---- Notifications ----
/** An app message was acknowledged after its state committed. */
'notif.acknowledged': {
userId: number;
uid: string;
type: string;
audience: string;
appUid: string;
};
/**
* A notification row exists. Emitted after the insert commits — nothing
* pushes a uid before there is a row to name — and carries the scope tuple
@@ -597,8 +579,6 @@ export type EventMap = {
value: Record<string, unknown>;
/** An earlier notification rewritten in place. */
updated?: true;
/** Replaced an earlier notification in its group. */
replaced?: true;
/** Names this one send, for a receipt asked about it. */
sendId: string;
/** The same `sendId` may be emitted again, as a delayed send is. */
@@ -636,18 +616,6 @@ export type EventMap = {
/** A peer region holds a socket for the user. */
peerRegions: boolean;
responders: NotifDeliveryResponder[];
/** A page here got it live while visible and focused. */
handled: boolean;
};
/**
* A page reported that it got a notification live while visible and
* focused. Node-local; `appUid` is the reporting socket's app, absent for
* the desktop.
*/
'notif.handled': {
userId: number;
appUid?: string;
uid: string;
};
// ---- Metering ----
@@ -873,12 +841,6 @@ export type EventMap = {
/** One access token was revoked; only its own connections should drop. */
'auth.access-token.revoked': { token_uid: string };
/** Same-cluster eviction for raw realtime WebSockets. */
'pubsub.realtime.auth-revoked': {
sessionUids?: string[];
tokenUid?: string;
};
/**
* A grant was withdrawn, so whatever was standing on it has to be settled
* rather than left to fail its next check.
@@ -1079,11 +1041,10 @@ export type EventKey = keyof EventMap & string;
// Generates a wildcard for every non-final dot-separated prefix of K.
export type WildcardPrefixes<K extends string> =
K extends `${infer Head}.${infer Tail}`
?
| `${Head}.*`
| (Tail extends `${string}.${string}`
? `${Head}.${WildcardPrefixes<Tail>}`
: never)
? | `${Head}.*`
| (Tail extends `${string}.${string}`
? `${Head}.${WildcardPrefixes<Tail>}`
: never)
: never;
export type ListenKey = EventKey | WildcardPrefixes<EventKey>;
@@ -1094,16 +1055,18 @@ export type MatchingEvents<P extends ListenKey> = P extends `${infer Prefix}.*`
/** Acked, not acked, no socket anywhere, or sockets only in a peer region. */
export type NotifDeliveryOutcome =
| 'received'
| 'unreceived'
| 'no-socket'
| 'remote-only';
'received' | 'unreceived' | 'no-socket' | 'remote-only';
/** One socket's receipt for a live notification. */
export interface NotifDeliveryResponder {
visibilityState: 'visible' | 'hidden' | 'unknown';
/** The page's window has focus. Absent from older clients. */
focused?: boolean;
/**
* The page shows its own browser notification while hidden or unfocused.
* Absent from older clients.
*/
showsOwn?: boolean;
}
export type EventMetadata = {
@@ -347,46 +347,6 @@ describe('DispatcherInvokeTransport with every connection busy', () => {
held[INVOKE_CONNECTIONS].answer();
await expect(after).resolves.toMatchObject({ status: 200 });
});
it('rechecks the guard once a connection frees, and drops a superseded call', async () => {
const { transport, held, answerAll } = await saturated();
let current = true;
const guard = vi.fn(async () => current);
const waiting = transport.send({ ...CALL, beforeSend: guard });
current = false;
held[0].answer();
await expect(waiting).resolves.toEqual({
status: null,
error: 'invocation superseded',
});
expect(guard).toHaveBeenCalledTimes(1);
expect(held).toHaveLength(INVOKE_CONNECTIONS);
await answerAll();
});
it('fails a call whose guard throws after the wait, and frees its slot', async () => {
const { transport, held, answerAll } = await saturated();
const waiting = transport.send({
...CALL,
beforeSend: async () => {
throw new Error('lease store down');
},
});
held[0].answer();
await expect(waiting).rejects.toThrow('lease store down');
expect(held).toHaveLength(INVOKE_CONNECTIONS);
await answerAll();
const after = transport.send(CALL);
await vi.waitFor(() =>
expect(held).toHaveLength(INVOKE_CONNECTIONS + 1),
);
held[INVOKE_CONNECTIONS].answer();
await expect(after).resolves.toMatchObject({ status: 200 });
});
});
describe('DispatcherInvokeTransport schedule lane', () => {
@@ -811,138 +771,6 @@ describe('DispatcherInvokeTransport batches', () => {
]);
});
it('leaves a call superseded while gathered out of the batch', async () => {
const { fetchImpl, batches, singles } = streamingFetch();
const transport = transportFor(fetchImpl, { batchWindowMs: 20 });
let current = true;
const sent = [
transport.send(CALL),
transport.send({ ...CALL, beforeSend: async () => current }),
transport.send({ ...CALL, script: 'evw-other' }),
];
current = false;
await vi.waitFor(() => expect(batches).toHaveLength(1));
expect(batches[0].body.calls.map((call) => call.script)).toEqual([
'evw-test',
'evw-other',
]);
await expect(sent[1]).resolves.toEqual({
status: null,
error: 'invocation superseded',
});
batches[0].answer({ i: 0, status: 200, handled: true });
batches[0].answer({ i: 1, status: 200, handled: true });
await expect(Promise.all([sent[0], sent[2]])).resolves.toEqual([
{ status: 200, handled: true },
{ status: 200, handled: true },
]);
expect(singles).toHaveLength(0);
});
it('sends nothing when every gathered call was superseded', async () => {
const fetchImpl = vi.fn(
stubFetch(200, { [EVENTS_HANDLED_HEADER]: '1' }),
);
const transport = transportFor(fetchImpl as unknown as FetchImpl);
const superseded = { ...CALL, beforeSend: async () => false };
await expect(
Promise.all([
transport.send(superseded),
transport.send(superseded),
]),
).resolves.toEqual([
{ status: null, error: 'invocation superseded' },
{ status: null, error: 'invocation superseded' },
]);
expect(fetchImpl).not.toHaveBeenCalled();
});
it('fails only the call whose guard throws at flush', async () => {
const { fetchImpl, batches, singles } = streamingFetch();
const transport = transportFor(fetchImpl);
const failing = transport.send({
...CALL,
beforeSend: async () => {
throw new Error('lease store down');
},
});
const kept = transport.send(CALL);
await expect(failing).rejects.toThrow('lease store down');
// One call left, so it goes alone.
await expect(kept).resolves.toEqual({ status: 200, handled: true });
expect(batches).toHaveLength(0);
expect(singles).toHaveLength(1);
});
it('rechecks the guard before resending a batch call on its own', async () => {
const urls: string[] = [];
let current = true;
const fetchImpl = (async (url: string) => {
urls.push(url);
if (url.endsWith(EVENTS_DISPATCH_BATCH_PATH)) {
// Superseded while the batch was out.
current = false;
return new Response('no-such-route', {
status: 404,
headers: {
[EVENTS_DISPATCH_ERROR_HEADER]: 'no-such-route',
},
});
}
return new Response(null, {
status: 200,
headers: { [EVENTS_HANDLED_HEADER]: '1' },
});
}) as unknown as FetchImpl;
const transport = transportFor(fetchImpl);
await expect(
Promise.all([
transport.send({ ...CALL, beforeSend: async () => current }),
transport.send(CALL),
]),
).resolves.toEqual([
{ status: null, error: 'invocation superseded' },
{ status: 200, handled: true },
]);
expect(urls.map((url) => new URL(url).pathname)).toEqual([
EVENTS_DISPATCH_BATCH_PATH,
EVENTS_DISPATCH_PATH,
]);
});
it('answers a schedule run superseded in the batch as the early check does', async () => {
const { fetchImpl, batches } = streamingFetch();
const client = new EventsWorkerInvokerClient({
events: { invokeTimeoutMs: 5_000 },
} as unknown as IConfig);
client.setTransport(transportFor(fetchImpl, { batchWindowMs: 20 }));
let current = true;
const guard = vi.fn(async () => current);
const run = client.invoke(REQUEST, {
lane: 'schedule',
beforeSend: guard,
});
const other = client.invoke(REQUEST);
const another = client.invoke(REQUEST);
await vi.waitFor(() => expect(guard).toHaveBeenCalledTimes(1));
current = false;
await vi.waitFor(() => expect(batches).toHaveLength(1));
expect(batches[0].body.calls).toHaveLength(2);
await expect(run).resolves.toEqual(
await client.invoke(REQUEST, { beforeSend: async () => false }),
);
await expect(run).resolves.toMatchObject({
outcome: 'unavailable',
error: 'invocation superseded',
});
batches[0].answer({ i: 0, status: 200, handled: true });
batches[0].answer({ i: 1, status: 200, handled: true });
await Promise.all([other, another]);
});
it('builds each body when the batch goes out', async () => {
const { fetchImpl, batches } = streamingFetch();
const transport = transportFor(fetchImpl);
@@ -999,26 +827,6 @@ describe('DispatcherInvokeTransport batches', () => {
});
describe('EventsWorkerInvokerClient invoke options', () => {
it('does not send a superseded invocation', async () => {
const client = makeClient();
const send = vi.fn(async () => ({ status: 200, handled: true }));
client.setTransport({ send });
const result = await client.invoke(REQUEST, { beforeSend: async () => false });
expect(result.outcome).toBe('unavailable');
expect(send).not.toHaveBeenCalled();
});
it('rechecks before resending after a deployment', async () => {
const client = makeClient();
let current = true;
const send = vi.fn(async () => ({ status: null, dispatchReason: 'missing' }));
client.setTransport({ send });
client.setMissHandler(async () => { current = false; return 'deployed'; });
const result = await client.invoke(REQUEST, { beforeSend: async () => current });
expect(result.outcome).toBe('unavailable');
expect(send).toHaveBeenCalledTimes(1);
});
it('stamps the event as each attempt goes out', async () => {
const bodies: string[] = [];
const client = makeClient();
@@ -282,11 +282,6 @@ export interface EventsInvokeCall {
* connection first, so a send time stamped into it is the real one.
*/
render?: () => string;
/**
* Rechecked by a transport that waits before sending; false drops the call
* with {@link supersededAnswer}.
*/
beforeSend?: () => Promise<boolean>;
}
/** What one attempt at delivering an invocation came back with. */
@@ -339,8 +334,6 @@ export interface WorkerInvokeResult {
/** How one invocation is sent. */
export interface WorkerInvokeOptions {
lane?: InvokeLane;
/** Rechecked before each send, including a resend after deployment. */
beforeSend?: () => Promise<boolean>;
/** Applied to the event as each attempt is sent. */
stampEvent?: (event: unknown) => unknown;
}
@@ -348,12 +341,6 @@ export interface WorkerInvokeOptions {
const NO_TRANSPORT =
'no events dispatcher configured (url and internal secret)';
/** What a call whose `beforeSend` said no answers instead of being sent. */
const supersededAnswer = (): EventsInvokeAnswer => ({
status: null,
error: 'invocation superseded',
});
export class EventsWorkerInvokerClient extends PuterClient {
/** Set only where invocations do not leave the process — local development. */
#transport: EventsInvokeTransport | null = null;
@@ -408,13 +395,11 @@ export class EventsWorkerInvokerClient extends PuterClient {
const margin = Math.min(EVENTS_DEADLINE_MARGIN_MS, timeoutMs / 2);
const deadline =
Date.now() + timeoutMs * EVENTS_WORKER_LEASE_FACTOR - margin;
const send = async (
const send = (
deployed: boolean,
sendTimeoutMs = timeoutMs,
): Promise<EventsInvokeAnswer> => {
if (options.beforeSend && !(await options.beforeSend()))
return supersededAnswer();
return transport.send({
): Promise<EventsInvokeAnswer> =>
transport.send({
script: request.script,
appUid: request.appUid,
...(request.holder ? { holder: request.holder } : {}),
@@ -424,11 +409,7 @@ export class EventsWorkerInvokerClient extends PuterClient {
...(deployed ? { deployed: true } : {}),
...(options.lane ? { lane: options.lane } : {}),
...(stampEvent ? { render } : {}),
...(options.beforeSend
? { beforeSend: options.beforeSend }
: {}),
});
};
// A send may wait for a connection for half its timeout before the
// run's own timeout starts, so it is given what is left divided by that.
@@ -553,8 +534,6 @@ export class EventsWorkerInvokerClient extends PuterClient {
interface BatchedCall {
call: EventsInvokeCall;
resolve: (answer: EventsInvokeAnswer) => void;
/** For a `beforeSend` that threw. */
reject: (err: unknown) => void;
/** When its wait for a connection began, for what is left of it. */
waitingSince: number;
}
@@ -625,14 +604,9 @@ export class DispatcherInvokeTransport implements EventsInvokeTransport {
error: 'no free connection to the events dispatcher',
};
try {
if (this.#batchSize === 1) {
// The wait for a connection may have outlived the call.
if (call.beforeSend && !(await call.beforeSend()))
return supersededAnswer();
return await this.#sendOne(call);
}
return await new Promise<EventsInvokeAnswer>((resolve, reject) => {
this.#batch.push({ call, resolve, reject, waitingSince });
if (this.#batchSize === 1) return await this.#sendOne(call);
return await new Promise<EventsInvokeAnswer>((resolve) => {
this.#batch.push({ call, resolve, waitingSince });
if (this.#batch.length >= this.#batchSize) this.#flush();
else
this.#batchTimer ??= setTimeout(
@@ -652,12 +626,6 @@ export class DispatcherInvokeTransport implements EventsInvokeTransport {
const batch = this.#batch;
this.#batch = [];
if (batch.length === 0) return;
if (batch.some(({ call }) => call.beforeSend))
void this.#sendStillCurrent(batch);
else this.#sendGathered(batch);
}
#sendGathered(batch: BatchedCall[]): void {
if (batch.length === 1 || Date.now() < this.#batchUnsupportedUntil) {
for (const { call, resolve } of batch)
void this.#sendOne(call).then(resolve);
@@ -666,26 +634,6 @@ export class DispatcherInvokeTransport implements EventsInvokeTransport {
void this.#sendBatch(batch);
}
/** Drops calls superseded while they were gathered, then sends the rest. */
async #sendStillCurrent(batch: BatchedCall[]): Promise<void> {
const checked = await Promise.all(
batch.map(async (entry) => {
if (!entry.call.beforeSend) return entry;
try {
if (await entry.call.beforeSend()) return entry;
entry.resolve(supersededAnswer());
} catch (err) {
entry.reject(err);
}
return null;
}),
);
const current = checked.filter(
(entry): entry is BatchedCall => entry !== null,
);
if (current.length > 0) this.#sendGathered(current);
}
/** One call on the single route. */
async #sendOne(call: EventsInvokeCall): Promise<EventsInvokeAnswer> {
try {
@@ -740,15 +688,13 @@ export class DispatcherInvokeTransport implements EventsInvokeTransport {
let open = batch.length;
const answered = batch.map(() => false);
const timers: ReturnType<typeof setTimeout>[] = [];
const finish = (i: number, done: (entry: BatchedCall) => void) => {
const settle = (i: number, answer: EventsInvokeAnswer): void => {
if (answered[i]) return;
answered[i] = true;
clearTimeout(timers[i]);
done(batch[i]);
batch[i].resolve(answer);
if (--open === 0) hangUp.abort();
};
const settle = (i: number, answer: EventsInvokeAnswer): void =>
finish(i, (entry) => entry.resolve(answer));
const settleRest = (answer: EventsInvokeAnswer): void => {
for (let i = 0; i < batch.length; i++) settle(i, answer);
};
@@ -831,22 +777,8 @@ export class DispatcherInvokeTransport implements EventsInvokeTransport {
this.#batchUnsupportedUntil =
Date.now() + BATCH_UNSUPPORTED_RETRY_MS;
batch.forEach(({ call }, i) => {
if (answered[i]) return;
const { beforeSend } = call;
if (!beforeSend) {
if (!answered[i])
void this.#sendOne(call).then((a) => settle(i, a));
return;
}
// The batch round trip may have outlived the call.
void (async () => {
try {
if (!(await beforeSend()))
return settle(i, supersededAnswer());
} catch (err) {
return finish(i, (entry) => entry.reject(err));
}
settle(i, await this.#sendOne(call));
})();
});
return;
}
@@ -1416,7 +1416,6 @@ describe('AuthController.handleLogin', () => {
is_user_token: true,
});
expect(body.user.directories).toBeTypeOf('object');
expect(Array.isArray(body.user.taskbar_items)).toBe(true);
});
// A deleted row still answering from cache reaches the session INSERT.
@@ -25,18 +25,13 @@ const ALLOWED_SORT_BY = ['name', 'size', 'modified', 'type'];
const ALLOWED_SORT_ORDER = ['asc', 'desc'];
/**
* Desktop/UI preference routes.
*
* Two categories:
*
* - User-level: desktop background, taskbar items (UserStore)
* - Folder-level: layout, sort_by/sort_order (fsentries table)
* Folder view preference routes: an explorer window's layout and sort order,
* kept on the folder's fsentry.
*/
/**
* Desktop preference writes — background, taskbar, layout, sort order. All four
* persist to the user row on every call, and the GUI fires them on direct user
* action, so a per-minute ceiling well above human speed is enough to catch a
* stuck client.
* Folder preference writes — layout, sort order. The GUI fires them on direct
* user action, so a per-minute ceiling well above human speed is enough to
* catch a stuck client.
*/
const PREFERENCE_WRITE_LIMIT = {
scope: 'desktop-preference',
@@ -47,89 +42,6 @@ const PREFERENCE_WRITE_LIMIT = {
export class DesktopController extends PuterController {
registerRoutes(router) {
// -- Desktop background --------------------------------------
router.post(
'/set-desktop-bg',
{
subdomain: 'api',
requireUserActor: true,
allowFullAccessToken: true,
rateLimit: PREFERENCE_WRITE_LIMIT,
},
async (req, res) => {
const { url, color, fit } = req.body ?? {};
const patch = {};
if (url !== undefined) {
if (url !== null && typeof url !== 'string') {
throw new HttpError(
400,
'`url` must be a string or null',
{ legacyCode: 'bad_request' },
);
}
patch.desktop_bg_url = url;
}
if (color !== undefined) {
if (color !== null && typeof color !== 'string') {
throw new HttpError(
400,
'`color` must be a string or null',
{ legacyCode: 'bad_request' },
);
}
patch.desktop_bg_color = color;
}
if (fit !== undefined) {
if (fit !== null && typeof fit !== 'string') {
throw new HttpError(
400,
'`fit` must be a string or null',
{ legacyCode: 'bad_request' },
);
}
patch.desktop_bg_fit = fit;
}
if (Object.keys(patch).length === 0) {
throw new HttpError(400, 'No fields provided', {
legacyCode: 'bad_request',
});
}
await this.stores.user.update(req.actor.user.id, patch);
res.json({});
},
);
// -- Taskbar items -------------------------------------------
router.post(
'/update-taskbar-items',
{
subdomain: 'api',
requireUserActor: true,
allowFullAccessToken: true,
rateLimit: PREFERENCE_WRITE_LIMIT,
},
async (req, res) => {
const { items } = req.body ?? {};
if (!Array.isArray(items)) {
throw new HttpError(
400,
'Missing or invalid `items` array',
{ legacyCode: 'bad_request' },
);
}
await this.stores.user.update(req.actor.user.id, {
taskbar_items: JSON.stringify(items),
});
res.json({});
},
);
// -- Folder layout -------------------------------------------
router.post(
@@ -130,150 +130,6 @@ const callRoute = async (
});
};
// ── /set-desktop-bg ─────────────────────────────────────────────────
describe('DesktopController POST /set-desktop-bg', () => {
it('persists url/color/fit on the user row', async () => {
const { actor, userId } = await makeUser();
const { res, captured } = makeRes();
await callRoute(
'post',
'/set-desktop-bg',
makeReq({
body: {
url: 'https://cdn.test/wallpaper.png',
color: '#000000',
fit: 'cover',
},
actor,
}),
res,
);
expect(captured.body).toEqual({});
const refreshed = await server.stores.user.getById(userId);
expect(refreshed?.desktop_bg_url).toBe(
'https://cdn.test/wallpaper.png',
);
expect(refreshed?.desktop_bg_color).toBe('#000000');
expect(refreshed?.desktop_bg_fit).toBe('cover');
});
it('persists only the supplied fields (partial update)', async () => {
const { actor, userId } = await makeUser();
const { res } = makeRes();
await callRoute(
'post',
'/set-desktop-bg',
makeReq({ body: { color: '#ffffff' }, actor }),
res,
);
const refreshed = await server.stores.user.getById(userId);
expect(refreshed?.desktop_bg_color).toBe('#ffffff');
// Untouched fields remain at their column default.
expect(refreshed?.desktop_bg_url).toBeFalsy();
expect(refreshed?.desktop_bg_fit).toBeFalsy();
});
it('passes through `null` to clear a field', async () => {
const { actor, userId } = await makeUser();
// First populate, then clear.
const populate = makeRes();
await callRoute(
'post',
'/set-desktop-bg',
makeReq({
body: { url: 'https://cdn.test/x.png' },
actor,
}),
populate.res,
);
const before = await server.stores.user.getById(userId);
expect(before?.desktop_bg_url).toBe('https://cdn.test/x.png');
const clear = makeRes();
await callRoute(
'post',
'/set-desktop-bg',
makeReq({ body: { url: null }, actor }),
clear.res,
);
const after = await server.stores.user.getById(userId);
expect(after?.desktop_bg_url).toBeNull();
});
it('throws 400 when url is not a string or null', async () => {
const { actor } = await makeUser();
const { res } = makeRes();
await expect(
callRoute(
'post',
'/set-desktop-bg',
makeReq({ body: { url: 123 }, actor }),
res,
),
).rejects.toMatchObject({ statusCode: 400 });
});
it('throws 400 when no fields are provided', async () => {
const { actor } = await makeUser();
const { res } = makeRes();
await expect(
callRoute(
'post',
'/set-desktop-bg',
makeReq({ body: {}, actor }),
res,
),
).rejects.toMatchObject({ statusCode: 400 });
});
});
// ── /update-taskbar-items ───────────────────────────────────────────
describe('DesktopController POST /update-taskbar-items', () => {
it('persists items as a JSON-encoded string', async () => {
const { actor, userId } = await makeUser();
const items = [{ name: 'editor' }, { name: 'browser' }];
const { res } = makeRes();
await callRoute(
'post',
'/update-taskbar-items',
makeReq({ body: { items }, actor }),
res,
);
const refreshed = await server.stores.user.getById(userId);
expect(refreshed?.taskbar_items).toBe(JSON.stringify(items));
});
it('throws 400 when items is missing', async () => {
const { actor } = await makeUser();
const { res } = makeRes();
await expect(
callRoute(
'post',
'/update-taskbar-items',
makeReq({ body: {}, actor }),
res,
),
).rejects.toMatchObject({ statusCode: 400 });
});
it('throws 400 when items is not an array', async () => {
const { actor } = await makeUser();
const { res } = makeRes();
await expect(
callRoute(
'post',
'/update-taskbar-items',
makeReq({ body: { items: 'oops' }, actor }),
res,
),
).rejects.toMatchObject({ statusCode: 400 });
});
});
// ── /set_layout ─────────────────────────────────────────────────────
describe('DesktopController POST /set_layout', () => {
@@ -236,17 +236,6 @@ export class EventsController extends PuterController {
});
}
@Post('/schedules/update', {
subdomain: 'api',
requireAuth: true,
allowAccessToken: true,
})
async updateSchedule(req: Request, res: Response): Promise<void> {
const actor = this.#requireActor(req);
const { scheduleId, changes } = bodyRecord(req);
res.json(await this.#schedules().update(actor, scheduleId, changes));
}
/**
* POST /events/schedules/remove — end one schedule. An id the caller does
* not hold reads as absent.
@@ -75,7 +75,6 @@ const fakeSchedules = () =>
total: 3,
})),
get: vi.fn(async () => view),
update: vi.fn(async () => view),
remove: vi.fn(async () => {}),
receivePeerChanges: vi.fn(async () => ({ applied: 2 })),
prepareSendAt: vi.fn(),
@@ -130,10 +129,6 @@ const routes: Array<[string, (response: Response) => Promise<void>]> = [
(r) =>
events.getSchedule(req({ params: { scheduleId: SCHEDULE_ID } }), r),
],
[
'POST /events/schedules/update',
(r) => events.updateSchedule(req({ body: { scheduleId: SCHEDULE_ID, changes: { every: '2h' } } }), r),
],
[
'POST /events/schedules/remove',
(r) =>
@@ -255,16 +250,6 @@ describe('with services.schedules', () => {
expect(sent.body).toEqual(view);
});
it('updates through update and answers its view', async () => {
const schedules = fakeSchedules();
setSchedules(schedules);
const { response, sent } = res();
const changes = { every: '2h' };
await events.updateSchedule(req({ body: { scheduleId: SCHEDULE_ID, changes } }), response);
expect(schedules.update).toHaveBeenCalledWith(actor, SCHEDULE_ID, changes);
expect(sent.body).toEqual(view);
});
it('removes through remove and answers {}', async () => {
const schedules = fakeSchedules();
setSchedules(schedules);
@@ -1,77 +0,0 @@
import type { Request, Response } from 'express';
import { describe, expect, it } from 'vitest';
import { makeActor } from '../../core/actor.js';
import type {
ScheduleServiceContract,
ScheduleView,
} from '../../core/schedules.js';
import { EventsController } from './EventsController.js';
const actor = makeActor({
user: { id: 1, uuid: 'user-1', username: 'user1' } as never,
});
const request = (body: unknown) => ({ actor, body }) as Request;
const controller = (schedules?: Pick<ScheduleServiceContract, 'update'>) =>
new EventsController(
{} as never,
{} as never,
{} as never,
{ schedules } as never,
{} as never,
);
describe('update schedule route contract', () => {
it('answers events_disabled when schedules are unavailable', async () => {
await expect(
controller().updateSchedule(
request({ scheduleId: 'id', changes: {} }),
{} as Response,
),
).rejects.toMatchObject({
legacyCode: 'events_disabled',
statusCode: 503,
noAlarm: true,
});
});
it('passes the actor, id and changes through and returns the updated view', async () => {
const view = {
scheduleId: 'id',
kind: 'recurring',
state: 'suspended',
} as ScheduleView;
const changes = { cron: '0 9 * * *', tz: 'UTC' };
const calls: unknown[][] = [];
const events = controller({
update: async (...args) => {
calls.push(args);
return view;
},
});
let sent: unknown;
await events.updateSchedule(request({ scheduleId: 'id', changes }), {
json: (value: unknown) => {
sent = value;
},
} as Response);
expect(calls).toEqual([[actor, 'id', changes]]);
expect(sent).toBe(view);
});
it('preserves validation and sending errors from the implementation', async () => {
const error = {
code: 'events_schedule_sending',
message: 'Already sending',
};
await expect(
controller({
update: async () => {
throw error;
},
}).updateSchedule(
request({ scheduleId: 'id', changes: {} }),
{} as Response,
),
).rejects.toBe(error);
});
});
@@ -27,7 +27,6 @@ import type { Actor } from '../../core/actor.js';
import { PuterRouter } from '../../core/http/PuterRouter.js';
import { PuterServer } from '../../server.js';
import { setupTestServer } from '../../testUtil.js';
import { embedFrameAncestors, embedHostOrigin } from './HomepageController.js';
// ── Test harness ────────────────────────────────────────────────────
//
@@ -79,11 +78,13 @@ interface CapturedResponse {
statusCode: number;
body: unknown;
contentType?: string;
location?: string;
}
const makeReq = (init: {
params?: Record<string, unknown>;
path?: string;
originalUrl?: string;
actor?: Actor;
hostname?: string;
protocol?: string;
@@ -94,6 +95,7 @@ const makeReq = (init: {
headers: {},
params: init.params ?? {},
path: init.path ?? '/',
originalUrl: init.originalUrl ?? init.path ?? '/',
hostname: init.hostname ?? 'test.local',
protocol: init.protocol ?? 'http',
actor: init.actor,
@@ -131,6 +133,11 @@ const makeRes = () => {
captured.contentType = value;
return res;
}),
redirect: vi.fn((code: number, location: string) => {
captured.statusCode = code;
captured.location = location;
return res;
}),
};
return { res: res as unknown as Response, captured };
};
@@ -214,14 +221,12 @@ describe('HomepageController shell routes', () => {
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
});
it('serves the shell on /settings, /dashboard, /desktop, /action, /@:username', async () => {
it('serves the shell on /settings, /dashboard, /action, /@:username', async () => {
for (const path of [
'/settings',
'/settings/*splat',
'/dashboard',
'/dashboard/',
'/desktop',
'/desktop/',
'/action/*splat',
'/@:username',
]) {
@@ -231,6 +236,18 @@ describe('HomepageController shell routes', () => {
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
}
});
it('serves the shell on a path inside a public folder, /@:username/*splat', async () => {
const { res, captured } = makeRes();
await callRoute(
'get',
'/@:username/*splat',
makeReq({ path: '/@alice/photos/cat.png' }),
res,
);
expect(captured.statusCode).toBe(200);
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
});
});
// ── /app/:name ──────────────────────────────────────────────────────
@@ -360,49 +377,6 @@ describe('HomepageController GET /app/:name', () => {
expect(html).not.toContain('owner_user_id');
});
it('serves the same app shell under /desktop/app/:name', async () => {
const { userId } = await makeUser();
const name = `desk-${Math.random().toString(36).slice(2, 10)}`;
await server.stores.app.create(
{
name,
title: 'Desktop App',
description: 'opens on the desktop instead of the dashboard',
index_url: `https://example.com/${name}/`,
approved_for_listing: 1,
},
{ ownerUserId: userId },
);
const { res, captured } = makeRes();
await callRoute(
'get',
'/desktop/app/:name',
makeReq({ params: { name }, path: `/desktop/app/${name}` }),
res,
);
expect(captured.statusCode).toBe(200);
const html = String(captured.body);
expect(html).toMatch(/<!DOCTYPE html>/i);
expect(html).toContain('Desktop App');
});
it('returns 404 under /desktop/app/:name when the app is unknown', async () => {
const { res, captured } = makeRes();
await callRoute(
'get',
'/desktop/app/:name',
makeReq({
params: { name: 'no-such-app' },
path: '/desktop/app/no-such-app',
}),
res,
);
expect(captured.statusCode).toBe(404);
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
});
it('omits index_url even for a public app — the shell is not the launch authority', async () => {
const { userId } = await makeUser();
const name = `pub-${Math.random().toString(36).slice(2, 10)}`;
@@ -434,8 +408,8 @@ describe('HomepageController GET /app/:name', () => {
// -- app landing rate limit --
describe('HomepageController app landing rate limit', () => {
it('rate-limits /app/:name and /desktop/app/:name per network', () => {
for (const path of ['/app/:name', '/desktop/app/:name']) {
it('rate-limits /app/:name per network', () => {
for (const path of ['/app/:name']) {
const route = router.routes.find(
(r) => r.method === 'get' && r.path === path,
);
@@ -453,7 +427,7 @@ describe('HomepageController app landing rate limit', () => {
// ── /show/* ─────────────────────────────────────────────────────────
describe('HomepageController GET /show/*splat', () => {
it('emits a launch_app explorer call with the post-/show path', async () => {
it('serves the plain shell; the GUI opens the path itself', async () => {
const { res, captured } = makeRes();
await callRoute(
'get',
@@ -461,13 +435,52 @@ describe('HomepageController GET /show/*splat', () => {
makeReq({ path: '/show/alice/Documents' }),
res,
);
// The launch payload is JSON-serialized into the rendered HTML.
// We assert the rendered shell included the explorer launch hint
// pointing at the expected (slashed) path.
const html = String(captured.body);
expect(html).toContain('launch_app');
expect(html).toContain('explorer');
expect(html).toContain('/alice/Documents');
expect(html).toMatch(/<!DOCTYPE html>/i);
// No boot-time launch hook: the one it used to carry named a GUI
// global that no longer exists, which stopped the GUI booting.
expect(html).not.toContain('launch_app');
});
});
// ── /desktop ────────────────────────────────────────────────────────
describe('HomepageController GET /desktop', () => {
it('redirects /desktop to the root, keeping the query', async () => {
for (const path of ['/desktop', '/desktop/']) {
const { res, captured } = makeRes();
await callRoute('get', path, makeReq({ path }), res);
expect(captured.statusCode).toBe(302);
expect(captured.location).toBe('/');
}
const { res, captured } = makeRes();
await callRoute(
'get',
'/desktop',
makeReq({
path: '/desktop',
originalUrl: '/desktop?shared=%2Falice%2Fx%2Fy&download=a',
}),
res,
);
expect(captured.location).toBe('/?shared=%2Falice%2Fx%2Fy&download=a');
});
it('redirects /desktop/app/:name to the app landing', async () => {
const { res, captured } = makeRes();
await callRoute(
'get',
'/desktop/app/:name',
makeReq({
params: { name: 'editor' },
path: '/desktop/app/editor',
originalUrl: '/desktop/app/editor?file=%2Falice%2Fa.txt',
}),
res,
);
expect(captured.statusCode).toBe(302);
expect(captured.location).toBe('/app/editor?file=%2Falice%2Fa.txt');
});
});
@@ -530,46 +543,3 @@ describe('HomepageController GET /sw.js', () => {
expect(route?.options.subdomain).toBe('');
});
});
describe('embedFrameAncestors', () => {
const config = {
origin: 'https://example.test',
domain: 'example.test',
api_base_url: 'https://backend.example.test',
};
it('names a sibling subdomain that embeds the browser', () => {
expect(
embedFrameAncestors(config, 'https://sheets.example.test/doc/1'),
).toBe("'self' https://sheets.example.test");
});
it('refuses the configured API host even off the api label', () => {
expect(
embedFrameAncestors(config, 'https://backend.example.test/x'),
).toBe("'self'");
});
});
describe('embedHostOrigin', () => {
const config = {
origin: 'https://example.test',
domain: 'example.test',
api_base_url: 'https://backend.example.test',
static_hosting_domain: 'site.example.test',
};
it.each([
['https://sheets.example.test/doc/1', 'https://sheets.example.test'],
['https://backend.example.test/x', null],
['https://api.example.test/', null],
['https://someone.site.example.test/', null],
['https://a.sheets.example.test/', null],
['http://sheets.example.test/', null],
['https://example.test/', null],
['not a url', null],
[undefined, null],
])('%s frames as %s', (referer, expected) => {
expect(embedHostOrigin(config, referer)).toBe(expected);
});
});
@@ -22,15 +22,9 @@ import path from 'node:path';
import { PuterController } from '../types.js';
import { toAppShellView } from '../../util/appShellView.js';
import type { PuterRouter } from '../../core/http/PuterRouter';
import {
isReservedSubdomain,
subdomainLabelOf,
} from '../../core/http/middleware/hostRedirects.js';
import type { IConfig } from '../../types';
import type {
PuterHomepageService,
PageMeta,
LaunchOptions,
} from '../../services/homepage/PuterHomepageService';
/** Longest description/og:description/twitter:description on `/app/<name>`. */
@@ -61,64 +55,6 @@ export function appMetaDescription(text: string): string {
return `${cut.replace(/[\s,;:.!?…—-]+$/, '')}…`;
}
type EmbedFramingConfig = Pick<
IConfig,
| 'origin'
| 'domain'
| 'api_base_url'
| 'static_hosting_domain'
| 'static_hosting_domain_alt'
| 'private_app_hosting_domain'
| 'private_app_hosting_domain_alt'
>;
/**
* The origin of a first-party page that may frame an `/embed/*` page, named
* exactly from the request's referrer, or null. A wildcard over `*.<domain>`
* would also admit user-hosted sites whenever the hosting domains sit under it,
* so only a single label under `<domain>` qualifies, and not one this server
* answers itself (the API, WebDAV, SDK and native-app hosts).
*/
export function embedHostOrigin(
config: EmbedFramingConfig,
referer: string | undefined,
): string | null {
const gui = new URL(config.origin ?? `https://${config.domain}`);
let parent: URL;
try {
parent = new URL(referer ?? '');
} catch {
return null;
}
const host = parent.hostname.toLowerCase();
const label = subdomainLabelOf(host, config.domain);
const hostingDomains = [
config.static_hosting_domain,
config.static_hosting_domain_alt,
config.private_app_hosting_domain,
config.private_app_hosting_domain_alt,
]
.map((d) => (d ?? '').toLowerCase().split(':')[0])
.filter(Boolean);
const allowed =
parent.protocol === gui.protocol &&
parent.port === gui.port &&
label !== undefined &&
!isReservedSubdomain(label) &&
host !== new URL(config.api_base_url).hostname &&
!hostingDomains.some((d) => host === d || host.endsWith(`.${d}`));
return allowed ? parent.origin : null;
}
/** `frame-ancestors` for an `/embed/*` page: the GUI and {@link embedHostOrigin}. */
export function embedFrameAncestors(
config: EmbedFramingConfig,
referer: string | undefined,
): string {
const host = embedHostOrigin(config, referer);
return host ? `'self' ${host}` : "'self'";
}
/**
* Routes that render the Puter GUI shell, plus a catch-all static fallback
* under `<gui_assets_root>/src` for non-dist/src paths (images, fonts, lib
@@ -152,7 +88,6 @@ export class HomepageController extends PuterController {
req: express.Request,
res: express.Response,
metaOverrides: Partial<PageMeta> = {},
launch: LaunchOptions = {},
) => {
const meta = { ...defaultMeta(req), ...metaOverrides };
const actor =
@@ -161,78 +96,54 @@ export class HomepageController extends PuterController {
actor?: Parameters<typeof homepage.send>[0]['actor'];
}
).actor ?? null;
await homepage.send({ req, res, actor }, meta, launch);
await homepage.send({ req, res, actor }, meta);
};
// -- Root + path-aliased shell routes ------------------------
router.get('/', {}, (req, res) => sendShell(req, res));
/**
* Headers shared by the `/embed/*` pages; false when the request was
* redirected instead. SDK bootstrap parameters must not change an
* embed's account or API origin, so a query string is dropped. Checked
* on the raw URL; `req.query` drops pairs past the parser's limit.
*/
const prepareEmbed = (
req: express.Request,
res: express.Response,
path: string,
): boolean => {
if (req.originalUrl.includes('?')) {
res.redirect(path);
return false;
}
res.removeHeader('X-Frame-Options');
res.setHeader(
'Content-Security-Policy',
`frame-ancestors ${embedFrameAncestors(this.config, req.get('referer'))}`,
);
res.setHeader('Cache-Control', 'no-store');
return true;
};
router.get('/embed/apps', {}, async (req, res) => {
if (!prepareEmbed(req, res, '/embed/apps')) return;
// Shown to visitors without a session; a signed-in embed fetches
// its own list, so a failure here only costs signed-out visitors.
const guestApps = await this.services.recommendedApps
.getRecommendedApps()
.catch((): Array<Record<string, unknown>> => []);
res.send(homepage.renderAppBrowserEmbed({ guestApps }));
});
router.get('/embed/feedback', {}, (req, res) => {
if (!prepareEmbed(req, res, '/embed/feedback')) return;
// The feedback is recorded against this origin, which
// frame-ancestors has just pinned to the actual framing page.
res.send(
homepage.renderFeedbackEmbed({
hostOrigin: embedHostOrigin(
this.config,
req.get('referer'),
),
}),
);
});
router.get('/settings', {}, (req, res) => sendShell(req, res));
router.get('/settings/*splat', {}, (req, res) => sendShell(req, res));
router.get('/dashboard', {}, (req, res) => sendShell(req, res));
router.get('/dashboard/', {}, (req, res) => sendShell(req, res));
router.get('/desktop', {}, (req, res) => sendShell(req, res));
router.get('/desktop/', {}, (req, res) => sendShell(req, res));
// `/desktop` used to pick the desktop interface. What follows it is
// the same route at the root, so it redirects there, keeping the query
// (`?shared=`, `?download=`); the browser carries the hash over.
const redirectWithoutDesktop = (
req: express.Request,
res: express.Response,
target: string,
) => {
const url = req.originalUrl ?? req.url ?? '';
const query = url.includes('?') ? url.slice(url.indexOf('?')) : '';
res.redirect(302, `${target}${query}`);
};
router.get('/desktop', {}, (req, res) =>
redirectWithoutDesktop(req, res, '/'),
);
router.get('/desktop/', {}, (req, res) =>
redirectWithoutDesktop(req, res, '/'),
);
router.get('/desktop/app/:name', {}, (req, res) =>
redirectWithoutDesktop(
req,
res,
`/app/${encodeURIComponent(String(req.params.name))}`,
),
);
router.get('/action/*splat', {}, (req, res) => sendShell(req, res));
// `/@<user>/<path>` names something in that user's Public folder; the
// GUI opens it.
router.get('/@:username', {}, (req, res) => sendShell(req, res));
router.get('/@:username/*splat', {}, (req, res) => sendShell(req, res));
// -- /app/:name - app metadata baked into the shell ----------
// `/desktop/app/:name` is the same landing booted on the desktop
// instead of the dashboard; the GUI strips the prefix and treats the
// rest of the path identically, so both render the same shell.
const sendAppShell = async (
req: express.Request,
@@ -287,27 +198,10 @@ export class HomepageController extends PuterController {
{ rateLimit: APP_LANDING_LIMIT },
sendAppShell,
);
router.get(
'/desktop/app/:name',
{ rateLimit: APP_LANDING_LIMIT },
sendAppShell,
);
// -- /show/* - launch explorer with the requested file path --
// -- /show/* - the GUI opens the path that follows ----------
router.get('/show/*splat', {}, (req, res) => {
const filePath = req.path.slice('/show'.length);
const launch: LaunchOptions = {
on_initialized: [
{
$: 'window-call',
fn_name: 'launch_app',
args: [{ name: 'explorer', path: filePath }],
},
],
};
return sendShell(req, res, {}, launch);
});
router.get('/show/*splat', {}, (req, res) => sendShell(req, res));
// -- /sw.js - the service worker, scoped to the whole origin --
@@ -244,10 +244,7 @@ describe('OIDCController GET /auth/oidc/providers', () => {
await callRoute('get', '/auth/oidc/providers', makeReq({}), res);
// We configured a single `custom` provider; the live service
// walks the config and returns its id.
expect(captured.body).toEqual({
providers: ['custom'],
signupOidcOnly: false,
});
expect(captured.body).toEqual({ providers: ['custom'] });
});
});
@@ -396,12 +396,9 @@ export class OIDCController extends PuterController {
},
},
async (_req: Request, res: Response) => {
const [providers, policy] = await Promise.all([
this.services.oidc.getEnabledProviderIds(),
this.services.signup.signupPolicy(),
]);
// The signup window drops its email form when this is set.
res.json({ providers, signupOidcOnly: policy.oidcOnly });
const providers =
await this.services.oidc.getEnabledProviderIds();
res.json({ providers });
},
);
@@ -201,7 +201,6 @@ describe('PuterAIController.openaiResponses parameter forwarding', () => {
context_management: [{ type: 'compaction' }],
prompt_cache_key: 'ck',
prompt_cache_retention: '24h',
prompt_cache_options: { ttl: '12h', prewarm: true },
store: true,
truncation: 'auto',
service_tier: 'default',
@@ -227,9 +226,6 @@ describe('PuterAIController.openaiResponses parameter forwarding', () => {
context_management: [{ type: 'compaction' }],
prompt_cache_key: 'ck',
prompt_cache_retention: '24h',
// Forwarded as sent; the provider keeps only the fields it
// accepts.
prompt_cache_options: { ttl: '12h', prewarm: true },
// forced false regardless of the client's request.
store: false,
truncation: 'auto',
@@ -363,18 +359,13 @@ describe('PuterAIController.openaiResponses input normalization', () => {
role: 'user',
content: [
'a bare string part',
{
type: 'input_text',
text: 'typed text',
prompt_cache_breakpoint: { mode: 'explicit', ttl: '12h' },
},
{ type: 'input_text', text: 'typed text' },
{ type: 'output_text', text: 'echoed text' },
{
type: 'input_image',
detail: 'high',
image_url: 'https://img.test/a.png',
file_id: 'file_img',
prompt_cache_breakpoint: { mode: 'explicit' },
},
{ type: 'input_audio', input_audio: { data: 'AAA' } },
{
@@ -395,18 +386,13 @@ describe('PuterAIController.openaiResponses input normalization', () => {
role: 'user',
content: [
{ type: 'text', text: 'a bare string part' },
{
type: 'text',
text: 'typed text',
prompt_cache_breakpoint: { mode: 'explicit', ttl: '12h' },
},
{ type: 'text', text: 'typed text' },
{ type: 'text', text: 'echoed text' },
{
type: 'image_url',
detail: 'high',
image_url: { url: 'https://img.test/a.png' },
file_id: 'file_img',
prompt_cache_breakpoint: { mode: 'explicit' },
},
{ type: 'input_audio', input_audio: { data: 'AAA' } },
{
@@ -653,33 +639,6 @@ describe('PuterAIController.openaiResponses output items', () => {
// -- /openai/v1/chat/completions edges -------------------------------
describe('PuterAIController.openaiChatCompletions translation edges', () => {
it('forwards the prompt-cache fields to the driver', async () => {
const completeSpy = stubChatComplete({
message: { role: 'assistant', content: 'ok' },
});
const { res } = makeRes();
await controller.openaiChatCompletions(
makeReq({
body: {
model: 'gpt-test',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_key: 'ck',
prompt_cache_retention: 'in_memory',
prompt_cache_options: { ttl: '30m' },
},
}),
res,
);
const args = completeSpy.mock.calls[0]![0] as Record<string, unknown>;
expect(args).toMatchObject({
prompt_cache_key: 'ck',
prompt_cache_retention: 'in_memory',
prompt_cache_options: { ttl: '30m' },
});
});
it('derives tool_calls from tool_use content blocks when the message has none', async () => {
stubChatComplete({
message: {
@@ -447,7 +447,6 @@ export class PuterAIController extends PuterController {
body.reasoning_effort as ICompleteArguments['reasoning_effort'],
}
: {}),
...promptCacheArgsFromBody(body),
...openaiCompatProvider(body),
...(body.fallback === false ? { fallback: false } : {}),
};
@@ -843,7 +842,15 @@ export class PuterAIController extends PuterController {
body.compaction as ICompleteArguments['compaction'],
}
: {}),
...promptCacheArgsFromBody(body),
...(body.prompt_cache_key
? { prompt_cache_key: String(body.prompt_cache_key) }
: {}),
...(body.prompt_cache_retention
? {
prompt_cache_retention:
body.prompt_cache_retention as ICompleteArguments['prompt_cache_retention'],
}
: {}),
// forced off regardless of what the caller sent — OpenAI
// defaults `store` to true, which would persist state server-side
// on OpenAI's end that this route gives no way to retrieve.
@@ -1336,33 +1343,6 @@ const openaiCompatProvider = (
return { provider: DEFAULTS.openaiChat };
};
/**
* The prompt-cache fields both OpenAI-shaped routes forward as sent; the
* provider checks the values.
*/
const promptCacheArgsFromBody = (
body: Record<string, unknown>,
): Pick<
ICompleteArguments,
'prompt_cache_key' | 'prompt_cache_retention' | 'prompt_cache_options'
> => ({
...(body.prompt_cache_key
? { prompt_cache_key: String(body.prompt_cache_key) }
: {}),
...(body.prompt_cache_retention
? {
prompt_cache_retention:
body.prompt_cache_retention as ICompleteArguments['prompt_cache_retention'],
}
: {}),
...(body.prompt_cache_options
? {
prompt_cache_options:
body.prompt_cache_options as ICompleteArguments['prompt_cache_options'],
}
: {}),
});
const randomId = (): string => crypto.randomUUID().replace(/-/g, '');
const generateId = (prefix: string): string => `${prefix}_${randomId()}`;
@@ -1610,24 +1590,12 @@ const parseJsonMaybe = (value: unknown): unknown => {
}
};
/** An OpenAI `prompt_cache_breakpoint` marker, kept on the translated part. */
const cacheBreakpointOf = (
p: Record<string, unknown>,
): { prompt_cache_breakpoint?: unknown } =>
p.prompt_cache_breakpoint && typeof p.prompt_cache_breakpoint === 'object'
? { prompt_cache_breakpoint: p.prompt_cache_breakpoint }
: {};
const normalizeContentPart = (part: unknown): Record<string, unknown> => {
if (typeof part === 'string') return { type: 'text', text: part };
if (!part || typeof part !== 'object') return { type: 'text', text: '' };
const p = part as Record<string, unknown>;
if (p.type === 'input_text' || p.type === 'output_text') {
return {
type: 'text',
text: String(p.text ?? ''),
...cacheBreakpointOf(p),
};
return { type: 'text', text: String(p.text ?? '') };
}
if (p.type === 'input_image') {
return {
@@ -1635,7 +1603,6 @@ const normalizeContentPart = (part: unknown): Record<string, unknown> => {
...(p.detail ? { detail: p.detail } : {}),
...(p.image_url ? { image_url: { url: p.image_url } } : {}),
...(p.file_id ? { file_id: p.file_id } : {}),
...cacheBreakpointOf(p),
};
}
if (p.type === 'input_audio')
@@ -1647,7 +1614,6 @@ const normalizeContentPart = (part: unknown): Record<string, unknown> => {
...(p.file_id ? { file_id: p.file_id } : {}),
...(p.file_url ? { file_url: p.file_url } : {}),
...(p.filename ? { filename: p.filename } : {}),
...cacheBreakpointOf(p),
};
}
return p;
@@ -187,9 +187,9 @@ describe('createUserSubdomainNotFound', () => {
});
it('passes through reserved subdomains (api, js, native apps, etc.)', () => {
// `api`, `js`, `dav`, `docs`, `developer`, `about`, `apps`,
// `api`, `js`, `dav`, `docs`, `developer`, `editor`, `pdf`,
// `puter-app-icons`, etc. all pass through.
for (const sub of ['api', 'js', 'docs', 'about', 'puter-app-icons']) {
for (const sub of ['api', 'js', 'docs', 'editor', 'puter-app-icons']) {
const { out, next } = run(
createUserSubdomainNotFound(config),
makeReq({
@@ -865,13 +865,13 @@ describe('createNativeAppStatic', () => {
beforeAll(() => {
root = mkdtempSync(nodePath.join(tmpdir(), 'native-apps-'));
mkdirSync(nodePath.join(root, 'about', 'assets'), { recursive: true });
mkdirSync(nodePath.join(root, 'editor', 'assets'), { recursive: true });
writeFileSync(
nodePath.join(root, 'about', 'index.html'),
'<h1>about</h1>',
nodePath.join(root, 'editor', 'index.html'),
'<h1>editor</h1>',
);
writeFileSync(
nodePath.join(root, 'about', 'assets', 'app.js'),
nodePath.join(root, 'editor', 'assets', 'app.js'),
'console.log(1);',
);
mkdirSync(nodePath.join(root, 'docs', 'dist'), { recursive: true });
@@ -893,7 +893,7 @@ describe('createNativeAppStatic', () => {
it('leaves a native app name alone on a host outside our domains', async () => {
const req = staticReq({
subdomains: ['com', 'example', 'about'],
subdomains: ['com', 'example', 'editor'],
path: '/index.html',
});
(req as Request & { is_custom_domain?: boolean }).is_custom_domain =
@@ -907,7 +907,7 @@ describe('createNativeAppStatic', () => {
const { out, next } = await runStatic(
createNativeAppStatic(config),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/index.html',
}),
);
@@ -915,24 +915,17 @@ describe('createNativeAppStatic', () => {
expect(next).toHaveBeenCalledTimes(1);
});
// `editor`, `markus` and `pdf` are web apps on standard host routing,
// even with a folder of their own under the native apps root.
it.each(['api', 'editor', 'markus', 'pdf'])(
'passes %s through, as it is not a native app',
async (sub) => {
mkdirSync(nodePath.join(root, sub), { recursive: true });
writeFileSync(nodePath.join(root, sub, 'index.html'), sub);
const { out, next } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', sub],
path: '/index.html',
}),
);
expect(out.sent).toBeUndefined();
expect(next).toHaveBeenCalledTimes(1);
},
);
it('passes through subdomains that are not native apps', async () => {
const { out, next } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'api'],
path: '/index.html',
}),
);
expect(out.sent).toBeUndefined();
expect(next).toHaveBeenCalledTimes(1);
});
it('passes through when there is no subdomain at all', async () => {
const { next } = await runStatic(
@@ -946,13 +939,13 @@ describe('createNativeAppStatic', () => {
const { out, next } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/index.html',
}),
);
expect(out.sent).toEqual({
path: '/index.html',
root: nodePath.join(root, 'about'),
root: nodePath.join(root, 'editor'),
});
expect(next).not.toHaveBeenCalled();
});
@@ -961,11 +954,11 @@ describe('createNativeAppStatic', () => {
const { out } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'ABOUT'],
subdomains: ['localhost', 'puter', 'EDITOR'],
path: '/index.html',
}),
);
expect(out.sent?.root).toBe(nodePath.join(root, 'about'));
expect(out.sent?.root).toBe(nodePath.join(root, 'editor'));
});
it('serves docs out of its dist/ subdirectory, not the app root', async () => {
@@ -986,7 +979,7 @@ describe('createNativeAppStatic', () => {
const { out, next } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/assets',
originalUrl: '/assets?v=2',
}),
@@ -1002,7 +995,7 @@ describe('createNativeAppStatic', () => {
const { out } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/assets/',
}),
);
@@ -1014,7 +1007,7 @@ describe('createNativeAppStatic', () => {
const { out, next } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/nope.html',
}),
);
@@ -1026,7 +1019,7 @@ describe('createNativeAppStatic', () => {
const { next } = await runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/index.html',
}),
new Error('send failed'),
@@ -1039,7 +1032,7 @@ describe('createNativeAppStatic', () => {
runStatic(
withRoot(),
staticReq({
subdomains: ['localhost', 'puter', 'about'],
subdomains: ['localhost', 'puter', 'editor'],
path: '/../../etc/passwd',
}),
),
@@ -27,7 +27,15 @@ import { HttpError, isHttpError } from '../HttpError';
import { isLocalWorkerHost } from './localWorkerProxy';
/** Native-app subdomains served via `nativeAppStatic`. */
const NATIVE_APP_SUBDOMAINS = ['about', 'developer', 'docs', 'apps'] as const;
const NATIVE_APP_SUBDOMAINS = [
'about',
'developer',
'docs',
'editor',
'markus',
'pdf',
'apps',
] as const;
/** Subset served out of a `dist/` subdirectory rather than the app root. */
const NATIVE_APPS_WITH_DIST = new Set(['docs', 'developer']);
@@ -103,10 +111,6 @@ export const subdomainLabelOf = (
return label && !label.includes('.') ? label : undefined;
};
/** Whether core itself answers `<name>.<domain>` (`www` redirects to the root). */
export const isReservedSubdomain = (name: string): boolean =>
name === 'www' || RESERVED_SUBDOMAINS.has(name);
/**
* Record a claim on `<name>.<domain>`. Throws on a malformed or uppercase
* label, a subdomain core already handles, or a name that is already claimed.
@@ -119,7 +123,7 @@ export const addClaimedSubdomain = (
if (typeof name !== 'string' || !SUBDOMAIN_LABEL.test(name)) {
throw new Error(`Invalid subdomain label: ${JSON.stringify(name)}`);
}
if (isReservedSubdomain(name)) {
if (name === 'www' || RESERVED_SUBDOMAINS.has(name)) {
throw new Error(`Subdomain '${name}' is reserved`);
}
if (claims.has(name)) {
+1 -9
View File
@@ -170,16 +170,8 @@ export interface ScheduleServiceContract {
request: ScheduleListRequest,
): Promise<PageResult<ScheduleView>>;
get(actor: Actor, scheduleId: unknown): Promise<ScheduleView>;
update(
actor: Actor,
scheduleId: unknown,
changes: unknown,
): Promise<ScheduleView>;
remove(actor: Actor, scheduleId: unknown): Promise<void>;
/** `results`: each change's index outcome, in order (`null` if dropped). */
receivePeerChanges(
body: unknown,
): Promise<{ applied: number; results?: Array<number | null> }>;
receivePeerChanges(body: unknown): Promise<{ applied: number }>;
/** Checks a caller supplying `sendAt`; `events_disabled` when off. */
prepareSendAt(actor: Actor, sendAt: unknown): Promise<DeferredSendPlan>;
createDeferredAppMessage(
@@ -449,22 +449,6 @@ describe('AzureResponsesProvider.complete request shape', () => {
expect(args.service_tier).toBe('default');
});
it('sends the wire spelling of the in-memory cache retention', async () => {
const provider = makeProvider();
responsesCreateMock.mockResolvedValueOnce(okResponse);
await withTestActor(() =>
provider.complete({
model: 'gpt-5.3-codex',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_retention: 'in-memory',
} as never),
);
const [args] = responsesCreateMock.mock.calls[0]!;
expect(args.prompt_cache_retention).toBe('in_memory');
});
it.each([
['previous_response_id', 'resp_1'],
['conversation', 'conv_1'],
@@ -35,7 +35,6 @@ import * as OpenAiUtil from '../../utils/OpenAIUtil.js';
import {
clampReasoningEffort,
openAICompatParams,
promptCacheRetentionToWire,
rejectStatefulResponsesFields,
} from '../../utils/openaiParams.js';
import { buildCostsOverride } from '../../utils/pricing.js';
@@ -210,9 +209,6 @@ export class AzureResponsesProvider implements IChatProvider {
const userIdentifier = upstreamUserIdentifier(actor);
// Cache key defaults to the actor identifier; see upstreamUserIdentifier.
const cacheKey = prompt_cache_key ?? userIdentifier;
const cacheRetention = promptCacheRetentionToWire(
prompt_cache_retention,
);
// Resolve any `puter_path` content parts into inline base64 data URLs
// before the Responses API sees them.
@@ -311,8 +307,8 @@ export class AzureResponsesProvider implements IChatProvider {
...(instructions !== undefined ? { instructions } : {}),
...(metadata !== undefined ? { metadata } : {}),
...(cacheKey !== undefined ? { prompt_cache_key: cacheKey } : {}),
...(cacheRetention !== undefined
? { prompt_cache_retention: cacheRetention }
...(prompt_cache_retention !== undefined
? { prompt_cache_retention }
: {}),
...(store !== undefined ? { store } : {}),
...(max_tokens !== undefined
@@ -23,7 +23,6 @@ import { HttpError } from '../../../../core/http/HttpError.js';
import type { MeteringService } from '../../../../services/metering/MeteringService.js';
import { upstreamUserIdentifier } from '../../../util/upstreamIdentifier.js';
import type { IChatModel, ICompleteArguments } from '../../types.js';
import { promptCacheRetentionToWire } from '../../utils/openaiParams.js';
import { sdkClientOptions } from '../../utils/sdkClient.js';
import {
type ChatProviderConfig,
@@ -108,9 +107,12 @@ export class MetaProvider extends OpenAICompatProvider {
? requestedEffort
: undefined;
const cacheRetention = promptCacheRetentionToWire(
args.prompt_cache_retention,
);
// Puter spells the in-memory retention with a hyphen; Meta's enum
// uses an underscore.
const cacheRetention =
args.prompt_cache_retention === 'in-memory'
? 'in_memory'
: args.prompt_cache_retention;
// The identifier is Puter's abuse attribution, so `custom` can't
// override it. Cache key defaults to it; see upstreamUserIdentifier.
@@ -249,130 +249,6 @@ describe('OpenAiChatProvider.complete argument validation', () => {
expect(result).toEqual({ delegated: true });
});
it('delegates a 12h cache lifetime to the Responses provider, which is the only API that writes it', async () => {
const { provider } = makeProvider();
const sibling = {
complete: vi.fn().mockResolvedValue({ delegated: true }),
};
provider.setResponsesProvider(
sibling as unknown as Parameters<
typeof provider.setResponsesProvider
>[0],
);
const params = {
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_options: { ttl: '12h' as const },
};
const result = await withTestActor(() => provider.complete(params));
expect(createMock).not.toHaveBeenCalled();
expect(sibling.complete).toHaveBeenCalledWith(params);
expect(result).toEqual({ delegated: true });
});
it.each([
['30m', { mode: 'explicit', ttl: '30m' }],
['12h', { mode: 'explicit', ttl: '12h' }],
])(
'delegates a %s breakpoint lifetime to the Responses provider, since Chat Completions rejects the field',
async (_ttl, breakpoint) => {
const { provider } = makeProvider();
const sibling = {
complete: vi.fn().mockResolvedValue({ delegated: true }),
};
provider.setResponsesProvider(
sibling as unknown as Parameters<
typeof provider.setResponsesProvider
>[0],
);
const params = {
model: 'gpt-6-luna',
messages: [
{
role: 'system',
content: [
{
type: 'text',
text: 'long prefix',
prompt_cache_breakpoint: breakpoint,
},
],
},
{ role: 'user', content: 'hi' },
],
};
const result = await withTestActor(() =>
provider.complete(params as never),
);
expect(createMock).not.toHaveBeenCalled();
expect(sibling.complete).toHaveBeenCalledWith(params);
expect(result).toEqual({ delegated: true });
},
);
it('keeps a breakpoint without a lifetime on the Chat Completions path, intact', async () => {
const { provider } = makeProvider();
createMock.mockResolvedValueOnce({
choices: [
{
message: { content: 'ok', role: 'assistant' },
finish_reason: 'stop',
},
],
usage: { prompt_tokens: 1, completion_tokens: 1 },
});
await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [
{
role: 'system',
content: [
{
type: 'text',
text: 'long prefix',
prompt_cache_breakpoint: { mode: 'explicit' },
},
],
},
{ role: 'user', content: 'hi' },
],
} as never),
);
const [args] = createMock.mock.calls[0]!;
expect(args.messages[0]).toMatchObject({
role: 'system',
content: [
{
type: 'text',
text: 'long prefix',
prompt_cache_breakpoint: { mode: 'explicit' },
},
],
});
});
it('throws 400 for a 12h cache lifetime without a Responses sibling provider', async () => {
const { provider } = makeProvider();
await expect(
withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_options: { ttl: '12h' },
}),
),
).rejects.toMatchObject({ statusCode: 400 });
expect(createMock).not.toHaveBeenCalled();
});
it('requestPricing delegates to the Responses sibling (web_search\'s own hold), and no-ops without one', async () => {
const { provider } = makeProvider();
const args = {
@@ -473,31 +349,6 @@ describe('OpenAiChatProvider.complete request shape', () => {
expect(args.safety_identifier).toBe('puter-u42');
});
it('forwards 30m prompt_cache_options and the wire spelling of prompt_cache_retention', async () => {
const { provider } = makeProvider();
createMock.mockResolvedValueOnce(baseCompletion);
await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hello' }],
prompt_cache_retention: 'in-memory',
prompt_cache_options: {
mode: 'explicit',
ttl: '30m',
prewarm: true,
} as never,
}),
);
const [args] = createMock.mock.calls[0]!;
expect(args.prompt_cache_retention).toBe('in_memory');
expect(args.prompt_cache_options).toEqual({
mode: 'explicit',
ttl: '30m',
});
});
it.each([
'gpt-6-astra',
'gpt-6.1-sol',
@@ -814,7 +665,7 @@ describe('OpenAiChatProvider.complete non-stream output', () => {
},
});
const result = await withTestActor(() =>
await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
@@ -834,13 +685,6 @@ describe('OpenAiChatProvider.complete non-stream output', () => {
cached_tokens: 1000 * Number(luna.costs.cached_tokens),
cache_write_tokens: 3000 * Number(luna.costs.cache_write_tokens),
});
// Chat Completions only writes OpenAI's default 30m entries.
expect((result as { usageDetails: unknown }).usageDetails).toEqual({
inputTokens: 1000,
outputTokens: 12,
cacheReadTokens: 1000,
cacheWrite30mTokens: 3000,
});
});
it('zeroes cached_tokens when prompt_tokens_details is missing', async () => {
@@ -35,10 +35,7 @@ import { make_openai_tools } from '../../utils/FunctionCalling.js';
import * as OpenAiUtil from '../../utils/OpenAIUtil.js';
import {
clampReasoningEffort,
messagesHaveCacheBreakpointTtl,
openAICompatParams,
promptCacheOptionsToWire,
promptCacheRetentionToWire,
} from '../../utils/openaiParams.js';
import { OPEN_AI_MODELS } from './models.js';
import type { OpenAiResponsesChatProvider } from './OpenAiChatResponsesProvider.js';
@@ -129,11 +126,8 @@ export class OpenAiChatProvider implements IChatProvider {
temperature,
text,
prompt_cache_key,
prompt_cache_retention,
prompt_cache_options,
} = params;
let { messages, model } = params;
const cacheOptions = promptCacheOptionsToWire(prompt_cache_options);
if (
tools?.filter((e) => isWebSearchTool(e as Record<string, unknown>))
.length
@@ -163,21 +157,6 @@ export class OpenAiChatProvider implements IChatProvider {
}
return await this.#responsesProvider.complete(params);
}
// Only the Responses API writes 12h cache entries or takes a lifetime
// on a `prompt_cache_breakpoint`; Chat Completions rejects both.
if (
cacheOptions?.ttl === '12h' ||
messagesHaveCacheBreakpointTtl(messages)
) {
if (!this.#responsesProvider) {
throw new HttpError(
400,
'a prompt cache lifetime requires the OpenAI Responses provider, which is not configured',
{ legacyCode: 'bad_request' },
);
}
return await this.#responsesProvider.complete(params);
}
// Validate messages
if (!Array.isArray(messages)) {
throw new HttpError(400, '`messages` must be an array', {
@@ -201,9 +180,6 @@ export class OpenAiChatProvider implements IChatProvider {
const userIdentifier = upstreamUserIdentifier(actor);
// Cache key defaults to the actor identifier; see upstreamUserIdentifier.
const cacheKey = prompt_cache_key ?? userIdentifier;
const cacheRetention = promptCacheRetentionToWire(
prompt_cache_retention,
);
// Strip Anthropic-only shape a fallback-replayed message can carry
// (thinking/server-tool blocks, cache_control, citations) before the
@@ -240,12 +216,6 @@ export class OpenAiChatProvider implements IChatProvider {
user: userIdentifier,
safety_identifier: userIdentifier,
...(cacheKey !== undefined ? { prompt_cache_key: cacheKey } : {}),
...(cacheRetention !== undefined
? { prompt_cache_retention: cacheRetention }
: {}),
...(cacheOptions !== undefined
? { prompt_cache_options: cacheOptions }
: {}),
messages: messages,
model: modelUsed.id,
...(mappedTools?.length ? { tools: mappedTools } : {}),
@@ -284,11 +254,28 @@ export class OpenAiChatProvider implements IChatProvider {
);
return OpenAiUtil.handle_completion_output({
usage_calculator: ({ usage, setUsageCosts, setUsageDetails }) => {
// GPT-5.6 and later report cache writes inside
// `prompt_tokens`, like cached reads; Chat Completions only
// writes the default 30m entries, billed at 1.25x input.
const trackedUsage = OpenAiUtil.splitCachedPrompt(usage);
usage_calculator: ({ usage, setUsageCosts }) => {
const cachedTokens =
usage.prompt_tokens_details?.cached_tokens ?? 0;
// GPT-5.6 and later bill cache writes at 1.25x input. They're
// reported inside `prompt_tokens`, like cached reads.
// The SDK doesn't type `cache_write_tokens` yet.
const cacheWriteTokens =
(
usage.prompt_tokens_details as
{ cache_write_tokens?: number } | undefined
)?.cache_write_tokens ?? 0;
const trackedUsage = {
prompt_tokens:
(usage.prompt_tokens ?? 0) -
cachedTokens -
cacheWriteTokens,
completion_tokens: usage.completion_tokens ?? 0,
cached_tokens: cachedTokens,
...(cacheWriteTokens
? { cache_write_tokens: cacheWriteTokens }
: {}),
};
const metered = meterChatUsage(
this.#meteringService,
@@ -298,11 +285,6 @@ export class OpenAiChatProvider implements IChatProvider {
trackedUsage,
);
setUsageCosts(metered.costs);
setUsageDetails(
OpenAiUtil.usageDetailsFromTrackedUsage(metered.usage, {
writeTtl: '30m',
})!,
);
return metered.usage;
},
stream,
@@ -246,7 +246,6 @@ describe('OpenAiResponsesChatProvider model catalog', () => {
prompt_tokens: input,
cached_tokens: cached,
cache_write_tokens: input * 1.25,
cache_write_12h_tokens: input * 2.5,
completion_tokens: output,
},
context: 1_050_000,
@@ -845,7 +844,7 @@ describe('OpenAiResponsesChatProvider.complete non-stream output', () => {
},
});
const result = await withTestActor(() =>
await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
@@ -868,115 +867,6 @@ describe('OpenAiResponsesChatProvider.complete non-stream output', () => {
cached_tokens: 1000 * Number(luna.costs.cached_tokens),
cache_write_tokens: 3000 * Number(luna.costs.cache_write_tokens),
});
// Writes without a per-lifetime breakdown are OpenAI's default 30m
// entries, and the neutral breakdown says so.
expect((result as { usageDetails: unknown }).usageDetails).toEqual({
inputTokens: 1000,
outputTokens: 20,
cacheReadTokens: 1000,
cacheWrite30mTokens: 3000,
});
});
it('bills 12h cache writes at 2.5x input and the other writes at 1.25x', async () => {
const luna = OPEN_AI_MODELS.find((m) => m.id === 'gpt-6-luna')!;
const { provider } = makeProvider();
// One request can write both lifetimes: an explicit 12h breakpoint
// plus the implicit 30m one OpenAI adds at the end of the prompt.
responsesCreateMock.mockResolvedValueOnce({
output: [{ role: 'assistant' }],
output_text: 'ok',
usage: {
input_tokens: 6026,
output_tokens: 5,
input_tokens_details: {
cached_tokens: 0,
cache_write_tokens: 6023,
cache_write_tokens_details: {
ttl_12h_tokens: 6012,
ttl_30m_tokens: 11,
},
},
},
});
const result = await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_options: { ttl: '12h' },
}),
);
const [usage, , , overrides] = recordSpy.mock.calls[0]!;
expect(usage).toEqual({
prompt_tokens: 3,
completion_tokens: 5,
cached_tokens: 0,
cache_write_tokens: 11,
cache_write_12h_tokens: 6012,
});
expect(luna.costs.cache_write_12h_tokens).toBe(
Number(luna.costs.prompt_tokens) * 2.5,
);
expect(overrides).toEqual({
prompt_tokens: 3 * Number(luna.costs.prompt_tokens),
completion_tokens: 5 * Number(luna.costs.completion_tokens),
cached_tokens: 0,
cache_write_tokens: 11 * Number(luna.costs.cache_write_tokens),
cache_write_12h_tokens:
6012 * Number(luna.costs.cache_write_12h_tokens),
});
expect((result as { usageDetails: unknown }).usageDetails).toEqual({
inputTokens: 3,
outputTokens: 5,
cacheWrite30mTokens: 11,
cacheWrite12hTokens: 6012,
});
});
it('forwards prompt_cache_options and the wire spelling of prompt_cache_retention', async () => {
const { provider } = makeProvider();
responsesCreateMock.mockResolvedValueOnce({
output: [{ role: 'assistant' }],
output_text: 'ok',
usage: { input_tokens: 1, output_tokens: 1 },
});
await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_retention: 'in-memory',
prompt_cache_options: {
mode: 'explicit',
ttl: '12h',
comparison_response_id: 'resp_1',
} as never,
}),
);
const [args] = responsesCreateMock.mock.calls[0]!;
expect(args.prompt_cache_retention).toBe('in_memory');
expect(args.prompt_cache_options).toEqual({
mode: 'explicit',
ttl: '12h',
});
});
it('rejects a cache lifetime OpenAI does not offer before calling upstream', async () => {
const { provider } = makeProvider();
await expect(
withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'hi' }],
prompt_cache_options: { ttl: '2h' } as never,
}),
),
).rejects.toMatchObject({ statusCode: 400 });
expect(responsesCreateMock).not.toHaveBeenCalled();
});
it.each([
@@ -1178,69 +1068,6 @@ describe('OpenAiResponsesChatProvider.complete streaming', () => {
});
});
it('labels streamed cache writes by lifetime on the final usage chunk', async () => {
const luna = OPEN_AI_MODELS.find((m) => m.id === 'gpt-6-luna')!;
const { provider } = makeProvider();
responsesCreateMock.mockReturnValueOnce(
asAsyncIterable([
{ type: 'response.output_text.delta', delta: 'ok' },
{
type: 'response.completed',
response: {
usage: {
input_tokens: 6026,
output_tokens: 5,
input_tokens_details: {
cached_tokens: 0,
cache_write_tokens: 6023,
cache_write_tokens_details: {
ttl_12h_tokens: 6012,
ttl_30m_tokens: 11,
},
},
},
},
},
]),
);
const result = await withTestActor(() =>
provider.complete({
model: 'gpt-6-luna',
messages: [{ role: 'user', content: 'say ok' }],
stream: true,
prompt_cache_options: { ttl: '12h' },
}),
);
const harness = makeCapturingChatStream();
await (
result as {
init_chat_stream: (p: { chatStream: unknown }) => Promise<void>;
}
).init_chat_stream({ chatStream: harness.chatStream });
const usageEvent = harness.events().find((e) => e.type === 'usage');
expect(usageEvent?.usage).toEqual({
prompt_tokens: 3,
completion_tokens: 5,
cached_tokens: 0,
cache_write_tokens: 11,
cache_write_12h_tokens: 6012,
});
expect(usageEvent?.usageDetails).toEqual({
inputTokens: 3,
outputTokens: 5,
cacheWrite30mTokens: 11,
cacheWrite12hTokens: 6012,
});
const [, , , overrides] = recordSpy.mock.calls[0]!;
expect(overrides).toMatchObject({
cache_write_tokens: 11 * Number(luna.costs.cache_write_tokens),
cache_write_12h_tokens:
6012 * Number(luna.costs.cache_write_12h_tokens),
});
});
it('emits a tool_use block when response.output_item.done arrives with a function_call', async () => {
const { provider } = makeProvider();
responsesCreateMock.mockReturnValueOnce(
@@ -32,8 +32,6 @@ import * as OpenAiUtil from '../../utils/OpenAIUtil.js';
import {
clampReasoningEffort,
openAICompatParams,
promptCacheOptionsToWire,
promptCacheRetentionToWire,
rejectStatefulResponsesFields,
} from '../../utils/openaiParams.js';
import { responseSamplingParams } from '../../utils/responseSampling.js';
@@ -152,7 +150,6 @@ export class OpenAiResponsesChatProvider implements IChatProvider {
prompt,
prompt_cache_key,
prompt_cache_retention,
prompt_cache_options,
store,
top_p,
truncation,
@@ -198,10 +195,6 @@ export class OpenAiResponsesChatProvider implements IChatProvider {
const userIdentifier = upstreamUserIdentifier(actor);
// Cache key defaults to the actor identifier; see upstreamUserIdentifier.
const cacheKey = prompt_cache_key ?? userIdentifier;
const cacheRetention = promptCacheRetentionToWire(
prompt_cache_retention,
);
const cacheOptions = promptCacheOptionsToWire(prompt_cache_options);
if (tools) {
// Unravel tools to OpenAI Responses API format
@@ -295,11 +288,8 @@ export class OpenAiResponsesChatProvider implements IChatProvider {
...(instructions !== undefined ? { instructions } : {}),
...(metadata !== undefined ? { metadata } : {}),
...(cacheKey !== undefined ? { prompt_cache_key: cacheKey } : {}),
...(cacheRetention !== undefined
? { prompt_cache_retention: cacheRetention }
: {}),
...(cacheOptions !== undefined
? { prompt_cache_options: cacheOptions }
...(prompt_cache_retention !== undefined
? { prompt_cache_retention }
: {}),
...(store !== undefined ? { store } : {}),
...(max_tokens !== undefined
@@ -320,17 +310,24 @@ export class OpenAiResponsesChatProvider implements IChatProvider {
{ signal: Context.get('upstreamSignal') },
);
return OpenAiUtil.handle_completion_output_responses_api({
usage_calculator: ({
usage,
webSearchCalls,
setUsageCosts,
setUsageDetails,
}) => {
// GPT-5.6 and later report cache writes inside `input_tokens`,
// like cached reads, split by lifetime (30m and 12h entries
// cost 1.25x and 2.5x input to write).
usage_calculator: ({ usage, webSearchCalls, setUsageCosts }) => {
const cachedTokens =
(usage as any).input_tokens_details?.cached_tokens ?? 0;
// GPT-5.6 and later bill cache writes at 1.25x input. They're
// reported inside `input_tokens`, like cached reads.
const cacheWriteTokens =
(usage as any).input_tokens_details?.cache_write_tokens ??
0;
const trackedUsage: Record<string, number> = {
...OpenAiUtil.splitCachedPrompt(usage),
prompt_tokens:
((usage as any).input_tokens ?? 0) -
cachedTokens -
cacheWriteTokens,
completion_tokens: (usage as any).output_tokens ?? 0,
cached_tokens: cachedTokens,
...(cacheWriteTokens
? { cache_write_tokens: cacheWriteTokens }
: {}),
...(webSearchCalls
? { web_search_calls: webSearchCalls }
: {}),
@@ -359,11 +356,6 @@ export class OpenAiResponsesChatProvider implements IChatProvider {
: {},
);
setUsageCosts?.(metered.costs);
setUsageDetails?.(
OpenAiUtil.usageDetailsFromTrackedUsage(metered.usage, {
writeTtl: '30m',
})!,
);
return metered.usage;
},
stream,
@@ -23,8 +23,6 @@ import type { IChatModel } from '../../types.js';
// Prompts over 272K input tokens are billed at 2x input (cached reads and
// cache writes included) and 1.5x output for the full request.
// GPT-5.6 and later bill cache writes by the lifetime requested: 1.25x input
// for the default 30m entries, 2.5x for 12h entries.
const GPT_LONG_CONTEXT_PRICING = {
threshold: 272_000,
input_multiplier: 2,
@@ -51,7 +49,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 100,
cached_tokens: 5,
cache_write_tokens: 100 * 1.25,
cache_write_12h_tokens: 100 * 2.5,
completion_tokens: 500,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -77,7 +74,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 200,
cached_tokens: 10,
cache_write_tokens: 200 * 1.25,
cache_write_12h_tokens: 200 * 2.5,
completion_tokens: 1000,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -103,7 +99,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 200,
cached_tokens: 20,
cache_write_tokens: 200 * 1.25,
cache_write_12h_tokens: 200 * 2.5,
completion_tokens: 1000,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -129,7 +124,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 10,
cached_tokens: 1,
cache_write_tokens: 10 * 1.25,
cache_write_12h_tokens: 10 * 2.5,
completion_tokens: 50,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -155,7 +149,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 1000,
cached_tokens: 100,
cache_write_tokens: 1000 * 1.25,
cache_write_12h_tokens: 1000 * 2.5,
completion_tokens: 5000,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -181,7 +174,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 400,
cached_tokens: 40,
cache_write_tokens: 400 * 1.25,
cache_write_12h_tokens: 400 * 2.5,
completion_tokens: 2000,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -206,7 +198,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 200,
cached_tokens: 20,
cache_write_tokens: 200 * 1.25,
cache_write_12h_tokens: 200 * 2.5,
completion_tokens: 1200,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
@@ -231,7 +222,6 @@ export const OPEN_AI_MODELS: IChatModel[] = [
prompt_tokens: 20,
cached_tokens: 2,
cache_write_tokens: 20 * 1.25,
cache_write_12h_tokens: 20 * 2.5,
completion_tokens: 120,
},
long_context_pricing: GPT_LONG_CONTEXT_PRICING,
+2 -22
View File
@@ -145,19 +145,13 @@ export type StopReason =
| 'model_context_window_exceeded'
| (string & {});
/**
* Provider-neutral usage breakdown. `inputTokens` excludes cache reads/writes.
* Cache writes are keyed by the lifetime the entry was written with: Claude and
* Moonshot write 5m and 1h entries, OpenAI writes 30m and 12h entries.
*/
/** Provider-neutral usage breakdown. `inputTokens` excludes cache reads/writes. */
export interface UsageDetails {
inputTokens: number;
outputTokens: number; // includes reasoning
cacheReadTokens?: number;
cacheWrite5mTokens?: number;
cacheWrite30mTokens?: number;
cacheWrite1hTokens?: number;
cacheWrite12hTokens?: number;
reasoningTokens?: number;
webSearchRequests?: number;
webFetchRequests?: number;
@@ -174,22 +168,10 @@ export interface UsageDetails {
outputTokens: number;
cacheReadTokens?: number;
cacheWrite5mTokens?: number;
cacheWrite30mTokens?: number;
cacheWrite1hTokens?: number;
cacheWrite12hTokens?: number;
}>;
}
/**
* OpenAI `prompt_cache_options`, GPT-5.6 and later. `ttl` is the minimum
* lifetime of every cache entry the request writes; `12h` entries cost twice
* what `30m` entries do to write and only the Responses API writes them.
*/
export interface PromptCacheOptions {
mode?: 'implicit' | 'explicit';
ttl?: '30m' | '12h';
}
export interface ICompleteArguments {
messages: PuterMessage[];
provider?: string;
@@ -252,9 +234,7 @@ export interface ICompleteArguments {
metadata?: Record<string, string>;
prompt?: unknown;
prompt_cache_key?: string;
/** `in-memory` is accepted as a spelling of OpenAI's `in_memory`. */
prompt_cache_retention?: 'in-memory' | 'in_memory' | '24h' | undefined;
prompt_cache_options?: PromptCacheOptions;
prompt_cache_retention?: 'in-memory' | '24h' | undefined;
store?: boolean;
top_p?: number;
truncation?: 'auto' | 'disabled' | undefined;
+20 -78
View File
@@ -481,86 +481,43 @@ export const extractMeteredUsage = (usage) => {
};
/**
* @typedef {{
* cached_tokens?: number | null;
* cache_write_tokens?: number | null;
* cache_write_tokens_details?: {
* ttl_30m_tokens?: number | null;
* ttl_12h_tokens?: number | null;
* } | null;
* }} OpenAiCacheDetails
*/
/**
* OpenAI-shaped usage as it's metered. The prompt count reports cached reads
* and cache writes inside it, so they come out of it and are priced once each
* under their own keys: `cached_tokens` for reads, `cache_write_tokens` for
* writes at the model's default lifetime and `cache_write_12h_tokens` for
* writes at OpenAI's 12h lifetime. Without the per-lifetime breakdown every
* write is a default-lifetime write: Chat Completions writes no 12h entries,
* and Responses reports the breakdown whenever a request asked for them. Reads
* the Chat Completions (`prompt_tokens`) and Responses (`input_tokens`)
* spellings alike.
* Chat Completions usage as it's metered: `prompt_tokens` reports cached reads
* inside its count, so they come out of it and are priced only once, under
* `cached_tokens`.
*
* @param {{
* prompt_tokens?: number;
* completion_tokens?: number;
* prompt_tokens_details?: OpenAiCacheDetails | null;
* input_tokens?: number;
* output_tokens?: number;
* input_tokens_details?: OpenAiCacheDetails | null;
* }
* | undefined} usage
* @param {import('openai/resources/completions.mjs').CompletionUsage | undefined} usage
*/
export const splitCachedPrompt = (usage) => {
const details = usage?.prompt_tokens_details ?? usage?.input_tokens_details;
const details = usage?.prompt_tokens_details;
const cachedTokens = details?.cached_tokens ?? 0;
// Moonshot and GPT-5.6+ count the prompt tokens they wrote to the prefix
// cache here; they're billed at the model's write rate, not the prompt rate.
// Moonshot counts the prompt tokens it wrote to its prefix cache here;
// they're billed at the model's write rate, not the plain prompt rate.
const writeTokens =
typeof details?.cache_write_tokens === 'number'
? details.cache_write_tokens
: undefined;
const reported12h = details?.cache_write_tokens_details?.ttl_12h_tokens;
const write12hTokens =
typeof reported12h === 'number'
? Math.min(reported12h, writeTokens ?? 0)
: undefined;
return {
prompt_tokens:
(usage?.prompt_tokens ?? usage?.input_tokens ?? 0) -
cachedTokens -
(writeTokens ?? 0),
completion_tokens:
usage?.completion_tokens ?? usage?.output_tokens ?? 0,
(usage?.prompt_tokens ?? 0) - cachedTokens - (writeTokens ?? 0),
completion_tokens: usage?.completion_tokens ?? 0,
cached_tokens: cachedTokens,
...(writeTokens !== undefined
? { cache_write_tokens: writeTokens - (write12hTokens ?? 0) }
: {}),
...(write12hTokens !== undefined
? { cache_write_12h_tokens: write12hTokens }
? { cache_write_tokens: writeTokens }
: {}),
};
};
/**
* The `{prompt_tokens, completion_tokens, cached_tokens, cache_write_tokens,
* cache_write_12h_tokens}` shape every OpenAI-family `usage_calculator` already
* returns for billing, mapped to the provider-neutral `UsageDetails` the
* end-of-stream/non-stream result carries. `inputTokens`/`outputTokens` are the
* same numbers already billed — this never introduces a new figure, only
* exposes the breakdown.
* The `{prompt_tokens, completion_tokens, cached_tokens, cache_write_tokens}`
* shape every OpenAI-family `usage_calculator` already returns for billing,
* mapped to the provider-neutral `UsageDetails` the end-of-stream/non-stream
* result carries. `inputTokens`/`outputTokens` are the same numbers already
* billed — this never introduces a new figure, only exposes the breakdown.
*
* @param {Record<string, number> | undefined | null} trackedUsage
* @param {{ writeTtl?: '5m' | '30m' }} [opts] The lifetime `cache_write_tokens`
* were written with: 5m unless the provider says otherwise (OpenAI's default
* entries live 30m).
* @returns {import('../types.js').UsageDetails | undefined}
*/
export const usageDetailsFromTrackedUsage = (
trackedUsage,
{ writeTtl = '5m' } = {},
) => {
export const usageDetailsFromTrackedUsage = (trackedUsage) => {
if (!trackedUsage || typeof trackedUsage !== 'object') return undefined;
// OpenRouter, Infron and Ollama track `{prompt, completion,
// input_cache_read}` instead; any other shape is left to the driver.
@@ -569,19 +526,12 @@ export const usageDetailsFromTrackedUsage = (
if (input === undefined && output === undefined) return undefined;
const cacheRead =
trackedUsage.cached_tokens ?? trackedUsage.input_cache_read;
const cacheWrite = trackedUsage.cache_write_tokens;
return {
inputTokens: input ?? 0,
outputTokens: output ?? 0,
...(cacheRead ? { cacheReadTokens: cacheRead } : {}),
...(cacheWrite && writeTtl === '30m'
? { cacheWrite30mTokens: cacheWrite }
: {}),
...(cacheWrite && writeTtl !== '30m'
? { cacheWrite5mTokens: cacheWrite }
: {}),
...(trackedUsage.cache_write_12h_tokens
? { cacheWrite12hTokens: trackedUsage.cache_write_12h_tokens }
...(trackedUsage.cache_write_tokens
? { cacheWrite5mTokens: trackedUsage.cache_write_tokens }
: {}),
};
};
@@ -914,16 +864,12 @@ export const create_chat_stream_handler_responses_api =
// Missing usage is left undefined rather than fed to the calculator —
// see the sibling handler above, including why usage is reported
// before the block flushes.
let usageDetails;
const usage = last_usage
? usage_calculator({
usage: last_usage,
webSearchCalls,
tool_usage: toolUsage,
setUsageCosts: (c) => chatStream.setUsageCosts(c),
setUsageDetails: (d) => {
usageDetails = d;
},
})
: undefined;
chatStream.reportUsage(usage);
@@ -931,7 +877,7 @@ export const create_chat_stream_handler_responses_api =
reason:
incompleteReason ?? (sawFunctionCall ? 'tool_use' : 'end_turn'),
});
usageDetails ??= usageDetailsFromTrackedUsage(usage);
const usageDetails = usageDetailsFromTrackedUsage(usage);
if (usageDetails) chatStream.setUsageDetails(usageDetails);
textblock.end();
@@ -1069,7 +1015,6 @@ export const handle_completion_output = async (
* webSearchCalls?: number;
* tool_usage?: Record<string, unknown>;
* setUsageCosts?: (costs: Record<string, number>) => void;
* setUsageDetails?: (details: import('../types').UsageDetails) => void;
* }) => unknown} params.usage_calculator
* @param {() => Promise<void>} [params.finally_fn]
* @returns {ReturnType<import('../types').IChatProvider['complete']>}
@@ -1211,15 +1156,12 @@ export const handle_completion_output_responses_api = async ({
setUsageCosts: (c) => {
ret.usageCosts = c;
},
setUsageDetails: (d) => {
ret.usageDetails = d;
},
})
: {
input_tokens: completion.usage.input_tokens,
output_tokens: completion.usage.output_tokens,
};
if (usage_calculator && ret.usageDetails === undefined) {
if (usage_calculator) {
const usageDetails = usageDetailsFromTrackedUsage(ret.usage);
if (usageDetails) ret.usageDetails = usageDetails;
}
@@ -247,40 +247,6 @@ describe('usageDetailsFromTrackedUsage', () => {
});
});
it('labels cache writes by the lifetime the provider says it wrote them with', () => {
expect(
usageDetailsFromTrackedUsage(
{
prompt_tokens: 10,
completion_tokens: 5,
cached_tokens: 3,
cache_write_tokens: 11,
cache_write_12h_tokens: 6012,
},
{ writeTtl: '30m' },
),
).toEqual({
inputTokens: 10,
outputTokens: 5,
cacheReadTokens: 3,
cacheWrite30mTokens: 11,
cacheWrite12hTokens: 6012,
});
// Zero counts, as OpenAI reports on a cache hit, add no field.
expect(
usageDetailsFromTrackedUsage(
{
prompt_tokens: 10,
completion_tokens: 5,
cached_tokens: 3,
cache_write_tokens: 0,
cache_write_12h_tokens: 0,
},
{ writeTtl: '30m' },
),
).toEqual({ inputTokens: 10, outputTokens: 5, cacheReadTokens: 3 });
});
it('returns undefined for a missing/non-object usage', () => {
expect(usageDetailsFromTrackedUsage(undefined)).toBeUndefined();
expect(usageDetailsFromTrackedUsage(null)).toBeUndefined();
@@ -996,66 +962,6 @@ describe('splitCachedPrompt', () => {
cached_tokens: 3,
});
});
it('reads the Responses usage spelling', () => {
expect(
splitCachedPrompt({
input_tokens: 6026,
output_tokens: 5,
input_tokens_details: { cached_tokens: 0, cache_write_tokens: 6023 },
}),
).toEqual({
prompt_tokens: 3,
completion_tokens: 5,
cached_tokens: 0,
cache_write_tokens: 6023,
});
});
it('splits 12h writes out of the write count when the breakdown is reported', () => {
// One request can write both lifetimes: an explicit 12h breakpoint
// plus the implicit 30m one OpenAI adds at the end of the prompt.
expect(
splitCachedPrompt({
input_tokens: 6026,
output_tokens: 5,
input_tokens_details: {
cached_tokens: 0,
cache_write_tokens: 6023,
cache_write_tokens_details: {
ttl_12h_tokens: 6012,
ttl_30m_tokens: 11,
},
},
}),
).toEqual({
prompt_tokens: 3,
completion_tokens: 5,
cached_tokens: 0,
cache_write_tokens: 11,
cache_write_12h_tokens: 6012,
});
});
it('never reports more 12h writes than writes in total', () => {
expect(
splitCachedPrompt({
input_tokens: 100,
output_tokens: 1,
input_tokens_details: {
cached_tokens: 0,
cache_write_tokens: 40,
cache_write_tokens_details: { ttl_12h_tokens: 50 },
},
}),
).toEqual({
prompt_tokens: 60,
completion_tokens: 1,
cached_tokens: 0,
cache_write_tokens: 0,
cache_write_12h_tokens: 40,
});
});
});
// ── recorded usage costs ────────────────────────────────────────────
@@ -22,14 +22,11 @@ import { describe, expect, it } from 'vitest';
import type { ICompleteArguments } from '../types.js';
import {
clampReasoningEffort,
messagesHaveCacheBreakpointTtl,
openAICompatParams,
outputFormatFromResponseFormat,
outputFormatFromResponsesText,
outputFormatToResponseFormat,
outputFormatToResponsesText,
promptCacheOptionsToWire,
promptCacheRetentionToWire,
rejectStatefulResponsesFields,
toolChoiceFromWire,
toolChoiceToWire,
@@ -337,109 +334,3 @@ describe('rejectStatefulResponsesFields', () => {
).toThrow(/previous_response_id/);
});
});
describe('promptCacheRetentionToWire', () => {
it('spells the in-memory retention the way the upstreams expect', () => {
expect(promptCacheRetentionToWire('in-memory')).toBe('in_memory');
expect(promptCacheRetentionToWire('in_memory')).toBe('in_memory');
expect(promptCacheRetentionToWire('24h')).toBe('24h');
expect(promptCacheRetentionToWire(undefined)).toBeUndefined();
});
});
describe('promptCacheOptionsToWire', () => {
it('forwards mode and ttl and nothing else', () => {
expect(
promptCacheOptionsToWire({
mode: 'explicit',
ttl: '12h',
prewarm: true,
comparison_response_id: 'resp_1',
}),
).toEqual({ mode: 'explicit', ttl: '12h' });
expect(promptCacheOptionsToWire({ ttl: '30m' })).toEqual({
ttl: '30m',
});
});
it('sends nothing for an absent or empty object', () => {
expect(promptCacheOptionsToWire(undefined)).toBeUndefined();
expect(promptCacheOptionsToWire(null)).toBeUndefined();
expect(promptCacheOptionsToWire({})).toBeUndefined();
expect(promptCacheOptionsToWire({ prewarm: true })).toBeUndefined();
});
it('rejects a lifetime or mode OpenAI does not offer', () => {
expect(() => promptCacheOptionsToWire({ ttl: '2h' })).toThrow(
expect.objectContaining({ statusCode: 400 }),
);
expect(() => promptCacheOptionsToWire({ ttl: '24h' })).toThrow(
/30m.*12h/,
);
expect(() => promptCacheOptionsToWire({ mode: 'auto' })).toThrow(
/implicit.*explicit/,
);
expect(() => promptCacheOptionsToWire('12h')).toThrow(
/must be an object/,
);
});
});
describe('messagesHaveCacheBreakpointTtl', () => {
it('finds a breakpoint lifetime on any content part', () => {
expect(
messagesHaveCacheBreakpointTtl([
{ role: 'user', content: 'plain' },
{
role: 'system',
content: [
{ type: 'text', text: 'a' },
{
type: 'text',
text: 'b',
prompt_cache_breakpoint: {
mode: 'explicit',
ttl: '30m',
},
},
],
},
]),
).toBe(true);
expect(
messagesHaveCacheBreakpointTtl([
{
role: 'user',
content: {
type: 'text',
text: 'a',
prompt_cache_breakpoint: { ttl: '12h' },
},
},
]),
).toBe(true);
});
it('ignores breakpoints without a lifetime and odd message shapes', () => {
expect(
messagesHaveCacheBreakpointTtl([
{
role: 'system',
content: [
{
type: 'text',
text: 'a',
prompt_cache_breakpoint: { mode: 'explicit' },
},
'bare string part',
null,
],
},
{ role: 'user', content: null },
null,
]),
).toBe(false);
expect(messagesHaveCacheBreakpointTtl(undefined)).toBe(false);
expect(messagesHaveCacheBreakpointTtl('nope')).toBe(false);
});
});
@@ -29,7 +29,6 @@ import { HttpError } from '../../../core/http/HttpError.js';
import type {
ICompleteArguments,
OutputFormat,
PromptCacheOptions,
ReasoningEffort,
ToolChoice,
} from '../types.js';
@@ -306,80 +305,6 @@ export const openAICompatParams = (
return out;
};
// -- prompt caching ----------------------------------------------------------
/**
* The wire spelling of `prompt_cache_retention`. Puter also accepts the
* hyphenated `in-memory`, which every OpenAI-shaped upstream rejects.
*/
export const promptCacheRetentionToWire = (
retention: ICompleteArguments['prompt_cache_retention'],
): 'in_memory' | '24h' | undefined =>
retention === 'in-memory' ? 'in_memory' : retention;
const PROMPT_CACHE_MODES = new Set(['implicit', 'explicit']);
const PROMPT_CACHE_TTLS = new Set(['30m', '12h']);
/**
* `prompt_cache_options` as forwarded upstream: `mode` and `ttl` only, each
* checked against the values OpenAI accepts, so a bad value fails here with a
* clear message instead of as an upstream 400 the fallback loop may hide.
* `comparison_response_id` names a stored response, which Puter never keeps,
* and `prewarm` is dropped with it.
*/
export const promptCacheOptionsToWire = (
options: unknown,
): PromptCacheOptions | undefined => {
if (options === undefined || options === null) return undefined;
if (typeof options !== 'object' || Array.isArray(options)) {
throw new HttpError(400, '`prompt_cache_options` must be an object', {
legacyCode: 'bad_request',
});
}
const { mode, ttl } = options as Record<string, unknown>;
if (mode !== undefined && !PROMPT_CACHE_MODES.has(mode as string)) {
throw new HttpError(
400,
'`prompt_cache_options.mode` must be `implicit` or `explicit`',
{ legacyCode: 'bad_request' },
);
}
if (ttl !== undefined && !PROMPT_CACHE_TTLS.has(ttl as string)) {
throw new HttpError(
400,
'`prompt_cache_options.ttl` must be `30m` or `12h`',
{ legacyCode: 'bad_request' },
);
}
const wire: PromptCacheOptions = {
...(mode !== undefined
? { mode: mode as PromptCacheOptions['mode'] }
: {}),
...(ttl !== undefined ? { ttl: ttl as PromptCacheOptions['ttl'] } : {}),
};
return Object.keys(wire).length ? wire : undefined;
};
/**
* Whether any content part carries a `prompt_cache_breakpoint` with its own
* `ttl`. Chat Completions rejects the field whatever its value; only the
* Responses API honours a per-breakpoint lifetime.
*/
export const messagesHaveCacheBreakpointTtl = (messages: unknown): boolean =>
Array.isArray(messages) &&
messages.some((message) => {
const content = (message as { content?: unknown } | null)?.content;
const parts = Array.isArray(content) ? content : [content];
return parts.some(
(part) =>
(
part as {
prompt_cache_breakpoint?: { ttl?: unknown } | null;
} | null
)?.prompt_cache_breakpoint?.ttl !== undefined,
);
});
// -- Responses server-side state ---------------------------------------------
const STATEFUL_RESPONSES_FIELDS = [
@@ -463,26 +463,10 @@ describe('ImageGenerationDriver.generate provider routing', () => {
driver.generate({ prompt: 'a landscape' }),
);
expect(openaiImagesGenerateMock).toHaveBeenCalledWith(
expect.objectContaining({ model: 'gpt-image-2.6-flare' }),
expect.objectContaining({ model: 'gpt-image-2' }),
);
});
it.each(['gpt-image-2.6-flare', 'gpt-image-2.6-sunburst'])(
'routes %s and its OpenAI alias', async (model) => {
for (const id of [model, `openai/${model}`]) {
openaiImagesGenerateMock.mockResolvedValueOnce({
data: [{ url: 'https://oai/image.png' }],
});
await withDriverName('ai-image', () => driver.generate({
model: id, prompt: 'a landscape',
}));
expect(openaiImagesGenerateMock).toHaveBeenLastCalledWith(
expect.objectContaining({ model }),
);
}
},
);
it('rejects an excluded model regardless of caller casing', async () => {
await expect(withActor(() =>
driver.generate({
@@ -758,10 +742,7 @@ describe('ImageGenerationDriver.generate provider routing', () => {
}),
);
const reserveSpy = vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
);
const reserveSpy = vi.spyOn(server.services.metering, 'reserveCredits');
const usageSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -855,7 +836,7 @@ describe('ImageGenerationDriver.generate provider routing', () => {
});
const reserveSpy = vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
'reserveCredits',
);
// Cloudflare answers the scheduled refresh with new rates at once;
@@ -1165,8 +1146,8 @@ describe('ImageGenerationDriver.generate Puter file inputs', () => {
);
beforeEach(() => {
vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable').mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
vi.spyOn(server.services.metering, 'hasEnoughCredits').mockResolvedValue(
true,
);
});
@@ -1668,10 +1649,7 @@ 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,
'reserveCreditsIfAffordable',
);
const reserveSpy = vi.spyOn(server.services.metering, 'reserveCredits');
const usageSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -72,7 +72,7 @@ vi.mock('openai', () => {
// -- Test harness ----------------------------------------------------
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
>;
@@ -107,7 +107,7 @@ const makeProvider = (
beforeEach(() => {
generateMock.mockReset();
openAICtor.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -177,7 +177,7 @@ describe('BytePlusImageProvider.generate gates', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
});
@@ -196,7 +196,7 @@ describe('BytePlusImageProvider.generate gates', () => {
});
it('throws 402 BEFORE hitting ModelArk when the actor lacks credits', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => makeProvider().generate({ prompt: 'hi' })),
).rejects.toMatchObject({ statusCode: 402 });
@@ -713,7 +713,7 @@ it.each([
}),
),
).rejects.toMatchObject({ statusCode: 400, legacyCode: 'bad_request' });
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
});
@@ -73,7 +73,7 @@ let server: PuterServer;
let globalFetchSpy: MockInstance<typeof fetch>;
let fetchSpy: Mock<typeof fetch>;
let modelSearchFetch: Mock<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
>;
@@ -123,7 +123,7 @@ beforeEach(() => {
? modelSearchFetch(input, init)
: fetchSpy(input, init),
);
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -188,7 +188,7 @@ describe('CloudflareImageProvider.generate test_mode', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
@@ -210,7 +210,7 @@ describe('CloudflareImageProvider.generate argument validation', () => {
describe('CloudflareImageProvider.generate credit gate', () => {
it('throws 402 BEFORE hitting Cloudflare when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => provider.generate({ prompt: 'hi' })),
@@ -240,7 +240,7 @@ describe('CloudflareImageProvider.generate credit gate', () => {
actor,
);
const [, estimate] = admitSpy.mock.calls[0]!;
const [, estimate] = hasCreditsSpy.mock.calls[0]!;
expect(estimate).toBeGreaterThan(0);
expect(heldDuringCall).toBe(Math.ceil(estimate));
// The hold stays until the usage write lands.
@@ -708,7 +708,7 @@ describe('Cloudflare legacy image option', () => {
legacyCode: 'bad_request',
});
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
},
);
@@ -726,7 +726,7 @@ describe('Cloudflare legacy image option', () => {
message: 'Invalid input image (empty or not base64)',
});
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
});
});
@@ -823,12 +823,12 @@ describe('Cloudflare priced legacy models', () => {
imageSize: { kind: 'pixels', w: 512, h: 512 },
}));
expect(JSON.parse(fetchSpy.mock.calls[0]![1]!.body as string)).toMatchObject({ image: [1, 2, 3], mask: [4, 5, 6], num_steps: 20, width: 512, height: 512 });
expect(admitSpy).toHaveBeenCalledWith(expect.anything(), 0, undefined);
expect(hasCreditsSpy).toHaveBeenCalledWith(expect.anything(), 0);
});
it('rejects missing inpainting inputs before credit checks', async () => {
await expect(withTestActor(() => makeProvider().generate({ model: '@cf/runwayml/stable-diffusion-v1-5-inpainting', prompt: 'A cup' }))).rejects.toMatchObject({ statusCode: 400 });
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
@@ -844,7 +844,7 @@ describe('Cloudflare priced legacy models', () => {
it('charges Lucid at the price returned by the model API', async () => {
fetchSpy.mockResolvedValueOnce(new Response(new Uint8Array([1, 2, 3]), { headers: { 'content-type': 'image/png' } }));
await withTestActor(() => makeProvider().generate({ model: '@cf/leonardo/lucid-origin', prompt: 'A cup', imageSize: { kind: 'pixels', w: 512, h: 512 }, steps: 1 }));
expect(admitSpy).toHaveBeenCalledWith(expect.anything(), 713200, undefined);
expect(hasCreditsSpy).toHaveBeenCalledWith(expect.anything(), 713200);
});
});
@@ -897,10 +897,9 @@ describe('Cloudflare model-search pricing', () => {
await runPhoenix(provider);
expect(listed?.costs).toEqual({ tile_512: 1_000_000, step: 20_200 });
expect(admitSpy).toHaveBeenCalledWith(
expect(hasCreditsSpy).toHaveBeenCalledWith(
expect.anything(),
4 * 1_000_000 + 10 * 20_200,
undefined,
);
expect(batchIncrementUsagesSpy.mock.calls[0]![1]).toEqual([
expect.objectContaining({
@@ -931,10 +930,9 @@ describe('Cloudflare model-search pricing', () => {
await runPhoenix(makeProvider());
expect(modelSearchFetch).not.toHaveBeenCalled();
expect(admitSpy).toHaveBeenCalledWith(
expect(hasCreditsSpy).toHaveBeenCalledWith(
expect.anything(),
4 * 583_000 + 10 * 11_000,
undefined,
);
});
@@ -957,7 +955,7 @@ describe('Cloudflare model-search pricing', () => {
await refresh;
await runPhoenix(provider);
expect(admitSpy.mock.calls.map(([, cost]) => cost)).toEqual([
expect(hasCreditsSpy.mock.calls.map(([, cost]) => cost)).toEqual([
2_442_000, 4_202_000,
]);
});
@@ -979,10 +977,9 @@ describe('Cloudflare model-search pricing', () => {
await runPhoenix(provider);
expect(modelSearchFetch).toHaveBeenCalledTimes(2);
expect(admitSpy).toHaveBeenCalledWith(
expect(hasCreditsSpy).toHaveBeenCalledWith(
expect.anything(),
4_202_000,
undefined,
);
});
@@ -1018,7 +1015,7 @@ describe('Cloudflare model-search pricing', () => {
steps: 10,
} as never),
);
return admitSpy.mock.lastCall![1];
return hasCreditsSpy.mock.lastCall![1];
};
const settle = () => new Promise((resolve) => setImmediate(resolve));
const OLD = { tile_512: 583_000, step: 11_000 };
@@ -1072,10 +1069,9 @@ describe('Cloudflare model-search pricing', () => {
}),
);
expect(modelSearchFetch).toHaveBeenCalledOnce();
expect(admitSpy).toHaveBeenCalledWith(
expect(hasCreditsSpy).toHaveBeenCalledWith(
expect.anything(),
4 * 5280 + 4 * 10560,
undefined,
);
});
@@ -82,7 +82,7 @@ vi.mock('../../inputImage.js', async (orig) => ({
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
@@ -111,7 +111,7 @@ beforeEach(() => {
generateContentMock.mockReset();
toBase64DataUriMock.mockReset();
googleAICtor.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
@@ -167,7 +167,7 @@ describe('GeminiImageProvider.generate test_mode', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateContentMock).not.toHaveBeenCalled();
});
});
@@ -219,7 +219,7 @@ describe('GeminiImageProvider.generate argument validation', () => {
legacyCode: 'bad_request',
message: expect.stringContaining('Unsupported quality tier'),
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateContentMock).not.toHaveBeenCalled();
},
);
@@ -427,7 +427,7 @@ describe('GeminiImageProvider.generate Flash path (generateContent)', () => {
it('throws 402 BEFORE hitting Gemini when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() =>
@@ -466,7 +466,7 @@ describe('GeminiImageProvider.generate Flash path (generateContent)', () => {
actor,
);
const [, estimate] = admitSpy.mock.calls[0]!;
const [, estimate] = hasCreditsSpy.mock.calls[0]!;
expect(estimate).toBeGreaterThan(0);
expect(heldDuringCall).toBe(Math.ceil(estimate));
// The hold stays until the usage write lands.
@@ -643,7 +643,7 @@ describe('Gemini Nano Banana image generation', () => {
const request = generateContentMock.mock.calls[0][0];
expect(request.config.imageConfig.imageSize).toBe('1K');
// Input + 1120 image tokens at $30/1M + 1000 text tokens at $7.50/1M.
expect(admitSpy).toHaveBeenCalledWith(expect.anything(), 4_194_450, undefined);
expect(hasCreditsSpy).toHaveBeenCalledWith(expect.anything(), 4_194_450);
expect(batchIncrementUsagesSpy).toHaveBeenCalledWith(
expect.anything(),
expect.arrayContaining([
@@ -50,7 +50,7 @@ import { KlingImageProvider } from './KlingImageProvider.js';
let server: PuterServer;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -73,7 +73,7 @@ const makeProvider = () =>
beforeEach(() => {
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
incrementUsageSpy.mockResolvedValue({} as never);
});
@@ -318,7 +318,7 @@ describe('KlingImageProvider billing', () => {
});
it('rejects before calling Kling when credits run short', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(generate({})).rejects.toMatchObject({ statusCode: 402 });
expect(fetchSpy).not.toHaveBeenCalled();
});
@@ -97,7 +97,7 @@ vi.mock('../../inputImage.js', async (orig) => ({
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
>;
@@ -126,7 +126,7 @@ beforeEach(() => {
editMock.mockReset();
fetchImageAsBase64Mock.mockReset();
openAICtor.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -150,9 +150,9 @@ describe('OpenAiImageProvider construction', () => {
// ── Model catalog ───────────────────────────────────────────────────
describe('OpenAiImageProvider model catalog', () => {
it('returns gpt-image-2.6-flare as the default', () => {
it('returns gpt-image-2 as the default', () => {
const provider = makeProvider();
expect(provider.getDefaultModel()).toBe('gpt-image-2.6-flare');
expect(provider.getDefaultModel()).toBe('gpt-image-2');
});
it('drops the deprecated gpt-image-1 family and chatgpt-image-latest', () => {
@@ -195,7 +195,7 @@ describe('OpenAiImageProvider.generate test_mode', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
});
});
@@ -235,60 +235,9 @@ describe('OpenAiImageProvider.generate argument validation', () => {
// ── Credit gate ─────────────────────────────────────────────────────
describe('OpenAiImageProvider.generate credit gate', () => {
it('waits for the real usage write before returning an image', async () => {
const actor = makeActor({
user: {
id: 62,
uuid: `image-write-${Date.now()}`,
username: 'metered',
},
});
const redis = server.clients.redis as unknown as {
meterIncr: (...args: string[]) => Promise<unknown>;
};
const realIncr = redis.meterIncr.bind(redis);
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
let blocked = false;
vi.spyOn(redis, 'meterIncr').mockImplementation(async (...args) => {
const actorKey = `:actor:${actor.user!.uuid}:`;
if (!blocked && args.some((arg) => arg.includes(actorKey))) {
blocked = true;
await held;
}
return realIncr(...args);
});
generateMock.mockResolvedValueOnce({
data: [{ url: 'https://image.example/result.png' }],
});
const provider = makeProvider();
let finished = false;
const generating = withTestActor(
() =>
provider.generate({
model: 'gpt-image-2',
prompt: 'an image',
ratio: { w: 1024, h: 1024 },
}),
actor,
).then((result) => {
finished = true;
return result;
});
try {
await vi.waitFor(() => expect(blocked).toBe(true));
expect(finished).toBe(false);
} finally {
release();
await generating;
}
});
it('throws 402 BEFORE hitting OpenAI when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() =>
provider.generate({
@@ -324,7 +273,7 @@ describe('OpenAiImageProvider.generate credit gate', () => {
actor,
);
const [, estimate] = admitSpy.mock.calls[0]!;
const [, estimate] = hasCreditsSpy.mock.calls[0]!;
expect(estimate).toBeGreaterThan(0);
expect(heldDuringCall).toBe(Math.ceil(estimate));
// The hold stays until the usage write lands.
@@ -728,8 +677,8 @@ describe('OpenAiImageProvider gpt-image-2.5 models', () => {
);
// Latent factor 48 vs 24 at the medium tier.
const gptImage2Estimate = admitSpy.mock.calls[0]![1];
const gptImage25Estimate = admitSpy.mock.calls[1]![1];
const gptImage2Estimate = hasCreditsSpy.mock.calls[0]![1];
const gptImage25Estimate = hasCreditsSpy.mock.calls[1]![1];
expect(gptImage25Estimate).toBeLessThan(gptImage2Estimate);
});
@@ -754,8 +703,8 @@ describe('OpenAiImageProvider gpt-image-2.5 models', () => {
}),
);
const highEstimate = admitSpy.mock.calls[0]![1];
const maxEstimate = admitSpy.mock.calls[1]![1];
const highEstimate = hasCreditsSpy.mock.calls[0]![1];
const maxEstimate = hasCreditsSpy.mock.calls[1]![1];
expect(maxEstimate).toBeGreaterThan(highEstimate);
});
});
@@ -908,64 +857,3 @@ it('keeps a landscape aspect hint landscape at gpt-image-2 sizes', async () => {
expect(w).toBeGreaterThan(h);
expect(Math.abs(w / h - 1.7)).toBeLessThan(0.1);
});
describe('OpenAiImageProvider GPT Image 2.6', () => {
it.each(['gpt-image-2.6-flare', 'gpt-image-2.6-sunburst'])(
'%s generates and edits with token-based billing', async (model) => {
const provider = makeProvider();
const response = {
data: [{ b64_json: 'AAAA' }],
usage: {
input_tokens: 100,
output_tokens: 800,
input_tokens_details: { text_tokens: 100, image_tokens: 0 },
},
};
generateMock.mockResolvedValue(response);
editMock.mockResolvedValue(response);
for (const input_image of [undefined, 'data:image/png;base64,AAAA']) {
const result = await withTestActor(() => provider.generate({
model, prompt: 'hi', quality: 'xhigh',
ratio: { w: 1024, h: 1024 }, input_image,
}));
expect(result).toBe('data:image/png;base64,AAAA');
}
for (const mock of [generateMock, editMock]) {
expect(mock.mock.calls[0]![0]).toMatchObject({
model, quality: 'xhigh', size: '1024x1024',
});
}
const [, entries] = batchIncrementUsagesSpy.mock.calls[0]!;
expect(entries).toEqual(expect.arrayContaining([
expect.objectContaining({
usageType: `openai:${model}:xhigh:1024x1024:output`,
costOverride: 2_400_000,
}),
]));
},
);
it.each([
['low', 1024, 1024, 823],
['medium', 1024, 1024, 1449],
['high', 1024, 1024, 1756],
['xhigh', 1024, 1024, 3122],
['max', 1024, 1024, 7024],
['auto', 1024, 1024, 1449],
['low', 2048, 1088, 571],
])('estimates %s at %sx%s from the 2.6 calculator', async (quality, w, h, tokens) => {
generateMock.mockResolvedValue({ data: [{ b64_json: 'AAAA' }] });
await withTestActor(() => makeProvider().generate({
model: 'gpt-image-2.6-flare', prompt: 'hi', quality: String(quality),
ratio: { w: Number(w), h: Number(h) },
}));
const [, entries] = batchIncrementUsagesSpy.mock.calls[0]!;
const output = (entries as Array<{ usageType: string; costOverride: number }>)
.find((entry) => entry.usageType.endsWith(':output'))!;
expect(output.usageType).toBe(`openai:gpt-image-2.6-flare:${quality}:${w}x${h}:output`);
// The metering conversion rounds fractional microcents upward.
expect(output.costOverride).toBeGreaterThanOrEqual(Number(tokens) * 3000);
expect(output.costOverride).toBeLessThanOrEqual(Number(tokens) * 3000 + 1);
});
});
@@ -56,8 +56,8 @@ interface OpenAIImageUsage {
/**
* OpenAI image generation provider for v2. Supports the GPT Image models
* (gpt-image-2 and the 2.5/2.6 Sunburst and Flare models), including
* image-to-image editing via `input_images` (the `images.edit` endpoint).
* (gpt-image-2, -2.5-sunburst, -2.5-flare), including image-to-image editing
* via `input_images` (the `images.edit` endpoint).
*/
export class OpenAiImageProvider implements IImageProvider {
#meteringService: AiMeteringService;
@@ -109,7 +109,7 @@ export class OpenAiImageProvider implements IImageProvider {
}
getDefaultModel(): string {
return 'gpt-image-2.6-flare';
return 'gpt-image-2';
}
async generate({
@@ -293,10 +293,7 @@ export class OpenAiImageProvider implements IImageProvider {
});
}
if (usageEntries.length) {
await this.#meteringService.batchIncrementUsages(
actor,
usageEntries,
);
this.#meteringService.batchIncrementUsages(actor, usageEntries);
}
const url =
@@ -604,36 +601,17 @@ export class OpenAiImageProvider implements IImageProvider {
height: number,
quality?: string,
): number {
const isGptImage26 = model.startsWith('gpt-image-2.6');
const factors =
isGptImage26 || model.startsWith('gpt-image-2.5')
? OpenAiImageProvider.#GPT_IMAGE_2_5_LATENT_FACTORS
: OpenAiImageProvider.#GPT_IMAGE_2_LATENT_FACTORS;
const factors = model.startsWith('gpt-image-2.5')
? OpenAiImageProvider.#GPT_IMAGE_2_5_LATENT_FACTORS
: OpenAiImageProvider.#GPT_IMAGE_2_LATENT_FACTORS;
const factor = factors[quality ?? ''] ?? factors.medium;
const longEdge = Math.max(width, height);
const shortEdge = Math.min(width, height);
const shortGrid = (factor * shortEdge) / longEdge;
const floorGrid = Math.floor(shortGrid);
const shortLatent =
isGptImage26 && shortGrid - floorGrid === 0.5
? floorGrid + (floorGrid % 2)
: Math.round(shortGrid);
const shortLatent = Math.round((factor * shortEdge) / longEdge);
const latentW = width >= height ? factor : shortLatent;
const latentH = width >= height ? shortLatent : factor;
const baseArea = latentW * latentH;
const tokens = Math.ceil(
(baseArea * (2_000_000 + width * height)) / 4_000_000,
);
// GPT Image 2.6 bills more tokens at low and medium quality.
const estimatedQuality =
quality && quality in factors ? quality : 'medium';
const multiplier =
estimatedQuality === 'low'
? 4.2
: estimatedQuality === 'medium'
? 3.3
: 1;
return isGptImage26 ? Math.round(tokens * multiplier) : tokens;
return Math.ceil((baseArea * (2_000_000 + width * height)) / 4_000_000);
}
#estimateOutputCostFromTokens(
@@ -20,46 +20,6 @@
import type { IImageModel } from '../../types.js';
export const OPEN_AI_IMAGE_GENERATION_MODELS: IImageModel[] = [
{
puterId: 'openai:openai/gpt-image-2.6-sunburst',
id: 'gpt-image-2.6-sunburst',
aliases: ['openai/gpt-image-2.6-sunburst'],
name: 'GPT Image 2.6 Sunburst',
version: '2.6',
costs_currency: 'usd-cents',
index_cost_key: 'low:1024x1024',
costs: {
// Text tokens (per 1M tokens)
text_input: 500, // $5.00
text_cached_input: 125, // $1.25
// Image tokens (per 1M tokens)
image_input: 800, // $8.00
image_cached_input: 200, // $2.00
image_output: 3000, // $30.00
'low:1024x1024': 2.469,
},
allowedQualityLevels: ['low', 'medium', 'high', 'xhigh', 'max', 'auto'],
},
{
puterId: 'openai:openai/gpt-image-2.6-flare',
id: 'gpt-image-2.6-flare',
aliases: ['openai/gpt-image-2.6-flare'],
name: 'GPT Image 2.6 Flare',
version: '2.6',
costs_currency: 'usd-cents',
index_cost_key: 'low:1024x1024',
costs: {
// Text tokens (per 1M tokens)
text_input: 500, // $5.00
text_cached_input: 125, // $1.25
// Image tokens (per 1M tokens)
image_input: 800, // $8.00
image_cached_input: 200, // $2.00
image_output: 3000, // $30.00
'low:1024x1024': 2.469,
},
allowedQualityLevels: ['low', 'medium', 'high', 'xhigh', 'max', 'auto'],
},
{
puterId: 'openai:openai/gpt-image-2.5-sunburst',
id: 'gpt-image-2.5-sunburst',
@@ -84,7 +84,7 @@ vi.mock('../../../../util/secureHttp.js', () => ({
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
@@ -115,7 +115,7 @@ beforeEach(() => {
cancelMock.mockReset();
replicateCtor.mockReset();
secureFetchMock.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
@@ -177,7 +177,7 @@ describe('ReplicateImageGenerationProvider.generate test_mode', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(createPredictionMock).not.toHaveBeenCalled();
});
});
@@ -199,7 +199,7 @@ describe('ReplicateImageGenerationProvider.generate argument validation', () =>
describe('ReplicateImageGenerationProvider.generate credit gate', () => {
it('throws 402 BEFORE hitting Replicate when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => provider.generate({ prompt: 'hi' })),
).rejects.toMatchObject({ statusCode: 402 });
@@ -255,10 +255,7 @@ describe('ReplicateImageGenerationProvider.generate credit gate', () => {
it('holds credits for longer than a prediction can run', async () => {
const provider = makeProvider();
const actor = holdUser('ttl');
const reserveSpy = vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
);
const reserveSpy = vi.spyOn(server.services.metering, 'reserveCredits');
createPredictionMock.mockResolvedValueOnce({
id: 'ttl',
status: 'succeeded',
@@ -277,9 +274,7 @@ describe('ReplicateImageGenerationProvider.generate credit gate', () => {
const provider = makeProvider();
const actor = holdUser('surcharge');
secureFetchMock.mockResolvedValueOnce(new Response('not-an-image'));
admitSpy.mockImplementationOnce((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
).mockResolvedValueOnce(false);
hasCreditsSpy.mockResolvedValueOnce(true).mockResolvedValueOnce(false);
await expect(
withTestActor(
@@ -955,7 +950,7 @@ it('does not start a prediction for an already-aborted request', async () => {
),
).rejects.toMatchObject({ statusCode: 400, legacyCode: 'client_aborted' });
expect(createPredictionMock).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
});
it('stops polling and cancels at the prediction deadline', async () => {
@@ -1197,12 +1192,12 @@ it('rejects more than ten input images before fetching or pricing any', async ()
),
).rejects.toMatchObject({ statusCode: 400, legacyCode: 'bad_request' });
expect(secureFetchMock).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(createPredictionMock).not.toHaveBeenCalled();
});
it('checks credits on the output-only estimate before fetching input images', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() =>
makeProvider().generate({
@@ -71,7 +71,7 @@ vi.mock('together-ai', () => {
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -96,7 +96,7 @@ const makeProvider = () =>
beforeEach(() => {
generateMock.mockReset();
togetherCtor.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -158,7 +158,7 @@ describe('TogetherImageProvider.generate test_mode', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
});
});
@@ -189,7 +189,7 @@ describe('TogetherImageProvider.generate argument validation', () => {
describe('TogetherImageProvider.generate credit gate', () => {
it('throws 402 BEFORE hitting Together when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() =>
@@ -760,7 +760,7 @@ describe('Together supported sizes and references', () => {
width: 1024,
height: 1024,
});
expect(Number.isFinite(admitSpy.mock.calls[0][1])).toBe(true);
expect(Number.isFinite(hasCreditsSpy.mock.calls[0][1])).toBe(true);
});
it('resolves provider aliases without changing the selected model', async () => {
@@ -790,7 +790,7 @@ describe('Together supported sizes and references', () => {
}),
),
).rejects.toMatchObject({ statusCode: 400 });
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
});
@@ -859,7 +859,7 @@ it.each(['3K', 'unknown', ' 5k '])(
}),
),
).rejects.toMatchObject({ statusCode: 400, legacyCode: 'bad_request' });
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
},
);
@@ -895,7 +895,7 @@ describe('Together current API prices', () => {
input_image: 'https://example.com/reference.png',
}),
);
expect(admitSpy).toHaveBeenCalledWith(expect.anything(), 4685000, undefined);
expect(hasCreditsSpy).toHaveBeenCalledWith(expect.anything(), 4685000);
expect(incrementUsageSpy).toHaveBeenCalledWith(
expect.anything(),
'togetherai:google/flash-image-3.1:0.5K',
@@ -85,7 +85,7 @@ vi.mock('openai', () => {
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
>;
@@ -115,7 +115,7 @@ beforeEach(() => {
openAICtor.mockReset();
axiosGetMock.mockReset();
axiosGetMock.mockRejectedValue(new Error('Catalog unavailable'));
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -182,7 +182,7 @@ describe('XAIImageProvider.generate test_mode', () => {
expect(result).toBe(
'https://puter-sample-data.puter.site/image_example.png',
);
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
expect(batchIncrementUsagesSpy).not.toHaveBeenCalled();
});
@@ -231,7 +231,7 @@ describe('XAIImageProvider.generate argument validation', () => {
describe('XAIImageProvider.generate credit gate', () => {
it('throws 402 BEFORE hitting xAI when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() =>
@@ -718,7 +718,7 @@ describe('XAIImageProvider quality and reference limits', () => {
}),
),
).rejects.toMatchObject({ statusCode: 400 });
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(postMock).not.toHaveBeenCalled();
});
});
@@ -746,7 +746,7 @@ describe('xAI option validation', () => {
makeProvider().generate({ prompt: 'hi', ...options } as never),
),
).rejects.toMatchObject({ statusCode: 400 });
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(generateMock).not.toHaveBeenCalled();
});
});
+9 -9
View File
@@ -167,7 +167,7 @@ const sentRegions = () =>
let server: PuterServer;
let driver: OCRDriver;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -199,7 +199,7 @@ beforeEach(() => {
mistralCtor.mockReset();
// Spy on metering — keep the real impl so its recording side runs,
// but capture calls so per-test assertions can inspect them.
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -335,7 +335,7 @@ describe('OCRDriver.recognize (aws-textract)', () => {
};
it('throws 402 when the actor does not have enough credits', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
const { actor } = await makeUser();
await expect(
@@ -546,7 +546,7 @@ describe('OCRDriver.recognize (aws-textract)', () => {
describe('regional pricing', () => {
const onePage = { Blocks: [{ BlockType: 'PAGE' }] };
const checkedCosts = () =>
admitSpy.mock.calls.map(([, cost]) => cost);
hasCreditsSpy.mock.calls.map(([, cost]) => cost);
const textractCharges = () =>
incrementUsageSpy.mock.calls
.filter(([, type]) => type === TEXTRACT_USAGE)
@@ -719,7 +719,7 @@ describe('OCRDriver.recognize (mistral)', () => {
};
it('throws 402 when the actor does not have enough credits', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
const { actor } = await makeUser();
await expect(
@@ -1033,7 +1033,7 @@ describe('OCRDriver.recognize (mistral)', () => {
const pageType = 'mistral-ocr:mistral-ocr-4-1:page';
const annotationType = 'mistral-ocr:mistral-ocr-4-1:annotations:page';
// The pre-flight covers the page plus its annotation.
expect(admitSpy.mock.calls[0]![1]).toBe(
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(
OCR_COSTS[pageType] + OCR_COSTS[annotationType],
);
const ocrCalls = incrementUsageSpy.mock.calls.filter(
@@ -1080,7 +1080,7 @@ describe('OCRDriver credit pre-flight', () => {
const pageType = 'mistral-ocr:mistral-ocr-4-1:page';
const perPage = OCR_COSTS[pageType];
const pdfSource = (buffer: Buffer) => dataUrl(buffer, 'application/pdf');
const checkedCosts = () => admitSpy.mock.calls.map(([, cost]) => cost);
const checkedCosts = () => hasCreditsSpy.mock.calls.map(([, cost]) => cost);
const outstandingHolds = (actor: Actor) =>
server.stores.creditHold.outstanding(actor.user.uuid!);
@@ -1171,8 +1171,8 @@ describe('OCRDriver credit pre-flight', () => {
),
).rejects.toMatchObject({ statusCode: 402 });
// The estimate/hold path never ran.
expect(admitSpy).not.toHaveBeenCalled();
// The estimate/hold path (which calls hasEnoughCredits) never ran.
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(mistralOcrProcessMock).not.toHaveBeenCalled();
noUsage.mockRestore();
});
@@ -72,7 +72,7 @@ vi.mock('undici', async (importOriginal) => ({
let server: PuterServer;
let driver: VoiceChangerDriver;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -91,7 +91,7 @@ afterAll(async () => {
beforeEach(() => {
webFetchMock.mockReset();
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -197,7 +197,7 @@ describe('VoiceChangerDriver.convert argument validation', () => {
describe('VoiceChangerDriver.convert credit gate', () => {
it('throws 402 BEFORE hitting ElevenLabs when the actor lacks credits', async () => {
const { actor } = await makeUser();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withActor(actor, () =>
@@ -387,7 +387,7 @@ describe('VoiceChangerDriver.convert success path', () => {
const [base, factored] = metered();
expect(factored).toBe(base! * 2);
const held = admitSpy.mock.calls.map(([, amount]) => amount);
const held = hasCreditsSpy.mock.calls.map(([, amount]) => amount);
expect(held).toEqual([base, base! * 2]);
});
@@ -122,7 +122,7 @@ vi.mock('openai', () => {
let server: PuterServer;
let driver: SpeechToTextDriver;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -145,7 +145,7 @@ beforeEach(() => {
toFileMock.mockClear();
// Spy on metering — keep the real impl so its recording side runs,
// but capture calls so per-test assertions can inspect them.
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -360,7 +360,7 @@ describe('SpeechToTextDriver argument validation', () => {
describe('SpeechToTextDriver credit gate', () => {
it('throws 402 BEFORE hitting OpenAI when actor lacks credits', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
const { actor } = await makeUser();
await expect(
@@ -686,7 +686,7 @@ describe('SpeechToTextDriver metering', () => {
expect(cost).toBe(SPEECH_TO_TEXT_COSTS[usageType]);
});
it('reserves the same total it later meters', async () => {
it('asks hasEnoughCredits for the same total it later meters', async () => {
const { actor } = await makeUser();
transcriptionsCreateMock.mockResolvedValueOnce({ text: 'x' });
@@ -700,7 +700,7 @@ describe('SpeechToTextDriver metering', () => {
const usageType = 'openai:gpt-transcribe:second';
const expected = SPEECH_TO_TEXT_COSTS[usageType] * 2;
const creditCall = admitSpy.mock.calls[0]!;
const creditCall = hasCreditsSpy.mock.calls[0]!;
expect(creditCall[1]).toBe(expected);
});
@@ -794,7 +794,7 @@ describe('SpeechToTextDriver metering', () => {
const [base, factored] = metered();
expect(factored).toBe(base! * 2);
const held = admitSpy.mock.calls.map(([, amount]) => amount);
const held = hasCreditsSpy.mock.calls.map(([, amount]) => amount);
expect(held).toEqual([base, base! * 2]);
});
});
@@ -72,7 +72,7 @@ const HOLD = COUNTED_TOKENS * AUDIO_RATE + 8192 * OUTPUT_RATE;
let server: PuterServer;
let sttDriver: SpeechToTextDriver;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchSpy: MockInstance<MeteringService['batchIncrementUsages']>;
const driver = {
@@ -102,7 +102,7 @@ beforeEach(() => {
.mockRejectedValue(new Error('unexpected fetch')) as MockInstance<
typeof fetch
>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
batchSpy = vi.spyOn(server.services.metering, 'batchIncrementUsages');
});
@@ -220,16 +220,13 @@ const metered = (): UsageInput[] =>
/** Records each credit hold taken, its options, and its release. */
const trackHolds = (order: string[] = []) => {
const metering = server.services.metering;
const realReserve = Object.getPrototypeOf(
metering,
).reserveCreditsIfAffordable.bind(metering) as typeof metering.reserveCreditsIfAffordable;
const realReserve = metering.reserveCredits.bind(metering);
const held: { amount: number; ttlMs?: number }[] = [];
const released = vi.fn();
vi.spyOn(metering, 'reserveCreditsIfAffordable').mockImplementation(
vi.spyOn(metering, 'reserveCredits').mockImplementation(
async (actor, amount, opts) => {
held.push({ amount, ttlMs: opts?.ttlMs });
const hold = await realReserve(actor, amount, opts);
if (!hold) return null;
return {
...hold,
release: async () => {
@@ -428,7 +425,7 @@ describe('GeminiSpeechToTextProvider test_mode', () => {
model: MODEL,
});
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(batchSpy).not.toHaveBeenCalled();
});
@@ -1266,12 +1263,12 @@ describe('GeminiSpeechToTextProvider countTokens preflight', () => {
describe('GeminiSpeechToTextProvider credit hold', () => {
it('throws 402 after counting tokens, before transcribing', async () => {
const { actor } = await makeUser();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
fetchSpy.mockResolvedValueOnce(Response.json({ totalTokens: 91 }));
await expect(
withActor(actor, () => driver.transcribe({ file: dataUrl() })),
).rejects.toMatchObject({ statusCode: 402 });
expect(admitSpy.mock.calls[0]![1]).toBe(HOLD);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(HOLD);
expect(fetchSpy).toHaveBeenCalledTimes(1);
expect(batchSpy).not.toHaveBeenCalled();
});
@@ -70,7 +70,7 @@ const driver = {
getReportedCosts: () => sttDriver.getReportedCosts(),
};
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -88,7 +88,7 @@ afterAll(async () => {
beforeEach(() => {
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -193,7 +193,7 @@ describe('XAISpeechToTextProvider test_mode', () => {
expect(Array.isArray(result.words)).toBe(true);
// No file required, no actor required, no fetch / metering hit.
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
@@ -258,7 +258,7 @@ describe('XAISpeechToTextProvider missing API key', () => {
describe('XAISpeechToTextProvider credit gate', () => {
it('throws 402 BEFORE hitting xAI when actor lacks credits', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
const { actor } = await makeUser();
await expect(
@@ -273,7 +273,7 @@ describe('XAISpeechToTextProvider credit gate', () => {
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
it('reserves estimated seconds × per-second ucents', async () => {
it('asks hasEnoughCredits for estimated seconds × per-second ucents', async () => {
const { actor } = await makeUser();
fetchSpy.mockResolvedValueOnce(
sttResponse({ text: 'ok', duration: 1 }),
@@ -285,7 +285,7 @@ describe('XAISpeechToTextProvider credit gate', () => {
driver.transcribe({ file: dataUrl(audio, 'audio/mp3') }),
);
expect(admitSpy.mock.calls[0]![1]).toBe(UCENTS_PER_SECOND * 2);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(UCENTS_PER_SECOND * 2);
});
it('estimates 60 seconds for URL inputs (we cannot inspect size locally)', async () => {
@@ -298,7 +298,7 @@ describe('XAISpeechToTextProvider credit gate', () => {
driver.transcribe({ file: 'https://example.com/clip.mp3' }),
);
expect(admitSpy.mock.calls[0]![1]).toBe(UCENTS_PER_SECOND * 60);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(UCENTS_PER_SECOND * 60);
});
});
+3 -3
View File
@@ -699,9 +699,9 @@ describe('TTSDriver cost factor', () => {
server.services.metering,
'incrementUsage',
);
const admitSpy = vi.spyOn(
const hasCreditsSpy = vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
'hasEnoughCredits',
);
const metered = () =>
incrementUsageSpy.mock.calls.map(([, , , cost]) => cost!);
@@ -725,7 +725,7 @@ describe('TTSDriver cost factor', () => {
const [base, factored] = metered();
expect(base).toBeGreaterThan(0);
expect(factored).toBe(Math.round(base! * 2));
const held = admitSpy.mock.calls.map(([, amount]) => amount);
const held = hasCreditsSpy.mock.calls.map(([, amount]) => amount);
expect(held).toEqual([base, Math.round(base! * 2)]);
});
});
@@ -84,7 +84,7 @@ vi.mock('@aws-sdk/client-polly', async () => {
let server: PuterServer;
let priceFetch: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -180,7 +180,7 @@ beforeEach(() => {
pollyCtor.mockReset();
priceFetch = vi.fn(servePriceLists());
vi.stubGlobal('fetch', priceFetch);
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -314,7 +314,7 @@ describe('AWSPollyTTSProvider.synthesize test_mode', () => {
url: 'https://puter-sample-data.puter.site/tts_example.mp3',
content_type: 'audio',
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(pollySendMock).not.toHaveBeenCalled();
});
});
@@ -349,7 +349,7 @@ describe('AWSPollyTTSProvider.synthesize argument validation', () => {
describe('AWSPollyTTSProvider.synthesize credit gate', () => {
it('throws 402 BEFORE hitting Polly when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
sendDispatch();
await expect(
@@ -481,7 +481,7 @@ describe('AWSPollyTTSProvider.synthesize metering', () => {
expect(cost).toBe(expectedCost);
});
it('reserves the same total it later meters', async () => {
it('asks for hasEnoughCredits with the same total it later meters', async () => {
const provider = makeProvider();
sendDispatch();
@@ -495,7 +495,7 @@ describe('AWSPollyTTSProvider.synthesize metering', () => {
);
const expectedCost = AWS_POLLY_COSTS['generative'] * text.length;
expect(admitSpy.mock.calls[0]![1]).toBe(expectedCost);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(expectedCost);
});
});
@@ -599,7 +599,7 @@ describe('AWSPollyTTSProvider published pricing', () => {
engine: 'generative',
});
expect(admitSpy.mock.calls.map((c) => c[1])).toEqual([
expect(hasCreditsSpy.mock.calls.map((c) => c[1])).toEqual([
1700 * 5,
3000 * 5,
]);
@@ -648,7 +648,7 @@ describe('AWSPollyTTSProvider published pricing', () => {
await readStreamResult(result);
expect(refreshedNeural).toBe(19);
expect(admitSpy.mock.calls[0]![1]).toBe(1700 * 5);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(1700 * 5);
expect(incrementUsageSpy.mock.calls[0]![3]).toBe(1700 * 5);
});
@@ -86,10 +86,8 @@ describe('meterPerCharacter', () => {
it('holds and then meters exactly text length × price', async () => {
const check = vi
.spyOn(server.services.metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
.spyOn(server.services.metering, 'hasEnoughCredits')
.mockResolvedValue(true);
const record = vi.spyOn(server.services.metering, 'incrementUsage');
await drain(
@@ -103,7 +101,7 @@ describe('meterPerCharacter', () => {
),
);
expect(check).toHaveBeenCalledWith(actor, 7500, undefined);
expect(check).toHaveBeenCalledWith(actor, 7500);
expect(record).toHaveBeenCalledWith(
actor,
'openai:tts-1:character',
@@ -120,10 +118,8 @@ describe('meterPerCharacter', () => {
it('meters nothing when the upstream breaks before any audio', async () => {
vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
).mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
'hasEnoughCredits',
).mockResolvedValue(true);
const record = vi.spyOn(server.services.metering, 'incrementUsage');
await drain(
@@ -143,10 +139,8 @@ describe('meterPerCharacter', () => {
it('meters the full text once audio has started, even if the upstream then breaks', async () => {
vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
).mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
'hasEnoughCredits',
).mockResolvedValue(true);
const record = vi.spyOn(server.services.metering, 'incrementUsage');
await drain(
@@ -171,10 +165,8 @@ describe('meterPerCharacter', () => {
it('meters the full text when the caller hangs up before any audio', async () => {
vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
).mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
'hasEnoughCredits',
).mockResolvedValue(true);
const record = vi.spyOn(server.services.metering, 'incrementUsage');
const result = await meterPerCharacter(
@@ -200,10 +192,8 @@ describe('meterPerCharacter', () => {
it('meters nothing when synthesis fails', async () => {
vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
).mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
'hasEnoughCredits',
).mockResolvedValue(true);
const record = vi.spyOn(server.services.metering, 'incrementUsage');
const boom = new Error('vendor down');
@@ -223,8 +213,8 @@ describe('meterPerCharacter', () => {
it('refuses with a 402 before synthesizing when unaffordable', async () => {
vi.spyOn(
server.services.metering,
'reserveCreditsIfAffordable',
).mockResolvedValue(null);
'hasEnoughCredits',
).mockResolvedValue(false);
const synthesize = vi.fn(audio);
await expect(
@@ -57,7 +57,7 @@ import { ELEVENLABS_TTS_COSTS } from './costs.js';
let server: PuterServer;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -88,7 +88,7 @@ const audioResponse = (body = 'audio-bytes', contentType = 'audio/mpeg') =>
beforeEach(() => {
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -283,7 +283,7 @@ describe('ElevenLabsTTSProvider.synthesize test_mode', () => {
url: 'https://puter-sample-data.puter.site/tts_example.mp3',
content_type: 'audio',
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
@@ -323,7 +323,7 @@ describe('ElevenLabsTTSProvider.synthesize argument validation', () => {
});
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(incrementUsageSpy).not.toHaveBeenCalled();
});
@@ -358,7 +358,7 @@ describe('ElevenLabsTTSProvider.synthesize argument validation', () => {
describe('ElevenLabsTTSProvider.synthesize credit gate', () => {
it('throws 402 BEFORE hitting ElevenLabs when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => provider.synthesize({ text: 'hi' })),
@@ -510,7 +510,7 @@ describe('ElevenLabsTTSProvider.synthesize request shape', () => {
fields: { key, got: value },
});
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(incrementUsageSpy).not.toHaveBeenCalled();
},
);
@@ -893,7 +893,7 @@ describe('ElevenLabsTTSProvider.synthesize metering', () => {
expect(cost).toBe(expectedCost);
});
it('reserves the same total it later meters', async () => {
it('asks for hasEnoughCredits with the same total it later meters', async () => {
const provider = makeProvider();
fetchSpy.mockResolvedValueOnce(audioResponse());
@@ -904,7 +904,7 @@ describe('ElevenLabsTTSProvider.synthesize metering', () => {
const expectedCost =
ELEVENLABS_TTS_COSTS['eleven_multilingual_v2'] * text.length;
expect(admitSpy.mock.calls[0]![1]).toBe(expectedCost);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(expectedCost);
});
});
@@ -61,7 +61,7 @@ const INTERACTIONS_URL =
let server: PuterServer;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchIncrementUsagesSpy: MockInstance<
MeteringService['batchIncrementUsages']
>;
@@ -183,16 +183,13 @@ const payingUser = () =>
/** Spies on the credit holds taken, recording the amount and each release. */
const trackHolds = () => {
const metering = server.services.metering;
const realReserve = Object.getPrototypeOf(
metering,
).reserveCreditsIfAffordable.bind(metering) as typeof metering.reserveCreditsIfAffordable;
const realReserve = metering.reserveCredits.bind(metering);
const held: number[] = [];
const released = vi.fn();
vi.spyOn(metering, 'reserveCreditsIfAffordable').mockImplementation(
vi.spyOn(metering, 'reserveCredits').mockImplementation(
async (actor, amount, opts) => {
held.push(amount);
const hold = await realReserve(actor, amount, opts);
if (!hold) return null;
return {
...hold,
release: async () => {
@@ -217,7 +214,7 @@ beforeEach(() => {
.mockRejectedValue(new Error('unexpected fetch')) as MockInstance<
typeof fetch
>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
batchIncrementUsagesSpy = vi.spyOn(
server.services.metering,
'batchIncrementUsages',
@@ -335,7 +332,7 @@ describe('GeminiTTSProvider.synthesize test_mode', () => {
url: 'https://puter-sample-data.puter.site/tts_example.mp3',
content_type: 'audio',
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
@@ -409,7 +406,7 @@ describe('GeminiTTSProvider.synthesize argument validation', () => {
legacyCode: 'input_too_large',
fields: { key: 'text', max: 3000 },
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
@@ -437,7 +434,7 @@ describe('GeminiTTSProvider.synthesize argument validation', () => {
legacyCode: 'input_too_large',
fields: { key: 'instructions', max: 3000 },
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
@@ -446,7 +443,7 @@ describe('GeminiTTSProvider.synthesize argument validation', () => {
describe('GeminiTTSProvider.synthesize credit gate', () => {
it('throws 402 before calling Gemini when the actor lacks credits', async () => {
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => makeProvider().synthesize({ text: 'hi' })),
).rejects.toMatchObject({ statusCode: 402 });
@@ -476,10 +473,9 @@ describe('GeminiTTSProvider.synthesize credit gate', () => {
actor,
),
).rejects.toMatchObject({ statusCode: 402 });
expect(admitSpy).toHaveBeenCalledWith(
expect(hasCreditsSpy).toHaveBeenCalledWith(
actor,
FLASH_RESERVATION,
undefined,
);
expect(fetchSpy).not.toHaveBeenCalled();
expect(batchIncrementUsagesSpy).not.toHaveBeenCalled();
@@ -1369,10 +1365,9 @@ describe('GeminiTTSProvider.synthesize scheduled rates', () => {
server.clients.event.off('ai.cost.factor.*', factor);
}
expect(admitSpy).toHaveBeenCalledWith(
expect(hasCreditsSpy).toHaveBeenCalledWith(
expect.anything(),
reserved * 1.5,
undefined,
);
expect(held).toEqual([reserved * 1.5]);
expect(metered(':input').costOverride).toBe(7 * inputRate * 1.5);
@@ -84,7 +84,7 @@ vi.mock('openai', () => {
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -108,7 +108,7 @@ const mockAudioResponse = (bytes = 'opus-audio') => new Response(bytes);
beforeEach(() => {
speechCreateMock.mockReset();
openAICtor.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -205,7 +205,7 @@ describe('OpenAITTSProvider.synthesize test_mode', () => {
url: 'https://puter-sample-data.puter.site/tts_example.mp3',
content_type: 'audio',
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(speechCreateMock).not.toHaveBeenCalled();
});
});
@@ -283,7 +283,7 @@ describe('OpenAITTSProvider.synthesize argument validation', () => {
describe('OpenAITTSProvider.synthesize credit gate', () => {
it('throws 402 BEFORE hitting OpenAI when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => provider.synthesize({ text: 'hi' })),
@@ -298,9 +298,7 @@ describe('OpenAITTSProvider.synthesize credit gate', () => {
user: { id: 7, uuid: `tts-hold-${Date.now()}`, username: 'hold' },
});
const userId = actor.user!.uuid;
admitSpy.mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
hasCreditsSpy.mockResolvedValue(true);
let heldDuringCall = -1;
speechCreateMock.mockImplementationOnce(async () => {
heldDuringCall = await server.stores.creditHold.outstanding(userId);
@@ -326,9 +324,7 @@ describe('OpenAITTSProvider.synthesize credit gate', () => {
const actor = makeActor({
user: { id: 8, uuid: `tts-fail-${Date.now()}`, username: 'fail' },
});
admitSpy.mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
hasCreditsSpy.mockResolvedValue(true);
speechCreateMock.mockRejectedValueOnce(new Error('upstream down'));
await expect(
@@ -467,7 +463,7 @@ describe('OpenAITTSProvider.synthesize metering', () => {
expect(cost).toBe(expectedCost);
});
it('reserves the same total it later meters', async () => {
it('asks for hasEnoughCredits with the same total it later meters', async () => {
const provider = makeProvider();
speechCreateMock.mockResolvedValueOnce(mockAudioResponse());
@@ -477,8 +473,8 @@ describe('OpenAITTSProvider.synthesize metering', () => {
);
const expectedCost = OPENAI_TTS_COSTS['tts-1'] * text.length;
// The first reservation should match the metered cost.
const creditCall = admitSpy.mock.calls[0]!;
// First call to hasEnoughCredits should match the metered cost.
const creditCall = hasCreditsSpy.mock.calls[0]!;
expect(creditCall[1]).toBe(expectedCost);
});
});
@@ -56,7 +56,7 @@ import { SPEECHIFY_TTS_COSTS } from './costs.js';
let server: PuterServer;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -82,7 +82,7 @@ const audioResponse = (audioData = Buffer.from('audio-bytes').toString('base64')
beforeEach(() => {
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -159,7 +159,7 @@ describe('SpeechifyTTSProvider.synthesize test_mode', () => {
url: 'https://puter-sample-data.puter.site/tts_example.mp3',
content_type: 'audio',
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
@@ -206,7 +206,7 @@ describe('SpeechifyTTSProvider.synthesize argument validation', () => {
describe('SpeechifyTTSProvider.synthesize credit gate', () => {
it('throws 402 BEFORE hitting Speechify when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => provider.synthesize({ text: 'hi' })),
@@ -324,7 +324,7 @@ describe('SpeechifyTTSProvider.synthesize metering', () => {
expect(cost).toBe(expectedCost);
});
it('reserves the same total it later meters', async () => {
it('asks for hasEnoughCredits with the same total it later meters', async () => {
const provider = makeProvider();
fetchSpy.mockResolvedValueOnce(audioResponse());
@@ -332,7 +332,7 @@ describe('SpeechifyTTSProvider.synthesize metering', () => {
await withTestActor(() => provider.synthesize({ text }));
const expectedCost = SPEECHIFY_TTS_COSTS['simba-3.2'] * text.length;
expect(admitSpy.mock.calls[0]![1]).toBe(expectedCost);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(expectedCost);
});
});
@@ -56,7 +56,7 @@ import { XAI_TTS_COSTS } from './costs.js';
let server: PuterServer;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
beforeAll(async () => {
@@ -79,7 +79,7 @@ const audioResponse = (body = 'audio-bytes', contentType = 'audio/mpeg') =>
beforeEach(() => {
fetchSpy = vi.spyOn(globalThis, 'fetch') as MockInstance<typeof fetch>;
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
});
@@ -160,7 +160,7 @@ describe('XAITTSProvider.synthesize test_mode', () => {
url: 'https://puter-sample-data.puter.site/tts_example.mp3',
content_type: 'audio',
});
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
@@ -195,7 +195,7 @@ describe('XAITTSProvider.synthesize argument validation', () => {
describe('XAITTSProvider.synthesize credit gate', () => {
it('throws 402 BEFORE hitting xAI when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() => provider.synthesize({ text: 'hi' })),
@@ -327,7 +327,7 @@ describe('XAITTSProvider.synthesize metering', () => {
expect(cost).toBe(expectedCost);
});
it('reserves the same total it later meters', async () => {
it('asks for hasEnoughCredits with the same total it later meters', async () => {
const provider = makeProvider();
fetchSpy.mockResolvedValueOnce(audioResponse());
@@ -335,7 +335,7 @@ describe('XAITTSProvider.synthesize metering', () => {
await withTestActor(() => provider.synthesize({ text }));
const expectedCost = XAI_TTS_COSTS['xai-tts'] * text.length;
expect(admitSpy.mock.calls[0]![1]).toBe(expectedCost);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(expectedCost);
});
});
@@ -94,7 +94,7 @@ vi.mock('../../util/secureHttp.js', async (importOriginal) => ({
let server: PuterServer;
let driver: VideoGenerationDriver;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
beforeAll(async () => {
server = await setupTestServer({
@@ -122,10 +122,8 @@ beforeEach(() => {
togetherVideosCreateMock.mockReset();
togetherVideosRetrieveMock.mockReset();
secureFetchMock.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
admitSpy.mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
hasCreditsSpy.mockResolvedValue(true);
vi.spyOn(server.services.metering, 'getRemainingUsage').mockResolvedValue(
100_000_000_000,
);
@@ -106,7 +106,7 @@ const MP4 = Buffer.concat([
let server: PuterServer;
let videoDriver: VideoGenerationDriver;
let fetchSpy: MockInstance<typeof fetch>;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let batchSpy: MockInstance<MeteringService['batchIncrementUsages']>;
const generate = (args: Record<string, unknown> = {}) =>
@@ -139,11 +139,9 @@ beforeEach(() => {
secureFetchMock.mockReset();
secureFetchMock.mockRejectedValue(new Error('unexpected secureFetch'));
// The full hold is more than a new account's allowance.
admitSpy = vi
.spyOn(server.services.metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
hasCreditsSpy = vi
.spyOn(server.services.metering, 'hasEnoughCredits')
.mockResolvedValue(true);
batchSpy = vi.spyOn(server.services.metering, 'batchIncrementUsages');
});
@@ -591,7 +589,7 @@ describe('GeminiVideoProvider test_mode', () => {
it('returns the sample clip without network, credits or metering', async () => {
expect(await testMode()).toBe(SAMPLE_URL);
expect(fetchSpy).not.toHaveBeenCalled();
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(batchSpy).not.toHaveBeenCalled();
});
@@ -1030,7 +1028,7 @@ describe('GeminiVideoProvider source video', () => {
const path = await writeVideo(user, 'dog.mp4', MP4);
const read = vi.spyOn(server.stores.s3Object, 'getObjectStream');
admitSpy.mockResolvedValue(null);
hasCreditsSpy.mockResolvedValue(false);
countOnly();
await expect(
withActor(user.actor, () => generate({ input_video: path })),
@@ -1575,12 +1573,12 @@ describe('GeminiVideoProvider countTokens preflight', () => {
describe('GeminiVideoProvider credit hold', () => {
it('throws 402 after counting tokens, before generating', async () => {
const { actor } = await makeUser();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
fetchSpy.mockResolvedValueOnce(Response.json({ totalTokens: 18 }));
await expect(withActor(actor, () => generate())).rejects.toMatchObject({
statusCode: 402,
});
expect(admitSpy.mock.calls[0]![1]).toBe(HOLD);
expect(hasCreditsSpy.mock.calls[0]![1]).toBe(HOLD);
expect(fetchSpy).toHaveBeenCalledTimes(1);
expect(batchSpy).not.toHaveBeenCalled();
});
@@ -85,7 +85,7 @@ vi.mock('together-ai', () => {
// ── Test harness ────────────────────────────────────────────────────
let server: PuterServer;
let admitSpy: MockInstance<MeteringService['reserveCreditsIfAffordable']>;
let hasCreditsSpy: MockInstance<MeteringService['hasEnoughCredits']>;
let remainingUsageSpy: MockInstance<MeteringService['getRemainingUsage']>;
let incrementUsageSpy: MockInstance<MeteringService['incrementUsage']>;
@@ -117,13 +117,11 @@ beforeEach(() => {
videosCreateMock.mockReset();
videosRetrieveMock.mockReset();
togetherCtor.mockReset();
admitSpy = vi.spyOn(server.services.metering, 'reserveCreditsIfAffordable');
hasCreditsSpy = vi.spyOn(server.services.metering, 'hasEnoughCredits');
// Default to "has credits" so per-test setup only needs to override
// for the explicit credit-gate scenarios. SYSTEM_ACTOR has no uuid,
// so the live `getRemainingUsage` path can short-circuit to 0.
admitSpy.mockImplementation((who, amount, opts) =>
server.services.metering.reserveCredits(who, amount, opts),
);
hasCreditsSpy.mockResolvedValue(true);
remainingUsageSpy = vi.spyOn(server.services.metering, 'getRemainingUsage');
remainingUsageSpy.mockResolvedValue(AMPLE_CREDIT);
incrementUsageSpy = vi.spyOn(server.services.metering, 'incrementUsage');
@@ -199,7 +197,7 @@ describe('TogetherVideoProvider.generate test_mode', () => {
provider.generate({ prompt: 'hi', test_mode: true }),
);
expect(result).toBe('https://assets.puter.site/txt2vid.mp4');
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
expect(videosCreateMock).not.toHaveBeenCalled();
});
});
@@ -240,7 +238,7 @@ const DIRECTOR = 'togetherai:minimax/video-01-director';
describe('TogetherVideoProvider.generate credit gate', () => {
it('throws 402 BEFORE hitting Together when actor lacks credits', async () => {
const provider = makeProvider();
admitSpy.mockResolvedValueOnce(null);
hasCreditsSpy.mockResolvedValueOnce(false);
await expect(
withTestActor(() =>
@@ -717,7 +715,7 @@ describe('TogetherVideoProvider.generate per-second models', () => {
expect('height' in sent).toBe(false);
expect('ratio' in sent).toBe(false);
// The flat-rate gate is not consulted for per-second models.
expect(admitSpy).not.toHaveBeenCalled();
expect(hasCreditsSpy).not.toHaveBeenCalled();
const seedance = TOGETHER_VIDEO_GENERATION_MODELS.find(
(m) => m.model === 'ByteDance/Seedance-2.5',
@@ -188,11 +188,7 @@ describe('app.message with live delivery over the socket wire', () => {
captureBus(state.server, 'outer.gui.notif.message', async () => {
created = (await withActor(asApp(holder, app), () =>
state.driver.create(
message({
text: 'Body',
priority: 'high',
channel: 'replies',
}),
message({ text: 'Body', channel: 'replies' }),
),
)) as Record<string, unknown>;
}).then((seen) => (desktop = seen)),
@@ -204,7 +200,7 @@ describe('app.message with live delivery over the socket wire', () => {
title: 'Hello',
text: 'Body',
channel: 'replies',
priority: 'high',
priority: 'normal',
ttl: 3600,
app: { uid: app.uid, name: 'App message test' },
});
@@ -216,7 +212,6 @@ describe('app.message with live delivery over the socket wire', () => {
app_uid: app.uid,
audience: 'app-user',
type: 'app.message',
value: expect.objectContaining({ priority: 'high' }),
});
// Not silent, but sent for the app alone: the desktop wire stays quiet.
expect(written).toEqual([
@@ -225,7 +220,7 @@ describe('app.message with live delivery over the socket wire', () => {
uid,
type: 'app.message',
appUid: app.uid,
value: expect.objectContaining({ priority: 'high' }), }),
}),
]);
expect(desktop).toEqual([]);
});
@@ -207,7 +207,6 @@ describe('app.message to the other party of a share', () => {
const written = await captureBus('notif.written', async () => {
sent = await send(inApp(owner, app), {
title: 'New message',
priority: 'high',
to: { handle },
});
});
@@ -223,7 +222,7 @@ describe('app.message to the other party of a share', () => {
expect(row!.value).toEqual({
type: 'app.message',
title: 'New message',
priority: 'high',
priority: 'normal',
ttl: 3600,
app: { uid: app.uid, name: 'Handle App' },
});
@@ -165,7 +165,6 @@ const fakeSchedules = (plan: Partial<DeferredSendPlan>) =>
createFor: vi.fn(),
list: vi.fn(),
get: vi.fn(),
update: vi.fn(),
remove: vi.fn(),
receivePeerChanges: vi.fn(),
prepareSendAt: vi.fn(async (): Promise<DeferredSendPlan> => ({
@@ -271,9 +270,7 @@ describe('notify({ sendAt }) with services.schedules', () => {
const schedules = fakeSchedules({ sendAt: at });
setSchedules(schedules);
await expect(
notify({ sendAt: at, text: 'later', priority: 'high' }),
).resolves.toEqual({
await expect(notify({ sendAt: at, text: 'later' })).resolves.toEqual({
scheduled: { scheduleId: 'sched-1', sendAt: at },
});
expect(schedules.prepareSendAt).toHaveBeenCalledWith(
@@ -286,7 +283,6 @@ describe('notify({ sendAt }) with services.schedules', () => {
message: expect.objectContaining({
title: 'Hi',
text: 'later',
priority: 'high',
}),
},
);
@@ -322,20 +318,11 @@ describe('deferredAppMessages.write', () => {
const key = uuidv4();
const id = await claimed(token);
await expect(
write(key, txFor(id, token), {
payload: JSON.stringify({
message: { title: 'Later', priority: 'high' },
}),
}),
).resolves.toBe('delivered');
await expect(write(key, txFor(id, token))).resolves.toBe('delivered');
const rows = await mailbox();
expect(rows).toHaveLength(1);
expect(rows[0]).toMatchObject({ uid: key, send_key: key });
expect(valueOf(rows[0])).toMatchObject({
title: 'Later',
priority: 'high',
});
expect(valueOf(rows[0])).toMatchObject({ title: 'Later' });
});
it('writes nothing when the guard no longer holds: another claim took it', async () => {
@@ -859,32 +859,3 @@ describe('NotificationDriver — rows written before the scope columns', () => {
expect(await selectUids(holder.actor)).toEqual([uid]);
});
});
describe('NotificationDriver displayed notification catch-up', () => {
it('selects named ids within the app and user scope', async () => {
const box = await mailbox();
await server.services.notification.markAcknowledged(box.rows.appUser, box.holder.userId);
const rows = await withActor(box.ownAppActor, () => driver.select({
subject: 'notif:app-user',
uids: Object.values(box.rows),
limit: 50,
}));
expect(rows).toEqual([expect.objectContaining({
uid: box.rows.appUser, acknowledged: expect.any(Number),
})]);
});
it.each([Array(51).fill('one'), [''], [7], 'one', ['x'.repeat(129)]])(
'rejects an invalid or oversized id batch: %s', async (uids) => {
const { actor } = await makeUser();
await expect(withActor(actor, () => driver.select({ uids })))
.rejects.toMatchObject({ statusCode: 400 });
},
);
it('returns no rows for an empty id batch', async () => {
const { actor } = await makeUser();
expect(await withActor(actor, () => driver.select({ uids: [] }))).toEqual([]);
});
});
@@ -46,7 +46,7 @@ import {
ownedAppUids,
} from '../../services/notification/notificationAudience.js';
import {
assertNotificationValueFits,
NOTIFICATION_VALUE_MAX_BYTES,
OUTSIDE_ACCOUNT_MAILBOX_TYPES,
resolveNotificationWrite,
type NotificationTypeName,
@@ -120,6 +120,19 @@ interface MailboxScope {
appUid: string | null | undefined;
}
const assertValueFits = (value: Record<string, unknown>): void => {
if (
Buffer.byteLength(JSON.stringify(value), 'utf8') >
NOTIFICATION_VALUE_MAX_BYTES
) {
throw new HttpError(
400,
`\`value\` may not exceed ${NOTIFICATION_VALUE_MAX_BYTES} bytes`,
{ legacyCode: 'notification_value_too_large' },
);
}
};
const typeNotAllowed = (message: string): HttpError =>
new HttpError(403, message, {
legacyCode: 'forbidden',
@@ -264,7 +277,7 @@ export class NotificationDriver extends PuterDriver {
value,
);
}
assertNotificationValueFits(value);
assertValueFits(value);
if (type === APP_MESSAGE_TYPE) {
throw typeNotAllowed(`Only apps can create ${APP_MESSAGE_TYPE}`);
}
@@ -329,34 +342,13 @@ export class NotificationDriver extends PuterDriver {
: predicate;
const scope = this.#resolveScope(actor, args.subject);
const uids = args.uids;
if (
uids !== undefined &&
(!Array.isArray(uids) ||
uids.length > 50 ||
uids.some(
(uid) =>
typeof uid !== 'string' ||
uid.length === 0 ||
uid.length > 128,
))
) {
throw new HttpError(
400,
'uids must contain at most 50 notification ids',
{
legacyCode: 'bad_request',
},
);
}
const query: {
limit: number;
scope: MailboxScope | null;
filter?: string;
onlyUnacknowledged?: boolean;
excludeTypes?: readonly string[];
uids?: string[];
} = { limit, scope, ...(uids ? { uids: uids as 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.
@@ -438,7 +430,7 @@ export class NotificationDriver extends PuterDriver {
}
const handle = to === undefined ? undefined : parseNotifyTarget(to);
const message = parseAppMessage(fields);
assertNotificationValueFits(value);
assertValueFits(value);
const timing =
sendAt === undefined || sendAt === null
? null
@@ -547,7 +539,9 @@ export class NotificationDriver extends PuterDriver {
};
}
/** For extensions. A field, not a method, so `/drivers/call` can't reach it. */
/**
* For extensions. A field, not a method, so `/drivers/call` can't reach it.
*/
readonly deferredAppMessages = {
write: (input: DeferredWriteInput, tx: DeferredWriteTx) =>
this.#writeDeferredAppMessage(input, tx),
+29 -89
View File
@@ -324,10 +324,8 @@ describe('AI cost factor', () => {
it('gates and holds at the factored cost', async () => {
listen(1.3);
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
const reserve = vi.spyOn(metering, 'reserveCredits');
try {
const hold = await scoped.reserveAiCredits(
@@ -336,11 +334,7 @@ describe('AI cost factor', () => {
1000,
);
await hold?.release();
expect(check).toHaveBeenCalledExactlyOnceWith(
actor,
1300,
undefined,
);
expect(check).toHaveBeenCalledWith(actor, 1300);
expect(reserve).toHaveBeenCalledWith(actor, 1300, undefined);
} finally {
check.mockRestore();
@@ -348,40 +342,10 @@ describe('AI cost factor', () => {
}
});
it('admits one of two concurrent holds the balance only covers once', async () => {
listen(1.3);
vi.spyOn(metering, 'getAllowedUsage').mockResolvedValue({
remaining: 20_000_000,
monthUsageAllowance: 20_000_000,
addons: {},
});
const holds = await Promise.all(
[0, 1].map(() =>
scoped.reserveAiCredits(
actor,
'openai:gpt-realtime:realtime:audio_output',
12_500_000,
),
),
);
try {
expect(holds.filter((h) => h !== null)).toHaveLength(1);
// The factor applies once: 12.5M at 1.3 is 16.25M held.
expect(await metering.getOutstandingHolds(actor)).toBe(
16_250_000,
);
} finally {
await Promise.all(holds.map((h) => h?.release()));
vi.restoreAllMocks();
}
});
it('passes a hold lifetime through to the service', async () => {
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
const reserve = vi.spyOn(metering, 'reserveCredits');
try {
const hold = await scoped.reserveAiCredits(
@@ -403,12 +367,8 @@ describe('AI cost factor', () => {
it('takes no hold when the factored cost is unaffordable', async () => {
listen(1.3);
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation(async (who, amount, opts) =>
amount <= 1000
? metering.reserveCredits(who, amount, opts)
: null,
);
.spyOn(metering, 'hasEnoughCredits')
.mockImplementation(async (_actor, amount) => amount <= 1000);
const reserve = vi.spyOn(metering, 'reserveCredits');
try {
const hold = await scoped.reserveAiCredits(
@@ -449,10 +409,8 @@ describe('AI cost factor', () => {
it('holds the factored cost while run executes, then releases it', async () => {
listen(1.3);
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
try {
let heldDuringRun = 0;
const result = await withAiCreditHold(
@@ -490,10 +448,8 @@ describe('AI cost factor', () => {
};
server.clients.event.on('ai.cost.factor.*', slowFactor as never);
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
try {
await runWithContext({ actor }, () =>
withAiCreditHold(
@@ -529,10 +485,8 @@ describe('AI cost factor', () => {
it('releases the hold when the usage write fails', async () => {
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
const write = vi
.spyOn(metering, 'incrementUsage')
.mockRejectedValueOnce(new Error('ledger down'));
@@ -561,10 +515,8 @@ describe('AI cost factor', () => {
it('releases at once when nothing was recorded', async () => {
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
try {
await runWithContext({ actor }, () =>
withAiCreditHold(
@@ -583,10 +535,8 @@ describe('AI cost factor', () => {
it('releases the hold when run throws', async () => {
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
const boom = new Error('upstream down');
try {
await expect(
@@ -602,8 +552,8 @@ describe('AI cost factor', () => {
it('refuses with a 402 and never runs when the cost is unaffordable', async () => {
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockResolvedValue(null);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(false);
const run = vi.fn();
try {
await expect(
@@ -625,10 +575,8 @@ describe('AI cost factor', () => {
const relay = async (source: Readable) => {
const record = vi.fn();
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
try {
const result = await withStreamedAiCharge(
scoped,
@@ -676,10 +624,8 @@ describe('AI cost factor', () => {
landCharge = resolve;
});
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
try {
const result = await withStreamedAiCharge(
scoped,
@@ -709,10 +655,8 @@ describe('AI cost factor', () => {
vi.useFakeTimers({ toFake: ['setInterval', 'clearInterval'] });
const refresh = vi.spyOn(server.stores.creditHold, 'refresh');
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
let landCharge = () => {};
const charge = new Promise<void>((resolve) => {
landCharge = resolve;
@@ -753,10 +697,8 @@ describe('AI cost factor', () => {
vi.useFakeTimers({ toFake: ['setInterval', 'clearInterval'] });
const refresh = vi.spyOn(server.stores.creditHold, 'refresh');
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
let opened = () => {};
const opening = new Promise<void>((resolve) => {
opened = resolve;
@@ -799,10 +741,8 @@ describe('AI cost factor', () => {
it('releases the hold when recording the charge throws', async () => {
const check = vi
.spyOn(metering, 'reserveCreditsIfAffordable')
.mockImplementation((who, amount, opts) =>
metering.reserveCredits(who, amount, opts),
);
.spyOn(metering, 'hasEnoughCredits')
.mockResolvedValue(true);
try {
const result = await withStreamedAiCharge(
scoped,
+3 -5
View File
@@ -354,12 +354,10 @@ export function withAiCostFactor(
? await costFactor(actor, aiModelKey(usageType))
: 1;
const cost = factor === 1 ? amount : scaleCost(amount, factor);
const hold = await metering.reserveCreditsIfAffordable(
actor,
cost,
opts,
if (!(await metering.hasEnoughCredits(actor, cost))) return null;
return outlastingWrites(
await metering.reserveCredits(actor, cost, opts),
);
return hold && outlastingWrites(hold);
};
const reserveCredits = async (
-269
View File
@@ -336,110 +336,6 @@ describe('PuterServer host header validation', () => {
expect(api.headers['x-frame-options']).toBeUndefined();
});
it('allows deployment subdomains to frame the app browser embed', async () => {
const parent = `http://spreadsheet.puter.localhost:${port}`;
for (const path of ['/embed/apps', '/embed/apps/']) {
const res = await request(path, {
host: `puter.localhost:${port}`,
referer: `${parent}/sheet/1`,
});
expect(res.status).toBe(200);
expect(res.headers['x-frame-options']).toBeUndefined();
expect(res.headers['content-security-policy']).toBe(
`frame-ancestors 'self' ${parent}`,
);
expect(res.headers['cache-control']).toBe('no-store');
expect(res.body).toContain('/dist/apps-embed.min.js');
expect(res.body).not.toContain('/dist/bundle.min.js');
expect(res.body).toContain(`http://api.puter.localhost:${port}`);
const config = JSON.parse(
res.body.match(/id="app-browser-config">(.*?)<\/script>/)[1],
);
expect(Array.isArray(config.guestApps)).toBe(true);
}
const gui = await request('/embed/apps', {
host: `puter.localhost:${port}`,
referer: `http://puter.localhost:${port}/dashboard`,
});
expect(gui.headers['content-security-policy']).toBe("frame-ancestors 'self'");
const dashboard = await request('/dashboard', { host: `puter.localhost:${port}` });
expect(dashboard.headers['x-frame-options']).toBe('SAMEORIGIN');
const api = await request('/embed/apps', { host: `api.puter.localhost:${port}` });
expect(api.status).toBe(404);
});
it('lets a deployment subdomain frame the feedback embed and names it', async () => {
const parent = `http://spreadsheet.puter.localhost:${port}`;
const res = await request('/embed/feedback', {
host: `puter.localhost:${port}`,
referer: `${parent}/sheet/1`,
});
expect(res.status).toBe(200);
expect(res.headers['x-frame-options']).toBeUndefined();
expect(res.headers['content-security-policy']).toBe(
`frame-ancestors 'self' ${parent}`,
);
expect(res.headers['cache-control']).toBe('no-store');
expect(res.body).toContain('/dist/feedback-embed.min.js');
expect(res.body).not.toContain('/dist/bundle.min.js');
const config = JSON.parse(
res.body.match(/id="feedback-embed-config">(.*?)<\/script>/)[1],
);
expect(config).toEqual({
apiOrigin: `http://api.puter.localhost:${port}`,
hostOrigin: parent,
});
const hosted = await request('/embed/feedback', {
host: `puter.localhost:${port}`,
referer: `http://someone.site.puter.localhost:${port}/`,
});
expect(hosted.headers['content-security-policy']).toBe("frame-ancestors 'self'");
expect(
JSON.parse(
hosted.body.match(/id="feedback-embed-config">(.*?)<\/script>/)[1],
).hostOrigin,
).toBeNull();
const redirected = await request('/embed/feedback?puter.api_origin=https://other.test', {
host: `puter.localhost:${port}`,
});
expect(redirected.status).toBe(302);
expect(redirected.headers.location).toBe('/embed/feedback');
});
it.each([
['a user-hosted site', 'http://someone.site.puter.localhost:PORT/'],
['a private app host', 'http://someone.app.puter.localhost:PORT/'],
['the API host', 'http://api.puter.localhost:PORT/'],
['the WebDAV host', 'http://dav.puter.localhost:PORT/'],
['a native app host', 'http://about.puter.localhost:PORT/'],
['a nested subdomain', 'http://a.spreadsheet.puter.localhost:PORT/'],
['another site', 'http://evil.test:PORT/'],
['another port', 'http://spreadsheet.puter.localhost:1/'],
['a suppressed referrer', undefined],
])('keeps the embed same-origin only when framed by %s', async (_label, referer) => {
const res = await request('/embed/apps', {
host: `puter.localhost:${port}`,
...(referer ? { referer: referer.replace('PORT', String(port)) } : {}),
});
expect(res.status).toBe(200);
expect(res.headers['content-security-policy']).toBe("frame-ancestors 'self'");
});
it.each([
['plain', ''],
// Past the parser's 1000-pair limit, so `req.query` comes back empty.
['padded', '&'.repeat(1000)],
])('strips %s SDK bootstrap query parameters from the embed route', async (_label, padding) => {
const res = await request(`/embed/apps?${padding}puter.app_instance_id=other&puter.api_origin=https://other.test`, {
host: `puter.localhost:${port}`,
});
expect(res.status).toBe(302);
expect(res.headers.location).toBe('/embed/apps');
expect(res.headers['x-frame-options']).toBe('SAMEORIGIN');
});
it('blocks a request the ip.validate listeners veto', async () => {
const handler = (_key: unknown, data: unknown) => {
(data as { allow: boolean }).allow = false;
@@ -1596,104 +1492,6 @@ describe('PuterServer keep-alive timeout', () => {
});
describe('PuterServer lifecycle hooks', () => {
it('fails startup before running later hooks when a start hook rejects', async () => {
const failure = new Error('startup failed');
const later = vi.fn();
class FailingStart extends JobScheduler {
override async onServerStart() {
throw failure;
}
}
class LaterStart extends JobScheduler {
override async onServerStart() {
later();
}
}
extension.registerService('failingStart', FailingStart as never);
extension.registerService('laterStart', LaterStart as never);
try {
await expect(setupTestServer()).rejects.toBe(failure);
expect(later).not.toHaveBeenCalled();
} finally {
delete (extensionStore.services as Record<string, unknown>)
.failingStart;
delete (extensionStore.services as Record<string, unknown>)
.laterStart;
}
});
it.each([false, true])(
'continues teardown after failing hooks with listener callback %s',
async (prepareFirst) => {
const port = await allocateEphemeralPort();
const server = await setupTestServer(
{ port } as unknown as IConfig,
{ listen: true },
);
const logged = vi
.spyOn(console, 'error')
.mockImplementation(() => {});
const ran: string[] = [];
class FailingHooks {
onServerPrepareShutdown() {
ran.push('prepare:failed');
throw new Error('prepare failed');
}
async onServerShutdown() {
ran.push('shutdown:failed');
throw new Error('shutdown failed');
}
}
(server.services as Record<string, unknown>).fails =
new FailingHooks();
(server.services as Record<string, unknown>).after = {
onServerPrepareShutdown: () => ran.push('prepare:after'),
onServerShutdown: () => ran.push('shutdown:after'),
};
(server.clients as Record<string, unknown>).last = {
onServerShutdown: () => ran.push('shutdown:client'),
};
try {
if (prepareFirst) {
await server.prepareShutdown();
await vi.waitFor(() =>
expect(ran).toContain('prepare:after'),
);
}
await server.shutdown();
expect(ran).toEqual([
'prepare:failed',
'prepare:after',
'shutdown:failed',
'shutdown:after',
'shutdown:client',
]);
expect(logged).toHaveBeenCalledWith(
'[server] onServerPrepareShutdown failed in FailingHooks',
expect.any(Error),
);
expect(logged).toHaveBeenCalledWith(
'[server] onServerShutdown failed in FailingHooks',
expect.any(Error),
);
await expect(
new Promise<void>((resolve, reject) => {
const socket = net.connect(port, '127.0.0.1');
socket.on('connect', () => {
socket.destroy();
resolve();
});
socket.on('error', reject);
}),
).rejects.toMatchObject({ code: 'ECONNREFUSED' });
} finally {
delete (server.services as Record<string, unknown>).fails;
await server.shutdown();
logged.mockRestore();
}
},
);
it('runs drain-start and prepare-shutdown bottom-up, once, before tearing down', async () => {
const port = await allocateEphemeralPort();
const server = await setupTestServer({ port } as unknown as IConfig, {
@@ -1743,73 +1541,6 @@ describe('PuterServer lifecycle hooks', () => {
'shutdown:client',
]);
});
it('keeps accepting connections until every drain-start hook settles, without one holding up another', async () => {
const port = await allocateEphemeralPort();
const server = await setupTestServer({ port } as unknown as IConfig, {
listen: true,
});
let release!: () => void;
const held = new Promise<void>((resolve) => (release = resolve));
let otherRan = false;
(server.services as unknown as Record<string, unknown>).holdsListener =
{ onServerDrainStart: () => held };
(server.drivers as unknown as Record<string, unknown>).other = {
onServerDrainStart: () => {
otherRan = true;
},
};
const connect = () =>
new Promise<void>((resolve, reject) => {
const socket = net.connect(port, '127.0.0.1');
socket.on('connect', () => {
socket.destroy();
resolve();
});
socket.on('error', reject);
});
const prepared = server.prepareShutdown({ drainMs: 1_000 });
await new Promise((resolve) => setTimeout(resolve, 20));
expect(otherRan).toBe(true);
await expect(connect()).resolves.toBeUndefined();
release();
await prepared;
await expect(connect()).rejects.toMatchObject({
code: 'ECONNREFUSED',
});
await server.shutdown();
});
it('runs every drain-start hook when one of them throws', async () => {
const port = await allocateEphemeralPort();
const server = await setupTestServer({ port } as unknown as IConfig, {
listen: true,
});
vi.spyOn(console, 'error').mockImplementation(() => {});
const ran: string[] = [];
(server.stores as unknown as Record<string, unknown>).fails = {
onServerDrainStart: () => {
throw new Error('drain hook failed');
},
};
(server.services as unknown as Record<string, unknown>).after = {
onServerDrainStart: () => {
ran.push('after');
},
};
await server.prepareShutdown({ drainMs: 1_000 });
await server.shutdown();
expect(ran).toEqual(['after']);
expect(console.error).toHaveBeenCalledWith(
expect.stringContaining('onServerDrainStart failed'),
expect.any(Error),
);
});
});
describe('PuterServer shutdown during prepare', () => {
+13 -47
View File
@@ -1743,7 +1743,12 @@ export class PuterServer {
*/
async #runHook(
order: 'bottomUp' | 'topDown',
hook: 'onServerStart' | 'onServerPrepareShutdown' | 'onServerShutdown',
hook:
| 'onServerStart'
| 'onServerDrainStart'
| 'onServerPrepareShutdown'
| 'onServerShutdown',
info?: ServerDrainInfo,
) {
const layers = [
this.clients,
@@ -1755,47 +1760,11 @@ export class PuterServer {
if (order === 'topDown') layers.reverse();
for (const layer of layers) {
for (const instance of Object.values(layer) as WithLifecycle[]) {
try {
await instance[hook]?.();
} catch (err) {
if (hook === 'onServerStart') throw err;
console.error(
`[server] ${hook} failed in ${instance.constructor.name}`,
err,
);
}
await instance[hook]?.(info);
}
}
}
/**
* Run every `onServerDrainStart` concurrently, so one hook holding the
* listener open doesn't delay the others, and one failing doesn't skip the
* rest.
*/
async #runDrainStartHooks(info: ServerDrainInfo) {
const instances = [
this.clients,
this.stores,
this.services,
this.controllers,
this.drivers,
].flatMap((layer) => Object.values(layer) as WithLifecycle[]);
const results = await Promise.allSettled(
instances.map(async (instance) =>
instance.onServerDrainStart?.(info),
),
);
results.forEach((result, i) => {
if (result.status === 'rejected') {
console.error(
`[server] onServerDrainStart failed in ${instances[i].constructor.name}`,
result.reason,
);
}
});
}
#prepareShutdownHooks: Promise<void> | null = null;
/**
@@ -1813,19 +1782,16 @@ export class PuterServer {
async prepareShutdown(info: ServerDrainInfo = {}) {
if (this.#server) {
await this.#runDrainStartHooks(info);
try {
await this.#runHook('bottomUp', 'onServerDrainStart', info);
} catch (err) {
console.error('[server] onServerDrainStart failed', err);
}
this.#server.close(async () => {
console.log(
'PuterServer has stopped accepting new connections',
);
try {
await this.#runPrepareShutdownHooks();
} catch (err) {
console.error(
'[server] prepare-shutdown hooks failed',
err,
);
}
await this.#runPrepareShutdownHooks();
});
}
}
@@ -27,16 +27,17 @@ import { PuterService } from '../types.js';
*/
export const RECOMMENDED_APP_NAMES = [
'builder',
'word-processor',
'spreadsheet',
'presentation',
'whiteboard',
'pdf-editor',
'contacts',
'calendar',
'meetings',
'teamchat',
'email',
'whiteboard',
'spreadsheet',
'word-processor',
'presentation',
'pdf-editor',
'terminal',
'dev-center',
'cap-table',
'invoices',
+1 -1
View File
@@ -2864,7 +2864,7 @@ export class AuthService extends PuterService {
#actorUserFromRow(user: UserRow) {
// Strip the password hash; pass everything else through so callers
// can read metadata, desktop_bg_*, otp_enabled, etc. without
// can read metadata, otp_enabled, etc. without
// re-fetching the user. Mirrors what /whoami exposes off of UserRow.
const { password: _password, ...rest } = user;
return {
@@ -1149,154 +1149,3 @@ describe('BroadcastService — same-cluster pub/sub fan-out', () => {
}
});
});
describe('BroadcastService shutdown drain', () => {
let server: PuterServer;
let broadcast: BroadcastService;
beforeEach(async () => {
axiosRequestMock.mockReset();
axiosRequestMock.mockResolvedValue({ status: 200, data: 'ok' });
server = await setupTestServer({
broadcast: {
webhook: { peerId: SELF_PEER_ID, secret: SELF_SECRET },
peers: [
{
peerId: PEER_ID,
webhook: true,
webhook_url: PEER_URL,
webhook_secret: PEER_SECRET,
},
],
outbound_flush_ms: 10,
},
} as never);
broadcast = server.services.broadcast as unknown as BroadcastService;
});
afterEach(async () => {
vi.useRealTimers();
await broadcast.onServerPrepareShutdown();
await broadcast.onServerShutdown();
await server.shutdown();
});
const emit = (hash: string) =>
server.clients.event.emit(
'outer.fs.write-hash' as never,
{ hash, uuid: hash } as never,
{},
);
it.each(['onServerPrepareShutdown', 'onServerShutdown'] as const)(
'waits for the active flush and sends its tail in %s',
async (hook) => {
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
let releaseTail!: () => void;
const tailHeld = new Promise<void>((resolve) => {
releaseTail = resolve;
});
axiosRequestMock
.mockImplementationOnce(async () => {
await held;
return { status: 200, data: 'ok' };
})
.mockImplementationOnce(async () => {
await tailHeld;
return { status: 200, data: 'ok' };
});
emit('first');
await vi.waitFor(() =>
expect(axiosRequestMock).toHaveBeenCalledTimes(1),
);
emit('tail');
let finished = false;
const draining = broadcast[hook]().then(() => {
finished = true;
});
try {
await new Promise((resolve) => setTimeout(resolve, 20));
expect(finished).toBe(false);
release();
await vi.waitFor(() =>
expect(axiosRequestMock).toHaveBeenCalledTimes(2),
);
expect(finished).toBe(false);
} finally {
release();
releaseTail();
await draining;
}
expect(axiosRequestMock).toHaveBeenCalledTimes(2);
expect(axiosRequestMock.mock.calls[1][0].data).toContain('tail');
},
);
it('keeps normal timer flushing after prepare on an idle server', async () => {
await broadcast.onServerPrepareShutdown();
vi.useFakeTimers();
axiosRequestMock.mockClear();
emit('during-drain');
await vi.advanceTimersByTimeAsync(10);
expect(axiosRequestMock).toHaveBeenCalledTimes(1);
expect(axiosRequestMock.mock.calls[0][0].data).toContain(
'during-drain',
);
});
it('sends events queued after prepare during shutdown and clears the timer', async () => {
await broadcast.onServerPrepareShutdown();
vi.useFakeTimers();
axiosRequestMock.mockClear();
emit('after-prepare');
await broadcast.onServerShutdown();
expect(axiosRequestMock).toHaveBeenCalledTimes(1);
expect(axiosRequestMock.mock.calls[0][0].data).toContain(
'after-prepare',
);
axiosRequestMock.mockClear();
await vi.advanceTimersByTimeAsync(100);
expect(axiosRequestMock).not.toHaveBeenCalled();
});
it.each(['onServerPrepareShutdown', 'onServerShutdown'] as const)(
'bounds a hung flush in %s',
async (hook) => {
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
axiosRequestMock.mockImplementationOnce(async () => {
await held;
return { status: 200, data: 'ok' };
});
emit('hung');
await vi.waitFor(() =>
expect(axiosRequestMock).toHaveBeenCalledTimes(1),
);
vi.useFakeTimers();
emit('tail');
let finished = false;
const draining = broadcast[hook]().then(() => {
finished = true;
});
try {
await vi.advanceTimersByTimeAsync(4_999);
expect(finished).toBe(false);
await vi.advanceTimersByTimeAsync(1);
await draining;
release();
await vi.advanceTimersByTimeAsync(100);
expect(axiosRequestMock).toHaveBeenCalledTimes(
hook === 'onServerPrepareShutdown' ? 2 : 1,
);
} finally {
release();
vi.useRealTimers();
}
},
);
});
@@ -21,8 +21,6 @@ import axios from 'axios';
import { createHmac, randomUUID, timingSafeEqual } from 'node:crypto';
import { Agent as HttpsAgent } from 'node:https';
import { IBroadcastPeerConfig } from '../../types.js';
import { settleWithin } from '../../util/concurrency.js';
import { FINAL_FLUSH_TIMEOUT_MS } from '../../util/gracefulShutdown.js';
import { PuterService } from '../types.js';
// -- Wire types ------------------------------------------------------
@@ -123,8 +121,7 @@ export class BroadcastService extends PuterService {
/** Per peer, serialized events it has not accepted yet, oldest first. */
#outboundBacklogs = new Map<IBroadcastPeerConfig, string[]>();
#outboundFlushTimer: ReturnType<typeof setTimeout> | null = null;
#outboundFlush: Promise<void> | null = null;
#outboundDraining = false;
#outboundIsFlushing = false;
#webhookReplayWindowSeconds = 300;
#outboundFlushMs = 2000;
@@ -168,40 +165,21 @@ export class BroadcastService extends PuterService {
}
override async onServerPrepareShutdown(): Promise<void> {
await this.#drainOutboundEvents();
if (this.#redisSub) {
try {
await this.#redisSub.unsubscribe('pubsub');
this.#redisSub.quit();
} catch (err) {
console.warn('[broadcast] unsubscribe failed', err);
} finally {
this.#redisSub = null;
}
}
}
override async onServerShutdown(): Promise<void> {
this.#outboundDraining = true;
await this.#drainOutboundEvents();
}
async #drainOutboundEvents(): Promise<void> {
if (this.#outboundFlushTimer) {
clearTimeout(this.#outboundFlushTimer);
this.#outboundFlushTimer = null;
}
const deadline = Date.now() + FINAL_FLUSH_TIMEOUT_MS;
const drain = async () => {
try {
await this.#outboundFlush;
if (Date.now() < deadline) await this.#flushOutboundEvents();
} catch (err) {
console.warn('[broadcast] final flush failed', err);
}
};
if (!(await settleWithin(drain(), FINAL_FLUSH_TIMEOUT_MS))) {
console.warn('[broadcast] final flush timed out');
// Best-effort drain — try one final flush so events queued near
// shutdown make it out.
try {
await this.#flushOutboundEvents();
} catch (err) {
console.warn('[broadcast] final flush failed', err);
}
if (this.#redisSub) {
await this.#redisSub.unsubscribe('pubsub');
this.#redisSub.quit();
this.#redisSub = null;
}
}
@@ -475,27 +453,24 @@ export class BroadcastService extends PuterService {
}
#scheduleOutboundFlush(): void {
if (this.#outboundDraining || this.#outboundFlushTimer) return;
this.#outboundFlushTimer = setTimeout(async () => {
if (this.#outboundFlushTimer) return;
this.#outboundFlushTimer = setTimeout(() => {
this.#outboundFlushTimer = null;
try {
await this.#flushOutboundEvents();
} catch (err) {
void this.#flushOutboundEvents().catch((err) => {
console.warn('[broadcast] outbound flush failed', err);
}
});
}, this.#outboundFlushMs);
}
#flushOutboundEvents(): Promise<void> {
if (this.#outboundFlush) return this.#outboundFlush;
if (this.#outboundQueue.size === 0 && this.#outboundBacklogs.size === 0)
return Promise.resolve();
async #flushOutboundEvents(): Promise<void> {
if (
this.#outboundIsFlushing ||
(this.#outboundQueue.size === 0 &&
this.#outboundBacklogs.size === 0)
)
return;
this.#outboundFlush = this.#sendOutboundEvents();
return this.#outboundFlush;
}
async #sendOutboundEvents(): Promise<void> {
this.#outboundIsFlushing = true;
try {
const fresh = this.#outboundQueue;
this.#outboundQueue = new Set();
@@ -529,7 +504,7 @@ export class BroadcastService extends PuterService {
for (const result of flushed)
if (result.status === 'rejected') throw result.reason;
} finally {
this.#outboundFlush = null;
this.#outboundIsFlushing = false;
// Anything that arrived during flush, or is still owed to a peer,
// gets the next tick.
if (
+29 -107
View File
@@ -56,7 +56,6 @@ import {
} from '../../core/actor.js';
import { HttpError, isHttpError } from '../../core/http/HttpError.js';
import type {
SqlGuard,
ScheduleEndReason,
ScheduleSubscriptionChange,
} from '../../core/schedules.js';
@@ -247,7 +246,6 @@ import {
isNotifToken,
kvHandleFromSubject,
kvHandleMatchFromSubject,
notifAnchorToken,
notifMatchSpansEveryApp,
parseSubject,
type FsOp,
@@ -682,7 +680,6 @@ export interface KvDispatchOptions {
/** One persisted notification, as the bus reports it. */
export interface NotifDispatchInput {
dismissed?: true;
/** The recipient, whose mailbox is the anchor. */
userId: number;
userUuid: string;
@@ -918,7 +915,7 @@ const scheduleSubscription = (): HttpError =>
const scheduleImmutable = (): HttpError =>
new HttpError(
400,
"Use updateSchedule() to change a schedule's context or timing",
"A schedule's context can't be changed; remove the schedule and create a new one",
{ legacyCode: 'events_schedule_immutable' },
);
@@ -1667,26 +1664,6 @@ export class EventsService extends PuterService {
});
});
this.clients.event.on('notif.acknowledged', (_key, data) => {
if (!this.notificationsFoldIn) return;
void (async () => {
const user = await this.stores.user.getById(data.userId);
if (!user?.uuid) return;
await this.dispatchNotif({
...data,
userUuid: user.uuid,
value: {},
createdAt: Date.now(),
dismissed: true,
});
})().catch((err) => {
console.warn(
'[events] notification dismissal dispatch failed',
err,
);
});
});
this.#armPendingSweep();
if (this.enabled) this.#registerJobs();
}
@@ -2893,7 +2870,6 @@ export class EventsService extends PuterService {
override?: readonly SuspendedReason[];
/** What a schedule ended by this records instead of `reason`. */
scheduleEndReason?: ScheduleEndReason;
guard?: SqlGuard;
} = {},
): Promise<DurableSubscription[]> {
if (rows.length === 0) return [];
@@ -2901,7 +2877,6 @@ export class EventsService extends PuterService {
const { suspended, bumps } =
await this.stores.durableSubscription.suspend(rows, reason, {
override: opts.override,
guard: opts.guard,
});
const policy = backlogPolicyFor(reason);
for (const row of suspended) {
@@ -3017,14 +2992,8 @@ export class EventsService extends PuterService {
* retry path's; this is the state it drives, and the developer is told
* because it is their code that stopped working. Called by extensions.
*/
async suspendForFailures(
subId: string,
guard?: SqlGuard,
): Promise<boolean> {
return this.#suspendOne(subId, 'failures', {
notifyDeveloper: true,
guard,
});
async suspendForFailures(subId: string): Promise<boolean> {
return this.#suspendOne(subId, 'failures', { notifyDeveloper: true });
}
/**
@@ -3699,16 +3668,13 @@ export class EventsService extends PuterService {
async #suspendOne(
subId: string,
reason: SuspendedReason,
options: { notifyDeveloper: boolean; guard?: SqlGuard },
options: { notifyDeveloper: boolean },
): Promise<boolean> {
if (!this.enabled) return false;
const row = await this.stores.durableSubscription.getBySubId(subId);
if (!row || row.suspendedAt !== null) return false;
const suspended = await this.#suspend([row], reason, {
guard: options.guard,
});
if (suspended.length === 0) return false;
await this.suspendSubscriptions([row], reason);
if (options.notifyDeveloper && row.appUid && row.handlerName)
await this.#notifySuspended(scopeOfRow(row), row.handlerName, 1);
return true;
@@ -4588,42 +4554,27 @@ export class EventsService extends PuterService {
return { matched, tokens };
}
if (item.family === 'notif' && item.notif) {
const input = {
...item.notif,
userId: item.ownerUserId,
createdAt: item.ts,
};
const matched = await this.dispatchNotif(input, {
forwarded: true,
id: item.id,
});
return { matched, tokens: [notifAnchorToken(item.notif.userUuid)] };
}
return { matched: false, tokens: [] };
}
/**
* Publish a posting or dismissal to the same mailbox audience. Postings
* also reach the desktop's wire; forwarded copies evaluate session rows
* only.
* Publish one persisted notification: the desktop's wire first, because
* that is what a person is waiting on, then whatever subscriptions asked
* for this slice of the mailbox.
*
* The fan-out is one token — a notification is addressed to a person — so
* there is no tree to walk and nothing to coalesce against.
*/
async dispatchNotif(
input: NotifDispatchInput,
options: { forwarded?: boolean; id?: string } = {},
): Promise<boolean> {
if (!this.notificationsFoldIn) return false;
async dispatchNotif(input: NotifDispatchInput): Promise<void> {
if (!this.notificationsFoldIn) return;
const subject = lookupNotifSubject('notif.created');
if (!subject) return false;
if (!subject) return;
const userId = input?.userId;
if (typeof userId !== 'number' || !input.userUuid || !input.uid)
return false;
if (typeof userId !== 'number' || !input.userUuid || !input.uid) return;
const context: NotifEventContext = {
key: input.dismissed ? 'notif.acknowledged' : 'notif.created',
...(input.dismissed ? { dismissed: true as const } : {}),
key: 'notif.created',
userId,
userUuid: input.userUuid,
uid: input.uid,
@@ -4631,9 +4582,9 @@ export class EventsService extends PuterService {
audience: (input.audience ??
'account') as NotifEventContext['audience'],
appUid: input.appUid ?? null,
notification: input.dismissed ? {} : (input.value ?? {}),
notification: input.value ?? {},
...(input.replaced === true ? { replaced: true as const } : {}),
id: options.id ?? (input.dismissed ? randomUUID() : input.uid),
id: input.uid,
ts: input.createdAt || Date.now(),
handlerDepth: input.handlerDepth,
};
@@ -4641,51 +4592,29 @@ export class EventsService extends PuterService {
// The adapter is not a subscription: the desktop is delivered to
// whether or not anything subscribed, which is what keeps the wire
// contract identical with the fold-in on.
if (!input.dismissed && !options.forwarded)
this.services.notification.deliverOverSocket(context);
this.services.notification.deliverOverSocket(context);
if (!(await this.#userHasAny(userId))) return false;
if (!(await this.#userHasAny(userId))) return;
const { local, remote } =
await this.stores.eventSubscription.watchedFor(
userId,
subject.tokens(context),
);
if (!options.forwarded && remote.size > 0)
this.services.eventForward.forwardEvent(regionsIn(remote), {
family: 'notif',
ownerUserId: userId,
id: context.id,
ts: context.ts,
notif: {
userUuid: input.userUuid,
uid: input.uid,
type: context.type,
audience: context.audience,
appUid: context.appUid,
value: context.notification,
...(input.dismissed ? { dismissed: true as const } : {}),
...(input.replaced ? { replaced: true as const } : {}),
handlerDepth: input.handlerDepth,
},
});
if (local.length === 0) return false;
const watched = await this.stores.eventSubscription.watchedTokens(
userId,
subject.tokens(context),
);
if (watched.length === 0) return;
const fetched = await this.stores.eventSubscription.getForTokens(
userId,
local,
{ keep: dispatchKeeps(options.forwarded) },
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 true;
if (rows.length === 0) return;
await this.#route(subject, context, rows, userId, (matched) =>
this.#notifStillAuthorized(matched, context),
);
return true;
}
/**
@@ -6684,10 +6613,8 @@ export class EventsService extends PuterService {
*/
async invokeForSchedule(
invocation: WorkerInvocation,
options: Pick<WorkerRunOptions, 'stampEvent' | 'beforeSend'> = {},
options: Pick<WorkerRunOptions, 'stampEvent'> = {},
): Promise<ScheduleInvokeResult> {
if (options.beforeSend && !(await options.beforeSend()))
return { outcome: 'deferred' };
if (await this.#tooDeep(invocation)) return { outcome: 'too-deep' };
if (await this.#suspendIfHandlerGone(invocation))
return { outcome: 'deferred' };
@@ -6928,12 +6855,7 @@ export class EventsService extends PuterService {
delivery: AddressedDelivery,
): void {
if (this.#ended.has(row.subId) || this.#parkedUserRow(row)) return;
const event = delivery.envelope.event;
const key =
event.op === 'dismiss'
? `${subject}:dismiss:${event.uid}`
: subject;
this.#coalesce().push(coalesceKey(row.subId, key), delivery);
this.#coalesce().push(coalesceKey(row.subId, subject), delivery);
}
async #flush(delivery: AddressedDelivery): Promise<void> {
@@ -217,97 +217,6 @@ describe('the addressed peer queue', () => {
).toEqual(['b']);
});
it.each([false, true])(
'waits for an active send and ships its tail after failure %s',
async (failFirst) => {
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
let releaseTail!: () => void;
const tailHeld = new Promise<void>((resolve) => {
releaseTail = resolve;
});
const sent: ForwardItem[][] = [];
const { queue } = makeQueue({
maxItems: 1,
flushMs: 60_000,
send: async (_peerId, items) => {
sent.push(items);
if (sent.length === 1) {
await held;
if (failFirst) throw new Error('peer unavailable');
} else {
await tailHeld;
}
},
});
queue.push('east', delivery('first'));
await vi.waitFor(() => expect(sent).toHaveLength(1));
queue.push('east', delivery('tail'));
let finished = false;
const draining = queue.flushAll().then(() => {
finished = true;
});
try {
await new Promise((resolve) => setTimeout(resolve, 20));
expect(finished).toBe(false);
release();
await vi.waitFor(() => expect(sent).toHaveLength(2));
expect(finished).toBe(false);
} finally {
release();
releaseTail();
await draining;
queue.stop();
}
expect(sent).toEqual([[delivery('first')], [delivery('tail')]]);
},
);
it('releases the peer after a send throws synchronously', async () => {
const send = vi.fn(() => {
throw new Error('send failed');
});
const { queue } = makeQueue({ maxItems: 1, send });
queue.push('east', delivery('first'));
await queue.flushAll();
queue.push('east', delivery('second'));
await queue.flushAll();
expect(send).toHaveBeenCalledTimes(2);
});
it('bounds a final drain while a send is hung', async () => {
vi.useFakeTimers();
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
const send = vi.fn(async () => {
await held;
});
const { queue } = makeQueue({ maxItems: 1, send });
try {
queue.push('east', delivery('first'));
queue.push('east', delivery('tail'));
let finished = false;
const draining = queue.flushAll().then(() => {
finished = true;
});
await vi.advanceTimersByTimeAsync(4_999);
expect(finished).toBe(false);
await vi.advanceTimersByTimeAsync(1);
await draining;
queue.stop();
release();
await vi.advanceTimersByTimeAsync(100);
expect(send).toHaveBeenCalledTimes(1);
expect(vi.getTimerCount()).toBe(0);
} finally {
release();
vi.useRealTimers();
}
});
it('sends nothing more once it is stopped', async () => {
const { queue, sent } = makeQueue();
queue.stop();
+10 -40
View File
@@ -18,8 +18,6 @@
*/
import type { EventKey, KvOp } from '../../clients/event/types.js';
import { settleWithin } from '../../util/concurrency.js';
import { FINAL_FLUSH_TIMEOUT_MS } from '../../util/gracefulShutdown.js';
import type { DeliverableEvent } from './registry.js';
/**
@@ -88,7 +86,7 @@ export interface ForwardWatch {
/** One committed change, replayed against another region's session rows. */
export interface ForwardEvent {
kind: 'event';
family: 'fs' | 'kv' | 'notif';
family: 'fs' | 'kv';
ownerUserId: number;
/** Who caused it, so `self` is right on the far side. */
actingUserId?: number;
@@ -110,17 +108,6 @@ export interface ForwardEvent {
ancestors: Array<{ uid: string; path: string }>;
};
};
notif?: {
userUuid: string;
uid: string;
type: string;
audience: string;
appUid: string | null;
value: Record<string, unknown>;
dismissed?: true;
replaced?: true;
handlerDepth?: number;
};
kv?: {
userUuid: string;
appUid: string;
@@ -217,7 +204,7 @@ interface PeerQueue {
items: ForwardItem[];
bytes: number;
timer: ReturnType<typeof setTimeout> | null;
flushing: Promise<void> | null;
flushing: boolean;
}
export class PeerForwardQueue {
@@ -285,27 +272,19 @@ export class PeerForwardQueue {
}
/** Ship whatever is held for one peer. */
flush(peerId: string): Promise<void> {
async flush(peerId: string): Promise<void> {
const queue = this.#peers.get(peerId);
if (!queue) return Promise.resolve();
if (queue.flushing) return queue.flushing;
if (queue.items.length === 0) return Promise.resolve();
if (!queue || queue.flushing || queue.items.length === 0) return;
if (queue.timer) {
clearTimeout(queue.timer);
queue.timer = null;
}
queue.flushing = this.#send(peerId, queue);
return queue.flushing;
}
async #send(peerId: string, queue: PeerQueue): Promise<void> {
queue.flushing = true;
const batch = queue.items;
queue.items = [];
queue.bytes = 0;
try {
// Register the in-flight promise before a send can throw synchronously.
await Promise.resolve();
await this.#options.send(peerId, batch);
} catch (err) {
// A lost batch is a lost at-most-once delivery, and a `single`
@@ -313,7 +292,7 @@ export class PeerForwardQueue {
// hand the client an event whose moment has passed.
console.warn(`[events] forward to ${peerId} failed`, err);
} finally {
queue.flushing = null;
queue.flushing = false;
// Anything that arrived mid-flush gets the next window.
if (queue.items.length > 0 && !queue.timer && !this.#stopped) {
queue.timer = setTimeout(() => {
@@ -326,16 +305,7 @@ export class PeerForwardQueue {
}
async flushAll(): Promise<void> {
const deadline = Date.now() + FINAL_FLUSH_TIMEOUT_MS;
const work = Promise.allSettled(
[...this.#peers.entries()].map(async ([id, queue]) => {
await queue.flushing;
if (Date.now() < deadline) await this.flush(id);
}),
);
if (!(await settleWithin(work, FINAL_FLUSH_TIMEOUT_MS))) {
console.warn('[events] final flush timed out');
}
await Promise.all([...this.#peers.keys()].map((id) => this.flush(id)));
}
stop(): void {
@@ -353,7 +323,7 @@ export class PeerForwardQueue {
items: [],
bytes: 0,
timer: null,
flushing: null,
flushing: false,
};
this.#peers.set(peerId, queue);
return queue;
@@ -379,7 +349,7 @@ const isGapMarker = (item: ForwardItem): boolean =>
*/
const shed = (queue: PeerQueue, count: number): ForwardItem[] => {
const dropped: ForwardItem[] = [];
for (let i = 0; i < queue.items.length && dropped.length < count; ) {
for (let i = 0; i < queue.items.length && dropped.length < count;) {
if (isGapMarker(queue.items[i])) {
i++;
continue;
@@ -402,7 +372,7 @@ const shed = (queue: PeerQueue, count: number): ForwardItem[] => {
const shedBytes = (queue: PeerQueue, maxBytesHeld: number): ForwardItem[] => {
const dropped: ForwardItem[] = [];
let remaining = queue.bytes;
for (let i = 0; i < queue.items.length && remaining > maxBytesHeld; ) {
for (let i = 0; i < queue.items.length && remaining > maxBytesHeld;) {
if (isGapMarker(queue.items[i])) {
i++;
continue;
+1 -66
View File
@@ -402,7 +402,7 @@ const makeRegion = (
fields: { code: 'subject_does_not_exist' },
}),
},
notification: { notify: vi.fn(), deliverOverSocket: vi.fn() },
notification: { notify: vi.fn() },
metering: {
bufferIncrementUsages: (
actor: Actor,
@@ -2401,68 +2401,3 @@ describe('a durable row created in another region', () => {
);
});
});
describe('notification dismissals across connected pages', () => {
const config = { events: { enabled: true, notificationsFoldIn: true } } as Partial<IConfig>;
const appUid = 'notification-app';
const input = (uid = 'one') => ({
userId, userUuid: `user-${userId}`, uid,
type: 'app.message', audience: 'app-user', appUid,
value: {}, createdAt: Date.now(), dismissed: true as const,
});
it('reaches local and remote session pages without content or a forwarding loop', async () => {
const west = makeRegion('west', ['east'], config);
const east = makeRegion('east', ['west'], config);
for (const [region, socket] of [[west, 'local'], [east, 'remote']] as const) {
await region.events.subscribe(actorFor(appUid), socket, { subject: 'notif:app-user' });
}
await posted(east);
await quiet(100);
await west.events.dispatchNotif({ ...input(), value: { title: 'private' } });
await arrived(west);
await arrived(east);
for (const region of [west, east]) {
expect(region.sent).toHaveLength(1);
expect(region.sent[0].event).toMatchObject({ op: 'dismiss', uid: 'one', appUid });
expect(region.sent[0].event).not.toHaveProperty('notification');
}
expect(east.sent[0].event.id).toBe(west.sent[0].event.id);
const forwarded = west.posts.flatMap((p) => p.batch.items)
.find((item): item is ForwardEvent => item.kind === 'event');
expect(forwarded?.notif?.value).toEqual({});
expect(east.posts.flatMap((p) => p.batch.items).filter((i) => i.kind === 'event')).toEqual([]);
});
it('keeps separate dismissed ids in the same coalescing window', async () => {
const region = makeRegion('west', [], config);
await region.events.subscribe(actorFor(appUid), 'local', { subject: 'notif:app-user' });
await region.events.dispatchNotif(input('one'));
await region.events.dispatchNotif(input('two'));
await arrived(region, 2);
expect(region.sent.map((item) => 'uid' in item.event && item.event.uid)).toEqual(['one', 'two']);
});
it('does not deliver another app, account audience or another user to an app page', async () => {
const region = makeRegion('west', [], config);
await region.events.subscribe(actorFor(appUid), 'local', { subject: 'notif:app-user' });
await region.events.dispatchNotif({ ...input(), appUid: 'other-app' });
await region.events.dispatchNotif({ ...input(), audience: 'account' });
await region.events.dispatchNotif({ ...input(), userId: userId + 1, userUuid: 'other-user' });
await quiet(350);
expect(region.sent).toEqual([]);
});
it('also forwards postings through the same session path', async () => {
const west = makeRegion('west', ['east'], config);
const east = makeRegion('east', ['west'], config);
await east.events.subscribe(actorFor(appUid), 'remote', { subject: 'notif:app-user' });
await posted(east);
await quiet(100);
const { dismissed, ...postedInput } = input();
await west.events.dispatchNotif({ ...postedInput, value: { title: 'Hello' } });
await arrived(east);
expect(east.sent[0].event).toMatchObject({ op: 'post', uid: 'one', notification: { title: 'Hello' } });
});
});
+14 -24
View File
@@ -93,25 +93,24 @@ export interface ProjectedKvEvent extends ProjectedEventBase {
/**
* What a notification subscriber receives.
*
* For postings, `id` is the row's own uid: a client that fetched a missed
* notification and then received the live copy has to be able to tell they are
* the same thing, and the mailbox uid is the only identity both halves share.
* `uid` carries it under the name the mailbox verbs (`mark-ack`, `mark-shown`)
* take.
* `id` is the row's own uid rather than a per-dispatch uuid: a client that
* fetched a missed notification and then received the live copy has to be able
* to tell they are the same thing, and the mailbox uid is the only identity
* both halves share. `uid` carries it under the name the mailbox verbs
* (`mark-ack`, `mark-shown`) take.
*
* `notification` is the payload the caller sent, which is exactly what the
* socket adapter puts on `notif.message` — a subscriber reading this channel
* sees no less than the desktop does, and no internal row either. Dismissals
* use a fresh dispatch id and omit the payload.
* sees no less than the desktop does, and no internal row either.
*/
export interface ProjectedNotifEvent extends ProjectedEventBase {
op: 'post' | 'dismiss';
op: 'post';
uid: string;
type: string;
audience: NotificationAudience;
/** App the notification is about; `null` for platform notifications. */
appUid: string | null;
notification?: Record<string, unknown>;
notification: Record<string, unknown>;
/**
* Present when the notification replaced an earlier one under the same uid.
* `ts` is then the replacement time, the same on live and fetched copies,
@@ -121,9 +120,7 @@ export interface ProjectedNotifEvent extends ProjectedEventBase {
}
export type ProjectedEvent =
| ProjectedFsEvent
| ProjectedKvEvent
| ProjectedNotifEvent;
ProjectedFsEvent | ProjectedKvEvent | ProjectedNotifEvent;
export type GapReason =
| 'matched_subscription_limit'
@@ -203,7 +200,6 @@ export interface KvEventContext extends EventContextBase {
* recipient's uuid because the anchor token is the mailbox.
*/
export interface NotifEventContext extends EventContextBase {
dismissed?: true;
userId: number;
userUuid: string;
uid: string;
@@ -272,9 +268,7 @@ export interface NotifPublicSubject extends SubjectSpec<
}
export type PublicSubject =
| FsPublicSubject
| KvPublicSubject
| NotifPublicSubject;
FsPublicSubject | KvPublicSubject | NotifPublicSubject;
export interface UnpublishedInternalEvent {
event: EventKey;
@@ -352,14 +346,14 @@ const notifMatchTarget = (event: NotifEventContext): string =>
const notifMatchScope = (_anchorPath: string, slice: string): string => slice;
const notifProject = (delivery: NotifDeliveryContext): ProjectedNotifEvent => ({
id: delivery.dismissed ? delivery.id : delivery.uid,
id: delivery.uid,
subject: `notif:${delivery.appUid ?? delivery.userUuid}:${delivery.audience}`,
op: delivery.dismissed ? 'dismiss' : 'post',
op: 'post',
uid: delivery.uid,
type: delivery.type,
audience: delivery.audience,
appUid: delivery.appUid,
...(delivery.dismissed ? {} : { notification: delivery.notification }),
notification: delivery.notification,
...(delivery.replaced ? { replaced: true as const } : {}),
self: delivery.self,
ts: delivery.ts,
@@ -470,7 +464,7 @@ export const PUBLIC_SUBJECTS = [
{
family: 'notif',
subject: 'notif:*',
internal: ['notif.created', 'notif.acknowledged'],
internal: ['notif.created'],
tokens: notifTokens,
matchOn: notifMatchTarget,
matchSeparator: NOTIF_MATCH_SEPARATOR,
@@ -512,10 +506,6 @@ export const UNPUBLISHED_INTERNAL_EVENTS = [
event: 'notif.delivery.settled',
reason: 'A node-local report on how the live socket copy of a notification went; the notification itself publishes through `notif.created`.',
},
{
event: 'notif.handled',
reason: 'A node-local report that a page saw a notification live, for extensions deciding whether to push it; not a change to the notification.',
},
] as const satisfies readonly UnpublishedInternalEvent[];
// Every `fs.*`/`kv.*`/`notif.*` bus key needs a decision. A new key that is in
@@ -83,7 +83,6 @@ const recording = () => {
createFor: vi.fn(),
list: vi.fn(),
get: vi.fn(),
update: vi.fn(),
remove: vi.fn(),
receivePeerChanges: vi.fn(),
prepareSendAt: vi.fn(),
+2 -1
View File
@@ -48,7 +48,8 @@ export type SubjectFamily = 'fs' | 'kv' | 'notif';
export type FsOp = 'add' | 'write' | 'move' | 'remove' | 'meta';
export type NotifOp = 'post' | 'dismiss';
/** A notification is only ever posted; the mailbox verbs are their own surface. */
export type NotifOp = 'post';
export type SubjectOp = FsOp | KvOp | NotifOp;
@@ -144,22 +144,11 @@ const createInline = async (
return String(response.body.subId);
};
/**
* The post each label made, in order, once all have arrived. Matched by label
* since earlier tests' subscriptions stay live and post to the same sink.
*/
const delivered = async (...labels: string[]): Promise<SinkPost[]> => {
await vi.waitFor(
() =>
expect(sinkPosts.map((post) => post.label)).toEqual(
expect.arrayContaining(labels),
),
{ timeout: 30_000, interval: 50 },
);
return labels.map((label) =>
sinkPosts.find((post) => post.label === label)!,
);
};
const delivered = (count = 1): Promise<void> =>
vi.waitFor(() => expect(sinkPosts.length).toBeGreaterThanOrEqual(count), {
timeout: 30_000,
interval: 50,
});
beforeAll(async () => {
env = await setupPuterTestEnv({
@@ -266,11 +255,14 @@ describe('an inline handler in a user scope, end to end', () => {
await env.server.services.fs.touch(holder.id, {
path: `${holder.anchor}/note.txt`,
});
const [post] = await delivered('inline');
await delivered();
expect(post.path).toBe(`${holder.anchor}/note.txt`);
expect(sinkPosts[0]).toMatchObject({
label: 'inline',
path: `${holder.anchor}/note.txt`,
});
const { actor } = await env.server.services.auth.authenticate(
post.token!,
sinkPosts[0].token!,
);
expect(actor!.user?.id).toBe(holder.id);
expect(actor!.effectiveApp?.uid).toBe(appUid);
@@ -305,14 +297,14 @@ describe('an inline handler in a user scope, end to end', () => {
await env.server.services.fs.touch(holder.id, {
path: `${holder.anchor}/shared-${i}.txt`,
});
// The first test's 'inline' handler also posts for holders[0].
const posts = await delivered('first', 'second');
for (const [i, post] of posts.entries()) {
const { actor } = await env.server.services.auth.authenticate(
post.token!,
await delivered(2);
const runAs = new Set<number>();
for (const post of sinkPosts)
runAs.add(
(await env.server.services.auth.authenticate(post.token!))
.actor!.user!.id,
);
expect(actor!.user!.id).toBe(holders[i].id);
}
expect(runAs).toEqual(new Set(holders.map((h) => h.id)));
create.mockRestore();
},
);
@@ -218,7 +218,6 @@ export class EventsWorkerInvoker implements WorkerInvokerSeam {
{
lane: options.lane,
stampEvent: options.stampEvent,
beforeSend: options.beforeSend,
},
);
if (result.deployBusy) return { outcome: 'deploy-busy' };
@@ -49,89 +49,6 @@ const makeReq = (over: Partial<Request> = {}): Request =>
...over,
}) as unknown as Request;
describe('app browser embed shell', () => {
it.each([
[{ env: 'dev' }, '/sdk/puter.dev.js'],
[{ env: 'prod' }, 'https://js.puter.com/v2/'],
[{ gui_puterjs_bundle: '/custom-sdk.js' }, '/custom-sdk.js'],
])('uses the deployment SDK configuration %j', (config, sdkUrl) => {
const service = makeService({
...config,
api_base_url: 'https://api.deployment.test',
domain: 'deployment.test',
});
const html = service.renderAppBrowserEmbed();
const configJson = html.match(/id="app-browser-config">(.*?)<\/script>/)![1];
expect(JSON.parse(configJson)).toEqual({
apiOrigin: 'https://api.deployment.test', sdkUrl, guestApps: [],
});
expect(html).toContain('/dist/apps-embed.min.js');
expect(html).not.toContain('/dist/bundle.min.js');
expect(html).not.toContain('gui(');
});
it.each([
[{}, '/dist/apps-embed.min.js'],
[
{ gui_bundle: 'https://gui-cdn.deployment.test/bundle.min.js' },
'https://gui-cdn.deployment.test/apps-embed.min.js',
],
[
{ gui_bundle: '/static/bundle.min.js?v=42' },
'/static/apps-embed.min.js?v=42',
],
])('loads its script from beside the GUI bundle %j', (config, script) => {
const html = makeService(config).renderAppBrowserEmbed();
expect(html).toContain(`<script defer src="${script}"></script>`);
});
it('escapes configured values without breaking its JSON bootstrap', () => {
const sdkUrl = '/sdk.js?value=</script><script>unexpected()</script>';
const html = makeService({
gui_params: { title: '<script>unexpected()</script>' },
gui_puterjs_bundle: sdkUrl,
}).renderAppBrowserEmbed();
expect(html).not.toContain('<script>unexpected()');
const configJson = html.match(/id="app-browser-config">(.*?)<\/script>/)![1];
expect(JSON.parse(configJson).sdkUrl).toBe(sdkUrl);
});
it('carries the apps shown without a session, escaped', () => {
const guestApps = [
{ name: 'notes', title: '</script><script>unexpected()</script>' },
];
const html = makeService({}).renderAppBrowserEmbed({ guestApps });
expect(html).not.toContain('<script>unexpected()');
const configJson = html.match(/id="app-browser-config">(.*?)<\/script>/)![1];
expect(JSON.parse(configJson).guestApps).toEqual(guestApps);
});
});
describe('feedback embed shell', () => {
it('carries the framing page and API origin, and loads only its own script', () => {
const html = makeService({
api_base_url: 'https://api.deployment.test',
gui_bundle: '/static/bundle.min.js?v=42',
}).renderFeedbackEmbed({ hostOrigin: 'https://notes.deployment.test' });
const configJson = html.match(/id="feedback-embed-config">(.*?)<\/script>/)![1];
expect(JSON.parse(configJson)).toEqual({
apiOrigin: 'https://api.deployment.test',
hostOrigin: 'https://notes.deployment.test',
});
expect(html).toContain('<script defer src="/static/feedback-embed.min.js?v=42"></script>');
expect(html).toContain('<link rel="stylesheet" href="/css/feedback-embed.css">');
expect(html).toContain('<main id="feedback-embed"></main>');
expect(html).not.toContain('bundle.min.js');
expect(html).not.toContain('apps-embed');
});
it('carries no framing page when none is allowed', () => {
const html = makeService({}).renderFeedbackEmbed({ hostOrigin: null });
const configJson = html.match(/id="feedback-embed-config">(.*?)<\/script>/)![1];
expect(JSON.parse(configJson).hostOrigin).toBeNull();
});
});
/** Capture what the service sends, and return the rendered HTML. */
const render = async (
service: PuterHomepageService,
@@ -167,91 +167,6 @@ export class PuterHomepageService extends PuterService {
this.#guiParams[key] = val;
}
/** `guestApps` is what the embed shows a visitor without a session. */
renderAppBrowserEmbed({
guestApps = [],
}: { guestApps?: Array<Record<string, unknown>> } = {}): string {
return this.#renderEmbed({
rootId: 'app-browser',
rootClass: 'dashboard',
stylesheet: 'apps-embed.css',
script: 'apps-embed.min.js',
config: {
apiOrigin: this.config.api_base_url,
sdkUrl:
this.config.env === 'dev'
? '/sdk/puter.dev.js'
: (this.config.gui_puterjs_bundle ??
'https://js.puter.com/v2/'),
guestApps,
},
});
}
/**
* `hostOrigin` is the first-party page framing the dialog, which the
* feedback is sent for; null when no allowed page frames it.
*/
renderFeedbackEmbed({ hostOrigin }: { hostOrigin: string | null }): string {
return this.#renderEmbed({
rootId: 'feedback-embed',
stylesheet: 'feedback-embed.css',
script: 'feedback-embed.min.js',
config: { apiOrigin: this.config.api_base_url, hostOrigin },
});
}
#renderEmbed({
rootId,
rootClass,
stylesheet,
script,
config,
}: {
rootId: string;
rootClass?: string;
stylesheet: string;
script: string;
config: Record<string, unknown>;
}): string {
const configJson = JSON.stringify(config).replace(/</g, '\\u003c');
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="robots" content="noindex">
<title>${encode(String(this.config.gui_params?.title ?? 'Puter'))}</title>
<link rel="stylesheet" href="/css/normalize.css">
<link rel="stylesheet" href="/css/dashboard.css">
<link rel="stylesheet" href="/css/${stylesheet}">
</head>
<body>
<main id="${rootId}"${rootClass ? ` class="${rootClass}"` : ''}></main>
<script type="application/json" id="${rootId}-config">${configJson}</script>
<script defer src="${encode(this.#embedScript(script))}"></script>
</body>
</html>`;
}
/**
* Embed scripts are built beside the GUI bundle, so they are served from
* wherever `gui_bundle` is (a CDN in production), with the same query.
*/
#embedScript(name: string): string {
const base = 'http://relative.invalid';
const bundle = new URL(
this.config.gui_bundle ?? '/dist/bundle.min.js',
base,
);
const script = new URL(name, bundle);
script.search = bundle.search;
return script.origin === base
? `${script.pathname}${script.search}`
: script.href;
}
/** `scriptPath` is a same-origin absolute path, like `/ext/push/worker.js`. */
registerServiceWorkerScript(scriptPath: string): void {
if (
@@ -1,103 +0,0 @@
import {
afterAll,
afterEach,
beforeAll,
describe,
expect,
it,
vi,
} from 'vitest';
import type { PuterServer } from '../../server.js';
import { setupTestServer } from '../../testUtil.js';
const { disposals } = vi.hoisted(() => ({
disposals: [] as Array<ReturnType<typeof vi.fn>>,
}));
vi.mock('miniflare', () => ({
Miniflare: class {
dispose = vi.fn(async () => {});
constructor() {
disposals.push(this.dispose);
}
},
}));
describe('LocalWorkerService shutdown disposal', () => {
let server: PuterServer;
beforeAll(async () => {
server = await setupTestServer({
api_base_url: 'http://api.puter.localhost',
} as never);
});
afterAll(async () => {
await server.shutdown();
});
afterEach(() => {
vi.useRealTimers();
disposals.length = 0;
});
it('awaits every disposal even if one fails', async () => {
const service = server.services.localworkerservice;
await service.cfDeployLocal('first', 'auth', 'export default {}');
await service.cfDeployLocal('second', 'auth', 'export default {}');
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
disposals[0].mockRejectedValueOnce(new Error('dispose failed'));
disposals[1].mockImplementationOnce(async () => {
await held;
});
let finished = false;
const draining = Promise.resolve(service.onServerShutdown()).then(
() => {
finished = true;
},
);
try {
await new Promise((resolve) => setTimeout(resolve, 20));
expect(
disposals.every((dispose) => dispose.mock.calls.length === 1),
).toBe(true);
expect(finished).toBe(false);
} finally {
release();
await draining;
}
});
it('bounds disposal of a hung worker to five seconds', async () => {
const service = server.services.localworkerservice;
await service.cfDeployLocal('hung', 'auth', 'export default {}');
let release!: () => void;
const held = new Promise<void>((resolve) => {
release = resolve;
});
disposals[0].mockImplementationOnce(async () => {
await held;
});
vi.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout'] });
// The test server keeps arming timers from real callbacks while fakes
// are installed, so only what shutdown arms synchronously is checked.
const arm = vi.spyOn(globalThis, 'setTimeout');
try {
let finished = false;
const draining = Promise.resolve(service.onServerShutdown()).then(
() => {
finished = true;
},
);
expect(arm.mock.calls.map(([, ms]) => ms)).toEqual([5_000]);
await vi.advanceTimersByTimeAsync(4_999);
expect(finished).toBe(false);
await vi.advanceTimersByTimeAsync(1);
await draining;
} finally {
arm.mockRestore();
release();
vi.useRealTimers();
}
});
});
@@ -10,8 +10,6 @@ import {
import { puterStores } from '../../stores';
import type { SubdomainRow } from '../../stores/subdomain/SubdomainStore';
import { LayerInstances } from '../../types';
import { settleWithin } from '../../util/concurrency.js';
import { FINAL_FLUSH_TIMEOUT_MS } from '../../util/gracefulShutdown.js';
import { PuterService } from '../types';
const MAX_SOURCE_SIZE = 10 * 1024 * 1024; // 10 MB
@@ -242,16 +240,13 @@ export class LocalWorkerService extends PuterService {
idleSweepTimer.unref?.();
}
override async onServerShutdown(): Promise<void> {
override onServerShutdown(): void {
if (idleSweepTimer) {
clearInterval(idleSweepTimer);
idleSweepTimer = null;
}
const work = Promise.allSettled(
[...activeWorkers.keys()].map((name) => this.#disposeWorker(name)),
);
if (!(await settleWithin(work, FINAL_FLUSH_TIMEOUT_MS))) {
console.warn('[localworker] final flush timed out');
for (const name of [...activeWorkers.keys()]) {
void this.#disposeWorker(name);
}
}
async reconstructDeployArgs(workerName: string, row: SubdomainRow) {
@@ -4290,295 +4290,6 @@ describe('MeteringService', () => {
});
});
describe('reserveCreditsIfAffordable', () => {
const BUDGET = 20_000_000;
const HOLD = 16_200_000;
afterEach(() => {
vi.restoreAllMocks();
});
/** Spends the fresh actor's allowance down to exactly `balance`. */
const withBalance = async (balance: number) => {
const { remaining } = await target.getAllowedUsage(actor);
if (remaining > balance) {
await target.incrementUsage(
actor,
'kv:read',
1,
remaining - balance,
);
}
expect((await target.getAllowedUsage(actor)).remaining).toBe(
balance,
);
};
it('admits exactly one of two concurrent holds that only fit alone', async () => {
await withBalance(BUDGET);
const holds = await Promise.all([
target.reserveCreditsIfAffordable(actor, HOLD),
target.reserveCreditsIfAffordable(actor, HOLD),
]);
expect(holds.filter((h) => h !== null)).toHaveLength(1);
expect(await target.getOutstandingHolds(actor)).toBe(HOLD);
await Promise.all(holds.map((h) => h?.release()));
});
it('compares against the gross balance, counting live holds once', async () => {
await withBalance(BUDGET);
const other = await target.reserveCredits(actor, 5_000_000);
expect(
await target.reserveCreditsIfAffordable(actor, 15_000_001),
).toBeNull();
const fits = await target.reserveCreditsIfAffordable(
actor,
15_000_000,
);
expect(fits).not.toBeNull();
expect(await target.getOutstandingHolds(actor)).toBe(BUDGET);
// A release gives the headroom back for a retry.
await other.release();
expect(
await target.reserveCreditsIfAffordable(actor, 5_000_000),
).not.toBeNull();
});
it('counts allowance and purchased credit together', async () => {
await withBalance(1_000_000);
await target.updateAddonCredit(actor.user.uuid!, 2_000_000);
expect(
await target.reserveCreditsIfAffordable(actor, 3_000_001),
).toBeNull();
expect(
await target.reserveCreditsIfAffordable(actor, 3_000_000),
).not.toBeNull();
});
it('reads the balance again when usage lands and a hold is released after the read', async () => {
await withBalance(BUDGET);
// A request still running, about to record its usage and release.
const running = await target.reserveCredits(actor, HOLD);
const settle = async () => {
await target.incrementUsage(actor, 'kv:read', 1, HOLD);
await running.release();
};
// The admission's balance read finishes first, then the
// settlement lands before its reservation runs.
const read = target.getAllowedUsage.bind(target);
let settled = false;
vi.spyOn(target, 'getAllowedUsage').mockImplementation(
async (...args) => {
const balance = await read(...args);
if (!settled) {
settled = true;
await settle();
}
return balance;
},
);
expect(await target.reserveCreditsIfAffordable(actor, HOLD)).toBe(
null,
);
expect(await target.getOutstandingHolds(actor)).toBe(0);
});
it('would over-admit that interleaving without the version check', async () => {
await withBalance(BUDGET);
const running = await target.reserveCredits(actor, HOLD);
const read = target.getAllowedUsage.bind(target);
let settled = false;
vi.spyOn(target, 'getAllowedUsage').mockImplementation(
async (...args) => {
const balance = await read(...args);
if (!settled) {
settled = true;
await target.incrementUsage(actor, 'kv:read', 1, HOLD);
await running.release();
}
return balance;
},
);
vi.spyOn(server.stores.creditHold, 'version').mockResolvedValue('');
const hold = await target.reserveCreditsIfAffordable(actor, HOLD);
expect(hold).not.toBeNull();
await hold?.release();
});
it('marks the balance changed once a usage write lands', async () => {
const before = await server.stores.creditHold.version(
actor.user.uuid!,
);
await target.incrementUsage(actor, 'kv:read', 1, 1_000);
expect(
await server.stores.creditHold.version(actor.user.uuid!),
).not.toBe(before);
});
it('lets the balance decide, holding nothing, when the cache is unavailable', async () => {
await withBalance(BUDGET);
vi.spyOn(server.stores.creditHold, 'reserve').mockResolvedValue({
outcome: 'unavailable',
});
const hold = await target.reserveCreditsIfAffordable(actor, HOLD);
expect(hold).not.toBeNull();
expect(await target.getOutstandingHolds(actor)).toBe(0);
expect(
await target.reserveCreditsIfAffordable(actor, BUDGET + 1),
).toBeNull();
});
it('reads the balance again while it keeps changing, then refuses', async () => {
await withBalance(BUDGET);
const reserve = vi
.spyOn(server.stores.creditHold, 'reserve')
.mockResolvedValue({ outcome: 'stale' });
expect(await target.reserveCreditsIfAffordable(actor, HOLD)).toBe(
null,
);
expect(reserve).toHaveBeenCalledTimes(5);
// Every attempt checks the version; none falls back to skipping it.
expect(reserve.mock.calls.every(([, , , v]) => v !== '')).toBe(
true,
);
expect(await target.getOutstandingHolds(actor)).toBe(0);
});
it('admits once the balance holds still', async () => {
await withBalance(BUDGET);
const reserve = vi.spyOn(server.stores.creditHold, 'reserve');
reserve
.mockResolvedValueOnce({ outcome: 'stale' })
.mockResolvedValueOnce({ outcome: 'stale' });
const hold = await target.reserveCreditsIfAffordable(actor, HOLD);
expect(hold).not.toBeNull();
expect(reserve).toHaveBeenCalledTimes(3);
await hold?.release();
});
it('reads purchased credit consistently only while some is left', async () => {
await withBalance(BUDGET);
const get = vi.spyOn(server.stores.kv, 'get');
const consistentAddonReads = () =>
get.mock.calls.filter(
([args]) =>
args.consistentRead &&
String(args.key).endsWith(':addons'),
).length;
// With none, the cached record that says so answers.
await target.getAllowedUsage(actor);
get.mockClear();
await (
await target.reserveCreditsIfAffordable(actor, 1000)
)?.release();
expect(consistentAddonReads()).toBe(0);
await target.updateAddonCredit(actor.user.uuid!, 5_000);
get.mockClear();
await (
await target.reserveCreditsIfAffordable(actor, 1000)
)?.release();
expect(consistentAddonReads()).toBe(1);
});
it('marks the balance changed on credit, allowance and manual usage changes', async () => {
const uuid = actor.user.uuid!;
const versions = [await server.stores.creditHold.version(uuid)];
await target.updateAddonCredit(uuid, 1_000);
versions.push(await server.stores.creditHold.version(uuid));
await target.setActorCurrentMonthUsageTotal(actor, 5_000);
versions.push(await server.stores.creditHold.version(uuid));
expect(new Set(versions).size).toBe(3);
});
it('treats the system actor, a userless actor and amounts it can’t hold as the plain check does', async () => {
for (const [who, amount] of [
[SYSTEM_ACTOR, HOLD],
[actor, 0],
[actor, -5],
] as const) {
const hold = await target.reserveCreditsIfAffordable(
who,
amount,
);
expect(hold).not.toBeNull();
}
for (const amount of [Number.NaN, Number.POSITIVE_INFINITY]) {
expect(
await target.reserveCreditsIfAffordable(actor, amount),
).toBeNull();
}
await expect(
target.reserveCreditsIfAffordable({ user: {} } as Actor, HOLD),
).rejects.toThrow();
expect(await target.getOutstandingHolds(actor)).toBe(0);
});
it('passes the hold lifetime through and renews it', async () => {
await withBalance(BUDGET);
const hold = await target.reserveCreditsIfAffordable(actor, 750, {
ttlMs: 500,
});
await new Promise((r) => setTimeout(r, 620));
expect(await target.getOutstandingHolds(actor)).toBe(0);
await hold?.extend?.();
expect(await target.getOutstandingHolds(actor)).toBe(750);
await hold?.release();
expect(await target.getOutstandingHolds(actor)).toBe(0);
});
});
describe('settling a charge while a flush is out', () => {
it('splits a charge over the allowance using usage a flush has claimed', async () => {
const uuid = actor.user.uuid!;
const { monthUsageAllowance: allowance } =
await target.getActorSubscription(actor);
await target.updateAddonCredit(uuid, 1_000_000);
const Service = target.constructor as typeof MeteringService;
const threshold = Service.PRECISION_THRESHOLD;
// Keeps the first charge buffered instead of read exactly.
Service.PRECISION_THRESHOLD = 2;
await target.incrementUsage(actor, 'kv:read', 1, allowance - 5);
Service.PRECISION_THRESHOLD = threshold;
// A flush claims it and stalls before writing it onward.
const kv = server.stores.kv;
const realIncr = kv.incr.bind(kv);
let release: () => void = () => {};
const gate = new Promise<void>((r) => (release = r));
const write = vi
.spyOn(kv, 'incr')
.mockImplementation(async (...args) => {
await gate;
return realIncr(...args);
});
const flushing = server.stores.meteringBuffer.flushCycle();
await vi.waitFor(() => expect(write).toHaveBeenCalled());
write.mockImplementation(realIncr);
// 5 µ¢ of this is left in the allowance; the rest is credit.
await target.incrementUsage(actor, 'kv:read', 1, 10);
release();
await flushing;
write.mockRestore();
await waitFor(async () => {
const addons = await target.getActorAddons(actor, {
consistentRead: true,
});
expect(addons.consumedPurchaseCredits).toBe(5);
});
});
});
// ── Resolver registration ────────────────────────────────────────
describe('resolver registration', () => {
@@ -698,8 +698,6 @@ export class MeteringService extends PuterService {
actorAddons,
totalBatchCost,
);
// Before any hold this usage stands for is released.
await this.stores.creditHold.bump(userId);
this.maybeAlertOveruse({
actor,
@@ -731,10 +729,6 @@ export class MeteringService extends PuterService {
? ({ ...own, ...charged } as UsageByType)
: (charged ?? own);
} catch (e) {
// Part of the usage may have landed before the failure.
if (actor?.user?.uuid) {
await this.stores.creditHold.bump(actor.user.uuid);
}
console.error('[metering] batchIncrementUsages failed', {
actor,
usages,
@@ -1438,7 +1432,6 @@ export class MeteringService extends PuterService {
}
this.invalidateActorCredits(userId);
await this.stores.creditHold.bump(userId);
await Promise.all([
this.stores.meteringBuffer.forgetSummed(actorUsageKey),
this.stores.meteringBuffer.forgetSummed(
@@ -1552,86 +1545,7 @@ export class MeteringService extends PuterService {
opts.ttlMs,
);
if (!member) return NO_CREDIT_HOLD;
return this.#holdHandle(userId, member, opts.ttlMs);
}
/**
* Commit part of an actor's budget only if it fits beside what their other
* operations hold; null when it doesn't. The check and the hold are one
* step in the cache, and a usage write or release that lands after the
* balance read sends the reservation back to read it again. When the cache
* can't answer, the balance alone decides and nothing is held.
*/
async reserveCreditsIfAffordable(
actor: Actor,
amount: number,
opts: { ttlMs?: number } = {},
): Promise<CreditHold | null> {
const userId = actor?.user?.uuid;
if (
!userId ||
isSystemActor(actor) ||
!Number.isFinite(amount) ||
!(amount > 0)
) {
// Nothing to hold; the plain check decides, as it always has.
return (await this.hasEnoughCredits(actor, amount))
? NO_CREDIT_HOLD
: null;
}
for (let attempt = 1; ; attempt++) {
const version = await this.stores.creditHold.version(userId);
// Read after the version, so a write it misses bumps the version.
const { remaining } = await this.getAllowedUsage(actor, {
exact: true,
});
const budget = remaining || 0;
const result =
version === null
? ({ outcome: 'unavailable' } as const)
: await this.stores.creditHold.reserve(
userId,
amount,
budget,
version,
opts.ttlMs,
);
switch (result.outcome) {
case 'accepted':
return this.#holdHandle(userId, result.member, opts.ttlMs);
case 'insufficient':
return null;
case 'unavailable':
return budget >= amount ? NO_CREDIT_HOLD : null;
case 'stale':
break;
}
// A balance that never holds still long enough to read is refused
// rather than checked against a read that may be out of date.
if (attempt >= MeteringService.RESERVE_ATTEMPTS) {
console.warn(
`[metering] credit reservation refused for ${userId}: balance kept changing`,
);
return null;
}
await new Promise((resolve) =>
setTimeout(
resolve,
Math.random() *
MeteringService.RESERVE_BACKOFF_MS *
attempt,
),
);
}
}
/** Reservations tried while the balance keeps changing under them. */
private static readonly RESERVE_ATTEMPTS = 5;
/** Upper bound of the randomized wait before each retry, times the attempt. */
private static readonly RESERVE_BACKOFF_MS = 20;
#holdHandle(userId: string, member: string, ttlMs?: number): CreditHold {
let released = false;
return {
release: async () => {
@@ -1641,7 +1555,11 @@ export class MeteringService extends PuterService {
},
extend: async () => {
if (released) return;
await this.stores.creditHold.refresh(userId, member, ttlMs);
await this.stores.creditHold.refresh(
userId,
member,
opts.ttlMs,
);
},
};
}
@@ -1653,22 +1571,14 @@ export class MeteringService extends PuterService {
return this.stores.creditHold.outstanding(userId);
}
/**
* `exact` reads purchased credit consistently, for a spend decision that
* has to see the consumption a write just recorded. A cached record with no
* credit left still answers: it can only understate the balance.
*/
async getAllowedUsage(
actor: Actor,
{ exact = false }: { exact?: boolean } = {},
): Promise<{
async getAllowedUsage(actor: Actor): Promise<{
remaining: number;
monthUsageAllowance: number;
addons: UsageAddons;
}> {
const [userSubscription, addons, totals] = await Promise.all([
this.getActorSubscription(actor),
this.#addonsForSettle(actor, { consistentRead: exact }),
this.#addonsForSettle(actor),
this.currentMonthTotals(actor),
]);
@@ -2335,16 +2245,13 @@ export class MeteringService extends PuterService {
}
/** `getActorAddons`, through `#spentAddons`. Shared by gates and settles. */
async #addonsForSettle(
actor: Actor,
{ consistentRead }: { consistentRead?: boolean } = {},
): Promise<UsageAddons> {
async #addonsForSettle(actor: Actor): Promise<UsageAddons> {
const uuid = actor.user?.uuid;
const cached = uuid ? this.#spentAddons.get(uuid) : undefined;
if (cached && cached.expiresAt > Date.now()) return cached.addons;
const drops = this.#spentAddonsDrops;
const addons = await this.getActorAddons(actor, { consistentRead });
const addons = await this.getActorAddons(actor);
if (!uuid) return addons;
this.#spentAddons.delete(uuid);
const creditLeft =
@@ -2475,7 +2382,6 @@ export class MeteringService extends PuterService {
// Credit that lands while the account is being turned away has to take
// effect on the next request, not at the end of the cache window.
this.invalidateActorCredits(userId);
await this.stores.creditHold.bump(userId);
}
/**
@@ -2523,7 +2429,6 @@ export class MeteringService extends PuterService {
});
// Every node drops its cached policy, and the budget answer with it.
this.invalidateActorSubscription(userUuid);
await this.stores.creditHold.bump(userUuid);
}
/**
@@ -1,39 +0,0 @@
import { expect, it } from 'vitest';
import { EventClient } from '../../clients/event/EventClient.js';
import type { EventMap } from '../../clients/event/types.js';
import { NotificationService } from './NotificationService.js';
it.each([undefined, 0, 1_700_000_000_000])(
'emits replacement metadata for replacedAt %s',
async (replacedAt) => {
const event = new EventClient({} as never);
const written: EventMap['notif.written'][] = [];
event.on('notif.written', (_key, value) => {
written.push(value);
});
const service = new NotificationService(
{} as never,
{ event } as never,
{} as never,
);
await service.emitWritten(
{
userId: 1,
uid: 'notification-1',
type: 'app.message',
audience: 'app-user',
appUid: 'app-1',
value: { title: 'A message' },
updated: replacedAt !== undefined,
replacedAt,
},
{ sendId: 'send-1' },
);
expect(written).toHaveLength(1);
if (replacedAt === undefined)
expect(written[0]).not.toHaveProperty('replaced');
else expect(written[0].replaced).toBe(true);
},
);
@@ -354,7 +354,6 @@ describe('NotificationService.notifyUpdate', () => {
appUid,
value: { title: 'two messages', type: 'app.message' },
updated: true,
replaced: true,
});
expect(desktop.seen).toEqual([]);
expect(
@@ -23,14 +23,10 @@ import { handlerDepthOf, type Actor } from '../../core/actor.js';
import { Context } from '../../core/context.js';
import type { NotifEventContext } from '../events/registry.js';
import { PuterService } from '../types.js';
import { checkRateLimit } from '../../core/http/middleware/rateLimit.js';
import {
NOTIF_HANDLED_EVENT,
NOTIF_HANDLED_PER_MINUTE,
NotificationSocketAdapter,
notificationAckTimeoutMs,
notificationsFoldInEnabled,
type NotifSocket,
type ReceiptScope,
} from './notificationSocket.js';
import {
@@ -314,9 +310,6 @@ export class NotificationService extends PuterService {
...scope,
value: structuredClone(payload),
...(updated ? { updated: true as const } : {}),
...(written.replacedAt !== undefined
? { replaced: true as const }
: {}),
sendId: opts.sendId,
...(opts.replayable ? { replayable: true as const } : {}),
},
@@ -408,11 +401,6 @@ export class NotificationService extends PuterService {
return this.#socket().receipt(scope);
}
/** Installs the `notif.handled` verb on one connection. */
attachSocket(socket: NotifSocket, actor: Actor): void {
this.#socket().attachSocket(socket, actor);
}
/**
* Drop notifications past the retention window, in batches, and report how
* many went. Deleting is all there is to it: nothing is pushed, because a
@@ -448,12 +436,6 @@ export class NotificationService extends PuterService {
ackTimeoutMs: () => notificationAckTimeoutMs(this.config),
heldInPeerRegion: (userId, appUid) =>
this.#heldInPeerRegion(userId, appUid),
allowHandled: (userId) =>
checkRateLimit(
`socket:${NOTIF_HANDLED_EVENT}:${userId}`,
NOTIF_HANDLED_PER_MINUTE,
60_000,
),
});
return this.#adapter;
}
@@ -172,23 +172,13 @@ describe('parseAppMessage', () => {
rejects({ title: 't', sensitive: 'yes' }, 'sensitive');
});
it('accepts normal and high priority, defaulting to normal', () => {
expect(parseAppMessage({ title: 't' }).priority).toBe('normal');
expect(
parseAppMessage({ title: 't', priority: 'normal' }).priority,
).toBe('normal');
expect(
parseAppMessage({ title: 't', priority: 'high' }).priority,
).toBe('high');
it('refuses high priority to apps', () => {
expect(() => parseAppMessage({ title: 't', priority: 'high' })).toThrow(
"'high' is not available to apps",
);
rejects({ title: 't', priority: 'urgent' }, 'priority');
});
it.each(['urgent', 'low', '', null, 1, true])(
'rejects priority %s',
(priority) => {
rejects({ title: 't', priority }, 'priority');
},
);
it('bounds ttl to whole seconds within a day', () => {
expect(parseAppMessage({ title: 't', ttl: 1 }).ttl).toBe(1);
rejects({ title: 't', ttl: 0 }, 'ttl');
@@ -39,7 +39,7 @@ export const APP_MESSAGE_RATE_LIMITS = {
perDay: 1000,
} as const;
export type AppMessagePriority = 'normal' | 'high';
export type AppMessagePriority = 'normal';
/** An `app.message` value as stored, after normalization. */
export type AppMessage = {
@@ -322,11 +322,13 @@ export const parseAppMessage = (input: Record<string, unknown>): AppMessage => {
message.sensitive = input.sensitive;
}
if (input.priority !== undefined) {
if (input.priority !== 'normal' && input.priority !== 'high') {
throw invalid('priority', "must be 'normal' or 'high'");
}
message.priority = input.priority;
if (input.priority !== undefined && input.priority !== 'normal') {
throw invalid(
'priority',
input.priority === 'high'
? "'high' is not available to apps; use 'normal'"
: "must be 'normal'",
);
}
return message;
@@ -32,10 +32,7 @@ import {
import type { EventMap } from '../../clients/event/types.js';
import type { PuterServer } from '../../server.js';
import { accountSocketRoom, SocketService } from '../socket/SocketService.js';
import {
NOTIF_HANDLED_EVENT,
NOTIF_RECEIPT_EVENT,
} from './notificationSocket.js';
import { NOTIF_RECEIPT_EVENT } from './notificationSocket.js';
import {
allocateEphemeralPort,
createTestUser,
@@ -312,13 +309,12 @@ describe('live notification delivery receipts', () => {
complete: true,
peerRegions: false,
responders: [{ visibilityState: 'hidden' }],
handled: false,
};
expect(settled).toEqual(expected);
expect(state.settled).toEqual([expected]);
});
it('passes a tab`s focus through, typed strictly', async () => {
it('passes a tab`s focus and own display through, typed strictly', async () => {
const answers = [
{
received: true,
@@ -330,6 +326,7 @@ describe('live notification delivery receipts', () => {
received: true,
visibilityState: 'nope',
focused: 1,
showsOwn: 'yes',
},
];
for (const answer of answers) {
@@ -344,39 +341,11 @@ describe('live notification delivery receipts', () => {
expect(settled.outcome).toBe('received');
expect(settled.responders).toEqual(
expect.arrayContaining([
{ visibilityState: 'hidden', focused: false },
{ visibilityState: 'hidden', focused: false, showsOwn: true },
{ visibilityState: 'unknown' },
]),
);
expect(settled.responders).toHaveLength(2);
expect(settled.handled).toBe(false);
});
it('counts as handled only a visible tab that is focused, or an older one that is visible', async () => {
const cases: Array<[Record<string, unknown>, boolean]> = [
[{ visibilityState: 'visible', focused: true }, true],
[{ visibilityState: 'visible', focused: false }, false],
[{ visibilityState: 'hidden', focused: true }, false],
[{ visibilityState: 'visible' }, true],
];
for (const [answer, handled] of cases) {
const tab = await connect({ acks: [NOTIF_RECEIPT_EVENT] });
tab.on(NOTIF_RECEIPT_EVENT, (_data: unknown, ack: Ack) =>
ack({ received: true, ...answer }),
);
const { settled } = await ask();
expect(settled.handled, JSON.stringify(answer)).toBe(handled);
tab.disconnect();
await vi.waitFor(() =>
expect(
state.server.services.socket.has({
room: accountSocketRoom(state.userId),
}),
).toBe(false),
);
}
});
it('settles as unreceived when every tab answers that it never got it', async () => {
@@ -580,7 +549,6 @@ describe('live receipts from an app’s own sockets', () => {
complete: true,
peerRegions: false,
responders: [{ visibilityState: 'visible' }],
handled: true,
};
expect(settled).toEqual(expected);
expect(state.settled).toEqual([expected]);
@@ -751,59 +719,3 @@ describe('app receipts where the adapter cannot count servers', () => {
});
});
});
describe('a page reporting a notification it handled', () => {
const { state, connect, appSocket } = withAppReceipts({ cluster: true });
const reports: Array<EventMap['notif.handled']> = [];
const onHandled = (_key: string, data: unknown) => {
reports.push(data as EventMap['notif.handled']);
};
beforeAll(() => {
state.server.clients.event.on('notif.handled', onHandled);
});
afterEach(() => {
reports.length = 0;
});
afterAll(() => {
state.server?.clients.event.off('notif.handled', onHandled);
});
it('relays a desktop tab`s report for its user, without an app', async () => {
const tab = await connect({});
const uid = uuidv4();
tab.emit(NOTIF_HANDLED_EVENT, { uid });
await vi.waitFor(() =>
expect(reports).toEqual([{ userId: state.userId, uid }]),
);
});
it('relays an app page`s report with the app it acts as', async () => {
const page = await appSocket();
const uid = uuidv4();
page.emit(NOTIF_HANDLED_EVENT, { uid });
await vi.waitFor(() =>
expect(reports).toEqual([
{ userId: state.userId, uid, appUid: OWN_APP },
]),
);
});
it('drops a report without a notification uid', async () => {
const tab = await connect({});
tab.emit(NOTIF_HANDLED_EVENT, { uid: 'not-a-uid' });
tab.emit(NOTIF_HANDLED_EVENT, null);
tab.emit(NOTIF_HANDLED_EVENT, { uid: uuidv4() });
await vi.waitFor(() => expect(reports).toHaveLength(1));
await new Promise((resolve) => setTimeout(resolve, 100));
expect(reports).toHaveLength(1);
});
});
Loaded 100 of 557 files, more files were not shown because too many files have changed in this diff. Show more