@prized/sdk 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,21 +1,23 @@
1
1
  // exec(..., { fullOutput: true }): one call that keeps a command's whole
2
2
  // output, not just the first 4 MiB of each stream the sandbox answers with.
3
3
  //
4
- // The command's stdout and stderr stay pipes, as in a plain exec. A reader on
5
- // each copies what comes through to a file in the exec's own directory, at a
6
- // fixed path under the sandbox user's home, and drops what passes 100 MiB, so
7
- // a runaway command cannot fill the disk:
4
+ // The command's stdout and stderr stay pipes, as in a plain exec. A relay on
5
+ // each passes what comes through to a reader that copies it to a file in the
6
+ // exec's own directory, at a fixed path under the sandbox user's home, and
7
+ // drops what passes 100 MiB, so a runaway command cannot fill the disk:
8
8
  //
9
9
  // ~/.prized/exec/<exec id>/stdout
10
10
  // ~/.prized/exec/<exec id>/stderr
11
11
  //
12
12
  // Both under 4 MiB: the script prints them back and removes the directory,
13
- // so the answer carries the same output a plain exec's does. Bigger: it
14
- // prints one marker line instead, and the SDK downloads both files through
15
- // the files API and removes the directory. The scripts are the Python SDK's
13
+ // so the answer carries the same output a plain exec's does. Bigger, or a
14
+ // reader that could not write its file (a full disk): it prints one marker
15
+ // line instead, and the SDK downloads both files through the files API and
16
+ // removes the directory. A stream whose write failed comes back as far as it
17
+ // got, `truncated` with `truncatedReason: 'write_failed'`. The scripts are the Python SDK's
16
18
  // (sdk/python/src/prized/_output.py), rendered the same; both SDKs check
17
19
  // them against sdk/output-scripts/.
18
- import { PrizedError } from './errors.js';
20
+ import { OutputReadError, PrizedError } from './errors.js';
19
21
  import { request } from './http.js';
20
22
  import { restate } from './outcome.js';
21
23
  import { LAUNCH_PATH } from './shell.js';
@@ -49,45 +51,102 @@ function checkId(id) {
49
51
  throw new Error(`unreachable: bad exec id ${id}`);
50
52
  }
51
53
  /**
52
- * The reader on one stream: tee copies it to the file as it comes (each read
53
- * written at once) until the file reaches FULL_OUTPUT_BYTES and one 512-byte
54
- * block more, which tells a cut stream from a full one. The file size limit
55
- * (ulimit -f, in 512-byte blocks in POSIX mode) stops the file there with
56
- * EFBIG, not SIGXFSZ, and tee goes on draining into /dev/null, so the command
57
- * never meets a closed pipe and a runaway one cannot fill the disk. One
58
- * process per stream (exec), in a session of its own (setsid, same pid): a
59
- * time limit or a `kill 0` that ends the command's process group leaves it to
54
+ * The reader's own shell (`$1` the file, `$2` its flag): cat writes the file
55
+ * until a write fails; then the flag, an empty file (it takes no free block),
56
+ * then the rest drained into /dev/null, and exit 1. `true`, not `:`: a
57
+ * redirection that fails on a special builtin ends the shell, and with it
58
+ * the draining.
59
+ */
60
+ const READER_SHELL = `'cat > "$1" || { true > "$2" || :; cat > /dev/null; exit 1; }'`;
61
+ /**
62
+ * The reader on one stream: cat copies what the relay passes it to the file
63
+ * as it comes (each read written at once) until the file reaches
64
+ * FULL_OUTPUT_BYTES and one 512-byte block more, which tells a cut stream
65
+ * from a full one. The file size limit (ulimit -f, in 512-byte blocks in
66
+ * POSIX mode) stops the file there with EFBIG, not SIGXFSZ, and the reader
67
+ * goes on draining into /dev/null, so the command never meets a closed pipe
68
+ * and a runaway one cannot fill the disk. A write that fails short of that (a
69
+ * full disk) stops the file the same way. Either leaves `<name>.failed` at
70
+ * once, which collect reads when a time limit ended the script before it
71
+ * could wait for the reader, and the reader exits 1 once its input ends. A
72
+ * shell per stream (exec), in a session of its own (setsid, same pid): a time
73
+ * limit or a `kill 0` that ends the command's process group leaves it to
60
74
  * drain what the pipe still holds.
61
75
  */
