@marimo-team/islands 0.25.3-dev192 → 0.25.3-dev196

package/src/core/transports/static.ts

@@ -2,7 +2,7 @@
 
 /** A backend that serves a document snapshot without a host. */
 
-import type { NotebookClient, NotebookTransport } from "@marimo-team/client";
+import type { NotebookClient } from "@marimo-team/client";
 import type * as Protocol from "@marimo-team/client/protocol";
 import type { NotebookBackend } from "../notebook/replica";
 
@@ -13,14 +13,9 @@ export interface StaticNotebookSnapshot {
   readonly cells: readonly Protocol.Cell[];
 }
 
-/**
- * Serve a document without a server, runtime, or mutation operations.
- * Callers and readers must treat the snapshot records as immutable.
- */
-export function createStaticNotebookBackend(
-  snapshot: StaticNotebookSnapshot,
-): NotebookBackend {
-  const frames: Protocol.Event[] = [
+/** The events that describe a snapshot, in the order a host sends them. */
+function snapshotFrames(snapshot: StaticNotebookSnapshot): Protocol.Event[] {
+  return [
     {
       event: "notebook",
       data: { notebook: { ...snapshot.notebook, operations: [] } },
@@ -30,6 +25,100 @@ export function createStaticNotebookBackend(
       data: { cell },
     })),
     { event: "document", data: { document: snapshot.document } },
+  ];
+}
+
+/** A snapshot of a notebook with no cells. */
+export function emptySnapshot(notebookId: string): StaticNotebookSnapshot {
+  return {
+    notebook: {
+      id: notebookId,
+      project_id: notebookId,
+      path: null,
+      name: "",
+      updated_at: null,
+    },
+    document: {
+      notebook_id: notebookId,
+      order: [],
+      app_config: {},
+      etag: `${notebookId}:document`,
+      saved_etag: `${notebookId}:document`,
+      order_etag: `${notebookId}:order`,
+      app_config_etag: `${notebookId}:app_config`,
+      version: 1,
+    },
+    cells: [],
+  };
+}
+
+/**
+ * Show a snapshot until `live` answers.
+ *
+ * The page carries the notebook it was served with, so cells appear before
+ * the host connects. The snapshot ends in a `ready` of its own, like a
+ * static notebook's, so the replica publishes it. At the host's first sign
+ * of life a `reset` discards it, and the host's snapshot takes over. A
+ * connection that resumes from a host cursor skips the snapshot; one that
+ * resumes from the snapshot's cursor starts the host connection fresh,
+ * since the host never issued it.
+ */
+export function startWithSnapshot(
+  snapshot: StaticNotebookSnapshot,
+  live: NotebookBackend,
+): NotebookBackend {
+  const cursor = `${snapshot.notebook.id}:snapshot`;
+  return {
+    ...live,
+    transport: (attempt, handlers) => {
+      if (attempt.cursor !== null && attempt.cursor !== cursor) {
+        return live.transport(attempt, handlers);
+      }
+      if (attempt.cursor === null) {
+        for (const frame of snapshotFrames(snapshot)) {
+          if (attempt.signal.aborted) {
+            break;
+          }
+          handlers.message(frame);
+        }
+        if (attempt.signal.aborted) {
+          return Promise.resolve();
+        }
+        handlers.message({ event: "ready", id: cursor, data: {} });
+      }
+      let shown = true;
+      const discard = () => {
+        if (shown) {
+          shown = false;
+          handlers.message({ event: "reset", data: {} });
+        }
+      };
+      return live.transport(
+        { ...attempt, cursor: null },
+        {
+          open: () => {
+            discard();
+            handlers.open();
+          },
+          message: (frame) => {
+            discard();
+            handlers.message(frame);
+          },
+        },
+      );
+    },
+  };
+}
+
+/**
+ * Serve a document without a server, runtime, or mutation operations.
+ * Callers and readers must treat the snapshot records as immutable.
+ */
+export function createStaticNotebookBackend(
+  snapshot: StaticNotebookSnapshot,
+): NotebookBackend {
+  const frames: Protocol.Event[] = [
+    ...snapshotFrames(snapshot),
     { event: "ready", id: "static", data: {} },
   ];
 
@@ -75,10 +164,3 @@ export function createStaticNotebookBackend(
     },
   };
 }
