main
md 46 lines 1.89 KB
Rendered Raw
1 # browser.py DOX
2
3 ## Purpose
4
5 - Own the `browser.py` helper module.
6 - This module holds shared browser helper state used by browser-facing integrations.
7 - Keep this file-level DOX profile synchronized with `browser.py` because this directory is intentionally flat.
8
9 ## Ownership
10
11 - `browser.py` owns the runtime implementation.
12 - `browser.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation.
13
14 ## Runtime Contracts
15
16 - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together.
17 - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change.
18 - Observed side-effect areas: filesystem reads, filesystem deletion.
19
20 ## Key Concepts
21
22 - This module is primarily declarative or delegates behavior through classes/imported objects.
23 - Keep request/response, tool, or helper semantics documented here at the same time as source changes.
24
25 ## Work Guidance
26
27 - Preserve public helper APIs used by core code and plugins unless every caller is updated.
28 - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded.
29 - Prefer adding cohesive helper functions here only when behavior is reused across modules.
30
31 ## Verification
32
33 - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers.
34 - Related tests observed by source search:
35 - `tests/test_a0_connector_prompt_gating.py`
36 - `tests/test_browser_agent_regressions.py`
37 - `tests/test_download_toast_regressions.py`
38 - `tests/test_host_browser_connector.py`
39 - `tests/test_oauth_gemini_api.py`
40 - `tests/test_oauth_providers.py`
41 - `tests/test_oauth_static.py`
42 - `tests/test_oauth_xai_grok.py`
43
44 ## Child DOX Index
45
46 No child DOX files.