@marimo-team/islands 0.25.3-dev13 → 0.25.3-dev135

package/src/core/host/__tests__/protocol.test.ts

@@ -1,214 +0,0 @@
-/* Copyright 2026 Marimo. All rights reserved. */
-
-import NodeFs from "node:fs";
-import NodeUrl from "node:url";
-import { describe, expect, expectTypeOf, it } from "vitest";
-import * as Protocol from "../protocol";
-
-const fixtures = new NodeUrl.URL(
-  "../../../../../protocols/host/fixtures/",
-  import.meta.url,
-);
-
-function readFixture(name: string): unknown {
-  return JSON.parse(
-    NodeFs.readFileSync(new NodeUrl.URL(name, fixtures), "utf8"),
-  );
-}
-
-const records = {
-  "record.json": Protocol.HostRecord,
-  "cell.json": Protocol.Cell,
-  "analysis.json": Protocol.Analysis,
-  "diagnostic.json": Protocol.Error,
-  "edit.json": Protocol.EditRequest,
-  "edit-conflict-request.json": Protocol.EditRequest,
-  "edit-response.json": Protocol.EditResponse,
-  "execution-restored.json": Protocol.Execution,
-  "run-cells-request.json": Protocol.RunRequest,
-};
-
-describe("host protocol fixtures", () => {
-  it.each(Object.entries(records))("parses %s unchanged", (name, schema) => {
-    const input = readFixture(name);
-    const original = structuredClone(input);
-    expect(schema.parse(input)).toEqual(original);
-    expect(input).toEqual(original);
-  });
-
-  it.each(NodeFs.readdirSync(new NodeUrl.URL("problems/", fixtures)))(
-    "parses problem %s",
-    (name) => {
-      const input = readFixture(`problems/${name}`);
-      expect(Protocol.Problem.parse(input)).toEqual(input);
-    },
-  );
-
-  it.each(NodeFs.readdirSync(fixtures).filter((name) => name.endsWith(".sse")))(
-    "parses events in %s unchanged",
-    (name) => {
-      const stream = NodeFs.readFileSync(
-        new NodeUrl.URL(name, fixtures),
-        "utf8",
-      );
-      let count = 0;
-      for (const frame of stream.split(/\r?\n\r?\n/)) {
-        const event = /^event: (.+)$/m.exec(frame)?.[1];
-        if (!event && !/^data:/m.test(frame)) {
-          continue;
-        }
-        const data = frame
-          .split(/\r?\n/)
-          .filter((line) => line.startsWith("data:"))
-          .map((line) => line.slice(5).trimStart())
-          .join("\n");
-        const id = /^id: (.+)$/m.exec(frame)?.[1];
-        const payload: unknown = JSON.parse(data);
-        const input = { event, data: payload, ...(id ? { id } : {}) };
-        const original = structuredClone(input);
-        expect(Protocol.Event.parse(input)).toEqual(original);
-        expect(input).toEqual(original);
-        count += 1;
-      }
-      expect(count).toBeGreaterThan(0);
-    },
-  );
-});
-
-describe("host protocol bindings", () => {
-  it("preserves native marimo payloads without interpreting them", () => {
-    expectTypeOf<Protocol.MarimoEvent["data"]["marimo"]>().toBeUnknown();
-    const input = {
-      event: "marimo",
-      id: "42",
-      data: {
-        marimo: {
-          future_payload: { value: Number.NaN },
-        },
-      },
-    };
-    expect(Protocol.Event.parse(input)).toEqual(input);
-  });
-
-  it("accepts additive fields and preserves arbitrary notebook settings", () => {
-    const cell = Protocol.Cell.parse(readFixture("cell.json"));
-    const input = {
-      ...cell,
-      future: { enabled: true },
-      config: { ...cell.config, future: 42 },
-    };
-    const original = structuredClone(input);
-    expect(Protocol.Cell.parse(input)).toEqual(cell);
-    expect(input).toEqual(original);
-
-    const { document } = Protocol.EditResponse.parse(
-      readFixture("edit-response.json"),
-    );
-    const configured = {
-      ...document,
-      app_config: { extension: { values: [1, null, false] } },
-    };
-    expect(Protocol.Document.parse(configured)).toEqual(configured);
-  });
-
-  it("applies the defaults declared for cell inputs", () => {
-    expect(
-      Protocol.CellInput.parse({ id: "c3", code: "x = 1", config: {} }),
-    ).toEqual({
-      id: "c3",
-      code: "x = 1",
-      name: "_",
-      config: {
-        column: null,
-        disabled: false,
-        hide_code: false,
-        expand_output: false,
-      },
-    });
-  });
-
-  it.each(["run_id", "runtime_id", "caused_by"] as const)(
-    "requires the nullable execution field %s",
-    (field) => {
-      const execution = Protocol.Execution.parse(
-        readFixture("execution-restored.json"),
-      );
-      const missing = Object.fromEntries(
-        Object.entries(execution).filter(([key]) => key !== field),
-      );
-      expect(Protocol.Execution.safeParse(missing).success).toBe(false);
-      expect(
-        Protocol.Execution.safeParse({ ...execution, [field]: null }).success,
-      ).toBe(true);
-    },
-  );
-
-  it("preserves snapshot metadata omissions and validates live timestamps", () => {
-    const cell = Protocol.Cell.parse(readFixture("cell.json"));
-    expect(Protocol.CellMessage.parse({ cell })).toEqual({ cell });
-    const message = { cell, time: "2026-01-01T12:00:00+05:30" };
-    expect(Protocol.CellMessage.parse(message)).toEqual(message);
-    for (const time of [
-      null,
-      "yesterday",
-      "2026-02-30T12:00:00Z",
-      "2026-01-01T12:00:00",
-    ]) {
-      expect(Protocol.CellMessage.safeParse({ cell, time }).success).toBe(
-        false,
-      );
-    }
-  });
-
-  it("rejects invalid cell fields without coercing their values", () => {
-    const cell = Protocol.Cell.parse(readFixture("cell.json"));
-    for (const patch of [
-      { id: "" },
-      { code: 42 },
-      { etag: 42 },
-      { version: "2" },
-      { version: 0 },
-      { version: 1.5 },
-      { config: { ...cell.config, disabled: "false" } },
-    ]) {
-      expect(Protocol.Cell.safeParse({ ...cell, ...patch }).success).toBe(
-        false,
-      );
-    }
-    const result = Protocol.Cell.safeParse({ ...cell, code: 42 });
-    expect(result.success).toBe(false);
-    if (result.success) {
-      throw new Error("Expected an invalid cell");
-    }
-    expect(result.error.issues).toEqual([
-      expect.objectContaining({ path: ["code"], code: "invalid_type" }),
-    ]);
-  });
-
-  it("requires the fields of the selected change kind", () => {
-    const change = { kind: "delete_cell", id: "c3", base_etag: "*" };
-    expect(Protocol.Change.parse(change)).toEqual(change);
-    expect(
-      Protocol.Change.safeParse({ kind: "delete_cell", id: "c3" }).success,
-    ).toBe(false);
-    expect(
-      Protocol.Change.safeParse({ ...change, kind: "unknown" }).success,
-    ).toBe(false);
-  });
-
-  it("requires custom payloads while allowing any JSON value", () => {
-    for (const data of [
-      null,
-      false,
-      42,
-      "text",
-      { nested: [1, null, false] },
-    ]) {
-      const custom = { type: "example.event", data };
-      expect(Protocol.Custom.parse(custom)).toEqual(custom);
-    }
-    expect(Protocol.Custom.safeParse({ type: "example.event" }).success).toBe(
-      false,
-    );
-  });
-});

