Add E2B PTY, LSP, and code runtime providers

This commit is contained in:
Tianyi Cui
2026-08-08 22:19:10 +08:00
parent e7b682f1f6
commit 6667102890
82 changed files with 5462 additions and 644 deletions
@@ -0,0 +1,460 @@
import { PassThrough, Writable } from 'node:stream'
import { Context } from 'cordis'
import { describe, expect, it, vi } from 'vitest'
import type { Sandbox } from '@deepseek-ai/dsh-e2b'
import {
E2BFrameDecoder,
encodeE2BFrame,
} from '@deepseek-ai/dsh-e2b'
import type E2BSandboxService from '@deepseek-ai/dsh-e2b'
import type {
SubprocessHandle,
SubprocessOutcome,
SubprocessSpawnSpec,
} from '@deepseek-ai/dsh-subprocess'
import E2BSubprocessService from '@deepseek-ai/dsh-subprocess-e2b'
import {
encodeWorkerJson,
} from '@deepseek-ai/dsh-code-runtime-worker'
import E2BCodeRuntime from '@deepseek-ai/dsh-code-runtime-e2b'
import * as E2BCodeRuntimeInvariant from '../src/invariant.ts'
import { CODE_RUNNER_SOURCE } from '../src/runner-source.ts'
import InvariantService from '@deepseek-ai/dsh-invariants'
class FakeHandle implements SubprocessHandle {
readonly pid = 123
readonly stdin: Writable | undefined
readonly stdout: PassThrough | undefined
readonly stderr = undefined
readonly collected: SubprocessHandle['collected']
readonly done: Promise<SubprocessOutcome>
readonly writes: unknown[] = []
readonly result = Promise.withResolvers<SubprocessOutcome>()
terminated = 0
waitCalls = 0
private readonly decoder = new E2BFrameDecoder(10_000_000)
private readonly waitError: Error | undefined
private settled = false
constructor(
private readonly onMessage: (message: unknown, handle: FakeHandle) => void = () => {},
options: { stdin?: boolean; stdout?: boolean; stderr?: string; writeError?: Error; waitError?: Error } = {},
) {
this.waitError = options.waitError
this.stdin = options.stdin === false
? undefined
: options.writeError === undefined
? new PassThrough()
: new Writable({ write: (_chunk, _encoding, callback) => { callback(options.writeError) } })
this.stdout = options.stdout === false ? undefined : new PassThrough()
this.collected = options.stderr === undefined
? {}
: { stderr: { readFrom: () => ({ text: options.stderr as string, nextOffset: 0, lossy: false }) } }
this.done = this.result.promise
this.stdin?.on('data', (chunk: Buffer) => {
for (const message of this.decoder.push(chunk.toString('ascii'))) {
this.writes.push(message)
this.onMessage(message, this)
}
})
}
emit(message: unknown): void {
this.stdout?.write(encodeE2BFrame(message))
}
emitRaw(text: string): void {
this.stdout?.write(text)
}
exit(outcome: SubprocessOutcome = { exitCode: 0, signal: null }): void {
if (this.settled) return
this.settled = true
this.stdout?.end()
this.result.resolve(outcome)
}
crash(error: unknown): void {
if (this.settled) return
this.settled = true
this.stdout?.end()
this.result.reject(error)
}
terminate(): void {
this.terminated += 1
this.exit({ exitCode: null, signal: 'SIGTERM' })
}
async waitForExit(): Promise<boolean> {
this.waitCalls += 1
if (this.waitError !== undefined) throw this.waitError
return true
}
}
interface RuntimeFixture {
ctx: Context
fiber: Awaited<ReturnType<Context['plugin']>>
runtime: E2BCodeRuntime
sandbox: Sandbox
spawn: ReturnType<typeof vi.fn<(spec: SubprocessSpawnSpec) => SubprocessHandle>>
write: ReturnType<typeof vi.fn>
run: ReturnType<typeof vi.fn>
}
async function setup(
handles: FakeHandle[] = [],
config: Record<string, number> = {},
sandboxOverrides: Partial<Sandbox> = {},
getSandbox?: () => Promise<Sandbox>,
): Promise<RuntimeFixture> {
const write = vi.fn().mockResolvedValue([])
const run = vi.fn().mockImplementation(async (command: string) => ({
exitCode: 0,
stdout: command.startsWith('command -v') ? '/usr/bin/node\n' : '',
stderr: '',
}))
const sandbox = {
files: { write },
commands: { run },
...sandboxOverrides,
} as unknown as Sandbox
const e2b = {
cwd: '/workspace',
runtimeRoot: '/workspace/.dsh-e2b',
getSandbox: getSandbox ?? (async () => sandbox),
} as unknown as E2BSandboxService
const spawn = vi.fn<(spec: SubprocessSpawnSpec) => SubprocessHandle>(() => {
const handle = handles.shift()
if (handle === undefined) throw new Error('no fake handle queued')
return handle
})
const subprocess = Object.create(E2BSubprocessService.prototype) as E2BSubprocessService
Object.defineProperty(subprocess, 'spawn', { value: spawn })
const ctx = new Context()
ctx.provide('e2b', e2b)
ctx.provide('subprocess', subprocess)
const fiber = await ctx.plugin(E2BCodeRuntime, config)
return { ctx, fiber, runtime: ctx.codeRuntime as E2BCodeRuntime, sandbox, spawn, write, run }
}
function request(program = 'return 1') {
return { program, bindings: [] }
}
describe('E2BCodeRuntime', () => {
it('prepares the remote runner and returns logs and a lossless completion', async () => {
const handle = new FakeHandle((message, current) => {
if ((message as { type?: string }).type !== 'boot') return
current.emit({ type: 'log', text: 'remote 你好' })
current.emitRaw(
encodeE2BFrame({ type: 'done', value: encodeWorkerJson({ answer: 42 }) })
+ encodeE2BFrame({ type: 'log', text: 'ignored after done' }),
)
current.emit({ type: 'log', text: 'also ignored after done' })
})
const fixture = await setup([handle])
await expect(fixture.runtime.run(request('const answer: number = 42; return { answer }')))
.resolves.toEqual({ logs: ['remote 你好'], value: { answer: 42 } })
expect(fixture.runtime.language).toBe('typescript')
expect(fixture.runtime.isolation).toBe('container')
expect(fixture.write).toHaveBeenCalledWith([{ path: '/workspace/.dsh-e2b/code-runtime-runner.mjs', data: CODE_RUNNER_SOURCE }])
expect(fixture.run).toHaveBeenCalledWith("chmod 600 -- '/workspace/.dsh-e2b/code-runtime-runner.mjs'")
expect(fixture.spawn).toHaveBeenCalledWith(expect.objectContaining({
argv: ['/usr/bin/node', '/workspace/.dsh-e2b/code-runtime-runner.mjs'],
cwd: '/workspace',
env: {},
}))
expect(handle.terminated).toBe(1)
expect(handle.waitCalls).toBe(1)
await fixture.fiber.dispose()
})
it('bridges binding success, host rejection, unknown members, and invalid values', async () => {
const replies: unknown[] = []
const handle = new FakeHandle((message, current) => {
const record = message as { type?: string; id?: number; ok?: boolean }
if (record.type === 'boot') {
current.emit({ type: 'call', id: 1, global: 'bridge', name: 'double', args: encodeWorkerJson({ value: 4 }) })
current.emit({ type: 'call', id: 2, global: 'bridge', name: 'fail', args: encodeWorkerJson(null) })
current.emit({ type: 'call', id: 3, global: 'bridge', name: 'missing', args: encodeWorkerJson(null) })
current.emit({ type: 'call', id: 4, global: 'bridge', name: 'double', args: [] })
current.emit({ type: 'call', id: 5, global: 'bridge', name: 'invalid', args: encodeWorkerJson(null) })
current.emit({ type: 'call', id: 6, global: 'bridge', name: 'throwing', args: encodeWorkerJson(null) })
current.emit({ type: 'call', id: 1, global: 'bridge', name: 'double', args: encodeWorkerJson({ value: 99 }) })
return
}
if (record.type === 'reply') {
replies.push(message)
if (replies.length === 6) current.emit({ type: 'done', value: encodeWorkerJson('done') })
}
})
const fixture = await setup([handle])
const result = await fixture.runtime.run({
program: 'return await bridge.double({ value: 4 })',
bindings: [
{
global: 'bridge',
errorClass: { name: 'BridgeError', memberNameProperty: 'member' },
functions: {
double: async args => (args as { value: number }).value * 2,
fail: async () => { throw 'nope' },
invalid: (async () => undefined) as never,
throwing: async () => Object.defineProperty({}, 'value', {
enumerable: true,
get: () => { throw new Error('getter failed') },
}),
},
},
{ global: 'plain', functions: {} },
],
})
expect(result).toEqual({ logs: [], value: 'done' })
expect(replies.sort((left, right) => (left as { id: number }).id - (right as { id: number }).id)).toEqual([
{ type: 'reply', id: 1, ok: true, value: encodeWorkerJson(8) },
{ type: 'reply', id: 2, ok: false, message: 'nope' },
{ type: 'reply', id: 3, ok: false, message: 'unknown binding "bridge.missing"' },
{ type: 'reply', id: 4, ok: false, message: 'binding arguments must be lossless JSON' },
{ type: 'reply', id: 5, ok: false, message: 'binding resolution must be lossless JSON' },
{ type: 'reply', id: 6, ok: false, message: 'binding resolution must be lossless JSON' },
])
await fixture.fiber.dispose()
})
it('ignores malformed runner traffic and classifies terminal runner messages', async () => {
const ignored = [
null, 1, {}, { type: 'log' }, { type: 'call' },
{ type: 'call', id: 0, global: 'x', name: 'y', args: [] },
{ type: 'call', id: 1, global: 1, name: 'y', args: [] },
{ type: 'call', id: 1, global: 'x', name: 1, args: [] },
{ type: 'call', id: 1, global: 'x', name: 'y', args: {} },
{ type: 'done', error: null },
{ type: 'done', error: { kind: 'invented', message: 'x' } },
{ type: 'done', error: { kind: 'exception', message: 1 } },
]
const handles = [
new FakeHandle((message, current) => {
if ((message as { type?: string }).type !== 'boot') return
for (const item of ignored) current.emit(item)
current.emit({ type: 'done' })
}),
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emit({ type: 'done', error: { kind: 'exception', message: 'boom' } })
}),
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emit({ type: 'done', value: [] })
}),
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emit({ type: 'output-limit' })
}),
]
const fixture = await setup(handles, { maxOutputBytes: 64, maxFrameBytes: 128 })
await expect(fixture.runtime.run(request())).resolves.toEqual({ logs: [] })
await expect(fixture.runtime.run(request())).resolves.toEqual({ logs: [], error: { kind: 'exception', message: 'boom' } })
await expect(fixture.runtime.run(request())).resolves.toEqual({ logs: [], error: { kind: 'invalid-output', message: 'program completion must be lossless JSON' } })
await expect(fixture.runtime.run(request())).resolves.toEqual({ logs: [], error: { kind: 'output-limit', message: 'outer output exceeded 64 bytes' } })
await fixture.fiber.dispose()
})
it('enforces the host output ledger and catches malformed bridge output', async () => {
const handles = [
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emit({ type: 'log', text: 'x'.repeat(1_000) })
}),
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emitRaw('not-base64\n')
}),
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emitRaw('é')
}),
new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.stdout?.emit('error', new Error('stdout broke'))
}),
]
const fixture = await setup(handles, { maxOutputBytes: 128, maxFrameBytes: 4_096 })
expect((await fixture.runtime.run(request())).error?.kind).toBe('output-limit')
const malformed = (await fixture.runtime.run(request())).error
expect(malformed?.kind).toBe('worker-exit')
expect(malformed?.message).toContain('bridge failed')
expect((await fixture.runtime.run(request())).error?.message).toContain('non-ASCII')
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime stdout failed: stdout broke' })
await fixture.fiber.dispose()
})
it('contains stdin errors, process exits, spawn failures, and missing pipes', async () => {
const writeError = new FakeHandle(() => {}, { writeError: new Error('write callback broke') })
const stdinError = new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.stdin?.emit('error', new Error('stdin broke'))
})
const earlyExit = new FakeHandle(() => {}, { stderr: 'remote diagnostic' })
const quietExit = new FakeHandle()
const emptyStderrExit = new FakeHandle(() => {}, { stderr: '' })
const spawnFailure = new FakeHandle()
const missingStdin = new FakeHandle(() => {}, { stdin: false })
const missingStdout = new FakeHandle(() => {}, { stdout: false, waitError: new Error('missing-stream process query failed') })
const truncated = new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') {
current.emitRaw('YQ==')
setImmediate(() => { current.exit() })
}
})
const cleanupFailure = new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') current.emit({ type: 'done' })
}, { waitError: new Error('process query failed') })
const fixture = await setup([
writeError, stdinError, earlyExit, quietExit, emptyStderrExit,
spawnFailure, missingStdin, missingStdout, truncated, cleanupFailure,
])
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime bridge write failed: write callback broke' })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime stdin failed: stdin broke' })
setImmediate(() => { earlyExit.exit() })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime exited before completing: remote diagnostic' })
setImmediate(() => { quietExit.exit() })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime exited before completing' })
setImmediate(() => { emptyStderrExit.exit() })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime exited before completing' })
setImmediate(() => { spawnFailure.crash('spawn rejected') })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime spawn failed: spawn rejected' })
expect((await fixture.runtime.run(request())).error?.message).toContain('dropped a piped runtime stream')
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime cleanup failed: missing-stream process query failed' })
expect(missingStdin.terminated).toBe(1)
expect(missingStdin.waitCalls).toBe(1)
expect(missingStdout.terminated).toBe(1)
expect(missingStdout.waitCalls).toBe(1)
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B frame stream ended mid-frame' })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'worker-exit', message: 'E2B runtime cleanup failed: process query failed' })
await fixture.fiber.dispose()
})
it('reports wall timeout, abort, pre-abort, type-strip failure, and disposal', async () => {
const timeout = new FakeHandle()
const abort = new FakeHandle()
const disposing = new FakeHandle()
const fixture = await setup([timeout, abort, disposing], { maxWallMs: 20 })
expect((await fixture.runtime.run(request())).error).toEqual({ kind: 'timeout', message: 'wall-clock ceiling reached (20ms)' })
const controller = new AbortController()
const aborting = fixture.runtime.run({ ...request(), signal: controller.signal })
controller.abort('stop')
expect((await aborting).error).toEqual({ kind: 'abort', message: 'stop' })
expect((await fixture.runtime.run({ ...request(), signal: AbortSignal.abort('already') })).error)
.toEqual({ kind: 'abort', message: 'already' })
expect((await fixture.runtime.run(request('enum E { A }'))).error?.kind).toBe('exception')
const live = fixture.runtime.run(request())
await new Promise(resolve => setImmediate(resolve))
await fixture.fiber.dispose()
expect((await live).error).toEqual({ kind: 'abort', message: 'runtime disposed' })
await expect(fixture.runtime.run(request())).rejects.toThrow('after disposal')
})
it('drops binding replies that settle after abort', async () => {
const controller = new AbortController()
const resolution = Promise.withResolvers<string>()
const invoked = Promise.withResolvers<undefined>()
const handle = new FakeHandle((message, current) => {
if ((message as { type?: string }).type === 'boot') {
current.emit({ type: 'call', id: 1, global: 'bridge', name: 'late', args: encodeWorkerJson(null) })
}
})
const fixture = await setup([handle])
const running = fixture.runtime.run({
program: 'return await bridge.late(null)',
bindings: [{
global: 'bridge',
functions: {
late: async () => {
invoked.resolve(undefined)
return await resolution.promise
},
},
}],
signal: controller.signal,
})
await invoked.promise
controller.abort('stop')
expect((await running).error).toEqual({ kind: 'abort', message: 'stop' })
resolution.resolve('late')
await new Promise(resolve => setImmediate(resolve))
expect(handle.writes).toHaveLength(1)
await fixture.fiber.dispose()
})
it('validates binding and runtime configuration before remote execution', async () => {
const fixture = await setup([])
const invalidRequests = [
{ global: 'not-valid!', functions: {} },
{ global: 'await', functions: {} },
{ global: 'console', functions: {} },
{ global: 'same', functions: {} },
{ global: 'same', functions: {} },
{ global: 'ok', functions: {}, errorClass: { name: 'not-valid!', memberNameProperty: 'member' } },
{ global: 'ok', functions: {}, errorClass: { name: 'await', memberNameProperty: 'member' } },
{ global: 'Clash', functions: {}, errorClass: { name: 'Clash', memberNameProperty: 'member' } },
{ global: 'one', functions: {}, errorClass: { name: 'Err', memberNameProperty: 'member' } },
{ global: 'two', functions: {}, errorClass: { name: 'Err', memberNameProperty: 'member' } },
{ global: 'ok', functions: {}, errorClass: { name: 'Err', memberNameProperty: '' } },
{ global: 'ok', functions: {}, errorClass: { name: 'Err', memberNameProperty: 'message' } },
]
for (const bindings of [
[invalidRequests[0]], [invalidRequests[1]], [invalidRequests[2]],
invalidRequests.slice(3, 5), [invalidRequests[5]], [invalidRequests[6]],
[invalidRequests[7]], invalidRequests.slice(8, 10), [invalidRequests[10]], [invalidRequests[11]],
]) {
await expect(fixture.runtime.run({ program: 'return 1', bindings: bindings as never })).rejects.toThrow()
}
await fixture.fiber.dispose()
for (const config of [
{ computeMs: 0 }, { computeMs: 1.5 }, { maxOutputBytes: 3 },
{ maxWallMs: 2_147_483_648 }, { maxFrameBytes: 10, maxOutputBytes: 20 },
]) {
const ctx = new Context()
const subprocess = Object.create(E2BSubprocessService.prototype) as E2BSubprocessService
ctx.provide('e2b', { getSandbox: async () => ({}) } as never)
ctx.provide('subprocess', subprocess)
await expect(ctx.plugin(E2BCodeRuntime, config)).rejects.toThrow()
}
const wrong = new Context()
wrong.provide('e2b', { getSandbox: async () => ({}) } as never)
wrong.provide('subprocess', {} as never)
await expect(wrong.plugin(E2BCodeRuntime, {})).rejects.toThrow('dsh-subprocess-e2b')
})
it('turns asynchronous runtime preparation failure into a run result', async () => {
const sandbox = {
files: { write: vi.fn().mockRejectedValue(new Error('upload failed')) },
commands: { run: vi.fn() },
} as unknown as Sandbox
const fixture = await setup([], {}, sandbox)
expect((await fixture.runtime.run(request())).error).toEqual({
kind: 'worker-exit',
message: 'E2B runtime setup failed: upload failed',
})
await fixture.fiber.dispose()
})
it('returns disposal when remote preparation completes after teardown', async () => {
const gate = Promise.withResolvers<Sandbox>()
const fixture = await setup([], {}, {}, () => gate.promise)
const running = fixture.runtime.run(request())
await (fixture.runtime as unknown as { teardown(): Promise<void> }).teardown()
gate.resolve(fixture.sandbox)
expect((await running).error).toEqual({ kind: 'abort', message: 'runtime disposed' })
await fixture.fiber.dispose()
})
it('registers the package-owned invariant companion', async () => {
const ctx = new Context()
await ctx.plugin(InvariantService, { enabled: true })
const fiber = await ctx.plugin(E2BCodeRuntimeInvariant).await()
await fiber.dispose()
})
})