fabro/apps/fabro-web/app/lib/run-sandbox-lifecycle.ts
Bryan Helmkamp e18772888e
Model run sandbox lifecycle explicitly (#431)
## Summary

Fixes sandbox state reporting by separating a requested sandbox plan
from an initialized sandbox instance. Runs now project sandbox lifecycle
as `planned`, `initializing`, `ready`, or `failed`, and live sandbox
operations only proceed once a real instance exists.

## Changes

- Introduces `RunSandboxPlan`, `RunSandboxInstance`, and
lifecycle-backed `RunSandbox` domain types, with serde validation that
prevents `ready` sandboxes without an instance.
- Updates store projection behavior so sandbox events transition through
planned, initializing, ready, and failed states while preserving
requested provider/image/snapshot separately from runtime metadata.
- Tightens server sandbox handlers so
details/files/services/terminal/VNC helpers require an initialized
instance and return a clear 404 when the sandbox was never created.
- Updates the OpenAPI contract and regenerated clients so `Run.sandbox`
exposes lifecycle state while `SandboxDetails.sandbox` contains only
initialized instance metadata.
- Updates the web UI to render lifecycle state directly from run
summaries, hide the Sandbox tab for pure planned sandboxes, and disable
sandbox controls until the instance is ready.
- Cleans up duplicated lifecycle display/type logic and duplicate
server-side sandbox instance loading found during review.

| Lifecycle state | Meaning | Live controls |
| --- | --- | --- |
| `planned` | Sandbox was requested but no provider instance exists |
Hidden/disabled |
| `initializing` | Provider setup has started | State view only |
| `ready` | Runtime instance exists | Enabled |
| `failed` | Provider setup failed with error details | State view only
|

## Testing

- `cargo check --workspace`
- `cargo +nightly-2026-04-14 fmt --check --all`
- `git diff --check`
- `cd apps/fabro-web && bun run typecheck`
- `cd apps/fabro-web && bun test app/routes/run-detail.test.ts
app/routes/run-sandbox.test.tsx
app/components/run-summary-panel.test.tsx`
- `cargo nextest run -p fabro-types --test sandbox_model_serde`
- `cargo nextest run -p fabro-store
run_created_projects_planned_sandbox_lifecycle
sandbox_lifecycle_events_update_projected_sandbox_state
run_failed_before_sandbox_events_leaves_sandbox_planned`
- `cargo nextest run -p fabro-server
planned_sandbox_returns_404_from_details_endpoint
planned_sandbox_rejects_live_operations
failed_sandbox_rejects_live_operations
local_sandbox_returns_provider_neutral_details`
- `cargo nextest run -p fabro-api --test run_sandbox_round_trip`
- `cargo nextest run -p fabro-api --test sandbox_details_round_trip`

---

[![Compound
Engineering](https://img.shields.io/badge/Compound_Engineering-6366f1)](https://github.com/EveryInc/compound-engineering-plugin)
🤖 Generated with GPT-5 via [Codex](https://openai.com/codex)
2026-05-27 12:48:56 -04:00

91 lines
2.4 KiB
TypeScript

import type {
Run,
RunProjection,
RunSandbox,
RunSandboxInstance,
RunSandboxKind,
RunSandboxRuntime,
} from "@qltysh/fabro-api-client";
export type SandboxLifecycleKind = RunSandboxKind;
export type MaybeSandbox = Run["sandbox"] | RunProjection["sandbox"] | null | undefined;
export const SANDBOX_LIFECYCLE_DISPLAY: Record<
SandboxLifecycleKind,
{ label: string; description: string; dot: string; text: string }
> = {
planned: {
label: "Not created",
description: "The sandbox instance was not created.",
dot: "bg-fg-muted",
text: "text-fg-muted",
},
initializing: {
label: "Initializing",
description: "The sandbox is being created.",
dot: "bg-amber",
text: "text-amber",
},
ready: {
label: "Ready",
description: "The sandbox instance is available.",
dot: "bg-teal-500",
text: "text-teal-500",
},
failed: {
label: "Failed",
description: "Sandbox creation failed.",
dot: "bg-coral",
text: "text-coral",
},
};
export function sandboxLifecycleKind(
sandbox: MaybeSandbox,
): SandboxLifecycleKind | null {
if (!sandbox) return null;
const value = sandbox as RunSandbox & {
provider?: unknown;
runtime?: unknown;
};
if (value.kind) return value.kind as SandboxLifecycleKind;
return value.runtime ? "ready" : "planned";
}
export function sandboxInstance(
sandbox: MaybeSandbox,
): RunSandboxInstance | null {
if (!sandbox) return null;
const value = sandbox as RunSandbox & {
provider?: RunSandboxInstance["provider"];
image?: string | null;
snapshot?: string | null;
runtime?: RunSandboxRuntime | null;
};
if (value.instance) return value.instance;
if (value.runtime && value.provider) {
return {
provider: value.provider,
image: value.image ?? null,
snapshot: value.snapshot ?? null,
runtime: value.runtime,
};
}
return null;
}
export function sandboxRuntime(
sandbox: MaybeSandbox,
): RunSandboxRuntime | null {
return sandboxInstance(sandbox)?.runtime ?? null;
}
export function sandboxTabVisible(sandbox: MaybeSandbox): boolean {
const kind = sandboxLifecycleKind(sandbox);
return kind === "initializing" || kind === "ready" || kind === "failed";
}
export function sandboxIsReady(sandbox: MaybeSandbox): boolean {
return sandboxLifecycleKind(sandbox) === "ready" && sandboxInstance(sandbox) != null;
}