62
76
  function reader(d, name, fifo) {
63
77
  const blocks = FULL_OUTPUT_BYTES / 512 + 1;
64
78
  return (`( exec > /dev/null 2>&1; PATH=${LAUNCH_PATH}; trap '' XFSZ; ( set -o posix ) && set -o posix; ` +
65
- `ulimit -f ${blocks} || :; exec setsid tee ${d}/${name} < ${d}/${fifo} ) &`);
79
+ `ulimit -f ${blocks} || :; exec setsid /bin/sh -c ${READER_SHELL} sh ${d}/${name} ${d}/${name}.failed < ${d}/${fifo} ) &`);
80
+ }
81
+ /**
82
+ * The relay on one stream: cat reads the command's pipe and passes it on to
83
+ * the reader's. It is what the watchdog stops, never the reader, so the
84
+ * reader always ends on the end of its input, and its exit status says
85
+ * whether every write to its file went through. In a session of its own
86
+ * (setsid, same pid), as the reader is.
87
+ */
88
+ function relay(d, from, to) {
89
+ return `( exec > ${d}/${to} 2> /dev/null < /dev/null; PATH=${LAUNCH_PATH}; exec setsid cat ${d}/${from} ) &`;
90
+ }
91
+ /**
92
+ * A shell test: process `pid` (shell text) is this exec's relay on `fifo`,
93
+ * not another process that reused its pid. Its arguments must be exactly
94
+ * `cat <fifo>` (as setsid execs it), not merely name the exec's directory
95
+ * somewhere in the command line, as a process the command started may
96
+ * (`tail -f ~/.prized/exec/<id>/stdout`). /proc ends each argument with a
97
+ * NUL; here each is one line (a NUL becomes a newline, a newline a space),
98
+ * as the run scripts' isRun (shell.ts) reads them.
99
+ */
100
+ function isRelay(pid, fifo) {
101
+ return `[ "$(tr "\\0\\n" "\\n " < "/proc/${pid}/cmdline" 2> /dev/null | tr "\\n" " ")" = "cat ${fifo} " ]`;
66
102
  }
67
103
  /**
68
104
  * The bound on waiting for the readers once the command has ended: GRACE_S
69
- * seconds, as the sandbox waits for a plain exec's pipes, then the readers
70
- * still running stop (a pid is checked to be this exec's tee first, never
71
- * one reused since), and a process the command left holding its output
72
- * meets a closed pipe, as it would there. Stopped early (TERM, once the
73
- * readers are done), it takes its sleep with it.
105
+ * seconds, as the sandbox waits for a plain exec's pipes, then the relays
106
+ * still running stop (each pid checked to be this exec's relay on its own
107
+ * pipe first, never one reused since): its reader then ends with what came
108
+ * through, and a process the command left holding its output meets a closed
109
+ * pipe, as it would there. Stopped early (TERM, once the readers are done),
110
+ * it takes its sleep with it.
74
111
  */
75
112
  function watchdog(d) {
76
113
  return (`( s=; trap '[ -z "$s" ] || kill "$s" 2> /dev/null; exit 0' TERM; sleep ${GRACE_S} & s=$!; wait "$s" || :; ` +
77
- `for p in "$2" "$3"; do if tr "\\0" " " < "/proc/$p/cmdline" 2> /dev/null | grep -qF -- ${d}/; then kill "$p" 2> /dev/null || :; fi; done ) > /dev/null 2>&1 &`);
114
+ `if ${isRelay('$4', `${d}/o`)}; then kill "$4" 2> /dev/null || :; fi; ` +
115
+ `if ${isRelay('$5', `${d}/e`)}; then kill "$5" 2> /dev/null || :; fi ) > /dev/null 2>&1 &`);
78
116
  }
