@marimo-team/islands 0.25.3-dev12 → 0.25.3-dev123

package/src/core/document/__tests__/test-host.test.ts

@@ -0,0 +1,92 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import * as Protocol from "@marimo-team/client/protocol";
+import { afterEach, expect, it, vi } from "vitest";
+import { initialDocument, protocolFixture } from "./protocol-fixtures";
+import { createTestHost } from "./test-host";
+
+afterEach(() => vi.useRealTimers());
+
+it("matches the portable host examples for accepted and conflicting edits", () => {
+  const host = createTestHost(initialDocument());
+  const accepted = host.process({
+    notebookId: "n1",
+    idempotencyKey: "accepted",
+    changes: Protocol.EditRequest.parse(protocolFixture("edit.json")).changes,
+  });
+  const expected = Protocol.EditResponse.parse(
+    protocolFixture("edit-response.json"),
+  );
+  expect(accepted.result).toEqual({ ok: true, status: 200, data: expected });
+  expect(accepted.update).toEqual(host.document());
+
+  const rejected = host.process({
+    notebookId: "n1",
+    idempotencyKey: "rejected",
+    changes: Protocol.EditRequest.parse(
+      protocolFixture("edit-conflict-request.json"),
+    ).changes,
+  });
+  const problem = Protocol.Problem.parse(
+    protocolFixture("problems/edit-conflict.json"),
+  );
+  expect(rejected).toEqual({
+    result: {
+      ok: false,
+      status: 409,
+      problem: { ...problem, detail: expect.any(String) },
+    },
+  });
+  expect(host.document().revision).toEqual(expected.document);
+});
+
+it("rejects an entire batch when a later precondition is stale", () => {
+  const initial = initialDocument();
+  const host = createTestHost(initial);
+  const result = host.apply([
+    { kind: "put_cell", base_etag: null, cell: { id: "created", code: "new" } },
+    { kind: "delete_cell", id: "c3", base_etag: "stale" },
+  ]);
+  expect(result).toMatchObject({
+    result: { ok: false, status: 409, problem: { edit: { change: 1 } } },
+  });
+  expect(host.document()).toEqual(initial);
+  expect(result.update).toBeUndefined();
+});
+
+it("keeps successful and rejected receipts tied to their original payload and revision", () => {
+  vi.useFakeTimers({ now: 0 });
+  const host = createTestHost(initialDocument());
+  const request = {
+    notebookId: "n1",
+    idempotencyKey: "original",
+    changes: Protocol.EditRequest.parse(protocolFixture("edit.json")).changes,
+  };
+  const accepted = host.process(request);
+  const stale = {
+    notebookId: "n1",
+    idempotencyKey: "stale",
+    changes: Protocol.EditRequest.parse(
+      protocolFixture("edit-conflict-request.json"),
+    ).changes,
+  };
+  const rejected = host.process(stale);
+  host.apply([
+    { kind: "put_cell", base_etag: "*", cell: { id: "c3", code: "later" } },
+  ]);
+  const latest = host.document();
+  expect(host.process(request)).toEqual({ result: accepted.result });
+  expect(host.process(stale)).toEqual({ result: rejected.result });
+  expect(host.process({ ...request, changes: [] }).result).toMatchObject({
+    ok: false,
+    status: 409,
+  });
+  expect(host.document()).toEqual(latest);
+
+  vi.advanceTimersByTime(300_000);
+  expect(host.process(request).result).toMatchObject({
+    ok: false,
+    status: 409,
+  });
+  expect(host.document()).toEqual(latest);
+});

package/src/core/document/__tests__/test-host.ts

