@marimo-team/islands 0.23.5-dev1 → 0.23.5-dev11

package/src/core/meta/__tests__/code-visibility.test.tsx

@@ -0,0 +1,141 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import { renderHook } from "@testing-library/react";
+import { createStore, Provider } from "jotai";
+import type { ReactNode } from "react";
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import { showCodeInRunModeAtom } from "@/core/meta/state";
+import { type AppMode, kioskModeAtom, viewStateAtom } from "@/core/mode";
+import { useNotebookCodeAvailable } from "../code-visibility";
+
+interface StoreOpts {
+  mode?: AppMode;
+  kiosk?: boolean;
+  showInRunMode?: boolean;
+}
+
+function makeStore({
+  mode = "read",
+  kiosk = false,
+  showInRunMode = true,
+}: StoreOpts = {}) {
+  const store = createStore();
+  store.set(viewStateAtom, { mode, cellAnchor: null });
+  store.set(kioskModeAtom, kiosk);
+  store.set(showCodeInRunModeAtom, showInRunMode);
+  return store;
+}
+
+function wrap(store: ReturnType<typeof createStore>) {
+  return ({ children }: { children: ReactNode }) => (
+    <Provider store={store}>{children}</Provider>
+  );
+}
+
+const cellsWithCode = [{ code: "x = 1" }, { code: "" }];
+const cellsWithoutCode = [{ code: "" }, { code: "" }];
+
+const originalHref = window.location.href;
+
+function setSearch(search: string) {
+  window.history.replaceState(null, "", `/${search}`);
+}
+
+describe("useNotebookCodeAvailable", () => {
+  beforeEach(() => {
+    setSearch("");
+  });
+
+  afterEach(() => {
+    window.history.replaceState(null, "", originalHref);
+  });
+
+  it("returns true in edit mode regardless of cells", () => {
+    const store = makeStore({ mode: "edit" });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithoutCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(true);
+  });
+
+  it("returns true in present mode (only reachable from edit)", () => {
+    const store = makeStore({ mode: "present" });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithoutCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(true);
+  });
+
+  it("returns true in kiosk mode even when read mode and no code", () => {
+    const store = makeStore({
+      mode: "read",
+      kiosk: true,
+      showInRunMode: false,
+    });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithoutCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(true);
+  });
+
+  it("returns true in read mode when at least one cell has code", () => {
+    const store = makeStore({ mode: "read" });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(true);
+  });
+
+  it("returns false in read mode when every cell.code is empty (server stripped)", () => {
+    const store = makeStore({ mode: "read" });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithoutCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(false);
+  });
+
+  it("returns false in read mode when host opts out via showAppCode", () => {
+    const store = makeStore({ mode: "read", showInRunMode: false });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(false);
+  });
+
+  it("returns false in read mode when ?include-code=false", () => {
+    setSearch("?include-code=false");
+    const store = makeStore({ mode: "read" });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(false);
+  });
+
+  it("ignores ?include-code=false in kiosk mode", () => {
+    setSearch("?include-code=false");
+    const store = makeStore({ mode: "read", kiosk: true });
+    const { result } = renderHook(
+      () => useNotebookCodeAvailable(cellsWithoutCode),
+      { wrapper: wrap(store) },
+    );
+    expect(result.current).toBe(true);
+  });
+
+  it("returns false for non-edit/non-read modes (home, gallery)", () => {
+    for (const mode of ["home", "gallery"] as const) {
+      const store = makeStore({ mode });
+      const { result } = renderHook(
+        () => useNotebookCodeAvailable(cellsWithCode),
+        { wrapper: wrap(store) },
+      );
+      expect(result.current).toBe(false);
+    }
+  });
+});

package/src/core/meta/code-visibility.ts

@@ -0,0 +1,48 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import { useAtomValue } from "jotai";
+import { KnownQueryParams } from "@/core/constants";
+import { showCodeInRunModeAtom } from "@/core/meta/state";
+import { kioskModeAtom, viewStateAtom } from "@/core/mode";
+import { logNever } from "@/utils/assertNever";
+
+/**
+ * Whether the notebook source code reached the frontend and can be rendered.
+ *
+ * In `marimo run` the server omits cell sources unless `--include-code` is
+ * set (every `cell.code` arrives as `""`). Use this to gate any "show code"
+ * / "copy code" / "download .py" affordance.
+ */
+export function useNotebookCodeAvailable(
+  cells: ReadonlyArray<{ code: string }>,
+): boolean {
+  const kioskMode = useAtomValue(kioskModeAtom);
+  const { mode } = useAtomValue(viewStateAtom);
+  const showInRunMode = useAtomValue(showCodeInRunModeAtom);
+
+  if (kioskMode) {
+    return true;
+  }
+
+  switch (mode) {
+    case "edit":
+    case "present":
+      return true;
+    case "home":
+    case "gallery":
+      return false;
+    case "read": {
+      if (!showInRunMode) {
+        return false;
+      }
+      const params = new URLSearchParams(window.location.search);
+      if (params.get(KnownQueryParams.includeCode) === "false") {
+        return false;
+      }
+      return cells.some((cell) => Boolean(cell.code));
+    }
+    default:
+      logNever(mode);
+      return false;
+  }
+}