@beachside/freestyle 0.0.0 → 0.12.0

package/README.md

@@ -1,5 +1,55 @@
 # @beachside/freestyle
 
-This 0.0.0 version reserves the package name so releases can use npm trusted publishing. It contains no code.
+Experimental Freestyle VMs adapter for Beachside. Tested on every change against a simulated Freestyle API, and checked by hand against the live service; not yet through the provider qualification suite. Install with `npm install beachside @beachside/freestyle`. Requires Node 20+ or Bun and a Freestyle API key. Built on Freestyle's official SDK, pinned to `freestyle@0.2.21` (public API v5).
 
-Releases are published from https://github.com/pandemicsyn/beachside/blob/main/packages/providers/freestyle.
+```ts
+import { Beachside } from "beachside";
+import { freestyleAdapter } from "@beachside/freestyle";
+
+const client = await Beachside.connect({
+  adapter: freestyleAdapter,
+  credentials: { apiKey: process.env.FREESTYLE_API_KEY! },
+  config: { network: "blocked" },
+});
+try {
+  const box = await client.sandboxes.create();
+  try {
+    console.log((await box.exec(["/bin/sh", "-c", "printf ready"])).stdoutText());
+  } finally {
+    await box.destroy();
+  }
+} finally {
+  await client.close();
+}
+```
+
+Freestyle does not reveal which account an API key belongs to, so the scope is a one-way fingerprint of the key plus the fixed `https://api.freestyle.sh` endpoint. References hold the VM id and scope, never the API key, and reopen with the same key.
+
+## Setup defaults
+
+| Setting                     | Behavior                                                                                                                                                                                         |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `network`                   | `blocked` (default) sends an empty Freestyle firewall; `internet` allows every public destination.                                                                                                |
+| `image`                     | `freestyle/ubuntu` (4 vCPU, 8 GiB). Any Freestyle snapshot: a `sh-…` id, your slug, or a public `owner/slug`. No OCI images.                                                                     |
+| `resources`                 | Optional minimum `{ vcpus, memoryMiB }`; picks the smallest Ubuntu base from `freestyle/ubuntu-sm` (2, 4 GiB) to `freestyle/ubuntu-2xl` (32, 64 GiB). Set `image` or `resources`, not both.      |
+| `lifecycle.lifetimeSeconds` | 900; 60 s to 30 days. Freestyle deletes the VM that long after creation (`ttlSeconds`).                                                                                                           |
+| `lifecycle.idleSeconds`     | Optional. Pauses the VM after that long without network activity (`idleTimeoutSeconds`).                                                                                                          |
+| `preview`                   | `{ access: "public", ports: [] }`. Listed ports are published at create on `<slug>-<port>.style.dev`, others on first `preview(port)`; `protected` rejects at connect.                            |
+| `snapshots`                 | `preserve` must be memory and disk (Freestyle's only capture); `retentionSeconds` deletes each snapshot that long after capture.                                                                  |
+
+## Behavior
+
+- **Create** boots one VM with a `beachside-<hash>` slug derived from the submission, so a lost response is found by slug and never resent, and waits for `running`. Labels become VM metadata. Create-time `env` is written to `/etc/beachside.env` (mode `0600`, owned by the command user `ubuntu`), which every command, process and terminal reads before its own `env`; a lost or slow create still writes it in the same process, while another process that recovers it reports `OUTCOME_UNKNOWN`.
+- **Exec** supports argv and shell, `cwd`, `env`, finite stdin up to 1 MiB (Freestyle's `stdin` field) and deadlines up to 24 hours on current guest agents. A small `sh` wrapper keeps arguments quoted and returns stdout/stderr as base64, or as raw files for large output, so bytes survive Freestyle's lossy UTF-8 text channel. Output is bounded to 1 MiB across both streams, stdout first.
+- **Processes** run as detached guest jobs whose stdout, stderr and exit status go to private files the adapter polls (base64, byte exact), with FIFO stdin, process-group signals, status and reopen. **Terminals** are named Freestyle PTY sessions (WebSocket) with input, resize, `SIGKILL` and reopen.
+- **Files** read and overwrite up to 8 MiB in one sha256-verified upload, with a root owner check before it and a Python 3 owner repair after replacing a file another user owns; larger files stream through 1 MiB range reads and staged writes published by rename (or hard link for no-clobber). Copy, move, mkdir and remove, and stat, exists and listings on a running VM, use a small Python 3 helper in the VM. On a paused or stopped VM, reads, listings, stat and exists use Freestyle's read-only file API without waking it; writes need a running VM.
+- **Snapshots** capture memory and disk from a running or paused VM under a per-attempt slug; restore boots a new VM from the snapshot id and resumes the captured processes. Inspect, list, delete and expiry (`ttlSeconds`) are supported, and `images.list()` lists the account's snapshots as prepared images.
+- **Suspend/resume** maps to Freestyle pause (memory kept) and start (same processes).
+- **Renew** sets `ttlSeconds` to the VM's age plus the requested window.
+- **Preview** returns the `style.dev` URL for a port, publishing it on first use; the rule names the VM, so Freestyle deletes it with the VM.
+- **Destroy** deletes the VM and waits until Freestyle no longer returns it.
+- Unsupported: OCI images and builds, volumes, mounts and regions (Freestyle has none). Protected previews (Freestyle offers forward auth through your own service) and egress allowlists are not wired yet.
+
+Every mutation is sent once. The SDK replays only bodyless reads, follows Freestyle background requests for slow calls, and this adapter adds no retries. 4xx refusals become ordinary errors; lost responses, 5xx and `VM_NON_RESPONSIVE` become `OUTCOME_UNKNOWN` and are never replayed.
+
+See the [provider page](https://beachside.run/docs/providers/freestyle/) and the [research issue](https://github.com/pandemicsyn/beachside/issues/129).

package/dist/adapter.d.ts

@@ -0,0 +1,103 @@
+import { z } from "zod";
+import { type AdapterSession, type CreateInput, type ExecInput, type FileWriteInput, type Sandbox } from "@beachside/adapter";
+import { type PtyDriver } from "./terminal.js";
+import { type NativeFetch } from "./transport.js";
+/** Freestyle's platform default base snapshot: Ubuntu 24.04 with 4 vCPU and 8 GiB. */
+export declare const BASE_IMAGE = "freestyle/ubuntu";
+/**
+ * Exec deadlines run up to 24 hours on guest agents with native resumable exec; older agents
+ * refuse anything over five minutes with `AGENT_UNSUPPORTED`.
+ */
+export declare const MAX_EXEC_SECONDS = 86400;
+/** Per-stream output bound collected through the guest wrapper. */
+export declare const MAX_OUTPUT_BYTES = 1048576;
+/** Native exec stdin limit (1 MiB after decoding). */
+export declare const MAX_STDIN_BYTES = 1048576;
+/**
+ * Largest file sent or read in one request. The SDK switches to a chunked upload above this
+ * size, and that upload replays chunks on its own, so the adapter stays below it.
+ */
+export declare const MAX_FILE_BYTES: number;
+export type FreestyleAdapterOptions = {
+    /** Native fetch handed to the official SDK; tests inject a deterministic fixture. */
+    fetch?: NativeFetch;
+    /** Poll interval while waiting for boot, pause, resume or deletion. */
+    pollIntervalMs?: number;
+    /** Longest a mutation waits in-call before returning a pending result. */
+    settleSeconds?: number;
+    /** Delay between output reads while a process is quiet (default 250 ms). */
+    processPollMs?: number;
+    /** Terminal sessions; defaults to the SDK's `vm.pty` WebSockets. Tests inject a stand-in. */
+    pty?: PtyDriver;
+};
+/** Constructing a definition performs no provider IO. */
+export declare function createFreestyleAdapter(options?: FreestyleAdapterOptions): import("@beachside/adapter").AdapterDefinition<z.ZodObject<{
+    network: z.ZodDefault<z.ZodEnum<{
+        blocked: "blocked";
+        internet: "internet";
+    }>>;
+    image: z.ZodOptional<z.ZodString>;
+    resources: z.ZodOptional<z.ZodObject<{
+        vcpus: z.ZodOptional<z.ZodNumber>;
+        memoryMiB: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    lifecycle: z.ZodDefault<z.ZodObject<{
+        lifetimeSeconds: z.ZodDefault<z.ZodNumber>;
+        idleSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    preview: z.ZodDefault<z.ZodObject<{
+        access: z.ZodDefault<z.ZodEnum<{
+            public: "public";
+            protected: "protected";
+        }>>;
+        ports: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+    }, z.core.$strict>>;
+    snapshots: z.ZodOptional<z.ZodObject<{
+        preserve: z.ZodOptional<z.ZodEnum<{
+            filesystem: "filesystem";
+            "filesystem+memory": "filesystem+memory";
+        }>>;
+        retentionSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+    apiKey: z.ZodString;
+}, z.core.$strict>, AdapterSession<CreateInput, Sandbox, ExecInput, FileWriteInput, "argv" | "shell", {
+    slug: string;
+    id?: string | undefined;
+    env?: true | undefined;
+}>>;
+export declare const freestyleAdapter: import("@beachside/adapter").AdapterDefinition<z.ZodObject<{
+    network: z.ZodDefault<z.ZodEnum<{
+        blocked: "blocked";
+        internet: "internet";
+    }>>;
+    image: z.ZodOptional<z.ZodString>;
+    resources: z.ZodOptional<z.ZodObject<{
+        vcpus: z.ZodOptional<z.ZodNumber>;
+        memoryMiB: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    lifecycle: z.ZodDefault<z.ZodObject<{
+        lifetimeSeconds: z.ZodDefault<z.ZodNumber>;
+        idleSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    preview: z.ZodDefault<z.ZodObject<{
+        access: z.ZodDefault<z.ZodEnum<{
+            public: "public";
+            protected: "protected";
+        }>>;
+        ports: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+    }, z.core.$strict>>;
+    snapshots: z.ZodOptional<z.ZodObject<{
+        preserve: z.ZodOptional<z.ZodEnum<{
+            filesystem: "filesystem";
+            "filesystem+memory": "filesystem+memory";
+        }>>;
+        retentionSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+    apiKey: z.ZodString;
+}, z.core.$strict>, AdapterSession<CreateInput, Sandbox, ExecInput, FileWriteInput, "argv" | "shell", {
+    slug: string;
+    id?: string | undefined;
+    env?: true | undefined;
+}>>;

package/dist/exec.d.ts

@@ -0,0 +1,61 @@
+import { type Command } from "@beachside/adapter";
+/**
+ * Freestyle's `exec-await` runs one command line through the guest shell and returns
+ * stdout/stderr as UTF-8 text with invalid bytes replaced, and no documented size bound.
+ * To keep argv as arguments and output as bytes, the adapter sends a small POSIX sh
+ * wrapper: the user's command writes stdout/stderr to private files in the guest, and the
+ * wrapper prints one header line. Small results follow inline as base64; larger ones stay
+ * in the guest for a raw-byte download through the filesystem API. User output is never
+ * read as a control record.
+ */
+export declare const EXEC_RECORD = "BEACHSIDE-EXEC-1";
+/** Combined bound for results returned inline instead of downloaded. */
+export declare const INLINE_BYTES: number;
+/** Single-quote one word for POSIX sh; the only special character inside quotes is `'`. */
+export declare function quote(word: string): string;
+export type WrapperInput = {
+    command: Command;
+    cwd?: string;
+    env?: Record<string, string>;
+    /** True when finite stdin bytes travel in the native `stdin` field; otherwise stdin is empty. */
+    stdin?: boolean;
+    /** Per-stream byte bound applied in the guest. */
+    maxBytes: number;
+};
+/**
+ * Sandbox-wide environment written at create. Freestyle takes environment variables only per
+ * command, so every command, process and terminal sources this file before its own `env`.
+ */
+export declare const ENV_FILE = "/etc/beachside.env";
+/** The env file: a marker naming the create attempt, then one quoted export per variable. */
+export declare function envFile(env: Record<string, string>, attempt: string): Uint8Array;
+export declare function envMarker(attempt: string): string;
+/** Throws before any effect when a variable name or value cannot be written. */
+export declare function checkEnv(env: Record<string, string> | undefined): void;
+/** The user's command as one sh line: optional `cd`, quoted exports, then `exec` of the program. */
+export declare function commandLine(input: Pick<WrapperInput, "command" | "cwd" | "env">): string;
+export declare function wrapperScript(input: WrapperInput): string;
+export type WrapperResult = {
+    exitCode: number;
+    stdout: Uint8Array;
+    stderr: Uint8Array;
+    truncated: boolean;
+};
+/** Output left in the guest: download `${directory}/stdout` and `${directory}/stderr`, then remove it. */
+export type WrapperFiles = {
+    exitCode: number;
+    stdoutLength: number;
+    stderrLength: number;
+    directory: string;
+};
+/** Decode the wrapper record, or null when it is missing or malformed. */
+export declare function parseWrapper(stdout: string): WrapperResult | WrapperFiles | null;
+/**
+ * Assemble a downloaded result. A stream shorter than the guest reported keeps the confirmed
+ * exit and is marked truncated (`complete: false`); one longer than reported is not this
+ * command's output, so the result is null.
+ */
+export declare function filesResult(files: WrapperFiles, stdout: Uint8Array, stderr: Uint8Array, maxBytes: number): {
+    result: WrapperResult;
+    complete: boolean;
+} | null;

package/dist/factory.d.ts

@@ -0,0 +1,7 @@
+import { type BoundAdapter } from "@beachside/adapter";
+import type { z } from "zod";
+import { freestyleAdapter } from "./adapter.js";
+/** Credentials and setup in one object: `freestyle({ apiKey, ... })`. */
+export type FreestyleOptions = z.input<typeof freestyleAdapter.credentials> & z.input<typeof freestyleAdapter.config>;
+/** Experimental Freestyle VMs adapter. Same as `Beachside.connect({ adapter: freestyleAdapter, credentials, config })`. */
+export declare function freestyle(options: FreestyleOptions): BoundAdapter;

package/dist/filesystem.d.ts

@@ -0,0 +1,49 @@
+import { type DirectoryResult, type FileStat, type FileTransferContext, type ReadContext } from "@beachside/adapter";
+import { z } from "zod";
+import type { GuestRunner } from "./process.js";
+/**
+ * Freestyle's filesystem API reads byte ranges and replaces whole files, but has no append,
+ * no-clobber create, copy or move. Those run through this finite helper in the guest, the
+ * same one the boxd adapter uses; Python 3 is an image prerequisite, never installed. Paths are
+ * arguments, never program text. Streamed writes stage chunks (1 MiB, the native stdin
+ * bound) into a private file beside the target and publish it with an atomic rename, or a
+ * hard link when the target must not be replaced.
+ */
+export declare const FILESYSTEM_HELPER: string;
+/** Bytes appended per staging request, Freestyle's native stdin bound. */
+export declare const STAGE_CHUNK_BYTES = 1048576;
+/** Bytes read per streamed range request. */
+export declare const READ_CHUNK_BYTES = 1048576;
+/**
+ * One native range read. `total` is the file length the response declared (`Content-Range`),
+ * when it declared one; a range that starts at the end of the file yields no bytes.
+ */
+export type RangeReader = (path: string, offset: number, length: number, ctx: ReadContext) => Promise<{
+    bytes: Uint8Array;
+    total: number | undefined;
+}>;
+/**
+ * Decode a native range response. A `206` carries `bytes a-b/total`; a `416` for a range that
+ * starts exactly at the end of the file (including an empty file) is EOF;
+ * a `200` is the whole file, valid only for a read from offset 0.
+ */
+export declare function rangeResult(response: Response, offset: number, length: number): Promise<{
+    bytes: Uint8Array;
+    total: number | undefined;
+} | null>;
+export declare function filesystem(run: GuestRunner, readRange: RangeReader): {
+    helper: (op: string, path: string, destination: string, flag: boolean, ctx: ReadContext, stage?: string, stdin?: Uint8Array) => Promise<z.core.util.JSONType>;
+    write: (path: string, bytes: AsyncIterable<Uint8Array> | Iterable<Uint8Array>, overwrite: boolean, ctx: FileTransferContext) => Promise<{
+        bytesWritten: number;
+    }>;
+    transfer(op: "copy" | "move", source: string, destination: string, overwrite: boolean, ctx: FileTransferContext): Promise<{
+        acknowledged: true;
+    }>;
+    /** Native range reads, one chunk per pull, so the file is never held whole. */
+    read(path: string, ctx: ReadContext): ReadableStream<Uint8Array<ArrayBufferLike>>;
+};
+export declare function directoryValue(value: z.infer<ReturnType<typeof z.json>>): DirectoryResult;
+export declare function statValue(value: z.infer<ReturnType<typeof z.json>>): FileStat;
+export declare const Exists: z.ZodObject<{
+    exists: z.ZodBoolean;
+}, z.core.$strip>;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { BASE_IMAGE, createFreestyleAdapter, freestyleAdapter, type FreestyleAdapterOptions, } from "./adapter.js";
+export { freestyle, type FreestyleOptions } from "./factory.js";