improvement: hold on to unnamed UI elements #1359
Conversation
Changes the semantics of the UIRegistry to hold on to unnamed UI elements. This makes function call requests work on unnamed UI elements. The registry now keeps track of all the UI elements registered to a cell, and exposes a method to unregister them. The runtime unregisters all UI elements for a cell when cell state is invalidated.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@mscolnick if you want to check if the |
|
@mscolnick I remember now why we didn't do this. This interacts badly with cached UI elements (we have a unit test that exercises this). In particular it isn't obvious how to handle the lifecycle of UI elements: It seems intuitive that when a cell is re-run, we purge UI elements it created from the registry — otherwise we'll have a memory leak. That's what I did in this PR. But the user may have held onto a reference to the UI element (with Here's the unit test that fails: async def test_cached_element_still_registered(
k: Kernel, exec_req: ExecReqProvider
) -> None:
await k.run(
[
exec_req.get("import functools"),
exec_req.get("import marimo as mo"),
exec_req.get(
"""
@functools.lru_cache
def slider():
return mo.ui.slider(1, 10)
"""
),
(construct_slider := exec_req.get("s = slider()")),
]
)
# Make sure that the slider is registered
s = k.globals["s"]
assert get_context().ui_element_registry.get_object(s._id) == s
# Re-run the cell but fetch the same slider, since we're using
# functools.cache. Make sure it's still registered!
await k.run([construct_slider])
assert get_context().ui_element_registry.get_object(s._id) == s Maybe there's a way to work around this, by tracking references/pointers in a clever way, but if there's a solution it isn't obvious to me. |
Changes the semantics of the UIRegistry to hold on to unnamed UI elements.
This makes function call requests work on unnamed UI elements.
The registry now keeps track of all the UI elements registered to a cell, and exposes a method to unregister them. The runtime unregisters all UI elements for a cell when cell state is invalidated.
STATUS: DRAFT.
[ ] Think through second-order effects.
[ ] Might need to change destructor logic for UI elements.
[ ] Update existing tests, rewrite new ones.