File size: 12,022 Bytes
7421850 | 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 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import http from 'node:http';
import { randomUUID } from 'node:crypto';
import { EventEmitter } from 'node:events';
import { WebSocketServer, type WebSocket } from 'ws';
import type {
NetworkLog,
ConsoleLogPayload,
InspectorConsoleLog,
} from './types.js';
import { INDEX_HTML, CLIENT_JS } from './_client-assets.js';
export type {
NetworkLog,
ConsoleLogPayload,
InspectorConsoleLog,
} from './types.js';
interface IncomingNetworkPayload extends Partial<NetworkLog> {
chunk?: {
index: number;
data: string;
timestamp: number;
};
}
export interface SessionInfo {
sessionId: string;
ws: WebSocket;
lastPing: number;
}
/**
* DevTools Viewer
*
* Receives logs via WebSocket from CLI sessions.
*/
export class DevTools extends EventEmitter {
private static instance: DevTools | undefined;
private logs: NetworkLog[] = [];
private consoleLogs: InspectorConsoleLog[] = [];
private server: http.Server | null = null;
private wss: WebSocketServer | null = null;
private sessions = new Map<string, SessionInfo>();
private heartbeatTimer: NodeJS.Timeout | null = null;
private port = 25417;
private static readonly DEFAULT_PORT = 25417;
private static readonly MAX_PORT_RETRIES = 10;
private constructor() {
super();
// Each SSE client adds 3 listeners; raise the limit to avoid warnings
this.setMaxListeners(50);
}
static getInstance(): DevTools {
if (!DevTools.instance) {
DevTools.instance = new DevTools();
}
return DevTools.instance;
}
addInternalConsoleLog(
payload: ConsoleLogPayload,
sessionId?: string,
timestamp?: number,
) {
const entry: InspectorConsoleLog = {
...payload,
id: randomUUID(),
sessionId,
timestamp: timestamp || Date.now(),
};
this.consoleLogs.push(entry);
if (this.consoleLogs.length > 5000) this.consoleLogs.shift();
this.emit('console-update', entry);
}
addInternalNetworkLog(
payload: IncomingNetworkPayload,
sessionId?: string,
timestamp?: number,
) {
if (!payload.id) return;
const existingIndex = this.logs.findIndex((l) => l.id === payload.id);
if (existingIndex > -1) {
const existing = this.logs[existingIndex];
// Handle chunk accumulation
if (payload.chunk) {
const chunks = existing.chunks || [];
chunks.push(payload.chunk);
this.logs[existingIndex] = {
...existing,
chunks,
sessionId: sessionId || existing.sessionId,
};
} else {
this.logs[existingIndex] = {
...existing,
...payload,
sessionId: sessionId || existing.sessionId,
// Drop chunks once we have the full response body — the data
// is redundant and keeping both can blow past V8's string limit
// when serializing the snapshot.
chunks: payload.response?.body ? undefined : existing.chunks,
response: payload.response
? { ...existing.response, ...payload.response }
: existing.response,
} as NetworkLog;
}
this.emit('update', this.logs[existingIndex]);
} else if (payload.url) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const entry = {
...payload,
sessionId,
timestamp: timestamp || Date.now(),
chunks: payload.chunk ? [payload.chunk] : undefined,
} as NetworkLog;
this.logs.push(entry);
if (this.logs.length > 10) this.logs.shift();
this.emit('update', entry);
}
}
getUrl(): string {
return `http://127.0.0.1:${this.port}`;
}
getPort(): number {
return this.port;
}
stop(): Promise<void> {
return new Promise((resolve) => {
if (this.heartbeatTimer) {
clearInterval(this.heartbeatTimer);
this.heartbeatTimer = null;
}
if (this.wss) {
this.wss.close();
this.wss = null;
}
if (this.server) {
this.server.close(() => resolve());
this.server = null;
} else {
resolve();
}
// Reset singleton so a fresh start() is possible
DevTools.instance = undefined;
});
}
start(): Promise<string> {
return new Promise((resolve, reject) => {
if (this.server) {
resolve(this.getUrl());
return;
}
this.server = http.createServer((req, res) => {
// Only allow same-origin requests — the client is served from this
// server so cross-origin access is unnecessary and would let arbitrary
// websites exfiltrate logs (which may contain API keys/headers).
const origin = req.headers.origin;
if (origin) {
const allowed = `http://127.0.0.1:${this.port}`;
if (origin === allowed) {
res.setHeader('Access-Control-Allow-Origin', allowed);
}
}
// API routes
if (req.url === '/api/trigger-debugger' && req.method === 'POST') {
let body = '';
req.on('data', (chunk) => {
body += chunk;
});
req.on('end', () => {
try {
const parsed: unknown = JSON.parse(body);
if (
typeof parsed !== 'object' ||
parsed === null ||
!('sessionId' in parsed) ||
typeof parsed.sessionId !== 'string'
) {
res.writeHead(400, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ error: 'Invalid request' }));
return;
}
const sessionId = parsed.sessionId;
const session = this.sessions.get(sessionId);
if (session) {
session.ws.send(JSON.stringify({ type: 'trigger-debugger' }));
res.writeHead(200, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ success: true }));
} else {
res.writeHead(404, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ error: 'Session not found' }));
}
} catch {
res.writeHead(400, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ error: 'Invalid request' }));
}
});
} else if (req.url === '/events') {
res.writeHead(200, {
'Content-Type': 'text/event-stream',
'Cache-Control': 'no-cache',
Connection: 'keep-alive',
});
// Send full snapshot on connect
const snapshot = JSON.stringify({
networkLogs: this.logs,
consoleLogs: this.consoleLogs,
sessions: Array.from(this.sessions.keys()),
});
res.write(`event: snapshot\ndata: ${snapshot}\n\n`);
// Incremental updates
const onNetwork = (log: NetworkLog) => {
res.write(`event: network\ndata: ${JSON.stringify(log)}\n\n`);
};
const onConsole = (log: InspectorConsoleLog) => {
res.write(`event: console\ndata: ${JSON.stringify(log)}\n\n`);
};
const onSession = () => {
const sessions = Array.from(this.sessions.keys());
res.write(`event: session\ndata: ${JSON.stringify(sessions)}\n\n`);
};
this.on('update', onNetwork);
this.on('console-update', onConsole);
this.on('session-update', onSession);
req.on('close', () => {
this.off('update', onNetwork);
this.off('console-update', onConsole);
this.off('session-update', onSession);
});
} else if (req.url === '/' || req.url === '/index.html') {
res.writeHead(200, { 'Content-Type': 'text/html' });
res.end(INDEX_HTML);
} else if (req.url === '/assets/main.js') {
res.writeHead(200, { 'Content-Type': 'application/javascript' });
res.end(CLIENT_JS);
} else {
res.writeHead(404);
res.end('Not Found');
}
});
this.server.on('error', (e: unknown) => {
if (
typeof e === 'object' &&
e !== null &&
'code' in e &&
e.code === 'EADDRINUSE'
) {
if (this.port - DevTools.DEFAULT_PORT >= DevTools.MAX_PORT_RETRIES) {
reject(
new Error(
`DevTools: all ports ${DevTools.DEFAULT_PORT}–${this.port} in use`,
),
);
return;
}
this.port++;
this.server?.listen(this.port, '127.0.0.1');
} else {
reject(e instanceof Error ? e : new Error(String(e)));
}
});
this.server.listen(this.port, '127.0.0.1', () => {
this.setupWebSocketServer();
resolve(this.getUrl());
});
});
}
private setupWebSocketServer() {
if (!this.server) return;
this.wss = new WebSocketServer({ server: this.server, path: '/ws' });
this.wss.on('connection', (ws: WebSocket) => {
let sessionId: string | null = null;
ws.on('message', (data: Buffer) => {
try {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const message = JSON.parse(data.toString());
// Handle registration first
if (message.type === 'register') {
sessionId = String(message.sessionId);
if (!sessionId) return;
this.sessions.set(sessionId, {
sessionId,
ws,
lastPing: Date.now(),
});
// Notify session update
this.emit('session-update');
// Send registration acknowledgement
ws.send(
JSON.stringify({
type: 'registered',
sessionId,
timestamp: Date.now(),
}),
);
} else if (sessionId) {
this.handleWebSocketMessage(sessionId, message);
}
} catch {
// Invalid WebSocket message
}
});
ws.on('close', () => {
if (sessionId) {
this.sessions.delete(sessionId);
this.emit('session-update');
}
});
ws.on('error', () => {
// WebSocket error — no action needed
});
});
// Heartbeat mechanism
this.heartbeatTimer = setInterval(() => {
const now = Date.now();
this.sessions.forEach((session, sessionId) => {
if (now - session.lastPing > 30000) {
session.ws.close();
this.sessions.delete(sessionId);
} else {
// Send ping
session.ws.send(JSON.stringify({ type: 'ping', timestamp: now }));
}
});
}, 10000);
this.heartbeatTimer.unref();
}
private handleWebSocketMessage(
sessionId: string,
message: Record<string, unknown>,
) {
const session = this.sessions.get(sessionId);
if (!session) return;
switch (message['type']) {
case 'pong':
session.lastPing = Date.now();
break;
case 'console':
this.addInternalConsoleLog(
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
message['payload'] as ConsoleLogPayload,
sessionId,
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
message['timestamp'] as number,
);
break;
case 'network':
this.addInternalNetworkLog(
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
message['payload'] as IncomingNetworkPayload,
sessionId,
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
message['timestamp'] as number,
);
break;
default:
break;
}
}
}
|