package/src/core/host/events.ts

@@ -1,60 +0,0 @@
-/* Copyright 2026 Marimo. All rights reserved. */
-
-import { z } from "zod";
-import * as Protocol from "./protocol";
-
-/**
- * Notebook stream events, including native marimo notifications.
- *
- * Known events follow the generated protocol. Unknown events retain their name
- * and cursor so clients can skip them without losing their place in the stream.
- */
-
-/** Event kinds requested by the client; removals and controls are implicit. */
-export const NOTEBOOK_EVENT_TYPES = [
-  "notebook",
-  "document",
-  "cell",
-  "marimo",
-] as const satisfies readonly (Protocol.ObjectType | "marimo")[];
-
-const envelope = z.object({
-  event: z.string().min(1),
-  data: z.unknown(),
-  id: z.string().min(1).optional(),
-});
-
-const knownNames = new Set<string>(
-  Protocol.Event.options.flatMap((schema) => schema.shape.event.options),
-);
-
-/** A decoded event, or the name and cursor of an unrecognized event. */
-export type NotebookEvent =
-  | Protocol.EventOutput
-  | {
-      readonly event: "unknown";
-      readonly name: string;
-      readonly id?: string;
-    };
-
-const sessionEnvelope = z.object({ data: Protocol.MarimoNotification });
-
-/**
- * Decode a host event or a legacy `{ data: notification }` session message.
- *
- * Throws if the envelope or a known event is malformed. Native notification
- * payloads are passed through for the session handler to interpret.
- */
-export function parseNotebookEvent(value: unknown): NotebookEvent {
-  if (typeof value === "object" && value !== null && !("event" in value)) {
-    return {
-      event: "marimo",
-      data: { marimo: sessionEnvelope.parse(value).data },
-    };
-  }
-  const parsed = envelope.parse(value);
-  if (knownNames.has(parsed.event)) {
-    return Protocol.Event.parse(parsed);
-  }
-  return { event: "unknown", name: parsed.event, id: parsed.id };
-}

