 ginuerzh
|
31878a72ec
|
docs(handler/tunnel): add architecture documentation and fix observeStats event loss
- Add package-level architecture doc in handler.go covering:
- NAT traversal reverse proxy architecture
- CmdBind/CmdConnect roles and data flow
- Connector lifecycle and waitClose semantics
- Entrypoint protocol dispatch (first-byte sniffing)
- SD fallback behavior
- Add data-flow-oriented doc comments to all business files:
- entrypoint.go: protocol dispatch, dial flow
- connector.go: Connector/ConnectorPool semantics
- dialer.go: two-phase dial strategy
- tunnel.go: MaxWeight semantics, selection algorithm
- bind.go: 6-step CmdBind flow
- connect.go: CmdConnect flow with relay framing
- ephttp.go, eptls.go, eprelay.go: per-protocol entrypoint flow
- Fix observeStats: after successful error retry, also flush new events
instead of skipping the current tick (handler.go:261-271)
- Add test for observeStats retry-then-flush (handler_test.go)
|
2026-06-02 18:36:52 +08:00 |
|
|
ginuerzh
|
e791ba47e2
|
refactor(handler/tunnel): split 794-line entrypoint.go into 6 files, fix 3 bugs, add 48 tests
Breaking Change: moves Connector, ConnectorPool, parseTunnelID from
tunnel.go into dedicated connector.go and id.go.
Bug Fixes:
- dialer.go: clear stale retry err so SD fallback is not masked (nil err
from pool.Get() left previous iteration's error live)
- connect.go: check WriteTo errors in both mux and non-mux paths
- eprelay.go: use fresh relay.Response for features sent over mux
(previously reused same resp struct after resp.WriteTo(muxConn))
Refactor:
- entrypoint.go: split ~790 lines into 6 files (ephttp, eptls, eprelay,
epwebsocket, eplistener, entrypointsvc), moved to dedicated package
- handler.go: moved initEntrypoints/createEntrypointService to
entrypointsvc.go
- tunnel.go: moved Connector/ConnectorPool/parseTunnelID to
connector.go and id.go
- connect.go: moved entrypoint-originated handleConnect to eprelay.go
(handler-side handleConnect kept in connect.go)
Tests (48 new, 88 total):
- id_test.go: parseTunnelID variants (empty, UUID, private '$', invalid)
- tunnel_test.go: Tunnel lifecycle (AddConnector, GetConnector
weighted/closed filtering, CloseOnIdle, clean),
Connector (NewConnector nil-opts, GetConn nil/closed session, Close,
IsClosed), ConnectorPool (Add/Get/Close, idle cleanup, concurrency)
- dialer_test.go: SD error paths (sd.Get error, empty address)
- handler_test.go: observeStats (nil observer, cancelled context loop),
initEntrypoints (no entrypoints configured)
- helpers_test.go: testLogger, fakeConn for handler tests
- eprelay_test.go: handleConnect ingress/dial/SD round-trip
|
2026-06-01 22:20:43 +08:00 |
|