feat(bookmarking): Add session.bookmark.show_bookmark_url_modal()

shiny/bookmark/_save_state.py

@@ -43,8 +43,6 @@ def __init__(
         self.dir = None  # This will be set by external functions.
         self.values = {}
 
-        self._always_exclude: list[str] = []
-
     async def _call_on_save(self):
         # Allow user-supplied save function to do things like add state$values, or
         # save data to state dir.

tests/playwright/shiny/bookmark/modal/app.py

@@ -0,0 +1,20 @@
+from starlette.requests import Request
+
+from shiny import App, Inputs, Outputs, Session, reactive, ui
+
+
+def app_ui(request: Request):
+    return ui.page_fluid(
+        ui.input_radio_buttons("letter", "Choose a letter", choices=["A", "B", "C"]),
+    )
+
+
+def server(input: Inputs, ouput: Outputs, session: Session):
+
+    @reactive.effect
+    @reactive.event(input.letter, ignore_init=True)
+    async def _():
+        await session.bookmark()
+
+
+app = App(app_ui, server, bookmark_store="url")

tests/playwright/shiny/bookmark/modal/test_bookmark_modal.py

@@ -0,0 +1,21 @@
+import re
+
+from playwright.sync_api import Page, expect
+
+from shiny.playwright.controller import InputRadioButtons
+from shiny.run import ShinyAppProc
+
+
+def test_bookmark_modules(page: Page, local_app: ShinyAppProc):
+
+    page.goto(local_app.url)
+
+    letter = InputRadioButtons(page, "letter")
+    letter.expect_selected("A")
+    letter.set("C")
+
+    expect(page.locator("div.modal-body > textarea")).to_have_value(
+        re.compile(r"letter=%22C%22")
+    )
+
+    assert "?" not in page.url

tests/playwright/shiny/bookmark/modules/app-core-recursive.py

@@ -29,7 +29,7 @@ def mod_btn(idx: int = 1):
             width="200px",
         ),
         ui.hr(),
-        mod_btn(f"sub{idx}", idx - 1) if idx > 0 else None,
+        mod_btn(f"sub{idx - 1}", idx - 1) if idx > 0 else None,
     )
 
 
@@ -55,7 +55,6 @@ def value():
     @reactive.effect
     @reactive.event(input.btn1, input.btn2, input.dyn1, input.dyn2, ignore_init=True)
     async def _():
-        # print("app-Bookmarking!")
         await session.bookmark()
 
     session.bookmark.exclude.append("btn2")
@@ -68,7 +67,6 @@ def _(state: BookmarkState) -> None:
 
     @session.bookmark.on_restore
     def _(restore_state: RestoreState) -> None:
-        # print("app-Restore state:", restore_state.values)
 
         if "btn2" in restore_state.values:
 
@@ -79,14 +77,16 @@ def _(restore_state: RestoreState) -> None:
             ui.update_radio_buttons("dyn2", selected=restore_state.values["dyn2"])
 
     if idx > 0:
-        btn_server(f"sub{idx}", idx - 1)
+        btn_server(f"sub{idx - 1}", idx - 1)
+    else:
+        # Attempt to call on_bookmarked at the very end of the proxy chain
+        session.bookmark.on_bookmarked(session.bookmark.update_query_string)
 
 
-k = 2
+k = 4
 
 
 def app_ui(request: Request) -> ui.Tag:
-    # print("app-Making UI")
     return ui.page_fixed(
         ui.output_code("bookmark_store"),
         "Click Buttons to update bookmark",
@@ -103,23 +103,6 @@ def server(input: Inputs, output: Outputs, session: Session):
     def bookmark_store():
         return f"{session.bookmark.store}"
 
-    @session.bookmark.on_bookmark
-    async def on_bookmark(state: BookmarkState) -> None:
-        print(
-            "app-On Bookmark",
-            "\nInputs: ",
-            await state.input._serialize(exclude=state.exclude, state_dir=None),
-            "\nValues: ",
-            state.values,
-            "\n\n",
-        )
-        # session.bookmark.update_query_string()
-
-        pass
-
-    session.bookmark.on_bookmarked(session.bookmark.update_query_string)
-    # session.bookmark.on_bookmarked(session.bookmark.show_modal)
-
 
 SHINY_BOOKMARK_STORE: Literal["url", "server"] = os.getenv(
     "SHINY_BOOKMARK_STORE", "url"

tests/playwright/shiny/bookmark/modules/app-core.py

@@ -30,9 +30,6 @@ def mod_btn(idx: int):
             ui.output_ui("ui_html"),
             ui.output_code("value"),
             width="200px",
-            # fill=True,
-            # fillable=True,
-            # height="75px",
         ),
         ui.hr(),
     )
@@ -60,7 +57,6 @@ def value():
     @reactive.effect
     @reactive.event(input.btn1, input.btn2, input.dyn1, input.dyn2, ignore_init=True)
     async def _():