package/src/core/host/notebook-client.ts

@@ -1,226 +0,0 @@
-/* Copyright 2026 Marimo. All rights reserved. */
-
-import { Logger } from "@/utils/Logger";
-import { type Atom, atom, type createStore } from "jotai/vanilla";
-import {
-  type ConnectionStatus,
-  ConnectionState,
-  ConnectionClosedReason,
-  type CloseDecision,
-  type NotebookTransport,
-  TransportReadyState,
-} from "./connection";
-import { parseNotebookEvent } from "./events";
-
-/** A connection to a notebook on a marimo host. */
-export interface NotebookClient {
-  /** Transport state, independent of kernel readiness. */
-  readonly connectionAtom: Atom<ConnectionStatus>;
-  /** Attempt to restore a closed connection after checking host health. */
-  reconnect(): Promise<void>;
-}
-
-/** The transport and application callbacks needed to connect a notebook. */
-export interface NotebookConnection {
-  /** Create a transport that reads the URL again on each connection attempt. */
-  createTransport: (url: () => string) => NotebookTransport;
-  /** The current stream URL, including authentication and subscription options. */
-  url: () => string;
-  /** Host events require an intact stream; legacy notifications are independent. */
-  messageFormat: "host" | "session";
-  /** Abort to close the transport and clear the client's state. */
-  signal: AbortSignal;
-  /** Wait until the host can accept the initial connection. */
-  waitUntilReady: () => Promise<void>;
-  /** Check whether the host is reachable before an explicit reconnect. */
-  checkHealth: () => Promise<boolean>;
-  /** Decode wire text without interpreting its event type. */
-  decodeJson: (message: string) => unknown;
-  /** Handle a native marimo notification. Its payload has not been validated. */
-  onNotification: (notification: unknown) => void;
-  /** Report a malformed message without coupling the client to editor UI. */
-  onMessageError: (error: unknown) => void;
-  /** Choose the connection status and retry policy after the transport closes. */
-  classifyClose: (event: CloseEvent) => CloseDecision;
-}
-
-/** Create a client without opening a connection. */
-export function createNotebookClient(store: ReturnType<typeof createStore>) {
-  const connectionAtom = atom<ConnectionStatus>({
-    state: ConnectionState.NOT_STARTED,
-  });
-  let reconnect: (() => Promise<void>) | undefined;
-  const client: NotebookClient = {
-    connectionAtom,
-    reconnect: async () => reconnect?.(),
-  };
-
-  function connect({
-    createTransport,
-    url,
-    messageFormat,
-    signal,
-    waitUntilReady,
-    checkHealth,
-    onNotification,
-    onMessageError,
-    decodeJson,
-    classifyClose,
-  }: NotebookConnection) {
-    if (signal.aborted) {
-      return;
-    }
-    let shouldRetry = true;
-    let terminal = false;
-    let checkingHealth = false;
-    const transport = createTransport(url);
-    const setStatus = (status: ConnectionStatus) =>
-      store.set(connectionAtom, status);
-    const disconnected = {
-      state: ConnectionState.CLOSED,
-      code: ConnectionClosedReason.KERNEL_DISCONNECTED,
-      reason: "kernel not found",
-    } satisfies ConnectionStatus;
-
-    function retry(code?: number, reason?: string) {
-      if (!signal.aborted && !terminal && shouldRetry) {
-        shouldRetry = false;
-        transport.reconnect(code, reason);
-      }
-    }
-
-    function onOpen() {
-      if (signal.aborted || terminal) {
-        return;
-      }
-      shouldRetry = true;
-      setStatus({ state: ConnectionState.OPEN });
-    }
-
-    function onClose(event: CloseEvent) {
-      if (signal.aborted || terminal) {
-        return;
-      }
-      Logger.warn("Notebook connection closed", event.code, event.reason);
-      const decision = classifyClose(event);
-      setStatus(decision.status);
-      if (decision.kind === "terminal") {
-        terminal = true;
-        transport.close();
-      } else if (decision.kind === "retry") {
-        retry(event.code, event.reason);
-      } else {
-        terminal = true;
-      }
-    }
-
-    function onError(event: Event) {
-      if (signal.aborted || terminal) {
-        return;
-      }
-      Logger.warn("Notebook connection error", event);
-      setStatus(disconnected);
-      retry();
-    }
-
-    function onMessage(message: MessageEvent<string>) {
-      if (signal.aborted || terminal) {
-        return;
-      }
-      let event;
-      try {
-        event = parseNotebookEvent(decodeJson(message.data));
-      } catch (error) {
-        Logger.error("Failed to decode notebook message", error);
-        if (messageFormat === "session") {
-          onMessageError(error);
-          return;
-        }
-        terminal = true;
-        setStatus({
-          ...disconnected,
-          reason: "Failed to decode notebook message",
-        });
-        transport.close();
-        return;
-      }
-      if (event.event === "marimo") {
-        onNotification(event.data.marimo);
-      }
-    }
-
-    reconnect = async () => {
-      if (
-        signal.aborted ||
-        checkingHealth ||
-        transport.readyState === TransportReadyState.OPEN ||
-        transport.readyState === TransportReadyState.CONNECTING
-      ) {
-        return;
-      }
-      checkingHealth = true;
-      setStatus({ state: ConnectionState.CONNECTING });
-      try {
-        const healthy = await checkHealth();
-        if (signal.aborted) {
-          return;
-        }
-        if (!healthy) {
-          shouldRetry = false;
-          setStatus(disconnected);
-          return;
-        }
-        terminal = false;
-        shouldRetry = true;
-        transport.reconnect();
-      } catch (error) {
-        if (!signal.aborted) {
-          Logger.error("Notebook health check failed", error);
-          shouldRetry = false;
-          setStatus(disconnected);
-        }
-      } finally {
-        checkingHealth = false;
-      }
-    };
-
-    signal.addEventListener(
-      "abort",
-      () => {
-        transport.removeEventListener("open", onOpen);
-        transport.removeEventListener("close", onClose);
-        transport.removeEventListener("error", onError);
-        transport.removeEventListener("message", onMessage);
-        transport.close();
-        reconnect = undefined;
-        setStatus({ state: ConnectionState.NOT_STARTED });
-      },
-      { once: true },
-    );
-
-    transport.addEventListener("open", onOpen);
-    transport.addEventListener("close", onClose);
-    transport.addEventListener("error", onError);
-    transport.addEventListener("message", onMessage);
-
-    if (transport.readyState === TransportReadyState.CLOSED) {
-      setStatus({ state: ConnectionState.CONNECTING });
-      void waitUntilReady()
-        .then(() => {
-          if (!signal.aborted) {
-            transport.reconnect();
-          }
-        })
-        .catch((error) => {
-          if (!signal.aborted) {
-            Logger.error("Healthy connection never made", error);
-            terminal = true;
-            setStatus(disconnected);
-            transport.close();
-          }
-        });
-    }
-  }
-
-  return { client, connect };
-}