Require that a ResolvedId is supplied to restore_input()

Author: schloerke

shiny/api-examples/restore_input/app.py

@@ -1,4 +1,4 @@
-from htmltools import tags
+from htmltools import css, tags
 from starlette.requests import Request
 
 from shiny import App, Inputs, Outputs, Session, ui
@@ -13,32 +13,26 @@ def custom_input_text(
 
     resolved_id = resolve_id(id)
     return tags.div(
-        "Custom input text:",
-        tags.input(
+        tags.label(tags.strong("Custom input text:")),
+        tags.textarea(
+            restore_input(resolved_id, value),
             id=resolved_id,
             type="text",
-            value=restore_input(resolved_id, value),
             placeholder="Type here...",
+            style=css(width="400px", height="3hr"),
         ),
         class_="shiny-input-container",
-        style=ui.css(width="400px"),
     )
 
 
 # App UI **must** be a function to ensure that each user restores their own UI values.
 def app_ui(request: Request):
     return ui.page_fluid(
-        custom_input_text("myid", value="Default value - Hello, world!"),
+        custom_input_text(
+            "myid",
+            value="Change this value, then click bookmark and refresh the page.",
+        ),
         ui.input_bookmark_button(),
-        # ui.markdown(
-        #     "Directions: "
-        #     "\n1. Change the radio button selection below"
-        #     "\n2. Save the bookmark."
-        #     "\n3. Then, refresh your browser page to see the radio button selection has been restored."
-        # ),
-        # ui.hr(),
-        # ui.input_radio_buttons("letter", "Choose a letter", choices=["A", "B", "C"]),
-        # ui.input_bookmark_button(label="Save bookmark!"),
     )
 
 
@@ -49,4 +43,5 @@ async def _(url: str):
         await session.bookmark.update_query_string(url)
 
 
+# `bookmark_store` (`"url"` or `"server"`) must be passed to the `App` constructor to enable bookmarking.
 app = App(app_ui, server, bookmark_store="url")

shiny/bookmark/_restore_state.py

@@ -8,6 +8,7 @@
 from typing import TYPE_CHECKING, Any, Literal, Optional
 from urllib.parse import parse_qs, parse_qsl
 
+from ..module import ResolvedId
 from ._bookmark_state import local_restore_dir
 from ._types import BookmarkRestoreDirFn
 from ._utils import from_json_str, in_shiny_server
@@ -283,33 +284,36 @@ class RestoreInputSet:
     could completely prevent any other (non- restored) kvalue from being used.
     """
 
-    _values: dict[str, Any]
-    _pending: set[str]
+    _values: dict[ResolvedId, Any]
+    _pending: set[ResolvedId]
     """Names of values which have been marked as pending"""
-    _used: set[str]
+    _used: set[ResolvedId]
     """Names of values which have been used"""
 
     def __init__(self, values: Optional[dict[str, Any]] = None):
 
-        self._values = {} if values is None else values
+        if values is None:
+            self._values = {}
+        else:
+            self._values = {ResolvedId(key): value for key, value in values.items()}
         self._pending = set()
         self._used = set()
 
-    def exists(self, name: str) -> bool:
+    def exists(self, name: ResolvedId) -> bool:
         return name in self._values
 
-    def available(self, name: str) -> bool:
+    def available(self, name: ResolvedId) -> bool:
         return self.exists(name) and not self.is_used(name)
 
-    def is_pending(self, name: str) -> bool:
+    def is_pending(self, name: ResolvedId) -> bool:
         return name in self._pending
 
-    def is_used(self, name: str) -> bool:
+    def is_used(self, name: ResolvedId) -> bool:
         return name in self._used
 
     # Get a value. If `force` is TRUE, get the value without checking whether
     # has been used, and without marking it as pending.
-    def get(self, name: str, force: bool = False) -> Any:
+    def get(self, name: ResolvedId, force: bool = False) -> Any:
         if force:
             return self._values[name]
 
@@ -325,7 +329,7 @@ def flush_pending(self) -> None:
         self._pending.clear()
 
     def as_dict(self) -> dict[str, Any]:
-        return self._values
+        return {str(key): value for key, value in self._values.items()}
 
 
 # #############################################################################
@@ -386,7 +390,7 @@ def get_current_restore_context() -> RestoreContext | None:
     return ctx
 
 
-def restore_input(id: str, default: Any) -> Any:
+def restore_input(resolved_id: ResolvedId, default: Any) -> Any:
     """
     Restore an input value
 
@@ -400,6 +404,10 @@ def restore_input(id: str, default: Any) -> Any:
     default
         A default value to use, if there's no value to restore.
     """
+    if not isinstance(resolved_id, ResolvedId):
+        raise TypeError(
+            "Expected `resolved_id` to be of type `ResolvedId` which is returned from `shiny.module.resolve_id(id)`."
+        )
     # Will run even if the domain is missing
     if not has_current_restore_context():
         return default
@@ -408,7 +416,7 @@ def restore_input(id: str, default: Any) -> Any:
     ctx = get_current_restore_context()
     if isinstance(ctx, RestoreContext):
         old_inputs = ctx.input
-        if old_inputs.available(id):
-            return old_inputs.get(id)
+        if old_inputs.available(resolved_id):
+            return old_inputs.get(resolved_id)
 
     return default