mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-07 09:24:09 +00:00
a38a3e0226
* refactor(mesh): extract shared TCP stream switchboard
Pull the `tcp_open` / `tcp_open_ack` / `tcp_open_reverse` / `tcp_close`
+ `TcpData` handling out of the pilot agent into a reusable module so a
second caller (the upcoming proxy-mode WS handler) can run the same
frame parser, stream allocator, idle timers, and Compose-label
resolver. One parser, two callers, zero drift on a
security-sensitive protocol surface.
The pilot agent keeps its public `openMeshTcpStream` API and delegates
to a per-connection switchboard constructed in `connect()` and torn
down in `cleanupAfterDisconnect`. Existing reverse-stream and resolver
tests are rewritten to exercise the shared module directly.
* feat(mesh): route mesh traffic over Distributed API remotes
Sencho Mesh now works against remotes in Distributed API mode in
addition to Pilot Agent mode. Central opens a short-lived WebSocket
tunnel to the remote's new `/api/mesh/proxy-tunnel` endpoint on demand
and tears it down after 5 minutes of idle (configurable via
`SENCHO_MESH_PROXY_TUNNEL_IDLE_MS`). Mesh dispatch is mode-agnostic at
the routing layer; `PilotTunnelManager.ensureBridge` resolves an
existing tunnel or asks the new `MeshProxyTunnelDialer` to dial.
The Routing tab badges now use a `reachableMode` classifier: `★ Local`
for local, `pilot offline` red badge for a pilot with a down tunnel,
and a new `unreachable` red badge surfacing the specific reason
(missing token, scope not full-admin, TLS failure, remote does not
support proxy mesh). Distributed API remotes with valid credentials
show no negative badge; the tunnel opens on first dial.
Auth: the proxy-tunnel WS upgrade requires an `Authorization: Bearer`
API token with the `full-admin` scope. Lower-scoped tokens are
rejected at upgrade time so a leaked read-only token cannot reach the
mesh data plane.
Bidirectional: the proxy-mode WS handler registers itself as the
local `MeshService` reverse dialer (compare-and-swap), so meshed
containers on a Distributed API remote can dial cross-node aliases
via `tcp_open_reverse` over the same tunnel. Cross-node relays
(`PilotTunnelBridge.acceptReverseRelay`) await `ensureBridge` so
proxy-to-proxy mesh works without standing tunnels.
* docs(mesh): describe Distributed API mesh and unreachable troubleshooting
Refresh the user-facing mesh documentation to reflect that mesh works
over both Pilot Agent and Distributed API remotes. Adds a
Troubleshooting accordion entry for the new `unreachable` Routing tab
badge so operators can match a tooltip reason ("api token rejected
(scope must be full-admin)", "remote does not support proxy mesh",
"TLS handshake failed", "api_url not set", "api token missing") to a
concrete fix.
* refactor(mesh): apply /simplify review findings
Five cleanups surfaced by the post-implementation code review pass.
No behaviour change for fleets running on `main`; only internal
structure improves.
- **Deterministic container IP shared.** Extract the compose-default
network preference (`pickContainerIp`) and the conventional-name
fast path (`lookupContainerIp`) into `backend/src/mesh/containerLookup.ts`.
Both `MeshService.resolveContainerIp` (existing same-node fast
path) and the switchboard's `resolveByComposeLabels` (proxy/pilot
inbound dial) now use the same logic. Earlier the switchboard
helper grabbed the first `Object.values(Networks)` IP, which
could flip across daemon versions on multi-network containers;
fixed.
- **WS URL upgrade extracted.** New `backend/src/utils/wsUrl.ts`
exposes `httpUrlToWs(baseUrl)` that maps `http://` to `ws://` and
`https://` to `wss://`. Used in both `pilot/agent.ts` and the
proxy-tunnel dialer. The previous inline `replace(/^http/, 'ws')`
silently downgraded `https://` to `ws://` (cleartext).
- **`computeReachable` takes the pre-fetched node.** `getStatus`
already iterated `db.getNodes()`; the helper previously re-queried
by id per node (N+1 reads). Pass the row in.
- **Reachable-reason ternary -> const map.** Replace the nested
ternary in `MeshService.computeReachable` with a
`Record<DialFailureCode, string>` lookup keyed on the dialer's
failure code.
- **Activity-type ternary -> const map.** Same flattening inside
`MeshProxyTunnelDialer.logActivity`.
All mesh tests pass (85/85). Full backend suite green (2126/2126).
* fix(mesh): cache proxy dial failures and contain WS handshake errors
`ensureBridge` now consults the recent-failure cache before dialing so a
continuous mesh workload against a misconfigured proxy-mode remote does
not produce one upgrade attempt per cross-node TCP open. `recordFailure`
emits at most one activity-log entry per cache window per (nodeId, code)
so a connect-loop on a single bad remote cannot flush the ring buffer.
Failure messages run through `redactSensitiveText` before reaching the
log so any embedded Bearer / JWT / inline-URL credentials are scrubbed.
`stop()` clears the inflight map and `dial()` checks `this.stopped`
between awaits so a shutdown does not leak a half-opened bridge.
When `awaitOpen` rejects (401, 4403, TLS), the dialer attaches a noop
'error' listener before calling `ws.close()`. Without it the ws library
emits a tail 'error' on a still-CONNECTING socket that propagates as an
unhandled exception. Surfaced by a live-network test against a real
proxy-mode peer.
Adds `mesh-proxy-tunnel-live.test.ts` (skipped unless MESH_AUDIT_URL
and MESH_AUDIT_TOKEN_FILE env vars are set) covering both the happy
path and the auth-rejected path against an actual remote Sencho.
* feat(mesh): instrument proxy tunnel observability
Adds three counters to `PilotMetrics`:
- `proxy_bridges_total` (incremented on `registerProxyBridge` success)
- `proxy_dials_failed` (every failed dial attempt, not deduped)
- `proxy_idle_closes` (idle-sweep teardowns)
All three surface automatically via `GET /api/system/pilot-tunnels`
since the route returns the full `Counters` snapshot.
Gates two pre-existing always-on `console.warn` calls in
`tcpStreamSwitchboard.ts` (mid-stream socket errors and Docker resolve
failures) behind `isDebugEnabled()`. Both fire on per-stream events and
would otherwise violate the diagnostic-log safety rule under load.
Adds `mesh-tcp-stream-switchboard.test.ts` covering the forward
`tcp_open` path: real localhost dial, resolver errors (no_target,
denied), per-tunnel cap saturation, frame-routing fall-through
invariants, `tcp_close` socket teardown.
Drops `MESH_CONNECT_TIMEOUT_MS` from the public surface; only the
switchboard itself uses it.
* fix(mesh): tighten Routing tab unreachable handling
`RoutingNodeCard.tsx`: the **Add stack to mesh** button now disables
when `reachableMode === 'unreachable'`, matching the existing
TogglePill behavior. Without this, an operator on an unreachable node
could open the opt-in sheet, confirm, and watch the redeploy proceed
against a target whose mesh data plane will silently fail to route.
Also drops the leftover `status.nodeId !== -1` guard on the pilot-
offline badge.
`MeshService.ts`: renames `isMeshReachable` to `isMeshConfigured` with
the new predicate that returns true for proxy-mode remotes whose creds
are valid (the tunnel is opened on demand). `getRouteDiagnostic` now
distinguishes "routable" (configured) from "pilotLive" (live tunnel
state, only meaningful for pilot mode); without the split, every idle
proxy-mode route would report `tunnel down`.
`MeshService.setReverseDialer` warns when the unconditional install
path silently overwrites a non-null current dialer. By topology a
Sencho is either pilot or central, so the branch flags a misconfigured
deployment rather than an expected race.
Drops the dead `export { ReverseTcpStreamHandle }` re-export from
`pilot/agent.ts`; its only consumer imports straight from
`mesh/tcpStreamSwitchboard.ts`. Fixes a stale doc comment in
`MeshService.ts` that referenced the wrong source file.
Adds `mesh-proxy-tunnel-handler.test.ts` covering the WS handler
lifecycle: pilot-mode 404 rejection, post-upgrade reverse-dialer
install, concurrent-upgrade 1013 rejection (single-tenant slot), and
error-path teardown.
Updates the troubleshooting accordion in the user docs to mention the
disabled-state behavior.
* fix(mesh): close ESLint and CodeQL findings on the proxy-tunnel diag logs
Remove the unused `reverseDialer` local in `meshProxyTunnel.ts`; the
closure target is `localDialer` above and this assignment was always
dead. Strip line breaks inline on the three `MeshProxyTunnelDialer`
diag log lines so CodeQL `js/log-injection` data flow recognises the
sanitisation that `sanitizeForLog` already performs.
No behaviour change; the diag logs render the same characters they
do today.
85 lines
3.4 KiB
TypeScript
85 lines
3.4 KiB
TypeScript
/**
|
|
* Shared Compose-container lookup for mesh routing. Both
|
|
* `MeshService.resolveContainerIp` (same-node fast path) and the
|
|
* `TcpStreamSwitchboard` (inbound `tcp_open` handler) need to translate
|
|
* a stack/service pair to a single deterministic IPv4 address; their
|
|
* earlier implementations diverged on the network-preference rule,
|
|
* which caused flaky resolution on containers attached to multiple
|
|
* networks (compose `_default` plus `sencho_mesh`, for example).
|
|
*
|
|
* `pickContainerIp` is the canonical preference rule. `lookupContainerIp`
|
|
* runs the conventional-name fast path first (`<stack>-<service>-1`)
|
|
* before falling back to a compose-label container list.
|
|
*/
|
|
interface ContainerInspectInfo {
|
|
NetworkSettings?: {
|
|
Networks?: Record<string, { IPAddress?: string } | undefined>;
|
|
IPAddress?: string;
|
|
};
|
|
}
|
|
|
|
interface ContainerListItem {
|
|
Id: string;
|
|
}
|
|
|
|
interface DockerodeLike {
|
|
getContainer(id: string): { inspect(): Promise<ContainerInspectInfo> };
|
|
listContainers(opts: unknown): Promise<unknown[]>;
|
|
}
|
|
|
|
/**
|
|
* Pick a deterministic IPv4 for a container. Prefer the compose default
|
|
* network (`<stack>_default` or any network named `<stack>_*`), then any
|
|
* other attached network, then the legacy `NetworkSettings.IPAddress`.
|
|
* Without this preference order, `Object.values(Networks)` ordering on
|
|
* multi-network containers varies across daemon versions and can make
|
|
* same-node forwarding flaky on a redeploy.
|
|
*/
|
|
export function pickContainerIp(stackName: string, info: ContainerInspectInfo): string | null {
|
|
const networks = info.NetworkSettings?.Networks ?? {};
|
|
const composeDefault = networks[`${stackName}_default`];
|
|
if (composeDefault?.IPAddress) return composeDefault.IPAddress;
|
|
for (const [name, net] of Object.entries(networks)) {
|
|
if (name.startsWith(`${stackName}_`) && net?.IPAddress) return net.IPAddress;
|
|
}
|
|
for (const net of Object.values(networks)) {
|
|
if (net?.IPAddress) return net.IPAddress;
|
|
}
|
|
return info.NetworkSettings?.IPAddress || null;
|
|
}
|
|
|
|
/**
|
|
* Resolve a stack + service to a container IPv4. Tries the conventional
|
|
* compose name first, then falls back to a label-filtered list. Returns
|
|
* null when no container matches or the matching container has no IP on
|
|
* any attached network.
|
|
*
|
|
* Errors propagate. Callers that only need a single string-or-null
|
|
* surface should wrap with a try/catch (`MeshService.resolveContainerIp`
|
|
* does this); callers that need to distinguish "Docker errored" from
|
|
* "no container matched" use the thrown error to pick the right code.
|
|
*/
|
|
export async function lookupContainerIp(
|
|
docker: DockerodeLike,
|
|
stack: string,
|
|
service: string,
|
|
): Promise<string | null> {
|
|
const conventional = `${stack}-${service}-1`;
|
|
const fast = await docker.getContainer(conventional).inspect().catch(() => null);
|
|
const fastIp = fast ? pickContainerIp(stack, fast) : null;
|
|
if (fastIp) return fastIp;
|
|
|
|
const containers = (await docker.listContainers({
|
|
all: true,
|
|
filters: {
|
|
label: [
|
|
`com.docker.compose.project=${stack}`,
|
|
`com.docker.compose.service=${service}`,
|
|
],
|
|
},
|
|
})) as ContainerListItem[];
|
|
if (containers.length === 0) return null;
|
|
const info = await docker.getContainer(containers[0].Id).inspect().catch(() => null);
|
|
return info ? pickContainerIp(stack, info) : null;
|
|
}
|