Fix issue caused by new script cache in 1.23.1

.github/workflows/testing.yml

@@ -29,3 +29,8 @@ jobs:
           playwright install --with-deps
       - name: Test with tox
         run: tox
+      - uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: screenshots
+          path: screenshot*.png

.gitignore

@@ -17,4 +17,5 @@ __pycache__
 
 .streamlit/secrets.toml
 
-*.png
+*.png
+.venv

README.md

@@ -3,7 +3,7 @@
 [![Releases](https://img.shields.io/pypi/v/st-pages)](https://pypi.org/project/st-pages/)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/blackary/st_pages/testing.yml?branch=main)](https://github.com/blackary/st_pages/actions?query=workflow%3A%22testing%22+branch%3Amain)
 ![Python Versions](https://img.shields.io/pypi/pyversions/st_pages.svg)
-![Streamlit versions](https://img.shields.io/badge/streamlit-1.15.0--1.18.0-white.svg)
+![Streamlit versions](https://img.shields.io/badge/streamlit-1.21.0--1.24.0-white.svg)
 ![License](https://img.shields.io/github/license/blackary/st_pages)
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 

src/st_pages/__init__.py

@@ -3,6 +3,7 @@
 import json
 from dataclasses import dataclass
 from pathlib import Path
+from time import sleep
 
 import toml
 
@@ -15,8 +16,10 @@ def _gather_metrics(name, func, *args, **kwargs):
 
 
 import streamlit as st
+from streamlit import runtime
 from streamlit.commands.page_config import get_random_emoji
 from streamlit.errors import StreamlitAPIException
+from streamlit.watcher import LocalSourcesWatcher
 
 try:
     from streamlit.runtime.scriptrunner import get_script_run_ctx
@@ -108,7 +111,7 @@ def _add_page_title(
 @cache_resource
 def get_icons() -> dict[str, str]:
     emoji_path = Path(__file__).parent / "emoji.json"
-    return json.loads(emoji_path.read_text())
+    return json.loads(emoji_path.read_text(encoding="utf-8"))
 
 
 def translate_icon(icon: str) -> str:
@@ -187,7 +190,7 @@ def to_dict(self) -> dict[str, str | bool]:
             "page_script_hash": self.page_hash,
             "page_name": self.page_name,
             "icon": self.page_icon,
-            "script_path": str(self.page_path),
+            "script_path": str(self.page_path.absolute()),
             "is_section": self.is_section,
             "in_section": self.in_section,
             "relative_page_hash": self.relative_page_hash,
@@ -241,6 +244,16 @@ def _show_pages(pages: list[Page]):
 
     _on_pages_changed.send()
 
+    rt = runtime.get_instance()
+
+    if hasattr(rt, "_script_cache"):
+        sleep(1)  # Not sure why this is needed, but it seems to be.
+
+        rt._sources_watcher = LocalSourcesWatcher(rt._main_script_path)
+        rt._sources_watcher.register_file_change_callback(
+            lambda _: rt._script_cache.clear()
+        )
+
 
 show_pages = _gather_metrics("st_pages.show_pages", _show_pages)
 

tests/test_edits.py

@@ -0,0 +1,98 @@
+from contextlib import contextmanager
+from pathlib import Path
+from time import sleep
+
+import pytest
+from playwright.sync_api import Page, expect
+
+LOCAL_TEST = False
+
+PORT = "8503" if LOCAL_TEST else "8699"
+
+
+@contextmanager
+def run_streamlit():
+    """Run the streamlit app at examples/streamlit_app.py on port 8599"""
+    import subprocess
+
+    if LOCAL_TEST:
+        try:
+            yield 1
+        finally:
+            pass
+    else:
+        p = subprocess.Popen(
+            [
+                "streamlit",
+                "run",
+                "example_app/streamlit_app.py",
+                "--server.port",
+                PORT,
+                "--server.headless",
+                "true",
+                "--server.runOnSave",
+                "true",
+            ]
+        )
+
+        sleep(5)
+
+        try:
+            yield 1
+        finally:
+            p.kill()
+
+
+@pytest.fixture(scope="module", autouse=True)
+def before_module():
+    # Run the streamlit app before each module
+    with run_streamlit():
+        yield
+
+    Path("example_app/example_one.py").write_text(
+        """import streamlit as st
+from st_pages import add_page_title
+
+add_page_title(layout="wide")
+
+st.write("This is just a sample page!")
+"""
+    )
+
+
+@pytest.fixture(scope="function", autouse=True)
+def before_test(page: Page):
+    page.goto(f"localhost:{PORT}")
+
+    yield
+
+    TEST_TEXT = "THIS IS A TEST"
+
+    current_text = Path("example_app/example_one.py").read_text()
+
+    with Path("example_app/example_one.py").open("w") as f:
+        f.write(current_text.replace(f"\nst.write('{TEST_TEXT}')\n", ""))
+
+
+def test_page_update(page: Page):
+    TEST_TEXT = "THIS IS A TEST"
+    page.get_by_role("link", name="Example One").click()
+
+    expect(page).to_have_title("Example One")
+
+    page.screenshot(path="screenshot-edits0.png", full_page=True)
+
+    try:
+        expect(page.get_by_text(TEST_TEXT)).not_to_be_visible()
+    except Exception as e:
+        page.screenshot(path="screenshot-edits1.png", full_page=True)
+        raise e
+
+    with Path("example_app/example_one.py").open("a") as f:
+        f.write(f"\nst.write('{TEST_TEXT}')\n")
+
+    try:
+        expect(page.get_by_text(TEST_TEXT)).to_be_visible()
+    except Exception as e:
+        page.screenshot(path="screenshot-edits2.png", full_page=True)
+        raise e

tests/test_frontend_sections.py

@@ -83,6 +83,8 @@ def test_deprecation_warning(page: Page):
 
 
 def test_in_section_false(page: Page):
+    sleep(3)
+    page.screenshot(path="screenshot_sections2.png")
     bbox_not_in_section = (
         page.get_by_role("link", name="Example Five")
         .get_by_text("Example Five")
@@ -99,7 +101,11 @@ def test_in_section_false(page: Page):
 
     # Check that the in_section=False page is at least 10 pixels to the left of the
     # in_section=True page
-    assert bbox_not_in_section["x"] < bbox_in_section["x"] - 10
+    try:
+        assert bbox_not_in_section["x"] < bbox_in_section["x"] - 10
+    except AssertionError as e:
+        page.screenshot(path="screenshot_sections3.png")
+        raise e
 
 
 def test_page_hiding(page: Page):