Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

refactor(eve)!: name sandbox handle lifecycle hooks (#4512)

Casey Gowrie32af96d23813
diff --git a/.changeset/rename-sandbox-handle-hooks.md b/.changeset/rename-sandbox-handle-hooks.md
new file mode 100644
index 000000000..6612ebb96
--- /dev/null
+++ b/.changeset/rename-sandbox-handle-hooks.md
@@ -0,0 +1,5 @@
+---
+"eve": minor
+---
+
+Rename custom sandbox provider handle hooks from `onSessionStop()` and `onSessionDelete()` to `onSandboxStop()` and `onSandboxDelete()` so handle lifecycle names describe the sandbox resource they operate on.
diff --git a/docs/sandbox/index.mdx b/docs/sandbox/index.mdx
index fb61fb1a6..bb6d894f9 100644
--- a/docs/sandbox/index.mdx
+++ b/docs/sandbox/index.mdx
@@ -221,7 +221,7 @@ export const AcmeSandbox = defineSandboxProvider<
`onSessionEnd()` is invoked when the durable session reaches a completed, expired, or failed terminal outcome. It receives the exact prepared artifact, persisted provider state, and a `reason` of `"completed"`, `"expired"`, or `"failed"`. Implement idempotent permanent cleanup from those values rather than depending on a live handle. eve retries the cleanup step and logs an exhausted failure without replacing the session's terminal outcome. A session that never opened a sandbox and a child that borrows its parent's sandbox do not call the hook.
-Provider handles implement `onSessionStop()`, `onRuntimeShutdown()`, and `onSessionDelete()`. These handle-level methods cover authored stop or delete calls, process shutdown, and failed initialization; `onSessionEnd()` is the single provider hook for durable terminal session cleanup.
+Provider handles implement `onSandboxStop()`, `onRuntimeShutdown()`, and `onSandboxDelete()`. These handle-level methods cover authored stop or delete calls, process shutdown, and failed initialization; `onSessionEnd()` is the single provider hook for durable terminal session cleanup.
Open options belong to `start()` and are not serialized or passed to `resume()`. A provider must put any immutable option-derived data needed for reconnection in its session state. With the current immutable-state contract, `resume()` reconnects existing native state and fails if it is gone rather than recreating callback side effects. A custom provider may define start-only callback fields, but built-in providers initialize the sandbox in `defineSandbox()` after `open()`.
diff --git a/e2e/fixtures/agent-tools-sandbox/agent/subagents/custom-provider/sandbox.ts b/e2e/fixtures/agent-tools-sandbox/agent/subagents/custom-provider/sandbox.ts
index d013fd0aa..2df47e5c9 100644
--- a/e2e/fixtures/agent-tools-sandbox/agent/subagents/custom-provider/sandbox.ts
+++ b/e2e/fixtures/agent-tools-sandbox/agent/subagents/custom-provider/sandbox.ts
@@ -83,7 +83,7 @@ function createHandle(marker: string) {
return {
sandbox: Object.freeze(session),
async onRuntimeShutdown() {},
- async onSessionDelete() {},
- async onSessionStop() {},
+ async onSandboxDelete() {},
+ async onSandboxStop() {},
};
}
diff --git a/packages/eve/extension-contracts/reports/channel/v54.json b/packages/eve/extension-contracts/reports/channel/v54.json
new file mode 100644
index 000000000..0392034ac
--- /dev/null
+++ b/packages/eve/extension-contracts/reports/channel/v54.json
@@ -0,0 +1,21 @@
+{
+ "kind": "eve-extension-capability-contract",
+ "capability": "channel",
+ "epoch": 54,
+ "sha256": "0775f79ab7ced86dd7dbfdc9d5e69ecef63aa8b5a5e3b0ab9660ab8edce24624",
+ "exports": [
+ "DELETE",
+ "GET",
+ "HEAD",
+ "OPTIONS",
+ "PATCH",
+ "POST",
+ "PUT",
+ "WS",
+ "createWebSocketUpgradeServer",
+ "defineChannel",
+ "disableRoute",
+ "isChannel",
+ "isDisabledRouteSentinel"
+ ]
+}
diff --git a/packages/eve/extension-contracts/reports/connection/v43.json b/packages/eve/extension-contracts/reports/connection/v43.json
new file mode 100644
index 000000000..bc0f3d0e2
--- /dev/null
+++ b/packages/eve/extension-contracts/reports/connection/v43.json
@@ -0,0 +1,16 @@
+{
+ "kind": "eve-extension-capability-contract",
+ "capability": "connection",
+ "epoch": 43,
+ "sha256": "6a9b13708208ea8d3689741e846db7b6e7b21665c0e10a67fd10ac5671cc2ff6",
+ "exports": [
+ "ConnectionAuthorizationFailedError",
+ "ConnectionAuthorizationRequiredError",
+ "defineDynamic",
+ "defineInteractiveAuthorization",
+ "defineMcpClientConnection",
+ "defineOpenAPIConnection",
+ "isConnectionAuthorizationFailedError",
+ "isConnectionAuthorizationRequiredError"
+ ]
+}
diff --git a/packages/eve/extension-contracts/reports/dynamicTool/v75.json b/packages/eve/extension-contracts/reports/dynamicTool/v75.json
new file mode 100644
index 000000000..31c2b4c74
--- /dev/null
+++ b/packages/eve/extension-contracts/reports/dynamicTool/v75.json
@@ -0,0 +1,16 @@
+{
+ "kind": "eve-extension-capability-contract",
+ "capability": "dynamicTool",
+ "epoch": 75,
+ "sha256": "43d67f94a80db8a05eee5693816c65fe4c4cfb2bd377212a2acd3ef9bac8c70e",
+ "exports": [
+ "DynamicToolEntry",
+ "DynamicToolEvents",
+ "DynamicToolResult",
+ "DynamicToolSet",
+ "auto",
+ "defineDurableCallback",
+ "defineDurableSchema",
+ "defineDynamic"
+ ]
+}
diff --git a/packages/eve/extension-contracts/reports/hook/v41.json b/packages/eve/extension-contracts/reports/hook/v41.json
new file mode 100644
index 000000000..505c527d5
--- /dev/null
+++ b/packages/eve/extension-contracts/reports/hook/v41.json
@@ -0,0 +1,7 @@
+{
+ "kind": "eve-extension-capability-contract",
+ "capability": "hook",
+ "epoch": 41,
+ "sha256": "d2ffac03dc4ee8867ede57cb805b433510f39364e3baf52f8f75c2332ae8f683",
+ "exports": ["defineHook"]
+}
diff --git a/packages/eve/extension-contracts/reports/state/v12.json b/packages/eve/extension-contracts/reports/state/v12.json
new file mode 100644
index 000000000..cea200a25
--- /dev/null
+++ b/packages/eve/extension-contracts/reports/state/v12.json
@@ -0,0 +1,15 @@
+{
+ "kind": "eve-extension-capability-contract",
+ "capability": "state",
+ "epoch": 12,
+ "sha256": "e2db73c0c548e51d5e66893c18d9cce85d9be0edb52dc05aa9edd70aaf3d0e45",
+ "exports": [
+ "Session",
+ "SessionAuth",
+ "SessionAuthContext",
+ "SessionContext",
+ "SessionParent",
+ "SessionTurn",
+ "defineState"
+ ]
+}
diff --git a/packages/eve/extension-contracts/reports/tool/v80.json b/packages/eve/extension-contracts/reports/tool/v80.json
new file mode 100644
index 000000000..a3a0b05b5
--- /dev/null
+++ b/packages/eve/extension-contracts/reports/tool/v80.json
@@ -0,0 +1,29 @@
+{
+ "kind": "eve-extension-capability-contract",
+ "capability": "tool",
+ "epoch": 80,
+ "sha256": "ac4f49ff9b94e88186e35b5105f5a3e70e8f06eaafa007625e48ecb7e1f0b77f",
+ "exports": [
+ "AgentRouterInput",
+ "AgentRouterTool",
+ "WorkflowStepToolContext",
+ "WorkflowTool",
+ "WorkflowToolDefinition",
+ "WorkflowToolInput",
+ "WorkflowToolOptions",
+ "agentRouter",
+ "decide",
+ "defaultWebSearch",
+ "defineTool",
+ "defineWorkflowTool",
+ "disableTool",
+ "isDisabledToolSentinel",
+ "isWebSearchToolDefinition",
+ "serializeModelInputSchema",
+ "toolOutput",
+ "toolOutputPart",
+ "toolResultFrom",
+ "webSearch",
+ "workflow"
+ ]
+}
diff --git a/packages/eve/src/compiler/extension-compatibility.ts b/packages/eve/src/compiler/extension-compatibility.ts
index 453129351..66f09b3fa 100644
--- a/packages/eve/src/compiler/extension-compatibility.ts
+++ b/packages/eve/src/compiler/extension-compatibility.ts
@@ -22,8 +22,8 @@ interface ExtensionCapabilityContract {
const EXTENSION_CAPABILITY_CONTRACTS = {
extension: { current: 1, supported: [1], dropped: {} },
tool: {
- current: 79,
- supported: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 29, 30, 31, 32, 34, 35, 76, 77, 78, 79],
+ current: 80,
+ supported: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 29, 30, 31, 32, 34, 35, 76, 77, 78, 80],
dropped: {
14: "TaskExec.delegated was removed; migrate to workflow-backed background tools",
15: "TaskExec replaces stageEffect with send",
@@ -81,13 +81,14 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
73: "eve/ai evaluate was renamed to decide and AI SDK evaluation models became decision models; import decide from eve/ai",
74: "eve/ai evaluate was renamed to decide and AI SDK evaluation models became decision models; import decide from eve/ai",
75: "eve/ai evaluate was renamed to decide and AI SDK evaluation models became decision models; import decide from eve/ai",
+ 79: "Sandbox provider handle hooks were renamed to onSandboxStop and onSandboxDelete.",
},
},
dynamicTool: {
- current: 74,
+ current: 75,
supported: [
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 22, 31, 32, 33, 52, 54,
- 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 72, 73, 74,
+ 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 72, 73, 75,
],
dropped: {
21: "Message and reasoning append events now expose deltas instead of cumulative snapshots.",
@@ -124,13 +125,14 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
58: "Approval response policies now run for Cancel as well as Approve; a policy written for Approve only could reject every Cancel.",
59: "Approval response policies now run for Cancel as well as Approve; a policy written for Approve only could reject every Cancel.",
71: "AI SDK evaluation models became decision models; auto() accepts decision models only",
+ 74: "Sandbox provider handle hooks were renamed to onSandboxStop and onSandboxDelete.",
},
},
channel: {
- current: 53,
+ current: 54,
supported: [
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 29, 31, 36, 37, 38, 39, 40, 41, 42,
- 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
+ 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 54,
],
dropped: {
12: "Message and reasoning append events now expose deltas instead of cumulative snapshots.",
@@ -149,6 +151,7 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
33: "Background task delivery was removed: sends no longer accept taskDeliveryPolicy and message.completed always carries text.",
34: 'Background task delivery was removed: sends no longer accept taskDeliveryPolicy and message.completed always carries text. input.resolved reports outcome "cancelled" when a workflow tool withdraws a ctx.ask() request, and stream events gained agent.started, published when a workflow run opens a ctx.agent session, and turn.waiting, which parks the open turn instead of emitting turn.completed and session.waiting.',
35: "Stream events gained task.started and task.settled, and input.requested, authorization events, and agent.started carry the taskId of the task they come from. The subagent.called, subagent.completed, subagent.started, and subagent.event stream events were removed; agent calls report task.started, task.settled, and agent.started.",
+ 53: "Sandbox provider handle hooks were renamed to onSandboxStop and onSandboxDelete.",
},
},
schedule: {
@@ -179,10 +182,10 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
},
},
connection: {
- current: 42,
+ current: 43,
supported: [
1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 26, 32, 33, 34,
- 35, 36, 37, 38, 39, 40, 41, 42,
+ 35, 36, 37, 38, 39, 40, 41, 43,
],
dropped: {
9: "Dynamic connection resolvers no longer receive conversation or channel continuation data",
@@ -194,11 +197,12 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
29: "Stream events gained task.started and task.settled, and input.requested, authorization events, and agent.started carry the taskId of the task they come from. The subagent.called, subagent.completed, subagent.started, and subagent.event stream events were removed; agent calls report task.started, task.settled, and agent.started.",
30: "Approval response policies now run for Cancel as well as Approve; a policy written for Approve only could reject every Cancel.",
31: "Approval response policies now run for Cancel as well as Approve; a policy written for Approve only could reject every Cancel.",
+ 42: "Sandbox provider handle hooks were renamed to onSandboxStop and onSandboxDelete.",
},
},
hook: {
- current: 40,
- supported: [20, 21, 22, 23, 25, 27, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40],
+ current: 41,
+ supported: [20, 21, 22, 23, 25, 27, 31, 32, 33, 34, 35, 36, 37, 38, 39, 41],
dropped: {
1: "Model identity moved from session.started runtime metadata to step.started call attribution.",
2: "Model identity moved from session.started runtime metadata to step.started call attribution.",
@@ -224,6 +228,7 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
28: "Background task execution was removed: subagent results no longer carry backgroundTask and message.completed always carries text.",
29: 'Background task execution was removed: subagent results no longer carry backgroundTask and message.completed always carries text. input.resolved reports outcome "cancelled" when a workflow tool withdraws a ctx.ask() request, and stream events gained agent.started, published when a workflow run opens a ctx.agent session, and turn.waiting, which parks the open turn instead of emitting turn.completed and session.waiting.',
30: "Stream events gained task.started and task.settled, and input.requested, authorization events, and agent.started carry the taskId of the task they come from. The subagent.called, subagent.completed, subagent.started, and subagent.event hook events were removed; subscribe to task.started, task.settled, and agent.started.",
+ 40: "Sandbox provider handle hooks were renamed to onSandboxStop and onSandboxDelete.",
},
},
skill: { current: 2, supported: [1, 2], dropped: {} },
@@ -256,11 +261,12 @@ const EXTENSION_CAPABILITY_CONTRACTS = {
},
config: { current: 1, supported: [1], dropped: {} },
state: {
- current: 11,
- supported: [1, 2, 3, 4, 5, 7, 9, 10, 11],
+ current: 12,
+ supported: [1, 2, 3, 4, 5, 7, 9, 10, 12],
dropped: {
6: "Sandbox sessions no longer expose core identity and mutable networking is provider-specific.",
8: "SandboxSession no longer exposes setNetworkPolicy; pass the configured environment to ctx.getSandbox(environment) to access network policy capabilities",
+ 11: "Sandbox provider handle hooks were renamed to onSandboxStop and onSandboxDelete.",
},
},
} as const satisfies Record<string, ExtensionCapabilityContract>;
diff --git a/packages/eve/src/execution/invoke-tool.test.ts b/packages/eve/src/execution/invoke-tool.test.ts
index 2940025b5..0b62da796 100644
--- a/packages/eve/src/execution/invoke-tool.test.ts
+++ b/packages/eve/src/execution/invoke-tool.test.ts
@@ -60,8 +60,8 @@ function sandboxes(options: { readonly startGate?: Promise<void> } = {}) {
handle: {
sandbox: sandbox.session,
onRuntimeShutdown: shutdown,
- onSessionDelete: deleted,
- onSessionStop: async () => {},
+ onSandboxDelete: deleted,
+ onSandboxStop: async () => {},
},
state: null,
};
@@ -117,8 +117,8 @@ function keyedSandboxes(options: { readonly failSelector?: () => boolean } = {})
const handle = {
sandbox: entry.sandbox.session,
onRuntimeShutdown: async () => {},
- onSessionDelete: async () => deleted(sessionId),
- onSessionStop: stopped,
+ onSandboxDelete: async () => deleted(sessionId),
+ onSandboxStop: stopped,
};
handles.push(handle);
return handle;
diff --git a/packages/eve/src/execution/sandbox/bindings/docker.integration.test.ts b/packages/eve/src/execution/sandbox/bindings/docker.integration.test.ts
index cf026efdb..d118e7426 100644
--- a/packages/eve/src/execution/sandbox/bindings/docker.integration.test.ts
+++ b/packages/eve/src/execution/sandbox/bindings/docker.integration.test.ts
@@ -441,7 +441,7 @@ describe("Docker provider create", () => {
// An authored stop releases the container; filesystem state survives
// for the next `create` to restart from.
- await handle.onSessionStop();
+ await handle.onSandboxStop();
expect(findCall(calls, (args) => args[0] === "stop")?.args).toEqual([
"stop",
"-t",
diff --git a/packages/eve/src/execution/sandbox/bindings/docker.test.ts b/packages/eve/src/execution/sandbox/bindings/docker.test.ts
index c52e17327..06c0cafe2 100644
--- a/packages/eve/src/execution/sandbox/bindings/docker.test.ts
+++ b/packages/eve/src/execution/sandbox/bindings/docker.test.ts
@@ -34,7 +34,7 @@ describe("Docker sandbox deletion", () => {
});
vi.mocked(run).mockClear();
- await handle.onSessionDelete();
+ await handle.onSandboxDelete();
expect(run).toHaveBeenNthCalledWith(1, ["stop", "-t", "0", "container-id-1"]);
expect(run).toHaveBeenNthCalledWith(2, ["rm", "-f", "container-id-1"]);
@@ -68,7 +68,7 @@ describe("Docker sandbox deletion", () => {
appRoot: "/tmp/eve-app",
sandboxName: "session-key",
});
- await oldHandle.onSessionDelete();
+ await oldHandle.onSandboxDelete();
containerId = "container-id-2";
await provider.openSession({
appRoot: "/tmp/eve-app",
diff --git a/packages/eve/src/execution/sandbox/bindings/docker.ts b/packages/eve/src/execution/sandbox/bindings/docker.ts
index 4790efadc..2e821fe52 100644
--- a/packages/eve/src/execution/sandbox/bindings/docker.ts
+++ b/packages/eve/src/execution/sandbox/bindings/docker.ts
@@ -178,14 +178,14 @@ export function createDockerSandboxProvider(
);
return {
sandbox: session,
- async onSessionDelete() {
+ async onSandboxDelete() {
await stopDockerContainerIfRunning(cli, containerIdentity);
expectDockerSuccess(
await cli.run(["rm", "-f", containerIdentity]),
`delete sandbox session container "${containerName}"`,
);
},
- async onSessionStop() {
+ async onSandboxStop() {
await stopDockerContainerIfRunning(cli, containerIdentity);
},
async onRuntimeShutdown() {
diff --git a/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.integration.test.ts b/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.integration.test.ts
index 2450318ea..729be72b5 100644
--- a/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.integration.test.ts
+++ b/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.integration.test.ts
@@ -28,7 +28,7 @@ describe("just-bash sandbox deletion", () => {
} satisfies BashSandbox;
const handle = createJustBashHandle(sandbox);
- await handle.onSessionDelete();
+ await handle.onSandboxDelete();
expect(dispose).toHaveBeenCalledTimes(1);
await expect(access(rootPath)).rejects.toMatchObject({ code: "ENOENT" });
diff --git a/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.ts b/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.ts
index 9f4b2d11a..f3598f347 100644
--- a/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.ts
+++ b/packages/eve/src/execution/sandbox/bindings/just-bash-runtime.ts
@@ -207,11 +207,11 @@ export function createJustBashHandle(sandbox: BashSandbox): SandboxProviderHandl
const session = buildSandboxSession(createFileBackedInternalSandboxSession({ sandbox }));
return {
sandbox: session,
- async onSessionDelete() {
+ async onSandboxDelete() {
await sandbox.dispose();
await rm(sandbox.rootPath, { force: true, recursive: true });
},
- async onSessionStop() {
+ async onSandboxStop() {
await sandbox.dispose();
},
// The interpreter lives in this process, so stopping it is all the
diff --git a/packages/eve/src/execution/sandbox/bindings/just-bash.scenario.test.ts b/packages/eve/src/execution/sandbox/bindings/just-bash.scenario.test.ts
index 60eeed82d..8f2353366 100644
--- a/packages/eve/src/execution/sandbox/bindings/just-bash.scenario.test.ts
+++ b/packages/eve/src/execution/sandbox/bindings/just-bash.scenario.test.ts
@@ -298,7 +298,7 @@ describe("just-bash sandbox file API", () => {
path: "persisted.txt",
});
- await firstHandle.onSessionStop();
+ await firstHandle.onSandboxStop();
expect(state).toMatchObject({ version: 2 });
await expect(
diff --git a/packages/eve/src/execution/sandbox/bindings/just-bash.ts b/packages/eve/src/execution/sandbox/bindings/just-bash.ts
index c180ce47a..f9d2e7f22 100644
--- a/packages/eve/src/execution/sandbox/bindings/just-bash.ts
+++ b/packages/eve/src/execution/sandbox/bindings/just-bash.ts
@@ -150,7 +150,7 @@ export function createJustBashSandboxProvider(
};
// Each handle runs its own interpreter in this process; stopping it keeps the root's files.
return withToolSessionSandboxes(implementation, {
- releaseHandle: (handle) => handle.onSessionStop(),
+ releaseHandle: (handle) => handle.onSandboxStop(),
});
}
diff --git a/packages/eve/src/execution/sandbox/bindings/microsandbox-lifecycle.ts b/packages/eve/src/execution/sandbox/bindings/microsandbox-lifecycle.ts
index 3cf330b62..b68a30335 100644
--- a/packages/eve/src/execution/sandbox/bindings/microsandbox-lifecycle.ts
+++ b/packages/eve/src/execution/sandbox/bindings/microsandbox-lifecycle.ts
@@ -390,12 +390,12 @@ function createHandle(
);
return {
sandbox: session,
- async onSessionDelete() {
+ async onSandboxDelete() {
await sandbox.shutdown();
await sandbox.removePersisted();
onShutdown?.();
},
- async onSessionStop() {
+ async onSandboxStop() {
await sandbox.stop();
onShutdown?.();
},
diff --git a/packages/eve/src/execution/sandbox/bindings/vercel.test.ts b/packages/eve/src/execution/sandbox/bindings/vercel.test.ts
index 088f20b37..7423a15e8 100644
--- a/packages/eve/src/execution/sandbox/bindings/vercel.test.ts
+++ b/packages/eve/src/execution/sandbox/bindings/vercel.test.ts
@@ -766,7 +766,7 @@ describe("createVercelSandbox", () => {
vi.mocked(sessionSandbox.runCommand).mockResolvedValue(createMockDetachedCommand() as never);
vi.mocked(sessionSandbox.runCommand).mockClear();
- await handle.onSessionStop();
+ await handle.onSandboxStop();
await handle.sandbox.run({ command: "printf resumed" });
expect(sessionSandbox.stop).toHaveBeenCalledTimes(1);
@@ -812,7 +812,7 @@ describe("createVercelSandbox", () => {
});
const abortSignal = new AbortController().signal;
- await expect(handle.onSessionDelete({ abortSignal })).resolves.toBeUndefined();
+ await expect(handle.onSandboxDelete({ abortSignal })).resolves.toBeUndefined();
expect(order).toEqual(["stop", "sandbox-get", "sandbox-delete"]);
expect(stableGet).toHaveBeenCalledWith({
@@ -860,7 +860,7 @@ describe("createVercelSandbox", () => {
const { handle, sessionSandbox } = await createTestVercelSession();
sessionSandbox.stop.mockRejectedValueOnce(new Error("provider unreachable"));
- await expect(handle.onSessionStop()).rejects.toThrow("provider unreachable");
+ await expect(handle.onSandboxStop()).rejects.toThrow("provider unreachable");
});
it("applies the open-time policy after template-less base setup", async () => {
diff --git a/packages/eve/src/execution/sandbox/bindings/vercel.ts b/packages/eve/src/execution/sandbox/bindings/vercel.ts
index 83fd6fabb..0db32484a 100644
--- a/packages/eve/src/execution/sandbox/bindings/vercel.ts
+++ b/packages/eve/src/execution/sandbox/bindings/vercel.ts
@@ -574,7 +574,7 @@ function createHandle(input: {
createVercelInternalSandboxSession(sandbox),
createVercelNetworkPolicySetter(sandbox),
),
- async onSessionDelete(options) {
+ async onSandboxDelete(options) {
await deleteVercelSandbox({
createOptions: input.createOptions,
loadDeleteSandboxModule: input.loadDeleteSandboxModule,
@@ -582,7 +582,7 @@ function createHandle(input: {
signal: options?.abortSignal,
});
},
- async onSessionStop() {
+ async onSandboxStop() {
await stopVercelSandbox(sandbox);
},
async onRuntimeShutdown() {
diff --git a/packages/eve/src/execution/sandbox/ensure.test.ts b/packages/eve/src/execution/sandbox/ensure.test.ts
index bdea4a172..759c7667c 100644
--- a/packages/eve/src/execution/sandbox/ensure.test.ts
+++ b/packages/eve/src/execution/sandbox/ensure.test.ts
@@ -24,9 +24,9 @@ function fixture(setup?: () => void, returnCopy = false, onSessionEnd?: () => Pr
const sandbox = mockSandbox();
return {
sandbox: sandbox.session,
- onSessionDelete: deleteSandbox,
+ onSandboxDelete: deleteSandbox,
onRuntimeShutdown: shutdownSandbox,
- onSessionStop: stopSandbox,
+ onSandboxStop: stopSandbox,
};
});
const start = vi.fn(async () => ({ handle: await create(), state: null }));
diff --git a/packages/eve/src/execution/sandbox/ensure.ts b/packages/eve/src/execution/sandbox/ensure.ts
index 925bd3506..53e3db49f 100644
--- a/packages/eve/src/execution/sandbox/ensure.ts
+++ b/packages/eve/src/execution/sandbox/ensure.ts
@@ -169,8 +169,8 @@ export async function ensureSandboxAccess(
): RuntimeSandboxSession {
const sandbox = withRuntimeSandboxLifecycle(
handle.sandbox,
- (deleteOptions?: SandboxDeleteOptions) => handle.onSessionDelete(deleteOptions),
- () => handle.onSessionStop(),
+ (deleteOptions?: SandboxDeleteOptions) => handle.onSandboxDelete(deleteOptions),
+ () => handle.onSandboxStop(),
);
opened = { handle, providerName, sandbox };
return sandbox;
@@ -311,7 +311,7 @@ export async function ensureSandboxAccess(
// same tool-session key, is using; only an owning access discards it.
if (failed !== undefined && input.ownsSandbox !== false) {
try {
- await failed.onSessionDelete();
+ await failed.onSandboxDelete();
} catch (cleanupError) {
throw new AggregateError(
[error, cleanupError],
@@ -356,7 +356,7 @@ export async function ensureSandboxAccess(
throw new Error("Only the owning session can delete this sandbox.");
const current = await requireHandle();
const providerName = opened?.providerName;
- await current.onSessionDelete(deleteOptions);
+ await current.onSandboxDelete(deleteOptions);
if (providerName !== undefined) {
untrackActiveSandboxHandle({ handle: current, providerName, sessionId: input.sessionId });
}
@@ -423,10 +423,10 @@ export async function ensureSandboxAccess(
if (provider.implementation.onSessionEnd !== undefined) {
await provider.implementation.onSessionEnd(context, artifact, persisted.state, { reason });
} else if (current !== undefined) {
- await current.handle.onSessionDelete();
+ await current.handle.onSandboxDelete();
} else {
const resumed = await provider.implementation.resume(context, artifact, persisted.state);
- await resumed.onSessionDelete();
+ await resumed.onSandboxDelete();
}
if (current !== undefined) {
untrackActiveSandboxHandle({
@@ -446,7 +446,7 @@ export async function ensureSandboxAccess(
},
async stop() {
const current = await requireHandle();
- await current.onSessionStop();
+ await current.onSandboxStop();
opened = undefined;
opening = undefined;
requiring = undefined;
diff --git a/packages/eve/src/execution/session-reset.integration.test.ts b/packages/eve/src/execution/session-reset.integration.test.ts
index a4fbec45a..61f4ce773 100644
--- a/packages/eve/src/execution/session-reset.integration.test.ts
+++ b/packages/eve/src/execution/session-reset.integration.test.ts
@@ -91,8 +91,8 @@ function createSessionSandboxHarness() {
function createHandle(sessionId: string, value = mockSandbox({ id: sessionId })) {
return {
sandbox: value.session,
- async onSessionDelete() {},
- async onSessionStop() {},
+ async onSandboxDelete() {},
+ async onSandboxStop() {},
async onRuntimeShutdown() {},
};
}
diff --git a/packages/eve/src/internal/testing/app-harness.ts b/packages/eve/src/internal/testing/app-harness.ts
index 0f3c9fc6a..dd9c52e07 100644
--- a/packages/eve/src/internal/testing/app-harness.ts
+++ b/packages/eve/src/internal/testing/app-harness.ts
@@ -159,11 +159,11 @@ function createTestSandboxProvider() {
const opened = sandbox;
return {
sandbox: opened.session,
- async onSessionDelete(options?: import("#shared/sandbox-provider.js").SandboxDeleteOptions) {
+ async onSandboxDelete(options?: import("#shared/sandbox-provider.js").SandboxDeleteOptions) {
sessionSandboxes.delete(sessionId);
await opened.access.delete?.(options);
},
- async onSessionStop() {},
+ async onSandboxStop() {},
async onRuntimeShutdown() {},
};
}
diff --git a/packages/eve/src/shared/sandbox-provider.test.ts b/packages/eve/src/shared/sandbox-provider.test.ts
index b9c1648d4..d01a9f691 100644
--- a/packages/eve/src/shared/sandbox-provider.test.ts
+++ b/packages/eve/src/shared/sandbox-provider.test.ts
@@ -40,8 +40,8 @@ function handle(nativeId: string) {
removePath: vi.fn(),
},
onRuntimeShutdown: vi.fn(async () => {}),
- onSessionDelete: vi.fn(async () => {}),
- onSessionStop: vi.fn(async () => {}),
+ onSandboxDelete: vi.fn(async () => {}),
+ onSandboxStop: vi.fn(async () => {}),
nativeId,
};
}
diff --git a/packages/eve/src/shared/sandbox-provider.ts b/packages/eve/src/shared/sandbox-provider.ts
index 403346cb3..f5d6b3407 100644
--- a/packages/eve/src/shared/sandbox-provider.ts
+++ b/packages/eve/src/shared/sandbox-provider.ts
@@ -124,8 +124,8 @@ export interface SandboxProviderSessionContext {
export interface SandboxProviderHandle<Session extends SandboxSession = SandboxSession> {
readonly sandbox: Session;
onRuntimeShutdown(): Promise<void>;
- onSessionDelete(options?: SandboxDeleteOptions): Promise<void>;
- onSessionStop(): Promise<void>;
+ onSandboxDelete(options?: SandboxDeleteOptions): Promise<void>;
+ onSandboxStop(): Promise<void>;
}
export interface SandboxProviderImplementation<