import fs from "node:fs"; import type { Command } from "commander"; import { CONFIG_PATH_CLAWDBOT, type GatewayAuthMode, loadConfig, readConfigFileSnapshot, resolveGatewayPort, } from "../config/config.js"; import { GATEWAY_LAUNCH_AGENT_LABEL, GATEWAY_SYSTEMD_SERVICE_NAME, GATEWAY_WINDOWS_TASK_NAME, } from "../daemon/constants.js"; import { resolveGatewayService } from "../daemon/service.js"; import { resolveGatewayAuth } from "../gateway/auth.js"; import { callGateway } from "../gateway/call.js"; import { startGatewayServer } from "../gateway/server.js"; import { type GatewayWsLogStyle, setGatewayWsLogStyle, } from "../gateway/ws-logging.js"; import { setVerbose } from "../globals.js"; import { GatewayLockError } from "../infra/gateway-lock.js"; import { formatPortDiagnostics, inspectPortUsage } from "../infra/ports.js"; import { createSubsystemLogger } from "../logging.js"; import { defaultRuntime } from "../runtime.js"; import { forceFreePortAndWait } from "./ports.js"; import { withProgress } from "./progress.js"; type GatewayRpcOpts = { url?: string; token?: string; password?: string; timeout?: string; expectFinal?: boolean; }; type GatewayRunOpts = { port?: unknown; bind?: unknown; token?: unknown; auth?: unknown; password?: unknown; tailscale?: unknown; tailscaleResetOnExit?: boolean; allowUnconfigured?: boolean; force?: boolean; verbose?: boolean; wsLog?: unknown; compact?: boolean; rawStream?: boolean; rawStreamPath?: unknown; }; type GatewayRunParams = { legacyTokenEnv?: boolean; }; const gatewayLog = createSubsystemLogger("gateway"); type GatewayRunSignalAction = "stop" | "restart"; function parsePort(raw: unknown): number | null { if (raw === undefined || raw === null) return null; const value = typeof raw === "string" ? raw : typeof raw === "number" || typeof raw === "bigint" ? raw.toString() : null; if (value === null) return null; const parsed = Number.parseInt(value, 10); if (!Number.isFinite(parsed) || parsed <= 0) return null; return parsed; } const toOptionString = (value: unknown): string | undefined => { if (typeof value === "string") return value; if (typeof value === "number" || typeof value === "bigint") return value.toString(); return undefined; }; function describeUnknownError(err: unknown): string { if (err instanceof Error) return err.message; if (typeof err === "string") return err; if (typeof err === "number" || typeof err === "bigint") return err.toString(); if (typeof err === "boolean") return err ? "true" : "false"; if (err && typeof err === "object") { if ("message" in err && typeof err.message === "string") { return err.message; } try { return JSON.stringify(err); } catch { return "Unknown error"; } } return "Unknown error"; } function extractGatewayMiskeys(parsed: unknown): { hasGatewayToken: boolean; hasRemoteToken: boolean; } { if (!parsed || typeof parsed !== "object") { return { hasGatewayToken: false, hasRemoteToken: false }; } const gateway = (parsed as Record).gateway; if (!gateway || typeof gateway !== "object") { return { hasGatewayToken: false, hasRemoteToken: false }; } const hasGatewayToken = "token" in (gateway as Record); const remote = (gateway as Record).remote; const hasRemoteToken = remote && typeof remote === "object" ? "token" in (remote as Record) : false; return { hasGatewayToken, hasRemoteToken }; } function renderGatewayServiceStopHints(): string[] { switch (process.platform) { case "darwin": return [ "Tip: clawdbot daemon stop", `Or: launchctl bootout gui/$UID/${GATEWAY_LAUNCH_AGENT_LABEL}`, ]; case "linux": return [ "Tip: clawdbot daemon stop", `Or: systemctl --user stop ${GATEWAY_SYSTEMD_SERVICE_NAME}.service`, ]; case "win32": return [ "Tip: clawdbot daemon stop", `Or: schtasks /End /TN "${GATEWAY_WINDOWS_TASK_NAME}"`, ]; default: return ["Tip: clawdbot daemon stop"]; } } async function maybeExplainGatewayServiceStop() { const service = resolveGatewayService(); let loaded: boolean | null = null; try { loaded = await service.isLoaded({ env: process.env }); } catch { loaded = null; } if (loaded === false) return; defaultRuntime.error( loaded ? `Gateway service appears ${service.loadedText}. Stop it first.` : "Gateway service status unknown; if supervised, stop it first.", ); for (const hint of renderGatewayServiceStopHints()) { defaultRuntime.error(hint); } } async function runGatewayLoop(params: { start: () => Promise>>; runtime: typeof defaultRuntime; }) { let server: Awaited> | null = null; let shuttingDown = false; let restartResolver: (() => void) | null = null; const cleanupSignals = () => { process.removeListener("SIGTERM", onSigterm); process.removeListener("SIGINT", onSigint); process.removeListener("SIGUSR1", onSigusr1); }; const request = (action: GatewayRunSignalAction, signal: string) => { if (shuttingDown) { gatewayLog.info(`received ${signal} during shutdown; ignoring`); return; } shuttingDown = true; const isRestart = action === "restart"; gatewayLog.info( `received ${signal}; ${isRestart ? "restarting" : "shutting down"}`, ); const forceExitTimer = setTimeout(() => { gatewayLog.error("shutdown timed out; exiting without full cleanup"); cleanupSignals(); params.runtime.exit(0); }, 5000); void (async () => { try { await server?.close({ reason: isRestart ? "gateway restarting" : "gateway stopping", restartExpectedMs: isRestart ? 1500 : null, }); } catch (err) { gatewayLog.error(`shutdown error: ${String(err)}`); } finally { clearTimeout(forceExitTimer); server = null; if (isRestart) { shuttingDown = false; restartResolver?.(); } else { cleanupSignals(); params.runtime.exit(0); } } })(); }; const onSigterm = () => request("stop", "SIGTERM"); const onSigint = () => request("stop", "SIGINT"); const onSigusr1 = () => request("restart", "SIGUSR1"); process.on("SIGTERM", onSigterm); process.on("SIGINT", onSigint); process.on("SIGUSR1", onSigusr1); try { // Keep process alive; SIGUSR1 triggers an in-process restart (no supervisor required). // SIGTERM/SIGINT still exit after a graceful shutdown. // eslint-disable-next-line no-constant-condition while (true) { server = await params.start(); await new Promise((resolve) => { restartResolver = resolve; }); } } finally { cleanupSignals(); } } const gatewayCallOpts = (cmd: Command) => cmd .option( "--url ", "Gateway WebSocket URL (defaults to gateway.remote.url when configured)", ) .option("--token ", "Gateway token (if required)") .option("--password ", "Gateway password (password auth)") .option("--timeout ", "Timeout in ms", "10000") .option("--expect-final", "Wait for final response (agent)", false); const callGatewayCli = async ( method: string, opts: GatewayRpcOpts, params?: unknown, ) => withProgress( { label: `Gateway ${method}`, indeterminate: true, enabled: true, }, async () => await callGateway({ url: opts.url, token: opts.token, password: opts.password, method, params, expectFinal: Boolean(opts.expectFinal), timeoutMs: Number(opts.timeout ?? 10_000), clientName: "cli", mode: "cli", }), ); async function runGatewayCommand( opts: GatewayRunOpts, params: GatewayRunParams = {}, ) { if (params.legacyTokenEnv) { const legacyToken = process.env.CLAWDIS_GATEWAY_TOKEN; if (legacyToken && !process.env.CLAWDBOT_GATEWAY_TOKEN) { process.env.CLAWDBOT_GATEWAY_TOKEN = legacyToken; } } setVerbose(Boolean(opts.verbose)); const wsLogRaw = (opts.compact ? "compact" : opts.wsLog) as | string | undefined; const wsLogStyle: GatewayWsLogStyle = wsLogRaw === "compact" ? "compact" : wsLogRaw === "full" ? "full" : "auto"; if ( wsLogRaw !== undefined && wsLogRaw !== "auto" && wsLogRaw !== "compact" && wsLogRaw !== "full" ) { defaultRuntime.error('Invalid --ws-log (use "auto", "full", "compact")'); defaultRuntime.exit(1); } setGatewayWsLogStyle(wsLogStyle); if (opts.rawStream) { process.env.CLAWDBOT_RAW_STREAM = "1"; } const rawStreamPath = toOptionString(opts.rawStreamPath); if (rawStreamPath) { process.env.CLAWDBOT_RAW_STREAM_PATH = rawStreamPath; } const cfg = loadConfig(); const portOverride = parsePort(opts.port); if (opts.port !== undefined && portOverride === null) { defaultRuntime.error("Invalid port"); defaultRuntime.exit(1); } const port = portOverride ?? resolveGatewayPort(cfg); if (!Number.isFinite(port) || port <= 0) { defaultRuntime.error("Invalid port"); defaultRuntime.exit(1); } if (opts.force) { try { const { killed, waitedMs, escalatedToSigkill } = await forceFreePortAndWait(port, { timeoutMs: 2000, intervalMs: 100, sigtermTimeoutMs: 700, }); if (killed.length === 0) { gatewayLog.info(`force: no listeners on port ${port}`); } else { for (const proc of killed) { gatewayLog.info( `force: killed pid ${proc.pid}${proc.command ? ` (${proc.command})` : ""} on port ${port}`, ); } if (escalatedToSigkill) { gatewayLog.info( `force: escalated to SIGKILL while freeing port ${port}`, ); } if (waitedMs > 0) { gatewayLog.info( `force: waited ${waitedMs}ms for port ${port} to free`, ); } } } catch (err) { defaultRuntime.error(`Force: ${String(err)}`); defaultRuntime.exit(1); return; } } if (opts.token) { const token = toOptionString(opts.token); if (token) process.env.CLAWDBOT_GATEWAY_TOKEN = token; } const authModeRaw = toOptionString(opts.auth); const authMode: GatewayAuthMode | null = authModeRaw === "token" || authModeRaw === "password" ? authModeRaw : null; if (authModeRaw && !authMode) { defaultRuntime.error('Invalid --auth (use "token" or "password")'); defaultRuntime.exit(1); return; } const tailscaleRaw = toOptionString(opts.tailscale); const tailscaleMode = tailscaleRaw === "off" || tailscaleRaw === "serve" || tailscaleRaw === "funnel" ? tailscaleRaw : null; if (tailscaleRaw && !tailscaleMode) { defaultRuntime.error( 'Invalid --tailscale (use "off", "serve", or "funnel")', ); defaultRuntime.exit(1); return; } const passwordRaw = toOptionString(opts.password); const tokenRaw = toOptionString(opts.token); const configExists = fs.existsSync(CONFIG_PATH_CLAWDBOT); const mode = cfg.gateway?.mode; if (!opts.allowUnconfigured && mode !== "local") { if (!configExists) { defaultRuntime.error( "Missing config. Run `clawdbot setup` or set gateway.mode=local (or pass --allow-unconfigured).", ); } else { defaultRuntime.error( `Gateway start blocked: set gateway.mode=local (current: ${mode ?? "unset"}) or pass --allow-unconfigured.`, ); } defaultRuntime.exit(1); return; } const bindRaw = toOptionString(opts.bind) ?? cfg.gateway?.bind ?? "loopback"; const bind = bindRaw === "loopback" || bindRaw === "tailnet" || bindRaw === "lan" || bindRaw === "auto" ? bindRaw : null; if (!bind) { defaultRuntime.error( 'Invalid --bind (use "loopback", "tailnet", "lan", or "auto")', ); defaultRuntime.exit(1); return; } const snapshot = await readConfigFileSnapshot().catch(() => null); const miskeys = extractGatewayMiskeys(snapshot?.parsed); const authConfig = { ...cfg.gateway?.auth, ...(authMode ? { mode: authMode } : {}), ...(passwordRaw ? { password: passwordRaw } : {}), ...(tokenRaw ? { token: tokenRaw } : {}), }; const resolvedAuth = resolveGatewayAuth({ authConfig, env: process.env, tailscaleMode: tailscaleMode ?? cfg.gateway?.tailscale?.mode ?? "off", }); const resolvedAuthMode = resolvedAuth.mode; const tokenValue = resolvedAuth.token; const passwordValue = resolvedAuth.password; const authHints: string[] = []; if (miskeys.hasGatewayToken) { authHints.push( 'Found "gateway.token" in config. Use "gateway.auth.token" instead.', ); } if (miskeys.hasRemoteToken) { authHints.push( '"gateway.remote.token" is for remote CLI calls; it does not enable local gateway auth.', ); } if (resolvedAuthMode === "token" && !tokenValue) { defaultRuntime.error( [ "Gateway auth is set to token, but no token is configured.", "Set gateway.auth.token (or CLAWDBOT_GATEWAY_TOKEN), or pass --token.", ...authHints, ] .filter(Boolean) .join("\n"), ); defaultRuntime.exit(1); return; } if (resolvedAuthMode === "password" && !passwordValue) { defaultRuntime.error( [ "Gateway auth is set to password, but no password is configured.", "Set gateway.auth.password (or CLAWDBOT_GATEWAY_PASSWORD), or pass --password.", ...authHints, ] .filter(Boolean) .join("\n"), ); defaultRuntime.exit(1); return; } if (bind !== "loopback" && resolvedAuthMode === "none") { defaultRuntime.error( [ `Refusing to bind gateway to ${bind} without auth.`, "Set gateway.auth.token (or CLAWDBOT_GATEWAY_TOKEN) or pass --token.", ...authHints, ] .filter(Boolean) .join("\n"), ); defaultRuntime.exit(1); return; } try { await runGatewayLoop({ runtime: defaultRuntime, start: async () => await startGatewayServer(port, { bind, auth: authMode || passwordRaw || tokenRaw || authModeRaw ? { mode: authMode ?? undefined, token: tokenRaw, password: passwordRaw, } : undefined, tailscale: tailscaleMode || opts.tailscaleResetOnExit ? { mode: tailscaleMode ?? undefined, resetOnExit: Boolean(opts.tailscaleResetOnExit), } : undefined, }), }); } catch (err) { if ( err instanceof GatewayLockError || (err && typeof err === "object" && (err as { name?: string }).name === "GatewayLockError") ) { const errMessage = describeUnknownError(err); defaultRuntime.error( `Gateway failed to start: ${errMessage}\nIf the gateway is supervised, stop it with: clawdbot daemon stop`, ); try { const diagnostics = await inspectPortUsage(port); if (diagnostics.status === "busy") { for (const line of formatPortDiagnostics(diagnostics)) { defaultRuntime.error(line); } } } catch { // ignore diagnostics failures } await maybeExplainGatewayServiceStop(); defaultRuntime.exit(1); return; } defaultRuntime.error(`Gateway failed to start: ${String(err)}`); defaultRuntime.exit(1); } } function addGatewayRunCommand( cmd: Command, params: GatewayRunParams = {}, ): Command { return cmd .option("--port ", "Port for the gateway WebSocket") .option( "--bind ", 'Bind mode ("loopback"|"tailnet"|"lan"|"auto"). Defaults to config gateway.bind (or loopback).', ) .option( "--token ", "Shared token required in connect.params.auth.token (default: CLAWDBOT_GATEWAY_TOKEN env if set)", ) .option("--auth ", 'Gateway auth mode ("token"|"password")') .option("--password ", "Password for auth mode=password") .option( "--tailscale ", 'Tailscale exposure mode ("off"|"serve"|"funnel")', ) .option( "--tailscale-reset-on-exit", "Reset Tailscale serve/funnel configuration on shutdown", false, ) .option( "--allow-unconfigured", "Allow gateway start without gateway.mode=local in config", false, ) .option( "--force", "Kill any existing listener on the target port before starting", false, ) .option("--verbose", "Verbose logging to stdout/stderr", false) .option( "--ws-log