79
- /** Sizes, the cut past FULL_OUTPUT_BYTES and the marker line, with `d` set to the directory. */
117
+ /**
118
+ * Sizes, the cut past FULL_OUTPUT_BYTES and the marker line, with `d` set to
119
+ * the directory and each reader's write failure in `x` and `y` (1 or 0,
120
+ * failedLines). A cut leaves `<name>.cut`, so collect sent again still reads
121
+ * the stream as past the bound (its flag is still there, its size no longer
122
+ * says so). `true`, not `:`, for the same reason as in READER_SHELL.
123
+ */
80
124
  function reportLines(id) {
81
125
  const max = FULL_OUTPUT_BYTES;
82
126
  return {
83
127
  sizes: ['o=$(stat -c %s "$d/stdout" 2> /dev/null || echo 0)', 'e=$(stat -c %s "$d/stderr" 2> /dev/null || echo 0)'],
84
128
  cut: [
85
- `if [ "$o" -gt ${max} ]; then truncate -s ${max} "$d/stdout" || :; fi`,
86
- `if [ "$e" -gt ${max} ]; then truncate -s ${max} "$d/stderr" || :; fi`,
87
- `echo "prized-output ${id} $o $e"`,
129
+ `if [ "$o" -gt ${max} ]; then truncate -s ${max} "$d/stdout" && true > "$d/stdout.cut" || :; fi`,
130
+ `if [ "$e" -gt ${max} ]; then truncate -s ${max} "$d/stderr" && true > "$d/stderr.cut" || :; fi`,
131
+ `echo "prized-output ${id} $o $e $x $y"`,
88
132
  ],
89
133
  };
90
134
  }
135
+ /**
136
+ * Whether each reader failed to write its file (`x` for stdout, `y` for
137
+ * stderr: nonzero from its exit status, or its flag, after `sizes`): 1 when
138
+ * it ended in error short of the bound (a full disk or a quota, a file it
139
+ * could not create, a reader killed), else 0. Past the bound its error is the
140
+ * cut (EFBIG). The watchdog stops relays, never readers, so a reader's status
141
+ * is its own.
142
+ */
143
+ function failedLines() {
144
+ const max = FULL_OUTPUT_BYTES;
145
+ return [
146
+ `if [ "$x" -eq 0 ] || [ "$o" -gt ${max} ]; then x=0; else x=1; fi`,
147
+ `if [ "$y" -eq 0 ] || [ "$e" -gt ${max} ]; then y=0; else y=1; fi`,
148
+ ];
149
+ }
91
150
  /**
92
151
  * The script a fullOutput exec runs (RUN_SCRIPT, from SCRIPT_VAR). The
93
152
  * caller's command, from COMMAND_VAR, runs as a plain exec runs it (`bash
@@ -97,10 +156,12 @@ function reportLines(id) {
97
156
  * Nothing is assigned before it runs but the positional parameters, so every
98
157
  * variable the caller's env sets reaches it unchanged, PATH included; and
99
158
  * every step holds under an errexit the env may switch on (SHELLOPTS). As in
100
- * a plain exec, the readers stop 5 s after the command ends if a process it
159
+ * a plain exec, the relays stop 5 s after the command ends if a process it
101
160
  * left running still holds its output, keeping what came through. A command
102
- * a signal ends exits 128+n, as a background command does. Without tee,
103
- * setsid or a directory to write to, the command runs as a plain exec.
161
+ * a signal ends exits 128+n, as a background command does. A reader that
162
+ * could not write its file (failedLines) sends the output to the files API
163
+ * whatever its size, with the marker saying which. Without /bin/sh, setsid,
164
+ * cat or a directory to write to, the command runs as a plain exec.
104
165
  */
