Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

fix add setup cell overwriting original cell on refresh (#7061)

Shahmir Varqhac559090c9931
diff --git a/frontend/src/components/editor/actions/useCellActionButton.tsx b/frontend/src/components/editor/actions/useCellActionButton.tsx
index c5f6e5154d..ff9a20a019 100644
--- a/frontend/src/components/editor/actions/useCellActionButton.tsx
+++ b/frontend/src/components/editor/actions/useCellActionButton.tsx
@@ -39,12 +39,8 @@ import { Switch } from "@/components/ui/switch";
import { toast } from "@/components/ui/use-toast";
import { aiCompletionCellAtom } from "@/core/ai/state";
import { maybeAddMarimoImport } from "@/core/cells/add-missing-import";
-import {
- hasOnlyOneCellAtom,
- SETUP_CELL_ID,
- useCellActions,
-} from "@/core/cells/cells";
-import type { CellId } from "@/core/cells/ids";
+import { hasOnlyOneCellAtom, useCellActions } from "@/core/cells/cells";
+import { type CellId, SETUP_CELL_ID } from "@/core/cells/ids";
import type { CellData } from "@/core/cells/types";
import { formatEditorViews } from "@/core/codemirror/format";
import { toggleToLanguage } from "@/core/codemirror/language/commands";
diff --git a/frontend/src/components/editor/links/cell-link.tsx b/frontend/src/components/editor/links/cell-link.tsx
index 141850a5da..fb367430e0 100644
--- a/frontend/src/components/editor/links/cell-link.tsx
+++ b/frontend/src/components/editor/links/cell-link.tsx
@@ -1,13 +1,8 @@
/* Copyright 2024 Marimo. All rights reserved. */
import type { JSX } from "react"; /* Copyright 2024 Marimo. All rights reserved. */
-import {
- SCRATCH_CELL_ID,
- useCellActions,
- useCellIds,
- useCellNames,
-} from "@/core/cells/cells";
-import { type CellId, HTMLCellId } from "@/core/cells/ids";
+import { useCellActions, useCellIds, useCellNames } from "@/core/cells/cells";
+import { type CellId, HTMLCellId, SCRATCH_CELL_ID } from "@/core/cells/ids";
import { displayCellName } from "@/core/cells/names";
import { goToCellLine } from "@/core/codemirror/go-to-definition/utils";
import { useFilename } from "@/core/saving/filename";
diff --git a/frontend/src/components/editor/notebook-cell.tsx b/frontend/src/components/editor/notebook-cell.tsx
index 6ba56706eb..290479f737 100644
--- a/frontend/src/components/editor/notebook-cell.tsx
+++ b/frontend/src/components/editor/notebook-cell.tsx
@@ -41,13 +41,12 @@ import type { Milliseconds, Seconds } from "@/utils/time";
import {
type CellActions,
createUntouchedCellAtom,
- SETUP_CELL_ID,
useCellActions,
useCellData,
useCellHandle,
useCellRuntime,
} from "../../core/cells/cells";
-import type { CellId } from "../../core/cells/ids";
+import { type CellId, SETUP_CELL_ID } from "../../core/cells/ids";
import { isUninstantiated } from "../../core/cells/utils";
import type { UserConfig } from "../../core/config/config-schema";
import {
diff --git a/frontend/src/components/editor/renderers/cell-array.tsx b/frontend/src/components/editor/renderers/cell-array.tsx
index 89fdecd28a..3b27f9f3cf 100644
--- a/frontend/src/components/editor/renderers/cell-array.tsx
+++ b/frontend/src/components/editor/renderers/cell-array.tsx
@@ -20,6 +20,7 @@ import { SortableCellsProvider } from "@/components/sort/SortableCellsProvider";
import { Button } from "@/components/ui/button";
import { Tooltip } from "@/components/ui/tooltip";
import { maybeAddMarimoImport } from "@/core/cells/add-missing-import";
+import { SETUP_CELL_ID } from "@/core/cells/ids";
import { LanguageAdapters } from "@/core/codemirror/language/LanguageAdapters";
import { aiEnabledAtom } from "@/core/config/config";
import { isConnectedAtom } from "@/core/network/connection";
@@ -30,7 +31,6 @@ import type { CellColumnId } from "@/utils/id-tree";
import { invariant } from "@/utils/invariant";
import {
columnIdsAtom,
- SETUP_CELL_ID,
useCellActions,
useCellIds,
useScrollKey,
diff --git a/frontend/src/components/scratchpad/scratchpad.tsx b/frontend/src/components/scratchpad/scratchpad.tsx
index 4d4f4d90cf..6f9988dc36 100644
--- a/frontend/src/components/scratchpad/scratchpad.tsx
+++ b/frontend/src/components/scratchpad/scratchpad.tsx
@@ -11,13 +11,9 @@ import {
import type React from "react";
import { Suspense, useRef, useState } from "react";
import useEvent from "react-use-event-hook";
-import {
- SCRATCH_CELL_ID,
- useCellActions,
- useNotebook,
-} from "@/core/cells/cells";
+import { useCellActions, useNotebook } from "@/core/cells/cells";
import { useLastFocusedCellId } from "@/core/cells/focus";
-import { HTMLCellId } from "@/core/cells/ids";
+import { HTMLCellId, SCRATCH_CELL_ID } from "@/core/cells/ids";
import { DEFAULT_CELL_NAME } from "@/core/cells/names";
import type { LanguageAdapterType } from "@/core/codemirror/language/types";
import { useResolvedMarimoConfig } from "@/core/config/config";
diff --git a/frontend/src/core/cells/__tests__/cells.test.ts b/frontend/src/core/cells/__tests__/cells.test.ts
index 897826534d..0e624e8690 100644
--- a/frontend/src/core/cells/__tests__/cells.test.ts
+++ b/frontend/src/core/cells/__tests__/cells.test.ts
@@ -13,7 +13,7 @@ import {
vi,
} from "vitest";
import type { CellHandle } from "@/components/editor/notebook-cell";
-import { CellId } from "@/core/cells/ids";
+import { CellId, SETUP_CELL_ID } from "@/core/cells/ids";
import { foldAllBulk, unfoldAllBulk } from "@/core/codemirror/editing/commands";
import { adaptiveLanguageConfiguration } from "@/core/codemirror/language/extension";
import { OverridingHotkeyProvider } from "@/core/hotkeys/hotkeys";
@@ -24,7 +24,6 @@ import {
exportedForTesting,
flattenTopLevelNotebookCells,
type NotebookState,
- SETUP_CELL_ID,
} from "../cells";
import {
focusAndScrollCellIntoView,
@@ -2108,8 +2107,8 @@ describe("cell reducer", () => {
// Update the setup cell
actions.addSetupCellIfDoesntExist({ code: "# Updated setup code" });
- // Check that the same setup cell was updated, not duplicated
- expect(state.cellData[SETUP_CELL_ID].code).toBe("# Updated setup code");
+ // Check that the setup cell did not change, since it already exists
+ expect(state.cellData[SETUP_CELL_ID].code).toBe("# Setup code");
expect(state.cellData[SETUP_CELL_ID].edited).toBe(true);
expect(state.cellIds.inOrderIds).toContain(SETUP_CELL_ID);
});
diff --git a/frontend/src/core/cells/cells.ts b/frontend/src/core/cells/cells.ts
index 7e1a0a0f64..8efb02e2f5 100644
--- a/frontend/src/core/cells/cells.ts
+++ b/frontend/src/core/cells/cells.ts
@@ -29,7 +29,7 @@ import type { CellConfig } from "../network/types";
import { isRtcEnabled } from "../rtc/state";
import { createDeepEqualAtom, store } from "../state/jotai";
import { prepareCellForExecution, transitionCell } from "./cell";
-import { CellId } from "./ids";
+import { CellId, SCRATCH_CELL_ID, SETUP_CELL_ID } from "./ids";
import { type CellLog, getCellLogsForMessage } from "./logs";
import {
focusAndScrollCellIntoView,
@@ -52,13 +52,6 @@ import {
notebookQueueOrRunningCount,
} from "./utils";
-export const SCRATCH_CELL_ID = "__scratch__" as CellId;
-export const SETUP_CELL_ID = "setup" as CellId;
-
-export function isSetupCell(cellId: CellId): boolean {
- return cellId === SETUP_CELL_ID;
-}
-
/**
* The state of the notebook.
*/
@@ -1335,8 +1328,7 @@ const {
code = "# Initialization code that runs before all other cells";
}
- // First check if setup cell already exists
- if (SETUP_CELL_ID in state.cellIds) {
+ if (state.cellIds.setupCellExists()) {
// Just focus on the existing setup cell
return {
...state,
diff --git a/frontend/src/core/cells/focus.ts b/frontend/src/core/cells/focus.ts
index d7d4b14123..5ab53dbf9e 100644
--- a/frontend/src/core/cells/focus.ts
+++ b/frontend/src/core/cells/focus.ts
@@ -4,8 +4,9 @@ import type { EditorView } from "@codemirror/view";
import { atom, useAtomValue } from "jotai";
import { createReducerAndAtoms } from "@/utils/createReducer";
import type { CellConfig, RuntimeState } from "../network/types";
-import { type NotebookState, notebookAtom, SCRATCH_CELL_ID } from "./cells";
+import { type NotebookState, notebookAtom } from "./cells";
import type { CellId } from "./ids";
+import { SCRATCH_CELL_ID } from "./ids";
export interface CellFocusState {
focusedCellId: CellId | null;
lastFocusedCellId: CellId | null;
diff --git a/frontend/src/core/cells/ids.ts b/frontend/src/core/cells/ids.ts
index 41310763d9..c15c9c78a6 100644
--- a/frontend/src/core/cells/ids.ts
+++ b/frontend/src/core/cells/ids.ts
@@ -9,6 +9,9 @@ const uppercase = lowercase.toUpperCase();
const alphabet = lowercase + uppercase;
const seen = new Set<CellId>();
+export const SCRATCH_CELL_ID = "__scratch__" as CellId;
+export const SETUP_CELL_ID = "setup" as CellId;
+
/**
* A typed CellId
*/
diff --git a/frontend/src/core/codemirror/cells/extensions.ts b/frontend/src/core/codemirror/cells/extensions.ts
index 2b9d832900..e995c91f47 100644
--- a/frontend/src/core/codemirror/cells/extensions.ts
+++ b/frontend/src/core/codemirror/cells/extensions.ts
@@ -3,8 +3,8 @@
import { closeCompletion, completionStatus } from "@codemirror/autocomplete";
import { type Extension, Prec } from "@codemirror/state";
import { EditorView, type KeyBinding, keymap } from "@codemirror/view";
-import { createTracebackInfoAtom, SCRATCH_CELL_ID } from "@/core/cells/cells";
-import { type CellId, HTMLCellId } from "@/core/cells/ids";
+import { createTracebackInfoAtom } from "@/core/cells/cells";
+import { type CellId, HTMLCellId, SCRATCH_CELL_ID } from "@/core/cells/ids";
import type { KeymapConfig } from "@/core/config/config-schema";
import type { HotkeyProvider } from "@/core/hotkeys/hotkeys";
import { store } from "@/core/state/jotai";
diff --git a/frontend/src/utils/__tests__/id-tree.test.ts b/frontend/src/utils/__tests__/id-tree.test.ts
index 925f2cd1d7..1c820fc161 100644
--- a/frontend/src/utils/__tests__/id-tree.test.ts
+++ b/frontend/src/utils/__tests__/id-tree.test.ts
@@ -1,5 +1,6 @@
/* Copyright 2024 Marimo. All rights reserved. */
import { beforeEach, describe, expect, it } from "vitest";
+import { SETUP_CELL_ID } from "@/core/cells/ids";
import {
type CellColumnId,
type CellIndex,
@@ -1139,6 +1140,16 @@ describe("MultiColumn", () => {
]);
});
+ it("handles setup cell existence", () => {
+ const multiColumn = MultiColumn.from([["A1"], ["B1"], ["C1"]]);
+ const columnIds = multiColumn.getColumnIds();
+ expect(multiColumn.setupCellExists()).toBe(false);
+ const multiColumn2 = multiColumn.insertId(SETUP_CELL_ID, columnIds[0], 0);
+ expect(multiColumn2.setupCellExists()).toBe(true);
+ const multiColumn3 = multiColumn2.deleteById(SETUP_CELL_ID);
+ expect(multiColumn3.setupCellExists()).toBe(false);
+ });
+
it("handles get method", () => {
const column = multiColumn.get(columnIds[1]);
expect(column?.topLevelIds).toEqual(["B1", "B2"]);
diff --git a/frontend/src/utils/id-tree.tsx b/frontend/src/utils/id-tree.tsx
index 9cb23467e3..704d99f005 100644
--- a/frontend/src/utils/id-tree.tsx
+++ b/frontend/src/utils/id-tree.tsx
@@ -2,6 +2,7 @@
import { Memoize } from "typescript-memoize";
import { reorderColumnSizes } from "@/components/editor/columns/storage";
+import { SETUP_CELL_ID } from "@/core/cells/ids";
import { arrayDelete, arrayInsert, arrayInsertMany, arrayMove } from "./arrays";
import { Logger } from "./Logger";
@@ -958,6 +959,10 @@ export class MultiColumn<T> {
return new MultiColumn(columns);
}
+ setupCellExists(): boolean {
+ return this.columns.some((c) => c.topLevelIds.includes(SETUP_CELL_ID as T));
+ }
+
insertId(id: T, col: CellColumnId, index: CellIndex): MultiColumn<T> {
return this.transform(col, (c) => c.insert(id, index));
}