wasm-idle 0.7.2 → 1.0.0

package/dist/playground/zig.js

@@ -0,0 +1,690 @@
+import { resolveSandboxExecutionArgs } from './options';
+import { resolveZigCompilerUrl, resolveZigStdlibUrl } from './assets';
+import { snapshotZigExecutionAssetReceipts } from './zigAssets';
+import { WASM_ZIG_ASSET_RECEIPTS } from './wasmZigVersion';
+import { BusyError, CancelledError, DEFAULT_WORKSPACE_LIMITS, DiagnosticLimitError, OutputLimitError, RuntimeConfigurationError, TimeoutError, resolveExecutionLimits, validateExecutionWorkspace } from '@wasm-idle/core';
+import { flushBufferedEof, flushQueuedStdin, resetBufferedStdin } from './stdinBuffer';
+import { createWasmIdleSharedBuffer } from './sharedBuffer';
+import { WorkerSession } from './workerSession';
+import { reportWorkerInputReady, reportWorkerProgress } from './workerProgress';
+const OUTPUT_ENCODER = new TextEncoder();
+const abortReason = (signal, phase) => signal.reason !== undefined
+    ? signal.reason
+    : new DOMException(phase === 'startup' ? 'Zig runtime startup aborted' : 'Zig execution aborted', 'AbortError');
+class Zig {
+    output = null;
+    worker = null;
+    buffer = createWasmIdleSharedBuffer(1024);
+    pendingInput = [];
+    begin = 0;
+    elapse = 0;
+    uid = 0;
+    exit = true;
+    compilerUrl = '';
+    stdlibUrl = '';
+    assetKey = '';
+    oncompilerdiagnostic;
+    waitingForInput = false;
+    pendingEof = false;
+    activeOperation = null;
+    disposed = false;
+    disposePromise = null;
+    disposeCancellation = new CancelledError('Zig sandbox disposed', {
+        phase: 'dispose',
+        runtimeId: 'ZIG',
+        recoverable: false
+    });
+    workerSession = new WorkerSession({
+        label: 'Zig',
+        onDispose: (worker) => {
+            if (this.worker === worker)
+                delete this.worker;
+            this.exit = true;
+            this.waitingForInput = false;
+            this.pendingEof = false;
+        }
+    });
+    requireOperationIdle() {
+        if (!this.activeOperation)
+            return;
+        throw new BusyError('Zig runtime already has an active operation', {
+            runtimeId: 'ZIG',
+            phase: this.activeOperation.phase
+        });
+    }
+    beginOperation(phase) {
+        if (this.disposed) {
+            throw new RuntimeConfigurationError('Zig sandbox is disposed', {
+                phase: 'dispose',
+                runtimeId: 'ZIG'
+            });
+        }
+        this.requireOperationIdle();
+        const operation = {
+            token: Symbol(phase),
+            phase,
+            cancelled: false,
+            cleanedUp: false,
+            cleanups: [],
+            explicitStdin: false
+        };
+        this.activeOperation = operation;
+        return operation;
+    }
+    isOperationActive(operation) {
+        return this.activeOperation?.token === operation.token && !operation.cancelled;
+    }
+    releaseOperation(operation) {
+        if (this.activeOperation?.token !== operation.token)
+            return false;
+        this.activeOperation = null;
+        return true;
+    }
+    cleanupOperation(operation) {
+        if (operation.cleanedUp)
+            return;
+        operation.cleanedUp = true;
+        const cleanups = operation.cleanups.splice(0);
+        for (const cleanup of cleanups) {
+            try {
+                cleanup();
+            }
+            catch {
+                // Caller-owned lifecycle cleanup must not replace the operation result.
+            }
+        }
+    }
+    releaseBeforeSession(operation, reason) {
+        const outcome = operation.cancelled ? operation.cancellationReason : reason;
+        this.releaseOperation(operation);
+        this.cleanupOperation(operation);
+        return outcome;
+    }
+    bindPreSessionAbort(operation, signal) {
+        if (!signal || !this.isOperationActive(operation))
+            return () => undefined;
+        let registered = false;
+        let unbound = false;
+        const unbind = () => {
+            if (unbound)
+                return;
+            unbound = true;
+            if (registered)
+                signal.removeEventListener('abort', onAbort);
+        };
+        const onAbort = () => {
+            if (!this.isOperationActive(operation))
+                return;
+            let reason;
+            try {
+                reason = abortReason(signal, operation.phase);
+            }
+            catch (error) {
+                reason = error;
+            }
+            operation.cancelled = true;
+            operation.cancellationReason = reason;
+            this.releaseOperation(operation);
+            this.cleanupOperation(operation);
+        };
+        operation.cleanups.push(unbind);
+        try {
+            registered = true;
+            signal.addEventListener('abort', onAbort, { once: true });
+            if (signal.aborted)
+                onAbort();
+        }
+        catch (error) {
+            if (this.isOperationActive(operation)) {
+                operation.cancelled = true;
+                operation.cancellationReason = error;
+                this.releaseOperation(operation);
+                this.cleanupOperation(operation);
+            }
+        }
+        return unbind;
+    }
+    bindAbortSignal(operation, signal) {
+        if (!signal || !this.isOperationActive(operation))
+            return;
+        let registered = false;
+        const onAbort = () => {
+            if (!this.isOperationActive(operation))
+                return;
+            let reason;
+            try {
+                reason = abortReason(signal, operation.phase);
+            }
+            catch (error) {
+                reason = error;
+            }
+            this.cancelOperation(operation, reason);
+        };
+        operation.cleanups.push(() => {
+            if (!registered)
+                return;
+            try {
+                signal.removeEventListener('abort', onAbort);
+            }
+            catch {
+                // Listener cleanup must not replace the operation result.
+            }
+        });
+        try {
+            registered = true;
+            signal.addEventListener('abort', onAbort, { once: true });
+            if (signal.aborted)
+                onAbort();
+        }
+        catch (error) {
+            this.cancelOperation(operation, error);
+        }
+    }
+    bindOperationTimeout(operation, timeoutMs) {
+        if (!this.isOperationActive(operation))
+            return;
+        let timeout;
+        operation.cleanups.push(() => {
+            if (timeout !== undefined)
+                clearTimeout(timeout);
+        });
+        try {
+            timeout = setTimeout(() => {
+                if (!this.isOperationActive(operation))
+                    return;
+                const label = operation.phase === 'startup' ? 'startup' : 'execution';
+                this.cancelOperation(operation, new TimeoutError(`Zig ${label} timed out after ${timeoutMs} ms`, {
+                    phase: operation.phase,
+                    runtimeId: 'ZIG',
+                    timeoutMs
+                }));
+            }, timeoutMs);
+            if (operation.cleanedUp)
+                clearTimeout(timeout);
+        }
+        catch (error) {
+            this.cancelOperation(operation, error);
+        }
+    }
+    resetExplicitStdinState() {
+        this.pendingInput = [];
+        this.pendingEof = false;
+        this.waitingForInput = false;
+        try {
+            resetBufferedStdin(this.buffer);
+        }
+        catch {
+            // Explicit stdin never consumes the shared terminal buffer.
+        }
+    }
+    finishExplicitStdin(operation) {
+        if (!operation.explicitStdin)
+            return;
+        operation.explicitStdin = false;
+        this.resetExplicitStdinState();
+    }
+    load(runtimeAssets = '', _code = '', _log = true, _args = [], options = {}, progress) {
+        let activeOperation;
+        try {
+            activeOperation = this.beginOperation('startup');
+        }
+        catch (error) {
+            return Promise.reject(error);
+        }
+        let signal;
+        let limits;
+        let unbindPreSessionAbort = () => undefined;
+        try {
+            signal = options.signal;
+            unbindPreSessionAbort = this.bindPreSessionAbort(activeOperation, signal);
+            if (!this.isOperationActive(activeOperation) || signal?.aborted) {
+                return Promise.reject(this.releaseBeforeSession(activeOperation, 'Zig runtime startup cancelled'));
+            }
+            limits = resolveExecutionLimits(options.limits);
+            if (!this.isOperationActive(activeOperation) || signal?.aborted) {
+                return Promise.reject(this.releaseBeforeSession(activeOperation, 'Zig runtime startup cancelled'));
+            }
+            unbindPreSessionAbort();
+        }
+        catch (error) {
+            return Promise.reject(this.releaseBeforeSession(activeOperation, error));
+        }
+        if (!this.isOperationActive(activeOperation)) {
+            return Promise.reject(this.releaseBeforeSession(activeOperation, 'Zig runtime startup cancelled'));
+        }
+        const loadPromise = this.workerSession.load(async (resolve, reject) => {
+            const resolveLoad = () => {
+                if (!this.releaseOperation(activeOperation))
+                    return;
+                resolve();
+                this.cleanupOperation(activeOperation);
+            };
+            const rejectLoad = (reason) => {
+                if (!this.releaseOperation(activeOperation))
+                    return;
+                reject(reason);
+                this.cleanupOperation(activeOperation);
+            };
+            try {
+                if (!this.isOperationActive(activeOperation))
+                    return;
+                this.pendingInput = [];
+                this.waitingForInput = false;
+                this.pendingEof = false;
+                const currentUrl = typeof window !== 'undefined' ? window.location.href : '';
+                let resolverAssets = runtimeAssets;
+                if (typeof runtimeAssets === 'object') {
+                    const zig = runtimeAssets.zig;
+                    if (!this.isOperationActive(activeOperation))
+                        return;
+                    let rootUrl;
+                    let rootUrlRead = false;
+                    resolverAssets = {
+                        get rootUrl() {
+                            if (!rootUrlRead) {
+                                rootUrlRead = true;
+                                rootUrl = runtimeAssets.rootUrl;
+                            }
+                            return rootUrl;
+                        },
+                        zig
+                    };
+                }
+                const nextCompilerUrl = resolveZigCompilerUrl(resolverAssets, currentUrl);
+                if (!this.isOperationActive(activeOperation))
+                    return;
+                const nextStdlibUrl = resolveZigStdlibUrl(resolverAssets, currentUrl);
+                if (!this.isOperationActive(activeOperation))
+                    return;
+                const configuredIntegrity = typeof resolverAssets === 'object' ? resolverAssets.zig?.integrity : undefined;
+                if (!this.isOperationActive(activeOperation))
+                    return;
+                const nextIntegrity = snapshotZigExecutionAssetReceipts(configuredIntegrity === undefined
+                    ? WASM_ZIG_ASSET_RECEIPTS
+                    : configuredIntegrity);
+                if (!this.isOperationActive(activeOperation))
+                    return;
+                if (!nextCompilerUrl || !nextStdlibUrl) {
+                    return rejectLoad('Zig runtime is not configured. Set PUBLIC_WASM_ZIG_COMPILER_URL and PUBLIC_WASM_ZIG_STDLIB_URL, or runtimeAssets.zig.compilerUrl and runtimeAssets.zig.stdlibUrl.');
+                }
+                for (const [asset, receipt] of Object.entries(nextIntegrity)) {
+                    const largestStage = Math.max(receipt.bytes, receipt.uncompressedBytes || 0);
+                    if (largestStage > limits.maxAssetBytes) {
+                        return rejectLoad(`Zig execution asset ${asset} exceeds the ${limits.maxAssetBytes} byte limit`);
+                    }
+                }
+                const nextAssetKey = JSON.stringify({
+                    compilerUrl: nextCompilerUrl,
+                    stdlibUrl: nextStdlibUrl,
+                    integrity: nextIntegrity
+                });
+                const needsWorkerReset = !this.worker || this.assetKey !== nextAssetKey;
+                this.compilerUrl = nextCompilerUrl;
+                this.stdlibUrl = nextStdlibUrl;
+                this.assetKey = nextAssetKey;
+                if (needsWorkerReset && this.worker) {
+                    this.workerSession.reset();
+                }
+                if (!this.worker) {
+                    const WorkerConstructor = (await import('./worker/zig?worker'))
+                        .default;
+                    if (!this.isOperationActive(activeOperation))
+                        return;
+                    const worker = new WorkerConstructor();
+                    if (!this.isOperationActive(activeOperation)) {
+                        worker.terminate();
+                        return;
+                    }
+                    this.worker = worker;
+                    this.workerSession.attach(worker);
+                    let handler;
+                    const ownsLoad = () => this.isOperationActive(activeOperation) &&
+                        this.worker === worker &&
+                        worker.onmessage === handler;
+                    const failLoad = (error) => {
+                        if (!ownsLoad())
+                            return;
+                        rejectLoad(error);
+                    };
+                    handler = (event) => {
+                        if (!ownsLoad())
+                            return;
+                        try {
+                            reportWorkerProgress(progress, event.data?.progress);
+                            if (!ownsLoad())
+                                return;
+                            if (event.data?.load) {
+                                progress?.set?.(1);
+                                if (!ownsLoad())
+                                    return;
+                                resolveLoad();
+                                return;
+                            }
+                            if (event.data?.error)
+                                rejectLoad(event.data.error);
+                        }
+                        catch (error) {
+                            failLoad(error);
+                        }
+                    };
+                    worker.onmessage = handler;
+                    worker.postMessage({
+                        load: true,
+                        compilerUrl: nextCompilerUrl,
+                        stdlibUrl: nextStdlibUrl,
+                        integrity: nextIntegrity,
+                        maxAssetBytes: limits.maxAssetBytes,
+                        log: _log
+                    });
+                }
+                else {
+                    const worker = this.worker;
+                    progress?.set?.(1);
+                    if (!this.isOperationActive(activeOperation) || this.worker !== worker)
+                        return;
+                    resolveLoad();
+                }
+            }
+            catch (error) {
+                rejectLoad(error);
+            }
+        });
+        const timeoutMs = Math.min(2_147_483_647, limits.assetTimeoutMs + limits.startupTimeoutMs);
+        this.bindOperationTimeout(activeOperation, timeoutMs);
+        this.bindAbortSignal(activeOperation, signal);
+        return loadPromise.finally(() => {
+            this.releaseOperation(activeOperation);
+            this.cleanupOperation(activeOperation);
+        });
+    }
+    write(input) {
+        if (this.disposed)
+            return;
+        this.pendingInput.push(input);
+        this.pendingEof = false;
+        this.flushPendingInput();
+    }
+    eof() {
+        if (this.disposed)
+            return;
+        this.pendingEof = true;
+        this.flushPendingInput();
+    }
+    flushPendingInput() {
+        if (!this.waitingForInput)
+            return;
+        if (flushQueuedStdin(this.pendingInput, this.buffer)) {
+            this.waitingForInput = false;
+            return;
+        }
+        if (this.pendingEof) {
+            flushBufferedEof(this.buffer);
+            this.pendingEof = false;
+            this.waitingForInput = false;
+        }
+    }
+    run(code, prepare, _log = true, _prog, args = [], options = {}) {
+        let activeOperation;
+        try {
+            activeOperation = this.beginOperation('execute');
+        }
+        catch (error) {
+            return Promise.reject(error);
+        }
+        const worker = this.worker;
+        if (!worker) {
+            return Promise.reject(this.releaseBeforeSession(activeOperation, 'Worker not loaded'));
+        }
+        let signal;
+        let unbindPreSessionAbort = () => undefined;
+        let compileArgs;
+        let programArgs;
+        let limits;
+        let targetTriple;
+        let workspace;
+        let stdin;
+        try {
+            signal = options.signal;
+            unbindPreSessionAbort = this.bindPreSessionAbort(activeOperation, signal);
+            if (!this.isOperationActive(activeOperation)) {
+                return Promise.reject(this.releaseBeforeSession(activeOperation, 'Zig execution cancelled'));
+            }
+            ({ compileArgs, programArgs } = resolveSandboxExecutionArgs('ZIG', args, options));
+            limits = resolveExecutionLimits(options.limits);
+            const workspaceFiles = options.workspaceFiles ?? [];
+            const activePath = options.activePath ?? 'main.zig';
+            const workspaceLimits = options.workspaceLimits;
+            workspace = validateExecutionWorkspace(code, workspaceFiles, activePath, {
+                ...workspaceLimits,
+                maxFileBytes: Math.min(workspaceLimits?.maxFileBytes ?? DEFAULT_WORKSPACE_LIMITS.maxFileBytes, limits.maxWorkspaceBytes),
+                maxTotalBytes: Math.min(workspaceLimits?.maxTotalBytes ?? DEFAULT_WORKSPACE_LIMITS.maxTotalBytes, limits.maxWorkspaceBytes)
+            });
+            targetTriple = options.zigTargetTriple || 'wasm64-wasi';
+            stdin = options.stdin;
+            if (!this.isOperationActive(activeOperation) || signal?.aborted) {
+                return Promise.reject(this.releaseBeforeSession(activeOperation, 'Zig execution cancelled'));
+            }
+            unbindPreSessionAbort();
+        }
+        catch (error) {
+            return Promise.reject(this.releaseBeforeSession(activeOperation, error));
+        }
+        if (!this.isOperationActive(activeOperation)) {
+            return Promise.reject(this.releaseBeforeSession(activeOperation, 'Zig execution cancelled'));
+        }
+        const hasExplicitStdin = stdin !== undefined;
+        if (hasExplicitStdin) {
+            activeOperation.explicitStdin = true;
+            this.resetExplicitStdinState();
+        }
+        this.exit = false;
+        const running = new Promise((resolve, reject) => {
+            const _uid = ++this.uid;
+            let diagnosticCount = 0;
+            let outputBytes = 0;
+            const operation = this.workerSession.beginRun(worker, reject);
+            const timeoutMs = Math.min(2_147_483_647, limits.compileTimeoutMs + limits.runTimeoutMs);
+            this.bindOperationTimeout(activeOperation, timeoutMs);
+            this.bindAbortSignal(activeOperation, signal);
+            if (!this.isOperationActive(activeOperation))
+                return;
+            let handler;
+            const ownsRun = () => this.isOperationActive(activeOperation) &&
+                this.worker === worker &&
+                worker.onmessage === handler &&
+                _uid === this.uid;
+            const claimRun = () => {
+                if (!ownsRun())
+                    return false;
+                this.finishExplicitStdin(activeOperation);
+                this.elapse = Date.now() - this.begin;
+                this.exit = true;
+                this.waitingForInput = false;
+                this.pendingEof = false;
+                this.workerSession.complete(operation);
+                this.releaseOperation(activeOperation);
+                this.cleanupOperation(activeOperation);
+                try {
+                    if (worker.onmessage === handler)
+                        worker.onmessage = null;
+                }
+                catch {
+                    // Handler cleanup must not replace the operation result.
+                }
+                return true;
+            };
+            const failRun = (error, disposeWorker = false) => {
+                if (!ownsRun())
+                    return;
+                if (disposeWorker) {
+                    this.cancelOperation(activeOperation, error);
+                    return;
+                }
+                if (!claimRun())
+                    return;
+                reject(error);
+            };
+            handler = (event) => {
+                if (!ownsRun())
+                    return;
+                try {
+                    const { output, results, error, buffer, diagnostic, progress } = event.data;
+                    if (buffer && !hasExplicitStdin) {
+                        this.waitingForInput = true;
+                        if (!prepare) {
+                            reportWorkerInputReady(_prog, 'Zig runtime ready for input');
+                            if (!ownsRun())
+                                return;
+                        }
+                        this.flushPendingInput();
+                        if (!ownsRun())
+                            return;
+                    }
+                    reportWorkerProgress(_prog, progress);
+                    if (!ownsRun())
+                        return;
+                    if (output) {
+                        const actual = outputBytes + OUTPUT_ENCODER.encode(String(output)).byteLength;
+                        if (actual > limits.maxOutputBytes) {
+                            failRun(new OutputLimitError(`Zig output exceeded ${limits.maxOutputBytes} bytes`, {
+                                actual,
+                                limit: limits.maxOutputBytes,
+                                phase: 'execute',
+                                runtimeId: 'ZIG'
+                            }), true);
+                            return;
+                        }
+                        outputBytes = actual;
+                        this.output?.(output);
+                    }
+                    if (!ownsRun())
+                        return;
+                    if (diagnostic) {
+                        const actual = diagnosticCount + 1;
+                        if (actual > limits.maxDiagnostics) {
+                            failRun(new DiagnosticLimitError(`Zig diagnostics exceeded ${limits.maxDiagnostics} messages`, {
+                                actual,
+                                limit: limits.maxDiagnostics,
+                                phase: 'execute',
+                                runtimeId: 'ZIG'
+                            }), true);
+                            return;
+                        }
+                        diagnosticCount = actual;
+                        this.oncompilerdiagnostic?.(diagnostic);
+                    }
+                    if (!ownsRun())
+                        return;
+                    if (results) {
+                        if (!claimRun())
+                            return;
+                        resolve(results);
+                        return;
+                    }
+                    if (error)
+                        failRun(error);
+                }
+                catch (error) {
+                    failRun(error, true);
+                }
+            };
+            worker.onmessage = handler;
+            if (!ownsRun())
+                return;
+            this.begin = Date.now();
+            try {
+                worker.postMessage({
+                    code,
+                    prepare,
+                    buffer: this.buffer,
+                    args: programArgs,
+                    compileArgs,
+                    stdin,
+                    activePath: workspace.activePath,
+                    workspaceFiles: workspace.workspaceFiles,
+                    targetTriple,
+                    log: _log
+                });
+            }
+            catch (error) {
+                failRun(error, true);
+            }
+        });
+        return running.finally(() => {
+            if (this.releaseOperation(activeOperation)) {
+                this.finishExplicitStdin(activeOperation);
+                this.exit = true;
+            }
+            this.cleanupOperation(activeOperation);
+        });
+    }
+    cancelOperation(operation, reason) {
+        if (!this.isOperationActive(operation))
+            return;
+        operation.cancelled = true;
+        operation.cancellationReason = reason;
+        this.activeOperation = null;
+        this.uid += 1;
+        this.finishExplicitStdin(operation);
+        this.waitingForInput = false;
+        this.pendingEof = false;
+        this.exit = true;
+        this.workerSession.terminate(reason);
+        this.cleanupOperation(operation);
+    }
+    kill() {
+        this.terminate();
+    }
+    terminate(reason = 'Process terminated') {
+        if (this.disposed)
+            return;
+        const activeOperation = this.activeOperation;
+        if (activeOperation) {
+            this.cancelOperation(activeOperation, reason);
+            return;
+        }
+        this.waitingForInput = false;
+        this.pendingEof = false;
+        this.uid += 1;
+        this.workerSession.terminate(reason);
+        this.exit = true;
+    }
+    async clear() {
+        if (this.disposed)
+            return;
+        this.pendingInput = [];
+        this.waitingForInput = false;
+        this.pendingEof = false;
+        resetBufferedStdin(this.buffer);
+        if (this.activeOperation) {
+            this.terminate();
+            return;
+        }
+        if (this.worker)
+            this.worker.onmessage = null;
+    }
+    dispose() {
+        if (this.disposePromise)
+            return this.disposePromise;
+        this.disposed = true;
+        this.disposePromise = Promise.resolve();
+        const activeOperation = this.activeOperation;
+        delete this.worker;
+        this.compilerUrl = '';
+        this.stdlibUrl = '';
+        this.assetKey = '';
+        this.output = null;
+        this.oncompilerdiagnostic = undefined;
+        this.resetExplicitStdinState();
+        if (activeOperation) {
+            this.cancelOperation(activeOperation, this.disposeCancellation);
+        }
+        else {
+            this.uid += 1;
+            this.workerSession.terminate(this.disposeCancellation);
+            this.exit = true;
+        }
+        return this.disposePromise;
+    }
+}
+export default Zig;

package/dist/playground/zigAssets.d.ts

@@ -0,0 +1,6 @@
+import type { RuntimeAssetIntegrityEntry } from '@wasm-idle/core';
+export declare const ZIG_EXECUTION_ASSET_NAMES: readonly ["zig_small.wasm", "std.tar.gz"];
+export type ZigExecutionAssetName = (typeof ZIG_EXECUTION_ASSET_NAMES)[number];
+export type ZigExecutionAssetReceipt = Readonly<Required<Pick<RuntimeAssetIntegrityEntry, 'bytes' | 'sha256'>> & Pick<RuntimeAssetIntegrityEntry, 'uncompressedBytes' | 'uncompressedSha256'>>;
+export type ZigExecutionAssetReceipts = Readonly<Record<ZigExecutionAssetName, ZigExecutionAssetReceipt>>;
+export declare function snapshotZigExecutionAssetReceipts(value: ZigExecutionAssetReceipts | undefined): ZigExecutionAssetReceipts;