Skip to content

Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.

fix(browser): read persisted storage state as UTF-8

r266-tech33b4c2c44ddf
diff --git a/browser_use/browser/watchdogs/storage_state_watchdog.py b/browser_use/browser/watchdogs/storage_state_watchdog.py
index 25ce39806..7efb8a3a1 100644
--- a/browser_use/browser/watchdogs/storage_state_watchdog.py
+++ b/browser_use/browser/watchdogs/storage_state_watchdog.py
@@ -186,7 +186,7 @@ class StorageStateWatchdog(BaseWatchdog):
merged_state = storage_state
if json_path.exists():
try:
- existing_state = json.loads(json_path.read_text())
+ existing_state = json.loads(json_path.read_text(encoding='utf-8'))
merged_state = self._merge_storage_states(existing_state, dict(storage_state))
except Exception as e:
self.logger.error(f'[StorageStateWatchdog] Failed to merge with existing state: {e}')
@@ -244,7 +244,7 @@ class StorageStateWatchdog(BaseWatchdog):
# Read the storage state file asynchronously
import anyio
- content = await anyio.Path(load_source).read_text()
+ content = await anyio.Path(load_source).read_text(encoding='utf-8')
storage = json.loads(content)
# Apply cookies if present
diff --git a/tests/ci/test_storage_state_watchdog.py b/tests/ci/test_storage_state_watchdog.py
new file mode 100644
index 000000000..ab8814418
--- /dev/null
+++ b/tests/ci/test_storage_state_watchdog.py
@@ -0,0 +1,107 @@
+import json
+from pathlib import Path
+from unittest.mock import AsyncMock, MagicMock
+
+import anyio
+import pytest
+
+from browser_use.browser.watchdogs.storage_state_watchdog import StorageStateWatchdog
+
+
+def _make_watchdog() -> tuple[StorageStateWatchdog, MagicMock]:
+ browser_session = MagicMock()
+ browser_session.cdp_client = object()
+ browser_session.get_or_create_cdp_session = AsyncMock(return_value=object())
+ browser_session._cdp_get_storage_state = AsyncMock(return_value={'cookies': [], 'origins': []})
+ browser_session._cdp_set_cookies = AsyncMock()
+ browser_session._cdp_add_init_script = AsyncMock()
+
+ watchdog = StorageStateWatchdog.model_construct(event_bus=MagicMock(), browser_session=browser_session)
+ return watchdog, browser_session
+
+
+async def test_load_storage_state_reads_utf8(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+ unicode_value = 'zażółć gęślą jaźń'
+ storage_path = tmp_path / 'storage-state.json'
+ storage_path.write_text(
+ json.dumps(
+ {
+ 'cookies': [],
+ 'origins': [
+ {
+ 'origin': 'https://example.com',
+ 'localStorage': [{'name': 'greeting', 'value': unicode_value}],
+ }
+ ],
+ },
+ ensure_ascii=False,
+ ),
+ encoding='utf-8',
+ )
+
+ encodings: list[str | None] = []
+ original_read_text = anyio.Path.read_text
+
+ async def track_encoding(path: anyio.Path, encoding: str | None = None, errors: str | None = None) -> str:
+ encodings.append(encoding)
+ return await original_read_text(path, encoding=encoding, errors=errors)
+
+ monkeypatch.setattr(anyio.Path, 'read_text', track_encoding)
+ watchdog, browser_session = _make_watchdog()
+
+ await watchdog._load_storage_state(str(storage_path))
+
+ assert encodings == ['utf-8']
+ browser_session._cdp_add_init_script.assert_awaited_once()
+ assert json.dumps(unicode_value) in browser_session._cdp_add_init_script.await_args.args[0]
+
+
+async def test_save_storage_state_reads_existing_file_as_utf8(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+ unicode_value = '你好,世界'
+ storage_path = tmp_path / 'storage-state.json'
+ storage_path.write_text(
+ json.dumps(
+ {
+ 'cookies': [
+ {
+ 'name': 'greeting',
+ 'value': unicode_value,
+ 'domain': 'example.com',
+ 'path': '/',
+ }
+ ],
+ 'origins': [],
+ },
+ ensure_ascii=False,
+ ),
+ encoding='utf-8',
+ )
+
+ encodings: list[str | None] = []
+ original_read_text = Path.read_text
+
+ def track_encoding(path: Path, encoding: str | None = None, errors: str | None = None) -> str:
+ if path == storage_path.resolve():
+ encodings.append(encoding)
+ return original_read_text(path, encoding=encoding, errors=errors)
+
+ monkeypatch.setattr(Path, 'read_text', track_encoding)
+ watchdog, browser_session = _make_watchdog()
+ browser_session._cdp_get_storage_state.return_value = {
+ 'cookies': [
+ {
+ 'name': 'current',
+ 'value': 'new-value',
+ 'domain': 'example.com',
+ 'path': '/',
+ }
+ ],
+ 'origins': [],
+ }
+
+ await watchdog._save_storage_state(str(storage_path))
+
+ assert encodings == ['utf-8']
+ saved_state = json.loads(original_read_text(storage_path, encoding='utf-8'))
+ saved_cookies = {cookie['name']: cookie['value'] for cookie in saved_state['cookies']}
+ assert saved_cookies == {'greeting': unicode_value, 'current': 'new-value'}