mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-30 21:52:22 +00:00
946db9df52
The mesh proxy-tunnel WS handler was gated on full-admin api_token scope only, so node_proxy JWTs (the credential the Add Remote Node dialog tells operators to generate via Settings -> Nodes -> Generate Token) were silently rejected with HTTP 403. Operators followed the dialog's instructions, enrolled the node cleanly, saw reachableMode='proxy' with no negative badge, opted a stack into mesh, watched the redeploy complete, and only then discovered no bytes flow. node_proxy already authorizes every /api/* surface on the remote (deploy, exec, host console, filesystem), which is a strict superset of what the mesh proxy-tunnel does. Gating mesh more strictly was theatre, not security, and it created a UX trap with no in-product signal pointing at the scope mismatch. Change the upgrade dispatcher to accept any machine-to-machine credential: node_proxy JWT or full-admin api_token. Session cookies and restricted api_token scopes (read-only, deploy-only) remain rejected through the same paths as before. Adds positive/negative coverage in upgrade-order.test.ts for all four credential shapes so the gate stays pinned against future re-tightening. Updates user-facing copy in the mesh docs and Settings -> API Tokens description so the documented path matches the actual code. If we ever introduce a demoted node_proxy variant (audit-only, read-only fleet member), the right move is differentiated node_proxy scope claims inside the tunnel JWT (tracker F-A3), not requiring a separate token type for mesh.
1817 lines
80 KiB
TypeScript
1817 lines
80 KiB
TypeScript
import net from 'net';
|
|
import path from 'path';
|
|
import fs from 'fs/promises';
|
|
import { EventEmitter } from 'events';
|
|
import * as YAML from 'yaml';
|
|
import { ComposeService } from './ComposeService';
|
|
import { DatabaseService } from './DatabaseService';
|
|
import DockerController from './DockerController';
|
|
import { FileSystemService } from './FileSystemService';
|
|
import { LicenseService } from './LicenseService';
|
|
import { PROXY_TIER_HEADER, PROXY_VARIANT_HEADER } from './license-headers';
|
|
import { MeshForwarder, type MeshForwarderHost } from './MeshForwarder';
|
|
import { NodeRegistry } from './NodeRegistry';
|
|
import { PilotTunnelManager } from './PilotTunnelManager';
|
|
import { MeshProxyTunnelDialer, type DialFailureCode } from './MeshProxyTunnelDialer';
|
|
import { generateOverrideYaml, MeshAlias, SENCHO_MESH_NETWORK } from './MeshComposeOverride';
|
|
import { lookupContainerIp } from '../mesh/containerLookup';
|
|
import { sanitizeForLog } from '../utils/safeLog';
|
|
import { isPathWithinBase, isValidStackName } from '../utils/validation';
|
|
import { PORT as SENCHO_LISTEN_PORT } from '../helpers/constants';
|
|
import { assertPolicyGateAllows, buildSystemPolicyGateOptions } from '../helpers/policyGate';
|
|
|
|
const ACTIVITY_BUFFER_SIZE = 1000;
|
|
const ALIAS_REFRESH_INTERVAL_MS = 60_000;
|
|
const PROBE_TIMEOUT_MS = 5_000;
|
|
const SLOW_PROBE_THRESHOLD_MS = 500;
|
|
const DEFAULT_MESH_SUBNET = '172.30.0.0/24';
|
|
|
|
const REACHABLE_REASON: Record<DialFailureCode, string> = {
|
|
auth_failed: 'api token rejected by remote',
|
|
endpoint_not_found: 'remote does not support proxy mesh',
|
|
tls_failed: 'TLS handshake failed',
|
|
no_target: 'proxy target missing',
|
|
network_error: 'remote unreachable',
|
|
};
|
|
|
|
/**
|
|
* Returns the static IPv4 address Sencho will pin itself to on the mesh
|
|
* Docker network: `<network address> + 2`. The Docker daemon assigns
|
|
* `<network> + 1` to the bridge gateway, so `+2` is the first usable host
|
|
* address. For the default `172.30.0.0/24` this is `172.30.0.2`. Throws
|
|
* on invalid CIDR or a prefix too narrow to host two addresses.
|
|
*/
|
|
export function getSenchoIpFromSubnet(subnet: string): string {
|
|
const cidr = subnet.trim().match(/^(\d+)\.(\d+)\.(\d+)\.(\d+)\/(\d+)$/);
|
|
if (!cidr) throw new Error(`Invalid mesh subnet CIDR: ${subnet}`);
|
|
const octets = [Number(cidr[1]), Number(cidr[2]), Number(cidr[3]), Number(cidr[4])];
|
|
const prefix = Number(cidr[5]);
|
|
if (octets.some((o) => o < 0 || o > 255) || prefix < 8 || prefix > 30) {
|
|
throw new Error(`Invalid mesh subnet CIDR: ${subnet}`);
|
|
}
|
|
const ipInt = (octets[0] << 24) | (octets[1] << 16) | (octets[2] << 8) | octets[3];
|
|
const mask = prefix === 0 ? 0 : (0xffffffff << (32 - prefix)) >>> 0;
|
|
const network = (ipInt & mask) >>> 0;
|
|
const sencho = (network + 2) >>> 0;
|
|
return [
|
|
(sencho >>> 24) & 0xff,
|
|
(sencho >>> 16) & 0xff,
|
|
(sencho >>> 8) & 0xff,
|
|
sencho & 0xff,
|
|
].join('.');
|
|
}
|
|
|
|
export type MeshActivitySource = 'pilot' | 'mesh';
|
|
export type MeshActivityLevel = 'info' | 'warn' | 'error';
|
|
export type MeshActivityType =
|
|
| 'route.dispatch' | 'route.resolve.ok' | 'route.resolve.denied'
|
|
| 'tunnel.open' | 'tunnel.fail' | 'tunnel.backpressure'
|
|
| 'opt_in' | 'opt_out'
|
|
| 'mesh.enable' | 'mesh.disable'
|
|
| 'mesh.override.preserved'
|
|
| 'probe.ok' | 'probe.fail'
|
|
| 'forwarder.listen' | 'forwarder.unlisten' | 'forwarder.error'
|
|
| 'proxy-tunnel.open.ok' | 'proxy-tunnel.open.fail' | 'proxy-tunnel.close';
|
|
|
|
export interface MeshActivityEvent {
|
|
ts: number;
|
|
source: MeshActivitySource;
|
|
level: MeshActivityLevel;
|
|
type: MeshActivityType;
|
|
nodeId?: number;
|
|
alias?: string;
|
|
streamId?: number;
|
|
message: string;
|
|
details?: Record<string, unknown>;
|
|
}
|
|
|
|
export interface MeshGlobalAlias {
|
|
/** `<service>.<stack>.<nodeName>.sencho` */
|
|
host: string;
|
|
nodeId: number;
|
|
nodeName: string;
|
|
stackName: string;
|
|
serviceName: string;
|
|
port: number;
|
|
}
|
|
|
|
export interface MeshTarget {
|
|
nodeId: number;
|
|
stack: string;
|
|
service: string;
|
|
port: number;
|
|
alias: string;
|
|
}
|
|
|
|
export interface MeshRegenFailure {
|
|
nodeId: number;
|
|
stackName: string;
|
|
message: string;
|
|
}
|
|
|
|
export interface MeshRegenSummary {
|
|
regenerated: number;
|
|
failures: MeshRegenFailure[];
|
|
skipped: boolean;
|
|
reason?: string;
|
|
}
|
|
|
|
/**
|
|
* How a node participates in mesh routing right now:
|
|
* - `local`: the Sencho serving this request.
|
|
* - `pilot`: a remote with a pilot agent. Live-tunnel state is captured
|
|
* separately in `pilotConnected`.
|
|
* - `proxy`: a remote that central reaches via the long-lived api_token.
|
|
* Mesh tunnels are opened on demand by `MeshProxyTunnelDialer`; the
|
|
* operator sees no badge while the configuration is sound.
|
|
* - `unreachable`: configuration or runtime problem keeps mesh traffic
|
|
* from flowing. `reachableReason` carries an actionable hint.
|
|
*/
|
|
export type MeshReachableMode = 'local' | 'pilot' | 'proxy' | 'unreachable';
|
|
|
|
export interface MeshNodeStatus {
|
|
nodeId: number;
|
|
nodeName: string;
|
|
enabled: boolean;
|
|
/** Forwarder state for the LOCAL node (the Sencho instance answering this request). Always `null` for any non-local node — fetching the remote forwarder state requires a cross-node call which lands in Phase B. */
|
|
localForwarderListening: boolean | null;
|
|
/**
|
|
* True iff a pilot tunnel is currently registered for this node. Only
|
|
* meaningful when `reachableMode === 'pilot'`. Kept for diagnostic
|
|
* surfaces; the Routing tab badge logic consumes `reachableMode` and
|
|
* ignores this field for proxy / local nodes.
|
|
* TODO: collapse into `reachableMode` (introduce `pilot_offline` value)
|
|
* once no remaining caller reads `pilotConnected` directly.
|
|
*/
|
|
pilotConnected: boolean;
|
|
/** Canonical reachability classification consumed by the Routing tab. */
|
|
reachableMode: MeshReachableMode;
|
|
/** Short, operator-facing reason when `reachableMode === 'unreachable'`. Null otherwise. */
|
|
reachableReason: string | null;
|
|
optedInStacks: string[];
|
|
activeStreamCount: number;
|
|
}
|
|
|
|
export interface MeshNodeDiagnostic {
|
|
nodeId: number;
|
|
forwarder: { listening: boolean; listenerCount: number };
|
|
pilot: { connected: boolean; bufferedAmount: number; lastSeen: number | null };
|
|
activeStreams: Array<{ streamId: number; alias?: string; bytesIn: number; bytesOut: number; ageMs: number }>;
|
|
aliasCache: Array<{ host: string; targetNodeId: number; port: number }>;
|
|
}
|
|
|
|
export interface MeshRouteDiagnostic {
|
|
alias: string;
|
|
target: MeshTarget | null;
|
|
pilot: { connected: boolean; lastSeen: number | null };
|
|
lastError: { ts: number; message: string } | null;
|
|
lastProbeMs: number | null;
|
|
state: 'healthy' | 'degraded' | 'unreachable' | 'tunnel down' | 'not authorized';
|
|
}
|
|
|
|
export interface MeshProbeResult {
|
|
ok: boolean;
|
|
latencyMs?: number;
|
|
where?: 'no_route' | 'pilot_tunnel' | 'agent_resolve' | 'agent_dial' | 'target_port';
|
|
code?: string;
|
|
message?: string;
|
|
}
|
|
|
|
interface ActiveStreamRecord {
|
|
streamId: number;
|
|
alias?: string;
|
|
bytesIn: number;
|
|
bytesOut: number;
|
|
openedAt: number;
|
|
}
|
|
|
|
/**
|
|
* Sencho Mesh orchestrator. Owns:
|
|
* - in-process TCP forwarder (`MeshForwarder`) that binds host-network
|
|
* listeners on alias ports. Replaces the prior separate sidecar
|
|
* container; one container per node now.
|
|
* - opt-in / opt-out persistence and cascading override regeneration
|
|
* - global alias aggregation (across the fleet via the existing HTTP
|
|
* proxy chain, see `inspectStackServices`)
|
|
* - cross-node TCP forwarding via `PilotTunnelManager` (central-side)
|
|
* - probe + diagnostics + activity ring buffer
|
|
*
|
|
* V1 limitations:
|
|
* - one cross-node alias per TCP port across the fleet (port-collision
|
|
* check at opt-in)
|
|
* - aliases resolve to Sencho's static IP on the internal `sencho_mesh`
|
|
* Docker bridge network. Meshed user services join `sencho_mesh` so
|
|
* that IP is reachable from inside their containers without any
|
|
* host-firewall coordination.
|
|
* - cross-node mesh routing is central → pilot in this phase. Pilot →
|
|
* central and pilot ↔ pilot via central relay land in Phase B.
|
|
*/
|
|
export class MeshService extends EventEmitter implements MeshForwarderHost {
|
|
private static instance: MeshService;
|
|
private started = false;
|
|
private aliasCache = new Map<string, MeshGlobalAlias>();
|
|
private aliasByPort = new Map<number, MeshGlobalAlias>();
|
|
// Populated on pilot nodes via the D-1 override push. Central's
|
|
// db.listMeshStacks() is authoritative on central; pilots have no
|
|
// mesh_stacks rows (C-3 design), so the push payload carries the alias
|
|
// data they need to bind forwarder listeners for the reverse direction.
|
|
private pilotAliasOverlay = new Map<string, MeshGlobalAlias[]>();
|
|
private activity: MeshActivityEvent[] = [];
|
|
private activeStreams = new Map<number, ActiveStreamRecord>();
|
|
private aliasRefreshTimer?: NodeJS.Timeout;
|
|
private routeErrorMap = new Map<string, { ts: number; message: string }>();
|
|
private routeLatencyMap = new Map<string, number>();
|
|
private activityListeners = new Set<(e: MeshActivityEvent) => void>();
|
|
private readonly forwarder: MeshForwarder;
|
|
private senchoIp: string | null = null;
|
|
private meshSubnet: string = DEFAULT_MESH_SUBNET;
|
|
private networkSetupError: string | null = null;
|
|
// On a pilot node, central's DB id for this node (e.g. 14). Used by
|
|
// handleAccept to decide same-node vs cross-node; the pilotAliasOverlay
|
|
// carries nodeIds from central's perspective, so comparing against the
|
|
// pilot's own local DB id (always 1) inverts dispatch. Null on central
|
|
// (fallback to getDefaultNodeId()). Populated from SENCHO_ENROLL_TOKEN.
|
|
private selfCentralNodeId: number | null = null;
|
|
|
|
private constructor() {
|
|
super();
|
|
this.setMaxListeners(50);
|
|
this.forwarder = new MeshForwarder(this);
|
|
}
|
|
|
|
public static getInstance(): MeshService {
|
|
if (!MeshService.instance) MeshService.instance = new MeshService();
|
|
return MeshService.instance;
|
|
}
|
|
|
|
private resolveSelfCentralNodeId(): number {
|
|
const tok = process.env.SENCHO_ENROLL_TOKEN;
|
|
if (tok) {
|
|
try {
|
|
// Extract payload only — signature verification not needed here;
|
|
// we only need the nodeId claim, not auth.
|
|
const [, b64] = tok.split('.');
|
|
const payload = JSON.parse(
|
|
Buffer.from(b64, 'base64url').toString('utf8'),
|
|
) as Record<string, unknown>;
|
|
if (typeof payload.nodeId === 'number') return payload.nodeId;
|
|
} catch {
|
|
// Malformed token; fall through to local default.
|
|
}
|
|
}
|
|
return NodeRegistry.getInstance().getDefaultNodeId();
|
|
}
|
|
|
|
public async start(): Promise<void> {
|
|
if (this.started) return;
|
|
this.started = true;
|
|
|
|
const ptm = PilotTunnelManager.getInstance();
|
|
ptm.on('tunnel-down', (nodeId: number) => this.onTunnelDown(nodeId));
|
|
ptm.on('tunnel-up', (nodeId: number) => {
|
|
this.logActivity({
|
|
source: 'pilot', level: 'info', type: 'tunnel.open',
|
|
nodeId, message: `pilot tunnel up for node ${nodeId}`,
|
|
});
|
|
// Boot regen runs before any pilot tunnel comes up, so any
|
|
// pilot-mode node misses its initial override push. Now that
|
|
// the tunnel is live, retry the regen for this node so its
|
|
// overrides on disk match what central holds. Idempotent:
|
|
// pushOverrideToNode writes the same file every time, and a
|
|
// tunnel reconnect during runtime regenerates harmlessly.
|
|
void this.regenerateOverridesForNode(nodeId).catch((err) => {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'forwarder.error',
|
|
nodeId,
|
|
message: `tunnel-up regen failed for node ${nodeId}: ${sanitizeForLog((err as Error).message)}`,
|
|
});
|
|
});
|
|
});
|
|
|
|
this.selfCentralNodeId = this.resolveSelfCentralNodeId();
|
|
|
|
await this.setupMeshNetwork();
|
|
try {
|
|
await this.refreshAliasCache();
|
|
} catch (err) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'error', type: 'forwarder.error',
|
|
message: `boot refreshAliasCache failed: ${sanitizeForLog((err as Error).message)}`,
|
|
});
|
|
}
|
|
try {
|
|
await this.syncForwarderListeners();
|
|
} catch (err) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'error', type: 'forwarder.error',
|
|
message: `boot syncForwarderListeners failed: ${sanitizeForLog((err as Error).message)}`,
|
|
});
|
|
}
|
|
await this.regenerateAllOverrides();
|
|
this.aliasRefreshTimer = setInterval(() => {
|
|
void (async () => {
|
|
try {
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
} catch (err) {
|
|
console.warn('[MeshService] alias refresh failed:', sanitizeForLog((err as Error).message));
|
|
}
|
|
})();
|
|
}, ALIAS_REFRESH_INTERVAL_MS);
|
|
|
|
const dataPlane = this.senchoIp ? 'ok' : `unavailable (${this.networkSetupError ?? 'unknown'})`;
|
|
this.logActivity({
|
|
source: 'mesh', level: this.senchoIp ? 'info' : 'warn', type: 'mesh.enable',
|
|
message: `MeshService started (data plane ${dataPlane}, self nodeId ${this.selfCentralNodeId})`,
|
|
});
|
|
}
|
|
|
|
public async stop(): Promise<void> {
|
|
if (!this.started) return;
|
|
this.started = false;
|
|
if (this.aliasRefreshTimer) {
|
|
clearInterval(this.aliasRefreshTimer);
|
|
this.aliasRefreshTimer = undefined;
|
|
}
|
|
await this.forwarder.shutdown();
|
|
}
|
|
|
|
public getSenchoIp(): string | null {
|
|
return this.senchoIp;
|
|
}
|
|
|
|
public getMeshSubnet(): string {
|
|
return this.meshSubnet;
|
|
}
|
|
|
|
public getNetworkSetupError(): string | null {
|
|
return this.networkSetupError;
|
|
}
|
|
|
|
/**
|
|
* Idempotent setup of the shared `sencho_mesh` Docker bridge network and
|
|
* Sencho's static attachment to it. Called once at boot before alias
|
|
* cache refresh. Failures here disable mesh routing for the lifetime of
|
|
* the process (forwarder still binds, but `ensureStackOverride` short-
|
|
* circuits because there is no IP to point user containers at).
|
|
*
|
|
* Skipped entirely when Sencho is not running inside Docker (dev mode,
|
|
* detected by an unset HOSTNAME env var or by the inspect lookup
|
|
* failing). The forwarder still runs locally for unit-test coverage.
|
|
*/
|
|
private async setupMeshNetwork(): Promise<void> {
|
|
const subnet = (process.env.SENCHO_MESH_SUBNET || DEFAULT_MESH_SUBNET).trim();
|
|
try {
|
|
this.senchoIp = getSenchoIpFromSubnet(subnet);
|
|
this.meshSubnet = subnet;
|
|
} catch (err) {
|
|
this.networkSetupError = (err as Error).message;
|
|
console.warn('[Mesh]', this.networkSetupError);
|
|
this.senchoIp = null;
|
|
return;
|
|
}
|
|
|
|
try {
|
|
await this.ensureMeshNetwork(subnet);
|
|
} catch (err) {
|
|
this.networkSetupError = (err as Error).message;
|
|
console.warn('[Mesh] mesh network setup failed:', sanitizeForLog(this.networkSetupError));
|
|
this.senchoIp = null;
|
|
return;
|
|
}
|
|
|
|
try {
|
|
await this.ensureSelfAttached();
|
|
} catch (err) {
|
|
this.networkSetupError = (err as Error).message;
|
|
console.warn('[Mesh] self-attach failed:', sanitizeForLog(this.networkSetupError));
|
|
this.senchoIp = null;
|
|
return;
|
|
}
|
|
|
|
this.networkSetupError = null;
|
|
}
|
|
|
|
/**
|
|
* Create `sencho_mesh` if it does not exist. If it does, validate the
|
|
* subnet matches `expectedSubnet`; on mismatch, refuse to continue.
|
|
* Silently using the wrong subnet would route traffic to the wrong IP.
|
|
*/
|
|
private async ensureMeshNetwork(expectedSubnet: string): Promise<void> {
|
|
const dc = DockerController.getInstance(NodeRegistry.getInstance().getDefaultNodeId());
|
|
try {
|
|
await dc.createNetwork({
|
|
Name: SENCHO_MESH_NETWORK,
|
|
Driver: 'bridge',
|
|
Attachable: true,
|
|
IPAM: { Config: [{ Subnet: expectedSubnet }] },
|
|
Labels: { 'io.sencho.mesh': 'true' },
|
|
});
|
|
return;
|
|
} catch (err) {
|
|
const e = err as { statusCode?: number; message?: string };
|
|
if (e?.statusCode !== 409) throw err;
|
|
}
|
|
|
|
const info = await dc.inspectNetwork(SENCHO_MESH_NETWORK) as {
|
|
IPAM?: { Config?: Array<{ Subnet?: string }> };
|
|
};
|
|
const existingSubnet = info?.IPAM?.Config?.[0]?.Subnet;
|
|
if (existingSubnet && existingSubnet !== expectedSubnet) {
|
|
throw new Error(
|
|
`${SENCHO_MESH_NETWORK} exists with subnet ${existingSubnet}, ` +
|
|
`expected ${expectedSubnet}. Remove the network or set SENCHO_MESH_SUBNET to match.`,
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Connect Sencho's own container to `sencho_mesh` at the static IP. Uses
|
|
* the `HOSTNAME` env var (which Docker sets to the container's short ID
|
|
* by default) to identify the container, mirroring the
|
|
* SelfUpdateService pattern. Skipped in dev mode where HOSTNAME is
|
|
* the laptop hostname and the inspect lookup would fail.
|
|
*/
|
|
private async ensureSelfAttached(): Promise<void> {
|
|
if (!this.senchoIp) return;
|
|
const hostname = process.env.HOSTNAME;
|
|
if (!hostname) {
|
|
console.log('[Mesh] HOSTNAME not set, mesh routing disabled (not running in Docker?)');
|
|
this.senchoIp = null;
|
|
return;
|
|
}
|
|
const dc = DockerController.getInstance(NodeRegistry.getInstance().getDefaultNodeId());
|
|
try {
|
|
await dc.connectContainerToNetwork(SENCHO_MESH_NETWORK, hostname, { ipv4Address: this.senchoIp });
|
|
} catch (err) {
|
|
const e = err as { statusCode?: number; message?: string };
|
|
if (e?.statusCode === 404) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'mesh.disable',
|
|
message: 'self-container lookup failed; mesh routing disabled (not running in Docker?)',
|
|
});
|
|
console.warn('[Mesh] self-container lookup failed; mesh routing disabled (not running in Docker?)');
|
|
this.senchoIp = null;
|
|
return;
|
|
}
|
|
throw err;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Bind the forwarder's listeners to every alias port across the fleet
|
|
* and release any listeners no longer in the alias set. Called from
|
|
* `start`, after each `refreshAliasCache` tick, and after every
|
|
* opt-in / opt-out / disable so the bound port set follows the DB
|
|
* state.
|
|
*
|
|
* Every meshed node binds every alias port (not just ports it owns)
|
|
* because alias DNS entries resolve to the SOURCE node's Sencho IP, so
|
|
* the source node is where the inbound TCP connection lands.
|
|
* `handleAccept` then dispatches to the same-node fast path or the
|
|
* cross-node bridge based
|
|
* on the resolved alias's owner. Fleet-wide port collisions are
|
|
* blocked at opt-in time (`optInStack` checks `aliasByPort`), so
|
|
* binding every alias port is unambiguous.
|
|
*/
|
|
private async syncForwarderListeners(): Promise<void> {
|
|
const localNodeId = NodeRegistry.getInstance().getDefaultNodeId();
|
|
const wantPorts = new Set<number>(this.aliasByPort.keys());
|
|
const havePorts = new Set(this.forwarder.getListenerPorts());
|
|
for (const port of havePorts) {
|
|
if (!wantPorts.has(port)) {
|
|
await this.forwarder.unlisten(port);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'forwarder.unlisten',
|
|
nodeId: localNodeId, message: `forwarder released port ${port}`,
|
|
});
|
|
}
|
|
}
|
|
for (const port of wantPorts) {
|
|
if (havePorts.has(port)) continue;
|
|
try {
|
|
await this.forwarder.listen(port);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'forwarder.listen',
|
|
nodeId: localNodeId, message: `forwarder listening on port ${port}`,
|
|
});
|
|
} catch (err) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'error', type: 'forwarder.error',
|
|
nodeId: localNodeId,
|
|
message: `forwarder bind failed on port ${port}: ${sanitizeForLog((err as Error).message)}`,
|
|
details: { port },
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
// --- Activity log ---
|
|
|
|
public logActivity(event: Omit<MeshActivityEvent, 'ts'>): void {
|
|
const full: MeshActivityEvent = { ts: Date.now(), ...event };
|
|
this.activity.push(full);
|
|
if (this.activity.length > ACTIVITY_BUFFER_SIZE) this.activity.shift();
|
|
for (const listener of this.activityListeners) {
|
|
try { listener(full); } catch { /* ignore */ }
|
|
}
|
|
if (event.alias && event.level === 'error') {
|
|
this.routeErrorMap.set(event.alias, { ts: full.ts, message: event.message });
|
|
}
|
|
}
|
|
|
|
public getActivity(filter?: { alias?: string; source?: MeshActivitySource; level?: MeshActivityLevel; limit?: number }): MeshActivityEvent[] {
|
|
let out = this.activity;
|
|
if (filter?.alias) out = out.filter((e) => e.alias === filter.alias);
|
|
if (filter?.source) out = out.filter((e) => e.source === filter.source);
|
|
if (filter?.level) out = out.filter((e) => e.level === filter.level);
|
|
const limit = filter?.limit ?? 200;
|
|
return out.slice(-limit);
|
|
}
|
|
|
|
public subscribeActivity(listener: (e: MeshActivityEvent) => void): () => void {
|
|
this.activityListeners.add(listener);
|
|
return () => { this.activityListeners.delete(listener); };
|
|
}
|
|
|
|
// --- Opt-in / opt-out ---
|
|
|
|
public async optInStack(nodeId: number, stackName: string, actor: string): Promise<void> {
|
|
if (!isValidStackName(stackName)) {
|
|
throw new MeshError('denied', `invalid stack name: ${stackName}`);
|
|
}
|
|
if (!this.senchoIp) {
|
|
throw new MeshError(
|
|
'denied',
|
|
this.networkSetupError || 'mesh data plane unavailable (mesh network setup did not complete)',
|
|
);
|
|
}
|
|
const db = DatabaseService.getInstance();
|
|
if (db.isMeshStackEnabled(nodeId, stackName)) return;
|
|
|
|
const services = await this.inspectStackServices(nodeId, stackName);
|
|
if (services.length === 0) {
|
|
throw new MeshError('no_target', `stack ${stackName} has no running services on this node`);
|
|
}
|
|
|
|
const newPorts = new Set<number>();
|
|
for (const svc of services) for (const p of svc.ports) newPorts.add(p);
|
|
if (newPorts.has(SENCHO_LISTEN_PORT)) {
|
|
throw new MeshError(
|
|
'port_collision',
|
|
`port ${SENCHO_LISTEN_PORT} is reserved for the Sencho API and cannot be used by a meshed service`,
|
|
);
|
|
}
|
|
for (const port of newPorts) {
|
|
const existing = this.aliasByPort.get(port);
|
|
if (existing) {
|
|
throw new MeshError(
|
|
'port_collision',
|
|
`port ${port} is already claimed by ${existing.host}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
db.insertMeshStack(nodeId, stackName, actor);
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
|
|
// Push the just-opted-in stack's override loudly. If this fails the
|
|
// DB state is invalid (alias claimed but remote pilot has no
|
|
// override file) so roll back rather than leave a half-state that
|
|
// future opt-in calls would short-circuit on `isMeshStackEnabled`.
|
|
try {
|
|
await this.pushOverrideToNode(nodeId, stackName);
|
|
} catch (err) {
|
|
db.deleteMeshStack(nodeId, stackName);
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
throw err;
|
|
}
|
|
// Regenerate OTHER meshed stacks' overrides on the same node so
|
|
// they pick up the new alias entry. The just-opted-in stack was
|
|
// already pushed above; skip it to avoid a duplicate round-trip.
|
|
// Best-effort; per-stack failures are logged inside the helper.
|
|
await this.regenerateOverridesForNode(nodeId, stackName);
|
|
this.triggerRedeploy(nodeId, stackName, actor);
|
|
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'opt_in',
|
|
nodeId, message: `opt-in ${stackName}`, details: { actor },
|
|
});
|
|
db.insertAuditLog({
|
|
timestamp: Date.now(), username: actor, method: 'POST',
|
|
path: `/api/mesh/nodes/${nodeId}/stacks/${stackName}/opt-in`,
|
|
status_code: 200, node_id: nodeId, ip_address: '127.0.0.1',
|
|
summary: `Sencho Mesh: opted ${stackName} into the mesh`,
|
|
});
|
|
}
|
|
|
|
public async optOutStack(nodeId: number, stackName: string, actor: string): Promise<void> {
|
|
if (!isValidStackName(stackName)) {
|
|
throw new MeshError('denied', `invalid stack name: ${stackName}`);
|
|
}
|
|
const db = DatabaseService.getInstance();
|
|
if (!db.isMeshStackEnabled(nodeId, stackName)) return;
|
|
db.deleteMeshStack(nodeId, stackName);
|
|
await this.removeOverrideFromNode(nodeId, stackName);
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
await this.regenerateOverridesForNode(nodeId);
|
|
this.triggerRedeploy(nodeId, stackName, actor);
|
|
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'opt_out',
|
|
nodeId, message: `opt-out ${stackName}`, details: { actor },
|
|
});
|
|
db.insertAuditLog({
|
|
timestamp: Date.now(), username: actor, method: 'POST',
|
|
path: `/api/mesh/nodes/${nodeId}/stacks/${stackName}/opt-out`,
|
|
status_code: 200, node_id: nodeId, ip_address: '127.0.0.1',
|
|
summary: `Sencho Mesh: opted ${stackName} out of the mesh`,
|
|
});
|
|
}
|
|
|
|
public async enableForNode(nodeId: number): Promise<void> {
|
|
DatabaseService.getInstance().setNodeMeshEnabled(nodeId, true);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'mesh.enable',
|
|
nodeId, message: `mesh enabled on node ${nodeId}`,
|
|
});
|
|
}
|
|
|
|
public async disableForNode(nodeId: number): Promise<void> {
|
|
DatabaseService.getInstance().setNodeMeshEnabled(nodeId, false);
|
|
const stacks = DatabaseService.getInstance().listMeshStacks(nodeId);
|
|
for (const s of stacks) {
|
|
DatabaseService.getInstance().deleteMeshStack(nodeId, s.stack_name);
|
|
await this.removeStackOverride(nodeId, s.stack_name);
|
|
}
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'mesh.disable',
|
|
nodeId, message: `mesh disabled on node ${nodeId}`,
|
|
});
|
|
}
|
|
|
|
// --- Override file management ---
|
|
|
|
public async ensureStackOverride(nodeId: number, stackName: string): Promise<string | null> {
|
|
if (!isValidStackName(stackName)) return null;
|
|
const db = DatabaseService.getInstance();
|
|
const dir = this.overrideDirFor(nodeId);
|
|
if (!db.isMeshStackEnabled(nodeId, stackName)) {
|
|
// Pilot nodes intentionally have no mesh_stacks rows (opt-in state
|
|
// lives on central per the C-3 design). Use file-presence as the
|
|
// fallback: if central pushed an override via applyLocalOverride, return
|
|
// that path so ComposeService picks it up on the next deploy.
|
|
const file = path.resolve(dir, `${path.basename(stackName)}.override.yml`);
|
|
if (!isPathWithinBase(file, dir)) return null;
|
|
try {
|
|
await fs.access(file);
|
|
return file;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
if (!this.senchoIp) return null;
|
|
|
|
const aliases: MeshAlias[] = Array.from(this.aliasCache.values()).map((a) => ({ host: a.host }));
|
|
const serviceNames = await this.getDeclaredStackServiceNames(stackName, nodeId);
|
|
|
|
await fs.mkdir(dir, { recursive: true });
|
|
// path.basename mirrors the applyLocalOverride pattern (and is
|
|
// the form CodeQL's path-injection model recognizes).
|
|
const file = path.resolve(dir, `${path.basename(stackName)}.override.yml`);
|
|
if (!isPathWithinBase(file, dir)) return null;
|
|
|
|
// Defensive fallback: a deploy that runs `compose down` immediately
|
|
// before `compose up` removes the containers, but the compose file
|
|
// is still on disk so getDeclaredStackServiceNames returns the
|
|
// declared services. The fallback below covers the much narrower
|
|
// case where the compose file itself is unreadable (permission
|
|
// glitch, transient FS error, mid-write rename); in that case
|
|
// keep any existing override rather than overwrite with `services: {}`.
|
|
if (serviceNames.length === 0) {
|
|
const existing = await this.readExistingOverrideServiceNames(dir, stackName);
|
|
if (existing.length > 0) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'mesh.override.preserved',
|
|
nodeId,
|
|
message: `mesh override preserved for ${stackName}: declared services unreadable, keeping ${existing.length} existing entries`,
|
|
details: { stackName, preservedServices: existing },
|
|
});
|
|
return file;
|
|
}
|
|
}
|
|
|
|
const yaml = generateOverrideYaml({
|
|
services: serviceNames,
|
|
aliases,
|
|
senchoIp: this.senchoIp,
|
|
});
|
|
await fs.writeFile(file, yaml, 'utf8');
|
|
return file;
|
|
}
|
|
|
|
/**
|
|
* Render and write a mesh override on the LOCAL node's filesystem from
|
|
* a fleet-wide alias list supplied by central. The pilot looks up its
|
|
* own service names and uses its own static IP, so each node's
|
|
* override resolves alias hostnames to that node's local Sencho.
|
|
* This is critical because each node has its own `sencho_mesh`
|
|
* network with its own subnet. Returns the absolute path on success
|
|
* or null if path validation rejects the input.
|
|
*/
|
|
public async applyLocalOverride(
|
|
stackName: string,
|
|
aliases: MeshAlias[],
|
|
portAliases?: MeshGlobalAlias[],
|
|
): Promise<string | null> {
|
|
if (!isValidStackName(stackName)) return null;
|
|
if (!this.senchoIp) {
|
|
throw new MeshError(
|
|
'push_failed',
|
|
this.networkSetupError || 'mesh data plane unavailable on this node',
|
|
);
|
|
}
|
|
const localNodeId = NodeRegistry.getInstance().getDefaultNodeId();
|
|
const serviceNames = await this.getDeclaredStackServiceNames(stackName, localNodeId);
|
|
|
|
const dir = this.overrideDirFor(localNodeId);
|
|
await fs.mkdir(dir, { recursive: true });
|
|
// path.basename strips any directory component as defense-in-depth
|
|
// on top of isValidStackName + isPathWithinBase. Recognized by
|
|
// CodeQL's path-injection model.
|
|
const file = path.resolve(dir, `${path.basename(stackName)}.override.yml`);
|
|
if (!isPathWithinBase(file, dir)) return null;
|
|
|
|
// Defensive fallback (mirror of ensureStackOverride): keep any
|
|
// existing override when the compose file is transiently
|
|
// unreadable. The remote that pushed this update will retry on
|
|
// its next regen tick, so a one-shot read failure should not
|
|
// wipe out a working override.
|
|
if (serviceNames.length === 0) {
|
|
const existing = await this.readExistingOverrideServiceNames(dir, stackName);
|
|
if (existing.length > 0) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'mesh.override.preserved',
|
|
nodeId: localNodeId,
|
|
message: `mesh override preserved for ${stackName}: declared services unreadable, keeping ${existing.length} existing entries`,
|
|
details: { stackName, preservedServices: existing },
|
|
});
|
|
return file;
|
|
}
|
|
}
|
|
|
|
const yaml = generateOverrideYaml({
|
|
services: serviceNames,
|
|
aliases,
|
|
senchoIp: this.senchoIp,
|
|
});
|
|
await fs.writeFile(file, yaml, 'utf8');
|
|
if (portAliases && portAliases.length > 0) {
|
|
this.pilotAliasOverlay.set(stackName, portAliases);
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
}
|
|
return file;
|
|
}
|
|
|
|
/**
|
|
* Delete a previously applied local override (mirror of
|
|
* `applyLocalOverride`). Used by central when a stack is opted out.
|
|
*/
|
|
public async removeLocalOverride(stackName: string): Promise<void> {
|
|
if (!isValidStackName(stackName)) return;
|
|
const localNodeId = NodeRegistry.getInstance().getDefaultNodeId();
|
|
const dir = this.overrideDirFor(localNodeId);
|
|
const file = path.resolve(dir, `${path.basename(stackName)}.override.yml`);
|
|
if (!isPathWithinBase(file, dir)) return;
|
|
try { await fs.unlink(file); } catch { /* ignore not-exist */ }
|
|
if (this.pilotAliasOverlay.delete(stackName)) {
|
|
await this.refreshAliasCache();
|
|
await this.syncForwarderListeners();
|
|
}
|
|
}
|
|
|
|
private async removeStackOverride(nodeId: number, stackName: string): Promise<void> {
|
|
if (!isValidStackName(stackName)) return;
|
|
const dir = this.overrideDirFor(nodeId);
|
|
const file = path.resolve(dir, `${path.basename(stackName)}.override.yml`);
|
|
if (!isPathWithinBase(file, dir)) return;
|
|
try { await fs.unlink(file); } catch { /* ignore not-exist */ }
|
|
}
|
|
|
|
private overrideDirFor(nodeId: number): string {
|
|
const dataDir = process.env.DATA_DIR || '/app/data';
|
|
return path.join(dataDir, 'mesh', 'overrides', String(nodeId));
|
|
}
|
|
|
|
private async regenerateOverridesForNode(nodeId: number, skipStack?: string): Promise<void> {
|
|
const db = DatabaseService.getInstance();
|
|
const stacks = db.listMeshStacks(nodeId);
|
|
// Push all overrides in parallel: each remote-node call is its own
|
|
// HTTP round-trip, so awaiting sequentially turns N stacks into N
|
|
// serialised PUTs. `allSettled` so a single failure does not abort
|
|
// the others.
|
|
await Promise.allSettled(
|
|
stacks
|
|
.filter((s) => s.stack_name !== skipStack)
|
|
.map(async (s) => {
|
|
try {
|
|
await this.pushOverrideToNode(nodeId, s.stack_name);
|
|
} catch (err) {
|
|
console.warn('[MeshService] override push failed:', sanitizeForLog((err as Error).message));
|
|
}
|
|
}),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Walk every `mesh_stacks` row across the fleet and re-push each override
|
|
* to its owning node. Called once at boot so on-disk override files
|
|
* survive a Sencho restart even if they were lost (image rebuild, volume
|
|
* reset, manual cleanup). Also exposed as `POST /api/mesh/regen-overrides`
|
|
* so an operator can rerun it after fixing a remote node that was offline
|
|
* at boot. Best-effort: failures are logged per-stack and other nodes
|
|
* still get regenerated. An offline remote node leaves stale overrides
|
|
* until the next opt-in / opt-out on that node, or the next manual rerun.
|
|
*/
|
|
public async regenerateAllOverrides(): Promise<MeshRegenSummary> {
|
|
if (!this.senchoIp) {
|
|
const reason = this.networkSetupError ?? 'mesh data plane unavailable';
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'mesh.disable',
|
|
message: `mesh override regen skipped: data plane unavailable (${sanitizeForLog(reason)})`,
|
|
});
|
|
return { regenerated: 0, failures: [], skipped: true, reason };
|
|
}
|
|
const db = DatabaseService.getInstance();
|
|
const stacks = db.listMeshStacks();
|
|
const failures: MeshRegenFailure[] = [];
|
|
await Promise.allSettled(
|
|
stacks.map(async (s) => {
|
|
try {
|
|
await this.pushOverrideToNode(s.node_id, s.stack_name);
|
|
} catch (err) {
|
|
const message = sanitizeForLog((err as Error).message);
|
|
failures.push({ nodeId: s.node_id, stackName: s.stack_name, message });
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'forwarder.error',
|
|
nodeId: s.node_id,
|
|
message: `mesh override regen failed for ${s.stack_name}: ${message}`,
|
|
details: { stackName: s.stack_name },
|
|
});
|
|
}
|
|
}),
|
|
);
|
|
const succeeded = stacks.length - failures.length;
|
|
const failedNodeIds = Array.from(new Set(failures.map((f) => f.nodeId))).sort((a, b) => a - b);
|
|
this.logActivity({
|
|
source: 'mesh', level: failures.length === 0 ? 'info' : 'warn', type: 'mesh.enable',
|
|
message: `mesh override regen complete: ${succeeded} succeeded, ${failures.length} failed across ${failedNodeIds.length} node(s)`,
|
|
details: { succeeded, failed: failures.length, failedNodeIds },
|
|
});
|
|
return { regenerated: succeeded, failures, skipped: false };
|
|
}
|
|
|
|
// --- Alias aggregation ---
|
|
|
|
public async refreshAliasCache(): Promise<void> {
|
|
const db = DatabaseService.getInstance();
|
|
const next = new Map<string, MeshGlobalAlias>();
|
|
const portMap = new Map<number, MeshGlobalAlias>();
|
|
const stacks = db.listMeshStacks();
|
|
|
|
// Inspect all stacks in parallel; each remote-node lookup involves an
|
|
// HTTP fetch with its own 5 s AbortSignal. Sequential awaiting would
|
|
// let one slow node stall the whole refresh, which is on a 60 s loop.
|
|
const inspections = await Promise.allSettled(
|
|
stacks.map(async (row) => {
|
|
const node = db.getNode(row.node_id);
|
|
if (!node) return null;
|
|
const services = await this.inspectStackServices(row.node_id, row.stack_name);
|
|
return { row, node, services };
|
|
}),
|
|
);
|
|
for (const result of inspections) {
|
|
if (result.status !== 'fulfilled' || !result.value) continue;
|
|
const { row, node, services } = result.value;
|
|
for (const svc of services) {
|
|
const host = `${svc.service}.${row.stack_name}.${node.name}.sencho`;
|
|
for (const port of svc.ports) {
|
|
const alias: MeshGlobalAlias = {
|
|
host,
|
|
nodeId: row.node_id,
|
|
nodeName: node.name,
|
|
stackName: row.stack_name,
|
|
serviceName: svc.service,
|
|
port,
|
|
};
|
|
next.set(host, alias);
|
|
if (!portMap.has(port)) portMap.set(port, alias);
|
|
}
|
|
}
|
|
}
|
|
// Merge pilot overlay. Invariant: on central, pilotAliasOverlay is
|
|
// always empty (DB is authoritative); on pilots, db.listMeshStacks()
|
|
// returns empty (C-3), so the two populations are mutually exclusive
|
|
// and the first-write-wins portMap policy is safe.
|
|
for (const overlayAliases of this.pilotAliasOverlay.values()) {
|
|
for (const alias of overlayAliases) {
|
|
next.set(alias.host, alias);
|
|
if (!portMap.has(alias.port)) portMap.set(alias.port, alias);
|
|
}
|
|
}
|
|
this.aliasCache = next;
|
|
this.aliasByPort = portMap;
|
|
}
|
|
|
|
public async listAliases(): Promise<MeshGlobalAlias[]> {
|
|
return Array.from(this.aliasCache.values());
|
|
}
|
|
|
|
/**
|
|
* Read the local stack's compose file and return its declared service
|
|
* names. Used by the override-write paths so a deploy that has just
|
|
* torn containers down still emits a complete services map even
|
|
* though Dockerode briefly returns no containers. Independent of
|
|
* runtime container state, so the override stays correct across the
|
|
* deploy lifecycle.
|
|
*
|
|
* Returns [] when the compose file is missing, unreadable, or fails
|
|
* to parse. Combined with the defensive fallback in
|
|
* {@link ensureStackOverride} / {@link applyLocalOverride} a transient
|
|
* empty result does not clobber a known-good override.
|
|
*
|
|
* LIMITATION: stacks that pull services in via compose `extends:` or
|
|
* `include:` will not have those external services covered. The
|
|
* top-level YAML.parse is sufficient for the supported compose
|
|
* shapes; if extends/include usage emerges, swap to
|
|
* `docker compose config --services` (subprocess).
|
|
*/
|
|
public async getDeclaredStackServiceNames(stackName: string, nodeId?: number): Promise<string[]> {
|
|
if (!isValidStackName(stackName)) return [];
|
|
const targetNodeId = nodeId ?? NodeRegistry.getInstance().getDefaultNodeId();
|
|
try {
|
|
const fsSvc = FileSystemService.getInstance(targetNodeId);
|
|
const filename = await fsSvc.getComposeFilename(stackName);
|
|
const baseDir = fsSvc.getBaseDir();
|
|
// path.basename strips any directory component as defense-in-depth
|
|
// on top of isValidStackName + isPathWithinBase. Recognized by
|
|
// CodeQL's path-injection model.
|
|
const composePath = path.join(baseDir, path.basename(stackName), filename);
|
|
if (!isPathWithinBase(composePath, baseDir)) return [];
|
|
const content = await fs.readFile(composePath, 'utf8');
|
|
const parsed = YAML.parse(content) as { services?: Record<string, unknown> } | null;
|
|
const services = parsed?.services && typeof parsed.services === 'object' ? parsed.services : null;
|
|
if (!services) return [];
|
|
return Object.keys(services).filter((name) => /^[A-Za-z0-9_][A-Za-z0-9_.-]*$/.test(name));
|
|
} catch (err) {
|
|
console.warn(
|
|
'[MeshService] getDeclaredStackServiceNames failed:',
|
|
sanitizeForLog((err as Error).message),
|
|
);
|
|
return [];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Parse an existing mesh override file and extract the service names
|
|
* it already lists. Used by the defensive fallback so a transient
|
|
* empty compose-file read does not clobber a known-good override.
|
|
* Takes (dir, stackName) rather than a pre-built filePath so the
|
|
* path-injection sanitizer pattern (path.basename + isPathWithinBase)
|
|
* lives next to the read sink and stays recognizable to CodeQL.
|
|
*/
|
|
private async readExistingOverrideServiceNames(dir: string, stackName: string): Promise<string[]> {
|
|
const file = path.resolve(dir, `${path.basename(stackName)}.override.yml`);
|
|
if (!isPathWithinBase(file, dir)) return [];
|
|
try {
|
|
const content = await fs.readFile(file, 'utf8');
|
|
const parsed = YAML.parse(content) as { services?: Record<string, unknown> } | null;
|
|
const services = parsed?.services && typeof parsed.services === 'object' ? parsed.services : null;
|
|
if (!services) return [];
|
|
return Object.keys(services);
|
|
} catch {
|
|
return [];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Inspect a stack and return its running services with the ports they
|
|
* listen on. For the LOCAL Docker daemon only; callers targeting a
|
|
* remote node must use {@link inspectStackServices}, which dispatches
|
|
* via the HTTP proxy to the remote's `/api/mesh/local-services/:stack`.
|
|
*/
|
|
public async inspectLocalStackServices(stackName: string): Promise<Array<{ service: string; ports: number[] }>> {
|
|
try {
|
|
const docker = DockerController.getInstance().getDocker();
|
|
const containers = await docker.listContainers({
|
|
all: true,
|
|
filters: { label: [`com.docker.compose.project=${stackName}`] },
|
|
});
|
|
const byService = new Map<string, Set<number>>();
|
|
for (const c of containers) {
|
|
const svc = c.Labels?.['com.docker.compose.service'];
|
|
if (!svc) continue;
|
|
const ports = byService.get(svc) || new Set<number>();
|
|
for (const p of c.Ports || []) {
|
|
if (p.PrivatePort) ports.add(p.PrivatePort);
|
|
}
|
|
byService.set(svc, ports);
|
|
}
|
|
return Array.from(byService.entries()).map(([service, ports]) => ({ service, ports: Array.from(ports) }));
|
|
} catch (err) {
|
|
console.warn('[MeshService] inspectLocalStackServices failed:', sanitizeForLog((err as Error).message));
|
|
return [];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Inspect a stack on a (possibly remote) node and return its running
|
|
* services with the ports they listen on. Local nodes hit Dockerode
|
|
* directly; remote nodes (proxy mode and pilot-agent) reach their own
|
|
* Sencho's `/api/mesh/local-services/:stackName` via the existing
|
|
* `NodeRegistry.getProxyTarget` resolution chain because Dockerode is not
|
|
* directly reachable for remote nodes by design.
|
|
*/
|
|
private async inspectStackServices(nodeId: number, stackName: string): Promise<Array<{ service: string; ports: number[] }>> {
|
|
const node = DatabaseService.getInstance().getNode(nodeId);
|
|
if (!node) return [];
|
|
if (node.type !== 'remote') return this.inspectLocalStackServices(stackName);
|
|
|
|
const target = NodeRegistry.getInstance().getProxyTarget(nodeId);
|
|
if (!target) {
|
|
console.warn(`[MeshService] inspectStackServices: no proxy target for node ${nodeId} (${sanitizeForLog(node.name)})`);
|
|
return [];
|
|
}
|
|
try {
|
|
const url = `${target.apiUrl.replace(/\/$/, '')}/api/mesh/local-services/${encodeURIComponent(stackName)}`;
|
|
const headers: Record<string, string> = {};
|
|
if (target.apiToken) headers['Authorization'] = `Bearer ${target.apiToken}`;
|
|
const proxyHeaders = LicenseService.getInstance().getProxyHeaders();
|
|
headers[PROXY_TIER_HEADER] = proxyHeaders.tier;
|
|
headers[PROXY_VARIANT_HEADER] = proxyHeaders.variant || '';
|
|
const res = await fetch(url, { headers, signal: AbortSignal.timeout(5_000) });
|
|
if (!res.ok) {
|
|
console.error(`[MeshService] inspectStackServices: HTTP ${res.status} from node ${nodeId} (${sanitizeForLog(node.name)})`);
|
|
return [];
|
|
}
|
|
const body = await res.json() as { services?: Array<{ service: string; ports: number[] }> };
|
|
return body.services ?? [];
|
|
} catch (err) {
|
|
console.error('[MeshService] inspectStackServices remote unreachable:', sanitizeForLog((err as Error).message));
|
|
return [];
|
|
}
|
|
}
|
|
|
|
public async listLocalStacks(): Promise<string[]> {
|
|
const localNodeId = NodeRegistry.getInstance().getDefaultNodeId();
|
|
return FileSystemService.getInstance(localNodeId).getStacks();
|
|
}
|
|
|
|
/**
|
|
* Local nodes read the filesystem; remote nodes fetch their own
|
|
* Sencho's `/api/mesh/local-stacks` because the remote's compose
|
|
* directory is not visible from central (pilot's filesystem lives
|
|
* on a different host).
|
|
*/
|
|
public async listStacksOnNode(nodeId: number): Promise<string[]> {
|
|
const node = DatabaseService.getInstance().getNode(nodeId);
|
|
if (!node) return [];
|
|
if (node.type !== 'remote') return this.listLocalStacks();
|
|
|
|
try {
|
|
const res = await this.proxyFetch(nodeId, 'GET', '/api/mesh/local-stacks', undefined, 5_000);
|
|
if (!res.ok) {
|
|
console.error(`[MeshService] listStacksOnNode: HTTP ${res.status} from node ${nodeId} (${sanitizeForLog(node.name)})`);
|
|
return [];
|
|
}
|
|
const body = await res.json() as { stacks?: unknown };
|
|
if (!Array.isArray(body.stacks)) return [];
|
|
return body.stacks.filter((s): s is string => typeof s === 'string');
|
|
} catch (err) {
|
|
// proxyFetch throws MeshError('push_failed') when getProxyTarget
|
|
// returns null (e.g. pilot tunnel offline). Treat the same as a
|
|
// non-OK response: empty list.
|
|
if (err instanceof MeshError && err.code === 'push_failed') {
|
|
console.warn(`[MeshService] listStacksOnNode: no proxy target for node ${nodeId} (${sanitizeForLog(node.name)})`);
|
|
return [];
|
|
}
|
|
console.error('[MeshService] listStacksOnNode remote unreachable:', sanitizeForLog((err as Error).message));
|
|
return [];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Build a `fetch` against a remote Sencho's API with the bearer token
|
|
* and the proxy tier/variant headers in place. Centralizes the header
|
|
* shape so a future addition (license header, audit context) only
|
|
* needs to land in one place.
|
|
*
|
|
* `x-node-id` is deliberately NOT set: callers target the remote
|
|
* Sencho's own routes, which operate against the remote's local node
|
|
* id. The bearer token alone authenticates.
|
|
*/
|
|
private async proxyFetch(
|
|
nodeId: number,
|
|
method: 'GET' | 'PUT' | 'POST' | 'DELETE',
|
|
apiPath: string,
|
|
body: unknown,
|
|
timeoutMs: number,
|
|
): Promise<Response> {
|
|
const target = NodeRegistry.getInstance().getProxyTarget(nodeId);
|
|
if (!target) throw new MeshError('push_failed', `no proxy target for node ${nodeId}`);
|
|
const url = `${target.apiUrl.replace(/\/$/, '')}${apiPath}`;
|
|
const headers: Record<string, string> = {};
|
|
if (body !== undefined) headers['Content-Type'] = 'application/json';
|
|
if (target.apiToken) headers['Authorization'] = `Bearer ${target.apiToken}`;
|
|
const proxyHeaders = LicenseService.getInstance().getProxyHeaders();
|
|
headers[PROXY_TIER_HEADER] = proxyHeaders.tier;
|
|
headers[PROXY_VARIANT_HEADER] = proxyHeaders.variant || '';
|
|
return await fetch(url, {
|
|
method,
|
|
headers,
|
|
body: body === undefined ? undefined : JSON.stringify(body),
|
|
signal: AbortSignal.timeout(timeoutMs),
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Place a mesh override for a stack on whichever node owns it:
|
|
* - local node: regenerates via `ensureStackOverride`, which uses
|
|
* central's own senchoIp (correct because central is the node
|
|
* deploying that stack).
|
|
* - remote node: sends the fleet-wide alias list to the remote's
|
|
* `PUT /api/mesh/local-override/:stackName`; the remote renders
|
|
* the YAML using its OWN local senchoIp and writes it under its
|
|
* own DATA_DIR. This is essential because each node has its own
|
|
* `sencho_mesh` network and may be configured with a different
|
|
* SENCHO_MESH_SUBNET, so alias hostnames must always resolve to
|
|
* the local Sencho IP on the deploying node.
|
|
*
|
|
* Throws on remote push failure so callers (opt-in / opt-out) can abort
|
|
* cleanly rather than silently leaving stale overrides.
|
|
*/
|
|
public async pushOverrideToNode(nodeId: number, stackName: string): Promise<void> {
|
|
const node = DatabaseService.getInstance().getNode(nodeId);
|
|
if (!node) throw new MeshError('denied', `unknown node ${nodeId}`);
|
|
|
|
if (node.type !== 'remote') {
|
|
await this.ensureStackOverride(nodeId, stackName);
|
|
return;
|
|
}
|
|
|
|
const portAliases: MeshGlobalAlias[] = Array.from(this.aliasCache.values());
|
|
const aliases: MeshAlias[] = portAliases.map((a) => ({ host: a.host }));
|
|
const res = await this.proxyFetch(
|
|
nodeId,
|
|
'PUT',
|
|
`/api/mesh/local-override/${encodeURIComponent(stackName)}`,
|
|
{ aliases, portAliases },
|
|
5_000,
|
|
);
|
|
if (res.status === 404) {
|
|
throw new MeshError(
|
|
'push_failed',
|
|
`node ${node.name} does not support mesh override push (upgrade required)`,
|
|
);
|
|
}
|
|
if (!res.ok) {
|
|
throw new MeshError('push_failed', `HTTP ${res.status} from node ${node.name}`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fire-and-forget redeploy of a stack on whichever node owns it. Used
|
|
* by opt-in and opt-out so the new alias entries reach the user
|
|
* containers' /etc/hosts without an operator manually clicking deploy.
|
|
*
|
|
* For local stacks: invokes `ComposeService.deployStack` directly.
|
|
* For remote stacks: HTTP POSTs to `<apiUrl>/api/stacks/:name/deploy`
|
|
* via the same bearer-token pattern the rest of the proxy chain uses.
|
|
*
|
|
* Errors are logged to the mesh activity buffer rather than thrown so
|
|
* the opt-in or opt-out call site can return success quickly. The
|
|
* operator sees the redeploy progress through the existing deploy
|
|
* stream surfaces; if it fails, the activity log records why.
|
|
*/
|
|
public triggerRedeploy(nodeId: number, stackName: string, actor: string): void {
|
|
void this.runRedeploy(nodeId, stackName, actor).catch((err) => {
|
|
const reason = sanitizeForLog((err as Error).message);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'error', type: 'forwarder.error',
|
|
nodeId,
|
|
message: `mesh redeploy failed for ${stackName}: ${reason}`,
|
|
details: { actor, stackName },
|
|
});
|
|
// Also drop a durable audit row so an operator who walks away
|
|
// from the toast still has a trail. The activity ring buffer
|
|
// alone gets pruned at 1000 events.
|
|
DatabaseService.getInstance().insertAuditLog({
|
|
timestamp: Date.now(), username: actor, method: 'POST',
|
|
path: `/api/mesh/nodes/${nodeId}/stacks/${stackName}/redeploy`,
|
|
status_code: 500, node_id: nodeId, ip_address: '127.0.0.1',
|
|
summary: `Sencho Mesh: redeploy failed for ${stackName}: ${reason}`,
|
|
});
|
|
});
|
|
}
|
|
|
|
private async runRedeploy(nodeId: number, stackName: string, actor: string): Promise<void> {
|
|
const node = DatabaseService.getInstance().getNode(nodeId);
|
|
if (!node) throw new Error(`unknown node ${nodeId}`);
|
|
|
|
if (node.type !== 'remote') {
|
|
await assertPolicyGateAllows(
|
|
stackName,
|
|
nodeId,
|
|
buildSystemPolicyGateOptions(actor, {
|
|
auditPath: `/api/mesh/nodes/${nodeId}/stacks/${stackName}/redeploy`,
|
|
}),
|
|
);
|
|
await ComposeService.getInstance(nodeId).deployStack(stackName);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'mesh.enable',
|
|
nodeId,
|
|
message: `mesh redeploy ok for ${stackName}`,
|
|
details: { actor, stackName },
|
|
});
|
|
return;
|
|
}
|
|
|
|
// Mesh redeploys are bounded by docker compose's own runtime; pick a
|
|
// generous ceiling rather than the 5 s default used for control-plane
|
|
// calls so a slow image pull does not abort the redeploy.
|
|
const res = await this.proxyFetch(
|
|
nodeId,
|
|
'POST',
|
|
`/api/stacks/${encodeURIComponent(stackName)}/deploy`,
|
|
{},
|
|
10 * 60 * 1000,
|
|
);
|
|
if (!res.ok) {
|
|
const body = await res.text().catch(() => '');
|
|
throw new Error(`HTTP ${res.status} from node ${node.name}: ${body.slice(0, 256)}`);
|
|
}
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'mesh.enable',
|
|
nodeId,
|
|
message: `mesh redeploy ok for ${stackName}`,
|
|
details: { actor, stackName },
|
|
});
|
|
}
|
|
|
|
public async removeOverrideFromNode(nodeId: number, stackName: string): Promise<void> {
|
|
const node = DatabaseService.getInstance().getNode(nodeId);
|
|
if (!node) return;
|
|
|
|
if (node.type !== 'remote') {
|
|
await this.removeStackOverride(nodeId, stackName);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
await this.proxyFetch(
|
|
nodeId,
|
|
'DELETE',
|
|
`/api/mesh/local-override/${encodeURIComponent(stackName)}`,
|
|
undefined,
|
|
5_000,
|
|
);
|
|
} catch (err) {
|
|
console.warn('[MeshService] removeOverrideFromNode failed:', sanitizeForLog((err as Error).message));
|
|
}
|
|
}
|
|
|
|
// --- Resolution + forwarding ---
|
|
|
|
public resolveByLocalPort(port: number): MeshTarget | null {
|
|
const alias = this.aliasByPort.get(port);
|
|
if (!alias) return null;
|
|
return {
|
|
nodeId: alias.nodeId,
|
|
stack: alias.stackName,
|
|
service: alias.serviceName,
|
|
port: alias.port,
|
|
alias: alias.host,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* MeshForwarder calls this on every accepted inbound socket. Resolves
|
|
* the alias by destination port, then dispatches to the same-node fast
|
|
* path or the cross-node bridge path.
|
|
*/
|
|
public async handleAccept(port: number, src: net.Socket): Promise<void> {
|
|
const target = this.resolveByLocalPort(port);
|
|
if (!target) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'warn', type: 'route.resolve.denied',
|
|
message: `inbound on port ${port} has no registered alias`,
|
|
details: { port, remoteAddr: src.remoteAddress ?? '' },
|
|
});
|
|
try { src.destroy(); } catch { /* ignore */ }
|
|
return;
|
|
}
|
|
const selfNodeId = this.selfCentralNodeId ?? NodeRegistry.getInstance().getDefaultNodeId();
|
|
if (target.nodeId === selfNodeId) {
|
|
await this.openSameNode(target, src);
|
|
} else {
|
|
await this.openCrossNode(target, src);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Same-node forward: dial the target container's bridge IP directly.
|
|
* Sencho runs in `network_mode: host` so it sees the docker bridge
|
|
* networks and can reach container IPs without going through any
|
|
* host-port publish. Looks up the container by Compose's
|
|
* `<project>-<service>-<index>` naming convention; falls back to a
|
|
* label-filtered listContainers if the conventional name is absent
|
|
* (e.g. when the operator overrode the project name).
|
|
*/
|
|
private async openSameNode(target: MeshTarget, src: net.Socket): Promise<void> {
|
|
const ip = await this.resolveContainerIp(target);
|
|
if (!ip) {
|
|
this.logActivity({
|
|
source: 'mesh', level: 'error', type: 'route.resolve.denied',
|
|
alias: target.alias,
|
|
message: `cannot resolve container IP for ${target.alias}`,
|
|
});
|
|
try { src.destroy(); } catch { /* ignore */ }
|
|
return;
|
|
}
|
|
const upstream = net.createConnection({ host: ip, port: target.port });
|
|
upstream.setTimeout(PROBE_TIMEOUT_MS);
|
|
const stream = this.registerActiveStream(target.alias);
|
|
upstream.once('connect', () => {
|
|
upstream.setTimeout(0);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'route.resolve.ok',
|
|
alias: target.alias, streamId: stream.streamId,
|
|
message: `same-node connect to ${target.alias} (${ip}:${target.port})`,
|
|
});
|
|
src.pipe(upstream);
|
|
upstream.pipe(src);
|
|
});
|
|
const teardown = () => {
|
|
this.activeStreams.delete(stream.streamId);
|
|
try { upstream.destroy(); } catch { /* ignore */ }
|
|
try { src.destroy(); } catch { /* ignore */ }
|
|
};
|
|
upstream.on('error', () => teardown());
|
|
upstream.on('close', () => teardown());
|
|
src.on('error', () => teardown());
|
|
src.on('close', () => teardown());
|
|
}
|
|
|
|
/**
|
|
* Find the bridge-network IP of the first container of
|
|
* `<stack>/<service>`. Public so the central-side
|
|
* `PilotTunnelBridge` reverse-open handler (Phase B) can dial the same
|
|
* target shape when a pilot's mesh forwarder routes traffic back to
|
|
* central.
|
|
*/
|
|
public async resolveContainerIp(target: { stack: string; service: string }): Promise<string | null> {
|
|
const docker = DockerController.getInstance().getDocker() as unknown as Parameters<typeof lookupContainerIp>[0];
|
|
try {
|
|
return await lookupContainerIp(docker, target.stack, target.service);
|
|
} catch (err) {
|
|
console.warn('[MeshService] container IP lookup failed:', sanitizeForLog((err as Error).message));
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Pluggable reverse dialer. Set by `PilotAgent` on a pilot host or by
|
|
* the proxy-mode WS handler when a `/api/mesh/proxy-tunnel` upgrade
|
|
* comes in; left null on a central host with no inbound mesh tunnel.
|
|
* When set, `openCrossNode` routes outbound mesh dials through the
|
|
* dialer's `tcp_open_reverse` path; when unset, `openCrossNode` uses
|
|
* the central-side `PilotTunnelManager.getBridge` directly. Lets the
|
|
* same MeshService code work on both sides.
|
|
*/
|
|
private reverseDialer: ReverseMeshDialer | null = null;
|
|
|
|
/**
|
|
* Install or clear the reverse dialer. Supports compare-and-swap via
|
|
* the optional `expected` argument so a caller (e.g., the proxy-mode
|
|
* WS handler) can install on a null slot and uninstall only if its
|
|
* own dialer is still the active one. Without the `expected` arg the
|
|
* operation is unconditional (used by the pilot agent at boot).
|
|
*
|
|
* Returns true when the swap happened, false when the CAS rejected
|
|
* because `expected` did not match the current dialer.
|
|
*/
|
|
public setReverseDialer(dialer: ReverseMeshDialer | null, expected?: ReverseMeshDialer | null): boolean {
|
|
if (expected !== undefined && this.reverseDialer !== expected) return false;
|
|
// Loud warn instead of silent overwrite: pilot and proxy modes are
|
|
// mutually exclusive by topology, so this branch indicates a
|
|
// misconfigured deployment rather than an expected race.
|
|
if (expected === undefined && dialer !== null && this.reverseDialer !== null && this.reverseDialer !== dialer) {
|
|
console.warn('[MeshService] reverse dialer overwritten without CAS; pilot/proxy mode race or duplicate install');
|
|
}
|
|
this.reverseDialer = dialer;
|
|
return true;
|
|
}
|
|
|
|
private async dialMeshTcpStream(target: MeshTarget): Promise<MeshTcpStreamLike | null> {
|
|
if (this.reverseDialer) {
|
|
return this.reverseDialer.openMeshTcpStream({
|
|
nodeId: target.nodeId,
|
|
stack: target.stack,
|
|
service: target.service,
|
|
port: target.port,
|
|
});
|
|
}
|
|
const ptm = PilotTunnelManager.getInstance();
|
|
// ensureBridge resolves an existing pilot tunnel, an existing
|
|
// proxy-mode tunnel, or dials a fresh proxy-mode tunnel on demand.
|
|
// Returns null for unreachable nodes (no api_url/api_token, scope
|
|
// insufficient, remote pre-Phase-C, network error).
|
|
const bridge = await ptm.ensureBridge(target.nodeId);
|
|
if (!bridge) return null;
|
|
return bridge.openTcpStream({ stack: target.stack, service: target.service, port: target.port });
|
|
}
|
|
|
|
private async openCrossNode(target: MeshTarget, src: net.Socket): Promise<void> {
|
|
// Log every dispatch entry. Same-node logs route.resolve.ok on
|
|
// its TCP `connect` event; cross-node only logs route.resolve.ok
|
|
// once tcp_open_ack arrives from the agent. Without this entry
|
|
// log, a stuck cross-node dial leaves zero events in the activity
|
|
// buffer even though the prober's TCP handshake completed.
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'route.dispatch',
|
|
nodeId: target.nodeId, alias: target.alias,
|
|
message: `cross-node dispatch to ${target.alias} on node ${target.nodeId}`,
|
|
});
|
|
|
|
const tcpStream = await this.dialMeshTcpStream(target);
|
|
if (!tcpStream) {
|
|
this.logActivity({
|
|
source: 'pilot', level: 'error', type: 'tunnel.fail',
|
|
nodeId: target.nodeId, alias: target.alias,
|
|
message: this.reverseDialer
|
|
? `cannot open reverse mesh stream to node ${target.nodeId}`
|
|
: `no mesh tunnel reachable for node ${target.nodeId}`,
|
|
});
|
|
try { src.destroy(); } catch { /* ignore */ }
|
|
return;
|
|
}
|
|
const record = this.registerActiveStream(target.alias, tcpStream.streamId);
|
|
const t0 = Date.now();
|
|
|
|
// Timer guards against the agent never returning a tcp_open_ack
|
|
// (broken pilot, frame dropped, dial stuck after handshake).
|
|
// Without this the stream sits forever and the operator sees
|
|
// nothing in the activity log between dispatch and close.
|
|
let openTimer: NodeJS.Timeout | null = setTimeout(() => {
|
|
openTimer = null;
|
|
this.logActivity({
|
|
source: 'pilot', level: 'warn', type: 'tunnel.fail',
|
|
nodeId: target.nodeId, alias: target.alias, streamId: record.streamId,
|
|
message: `cross-node dial to ${target.alias} timed out waiting for tcp_open_ack`,
|
|
});
|
|
try { tcpStream.destroy(); } catch { /* ignore */ }
|
|
try { src.destroy(); } catch { /* ignore */ }
|
|
}, PROBE_TIMEOUT_MS);
|
|
const clearOpenTimer = () => {
|
|
if (openTimer) { clearTimeout(openTimer); openTimer = null; }
|
|
};
|
|
|
|
tcpStream.on('open', () => {
|
|
clearOpenTimer();
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'route.resolve.ok',
|
|
nodeId: target.nodeId, alias: target.alias, streamId: record.streamId,
|
|
message: `cross-node connect to ${target.alias}`,
|
|
});
|
|
this.routeLatencyMap.set(target.alias, Date.now() - t0);
|
|
});
|
|
tcpStream.on('data', (chunk: Buffer) => {
|
|
record.bytesIn += chunk.length;
|
|
try { src.write(chunk); } catch { /* ignore */ }
|
|
});
|
|
tcpStream.on('error', (err: Error) => {
|
|
clearOpenTimer();
|
|
this.logActivity({
|
|
source: 'pilot', level: 'error', type: 'tunnel.fail',
|
|
nodeId: target.nodeId, alias: target.alias, streamId: record.streamId,
|
|
message: sanitizeForLog(err.message),
|
|
});
|
|
this.activeStreams.delete(record.streamId);
|
|
try { src.destroy(); } catch { /* ignore */ }
|
|
});
|
|
tcpStream.on('close', () => {
|
|
clearOpenTimer();
|
|
this.activeStreams.delete(record.streamId);
|
|
try { src.end(); } catch { /* ignore */ }
|
|
});
|
|
src.on('data', (chunk: Buffer) => {
|
|
record.bytesOut += chunk.length;
|
|
tcpStream.write(chunk);
|
|
});
|
|
src.on('end', () => tcpStream.end());
|
|
src.on('close', () => { clearOpenTimer(); tcpStream.destroy(); });
|
|
src.on('error', () => { clearOpenTimer(); tcpStream.destroy(); });
|
|
}
|
|
|
|
private registerActiveStream(alias: string, streamId?: number): ActiveStreamRecord {
|
|
const id = streamId ?? -Math.floor(Math.random() * 0x7fffffff);
|
|
const record: ActiveStreamRecord = {
|
|
streamId: id, alias, bytesIn: 0, bytesOut: 0, openedAt: Date.now(),
|
|
};
|
|
this.activeStreams.set(id, record);
|
|
return record;
|
|
}
|
|
|
|
private onTunnelDown(nodeId: number): void {
|
|
this.logActivity({
|
|
source: 'pilot', level: 'warn', type: 'tunnel.fail',
|
|
nodeId, message: `pilot tunnel down for node ${nodeId}`,
|
|
});
|
|
}
|
|
|
|
// --- Probe / Test upstream ---
|
|
|
|
public async testUpstream(alias: string, sourceNodeId: number): Promise<MeshProbeResult> {
|
|
const target = this.lookupAliasGlobal(alias);
|
|
if (!target) {
|
|
return { ok: false, where: 'no_route', code: 'no_route', message: 'alias not found' };
|
|
}
|
|
if (!DatabaseService.getInstance().isMeshStackEnabled(target.nodeId, target.stackName)) {
|
|
return { ok: false, where: 'agent_resolve', code: 'denied', message: 'target stack not opted in' };
|
|
}
|
|
|
|
if (target.nodeId !== sourceNodeId) {
|
|
const ptm = PilotTunnelManager.getInstance();
|
|
if (!ptm.hasActiveTunnel(target.nodeId)) {
|
|
return { ok: false, where: 'pilot_tunnel', code: 'tunnel_down', message: 'no pilot tunnel' };
|
|
}
|
|
const bridge = ptm.getBridge(target.nodeId);
|
|
if (!bridge) {
|
|
return { ok: false, where: 'pilot_tunnel', code: 'tunnel_down', message: 'no bridge' };
|
|
}
|
|
const t0 = Date.now();
|
|
const stream = bridge.openTcpStream({ stack: target.stackName, service: target.serviceName, port: target.port });
|
|
if (!stream) return { ok: false, where: 'pilot_tunnel', code: 'tunnel_down', message: 'open failed' };
|
|
return new Promise<MeshProbeResult>((resolve) => {
|
|
const timer = setTimeout(() => {
|
|
stream.destroy();
|
|
resolve({ ok: false, where: 'agent_dial', code: 'timeout', message: 'probe timeout' });
|
|
}, PROBE_TIMEOUT_MS);
|
|
stream.once('open', () => {
|
|
clearTimeout(timer);
|
|
const latency = Date.now() - t0;
|
|
this.routeLatencyMap.set(target.host, latency);
|
|
stream.destroy();
|
|
this.logActivity({
|
|
source: 'mesh', level: 'info', type: 'probe.ok',
|
|
alias: target.host, message: `probe ok ${latency}ms`,
|
|
});
|
|
resolve({ ok: true, latencyMs: latency });
|
|
});
|
|
stream.once('error', (err: Error) => {
|
|
clearTimeout(timer);
|
|
const sanitized = sanitizeForLog(err.message);
|
|
this.logActivity({
|
|
source: 'mesh', level: 'error', type: 'probe.fail',
|
|
alias: target.host, message: sanitized,
|
|
});
|
|
resolve({ ok: false, where: 'agent_dial', code: 'unreachable', message: sanitized });
|
|
});
|
|
});
|
|
}
|
|
|
|
const t0 = Date.now();
|
|
return new Promise<MeshProbeResult>((resolve) => {
|
|
const sock = net.createConnection({ host: '127.0.0.1', port: target.port });
|
|
sock.setTimeout(PROBE_TIMEOUT_MS);
|
|
sock.once('connect', () => {
|
|
const latency = Date.now() - t0;
|
|
this.routeLatencyMap.set(target.host, latency);
|
|
sock.destroy();
|
|
resolve({ ok: true, latencyMs: latency });
|
|
});
|
|
sock.once('timeout', () => {
|
|
sock.destroy();
|
|
resolve({ ok: false, where: 'target_port', code: 'timeout', message: 'connect timeout' });
|
|
});
|
|
sock.once('error', (err) => {
|
|
resolve({ ok: false, where: 'target_port', code: 'unreachable', message: sanitizeForLog(err.message) });
|
|
});
|
|
});
|
|
}
|
|
|
|
private lookupAliasGlobal(host: string): MeshGlobalAlias | null {
|
|
return this.aliasCache.get(host) || null;
|
|
}
|
|
|
|
// --- Diagnostics ---
|
|
|
|
/**
|
|
* Whether mesh CAN route to a node based on current configuration.
|
|
* Distinct from "live tunnel up right now": for proxy-mode remotes
|
|
* the tunnel is opened on demand, so a caller that demanded a
|
|
* current tunnel would misreport every idle proxy-mode route as
|
|
* `tunnel down`. Live pilot-tunnel state is surfaced separately.
|
|
*/
|
|
private isNodeMeshConfigured(node: ReturnType<typeof DatabaseService.prototype.getNode>): boolean {
|
|
if (!node) return false;
|
|
if (node.type !== 'remote') return true;
|
|
if (node.mode === 'pilot_agent') return true;
|
|
if (node.mode === 'proxy') return !!node.api_url && !!node.api_token;
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Compute the reachability classification surfaced in `MeshNodeStatus`
|
|
* and consumed by the Routing tab. See `MeshReachableMode` for the
|
|
* meaning of each value. Callers pass in the already-fetched node row
|
|
* (and the local nodeId) so this helper is free of DB I/O when
|
|
* `getStatus` iterates the fleet.
|
|
*/
|
|
private computeReachable(node: ReturnType<typeof DatabaseService.prototype.getNode>, localNodeId: number): { mode: MeshReachableMode; reason: string | null } {
|
|
if (!node) return { mode: 'unreachable', reason: 'unknown node' };
|
|
if (node.id === localNodeId || node.type !== 'remote') return { mode: 'local', reason: null };
|
|
if (node.mode === 'pilot_agent') return { mode: 'pilot', reason: null };
|
|
if (node.mode === 'proxy') {
|
|
if (!node.api_url) return { mode: 'unreachable', reason: 'api_url not set' };
|
|
if (!node.api_token) return { mode: 'unreachable', reason: 'api token missing' };
|
|
// Recent-failure cache surfaces the last failed dial so the
|
|
// operator sees a clear reason without triggering a redial
|
|
// storm.
|
|
const failure = MeshProxyTunnelDialer.getInstance().getRecentFailure(node.id);
|
|
if (failure) {
|
|
const reason = REACHABLE_REASON[failure.code] ?? failure.message ?? 'remote unreachable';
|
|
return { mode: 'unreachable', reason };
|
|
}
|
|
return { mode: 'proxy', reason: null };
|
|
}
|
|
return { mode: 'unreachable', reason: 'unknown node mode' };
|
|
}
|
|
|
|
public async getRouteDiagnostic(alias: string): Promise<MeshRouteDiagnostic> {
|
|
const target = this.lookupAliasGlobal(alias);
|
|
const lastError = this.routeErrorMap.get(alias) || null;
|
|
const lastProbeMs = this.routeLatencyMap.get(alias) ?? null;
|
|
|
|
if (!target) {
|
|
return { alias, target: null, pilot: { connected: false, lastSeen: null }, lastError, lastProbeMs, state: 'not authorized' };
|
|
}
|
|
|
|
const node = DatabaseService.getInstance().getNode(target.nodeId);
|
|
const routable = this.isNodeMeshConfigured(node);
|
|
// Pilot-mode routes surface live tunnel state; proxy-mode routes
|
|
// fall back to `routable` because the tunnel is opened on demand
|
|
// and a quiescent state is normal.
|
|
const pilotLive = node?.type === 'remote' && node.mode === 'pilot_agent'
|
|
? PilotTunnelManager.getInstance().hasActiveTunnel(target.nodeId)
|
|
: routable;
|
|
const lastSeen = node?.pilot_last_seen ?? null;
|
|
const optedIn = DatabaseService.getInstance().isMeshStackEnabled(target.nodeId, target.stackName);
|
|
|
|
let state: MeshRouteDiagnostic['state'];
|
|
if (!optedIn) state = 'not authorized';
|
|
else if (!routable || !pilotLive) state = 'tunnel down';
|
|
else if (lastError && Date.now() - lastError.ts < 60_000) state = 'unreachable';
|
|
else if (lastProbeMs !== null && lastProbeMs > SLOW_PROBE_THRESHOLD_MS) state = 'degraded';
|
|
else state = 'healthy';
|
|
|
|
return {
|
|
alias,
|
|
target: {
|
|
nodeId: target.nodeId,
|
|
stack: target.stackName,
|
|
service: target.serviceName,
|
|
port: target.port,
|
|
alias,
|
|
},
|
|
pilot: { connected: pilotLive, lastSeen },
|
|
lastError,
|
|
lastProbeMs,
|
|
state,
|
|
};
|
|
}
|
|
|
|
public async getNodeDiagnostic(nodeId: number): Promise<MeshNodeDiagnostic> {
|
|
const ptm = PilotTunnelManager.getInstance();
|
|
const bridge = ptm.getBridge(nodeId);
|
|
const node = DatabaseService.getInstance().getNode(nodeId);
|
|
const localNodeId = NodeRegistry.getInstance().getDefaultNodeId();
|
|
const isLocal = nodeId === localNodeId;
|
|
|
|
const aliasCacheRows = Array.from(this.aliasCache.values())
|
|
.filter((a) => a.nodeId === nodeId)
|
|
.map((a) => ({ host: a.host, targetNodeId: a.nodeId, port: a.port }));
|
|
|
|
const now = Date.now();
|
|
const activeStreams = Array.from(this.activeStreams.values()).map((s) => ({
|
|
streamId: s.streamId, alias: s.alias,
|
|
bytesIn: s.bytesIn, bytesOut: s.bytesOut,
|
|
ageMs: now - s.openedAt,
|
|
}));
|
|
|
|
const listenerCount = isLocal ? this.forwarder.getListenerPorts().length : 0;
|
|
return {
|
|
nodeId,
|
|
forwarder: {
|
|
listening: isLocal && this.isLocalForwarderActive(),
|
|
listenerCount,
|
|
},
|
|
pilot: {
|
|
connected: !!bridge,
|
|
bufferedAmount: bridge?.getBufferedAmount() ?? 0,
|
|
lastSeen: node?.pilot_last_seen ?? null,
|
|
},
|
|
activeStreams,
|
|
aliasCache: aliasCacheRows,
|
|
};
|
|
}
|
|
|
|
public async getStatus(): Promise<MeshNodeStatus[]> {
|
|
const db = DatabaseService.getInstance();
|
|
const nodes = db.getNodes();
|
|
const localNodeId = NodeRegistry.getInstance().getDefaultNodeId();
|
|
const localListening = this.isLocalForwarderActive();
|
|
const ptm = PilotTunnelManager.getInstance();
|
|
return nodes.map((node) => {
|
|
const reach = this.computeReachable(node, localNodeId);
|
|
return {
|
|
nodeId: node.id,
|
|
nodeName: node.name,
|
|
enabled: db.getNodeMeshEnabled(node.id),
|
|
localForwarderListening: node.id === localNodeId ? localListening : null,
|
|
// `pilotConnected` stays at its original meaning: a pilot
|
|
// tunnel is currently registered for this node. The
|
|
// Routing tab now derives badge state from `reachableMode`
|
|
// and reads `pilotConnected` only for the pilot-offline
|
|
// sub-state.
|
|
pilotConnected: node.type !== 'remote' || ptm.hasActiveTunnel(node.id),
|
|
reachableMode: reach.mode,
|
|
reachableReason: reach.reason,
|
|
optedInStacks: db.listMeshStacks(node.id).map((s) => s.stack_name),
|
|
activeStreamCount: this.activeStreams.size,
|
|
};
|
|
});
|
|
}
|
|
|
|
/** True when the local Sencho's forwarder is started and bound to at least one alias port. */
|
|
private isLocalForwarderActive(): boolean {
|
|
return this.started && this.forwarder.getListenerPorts().length > 0;
|
|
}
|
|
|
|
// mintSidecarToken / verifySidecarToken / spawnSidecar / stopSidecar /
|
|
// isSidecarRunning / handleSidecarResolve / sendSidecar /
|
|
// attachSidecarSocket are gone: the in-process MeshForwarder replaces
|
|
// the entire sidecar layer. Routing decisions happen via direct
|
|
// MeshService calls — no JWT minting, no separate container, no control
|
|
// WebSocket. See `docs/internal/architecture/mesh.md` for the new flow.
|
|
}
|
|
|
|
export type MeshErrorCode =
|
|
| 'no_target'
|
|
| 'port_collision'
|
|
| 'denied'
|
|
| 'agent_error'
|
|
| 'push_failed';
|
|
|
|
export class MeshError extends Error {
|
|
public readonly code: MeshErrorCode;
|
|
constructor(code: MeshErrorCode, message: string) {
|
|
super(message);
|
|
this.code = code;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Common surface of an outbound mesh TCP stream as MeshService consumes
|
|
* it. Both the central-side `PilotTunnelBridge.TcpStream` and the
|
|
* pilot-side `ReverseTcpStreamHandle` (from `mesh/tcpStreamSwitchboard.ts`) implement
|
|
* this shape structurally so MeshService.openCrossNode can splice bytes
|
|
* against either without caring which side initiated the stream.
|
|
*/
|
|
export interface MeshTcpStreamLike {
|
|
readonly streamId: number;
|
|
write(chunk: Buffer): boolean;
|
|
end(): void;
|
|
destroy(): void;
|
|
on(event: 'open', listener: () => void): this;
|
|
on(event: 'data', listener: (chunk: Buffer) => void): this;
|
|
on(event: 'error', listener: (err: Error) => void): this;
|
|
on(event: 'close', listener: () => void): this;
|
|
}
|
|
|
|
/**
|
|
* Pilot-side reverse dialer. Set by `PilotAgent` when the agent boots
|
|
* (Phase B); leaves MeshService.openCrossNode able to route outbound
|
|
* cross-node mesh traffic over the agent's outbound `tcp_open_reverse`
|
|
* frame instead of central's `PilotTunnelManager.getBridge`.
|
|
*/
|
|
export interface ReverseMeshDialer {
|
|
openMeshTcpStream(target: { nodeId: number; stack: string; service: string; port: number }): MeshTcpStreamLike | null;
|
|
}
|