/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { EventEmitter } from 'node:events'; import type { AgentDefinition } from '../agents/types.js'; import type { McpClient } from '../tools/mcp-client.js'; import type { ExtensionEvents } from './extensionLoader.js'; import type { EditorType } from './editor.js'; /** * Defines the severity level for user-facing feedback. * This maps loosely to UI `MessageType` */ export type FeedbackSeverity = 'info' | 'warning' | 'error'; /** * Payload for the 'user-feedback' event. */ export interface UserFeedbackPayload { /** * The severity level determines how the message is rendered in the UI * (e.g. colored text, specific icon). */ severity: FeedbackSeverity; /** * The main message to display to the user in the chat history or stdout. */ message: string; /** * The original error object, if applicable. * Listeners can use this to extract stack traces for debug logging * or verbose output, while keeping the 'message' field clean for end users. */ error?: unknown; } /** * Payload for the 'model-changed' event. */ export interface ModelChangedPayload { /** * The new model that was set. */ model: string; } /** * Payload for the 'console-log' event. */ export interface ConsoleLogPayload { type: 'log' | 'warn' | 'error' | 'debug' | 'info'; content: string; } /** * Payload for the 'output' event. */ export interface OutputPayload { isStderr: boolean; chunk: Uint8Array | string; encoding?: BufferEncoding; } /** * Payload for the 'memory-changed' event. */ export interface MemoryChangedPayload { fileCount: number; } /** * Base payload for hook-related events. */ export interface HookPayload { hookName: string; eventName: string; } /** * Payload for the 'hook-start' event. */ export interface HookStartPayload extends HookPayload { /** * The 1-based index of the current hook in the execution sequence. * Used for progress indication (e.g. "Hook 1/3"). */ hookIndex?: number; /** * The total number of hooks in the current execution sequence. */ totalHooks?: number; } /** * Payload for the 'hook-end' event. */ export interface HookEndPayload extends HookPayload { success: boolean; } /** * Payload for the 'retry-attempt' event. */ export interface RetryAttemptPayload { attempt: number; maxAttempts: number; delayMs: number; error?: string; model: string; } /** * Payload for the 'consent-request' event. */ export interface ConsentRequestPayload { prompt: string; onConfirm: (confirmed: boolean) => void; } /** * Payload for the 'agents-discovered' event. */ export interface AgentsDiscoveredPayload { agents: AgentDefinition[]; } export enum CoreEvent { UserFeedback = 'user-feedback', ModelChanged = 'model-changed', ConsoleLog = 'console-log', Output = 'output', MemoryChanged = 'memory-changed', ExternalEditorClosed = 'external-editor-closed', McpClientUpdate = 'mcp-client-update', OauthDisplayMessage = 'oauth-display-message', SettingsChanged = 'settings-changed', HookStart = 'hook-start', HookEnd = 'hook-end', AgentsRefreshed = 'agents-refreshed', AdminSettingsChanged = 'admin-settings-changed', RetryAttempt = 'retry-attempt', ConsentRequest = 'consent-request', AgentsDiscovered = 'agents-discovered', RequestEditorSelection = 'request-editor-selection', EditorSelected = 'editor-selected', } /** * Payload for the 'editor-selected' event. */ export interface EditorSelectedPayload { editor?: EditorType; } export interface CoreEvents extends ExtensionEvents { [CoreEvent.UserFeedback]: [UserFeedbackPayload]; [CoreEvent.ModelChanged]: [ModelChangedPayload]; [CoreEvent.ConsoleLog]: [ConsoleLogPayload]; [CoreEvent.Output]: [OutputPayload]; [CoreEvent.MemoryChanged]: [MemoryChangedPayload]; [CoreEvent.ExternalEditorClosed]: never[]; [CoreEvent.McpClientUpdate]: Array | never>; [CoreEvent.OauthDisplayMessage]: string[]; [CoreEvent.SettingsChanged]: never[]; [CoreEvent.HookStart]: [HookStartPayload]; [CoreEvent.HookEnd]: [HookEndPayload]; [CoreEvent.AgentsRefreshed]: never[]; [CoreEvent.AdminSettingsChanged]: never[]; [CoreEvent.RetryAttempt]: [RetryAttemptPayload]; [CoreEvent.ConsentRequest]: [ConsentRequestPayload]; [CoreEvent.AgentsDiscovered]: [AgentsDiscoveredPayload]; [CoreEvent.RequestEditorSelection]: never[]; [CoreEvent.EditorSelected]: [EditorSelectedPayload]; } type EventBacklogItem = { [K in keyof CoreEvents]: { event: K; args: CoreEvents[K]; }; }[keyof CoreEvents]; export class CoreEventEmitter extends EventEmitter { private _eventBacklog: EventBacklogItem[] = []; private static readonly MAX_BACKLOG_SIZE = 10000; constructor() { super(); } private _emitOrQueue( event: K, ...args: CoreEvents[K] ): void { if (this.listenerCount(event) === 0) { if (this._eventBacklog.length >= CoreEventEmitter.MAX_BACKLOG_SIZE) { this._eventBacklog.shift(); } this._eventBacklog.push({ event, args } as EventBacklogItem); } else { ( this.emit as ( event: K, ...args: CoreEvents[K] ) => boolean )(event, ...args); } } /** * Sends actionable feedback to the user. * Buffers automatically if the UI hasn't subscribed yet. */ emitFeedback( severity: FeedbackSeverity, message: string, error?: unknown, ): void { const payload: UserFeedbackPayload = { severity, message, error }; this._emitOrQueue(CoreEvent.UserFeedback, payload); } /** * Broadcasts a console log message. */ emitConsoleLog( type: 'log' | 'warn' | 'error' | 'debug' | 'info', content: string, ): void { const payload: ConsoleLogPayload = { type, content }; this._emitOrQueue(CoreEvent.ConsoleLog, payload); } /** * Broadcasts stdout/stderr output. */ emitOutput( isStderr: boolean, chunk: Uint8Array | string, encoding?: BufferEncoding, ): void { const payload: OutputPayload = { isStderr, chunk, encoding }; this._emitOrQueue(CoreEvent.Output, payload); } /** * Notifies subscribers that the model has changed. */ emitModelChanged(model: string): void { const payload: ModelChangedPayload = { model }; this.emit(CoreEvent.ModelChanged, payload); } /** * Notifies subscribers that settings have been modified. */ emitSettingsChanged(): void { this.emit(CoreEvent.SettingsChanged); } /** * Notifies subscribers that a hook execution has started. */ emitHookStart(payload: HookStartPayload): void { this.emit(CoreEvent.HookStart, payload); } /** * Notifies subscribers that a hook execution has ended. */ emitHookEnd(payload: HookEndPayload): void { this.emit(CoreEvent.HookEnd, payload); } /** * Notifies subscribers that agents have been refreshed. */ emitAgentsRefreshed(): void { this.emit(CoreEvent.AgentsRefreshed); } /** * Notifies subscribers that admin settings have changed. */ emitAdminSettingsChanged(): void { this.emit(CoreEvent.AdminSettingsChanged); } /** * Notifies subscribers that a retry attempt is happening. */ emitRetryAttempt(payload: RetryAttemptPayload): void { this.emit(CoreEvent.RetryAttempt, payload); } /** * Requests consent from the user via the UI. */ emitConsentRequest(payload: ConsentRequestPayload): void { this._emitOrQueue(CoreEvent.ConsentRequest, payload); } /** * Notifies subscribers that new unacknowledged agents have been discovered. */ emitAgentsDiscovered(agents: AgentDefinition[]): void { const payload: AgentsDiscoveredPayload = { agents }; this._emitOrQueue(CoreEvent.AgentsDiscovered, payload); } /** * Flushes buffered messages. Call this immediately after primary UI listener * subscribes. */ drainBacklogs(): void { const backlog = [...this._eventBacklog]; this._eventBacklog.length = 0; // Clear in-place for (const item of backlog) { ( this.emit as ( event: K, ...args: CoreEvents[K] ) => boolean )(item.event, ...item.args); } } } export const coreEvents = new CoreEventEmitter();