509 lines · 16.4 KB · TypeScript
RawDownload
/** * DynamicWorkerExecutor — runs sandboxed code in an isolated Cloudflare * Worker via the WorkerLoader binding. * * Tool calls are dispatched over Workers RPC: the host creates a * `ToolDispatcher` (an `RpcTarget`) that bridges back to the * `SandboxToolInvoker` from codemode-core, and passes it to the * dynamic worker's `evaluate()` entrypoint. */ import { RpcTarget } from "cloudflare:workers";import * as Cause from "effect/Cause";import * as Data from "effect/Data";import * as Effect from "effect/Effect"; import {  recoverExecutionBody,  stripTypeScript,  type CodeExecutor,  type ExecuteResult,  type SandboxToolInvoker,} from "@executor-js/codemode-core"; import { buildExecutorModule } from "./module-template"; // ---------------------------------------------------------------------------// Errors// --------------------------------------------------------------------------- export class DynamicWorkerExecutionError extends Data.TaggedError("DynamicWorkerExecutionError")<{  readonly message: string;}> {} // ---------------------------------------------------------------------------// Options// --------------------------------------------------------------------------- export type DynamicWorkerExecutorOptions = {  readonly loader: WorkerLoader;  /**   * Timeout in milliseconds for code execution. Defaults to 5 minutes.   */  readonly timeoutMs?: number;  /**   * Controls outbound network access from sandboxed code.   * - `null` (default): `fetch()` and `connect()` throw — fully isolated.   * - `undefined`: inherits parent Worker's network access.   * - A `Fetcher`: all outbound requests route through this handler.   */  readonly globalOutbound?: Fetcher | null;  /**   * Additional modules to make available in the sandbox.   * Keys are module specifiers, values are module source code.   * The key `"executor.js"` is reserved.   */  readonly modules?: Record<string, string>;}; export type SerializedWorkerErrorValue = unknown; export type SerializedWorkerError = {  readonly kind: "fail" | "die" | "interrupt" | "mixed" | "unknown";  readonly message: string;  readonly primary: SerializedWorkerErrorValue | null;  readonly failures: ReadonlyArray<SerializedWorkerErrorValue>;  readonly defects: ReadonlyArray<SerializedWorkerErrorValue>;  readonly interrupted: boolean;}; type WorkerRpcSuccess = {  readonly ok: true;  readonly result: unknown;}; type WorkerRpcFailure = {  readonly ok: false;  readonly error: SerializedWorkerError;}; type WorkerRpcResponse = WorkerRpcSuccess | WorkerRpcFailure; // ---------------------------------------------------------------------------// Constants// --------------------------------------------------------------------------- const DEFAULT_TIMEOUT_MS = 5 * 60_000;const ENTRY_MODULE = "executor.js"; const normalizeErrorObject = (error: Error) => ({  __type: "Error" as const,  name: error.name,  message: error.message,}); const isNormalizedErrorObject = (  value: unknown,): value is { readonly __type: "Error"; readonly message: string } =>  typeof value === "object" &&  value !== null &&  "__type" in value &&  value.__type === "Error" &&  "message" in value &&  typeof value.message === "string"; const serializeWorkerErrorValue = (value: unknown): SerializedWorkerErrorValue => {  if (value instanceof Error) {    return normalizeErrorObject(value);  }   if (    value === null ||    typeof value === "string" ||    typeof value === "number" ||    typeof value === "boolean"  ) {    return value;  }   try {    return JSON.parse(JSON.stringify(value)) as SerializedWorkerErrorValue;  } catch {    return String(value);  }}; const renderTransportMessage = (value: unknown): string => {  if (typeof value === "string") {    return value;  }   if (isNormalizedErrorObject(value)) {    return value.message;  }   if (value instanceof Error) {    return value.message;  }   if (    typeof value === "object" &&    value !== null &&    "message" in value &&    typeof value.message === "string"  ) {    return value.message;  }   if (typeof value === "object" && value !== null) {    try {      return JSON.stringify(value);    } catch {      return String(value);    }  }   if (typeof value === "undefined") {    return "Unknown error";  }   return String(value);}; export const serializeWorkerCause = (cause: Cause.Cause<unknown>): SerializedWorkerError => {  const failures = cause.reasons    .filter(Cause.isFailReason)    .map((reason) => serializeWorkerErrorValue(reason.error));  const defects = cause.reasons    .filter(Cause.isDieReason)    .map((reason) => serializeWorkerErrorValue(reason.defect));  const interrupted = cause.reasons.some(Cause.isInterruptReason);  const primary = failures[0] ?? defects[0] ?? null;  const kind =    failures.length > 0 && defects.length > 0      ? "mixed"      : failures.length > 0        ? "fail"        : defects.length > 0          ? "die"          : interrupted            ? "interrupt"            : "unknown";   return {    kind,    message:      primary !== null        ? renderTransportMessage(primary)        : interrupted          ? "Interrupted"          : "Unknown error",    primary,    failures,    defects,    interrupted,  };}; export const renderWorkerError = (error: SerializedWorkerError): string => {  if (isNormalizedErrorObject(error.primary)) {    return error.primary.message;  }   if (typeof error.primary === "string") {    return error.primary;  }   if (    typeof error.primary === "object" &&    error.primary !== null &&    "message" in error.primary &&    typeof error.primary.message === "string"  ) {    return error.primary.message;  }   if (typeof error.primary === "object" && error.primary !== null) {    try {      return JSON.stringify(error.primary);    } catch {      return error.message;    }  }   return error.message;}; export type { WorkerRpcResponse }; // ---------------------------------------------------------------------------// Blob/File codec (both directions across the dispatcher boundary)//// Workers RPC's structured-clone allow-list excludes `Blob` / `File`, so// we encode them to a tagged ArrayBuffer envelope and rehydrate on the// far side. Symmetric in both directions: sandbox encodes args + host// rehydrates them; host encodes result + sandbox rehydrates it. The// matching encoder lives inside `module-template.ts` because it runs in// the dynamic Worker isolate. `ArrayBuffer` / typed arrays / primitives// cross structured clone natively.// --------------------------------------------------------------------------- type BinaryEnvelope = {  readonly __executorBinary: 1;  readonly kind: "blob" | "file";  readonly type: string;  readonly name?: string;  readonly lastModified?: number;  readonly buffer: ArrayBuffer;}; const isBinaryEnvelope = (value: unknown): value is BinaryEnvelope =>  typeof value === "object" &&  value !== null &&  (value as { __executorBinary?: unknown }).__executorBinary === 1 &&  (value as { buffer?: unknown }).buffer instanceof ArrayBuffer &&  typeof (value as { type?: unknown }).type === "string"; const isPlainObject = (value: object): boolean => {  const proto = Object.getPrototypeOf(value);  return proto === Object.prototype || proto === null;}; const rehydrateBinary = (value: unknown, seen = new WeakSet<object>()): unknown => {  if (value === null || typeof value !== "object") return value;  if (value instanceof ArrayBuffer || ArrayBuffer.isView(value)) return value;  if (seen.has(value)) {    throw new Error("Tool RPC payload contains a circular reference");  }  seen.add(value);  if (isBinaryEnvelope(value)) {    if (value.kind === "file" && typeof value.name === "string") {      return new File([value.buffer], value.name, {        type: value.type,        ...(typeof value.lastModified === "number" ? { lastModified: value.lastModified } : {}),      });    }    return new Blob([value.buffer], { type: value.type });  }  if (Array.isArray(value)) return value.map((item) => rehydrateBinary(item, seen));  if (!isPlainObject(value)) return value;  const out: Record<string, unknown> = {};  for (const [k, v] of Object.entries(value as Record<string, unknown>)) {    out[k] = rehydrateBinary(v, seen);  }  return out;}; // Async because `Blob.arrayBuffer()` is async. Used on tool results before// the dispatcher hands them back to the sandbox.const encodeBinary = async (value: unknown, seen = new WeakSet<object>()): Promise<unknown> => {  if (value === null || typeof value !== "object") return value;  if (value instanceof ArrayBuffer || ArrayBuffer.isView(value)) return value;  if (seen.has(value)) {    throw new Error("Tool RPC payload contains a circular reference");  }  seen.add(value);  if (typeof File !== "undefined" && value instanceof File) {    return {      __executorBinary: 1 as const,      kind: "file" as const,      type: value.type,      name: value.name,      lastModified: value.lastModified,      buffer: await value.arrayBuffer(),    };  }  if (value instanceof Blob) {    return {      __executorBinary: 1 as const,      kind: "blob" as const,      type: value.type,      buffer: await value.arrayBuffer(),    };  }  if (Array.isArray(value)) return Promise.all(value.map((item) => encodeBinary(item, seen)));  if (!isPlainObject(value)) return value;  const out: Record<string, unknown> = {};  for (const [k, v] of Object.entries(value as Record<string, unknown>)) {    out[k] = await encodeBinary(v, seen);  }  return out;}; // ---------------------------------------------------------------------------// ToolDispatcher — bridges RPC calls back to SandboxToolInvoker// --------------------------------------------------------------------------- /** * An `RpcTarget` passed to the dynamic Worker so that sandboxed code can * invoke tools on the host. The dynamic worker calls * `__dispatcher.call(path, args)` over Workers RPC. `Uint8Array` / * `ArrayBuffer` cross structured clone natively; `Blob` / `File` are * encoded sandbox-side as a tagged envelope and rehydrated here via * `rehydrateBinary` before the invoker sees them. JSON serialization on * this hop would replace those values with `"{}"` or numeric-keyed * objects, which is what broke `multipart/form-data` uploads. * * Each call is wrapped in an `executor.tool.rpc_dispatch` span so the * tool-invocation shell (Workers RPC roundtrip → local invoker → * serialize result) is visible in the trace. Tool-level attributes * like `mcp.tool.name` already come from the inner * `mcp.tool.dispatch` span that `tool-invoker.ts` wraps around * `executor.tools.invoke`. */export type RunPromise = <A, E>(effect: Effect.Effect<A, E>) => Promise<A>; export class ToolDispatcher extends RpcTarget {  readonly #invoker: SandboxToolInvoker;  readonly #runPromise: RunPromise;   constructor(invoker: SandboxToolInvoker, runPromise: RunPromise) {    super();    this.#invoker = invoker;    this.#runPromise = runPromise;  }   async call(path: string, args: unknown): Promise<WorkerRpcResponse> {    return this.#runPromise(      Effect.try({        try: () => rehydrateBinary(args),        catch: (cause) => cause,      }).pipe(        Effect.flatMap((decodedArgs) => this.#invoker.invoke({ path, args: decodedArgs })),        Effect.flatMap((value) =>          Effect.tryPromise({            try: (): Promise<WorkerRpcResponse> =>              encodeBinary(value).then((result) => ({ ok: true, result })),            // Encoding failed (e.g. Blob.arrayBuffer rejected) — surface            // it as a normal failure envelope rather than throwing.            catch: (cause) => cause,          }),        ),        Effect.catchCause((cause) =>          Effect.succeed<WorkerRpcResponse>({            ok: false,            error: serializeWorkerCause(cause),          }),        ),        Effect.withSpan("executor.tool.rpc_dispatch", {          attributes: {            "mcp.tool.name": path,          },        }),      ),    );  }} // ---------------------------------------------------------------------------// Evaluate// --------------------------------------------------------------------------- type DynamicWorkerEntrypoint = {  evaluate(dispatcher: ToolDispatcher): Promise<{    result: unknown;    error?: SerializedWorkerError;    logs?: string[];  }>;}; const asDynamicWorkerEntrypoint = (value: unknown): DynamicWorkerEntrypoint =>  value as DynamicWorkerEntrypoint; /** * Assemble the executor module source and ask the `WorkerLoader` for an * isolate. Spans the synchronous module-build + RPC-stub acquisition as * `executor.runtime.startup` so the trace separates "did we wait on * worker boot?" from the actual `evaluate` RPC roundtrip. */const startDynamicWorker = (  options: DynamicWorkerExecutorOptions,  code: string,  timeoutMs: number,): Effect.Effect<DynamicWorkerEntrypoint, DynamicWorkerExecutionError> =>  Effect.try({    try: (): DynamicWorkerEntrypoint => {      const recoveredBody = recoverExecutionBody(code);      // The dynamic Worker isolate only accepts plain JavaScript; TS type      // syntax in user code (`: T`, `as T`, generics) would otherwise      // surface as "Unexpected token ':'" inside `evaluate()` and bubble      // out via DynamicWorkerExecutionError. Stripping here gives the      // model a clear syntax-error message at the front door instead.      const strippedBody = stripTypeScript(recoveredBody);      const executorModule = buildExecutorModule(strippedBody, timeoutMs);      const { [ENTRY_MODULE]: _, ...safeModules } = options.modules ?? {};       const worker = options.loader.get(`executor-${crypto.randomUUID()}`, () => ({        compatibilityDate: "2025-06-01",        compatibilityFlags: ["nodejs_compat"],        mainModule: ENTRY_MODULE,        modules: {          ...safeModules,          [ENTRY_MODULE]: executorModule,        },        globalOutbound: options.globalOutbound ?? null,      }));       return asDynamicWorkerEntrypoint(worker.getEntrypoint());    },    catch: (cause) =>      new DynamicWorkerExecutionError({        message: renderTransportMessage(serializeWorkerErrorValue(cause)),      }),  }).pipe(    Effect.withSpan("executor.runtime.startup", {      attributes: {        "executor.runtime": "dynamic-worker",        "executor.code.length": code.length,        "executor.timeout_ms": timeoutMs,        "executor.extra_modules": Object.keys(options.modules ?? {}).length,      },    }),  ); const evaluate = (  options: DynamicWorkerExecutorOptions,  code: string,  toolInvoker: SandboxToolInvoker,): Effect.Effect<ExecuteResult, DynamicWorkerExecutionError> => {  const timeoutMs = Math.max(100, options.timeoutMs ?? DEFAULT_TIMEOUT_MS);   return Effect.gen(function* () {    const context = yield* Effect.context<never>();    const dispatcher = new ToolDispatcher(toolInvoker, Effect.runPromiseWith(context));    const entrypoint = yield* startDynamicWorker(options, code, timeoutMs);    const response = yield* Effect.tryPromise({      try: () => entrypoint.evaluate(dispatcher),      catch: (cause) =>        new DynamicWorkerExecutionError({          message: renderTransportMessage(serializeWorkerErrorValue(cause)),        }),    }).pipe(      Effect.withSpan("executor.runtime.evaluate", {        attributes: { "executor.runtime": "dynamic-worker" },      }),    );    const error = response.error ? renderWorkerError(response.error) : undefined;    return {      result: error ? null : response.result,      error,      logs: response.logs,    } satisfies ExecuteResult;  });}; // ---------------------------------------------------------------------------// Effect wrapper// --------------------------------------------------------------------------- const runInDynamicWorker = (  options: DynamicWorkerExecutorOptions,  code: string,  toolInvoker: SandboxToolInvoker,): Effect.Effect<ExecuteResult, DynamicWorkerExecutionError> =>  evaluate(options, code, toolInvoker).pipe(    Effect.withSpan("executor.code.exec.dynamic_worker", {      attributes: { "executor.runtime": "dynamic-worker" },    }),  ); // ---------------------------------------------------------------------------

Lines 1–500 of 509.