Spaces:
Runtime error
Runtime error
File size: 22,241 Bytes
cd8bd0a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 | /**
* Live Dashboard WebSocket Server
*
* Separate process (runs alongside Next.js on port 20129).
* Forwards EventBus events to subscribed dashboard clients.
*
* Protocol:
* Client β Server: { type: "subscribe", channels: ["requests", "combo"] }
* Server β Client: { type: "event", channel: "requests", event: "request.started", data: {...} }
* Client β Server: { type: "ping" }
* Server β Client: { type: "pong" }
* Server β Client: { type: "welcome", version, sessionId, channels, backlog }
* Server β Client: { type: "error", code, message }
*/
import { WebSocketServer, WebSocket } from "ws";
import { jwtVerify } from "jose";
import { createServer, type IncomingMessage, type ServerResponse } from "http";
import { randomUUID } from "crypto";
// ββ Types βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
import type {
WsClientMessage,
WsServerMessage,
WsEventMessage,
WsAuthResult,
} from "./types";
import { emit, on, onAny, getEventHistory, type HistoryEntry } from "@/lib/events/eventBus";
import type { DashboardEventName, DashboardEventMap, DashboardChannel } from "@/lib/events/types";
import { CHANNEL_EVENTS, getChannelForEvent } from "@/lib/events/types";
import {
buildAllowedOrigins,
buildAllowedHosts,
isOriginAllowed as isOriginAllowedPure,
} from "./liveServerAllowList";
// ββ Config ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const DEFAULT_PORT = 20129;
// Loopback by default. Opt-in to LAN exposure via LIVE_WS_HOST=0.0.0.0 β the
// caller is then responsible for fronting it with a TLS terminator + origin
// allow-list. Mirrors the route guard "local-only by default" posture.
const DEFAULT_HOST = "127.0.0.1";
const HEARTBEAT_INTERVAL_MS = 15_000;
const HEARTBEAT_TIMEOUT_MS = 35_000;
const MAX_CLIENTS = 500;
const MAX_EVENTS_PER_SECOND = 100;
const MAX_PENDING_MESSAGES_PER_CLIENT = 32;
const MAX_PENDING_MESSAGE_BYTES = 16_384;
const ALLOWED_ORIGINS = buildAllowedOrigins();
const ALLOWED_HOSTS = buildAllowedHosts();
/**
* Whether the given Origin is acceptable for a WS upgrade.
*
* Delegates to `liveServerAllowList` for the actual policy; this wrapper
* exists so the connection handler can read the closure-bound allow-lists
* without re-parsing env on every connection.
*/
function isOriginAllowed(origin: string | undefined): boolean {
return isOriginAllowedPure(origin, process.env, {
allowedOrigins: ALLOWED_ORIGINS,
allowedHosts: ALLOWED_HOSTS,
});
}
// ββ Client State ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
interface ClientState {
ws: WebSocket;
sessionId: string;
subscribedChannels: Set<DashboardChannel>;
lastActivity: number;
/** Per-second rate limit counter */
eventCounter: number;
eventCounterReset: number;
/** Current IP for rate limiting */
remoteAddress: string;
}
const clients = new Map<string, ClientState>();
let eventHistoryBacklog: HistoryEntry[] = [];
const BACKLOG_MAX = 500;
// ββ Auth ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function toWebHeaders(headers: import("http").IncomingMessage["headers"]): Headers {
const webHeaders = new Headers();
for (const [name, value] of Object.entries(headers)) {
if (typeof value === "string") {
webHeaders.set(name, value);
} else if (Array.isArray(value)) {
webHeaders.set(name, name.toLowerCase() === "cookie" ? value.join("; ") : value.join(", "));
}
}
return webHeaders;
}
// Auth-module warmer. The SSE auth graph is large (hundreds of transitive
// modules); a cold dynamic import takes several seconds and runs synchronously
// enough to stall the single-threaded event loop. Loading it lazily inside the
// connection handler meant the FIRST API-key WebSocket connection blocked the
// loop long enough that any connection arriving in that window (e.g. a
// same-origin cookie client) could not complete its handshake and timed out.
// Memoize the import and warm it once during startup (before listen) so
// connection handling never pays that cost. Kept as a dynamic import (not a
// top-level static one) to preserve the sidecar's decoupling from the SSE auth
// graph at module-load time.
let authModulePromise: Promise<typeof import("../../sse/services/auth.ts")> | null = null;
function loadAuthModule(): Promise<typeof import("../../sse/services/auth.ts")> {
if (!authModulePromise) {
authModulePromise = import("../../sse/services/auth.ts");
}
return authModulePromise;
}
async function authorizeConnection(request: import("http").IncomingMessage): Promise<WsAuthResult> {
const sessionId = randomUUID().slice(0, 8);
// Token MUST come from the Authorization header (or X-Live-WS-Token).
// Query-string tokens leak into access logs, browser history, and Referer
// headers β a single screenshot of the URL bar exposes the API key.
const token = extractBearerToken(request) || extractAltTokenHeader(request);
// Browser WebSocket clients cannot set custom Authorization headers. When
// LiveWS is exposed same-origin through a reverse proxy, accept the existing
// dashboard session cookie before falling back to API-key authentication. Keep
// the check local to this sidecar so it does not import Next.js-only modules.
if (!token) {
if (await isDashboardCookieAuthenticated(request)) {
return { authorized: true, sessionId };
}
return { authorized: false, sessionId, error: "Missing token" };
}
try {
// Validate API key via the existing auth system (warmed at startup).
const { extractApiKey, isValidApiKey } = await loadAuthModule();
const apiKey = extractApiKey({ headers: { authorization: `Bearer ${token}` } } as any, {
allowUrl: false,
});
if (!apiKey || !(await isValidApiKey(apiKey))) {
return { authorized: false, sessionId, error: "Invalid API key" };
}
return { authorized: true, sessionId };
} catch {
return { authorized: false, sessionId, error: "Auth system unavailable" };
}
}
function extractAltTokenHeader(request: import("http").IncomingMessage): string | null {
const raw = request.headers["x-live-ws-token"];
if (Array.isArray(raw)) return raw[0] || null;
return typeof raw === "string" ? raw : null;
}
export function getCookieValueFromHeader(
headers: import("http").IncomingHttpHeaders,
name: string
): string | null {
const raw = headers.cookie;
const cookieHeader = Array.isArray(raw) ? raw.join("; ") : raw;
if (!cookieHeader) return null;
const escaped = name.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
// NOTE: \\s (not \s) β this is a plain template literal, so \s would collapse to a
// literal "s" and the pattern would only match auth_token when it is the FIRST cookie.
// Browsers serialize the Cookie header as "a=1; b=2", so the leading-cookie case
// (auth_token preceded by another cookie) must match too (#4004 same-origin proxy auth).
const match = cookieHeader.match(new RegExp(`(?:^|;\\s*)${escaped}=([^;]*)`));
return match ? decodeURIComponent(match[1]) : null;
}
async function isDashboardCookieAuthenticated(
request: import("http").IncomingMessage
): Promise<boolean> {
const token = getCookieValueFromHeader(request.headers, "auth_token");
if (!token || !process.env.JWT_SECRET) return false;
try {
const secret = new TextEncoder().encode(process.env.JWT_SECRET);
await jwtVerify(token, secret);
return true;
} catch {
return false;
}
}
function extractBearerToken(request: import("http").IncomingMessage): string | null {
const auth = request.headers["authorization"];
if (!auth || typeof auth !== "string") return null;
const match = auth.match(/^Bearer\s+(.+)$/i);
return match?.[1] || null;
}
// ββ Protocol Handler ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function handleMessage(clientId: string, raw: string): void {
const client = clients.get(clientId);
if (!client) return;
// Rate limiting
const now = Date.now();
if (now - client.eventCounterReset > 1000) {
client.eventCounter = 0;
client.eventCounterReset = now;
}
client.eventCounter++;
if (client.eventCounter > MAX_EVENTS_PER_SECOND) {
sendTo(client.ws, { type: "error", code: "RATE_LIMITED", message: "Too many messages" });
return;
}
let msg: WsClientMessage;
try {
msg = JSON.parse(raw);
} catch {
sendTo(client.ws, { type: "error", code: "PARSE_ERROR", message: "Invalid JSON" });
return;
}
client.lastActivity = now;
switch (msg.type) {
case "subscribe": {
client.subscribedChannels = new Set(msg.channels);
// Send buffered events that match subscribed channels
const relevantHistory = eventHistoryBacklog.filter((h) => {
const ch = getChannelForEvent(h.event as DashboardEventName);
return ch && msg.channels.includes(ch);
});
sendTo(client.ws, {
type: "welcome",
version: "1.0.0",
sessionId: client.sessionId,
serverTime: now,
channels: msg.channels,
backlog: relevantHistory.length,
data: relevantHistory.map((h) => ({
event: h.event,
channel: getChannelForEvent(h.event as DashboardEventName),
data: h.payload,
timestamp: h.timestamp,
})),
} as any);
break;
}
case "ping":
sendTo(client.ws, { type: "pong" } as WsServerMessage);
break;
}
}
// ββ Send ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function sendTo(ws: WebSocket, msg: WsServerMessage | Record<string, unknown>): void {
if (ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(msg));
}
}
// ββ Event Bus β WebSocket Bridge ββββββββββββββββββββββββββββββββββββββββββ
function publishDashboardEvent(
event: DashboardEventName,
payload: unknown,
timestamp = Date.now()
): boolean {
const channel = getChannelForEvent(event);
if (!channel) return false;
// Store in backlog so clients that subscribe just after a run still receive it.
eventHistoryBacklog.push({ event, payload, timestamp });
if (eventHistoryBacklog.length > BACKLOG_MAX) {
eventHistoryBacklog.shift();
}
const msg: WsEventMessage = {
type: "event",
channel,
event,
data: payload,
};
for (const [clientId, client] of clients) {
if (client.ws.readyState !== WebSocket.OPEN) {
clients.delete(clientId);
continue;
}
if (client.subscribedChannels.has(channel)) {
sendTo(client.ws, msg);
}
}
return true;
}
function subscribeToEventBus(): () => void {
return onAny((event: DashboardEventName, payload: unknown) => {
publishDashboardEvent(event, payload);
});
}
function isLoopbackRequest(req: IncomingMessage): boolean {
const addr = req.socket.remoteAddress;
return addr === "127.0.0.1" || addr === "::1" || addr === "::ffff:127.0.0.1";
}
function handleInternalEventRequest(req: IncomingMessage, res: ServerResponse): void {
if (req.method !== "POST" || req.url !== "/__omniroute_event") {
res.writeHead(404).end();
return;
}
if (!isLoopbackRequest(req)) {
res.writeHead(403, { "content-type": "application/json" }).end(JSON.stringify({ ok: false }));
return;
}
let body = "";
req.setEncoding("utf8");
req.on("data", (chunk) => {
body += chunk;
if (body.length > 1_000_000) {
req.destroy(new Error("Internal event payload too large"));
}
});
req.on("error", () => {
if (!res.headersSent) res.writeHead(400).end();
});
req.on("end", () => {
try {
const parsed = JSON.parse(body || "{}");
const event = parsed.event as DashboardEventName;
if (!Object.values(CHANNEL_EVENTS).some((events) => events.includes(event))) {
res
.writeHead(400, { "content-type": "application/json" })
.end(JSON.stringify({ ok: false }));
return;
}
const ok = publishDashboardEvent(
event,
parsed.payload,
Number(parsed.timestamp) || Date.now()
);
res
.writeHead(ok ? 202 : 400, { "content-type": "application/json" })
.end(JSON.stringify({ ok }));
} catch {
res.writeHead(400, { "content-type": "application/json" }).end(JSON.stringify({ ok: false }));
}
});
}
async function seedLatestCompressionRunFromDb(): Promise<void> {
try {
const { getLatestCompressionAnalyticsRun } = await import("@/lib/db/compressionAnalytics");
const row = getLatestCompressionAnalyticsRun();
if (!row) return;
const originalTokens = Number(row.original_tokens) || 0;
const compressedTokens = Number(row.compressed_tokens) || 0;
const savingsPercent =
originalTokens > 0
? Math.round(((originalTokens - compressedTokens) / originalTokens) * 100)
: 0;
const timestamp = Number.isFinite(Date.parse(row.timestamp))
? Date.parse(row.timestamp)
: Date.now();
publishDashboardEvent(
"compression.completed",
{
requestId: row.request_id || `analytics-${row.id}`,
comboId: row.compression_combo_id || row.combo_id || null,
mode: row.mode,
originalTokens,
compressedTokens,
savingsPercent,
engineBreakdown: [
{
engine: row.engine || row.mode || "compression",
originalTokens,
compressedTokens,
savingsPercent,
techniquesUsed: [],
rulesApplied: [],
durationMs: row.duration_ms ?? undefined,
},
],
validationWarnings: [],
fallbackApplied: Boolean(row.validation_fallback),
timestamp,
},
timestamp
);
console.log(
"[LiveWS] Seeded latest compression run from analytics: %s",
row.request_id || row.id
);
} catch (err) {
console.warn(
"[LiveWS] Could not seed compression analytics backlog: %s",
err instanceof Error ? err.message : String(err)
);
}
}
// ββ Heartbeat βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function startHeartbeat(server: WebSocketServer): void {
const interval = setInterval(() => {
const now = Date.now();
for (const [clientId, client] of clients) {
if (client.ws.readyState !== WebSocket.OPEN) {
clients.delete(clientId);
continue;
}
// Check heartbeat timeout
if (now - client.lastActivity > HEARTBEAT_TIMEOUT_MS) {
client.ws.terminate();
clients.delete(clientId);
continue;
}
// Send ping
sendTo(client.ws, { type: "pong" } as WsServerMessage);
}
}, HEARTBEAT_INTERVAL_MS);
// Don't keep the process alive solely for the heartbeat (it is also cleared on close).
(interval as { unref?: () => void })?.unref?.();
server.on("close", () => clearInterval(interval));
}
// ββ Server Start ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
/**
* Start the live dashboard WebSocket server.
*
* Bound to 127.0.0.1 by default. Set LIVE_WS_HOST=0.0.0.0 to expose on the
* LAN β the caller is then responsible for fronting it with TLS + an Origin
* allow-list via LIVE_WS_ALLOWED_ORIGINS.
*/
export async function startLiveDashboardServer(
port = DEFAULT_PORT,
host = DEFAULT_HOST
): Promise<import("http").Server> {
if (!process.env.JWT_SECRET) {
console.warn(
" \x1b[33mβ Warning: JWT_SECRET is not set in the environment.\x1b[0m\n" +
" Dashboard cookie-based WebSocket authentication will fail.\n" +
" Please ensure JWT_SECRET is configured in your .env file."
);
}
const server = createServer((req, res) => {
handleInternalEventRequest(req, res);
});
const wss = new WebSocketServer({ server });
// Subscribe to EventBus
const unsubscribe = subscribeToEventBus();
await seedLatestCompressionRunFromDb();
// Warm the auth module before accepting clients so the first API-key connection
// does not block the event loop on a cold import β which would starve concurrent
// WebSocket handshakes (see loadAuthModule). A failed warm is non-fatal: the
// handler retries the import lazily.
await loadAuthModule().catch(() => {});
wss.on("connection", async (ws, request) => {
const pendingMessages: string[] = [];
let activeClientId: string | null = null;
// Clients can send the subscribe frame immediately after the WS open event,
// while dashboard cookie/API-key auth is still resolving. Queue those early
// messages so the first subscribe is not dropped.
ws.on("message", (data) => {
const raw = data.toString();
if (!activeClientId) {
if (
pendingMessages.length >= MAX_PENDING_MESSAGES_PER_CLIENT ||
raw.length > MAX_PENDING_MESSAGE_BYTES
) {
sendTo(ws, { type: "error", code: "RATE_LIMITED", message: "Too many early messages" });
ws.close(4008, "Too many early messages");
return;
}
pendingMessages.push(raw);
return;
}
handleMessage(activeClientId, raw);
});
// Origin check β browsers always send Origin on the WS upgrade; reject
// unknown origins to stop drive-by cross-origin WebSocket from a victim
// page. Non-browser clients (CLI / MCP) omit Origin and are accepted
// only when bound to loopback (see isOriginAllowed).
const origin = request.headers["origin"];
const originStr = Array.isArray(origin) ? origin[0] : origin;
if (!isOriginAllowed(originStr)) {
sendTo(ws, { type: "error", code: "FORBIDDEN_ORIGIN", message: "Origin not allowed" });
ws.close(4003, "Forbidden origin");
return;
}
// Enforce max clients
if (clients.size >= MAX_CLIENTS) {
sendTo(ws, { type: "error", code: "SERVER_FULL", message: "Max clients reached" });
ws.close(1013, "Server full");
return;
}
// Authorize
const auth = await authorizeConnection(request);
if (!auth.authorized) {
sendTo(ws, { type: "error", code: "UNAUTHORIZED", message: auth.error || "Unauthorized" });
ws.close(4001, "Unauthorized");
return;
}
const clientId = auth.sessionId;
activeClientId = clientId;
const client: ClientState = {
ws,
sessionId: clientId,
subscribedChannels: new Set(),
lastActivity: Date.now(),
eventCounter: 0,
eventCounterReset: Date.now(),
remoteAddress: request.socket?.remoteAddress || "unknown",
};
clients.set(clientId, client);
// Constant format string + %s args β keeps clientId / remoteAddress out
// of the format slot so a malicious value cannot forge log lines via
// injected format specifiers (CWE-134).
console.log(
"[LiveWS] Client connected: %s (%s) [%d total]",
clientId,
client.remoteAddress,
clients.size
);
// Replay any subscribe/ping frames sent while auth was still pending.
for (const raw of pendingMessages.splice(0)) {
handleMessage(clientId, raw);
}
// Handle close
ws.on("close", () => {
clients.delete(clientId);
console.log("[LiveWS] Client disconnected: %s [%d remaining]", clientId, clients.size);
});
// Handle errors
ws.on("error", (err) => {
console.error("[LiveWS] Client error %s: %s", clientId, err.message);
clients.delete(clientId);
});
});
// Heartbeat
startHeartbeat(wss);
// Cleanup on close
wss.on("close", () => {
unsubscribe();
clients.clear();
});
return new Promise((resolve) => {
server.listen(port, host, () => {
console.log("[LiveWS] Dashboard WebSocket server listening on %s:%d", host, port);
resolve(server);
});
});
}
// ββ Auto-start on import ββββββββββββββββββββββββββββββββββββββββββββββββββ
//
// Default: ON, bound to loopback (127.0.0.1). The live dashboard WebSocket
// starts automatically unless explicitly disabled. To disable, set:
// OMNIROUTE_ENABLE_LIVE_WS=0 (or "false")
//
// LAN exposure remains opt-in via LIVE_WS_HOST=0.0.0.0 combined with
// LIVE_WS_ALLOWED_ORIGINS. DEFAULT_HOST stays "127.0.0.1".
//
// Build/test environments never auto-start regardless of the flag.
function isBuildOrTest(): boolean {
return (
process.env.NEXT_PHASE === "phase-production-build" ||
process.env.NODE_ENV === "test" ||
process.env.VITEST !== undefined ||
process.argv.some((arg) => arg.includes("test"))
);
}
export function isLiveWsEnabled(): boolean {
const v = process.env.OMNIROUTE_ENABLE_LIVE_WS;
if (v === undefined) return true; // default ON (loopback-bound)
return v === "1" || v.toLowerCase() === "true";
}
if (!isBuildOrTest() && isLiveWsEnabled()) {
const port = parseInt(process.env.LIVE_WS_PORT || String(DEFAULT_PORT), 10);
const host = process.env.LIVE_WS_HOST || DEFAULT_HOST;
startLiveDashboardServer(port, host).catch((err) => {
console.error("[LiveWS] Failed to start: %s", err instanceof Error ? err.message : String(err));
});
}
|