@@ -0,0 +1,247 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import { createHash } from "node:crypto";
+import type { Result } from "@marimo-team/client";
+import * as Protocol from "@marimo-team/client/protocol";
+import type { Document } from "../../host/resources/document";
+
+export interface EditRequest {
+  readonly notebookId: Protocol.NotebookId;
+  readonly changes: readonly Protocol.Change[];
+  readonly idempotencyKey: string;
+}
+
+interface Outcome {
+  readonly result: Result<Protocol.EditResponseOutput>;
+  /** Only a new commit produces a stream update; replaying a receipt does not. */
+  readonly update?: Document;
+}
+
+const hash = (text: string) =>
+  createHash("sha256").update(text).digest("hex").slice(0, 16);
+
+function record(
+  input: Protocol.CellInput,
+  notebookId: Protocol.NotebookId,
+  version: number,
+): Protocol.Cell {
+  const cell = Protocol.CellInput.parse(input);
+  const config = Protocol.CellConfigInput.parse(cell.config ?? {});
+  const code = cell.code.replace(/\r\n?/g, "\n");
+  const codeHash = hash(code);
+  return {
+    id: cell.id,
+    notebook_id: notebookId,
+    name: cell.name,
+    code,
+    config,
+    code_hash: codeHash,
+    etag: hash(
+      [
+        codeHash,
+        cell.name,
+        ...[
+          config.column,
+          config.disabled,
+          config.hide_code,
+          config.expand_output,
+        ].map((value) => JSON.stringify(value)),
+      ].join("\n"),
+    ),
+    version,
+  };
+}
+
+function rejected(
+  status: number,
+  kind: string,
+  detail: string,
+  edit?: Protocol.Problem["edit"],
+): Outcome {
+  return {
+    result: {
+      ok: false,
+      status,
+      problem: {
+        type: `tag:marimo.io,2026:host/${kind}`,
+        title: kind === "conflict" ? "Conflict" : "Invalid request",
+        detail,
+        status,
+        ...(edit === undefined ? {} : { edit }),
+      },
+    },
+  };
+}
+
+/** An independent implementation of the document edit protocol, without client draft logic. */
+export function createTestHost(initial: Document) {
+  let current = initial;
+  const receipts = new Map<
+    string,
+    {
+      fingerprint: string;
+      result: Result<Protocol.EditResponseOutput>;
+      expiresAt: number;
+    }
+  >();
+
+  function apply(changes: readonly Protocol.Change[]): Outcome {
+    const cells = new Map(current.cells);
+    let order = [...current.revision.order];
+    const touched = new Set<Protocol.CellId>();
+    const version = current.revision.version + 1;
+    const matches = (id: Protocol.CellId, etag: string) =>
+      etag === "*" || current.cells.get(id)?.etag === etag;
+    const conflict = (change: number, id?: Protocol.CellId) =>
+      rejected(409, "conflict", `Edit conflict at change ${change}`, {
+        change,
+        cell: id === undefined ? null : (current.cells.get(id) ?? null),
+        document: current.revision,
+      });
+
+    for (const [index, change] of changes.entries()) {
+      switch (change.kind) {
+        case "put_cell": {
+          const { id } = change.cell;
+          if (change.base_etag === null) {
+            if (current.cells.has(id) || cells.has(id)) {
+              return conflict(index, id);
+            }
+            if (change.after !== undefined && change.before !== undefined) {
+              return rejected(
+                400,
+                "invalid-request",
+                "A cell cannot name both before and after",
+              );
+            }
+            const anchor = change.after ?? change.before;
+            if (anchor !== undefined && !order.includes(anchor)) {
+              return rejected(
+                400,
+                "invalid-request",
+                "The placement anchor does not exist",
+              );
+            }
+            const position =
+              anchor === undefined
+                ? order.length
+                : order.indexOf(anchor) + (change.after === undefined ? 0 : 1);
+            order.splice(position, 0, id);
+          } else if (!cells.has(id) || !matches(id, change.base_etag)) {
+            return conflict(index, id);
+          }
+          cells.set(
+            id,
+            record(change.cell, current.revision.notebook_id, version),
+          );
+          touched.add(id);
+          break;
+        }
+        case "delete_cell":
+          if (!cells.has(change.id) || !matches(change.id, change.base_etag)) {
+            return conflict(index, change.id);
+          }
+          cells.delete(change.id);
+          order = order.filter((id) => id !== change.id);
+          touched.add(change.id);
+          break;
+        case "set_order":
+          if (
+            change.base_etag !== "*" &&
+            change.base_etag !== current.revision.order_etag
+          ) {
+            return conflict(index);
+          }
+          if (
+            change.order.length !== cells.size ||
+            new Set(change.order).size !== cells.size ||
+            change.order.some((id) => !cells.has(id))
+          ) {
+            return rejected(
+              400,
+              "invalid-request",
+              "Order must name every cell exactly once",
+            );
+          }
+          order = [...change.order];
+          break;
+      }
+    }
+
+    for (const [id, cell] of cells) {
+      const previous = current.cells.get(id);
+      if (previous?.etag === cell.etag) {
+        cells.set(id, previous);
+      }
+    }
+    const orderEtag = hash(JSON.stringify(order));
+    const etag = hash(
+      [
+        orderEtag,
+        current.revision.app_config_etag,
+        ...order.map((id) => cells.get(id)!.etag),
+      ].join("\n"),
+    );
+    const changed = etag !== current.revision.etag;
+    if (changed) {
+      current = {
+        revision: {
+          ...current.revision,
+          order,
+          order_etag: orderEtag,
+          etag,
+          version,
+        },
+        cells,
+      };
+    }
+    const versions: Protocol.EditResponseOutput["cells"] = {};
+    for (const id of touched) {
+      const cell = current.cells.get(id);
+      versions[id] =
+        cell === undefined
+          ? null
+          : {
+              etag: cell.etag,
+              code_hash: cell.code_hash,
+              version: cell.version,
+            };
+    }
+    return {
+      result: {
+        ok: true,
+        status: 200,
+        data: { document: current.revision, cells: versions },
+      },
+      ...(changed ? { update: current } : {}),
+    };
+  }
+
+  return {
+    document: () => current,
+    apply,
+    process(request: EditRequest): Outcome {
+      const fingerprint = JSON.stringify([request.notebookId, request.changes]);
+      const receipt = receipts.get(request.idempotencyKey);
+      if (receipt !== undefined && Date.now() < receipt.expiresAt) {
+        return receipt.fingerprint === fingerprint
+          ? { result: receipt.result }
+          : rejected(
+              409,
+              "conflict",
+              "Idempotency key was used for another request",
+            );
+      }
+      const outcome =
+        request.notebookId === current.revision.notebook_id
+          ? apply(request.changes)
+          : rejected(404, "not-found", "Notebook does not exist");
+      receipts.set(request.idempotencyKey, {
+        fingerprint,
+        result: outcome.result,
+        expiresAt: Date.now() + 300_000,
+      });
+      return outcome;
+    },
+  };
+}

