@poe-platform/safe-bash 0.1.441 → 0.1.443

package/dist/safe-bash/shell/runtime.js

@@ -1,3 +1,4 @@
+import { PublicDiagnostic, publicDiagnosticMessage } from "../diagnostics.js";
 import { writeDiagnostic } from "../escaping.js";
 import { cancelTurn, monotonicNow, registerYieldCheckpoint, scheduleTurn, yieldTurn } from "../contracts/yield.js";
 import { ACCESS_MODES, FsError, composeMiddleware, createBytePipe, pipeBytes, resolvePath, toByteSource, validateExitCode, writeText, } from "../contracts/index.js";
@@ -77,6 +78,7 @@ export function resolveLimits(...limits) {
 const budgetedSinks = new WeakMap();
 export class Budget {
     limits;
+    onInternalError;
     executionScope = Object.freeze({});
     pathLookup = new PathLookup();
     parsing;
@@ -92,8 +94,9 @@ export class Budget {
     #pipelineStages = 0;
     #fileSystemOperations = 0;
     #cpuStarted = monotonicNow();
-    constructor(limits, signal) {
+    constructor(limits, signal, onInternalError) {
         this.limits = limits;
+        this.onInternalError = onInternalError;
         this.signal = signal ? AbortSignal.any([signal, this.controller.signal]) : this.controller.signal;
         this.parsing = new ParseBudget(limits.maxParseUnits, this.signal, error => this.controller.abort(error));
         this.values = new ValueArena(limits.maxExpansionBytes, limits.maxExpansionFields, () => this.signal.throwIfAborted(), limit => this.fail(limit));
@@ -539,11 +542,18 @@ function saturatedSum(left, right) {
 function errorCode(error) {
     return typeof error === "object" && error !== null && "code" in error ? String(error.code) : undefined;
 }
-function message(error) { return error instanceof Error ? error.message : String(error); }
-function filesystemDiagnostic(error, target) {
+function message(error, onInternalError) {
+    if (error instanceof ExpansionFailure || error instanceof CommandFailure || error instanceof ArrayFailure || error instanceof BraceExpansionFailure)
+        return error.message;
+    return publicDiagnosticMessage(error, onInternalError);
+}
+function filesystemDiagnostic(error, target, onInternalError) {
     const descriptions = { ENOENT: "No such file or directory", EACCES: "Permission denied", EPERM: "Operation not permitted", ENOTDIR: "Not a directory", EISDIR: "Is a directory", ELOOP: "Too many levels of symbolic links", ENOSPC: "No space left on device", EROFS: "Read-only file system" };
     const description = descriptions[errorCode(error) ?? ""];
-    return description ? `${target}: ${description}` : undefined;
+    if (!description)
+        return undefined;
+    publicDiagnosticMessage(error, onInternalError);
+    return `${target}: ${description}`;
 }
 function cdUtf8Width(codePoint) {
     return codePoint <= 0x7f ? 1 : codePoint <= 0x7ff ? 2 : codePoint <= 0xffff ? 3 : 4;
@@ -583,7 +593,7 @@ class CdLookup {
     async charge(amount) {
         this.signal.throwIfAborted();
         if (amount > 8_388_608 - this.spent)
-            throw new Error("cd: helper work limit exceeded");
+            throw new PublicDiagnostic("cd: helper work limit exceeded");
         while (amount > 0) {
             const step = Math.min(amount, 128 - this.spent % 128);
             this.spent += step;
@@ -605,9 +615,9 @@ class CdLookup {
             const codePoint = value.codePointAt(index);
             const width = cdUtf8Width(codePoint);
             if (bytes + width > 65_536)
-                throw new Error(search ? "cd: CDPATH exceeds 65536 UTF-8 bytes" : "cd: path exceeds 65536 UTF-8 bytes");
+                throw new PublicDiagnostic(search ? "cd: CDPATH exceeds 65536 UTF-8 bytes" : "cd: path exceeds 65536 UTF-8 bytes");
             if (search && codePoint === 58 && ++slots > 4096)
-                throw new Error("cd: CDPATH exceeds 4096 components");
+                throw new PublicDiagnostic("cd: CDPATH exceeds 4096 components");
             await this.charge(width);
             if (search && codePoint === 58) {
                 components.push({ start, end: index, bytes: bytes - startBytes });
@@ -631,7 +641,7 @@ class CdLookup {
             const rawBytes = absolute ? targetBytes : component.startsWith("/") ? componentBytes + 1 + targetBytes
                 : cwdBytes + 1 + (component ? componentBytes + 1 : 0) + targetBytes;
             if (rawBytes > 65_536)
-                throw new Error("cd: path exceeds 65536 UTF-8 bytes");
+                throw new PublicDiagnostic("cd: path exceeds 65536 UTF-8 bytes");
             await this.charge(2 * rawBytes);
             const raw = absolute ? target : component.startsWith("/") ? `${component}/${target}`
                 : component ? `${cwd}/${component}/${target}` : `${cwd}/${target}`;
@@ -639,7 +649,7 @@ class CdLookup {
             await this.scan(path);
             this.signal.throwIfAborted();
             if (++this.probes > 4097)
-                throw new Error("cd: probe limit exceeded");
+                throw new PublicDiagnostic("cd: probe limit exceeded");
             await this.charge(1);
             this.signal.throwIfAborted();
             const stat = await fs.stat(path, { signal: this.signal });
@@ -812,7 +822,7 @@ class DirectoryStackWork {
         await this.flushOutput();
     }
 }
-const closedSink = { async write() { throw Object.assign(new Error("Bad file descriptor"), { code: "EBADF" }); } };
+const closedSink = { async write() { throw Object.assign(new PublicDiagnostic("Bad file descriptor"), { code: "EBADF" }); } };
 const closedSource = { [Symbol.asyncIterator]() {
         let closed = false;
         let completion = Promise.resolve();
@@ -827,7 +837,7 @@ const closedSource = { [Symbol.asyncIterator]() {
                     if (closed)
                         return { done: true, value: undefined };
                     closed = true;
-                    throw Object.assign(new Error("Bad file descriptor"), { code: "EBADF" });
+                    throw Object.assign(new PublicDiagnostic("Bad file descriptor"), { code: "EBADF" });
                 });
             },
             return(value) { return enqueue(async () => { closed = true; return { done: true, value: await value }; }); },
@@ -1307,7 +1317,7 @@ export class Runtime {
         if (arrayStore(state)?.get(name))
             throw new ArrayFailure(origin === "arithmetic" ? "indexed arithmetic is unsupported" : "indexed write requires prepared publication");
         if (state.readonlyVariables?.has(name))
-            throw new Error(`${name}: readonly variable`);
+            throw new PublicDiagnostic(`${name}: readonly variable`);
         if (shellValueByteLength(value) > this.budget.limits.maxExpansionBytes)
             this.budget.fail("maxExpansionBytes");
         if (name === "OPTIND" && state.getopts?.integer && origin !== "arithmetic") {
@@ -1316,7 +1326,7 @@ export class Runtime {
             }
             catch (error) {
                 this.rethrowArithmeticControl(error);
-                throw new ExpansionFailure(message(error));
+                throw new ExpansionFailure(message(error, this.budget.onInternalError));
             }
         }
         publishVariable(state, name, value);
@@ -1339,7 +1349,7 @@ export class Runtime {
     }
     unsetVariable(state, name, internal = false) {
         if (state.readonlyVariables?.has(name))
-            throw new Error(`${name}: readonly variable`);
+            throw new PublicDiagnostic(`${name}: readonly variable`);
         delete state.variables[name];
         state.exported.delete(name);
         if (name === "OPTIND" && !internal)
@@ -2140,7 +2150,7 @@ export class Runtime {
                     }
                     catch (error) {
                         this.rethrowArithmeticControl(error);
-                        throw new Error(`((: ${message(error)}`);
+                        throw new PublicDiagnostic(`((: ${message(error, this.budget.onInternalError)}`);
                     }
                 }
                 if (command.kind === "subshell") {
@@ -2255,9 +2265,10 @@ export class Runtime {
                     this.errexit(141, state, io);
                 return 141;
             }
+            const publicMessage = message(error, this.budget.onInternalError);
             const line = error instanceof ExpansionFailure ? error.line ?? io.diagnosticLine ?? 1 : io.diagnosticLine ?? 1;
             if (error instanceof NounsetFailure || error instanceof ParameterExpansionFailure) {
-                const detail = error instanceof ParameterExpansionFailure ? diagnostic ?? message(error) : message(error);
+                const detail = error instanceof ParameterExpansionFailure ? diagnostic ?? publicMessage : publicMessage;
                 try {
                     await writeDiagnostic(io.stderr, `${io.scriptName ?? "shell"}: line ${line}: ${detail}\n`);
                 }
@@ -2271,13 +2282,14 @@ export class Runtime {
                 throw completedExit(error instanceof ParameterExpansionFailure && !state.isolated ? 127 : 1);
             }
             if (error instanceof ArrayFailure)
-                await writeDiagnostic(io.stderr, `${io.scriptName ?? "shell"}: line ${line}: ${diagnostic ?? message(error)}\n`);
+                await writeDiagnostic(io.stderr, `${io.scriptName ?? "shell"}: line ${line}: ${diagnostic ?? publicMessage}\n`);
             else {
                 try {
-                    await writeDiagnostic(io.stderr, `${io.scriptName ?? "shell"}: line ${line}: ${diagnostic ?? message(error)}\n`);
+                    await writeDiagnostic(io.stderr, `${io.scriptName ?? "shell"}: line ${line}: ${diagnostic ?? publicMessage}\n`);
                 }
-                catch {
+                catch (failure) {
                     this.signal.throwIfAborted();
+                    publicDiagnosticMessage(failure, this.budget.onInternalError);
                 }
             }
             if (error instanceof ExpansionFailure || error instanceof BraceExpansionFailure)
@@ -2406,7 +2418,7 @@ export class Runtime {
                         if (error instanceof ParameterExpansionFailure)
                             throw new CommandFailure(error.message, state.isolated ? 1 : 127);
                         if (error instanceof ExpansionFailure)
-                            throw new Error(error.message);
+                            throw new PublicDiagnostic(error.message);
                         throw error;
                     }
                     if (hereString) {
@@ -2421,7 +2433,7 @@ export class Runtime {
                 }
                 const targets = await this.word(redirect.target, state, currentIO());
                 if (targets.length !== 1)
-                    throw new Error("Ambiguous redirect");
+                    throw new PublicDiagnostic("Ambiguous redirect");
                 const target = targets[0];
                 errorTarget = target;
                 if (redirect.operator.endsWith("&")) {
@@ -2429,14 +2441,14 @@ export class Runtime {
                         descriptors.delete(redirect.descriptor);
                     else {
                         if (!/^\d+-?$/u.test(target))
-                            throw new Error(`${target}: Bad file descriptor`);
+                            throw new PublicDiagnostic(`${target}: Bad file descriptor`);
                         const move = target.endsWith("-");
                         if (move && !redirect.move)
-                            throw new Error(`${target}: ambiguous redirect`);
+                            throw new PublicDiagnostic(`${target}: ambiguous redirect`);
                         const sourceDescriptor = Number(move ? target.slice(0, -1) : target);
                         const descriptor = descriptors.get(sourceDescriptor);
                         if (!descriptor || descriptor.closed || (!move && (redirect.operator === "<&" ? !descriptor.input : !descriptor.output)))
-                            throw new Error(`${move ? sourceDescriptor : target}: Bad file descriptor`);
+                            throw new PublicDiagnostic(`${move ? sourceDescriptor : target}: Bad file descriptor`);
                         descriptors.set(redirect.descriptor, { ...descriptor });
                         if (move && sourceDescriptor !== redirect.descriptor) {
                             descriptors.delete(sourceDescriptor);
@@ -2452,7 +2464,7 @@ export class Runtime {
                         await interruptible(this.fs.access(path, 4, options), this.signal);
                         const stat = await interruptible(this.fs.stat(path, options), this.signal);
                         if (stat.type === "directory" && !fileShortcut)
-                            throw new Error(`${target}: Is a directory`);
+                            throw new PublicDiagnostic(`${target}: Is a directory`);
                         const source = stat.type === "directory" ? toByteSource("")
                             : await fileInput(this.fs, path, this.budget.limits.maxInputBytes, this.signal);
                         const input = new ShellInput(source, this.budget, this.signal);
@@ -2761,7 +2773,7 @@ export class Runtime {
             if (fileShortcut) {
                 const input = io.descriptors?.get(command.redirects[0].descriptor)?.input;
                 if (!input)
-                    throw new Error("Bad file descriptor");
+                    throw new PublicDiagnostic("Bad file descriptor");
                 await pipeBytes(input, io.stdout, this.signal);
                 return 0;
             }
@@ -2773,7 +2785,7 @@ export class Runtime {
             this.signal.throwIfAborted();
             const original = error instanceof ExecutionFailure ? error.original : error;
             if (special && !(original instanceof ShellLimitError) && !(original instanceof ExpansionFailure) && !(original instanceof Flow) && !(original instanceof ShellSyntaxError)) {
-                throw new ExecutionFailure(new FatalCommandFailure(message(original), 1), error instanceof ExecutionFailure ? error.io : io, error instanceof ExecutionFailure ? error.diagnostic : undefined);
+                throw new ExecutionFailure(new FatalCommandFailure(message(original, this.budget.onInternalError), 1), error instanceof ExecutionFailure ? error.io : io, error instanceof ExecutionFailure ? error.diagnostic : undefined);
             }
             if (error instanceof ExecutionFailure)
                 throw error;
@@ -2822,6 +2834,7 @@ export class Runtime {
         const context = {
             ...publicIO, command: name, args: argumentValues.args, argumentValues, env, cwd: state.cwd, fs: this.fs, signal: this.commandSignal,
             executionScope: this.budget.executionScope,
+            onInternalError: this.budget.onInternalError,
             registerCleanup: (cleanup) => { scope.register(cleanup); },
             invoke: (name, args, options) => {
                 const invocation = this.invoke(name, args, options, context, state, scope);
@@ -3271,8 +3284,8 @@ export class Runtime {
                 if (code === "ENOENT" || code === "ENOTDIR")
                     continue;
                 if (code !== "EACCES" && code !== "EPERM")
-                    throw new CommandFailure(filesystemDiagnostic(error, target) ?? `${target}: ${message(error)}`, 126);
-                denied ??= new CommandFailure(filesystemDiagnostic(error, target) ?? `${target}: ${message(error)}`, 126);
+                    throw new CommandFailure(filesystemDiagnostic(error, target, this.budget.onInternalError) ?? `${target}: ${message(error, this.budget.onInternalError)}`, 126);
+                denied ??= new CommandFailure(filesystemDiagnostic(error, target, this.budget.onInternalError) ?? `${target}: ${message(error, this.budget.onInternalError)}`, 126);
             }
         }
         if (denied && !matches.length && !discovery)
@@ -3479,6 +3492,7 @@ export class Runtime {
             const context = {
                 ...incoming, args: argumentValues.args, argumentValues,
                 executionScope: this.budget.executionScope,
+                onInternalError: this.budget.onInternalError,
                 env: Object.assign(Object.create(null), incoming.env),
                 stdin: input ?? incoming.stdin,
                 stdout: this.budget.sink(incoming.stdout, runtime.signal), stderr: this.budget.sink(incoming.stderr, runtime.signal),
@@ -3675,7 +3689,7 @@ export class Runtime {
                 throw error;
             if (errorCode(error) === "EFBIG")
                 this.budget.fail("maxSourceBytes");
-            throw new CommandFailure(filesystemDiagnostic(error, target) ?? `${target}: ${message(error)}`, errorCode(error) === "ENOENT" ? 127 : 126);
+            throw new CommandFailure(filesystemDiagnostic(error, target, this.budget.onInternalError) ?? `${target}: ${message(error, this.budget.onInternalError)}`, errorCode(error) === "ENOENT" ? 127 : 126);
         }
         if (direct && environmentInterpreter)
             return this.envShebang(context, state, io, environmentInterpreter[1], target, args, { path, source });
@@ -3848,7 +3862,7 @@ export class Runtime {
                 throw error;
             if (errorCode(error) === "EFBIG")
                 this.budget.fail("maxSourceBytes");
-            const diagnostic = error instanceof CommandFailure ? error.message : filesystemDiagnostic(error, target) ?? `${target}: ${message(error)}`;
+            const diagnostic = error instanceof CommandFailure ? error.message : filesystemDiagnostic(error, target, this.budget.onInternalError) ?? `${target}: ${message(error, this.budget.onInternalError)}`;
             if (special)
                 throw new FatalCommandFailure(diagnostic, 1);
             throw new CommandFailure(diagnostic, error instanceof CommandFailure ? error.status : 1);
@@ -4095,7 +4109,7 @@ export class Runtime {
             }
             catch (error) {
                 this.rethrowArithmeticControl(error);
-                throw new Error(`let: ${message(error)}`);
+                throw new PublicDiagnostic(`let: ${message(error, this.budget.onInternalError)}`);
             }
             if ((index - offset + 1) % 128 === 0)
                 await checkpoint();
@@ -4207,7 +4221,7 @@ export class Runtime {
         else
             this.unsetVariable(state, "OPTARG", true);
         if (!/^[a-zA-Z_][a-zA-Z_0-9]*$/u.test(name))
-            throw new Error(`getopts: \`${name}': not a valid identifier`);
+            throw new PublicDiagnostic(`getopts: \`${name}': not a valid identifier`);
         await this.assignVariable(state, name, result.option, "getopts");
         return result.status;
     }
@@ -4229,8 +4243,8 @@ export class Runtime {
         }
         catch (error) {
             this.signal.throwIfAborted();
-            const description = filesystemDiagnostic(error, "");
-            const text = description ? "" : message(error);
+            const description = filesystemDiagnostic(error, "", this.budget.onInternalError);
+            const text = description ? "" : message(error, this.budget.onInternalError);
             diagnose?.(error, cdDiagnostic(description ? [name, ": ", target, description]
                 : stackHooks && text.startsWith("cd: ") ? [name, text.slice(2)] : [text]));
             throw error;
@@ -5216,7 +5230,7 @@ export class Runtime {
             }
             catch (error) {
                 this.rethrowArithmeticControl(error);
-                throw new ExpansionFailure(message(error), io.diagnosticLine ?? part.line);
+                throw new ExpansionFailure(message(error, this.budget.onInternalError), io.diagnosticLine ?? part.line);
             }
         }
         if (part.kind === "substitution") {
@@ -5336,7 +5350,7 @@ export class Runtime {
                     throw new ParameterExpansionFailure(`${part.name}: ${alternate || (part.operator.startsWith(":") ? "parameter null or not set" : "parameter not set")}`, io.diagnosticLine ?? part.line);
                 if (operator === "=") {
                     if (!/^[a-zA-Z_][a-zA-Z_0-9]*$/u.test(part.name))
-                        throw new Error("Cannot assign special parameter");
+                        throw new PublicDiagnostic("Cannot assign special parameter");
                     this.writeVariable(state, part.name, retained);
                 }
                 value = alternate;
@@ -5405,7 +5419,7 @@ export class Runtime {
                 }
                 catch (error) {
                     this.rethrowArithmeticControl(error);
-                    throw new ExpansionFailure(`${part.name}: ${message(error)}`, line);
+                    throw new ExpansionFailure(`${part.name}: ${message(error, this.budget.onInternalError)}`, line);
                 }
                 finally {
                     retained?.release();