@prized/sdk 0.1.1 → 0.1.2

package/dist/esm/http.js

@@ -5,6 +5,11 @@ import { commandEffect, restate, withAbort, withOutcome } from './outcome.js';
 import { VERSION } from './version.js';
 export const DEFAULT_BASE_URL = 'https://api.prized.dev';
 export const DEFAULT_EDGE_URL = 'https://term.prized.dev';
+/** Node's own fetch (not Bun's or Deno's, which also say they are Node), with web streams. */
+function nodeFetch() {
+    const versions = globalThis.process?.versions;
+    return typeof versions?.node === 'string' && versions.bun === undefined && versions.deno === undefined && typeof ReadableStream === 'function';
+}
 function envApiKey() {
     try {
         const env = globalThis.process?.env;
@@ -66,8 +71,9 @@ export function abortableSleep(ms, signal) {
 /**
  * How long a wait (a streamed or long exec, a handle's wait()) keeps polling
  * while its polls fail before it gives up (pollOutageMs), and a streamed or
- * long exec stops its command: long enough to ride out a dropped connection
- * or an edge that restarts. The Python SDK's DEFAULT_POLL_OUTAGE.
+ * long exec stops its command, and how long a start is sent again: long
+ * enough to ride out a dropped connection or an edge that restarts (about
+ * 70 s, the last time it crashed). The Python SDK's DEFAULT_POLL_OUTAGE.
  */
 export const DEFAULT_POLL_OUTAGE_MS = 120_000;
 /** A pollOutageMs given (a number of ms ≥ 0), or undefined. */
@@ -109,6 +115,7 @@ export function resolveConfig(options = {}) {
         sleep: options.sleep ?? abortableSleep,
         now: options.now ?? Date.now,
         random: options.random ?? Math.random,
+        streamBodies: options.fetch === undefined && nodeFetch(),
     };
 }
 /** Prized's own domain: its API and its edges are hosts under it. */
@@ -355,6 +362,84 @@ export function backoffMs(config, attempt) {
     const base = Math.min(MAX_BACKOFF_MS, BACKOFF_FIRST_MS * 2 ** attempt);
     return Math.round(base / 2 + (config.random() * base) / 2);
 }
+/**
+ * How long a file transfer may move no bytes before the attempt is given up
+ * (sdk/retry-spec.json transferStallMs; the Python SDK's TRANSFER_STALL).
+ * The edge holds a request about 20 s at most before it reads the body (its
+ * admission queue, then waking a paused sandbox), and ends a body that brings
+ * nothing for 60 s itself: kept above that, a stalled copy is over at the
+ * edge before the next one goes to the same staged name, so the two never
+ * race. Once an upload's last byte is handed over, its answer is waited for
+ * that and a second more for every uploadAnswerBytesPerSecond it sent: what
+ * the socket's buffers, or a proxy that takes a whole body before it sends it
+ * on, still hold moves unseen, and must not read as a stall (the Python SDK's
+ * UPLOAD_ANSWER_RATE). Mutable for tests only.
+ */
+export const timing = { transferStallMs: 120_000, uploadAnswerBytesPerSecond: 128 * 1024 };
+/** A streamed upload goes out this many bytes at a time. */
+export const UPLOAD_CHUNK = 64 * 1024;
+/**
+ * A body's bytes, to stream; null for one to send as it is. By shape, not
+ * instanceof: a Uint8Array or Buffer from another realm (a test runner's vm
+ * context, say) is one too.
+ */
+async function bodyBytes(body) {
+    if (typeof body === 'string')
+        return new TextEncoder().encode(body);
+    if (ArrayBuffer.isView(body))
+        return new Uint8Array(body.buffer, body.byteOffset, body.byteLength);
+    if (Object.prototype.toString.call(body) === '[object ArrayBuffer]')
+        return new Uint8Array(body);
+    if (typeof body.arrayBuffer === 'function')
+        return new Uint8Array(await body.arrayBuffer());
+    return null;
+}
+/**
+ * `bytes` as a stream fed UPLOAD_CHUNK at a time, `moved` told each time
+ * fetch asks for more, and at the end given the answer's allowance
+ * (timing.uploadAnswerBytesPerSecond).
+ */
+function inPieces(bytes, moved) {
+    let at = 0;
+    return new ReadableStream({
+        pull(controller) {
+            if (at >= bytes.byteLength) {
+                moved((bytes.byteLength / timing.uploadAnswerBytesPerSecond) * 1000);
+                controller.close();
+                return;
+            }
+            moved();
+            // A copy: a runtime may take the piece's buffer as it sends it.
+            controller.enqueue(bytes.slice(at, at + UPLOAD_CHUNK));
+            at += UPLOAD_CHUNK;
+        },
+    }, 
+    // Nothing read ahead: a pull is the socket taking the last piece.
+    { highWaterMark: 0 });
+}
+/** A body read whole, `moved` told of every piece. */
+async function readAll(response, moved) {
+    if (response.body === null)
+        return new Uint8Array(0);
+    const reader = response.body.getReader();
+    const parts = [];
+    let size = 0;
+    for (;;) {
+        const { done, value } = await reader.read();
+        if (done)
+            break;
+        moved();
+        parts.push(value);
+        size += value.byteLength;
+    }
+    const whole = new Uint8Array(size);
+    let at = 0;
+    for (const part of parts) {
+        whole.set(part, at);
+        at += part.byteLength;
+    }
+    return whole;
+}
 /**
  * One fetch, body included, under one timeout and the caller's signal. A
  * body that stalls or breaks after the headers fails the attempt like a
@@ -363,10 +448,24 @@ export function backoffMs(config, attempt) {
 async function attemptOnce(config, spec, url, timeoutMs) {
     const controller = new AbortController();
     let timedOut = false;
+    let stalled = false;
     const timer = setTimeout(() => {
         timedOut = true;
         controller.abort();
     }, timeoutMs);
+    // The stall bound starts over whenever bytes move (stallMs), until the attempt is over.
+    let stall;
+    let over = false;
+    const moved = (extraMs = 0) => {
+        if (spec.stallMs === undefined || over)
+            return;
+        clearTimeout(stall);
+        stall = setTimeout(() => {
+            stalled = true;
+            timedOut = true;
+            controller.abort();
+        }, spec.stallMs + extraMs);
+    };
     const onAbort = () => controller.abort();
     spec.signal?.addEventListener('abort', onAbort, { once: true });
     const headers = {
@@ -376,30 +475,52 @@ async function attemptOnce(config, spec, url, timeoutMs) {
         ...spec.headers,
     };
     let body;
-    if (spec.json !== undefined) {
-        headers['content-type'] = 'application/json';
-        body = JSON.stringify(spec.json);
-    }
-    else if (spec.body !== undefined) {
-        headers['content-type'] = spec.contentType ?? 'application/octet-stream';
-        body = spec.body;
-    }
+    // Watched from the start unless an upload goes out unwatched (Config.streamBodies).
+    let watched = spec.stallMs !== undefined && spec.body === undefined;
+    let streamed = false;
     let status = null;
     try {
+        if (spec.json !== undefined) {
+            headers['content-type'] = 'application/json';
+            body = JSON.stringify(spec.json);
+        }
+        else if (spec.body !== undefined) {
+            headers['content-type'] = spec.contentType ?? 'application/octet-stream';
+            body = spec.body;
+            const bytes = spec.stallMs !== undefined && config.streamBodies ? await bodyBytes(spec.body) : null;
+            if (bytes !== null) {
+                headers['content-length'] = String(bytes.byteLength);
+                body = inPieces(bytes, moved);
+                streamed = true;
+                watched = true;
+            }
+        }
+        if (watched)
+            moved();
         const response = await config.fetch(url, {
             method: spec.method,
             headers,
             body: body,
+            // A streamed body (Node's fetch asks for it): sent before the answer is read.
+            ...(streamed ? { duplex: 'half' } : {}),
             // Never follow a redirect with the key attached.
             redirect: 'manual',
             signal: controller.signal,
         });
         status = response.status;
+        if (spec.stallMs !== undefined)
+            moved();
         const ok = response.status >= 200 && response.status < 300;
         if (response.status >= 300 && response.status < 400) {
             await response.body?.cancel().catch(() => undefined);
             return { answer: { status: response.status, headers: response.headers, text: '', bytes: null } };
         }
+        if (spec.stallMs !== undefined) {
+            const whole = await readAll(response, moved);
+            if (ok && spec.read === 'bytes')
+                return { answer: { status: response.status, headers: response.headers, text: '', bytes: whole } };
+            return { answer: { status: response.status, headers: response.headers, text: new TextDecoder('utf-8').decode(whole), bytes: null } };
+        }
         if (ok && spec.read === 'bytes') {
             const bytes = new Uint8Array(await response.arrayBuffer());
             return { answer: { status: response.status, headers: response.headers, text: '', bytes } };
@@ -407,10 +528,12 @@ async function attemptOnce(config, spec, url, timeoutMs) {
         return { answer: { status: response.status, headers: response.headers, text: await response.text(), bytes: null } };
     }
     catch (error) {
-        return { error, timedOut, status };
+        return { error, timedOut, stalled, status };
     }
     finally {
+        over = true;
         clearTimeout(timer);
+        clearTimeout(stall);
         spec.signal?.removeEventListener('abort', onAbort);
     }
 }
@@ -473,8 +596,8 @@ export async function request(config, spec) {
     const timeoutMs = spec.timeoutMs ?? config.requestTimeoutMs;
     const sandboxId = spec.sandboxId ?? null;
     const effect = spec.effect ?? (spec.retry === 'exec' ? commandEffect() : undefined);
-    // Whether an attempt that was sent again may have reached the sandbox.
-    let acted = false;
+    // Whether an attempt that was sent again (or an earlier copy) may have reached the sandbox.
+    let acted = spec.acted ?? false;
     // Names the last attempt's failure, if any, so a call cut short by its
     // deadline still says what it was waiting out (a 503, a rate limit).
     const pastDeadline = (last) => {
@@ -483,9 +606,10 @@ export async function request(config, spec) {
         let error = new PrizedError('timeout', `The time allowed for this call ran out.${tail}`, { sandboxId, cause: last });
         // A command is sent again only when it provably never arrived, so every
         // attempt of one cut short this way never reached the sandbox. A staged
-        // upload's copies may have, unless each provably never arrived.
-        if (effect !== undefined && spec.retry !== 'safe')
-            error = withOutcome(error, effect, spec.retry === 'staged' && acted ? 'maybe' : 'never');
+        // upload's copies may have, unless each provably never arrived, and so
+        // may a keyed start's (the one `safe` request that names an effect).
+        if (effect !== undefined)
+            error = withOutcome(error, effect, spec.retry !== 'exec' && acted ? 'maybe' : 'never');
         cutShort.add(error);
         return error;
     };
@@ -523,7 +647,10 @@ export async function request(config, spec) {
             }
             const unsentAttempt = !outcome.timedOut && neverSent(outcome.error);
             failure = failed(outcome.timedOut
-                ? new PrizedError('timeout', `No answer within ${attemptMs} ms`, { sandboxId, cause: outcome.error })
+                ? new PrizedError('timeout', outcome.stalled ? `No bytes moved for ${spec.stallMs} ms` : `No answer within ${attemptMs} ms`, {
+                    sandboxId,
+                    cause: outcome.error,
+                })
                 : unsentAttempt
                     ? new PrizedError('network_error', null, { sandboxId, cause: outcome.error })
                     : new PrizedError('network_error', lostMessage(spec.method, url, outcome.error), { sandboxId, cause: outcome.error }));
@@ -548,7 +675,8 @@ export async function request(config, spec) {
                 }
             }
             if (answer.status >= 300 && answer.status < 400) {
-                throw failed(new PrizedError('unexpected_redirect', null, { status: answer.status, sandboxId }));
+                // A refusal; worded only when an earlier copy of a keyed start may have arrived.
+                throw raised(failed(new PrizedError('unexpected_redirect', null, { status: answer.status, sandboxId })), null, acted, effect);
             }
             const retryAfter = parseRetryAfter(answer.headers.get('retry-after'), config.now());
             failure = failed(errorFromResponse(answer.status, answer.text, retryAfter, sandboxId, urlPath(url)));

package/dist/esm/outcome.d.ts

@@ -49,6 +49,15 @@ export declare function withOutcome(error: PrizedError, effect: Effect, outcome:
  * connection closes. TypeScript only: the Python SDK takes no signal.
  */
 export declare function withAbort(error: PrizedError, effect: Effect, outcome: 'never' | 'maybe' | 'did'): PrizedError;
+/**
+ * What a start that gave up throws when the failure it gives up with
+ * (`failure`, Outage's pick) is not the last copy's own: an earlier copy's,
+ * worded before a later copy may have reached the sandbox, or what a copy
+ * cut short by the window met, not yet worded. Worded for the start: as one
+ * that may have started when any copy may have reached the sandbox
+ * (`anyActed`), else as one that never did. The Python SDK's start_gave_up.
+ */
+export declare function startGaveUp(failure: PrizedError, anyActed: boolean): PrizedError;
 /**
  * A background start that may have started (`error`, from withOutcome or
  * withAbort) and that the SDK then stopped by its run id (`stopped`: the

package/dist/esm/outcome.js

@@ -90,12 +90,14 @@ function maybeTail(effect, closed) {
         tail += ` ${effect.check}`;
     return tail;
 }
+/** How an error says its request never reached the sandbox (withOutcome). */
+const NEVER_TAIL = ' It never reached the sandbox, so it had no effect.';
 /** `error` (same code, status and body), its message saying what it means for `effect`. */
 export function withOutcome(error, effect, outcome) {
     if (outcome === null)
         return error;
     if (outcome === 'never')
-        return restate(error, `${trimmed(error.message)}. It never reached the sandbox, so it had no effect.`);
+        return restate(error, `${trimmed(error.message)}.${NEVER_TAIL}`);
     if (outcome === 'did')
         return acting(error, `${effect.did}, but the answer could not be read (${detail(error)}).`);
     return acting(error, `No clear answer came back (${detail(error)}), so ${maybeTail(effect, false)}`);
@@ -119,6 +121,23 @@ function stopTail(runId, stopped) {
         ? ` The SDK stopped ${runId}, or it had already ended.`
         : ` The SDK could not confirm it stopped: it may still be running as ${runId} (exec('ps -ef | grep ${runId}') finds it).`;
 }
+/**
+ * What a start that gave up throws when the failure it gives up with
+ * (`failure`, Outage's pick) is not the last copy's own: an earlier copy's,
+ * worded before a later copy may have reached the sandbox, or what a copy
+ * cut short by the window met, not yet worded. Worded for the start: as one
+ * that may have started when any copy may have reached the sandbox
+ * (`anyActed`), else as one that never did. The Python SDK's start_gave_up.
+ */
+export function startGaveUp(failure, anyActed) {
+    if (acted.has(failure))
+        return failure;
+    const never = failure.message.endsWith(NEVER_TAIL);
+    if (never && !anyActed)
+        return failure;
+    const plain = never ? restate(failure, failure.message.slice(0, -NEVER_TAIL.length)) : failure;
+    return withOutcome(plain, startEffect(), anyActed ? 'maybe' : 'never');
+}
 /**
  * A background start that may have started (`error`, from withOutcome or
  * withAbort) and that the SDK then stopped by its run id (`stopped`: the

package/dist/esm/output.js

@@ -18,7 +18,7 @@
 // (sdk/python/src/prized/_output.py), rendered the same; both SDKs check
 // them against sdk/output-scripts/.
 import { OutputReadError, PrizedError } from './errors.js';
-import { request } from './http.js';
+import { request, timing } from './http.js';
 import { restate } from './outcome.js';
 import { LAUNCH_PATH } from './shell.js';
 import { helperExec, MAX_FILE_BYTES, MAX_OUTPUT_BYTES, rawExec } from './toolbox.js';
@@ -270,6 +270,7 @@ async function download(toolbox, path, signal) {
         retry: 'safe',
         read: 'bytes',
         timeoutMs: READ_MS,
+        stallMs: timing.transferStallMs,
         deadline: toolbox.config.now() + READ_MS,
         signal,
         sandboxId: toolbox.sandboxId,

package/dist/esm/sandbox.d.ts

@@ -128,8 +128,9 @@ export declare class Sandbox {
     /**
      * Delete every sandbox carrying all of `labels` (at least one) and resolve
      * with their ids (the API takes up to 250 a request; this repeats it until
-     * none are left). Safe to repeat: sandboxes already being
-     * deleted are in the answer again, and none matching resolves `[]`. Each
+     * none are left). Each request selects the current matches, so a repeat
+     * can delete sandboxes created since the first request. An uncertain
+     * answer is not retried; list the matches before deleting again. Each
      * counts toward the workspace's quotas until it is gone;
      * `Sandbox.list({ labels })` coming back empty means they all are.
      */

package/dist/esm/sandbox.js

@@ -437,8 +437,9 @@ export class Sandbox {
     /**
      * Delete every sandbox carrying all of `labels` (at least one) and resolve
      * with their ids (the API takes up to 250 a request; this repeats it until
-     * none are left). Safe to repeat: sandboxes already being
-     * deleted are in the answer again, and none matching resolves `[]`. Each
+     * none are left). Each request selects the current matches, so a repeat
+     * can delete sandboxes created since the first request. An uncertain
+     * answer is not retried; list the matches before deleting again. Each
      * counts toward the workspace's quotas until it is gone;
      * `Sandbox.list({ labels })` coming back empty means they all are.
      */
@@ -452,7 +453,15 @@ export class Sandbox {
         const deleted = new Set();
         const stuck = (calls) => new PrizedError('delete_incomplete', `Deleted ${deleted.size} sandboxes in ${calls} requests and some are left; call again to delete the rest.`);
         for (let call = 1; call <= MAX_BULK_DELETE_CALLS; call += 1) {
-            const result = await request(config, { method: 'DELETE', url: apiUrl(config, `/sandboxes${query}`), retry: 'safe', deadline });
+            // A label is a live selector, not a stable resource or idempotency key.
+            const result = await request(config, {
+                method: 'DELETE', url: apiUrl(config, `/sandboxes${query}`), retry: 'exec', deadline,
+                effect: {
+                    maybe: 'some matching sandboxes may already be deleting',
+                    did: 'The matching sandboxes were marked for deletion',
+                    check: 'It was not sent again: list the matching sandboxes before deleting again, because the matches may have changed.',
+                },
+            });
             const answer = result.json;
             const ids = answer?.ids;
             if (!Array.isArray(ids) || !ids.every((id) => typeof id === 'string')) {

package/dist/esm/shell.d.ts

@@ -11,7 +11,8 @@ export declare const RUN_ID_RE: RegExp;
 /**
  * Minutes (by the sandbox's clock) a cleaned or abandoned run's directory
  * stays: what keeps a resend of its start from running the command again.
- * The SDK stops resending a start within minutes, so an hour is ample; each
+ * The SDK stops resending a start once pollOutageMs (2 minutes by default)
+ * has run out after its first copy's retries, so an hour is ample; each
  * cleanup then removes the ones older than that, so they never pile up.
  */
 export declare const CLEANED_KEEP_MIN = 60;

package/dist/esm/shell.js

@@ -50,7 +50,8 @@ export const RUN_ID_RE = /^run_[0-9a-f]{16}$/;
 /**
  * Minutes (by the sandbox's clock) a cleaned or abandoned run's directory
  * stays: what keeps a resend of its start from running the command again.
- * The SDK stops resending a start within minutes, so an hour is ample; each
+ * The SDK stops resending a start once pollOutageMs (2 minutes by default)
+ * has run out after its first copy's retries, so an hour is ample; each
  * cleanup then removes the ones older than that, so they never pile up.
  */
 export const CLEANED_KEEP_MIN = 60;

package/dist/esm/toolbox.d.ts

@@ -30,6 +30,8 @@ export declare function rawExec(toolbox: Toolbox, req: RawExecRequest, options:
     deadline?: number | undefined;
     /** What the command does, for an error that says whether it happened (`exec`: a command unless given). */
     effect?: Effect | undefined;
+    /** An earlier copy of a keyed start may have reached the sandbox. */
+    acted?: boolean | undefined;
 }): Promise<ExecResult>;
 /** A helper command the SDK sends itself; a non-zero exit is the caller's to judge. */
 export declare function helperExec(toolbox: Toolbox, command: string, options?: {

package/dist/esm/toolbox.js

@@ -46,6 +46,7 @@ export async function rawExec(toolbox, req, options) {
         deadline: options.deadline,
         sandboxId: toolbox.sandboxId,
         ...(effect === undefined ? {} : { effect }),
+        ...(options.acted ? { acted: true } : {}),
     });
     const doc = result.json;
     if (doc === null || typeof doc !== 'object' || typeof doc.exitCode !== 'number') {

package/dist/esm/version.d.ts

@@ -1,2 +1,2 @@
 /** This package's version; test/version.test.ts holds it equal to package.json. */
-export declare const VERSION = "0.1.1";
+export declare const VERSION = "0.1.2";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
 /** This package's version; test/version.test.ts holds it equal to package.json. */
-export const VERSION = '0.1.1';
+export const VERSION = '0.1.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prized/sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Prized Sandboxes (beta): create microVM sandboxes, run commands, move files, pause, resume and fork them from TypeScript.",
   "homepage": "https://prized.dev/docs/sandboxes",
   "license": "Apache-2.0",