package/src/core/document/__tests__/test-notebook.ts

@@ -0,0 +1,139 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import type { Result } from "@marimo-team/client";
+import type * as Protocol from "@marimo-team/client/protocol";
+import { atom, type createStore } from "jotai/vanilla";
+import { vi } from "vitest";
+import { Deferred } from "@/utils/Deferred";
+import { invariant } from "@/utils/invariant";
+import type { Document } from "../../host/resources/document";
+import type { DocumentHost } from "../model";
+import { createTestHost, type EditRequest } from "./test-host";
+
+export interface PendingRequest extends EditRequest {
+  readonly signal: AbortSignal;
+  process(): void;
+  deliverResponse(): void;
+  loseResponse(): void;
+}
+
+export function createTestNotebook(
+  store: ReturnType<typeof createStore>,
+  initial: Document,
+) {
+  const host = createTestHost(initial);
+  const source = atom<Document | null>(initial);
+  const requests: PendingRequest[] = [];
+  const waiting: Deferred<PendingRequest>[] = [];
+  const documents: Document[] = [];
+  function apply(changes: readonly Protocol.Change[]) {
+    const { result, update } = host.apply(changes);
+    invariant(result.ok, "Another writer's edit was rejected");
+    if (update !== undefined) {
+      documents.push(update);
+    }
+  }
+  const edit = vi.fn<DocumentHost["edit"]>((notebookId, changes, options) => {
+    options.signal.throwIfAborted();
+    const reply = new Deferred<Result<Protocol.EditResponseOutput>>();
+    let outcome: Result<Protocol.EditResponseOutput> | undefined;
+    const abort = () => reply.reject(options.signal.reason);
+    const finish = () => options.signal.removeEventListener("abort", abort);
+    options.signal.addEventListener("abort", abort, { once: true });
+    void reply.promise.then(finish, finish);
+    const request: PendingRequest = {
+      notebookId,
+      changes: structuredClone(changes),
+      idempotencyKey: options.idempotencyKey,
+      signal: options.signal,
+      process() {
+        invariant(outcome === undefined, "Request was already processed");
+        // Cancellation of the client's wait does not roll back a server commit.
+        const processed = host.process(request);
+        outcome = processed.result;
+        if (processed.update !== undefined) {
+          documents.push(processed.update);
+        }
+      },
+      deliverResponse() {
+        invariant(
+          outcome !== undefined,
+          "Process the request before delivering its response",
+        );
+        reply.resolve(outcome);
+      },
+      loseResponse() {
+        reply.reject(new Error("Connection lost"));
+      },
+    };
+    const next = waiting.shift();
+    if (next === undefined) {
+      requests.push(request);
+    } else {
+      next.resolve(request);
+    }
+    return reply.promise;
+  });
+  const notebook = { documentAtom: source, edit } satisfies DocumentHost;
+  return {
+    notebook,
+    control: {
+      document: host.document,
+      nextRequest(): Promise<PendingRequest> {
+        const next = requests.shift();
+        if (next !== undefined) {
+          return Promise.resolve(next);
+        }
+        const deferred = new Deferred<PendingRequest>();
+        waiting.push(deferred);
+        return deferred.promise;
+      },
+      changeCell(
+        id: Protocol.CellId,
+        patch: Partial<Omit<Protocol.CellInput, "id">>,
+      ) {
+        const cell = host.document().cells.get(id);
+        invariant(
+          cell !== undefined && cell.code !== null,
+          `No host source for cell ${id}`,
+        );
+        apply([
+          {
+            kind: "put_cell",
+            base_etag: cell.etag,
+            cell: {
+              ...cell,
+              code: cell.code,
+              ...patch,
+              config: { ...cell.config, ...patch.config },
+            },
+          },
+        ]);
+      },
+      createCell(cell: Protocol.CellInput) {
+        apply([{ kind: "put_cell", base_etag: null, cell }]);
+      },
+      deleteCell(id: Protocol.CellId) {
+        const cell = host.document().cells.get(id);
+        invariant(cell !== undefined, `No host cell ${id}`);
+        apply([{ kind: "delete_cell", id, base_etag: cell.etag }]);
+      },
+      deliverDocument() {
+        const next = documents.shift();
+        invariant(
+          next !== undefined,
+          "No document update is waiting for delivery",
+        );
+        store.set(source, next);
+      },
+      reset() {
+        documents.length = 0;
+        store.set(source, null);
+      },
+      deliverSnapshot() {
+        documents.length = 0;
+        store.set(source, host.document());
+      },
+    },
+  };
+}