-        # print("app-Bookmarking!")
         await session.bookmark()
 
     session.bookmark.exclude.append("btn2")
@@ -73,7 +69,6 @@ def _(state: BookmarkState) -> None:
 
     @session.bookmark.on_restore
     def _(restore_state: RestoreState) -> None:
-        # print("app-Restore state:", restore_state.values)
 
         if "btn2" in restore_state.values:
 
@@ -84,53 +79,29 @@ def _(restore_state: RestoreState) -> None:
             ui.update_radio_buttons("dyn2", selected=restore_state.values["dyn2"])
 
 
-k = 2
+k = 4
 
 
 def app_ui(request: Request) -> ui.Tag:
-    # print("app-Making UI")
     return ui.page_fixed(
         ui.output_code("bookmark_store"),
         "Click Button to update bookmark",
-        # ui.input_action_button("btn", "Button"),
         *[mod_btn(f"mod{i}", i) for i in reversed(range(k))],
-        # ui.input_radio_buttons("btn", "Button", choices=["a", "b", "c"], selected="a"),
-        # ui.output_code("code"),
-        # ui.input_bookmark_button(),
     )
 
 
 # Needs access to the restore context to the dynamic UI
 def server(input: Inputs, output: Outputs, session: Session):
 
+    session.bookmark.on_bookmarked(session.bookmark.update_query_string)
+
     @render.code
     def bookmark_store():
         return f"{session.bookmark.store}"
 
     for i in reversed(range(k)):
         btn_server(f"mod{i}", i)
 
-    @session.bookmark.on_bookmark
-    async def on_bookmark(state: BookmarkState) -> None:
-        # print(
-        #     "app-On Bookmark",
-        #     "\nInputs: ",
-        #     await state.input._serialize(exclude=state.exclude, state_dir=None),
-        #     "\nValues: ",
-        #     state.values,
-        #     "\n\n",
-        # )
-        # session.bookmark.update_query_string()
-
-        pass
-
-    session.bookmark.on_bookmarked(session.bookmark.update_query_string)
-    # session.bookmark.on_bookmarked(session.bookmark.show_modal)
-
-    # @render.code
-    # def code():
-    #     return f"{input.btn()}"
-
 
 SHINY_BOOKMARK_STORE: Literal["url", "server"] = os.getenv(
     "SHINY_BOOKMARK_STORE", "url"

tests/playwright/shiny/bookmark/modules/app-express.py

@@ -15,13 +15,18 @@
 app_opts(bookmark_store=SHINY_BOOKMARK_STORE)
 
 
+@session.bookmark.on_bookmarked
+async def _(url: str):
+    await session.bookmark.update_query_string(url)
+
+
 @render.code
 def bookmark_store():
     return f"{session.bookmark.store}"
 
 
 @module
-def recursive_mod(input: Inputs, output: Outputs, session: Session, recurse: int = 3):
+def ex_mod(input: Inputs, output: Outputs, session: Session, recurse: int = 3):
 
     ui.h3(f"Module {recurse}")
     with ui.layout_column_wrap(width="200px"):
@@ -84,38 +89,6 @@ def _(restore_state: RestoreState) -> None:
 
 "Click Button to update bookmark"
 
-k = 2
+k = 4
 for i in reversed(range(k)):
-    recursive_mod(f"mod{i}", i)
-
-
-# ui.input_radio_buttons("btn", "Button", choices=["a", "b", "c"], selected="a")
-
-
-# @render.code
-# def code():
-#     return f"{input.btn()}"
-
-
-# ui.input_bookmark_button()
-
-
-# @session.bookmark.on_bookmark
-# async def on_bookmark(state: BookmarkState) -> None:
-#     print(
-#         "app-On Bookmark",
-#         "\nInputs: ",
-#         await state.input._serialize(exclude=state.exclude, state_dir=None),
-#         "\nValues: ",
-#         state.values,
-#         "\n\n",
-#     )
-#     # session.bookmark.update_query_string()
-
-
-@session.bookmark.on_bookmarked
-async def _(url: str):
-    await session.bookmark.update_query_string(url)
-
-
-# session.bookmark.on_bookmarked(session.bookmark.show_modal)
+    ex_mod(f"mod{i}", i)

tests/playwright/shiny/bookmark/modules/test_bookmark_modules.py

@@ -12,11 +12,11 @@
     "app_name,mod0_key,mod1_key",
     [
         # Express mode
-        ("app-express.py", "mod0", "mod1"),
+        ("app-express.py", "mod0", "mod3"),
         # Core mode
-        ("app-core.py", "mod0", "mod1"),
+        ("app-core.py", "mod0", "mod3"),
         # Recursive modules within core mode
-        ("app-core-recursive.py", "mod1-sub1", "mod1"),
+        ("app-core-recursive.py", "mod3", "mod3-sub2-sub1-sub0"),
     ],
 )
 @pytest.mark.parametrize("bookmark_store", ["url", "server"])