| 1 | # serveo_tunnel.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `serveo_tunnel.py` helper module. |
| 6 | - This module implements Serveo tunnel provider behavior. |
| 7 | - Keep this file-level DOX profile synchronized with `serveo_tunnel.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `serveo_tunnel.py` owns the runtime implementation. |
| 12 | - `serveo_tunnel.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Classes: |
| 14 | - `ServeoTunnelHelper` (`FlaredanticTunnelHelper`) |
| 15 | - `build_tunnel(self)` |
| 16 | |
| 17 | ## Runtime Contracts |
| 18 | |
| 19 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 20 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 21 | - Observed side-effect areas: settings/state persistence, tunnel state. |
| 22 | - Imported dependency areas include: `flaredantic`, `helpers.tunnel_common`. |
| 23 | |
| 24 | ## Key Concepts |
| 25 | |
| 26 | - Important called helpers/classes observed in the source: `ServeoConfig`, `ServeoTunnel`. |
| 27 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 28 | |
| 29 | ## Work Guidance |
| 30 | |
| 31 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 32 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 33 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 34 | |
| 35 | ## Verification |
| 36 | |
| 37 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 38 | - Related tests observed by source search: |
| 39 | - `tests/test_tunnel_remote_link.py` |
| 40 | |
| 41 | ## Child DOX Index |
| 42 | |
| 43 | No child DOX files. |