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.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
Pass model_id as data attribute to prevent loss on value update (#9032)
Trevor Manzcf3d07a85e74
diff --git a/frontend/src/plugins/impl/anywidget/AnyWidgetPlugin.tsx b/frontend/src/plugins/impl/anywidget/AnyWidgetPlugin.tsxindex 044ffd65b8..2a3e67b9c1 100644--- a/frontend/src/plugins/impl/anywidget/AnyWidgetPlugin.tsx+++ b/frontend/src/plugins/impl/anywidget/AnyWidgetPlugin.tsx@@ -21,17 +21,19 @@ import { BINDING_MANAGER, WIDGET_DEF_REGISTRY } from "./widget-binding";interface Data {jsUrl: string;jsHash: string;+ modelId: WidgetModelId;}type AnyWidgetState = ModelState;/**- * Initial value is a model_id reference.- * The backend sends just { model_id: string } and the frontend- * retrieves the actual state from the 'open' message.+ * Value payload sent by the frontend on state updates.+ *+ * The initial value from the backend is empty — `model_id` is passed+ * via immutable data attributes (`args`) so it survives value overwrites.*/interface ModelIdRef {- model_id: WidgetModelId;+ model_id?: WidgetModelId;}export function useAnyWidgetModule(opts: { jsUrl: string; jsHash: string }) {@@ -117,14 +119,14 @@ export const AnyWidgetPlugin = createPlugin<ModelIdRef>("marimo-anywidget")z.object({jsUrl: z.string(),jsHash: z.string(),+ modelId: z.string().transform((v) => v as WidgetModelId),}),).withFunctions({}).renderer((props) => <AnyWidgetSlot {...props} />);const AnyWidgetSlot = (props: IPluginProps<ModelIdRef, Data>) => {- const { jsUrl, jsHash } = props.data;- const { model_id: modelId } = props.value;+ const { jsUrl, jsHash, modelId } = props.data;const host = props.host as HTMLElementNotDerivedFromRef;const { jsModule, error } = useAnyWidgetModule({ jsUrl, jsHash });diff --git a/frontend/src/plugins/impl/anywidget/__tests__/AnyWidgetPlugin.test.tsx b/frontend/src/plugins/impl/anywidget/__tests__/AnyWidgetPlugin.test.tsxindex b49fdcb195..7ff5d06a23 100644--- a/frontend/src/plugins/impl/anywidget/__tests__/AnyWidgetPlugin.test.tsx+++ b/frontend/src/plugins/impl/anywidget/__tests__/AnyWidgetPlugin.test.tsx@@ -29,6 +29,7 @@ describe("LoadedSlot", () => {data: {jsUrl: "http://example.com/widget.js",jsHash: "abc123",+ modelId: modelId,},host: document.createElement("div",@@ -67,6 +68,30 @@ describe("LoadedSlot", () => {});});+ it("should not remount when value update drops model_id", async () => {+ // Regression: when the frontend sends a state update (e.g. {zoom_level: 0}),+ // it overwrites the UIElement value that originally held {model_id: "..."}.+ // The key must stay stable because modelId comes from data, not value.+ const { container, rerender } = render(<LoadedSlot {...mockProps} />);++ await waitFor(() => {+ expect(mockWidget.render).toHaveBeenCalledTimes(1);+ });++ const divBefore = container.querySelector("div");++ // Simulate a value update that does NOT include model_id+ // (this is what happens when the widget sends trait state)+ rerender(<LoadedSlot {...mockProps} />);++ await waitFor(() => {+ // The div should be the same DOM node (no remount)+ expect(container.querySelector("div")).toBe(divBefore);+ // render should not be called again (no remount)+ expect(mockWidget.render).toHaveBeenCalledTimes(1);+ });+ });+it("should re-run widget when widget prop changes", async () => {const { rerender } = render(<LoadedSlot {...mockProps} />);diff --git a/marimo/_output/formatters/repr_formatters.py b/marimo/_output/formatters/repr_formatters.pyindex 75f8329354..4cc359de65 100644--- a/marimo/_output/formatters/repr_formatters.py+++ b/marimo/_output/formatters/repr_formatters.py@@ -59,11 +59,12 @@ def _maybe_as_anywidget_html(inner = build_ui_plugin(component_name="marimo-anywidget",- initial_value={"model_id": model_id},+ initial_value={},label=None,args={"js-url": js_url,"js-hash": js_hash,+ "model-id": model_id,},)# Wrap in <marimo-ui-element> so the plugin gets proper lifecyclediff --git a/marimo/_plugins/ui/_impl/from_anywidget.py b/marimo/_plugins/ui/_impl/from_anywidget.pyindex aa81b4fd4a..c096f42974 100644--- a/marimo/_plugins/ui/_impl/from_anywidget.py+++ b/marimo/_plugins/ui/_impl/from_anywidget.py@@ -208,6 +208,7 @@ class anywidget(UIElement[ModelIdRef, AnyWidgetState]):args={"js-url": mo_data.js(js).url if js else "", # type: ignore [unused-ignore] # noqa: E501"js-hash": js_hash,+ "model-id": model_id,},on_change=None,)