package/src/core/document/__tests__/user.ts

@@ -0,0 +1,61 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import type * as Protocol from "@marimo-team/client/protocol";
+import type { createStore } from "jotai/vanilla";
+import type { DocumentModel } from "../model";
+
+/** Translate user actions and observations without keeping any expected state. */
+export function createUser(
+  store: ReturnType<typeof createStore>,
+  model: DocumentModel,
+) {
+  function observe(promise: Promise<Protocol.Document>) {
+    // A failed assertion may end a scenario before it awaits sync; teardown
+    // should not obscure that failure with an unhandled abort rejection.
+    void promise.catch(() => undefined);
+    return promise;
+  }
+  return {
+    changeCode(id: Protocol.CellId, code: string) {
+      store.set(model.editAtom, (tx) => tx.setCode(id, code));
+    },
+    changeCells(
+      changes: Record<Protocol.CellId, Partial<Omit<Protocol.CellInput, "id">>>,
+    ) {
+      store.set(model.editAtom, (tx) => {
+        for (const [id, patch] of Object.entries(changes)) {
+          if (patch.code !== undefined) {
+            tx.setCode(id, patch.code);
+          }
+          if (patch.name !== undefined) {
+            tx.setName(id, patch.name);
+          }
+          if (patch.config !== undefined) {
+            tx.updateConfig(id, patch.config);
+          }
+        }
+      });
+    },
+    createCell(cell: Protocol.CellInput) {
+      store.set(model.editAtom, (tx) => tx.createCell(cell));
+    },
+    deleteCell(id: Protocol.CellId) {
+      store.set(model.editAtom, (tx) => tx.deleteCell(id));
+    },
+    cell(id: Protocol.CellId) {
+      const cell = store.get(model.documentAtom)?.cells.get(id);
+      return cell === undefined
+        ? undefined
+        : {
+            id: cell.id,
+            code: cell.code,
+            name: cell.name,
+            config: cell.config,
+          };
+    },
+    order: () => store.get(model.documentAtom)?.order ?? null,
+    status: () => store.get(model.syncStatusAtom),
+    sync: () => observe(model.flush()),
+    retry: () => observe(model.retry()),
+  };
+}