Use JSON instead of pickle files for storage of bookmarks

Author: schloerke

shiny/bookmark/_restore_state.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import pickle
 import warnings
 from contextlib import contextmanager
 from contextvars import ContextVar, Token
@@ -11,7 +10,7 @@
 from ..module import ResolvedId
 from ._bookmark_state import local_restore_dir
 from ._types import BookmarkRestoreDirFn
-from ._utils import from_json_str, in_shiny_server
+from ._utils import from_json_file, from_json_str, in_shiny_server
 
 if TYPE_CHECKING:
     from .._app import App
@@ -204,17 +203,15 @@ async def _load_state_qs(self, query_string: str, *, app: App) -> None:
         self.dir = Path(await load_bookmark_fn(id))
 
         if not self.dir.exists():
-            raise ValueError("Bookmarked state directory does not exist.")
+            raise RuntimeError("Bookmarked state directory does not exist.")
 
         # TODO: Barret; Store/restore as JSON
-        with open(self.dir / "input.pickle", "rb") as f:
-            input_values = pickle.load(f)
+        input_values = from_json_file(self.dir / "input.json")
         self.input = RestoreInputSet(input_values)
 
-        values_file = self.dir / "values.pickle"
+        values_file = self.dir / "values.json"
         if values_file.exists():
-            with open(values_file, "rb") as f:
-                self.values = pickle.load(f)
+            self.values = from_json_file(values_file)
         # End load state from disk
 
         return

shiny/bookmark/_save_state.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import pickle
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Awaitable, Callable
 from urllib.parse import urlencode as urllib_urlencode
@@ -9,7 +8,7 @@
 from ..reactive import isolate
 from ._bookmark_state import local_save_dir
 from ._types import BookmarkSaveDirFn
-from ._utils import in_shiny_server, to_json_str
+from ._utils import in_shiny_server, to_json_file, to_json_str
 
 if TYPE_CHECKING:
     from .. import Inputs
@@ -55,7 +54,7 @@ async def _call_on_save(self):
 
     async def _save_state(self, *, app: App) -> str:
         """
-        Save a state to disk (pickle).
+        Save a bookmark state to disk (JSON).
 
         Returns
         -------
@@ -91,12 +90,10 @@ async def _save_state(self, *, app: App) -> str:
         )
         assert self.dir is not None
 
-        with open(self.dir / "input.pickle", "wb") as f:
-            pickle.dump(input_values_json, f)
+        to_json_file(input_values_json, self.dir / "input.json")
 
         if len(self.values) > 0:
-            with open(self.dir / "values.pickle", "wb") as f:
-                pickle.dump(self.values, f)
+            to_json_file(self.values, self.dir / "values.json")
         # End save to disk
 
         # No need to encode URI component as it is only ascii characters.

shiny/bookmark/_utils.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
 from typing import Any
 
 import orjson
@@ -21,3 +22,17 @@ def to_json_str(x: Any) -> str:
 
 def from_json_str(x: str) -> Any:
     return orjson.loads(x)
+
+
+# When saving to a file, use plain text json.
+# (It's possible that we could store bytes, but unknown if there's any security benefit.)
+#
+# This makes the file contents independent of the json library used and
+# independent of the python version being used
+# (ex: pickle files are not compatible between python versions)
+def to_json_file(x: Any, file: Path) -> None:
+    file.write_text(to_json_str(x), encoding="utf-8")
+
+
+def from_json_file(file: Path) -> Any:
+    return from_json_str(file.read_text(encoding="utf-8"))