mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-28 23:11:19 -07:00
feat(cli): defer devtools startup and integrate with F12 (#18695)
This commit is contained in:
Sandy Tao
@@ -4,23 +4,31 @@
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
/* eslint-disable @typescript-eslint/no-unnecessary-type-assertion */
|
||||
/* eslint-disable @typescript-eslint/no-this-alias */
|
||||
|
||||
import http from 'node:http';
|
||||
import https from 'node:https';
|
||||
import zlib from 'node:zlib';
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { EventEmitter } from 'node:events';
|
||||
import { CoreEvent, coreEvents, debugLogger } from '@google/gemini-cli-core';
|
||||
import type { Config } from '@google/gemini-cli-core';
|
||||
import {
|
||||
CoreEvent,
|
||||
coreEvents,
|
||||
debugLogger,
|
||||
type ConsoleLogPayload,
|
||||
type Config,
|
||||
} from '@google/gemini-cli-core';
|
||||
import WebSocket from 'ws';
|
||||
|
||||
const ACTIVITY_ID_HEADER = 'x-activity-request-id';
|
||||
const MAX_BUFFER_SIZE = 100;
|
||||
|
||||
/** Type guard: Array.isArray doesn't narrow readonly arrays in TS 5.8 */
|
||||
function isHeaderRecord(
|
||||
h: http.OutgoingHttpHeaders | readonly string[],
|
||||
): h is http.OutgoingHttpHeaders {
|
||||
return !Array.isArray(h);
|
||||
}
|
||||
|
||||
export interface NetworkLog {
|
||||
id: string;
|
||||
timestamp: number;
|
||||
@@ -43,6 +51,9 @@ export interface NetworkLog {
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/** Partial update to an existing network log. */
|
||||
export type PartialNetworkLog = { id: string } & Partial<NetworkLog>;
|
||||
|
||||
/**
|
||||
* Capture utility for session activities (network and console).
|
||||
* Provides a stream of events that can be persisted for analysis or inspection.
|
||||
@@ -53,6 +64,14 @@ export class ActivityLogger extends EventEmitter {
|
||||
private requestStartTimes = new Map<string, number>();
|
||||
private networkLoggingEnabled = false;
|
||||
|
||||
private networkBufferMap = new Map<
|
||||
string,
|
||||
Array<NetworkLog | PartialNetworkLog>
|
||||
>();
|
||||
private networkBufferIds: string[] = [];
|
||||
private consoleBuffer: Array<ConsoleLogPayload & { timestamp: number }> = [];
|
||||
private readonly bufferLimit = 10;
|
||||
|
||||
static getInstance(): ActivityLogger {
|
||||
if (!ActivityLogger.instance) {
|
||||
ActivityLogger.instance = new ActivityLogger();
|
||||
@@ -73,6 +92,47 @@ export class ActivityLogger extends EventEmitter {
|
||||
return this.networkLoggingEnabled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Atomically returns and clears all buffered logs.
|
||||
* Prevents data loss from events emitted between get and clear.
|
||||
*/
|
||||
drainBufferedLogs(): {
|
||||
network: Array<NetworkLog | PartialNetworkLog>;
|
||||
console: Array<ConsoleLogPayload & { timestamp: number }>;
|
||||
} {
|
||||
const network: Array<NetworkLog | PartialNetworkLog> = [];
|
||||
for (const id of this.networkBufferIds) {
|
||||
const events = this.networkBufferMap.get(id);
|
||||
if (events) network.push(...events);
|
||||
}
|
||||
const console = [...this.consoleBuffer];
|
||||
this.networkBufferMap.clear();
|
||||
this.networkBufferIds = [];
|
||||
this.consoleBuffer = [];
|
||||
return { network, console };
|
||||
}
|
||||
|
||||
getBufferedLogs(): {
|
||||
network: Array<NetworkLog | PartialNetworkLog>;
|
||||
console: Array<ConsoleLogPayload & { timestamp: number }>;
|
||||
} {
|
||||
const network: Array<NetworkLog | PartialNetworkLog> = [];
|
||||
for (const id of this.networkBufferIds) {
|
||||
const events = this.networkBufferMap.get(id);
|
||||
if (events) network.push(...events);
|
||||
}
|
||||
return {
|
||||
network,
|
||||
console: [...this.consoleBuffer],
|
||||
};
|
||||
}
|
||||
|
||||
clearBufferedLogs(): void {
|
||||
this.networkBufferMap.clear();
|
||||
this.networkBufferIds = [];
|
||||
this.consoleBuffer = [];
|
||||
}
|
||||
|
||||
private stringifyHeaders(headers: unknown): Record<string, string> {
|
||||
const result: Record<string, string> = {};
|
||||
if (!headers) return result;
|
||||
@@ -91,13 +151,15 @@ export class ActivityLogger extends EventEmitter {
|
||||
return result;
|
||||
}
|
||||
|
||||
private sanitizeNetworkLog(log: any): any {
|
||||
private sanitizeNetworkLog(
|
||||
log: NetworkLog | PartialNetworkLog,
|
||||
): NetworkLog | PartialNetworkLog {
|
||||
if (!log || typeof log !== 'object') return log;
|
||||
|
||||
const sanitized = { ...log };
|
||||
|
||||
// Sanitize request headers
|
||||
if (sanitized.headers) {
|
||||
if ('headers' in sanitized && sanitized.headers) {
|
||||
const headers = { ...sanitized.headers };
|
||||
for (const key of Object.keys(headers)) {
|
||||
if (
|
||||
@@ -112,7 +174,7 @@ export class ActivityLogger extends EventEmitter {
|
||||
}
|
||||
|
||||
// Sanitize response headers
|
||||
if (sanitized.response?.headers) {
|
||||
if ('response' in sanitized && sanitized.response?.headers) {
|
||||
const resHeaders = { ...sanitized.response.headers };
|
||||
for (const key of Object.keys(resHeaders)) {
|
||||
if (['set-cookie'].includes(key.toLowerCase())) {
|
||||
@@ -125,8 +187,27 @@ export class ActivityLogger extends EventEmitter {
|
||||
return sanitized;
|
||||
}
|
||||
|
||||
private safeEmitNetwork(payload: any) {
|
||||
this.emit('network', this.sanitizeNetworkLog(payload));
|
||||
/** @internal Emit a network event — public for testing only. */
|
||||
emitNetworkEvent(payload: NetworkLog | PartialNetworkLog) {
|
||||
this.safeEmitNetwork(payload);
|
||||
}
|
||||
|
||||
private safeEmitNetwork(payload: NetworkLog | PartialNetworkLog) {
|
||||
const sanitized = this.sanitizeNetworkLog(payload);
|
||||
const id = sanitized.id;
|
||||
|
||||
if (!this.networkBufferMap.has(id)) {
|
||||
this.networkBufferIds.push(id);
|
||||
this.networkBufferMap.set(id, []);
|
||||
// Evict oldest request group if over limit
|
||||
if (this.networkBufferIds.length > this.bufferLimit) {
|
||||
const evictId = this.networkBufferIds.shift()!;
|
||||
this.networkBufferMap.delete(evictId);
|
||||
}
|
||||
}
|
||||
this.networkBufferMap.get(id)!.push(sanitized);
|
||||
|
||||
this.emit('network', sanitized);
|
||||
}
|
||||
|
||||
enable() {
|
||||
@@ -147,8 +228,7 @@ export class ActivityLogger extends EventEmitter {
|
||||
? input
|
||||
: input instanceof URL
|
||||
? input.toString()
|
||||
: // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
||||
(input as any).url;
|
||||
: input.url;
|
||||
if (url.includes('127.0.0.1') || url.includes('localhost'))
|
||||
return originalFetch(input, init);
|
||||
|
||||
@@ -277,57 +357,108 @@ export class ActivityLogger extends EventEmitter {
|
||||
}
|
||||
|
||||
private patchNodeHttp() {
|
||||
// eslint-disable-next-line @typescript-eslint/no-this-alias
|
||||
const self = this;
|
||||
const originalRequest = http.request;
|
||||
const originalHttpsRequest = https.request;
|
||||
|
||||
const wrapRequest = (originalFn: any, args: any[], protocol: string) => {
|
||||
const options = args[0];
|
||||
const url =
|
||||
typeof options === 'string'
|
||||
? options
|
||||
: options.href ||
|
||||
`${protocol}//${options.hostname || options.host || 'localhost'}${options.path || '/'}`;
|
||||
const wrapRequest = (
|
||||
originalFn: typeof http.request,
|
||||
args: unknown[],
|
||||
protocol: string,
|
||||
) => {
|
||||
const firstArg = args[0];
|
||||
let options: http.RequestOptions | string | URL;
|
||||
if (typeof firstArg === 'string') {
|
||||
options = firstArg;
|
||||
} else if (firstArg instanceof URL) {
|
||||
options = firstArg;
|
||||
} else {
|
||||
options = (firstArg ?? {}) as http.RequestOptions;
|
||||
}
|
||||
|
||||
let url = '';
|
||||
if (typeof options === 'string') {
|
||||
url = options;
|
||||
} else if (options instanceof URL) {
|
||||
url = options.href;
|
||||
} else {
|
||||
// Some callers pass URL-like objects that include href
|
||||
const href =
|
||||
'href' in options && typeof options.href === 'string'
|
||||
? options.href
|
||||
: '';
|
||||
url =
|
||||
href ||
|
||||
`${protocol}//${options.hostname || options.host || 'localhost'}${options.path || '/'}`;
|
||||
}
|
||||
|
||||
if (url.includes('127.0.0.1') || url.includes('localhost'))
|
||||
return originalFn.apply(http, args);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
return originalFn.apply(http, args as any);
|
||||
|
||||
const headers =
|
||||
typeof options === 'object' && typeof options !== 'function'
|
||||
? (options as any).headers
|
||||
: {};
|
||||
if (headers && headers[ACTIVITY_ID_HEADER]) {
|
||||
const rawHeaders =
|
||||
typeof options === 'object' &&
|
||||
options !== null &&
|
||||
!(options instanceof URL)
|
||||
? options.headers
|
||||
: undefined;
|
||||
let headers: http.OutgoingHttpHeaders = {};
|
||||
if (rawHeaders && isHeaderRecord(rawHeaders)) {
|
||||
headers = rawHeaders;
|
||||
}
|
||||
|
||||
if (headers[ACTIVITY_ID_HEADER]) {
|
||||
delete headers[ACTIVITY_ID_HEADER];
|
||||
return originalFn.apply(http, args);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
return originalFn.apply(http, args as any);
|
||||
}
|
||||
|
||||
const id = Math.random().toString(36).substring(7);
|
||||
self.requestStartTimes.set(id, Date.now());
|
||||
const req = originalFn.apply(http, args);
|
||||
this.requestStartTimes.set(id, Date.now());
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
const req = originalFn.apply(http, args as any);
|
||||
const requestChunks: Buffer[] = [];
|
||||
|
||||
const oldWrite = req.write;
|
||||
const oldEnd = req.end;
|
||||
|
||||
req.write = function (chunk: any, ...etc: any[]) {
|
||||
req.write = function (chunk: unknown, ...etc: unknown[]) {
|
||||
if (chunk) {
|
||||
const encoding =
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
||||
typeof etc[0] === 'string' ? (etc[0] as BufferEncoding) : undefined;
|
||||
requestChunks.push(
|
||||
Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk, encoding),
|
||||
Buffer.isBuffer(chunk)
|
||||
? chunk
|
||||
: typeof chunk === 'string'
|
||||
? Buffer.from(chunk, encoding)
|
||||
: Buffer.from(
|
||||
chunk instanceof Uint8Array ? chunk : String(chunk),
|
||||
),
|
||||
);
|
||||
}
|
||||
return oldWrite.apply(this, [chunk, ...etc]);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
return oldWrite.apply(this, [chunk, ...etc] as any);
|
||||
};
|
||||
|
||||
req.end = function (this: any, chunk: any, ...etc: any[]) {
|
||||
req.end = function (
|
||||
this: http.ClientRequest,
|
||||
chunk: unknown,
|
||||
...etc: unknown[]
|
||||
) {
|
||||
if (chunk && typeof chunk !== 'function') {
|
||||
const encoding =
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
||||
typeof etc[0] === 'string' ? (etc[0] as BufferEncoding) : undefined;
|
||||
requestChunks.push(
|
||||
Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk, encoding),
|
||||
Buffer.isBuffer(chunk)
|
||||
? chunk
|
||||
: typeof chunk === 'string'
|
||||
? Buffer.from(chunk, encoding)
|
||||
: Buffer.from(
|
||||
chunk instanceof Uint8Array ? chunk : String(chunk),
|
||||
),
|
||||
);
|
||||
}
|
||||
const body = Buffer.concat(requestChunks).toString('utf8');
|
||||
@@ -341,10 +472,11 @@ export class ActivityLogger extends EventEmitter {
|
||||
body,
|
||||
pending: true,
|
||||
});
|
||||
return oldEnd.apply(this, [chunk, ...etc]);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
return (oldEnd as any).apply(this, [chunk, ...etc]);
|
||||
};
|
||||
|
||||
req.on('response', (res: any) => {
|
||||
req.on('response', (res: http.IncomingMessage) => {
|
||||
const responseChunks: Buffer[] = [];
|
||||
let chunkIndex = 0;
|
||||
|
||||
@@ -378,7 +510,7 @@ export class ActivityLogger extends EventEmitter {
|
||||
id,
|
||||
pending: false,
|
||||
response: {
|
||||
status: res.statusCode,
|
||||
status: res.statusCode || 0,
|
||||
headers: self.stringifyHeaders(res.headers),
|
||||
body: resBody,
|
||||
durationMs,
|
||||
@@ -400,23 +532,34 @@ export class ActivityLogger extends EventEmitter {
|
||||
});
|
||||
});
|
||||
|
||||
req.on('error', (err: any) => {
|
||||
req.on('error', (err: Error) => {
|
||||
self.requestStartTimes.delete(id);
|
||||
const message = err instanceof Error ? err.message : String(err);
|
||||
self.safeEmitNetwork({ id, pending: false, error: message });
|
||||
const message = err.message;
|
||||
self.safeEmitNetwork({
|
||||
id,
|
||||
pending: false,
|
||||
error: message,
|
||||
});
|
||||
});
|
||||
|
||||
return req;
|
||||
};
|
||||
|
||||
http.request = (...args: any[]) =>
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
(http as any).request = (...args: unknown[]) =>
|
||||
wrapRequest(originalRequest, args, 'http:');
|
||||
https.request = (...args: any[]) =>
|
||||
wrapRequest(originalHttpsRequest, args, 'https:');
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
|
||||
(https as any).request = (...args: unknown[]) =>
|
||||
wrapRequest(originalHttpsRequest as typeof http.request, args, 'https:');
|
||||
}
|
||||
|
||||
logConsole(payload: unknown) {
|
||||
this.emit('console', payload);
|
||||
logConsole(payload: ConsoleLogPayload) {
|
||||
const enriched = { ...payload, timestamp: Date.now() };
|
||||
this.consoleBuffer.push(enriched);
|
||||
if (this.consoleBuffer.length > this.bufferLimit) {
|
||||
this.consoleBuffer.shift();
|
||||
}
|
||||
this.emit('console', enriched);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -476,7 +619,7 @@ function setupNetworkLogging(
|
||||
config: Config,
|
||||
onReconnectFailed?: () => void,
|
||||
) {
|
||||
const buffer: Array<Record<string, unknown>> = [];
|
||||
const transportBuffer: object[] = [];
|
||||
let ws: WebSocket | null = null;
|
||||
let reconnectTimer: NodeJS.Timeout | null = null;
|
||||
let sessionId: string | null = null;
|
||||
@@ -501,8 +644,21 @@ function setupNetworkLogging(
|
||||
|
||||
ws.on('message', (data: Buffer) => {
|
||||
try {
|
||||
const message = JSON.parse(data.toString());
|
||||
handleServerMessage(message);
|
||||
const parsed: unknown = JSON.parse(data.toString());
|
||||
if (
|
||||
typeof parsed === 'object' &&
|
||||
parsed !== null &&
|
||||
'type' in parsed &&
|
||||
typeof parsed.type === 'string'
|
||||
) {
|
||||
handleServerMessage({
|
||||
type: parsed.type,
|
||||
sessionId:
|
||||
'sessionId' in parsed && typeof parsed.sessionId === 'string'
|
||||
? parsed.sessionId
|
||||
: undefined,
|
||||
});
|
||||
}
|
||||
} catch (err) {
|
||||
debugLogger.debug('Invalid WebSocket message:', err);
|
||||
}
|
||||
@@ -523,10 +679,13 @@ function setupNetworkLogging(
|
||||
}
|
||||
};
|
||||
|
||||
const handleServerMessage = (message: any) => {
|
||||
const handleServerMessage = (message: {
|
||||
type: string;
|
||||
sessionId?: string;
|
||||
}) => {
|
||||
switch (message.type) {
|
||||
case 'registered':
|
||||
sessionId = message.sessionId;
|
||||
sessionId = message.sessionId || null;
|
||||
debugLogger.debug(`WebSocket session registered: ${sessionId}`);
|
||||
|
||||
// Start ping interval
|
||||
@@ -549,13 +708,13 @@ function setupNetworkLogging(
|
||||
}
|
||||
};
|
||||
|
||||
const sendMessage = (message: any) => {
|
||||
const sendMessage = (message: object) => {
|
||||
if (ws && ws.readyState === WebSocket.OPEN) {
|
||||
ws.send(JSON.stringify(message));
|
||||
}
|
||||
};
|
||||
|
||||
const sendToNetwork = (type: 'console' | 'network', payload: unknown) => {
|
||||
const sendToNetwork = (type: 'console' | 'network', payload: object) => {
|
||||
const message = {
|
||||
type,
|
||||
payload,
|
||||
@@ -569,8 +728,8 @@ function setupNetworkLogging(
|
||||
ws.readyState !== WebSocket.OPEN ||
|
||||
!capture.isNetworkLoggingEnabled()
|
||||
) {
|
||||
buffer.push(message);
|
||||
if (buffer.length > MAX_BUFFER_SIZE) buffer.shift();
|
||||
transportBuffer.push(message);
|
||||
if (transportBuffer.length > MAX_BUFFER_SIZE) transportBuffer.shift();
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -586,9 +745,39 @@ function setupNetworkLogging(
|
||||
return;
|
||||
}
|
||||
|
||||
debugLogger.debug(`Flushing ${buffer.length} buffered logs...`);
|
||||
while (buffer.length > 0) {
|
||||
const message = buffer.shift()!;
|
||||
const { network, console: consoleLogs } = capture.drainBufferedLogs();
|
||||
const allInitialLogs: Array<{
|
||||
type: 'network' | 'console';
|
||||
payload: object;
|
||||
timestamp: number;
|
||||
}> = [
|
||||
...network.map((l) => ({
|
||||
type: 'network' as const,
|
||||
payload: l,
|
||||
timestamp: 'timestamp' in l && l.timestamp ? l.timestamp : Date.now(),
|
||||
})),
|
||||
...consoleLogs.map((l) => ({
|
||||
type: 'console' as const,
|
||||
payload: l,
|
||||
timestamp: l.timestamp,
|
||||
})),
|
||||
].sort((a, b) => a.timestamp - b.timestamp);
|
||||
|
||||
debugLogger.debug(
|
||||
`Flushing ${allInitialLogs.length} initial buffered logs and ${transportBuffer.length} transport buffered logs...`,
|
||||
);
|
||||
|
||||
for (const log of allInitialLogs) {
|
||||
sendMessage({
|
||||
type: log.type,
|
||||
payload: log.payload,
|
||||
sessionId: sessionId || config.getSessionId(),
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
}
|
||||
|
||||
while (transportBuffer.length > 0) {
|
||||
const message = transportBuffer.shift()!;
|
||||
sendMessage(message);
|
||||
}
|
||||
};
|
||||
@@ -625,6 +814,7 @@ function setupNetworkLogging(
|
||||
|
||||
capture.on('console', (payload) => sendToNetwork('console', payload));
|
||||
capture.on('network', (payload) => sendToNetwork('network', payload));
|
||||
|
||||
capture.on('network-logging-enabled', () => {
|
||||
debugLogger.debug('Network logging enabled, flushing buffer...');
|
||||
flushBuffer();
|
||||
@@ -666,7 +856,8 @@ export function initActivityLogger(
|
||||
port: number;
|
||||
onReconnectFailed?: () => void;
|
||||
}
|
||||
| { mode: 'file'; filePath?: string },
|
||||
| { mode: 'file'; filePath?: string }
|
||||
| { mode: 'buffer' },
|
||||
): void {
|
||||
const capture = ActivityLogger.getInstance();
|
||||
capture.enable();
|
||||
@@ -680,9 +871,10 @@ export function initActivityLogger(
|
||||
options.onReconnectFailed,
|
||||
);
|
||||
capture.enableNetworkLogging();
|
||||
} else {
|
||||
} else if (options.mode === 'file') {
|
||||
setupFileLogging(capture, config, options.filePath);
|
||||
}
|
||||
// buffer mode: no transport, just intercept + bridge
|
||||
|
||||
bridgeCoreEvents(capture);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user