| 1 | # tunnel_manager.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `tunnel_manager.py` helper module. |
| 6 | - This module selects and coordinates configured tunnel providers. |
| 7 | - Keep this file-level DOX profile synchronized with `tunnel_manager.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `tunnel_manager.py` owns the runtime implementation. |
| 12 | - `tunnel_manager.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Classes: |
| 14 | - `TunnelManager` (no explicit base class) |
| 15 | - `get_instance(cls)` |
| 16 | - `get_notifications(self)` |
| 17 | - `get_last_error(self)` |
| 18 | - `start_tunnel(self, port=..., provider=...)` |
| 19 | - `stop_tunnel(self)` |
| 20 | - `get_tunnel_url(self)` |
| 21 | - Top-level functions: |
| 22 | - `normalize_provider(provider)` |
| 23 | - Notable constants/configuration names: `SUPPORTED_TUNNEL_PROVIDERS`, `TUNNEL_PROVIDER_ALIASES`. |
| 24 | |
| 25 | ## Runtime Contracts |
| 26 | |
| 27 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 28 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 29 | - Observed side-effect areas: tunnel state. |
| 30 | - Imported dependency areas include: `collections`, `flaredantic`, `helpers.cloudflare_tunnel`, `helpers.microsoft_tunnel`, `helpers.print_style`, `helpers.serveo_tunnel`, `helpers.tailscale_tunnel`, `helpers.tunnel_common`, `threading`, `time`. |
| 31 | |
| 32 | ## Key Concepts |
| 33 | |
| 34 | - Important called helpers/classes observed in the source: `strip.lower`, `threading.Lock`, `join`, `ValueError`, `deque`, `self.notifications.clear`, `ServeoTunnelHelper`, `self._ensure_subscribed`, `strip`, `notifier.subscribe`, `CloudflareTunnel`, `MicrosoftDevTunnel`, `TailscaleTunnel`, `normalize_provider`, `threading.Thread`, `tunnel_thread.start`, `cls`, `event_value`, `PrintStyle.error`, `self._append_notification`. |
| 35 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 36 | |
| 37 | ## Work Guidance |
| 38 | |
| 39 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 40 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 41 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 42 | |
| 43 | ## Verification |
| 44 | |
| 45 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 46 | - Related tests observed by source search: |
| 47 | - `tests/test_tunnel_remote_link.py` |
| 48 | |
| 49 | ## Child DOX Index |
| 50 | |
| 51 | No child DOX files. |