README.md 9.8 KB
description: "Run TypeScript programs in fresh Node processes with the session filesystem sandbox, managed cleanup, and configurable execution and output limits."
kind: "package-reference"
@deepseek-ai/dsh-code-runtime-node
English | 中文
Summary
Execute model-written TypeScript under the same platform sandbox policy as Bash, with host-provided functions available as async bindings. Each call starts a fresh Node process and returns captured logs, an exact JSON value, or a structured failure. Direct Node APIs remain available within the selected restrictions. Elapsed deadlines, output bounds and a V8 heap limit constrain execution; cancellation and completion terminate the managed process range. A requested restricted mode fails when its sandbox backend is unavailable.
Table of Contents
- Use this package
- Understand the implementation
- Further Exploration
- Model Experience
- Known Limitations and Deferred Work
- Dev Note
Use this package
Mount this provider in a composition that supplies fs, subprocess, sandbox and sandboxPolicy. PTC mode in dsh-tools supplies the calling Session's directory and standing policy; direct runtime consumers resolve those options before execution.
Configuration
Configure the provider row after its required services are available:
- name: '@deepseek-ai/dsh-code-runtime-node'
config:
timeoutMs: 120000
maxTimeoutMs: 600000
maxOutputBytes: 67108864
maxOldGenerationSizeMb: 512
maxMessageBytes: 134217728
maxPendingCalls: 128
graceMs: 3000
| Field | Default | Meaning |
|---|---|---|
timeoutMs |
120,000 |
Default elapsed execution deadline, including nested tool and approval waits |
maxTimeoutMs |
600,000 |
Elapsed deadline ceiling applied by the resolver |
maxOutputBytes |
67,108,864 |
Combined serialized logs and completion or diagnostic budget |
maxOldGenerationSizeMb |
512 |
V8 old-generation heap limit in MiB |
maxMessageBytes |
134,217,728 |
Limit for a control frame, outstanding argument bytes and queued control writes |
maxPendingCalls |
128 |
Maximum simultaneous host binding calls |
graceMs |
3,000 |
Managed termination and output-drain grace |
nodeExecutable |
Current Node executable | Executable resolved in the subprocess execution world |
bootstrapPath |
Package bootstrap | Optional absolute path to a preinstalled built bootstrap in that world |
The configuration catalog defines accepted config fields. resolve(request) supplies cwd, the capped timeout and the execution policy; run(spec) accepts those resolved inputs and does not fill missing values.
Execution and results
Programs are async function bodies: top-level await and return work, and only erasable TypeScript is accepted. A successful call returns its lossless-JSON value as result.value and captured text as result.logs. result.sandbox reports the selected mode, observed denial and the backend's full or partial enforcement independently of the program outcome.
Direct filesystem, network and subprocess operations remain Node operations, subject to the selected OS sandbox. Nested host bindings cross the control channel; PTC tool calls retain the registry's visibility, ordering, logging and approval rules. Running a program does not change the Session's standing policy or automatically replay it after a denial.
Deadlines and cancellation
The elapsed deadline covers runtime setup and execution, including time awaiting nested tools or approval. It is not a CPU meter. Timeout or cancellation stops a synchronous loop through the host's managed process owner; successful completion also cleans that managed range. The timer stops when an outcome is selected, before cleanup, so the returned call can take longer than its execution deadline while cleanup settles.
Failures
Program parse errors and thrown exceptions are exception; deadline expiry is timeout; cancellation is abort; malformed or excessive control traffic is protocol; unavailable confinement is sandbox-unavailable; early process exit or failed managed cleanup is worker-exit. The substrate-independent failure name remains worker-exit for process providers. Lossy completions are invalid-output, and an oversized outer result is output-limit, retaining the fitting log prefix. Invalid or unsupported options and calls after disposal reject as caller misuse.
Understand the implementation
Implementation internals — click to expand
The host owns policy, deadlines, binding lookup and process cleanup. The child owns program evaluation and binding proxies; model-written code is an untrusted peer even when its messages use the expected control descriptor. ### Launch and control The host strips erasable types, resolves the executable and bootstrap in the configured execution world, wraps the argv through `ctx.sandbox`, and spawns through `ctx.subprocess`. After adopting the inherited control channel, the child retains only executable-search and Windows system paths in its OS environment and replaces the program-visible `process.env` with an empty dictionary. The retained native paths keep nested Windows process creation functional. The heap limit uses Node argv or a provider-created `NODE_OPTIONS` value for packaged executables; ambient loader and inspector flags are discarded. Length-framed JSON travels separately from stdout/stderr. The host bounds frames and queued writes, validates call identity and declared binding names before dispatch, and refuses invalid traffic. Output capture meters serialized logs plus the completion or diagnostic; fixed result-envelope fields and sandbox metadata are outside that ledger. ### Source and built bootstraps Source execution loads an erasable-only bootstrap closure without relying on sibling built exports. Built execution uses the packaged `process.js` entry. An execution world that cannot map the host bootstrap requires a preinstalled compatible `bootstrapPath`; a host path is never assumed to name the same remote file. ### Source map | File | Role | |---|---| | [`src/index.ts`](src/index.ts) | Configuration, resolution, policy, bindings and managed execution | | [`src/launch.ts`](src/launch.ts) | Executable/bootstrap arguments and execution-world asset mapping | | [`src/process.ts`](src/process.ts) | Child handshake, environment clearing and program lifecycle | | [`src/bootstrap.ts`](src/bootstrap.ts) | Program evaluation, binding proxies and output capture | | [`src/channel.ts`](src/channel.ts) | Framing, bounded writes and protocol failures | | [`src/output-ledger.ts`](src/output-ledger.ts) | Host accounting for the outer result | | — | No runtime invariant companion is published; framing and process cleanup are enforced across the process boundary rather than through independent same-process observations. |Further Exploration
Read the service contract before using the provider directly; the decisions explain policy and consumer ownership.
- Code runtime service — requests, resolved specs and results.
- Sandboxed Node decision — security, lifecycle and timeout tradeoffs.
- PTC foundation — registry presentation and nested tool dispatch.
- Subprocess provider — managed process ranges and platform limitations.
Model Experience
Indirectly, through PTC mode in dsh-tools, which returns captured logs and the completion value or a failure with sandbox facts. Intermediate binding traffic stays outside model history; the outer result follows the ordinary tool spill policy.
KV Cache effect
No direct invalidation; the named consumer owns any request-prefix changes.
Known Limitations and Deferred Work
These limits qualify the execution guarantees and retained output.
- Confinement inherits the selected backend's limits — full and partial enforcement are reported separately; sandbox policy and managed-process containment are distinct guarantees.
- The heap cap is not a process-tree memory limit — native allocations and descendant memory are outside the V8 old-generation bound. No process-tree CPU meter is supplied.
- Cleanup inherits subprocess observability — escaped descendants on a fallback platform may remain outside the managed range; see the subprocess provider's stated limits.
- Execution is one-shot — no yield/wait API, live result stream or retained program state exists between calls.
- Output caps reject rather than retain every byte — spill can preserve only the bounded result delivered by this provider.
- Bindings are bounded at transport admission — control limits do not bound the memory a host binding allocates while producing its result.
- The console shim has five methods —
log,info,warn,erroranddebug.