105
166
  export function captureScript(id) {
106
167
  checkId(id);
@@ -109,21 +170,28 @@ export function captureScript(id) {
109
170
  return [
110
171
  `set -- "\${${COMMAND_VAR}:?}" /bin/bash; unset ${COMMAND_VAR} ${SCRIPT_VAR}; [ -x "$2" ] || set -- "$1" /bin/sh`,
111
172
  `if ( PATH=${LAUNCH_PATH}; mkdir -p ${OUTPUT_DIR} && mkdir ${d} ) 2> /dev/null; then`,
112
- `if ( PATH=${LAUNCH_PATH}; command -v tee && command -v setsid && mkfifo ${d}/o ${d}/e ) > /dev/null 2>&1; then`,
113
- reader(d, 'stdout', 'o'),
173
+ `if ( PATH=${LAUNCH_PATH}; [ -x /bin/sh ] && command -v setsid && command -v cat && mkfifo ${d}/o ${d}/e ${d}/p ${d}/q ) > /dev/null 2>&1; then`,
174
+ // The command writes to o and e; a relay passes each on to p and q, where its reader is.
175
+ reader(d, 'stdout', 'p'),
114
176
  'set -- "$1" "$2" "$!"',
115
- reader(d, 'stderr', 'e'),
177
+ reader(d, 'stderr', 'q'),
116
178
  'set -- "$1" "$2" "$3" "$!"',
179
+ relay(d, 'o', 'p'),
180
+ 'set -- "$1" "$2" "$3" "$4" "$!"',
181
+ relay(d, 'e', 'q'),
182
+ 'set -- "$1" "$2" "$3" "$4" "$5" "$!"',
117
183
  // bash's "Killed" line for a command a signal ended goes to the braces' /dev/null.
118
- `if { "$2" -c "$1" > ${d}/o 2> ${d}/e < /dev/null; } 2> /dev/null; then set -- 0 "$3" "$4"; else set -- "$?" "$3" "$4"; fi`,
184
+ `if { "$2" -c "$1" > ${d}/o 2> ${d}/e < /dev/null; } 2> /dev/null; then set -- 0 "$3" "$4" "$5" "$6"; else set -- "$?" "$3" "$4" "$5" "$6"; fi`,
119
185
  `PATH=${LAUNCH_PATH}`,
120
186
  `c=$1; d=${d}`,
121
187
  watchdog(d),
122
188
  'w=$!',
123
- 'wait "$2" "$3" 2> /dev/null || :',
189
+ 'if wait "$2" 2> /dev/null; then x=0; else x=$?; fi',
190
+ 'if wait "$3" 2> /dev/null; then y=0; else y=$?; fi',
124
191
  'kill "$w" 2> /dev/null || :',
125
192
  ...sizes,
126
- `if [ "$o" -lt ${MAX_OUTPUT_BYTES} ] && [ "$e" -lt ${MAX_OUTPUT_BYTES} ]; then ` +
193
+ ...failedLines(),
194
+ `if [ "$o" -lt ${MAX_OUTPUT_BYTES} ] && [ "$e" -lt ${MAX_OUTPUT_BYTES} ] && [ "$x$y" = 00 ]; then ` +
127
195
  'cat "$d/stdout" 2> /dev/null || :; cat "$d/stderr" >&2 2> /dev/null || :; rm -rf "$d" || :; exit "$c"; fi',
128
196
  ...cut,
129
197
  'exit "$c"',
@@ -137,7 +205,10 @@ export function captureScript(id) {
137
205
  * What a fullOutput command left when the script could not print it (its
138
206
  * time limit, or a signal, ended the script): the marker line, or `gone`,
139
207
  * with the directory removed, when there is nothing to read (it was never
140
- * made, or its output was already printed back).
208
+ * made, or its output was already printed back). A failed write is read from
209
+ * the reader's flag, before the size, which is final once the flag is there
210
+ * (the script's wait for the reader's exit status went with the script); a
211
+ * reader killed, or one that could not make its flag, is not seen here.
141
212
  */
142
213
  export function collectScript(id) {
143
214
  checkId(id);
@@ -146,7 +217,13 @@ export function collectScript(id) {
146
217
  `d=${OUTPUT_DIR}/${id}`,
147
218
  `PATH=${LAUNCH_PATH}`,
148
219
  `if [ ! -f "$d/stdout" ] || [ ! -f "$d/stderr" ]; then rm -rf "$d" || :; echo "prized-output ${id} gone"; exit 0; fi`,
220
+ 'if [ -e "$d/stdout.failed" ]; then x=1; else x=0; fi',
221
+ 'if [ -e "$d/stderr.failed" ]; then y=1; else y=0; fi',
149
222
  ...sizes,
223
+ // Cut by an earlier collect whose answer was lost: as long as a cut stream (the bound and a block).
224
+ `if [ -e "$d/stdout.cut" ]; then o=$((${FULL_OUTPUT_BYTES} + 512)); fi`,
225
+ `if [ -e "$d/stderr.cut" ]; then e=$((${FULL_OUTPUT_BYTES} + 512)); fi`,
226
+ ...failedLines(),
150
227
  ...cut,
151
228
  ].join('\n');
152
229
  }
@@ -160,14 +237,22 @@ export function removeOutputScript(id) {
160
237
  return (`PATH=${LAUNCH_PATH}; rm -rf ${OUTPUT_DIR}/${id}; ` +
161
238
  `find ${OUTPUT_DIR} -mindepth 1 -maxdepth 1 -name 'exec_*' -mmin +${STALE_MIN} -exec rm -rf -- {} + 2> /dev/null || :`);
162
239
  }
163
- /** The marker's byte counts (a stream cut at FULL_OUTPUT_BYTES reads more), `gone`, or null for no marker. */
240
+ /** The marker (one without failure flags, as an earlier SDK's collect printed, has none), `gone`, or null for no marker. */
164
241
  export function parseMarker(stdout, id) {
165
- const m = new RegExp(`(?:^|\\n)prized-output ${id} (?:([0-9]+) ([0-9]+)|(gone))\\n$`).exec(stdout);
242
+ const m = new RegExp(`(?:^|\\n)prized-output ${id} (?:([0-9]+) ([0-9]+)(?: ([01]) ([01]))?|(gone))\\n$`).exec(stdout);
166
243
  if (m === null)
167
244
  return null;
168
- if (m[3] === 'gone')
245
+ if (m[5] === 'gone')
169
246
  return 'gone';
170
- return { out: Number(m[1]), err: Number(m[2]) };
247
+ return { out: Number(m[1]), err: Number(m[2]), outFailed: m[3] === '1', errFailed: m[4] === '1' };
248
+ }
249
+ /** Why the read-back output is cut, if it is: a failed write first, since it is the one the caller cannot foresee. */
250
+ export function markerTruncation(marker) {
251
+ if (marker.outFailed || marker.errFailed)
252
+ return 'write_failed';
253
+ if (marker.out > FULL_OUTPUT_BYTES || marker.err > FULL_OUTPUT_BYTES)
254
+ return 'output_limit';
255
+ return null;
171
256
  }
172
257
  /** A request the SDK sends on its own to collect or remove the files: best effort, within TEARDOWN_MS. */
173
258
  async function teardown(toolbox, script) {
@@ -193,7 +278,7 @@ async function download(toolbox, path, signal) {
193
278
  return new TextDecoder('utf-8', { ignoreBOM: true }).decode(result.bytes ?? new Uint8Array(0));
194
279
  }
195
280
  /** The files' contents in place of the answer's output. */
196
- async function readBack(toolbox, id, sizes, result, signal) {
281
+ async function readBack(toolbox, id, marker, result, signal) {
197
282
  const dir = `${OUTPUT_DIR}/${id}`;
198
283
  // Both at once; one that fails stops the other, as the caller's abort stops both.
199
284
  const both = new AbortController();
@@ -210,17 +295,17 @@ async function readBack(toolbox, id, sizes, result, signal) {
210
295
  let stdout;
211
296
  let stderr;
212
297
  try {
213
- [stdout, stderr] = await Promise.all([read('stdout', sizes.out), read('stderr', sizes.err)]);
298
+ [stdout, stderr] = await Promise.all([read('stdout', marker.out), read('stderr', marker.err)]);
214
299
  }
215
300
  finally {
216
301
  signal?.removeEventListener('abort', stop);
217
302
  }
218
- return {
219
- ...result,
220
- stdout,
221
- stderr,
222
- truncated: sizes.out > FULL_OUTPUT_BYTES || sizes.err > FULL_OUTPUT_BYTES,
223
- };
303
+ const reason = markerTruncation(marker);
304
+ const { exitCode, durationMs, timedOut } = result;
305
+ const full = { stdout, stderr, exitCode, durationMs, timedOut, truncated: reason !== null };
306
+ if (reason !== null)
307
+ full.truncatedReason = reason;
308
+ return full;
224
309
  }
225
310
  /**
226
311
  * A blocking exec that keeps the whole output (up to FULL_OUTPUT_BYTES of
@@ -245,22 +330,22 @@ export async function execFullOutput(toolbox, id, req, signal) {
245
330
  await teardown(toolbox, removeOutputScript(id));
246
331
  throw error;
247
332
  }
248
- let sizes = parseMarker(result.stdout, id);
249
- if (sizes === null && (result.timedOut || result.exitCode === -1)) {
333
+ let marker = parseMarker(result.stdout, id);
334
+ if (marker === null && (result.timedOut || result.exitCode === -1)) {
250
335
  // Its time limit (or a signal) ended the script with the command, before
251
336
  // it printed anything back: what the command printed is in its files.
252
337
  const collected = await teardown(toolbox, collectScript(id));
253
- sizes = collected === null ? null : parseMarker(collected.stdout, id);
254
- if (sizes === null)
338
+ marker = collected === null ? null : parseMarker(collected.stdout, id);
339
+ if (marker === null)
255
340
  return result; // no answer: nothing more to be done
256
341
  }
257
342
  // No marker: the output came back in the answer (or the command ran as a
258
343
  // plain exec), and the directory is already gone.
259
- if (sizes === null || sizes === 'gone')
344
+ if (marker === null || marker === 'gone')
260
345
  return result;
261
346
  let full;
262
347
  try {
263
- full = await readBack(toolbox, id, sizes, result, signal);
348
+ full = await readBack(toolbox, id, marker, result, signal);
264
349
  }
265
350
  catch (error) {
266
351
  const aborted = !(error instanceof PrizedError) || error.code === 'aborted';
@@ -271,9 +356,18 @@ export async function execFullOutput(toolbox, id, req, signal) {
271
356
  throw error;
272
357
  return result;
273
358
  }
359
+ if (error.code === 'sandbox_deleted') {
360
+ // Nothing is kept: the output went with the sandbox, as its code says for any call on it.
361
+ // The command ran: its exit code goes on the error too, so a caller
362
+ // that replaces the sandbox can tell not to run it again.
363
+ throw restate(error, `The command ran (exit ${result.exitCode}), but the sandbox was deleted before its output could be read back.`, {
364
+ cause: error,
365
+ exitCode: result.exitCode,
366
+ });
367
+ }
274
368
  const dir = `${OUTPUT_DIR}/${id}`;
275
- throw restate(error, `The command ran (exit ${result.exitCode}), but its output could not be read back (${error.message.replace(/[.\s]+$/, '')}). ` +
276
- `It is kept in ${dir}/stdout and ${dir}/stderr for an hour: read them with files.read(), then remove ${dir}.`);
369
+ throw new OutputReadError(`The command ran (exit ${result.exitCode}), but its output could not be read back (${error.message.replace(/[.\s]+$/, '')}). ` +
370
+ `It is kept in ${dir}/stdout and ${dir}/stderr for an hour: read them with files.read(), then remove ${dir}.`, { cause: error, exitCode: result.exitCode, stdoutPath: `${dir}/stdout`, stderrPath: `${dir}/stderr` });
277
371
  }
278
372
  await teardown(toolbox, removeOutputScript(id));
279
373
  return full;
@@ -225,6 +225,32 @@ function failedState(info) {
225
225
  }
226
226
  return null;
227
227
  }
228
+ /** How the API's errorReason starts on each copy it deletes because another
229
+ * copy of the same fork could not start. */
230
+ const FORK_UNDONE_PREFIX = 'fork undone';
231
+ /**
232
+ * The error a fork throws when not every copy runs, or null. The API undoes
233
+ * a fork one of whose copies could not start, deleting every copy, so the
234
+ * copy that failed may already read `deleting`, with its errorReason, by the
235
+ * time it is read: the error is that copy's reason (one that is not the
236
+ * undo's own), else a copy in error, else any non-running copy's state.
237
+ */
238
+ function forkFailure(copies) {
239
+ const failed = copies.filter((copy) => copy.state !== 'running');
240
+ if (failed.length === 0)
241
+ return null;
242
+ const cause = failed.find((copy) => copy.errorReason && !copy.errorReason.startsWith(FORK_UNDONE_PREFIX)) ??
243
+ failed.find((copy) => copy.state === 'error') ??
244
+ failed.find((copy) => copy.errorReason) ??
245
+ failed[0];
246
+ if (cause.errorReason) {
247
+ return new PrizedError('sandbox_error', `The sandbox failed: ${cause.errorReason}`, {
248
+ sandboxId: cause.id,
249
+ reason: cause.errorReason,
250
+ });
251
+ }
252
+ return failedState(cause) ?? new PrizedError('sandbox_error', null, { sandboxId: cause.id });
253
+ }
228
254
  /**
229
255
  * A wait's timeout. One ended by a read its deadline cut short (the retry it
230
256
  * was due would have ended past it: a 503's Retry-After, say) may come
@@ -560,9 +586,9 @@ export class Sandbox {
560
586
  return children;
561
587
  try {
562
588
  await Sandbox.settle(this.config, children, deadline, timeoutMs, options.signal, this.id);
563
- const failed = children.find((child) => child.state !== 'running');
589
+ const failed = forkFailure(children.map((child) => child.current));
564
590
  if (failed)
565
- throw failedState(failed.current) ?? new PrizedError('sandbox_error', null, { sandboxId: failed.id });
591
+ throw failed;
566
592
  }
567
593
  catch (error) {
568
594
  // All or nothing: copies the caller will never get are not left billing.
@@ -58,13 +58,15 @@ export async function rawExec(toolbox, req, options) {
58
58
  }
59
59
  const stdout = typeof doc.stdout === 'string' ? doc.stdout : '';
60
60
  const stderr = typeof doc.stderr === 'string' ? doc.stderr : '';
61
+ const truncated = keptBytes(stdout) >= MAX_OUTPUT_BYTES || keptBytes(stderr) >= MAX_OUTPUT_BYTES;
61
62
  return {
62
63
  stdout,
63
64
  stderr,
64
65
  exitCode: doc.exitCode,
65
66
  durationMs: typeof doc.durationMs === 'number' ? doc.durationMs : 0,
66
67
  timedOut: doc.timedOut === true,
67
- truncated: keptBytes(stdout) >= MAX_OUTPUT_BYTES || keptBytes(stderr) >= MAX_OUTPUT_BYTES,
68
+ truncated,
69
+ ...(truncated ? { truncatedReason: 'output_limit' } : {}),
68
70
  };
69
71
  }
70
72
  /** A helper command the SDK sends itself; a non-zero exit is the caller's to judge. */
@@ -70,10 +70,22 @@ export interface ExecResult {
70
70
  * True when stdout or stderr reached the 4 MiB per-stream cap of a single
71
71
  * call: the command kept running, the rest of that stream was dropped.
72
72
  * Pass `fullOutput: true` for commands that may print more (it keeps up
73
- * to 100 MiB of each stream, and sets this past that).
73
+ * to 100 MiB of each stream, and sets this past that). `truncatedReason`
74
+ * says why.
74
75
  */
75
76
  truncated: boolean;
77
+ /**
78
+ * Why `truncated` is true; absent when it is false. `output_limit`: a
79
+ * stream reached its cap (4 MiB in one call, 100 MiB with `fullOutput`).
80
+ * `write_failed` (`fullOutput` only): the sandbox could not save a stream
81
+ * as the command printed it, most often because its disk is full, so that
82
+ * stream stops where the write failed, however short; free some space and
83
+ * run it again.
84
+ */
85
+ truncatedReason?: TruncatedReason;
76
86
  }
87
+ /** Why a command's output was cut: ExecResult.truncatedReason. */
88
+ export type TruncatedReason = 'output_limit' | 'write_failed';
77
89
  /** One directory entry, as `sandbox.files.list()` returns it. */
78
90
  export interface FileInfo {
79
91
  name: string;
@@ -1,2 +1,2 @@
1
1
  /** This package's version; test/version.test.ts holds it equal to package.json. */
2
- export declare const VERSION = "0.1.0";
2
+ export declare const VERSION = "0.1.1";
@@ -1,2 +1,2 @@
1
1
  /** This package's version; test/version.test.ts holds it equal to package.json. */
2
- export const VERSION = '0.1.0';
2
+ export const VERSION = '0.1.1';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prized/sdk",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Prized Sandboxes (beta): create microVM sandboxes, run commands, move files, pause, resume and fork them from TypeScript.",
5
5
  "homepage": "https://prized.dev/docs/sandboxes",
6
6
  "license": "Apache-2.0",