| 1 | # rfc.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `rfc.py` helper module. |
| 6 | - This module implements remote function call dispatch and serialization. |
| 7 | - Keep this file-level DOX profile synchronized with `rfc.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `rfc.py` owns the runtime implementation. |
| 12 | - `rfc.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Classes: |
| 14 | - `RFCInput` (`TypedDict`) |
| 15 | - `RFCCall` (`TypedDict`) |
| 16 | - Top-level functions: |
| 17 | - `async call_rfc(url: str, password: str, module: str, function_name: str, args: list, kwargs: dict)` |
| 18 | - `async handle_rfc(rfc_call: RFCCall, password: str)` |
| 19 | - `async _call_function(module: str, function_name: str, *args, **kwargs)` |
| 20 | - `_get_function(module: str, function_name: str)` |
| 21 | - `async _send_json_data(url: str, data)` |
| 22 | |
| 23 | ## Runtime Contracts |
| 24 | |
| 25 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 26 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 27 | - Observed side-effect areas: filesystem writes, network calls, settings/state persistence, secret handling. |
| 28 | - Imported dependency areas include: `aiohttp`, `helpers`, `importlib`, `inspect`, `json`, `typing`. |
| 29 | |
| 30 | ## Key Concepts |
| 31 | |
| 32 | - Important called helpers/classes observed in the source: `RFCInput`, `RFCCall`, `json.loads`, `_get_function`, `inspect.iscoroutinefunction`, `importlib.import_module`, `_send_json_data`, `crypto.verify_data`, `Exception`, `_call_function`, `func`, `aiohttp.ClientSession`, `json.dumps`, `crypto.hash_data`, `session.post`, `response.json`, `response.text`. |
| 33 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 34 | |
| 35 | ## Work Guidance |
| 36 | |
| 37 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 38 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 39 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 40 | |
| 41 | ## Verification |
| 42 | |
| 43 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 44 | - No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check. |
| 45 | |
| 46 | ## Child DOX Index |
| 47 | |
| 48 | No child DOX files. |