-
-/** A connection that opens and delivers nothing, for static notebooks. */
-export const idle: NotebookTransport = ({ signal }, { open }) =>
-  new Promise((settle) => {
-    open();
-    signal.addEventListener("abort", () => settle(), { once: true });
-  });

package/src/core/wasm/__tests__/bridge.test.ts

@@ -235,6 +235,7 @@ describe("PyodideBridge.sendSave", () => {
     store.set(activeNotebookReplicaAtom, replica);
     const backend = createEditorBackend({
       static: false,
+      snapshot: null,
       transportType: "sse",
       url: () => "http://localhost/",
       headers: () => ({}),

package/src/mount.tsx

@@ -5,8 +5,8 @@ import { Provider } from "jotai";
 import { createRoot } from "react-dom/client";
 import { z } from "zod";
 import {
-  appConfigAtom,
   configOverridesAtom,
+  pageAppConfigAtom,
   userConfigAtom,
 } from "@/core/config/config";
 import { KnownQueryParams } from "@/core/constants";
@@ -21,7 +21,7 @@ import {
 import { Logger } from "@/utils/Logger";
 import { ErrorBoundary } from "./components/editor/boundary/ErrorBoundary";
 import { notebookAtom } from "./core/cells/cells";
-import { notebookStateFromSession } from "./core/cells/session";
+import { readExport } from "./core/cells/session";
 import {
   parseAppConfig,
   parseConfigOverrides,
@@ -62,6 +62,7 @@ import {
 import { maybeRegisterVSCodeBindings } from "./core/vscode/vscode-bindings";
 import type { FileStore } from "./core/wasm/store";
 import { notebookFileStore } from "./core/wasm/store";
+import { embeddedSnapshotAtom } from "./core/session/embedded";
 import { ConnectionState } from "./core/session/types";
 import {
   handleWidgetMessage,
@@ -346,7 +347,8 @@ function initStore(options: unknown) {
     parseConfigOverrides(parsedOptions.data.configOverrides),
   );
   store.set(userConfigAtom, parseUserConfig(parsedOptions.data.config));
-  store.set(appConfigAtom, parseAppConfig(parsedOptions.data.appConfig));
+  store.set(pageAppConfigAtom, parsedOptions.data.appConfig);
+  const appConfig = parseAppConfig(parsedOptions.data.appConfig);
   store.set(pairConfigAtom, parsedOptions.data.pairConfig);
 
   // Runtime config
@@ -369,14 +371,21 @@ function initStore(options: unknown) {
     });
   }
 
-  // Session/notebook
-  const notebook = notebookStateFromSession(
-    parsedOptions.data.session,
-    parsedOptions.data.notebook,
-  );
+  // The notebook the page was served with shows until the host answers.
+  const { snapshot, cellRuntime } = readExport({
+    session: parsedOptions.data.session,
+    notebook: parsedOptions.data.notebook,
+    filename: parsedOptions.data.filename,
+    appConfig,
+  });
+  store.set(embeddedSnapshotAtom, snapshot);
   store.set(layoutStateAtom, initialLayoutState(parsedOptions.data.layout));
-  if (notebook) {
-    store.set(notebookAtom, notebook);
+  if (snapshot !== null) {
+    // The scratch cell keeps its own runtime; the snapshot has none for it.
+    store.set(notebookAtom, (state) => ({
+      ...state,
+      cellRuntime: { ...state.cellRuntime, ...cellRuntime },
+    }));
   }
 }
 

package/src/stories/cell.stories.tsx

@@ -46,7 +46,6 @@ const Cell: React.FC<{
         name: "cell_1",
         code: "import marimo as mo",
         edited: overrides.edited ?? false,
-        serializedEditorState: null,
         config: {
           hide_code: overrides.config?.hide_code ?? false,
           disabled: overrides.config?.disabled ?? false,
@@ -79,7 +78,6 @@ const Cell: React.FC<{
     cellLogs: [],
     history: [],
     scrollKey: null,
-    untouchedNewCells: new Set(),
   };
 
   const store = createStore();

package/src/stories/layout/vertical/one-column.stories.tsx

@@ -36,7 +36,6 @@ const createLongReprNotebook = (
 print('hello')
 LongReprA()`,
       edited: false,
-      serializedEditorState: null,
       config: {
         hide_code: hideCode,
         disabled: false,
@@ -88,7 +87,6 @@ LongReprA()`,
   cellLogs: [],
   history: [],
   scrollKey: null,
-  untouchedNewCells: new Set(),
 });
 
 export default {