-
Notifications
You must be signed in to change notification settings - Fork 212
Expand file tree
/
Copy pathmessage-processor.ts
More file actions
443 lines (385 loc) · 12.8 KB
/
Copy pathmessage-processor.ts
File metadata and controls
443 lines (385 loc) · 12.8 KB
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
/**
* Message Processor
*
* This module handles incoming messages from the extension host and dispatches
* appropriate state updates and events. It acts as the bridge between raw
* extension messages and the client's internal state management.
*
* Message Flow:
* ```
* Extension Host ──▶ MessageProcessor ──▶ StateStore ──▶ Events
* ```
*
* The processor handles different message types:
* - "state": Full state update from extension
* - "messageUpdated": Single message update
* - "action": UI action triggers
* - "invoke": Command invocations
*/
import { ExtensionMessage, ClineMessage } from "@roo-code/types"
import { debugLog } from "@roo-code/core/cli"
import type { StateStore } from "./state-store.js"
import type { TypedEventEmitter, AgentStateChangeEvent, WaitingForInputEvent, TaskCompletedEvent } from "./events.js"
import {
isSignificantStateChange,
transitionedToWaiting,
transitionedToRunning,
streamingStarted,
streamingEnded,
taskCompleted,
} from "./events.js"
import type { AgentStateInfo } from "./agent-state.js"
// =============================================================================
// Message Processor Options
// =============================================================================
export interface MessageProcessorOptions {
/**
* Whether to emit events for every state change, or only significant ones.
* Default: true (emit all changes)
*/
emitAllStateChanges?: boolean
/**
* Whether to log debug information.
* Default: false
*/
debug?: boolean
}
// =============================================================================
// Message Processor Class
// =============================================================================
/**
* MessageProcessor handles incoming extension messages and updates state accordingly.
*
* It is responsible for:
* 1. Parsing and validating incoming messages
* 2. Updating the state store
* 3. Emitting appropriate events
*
* Usage:
* ```typescript
* const store = new StateStore()
* const emitter = new TypedEventEmitter()
* const processor = new MessageProcessor(store, emitter)
*
* // Process a message from the extension
* processor.processMessage(extensionMessage)
* ```
*/
export class MessageProcessor {
private store: StateStore
private emitter: TypedEventEmitter
private options: Required<MessageProcessorOptions>
constructor(store: StateStore, emitter: TypedEventEmitter, options: MessageProcessorOptions = {}) {
this.store = store
this.emitter = emitter
this.options = {
emitAllStateChanges: options.emitAllStateChanges ?? true,
debug: options.debug ?? false,
}
}
// ===========================================================================
// Main Processing Methods
// ===========================================================================
/**
* Process an incoming message from the extension host.
*
* This is the main entry point for all extension messages.
* It routes messages to the appropriate handler based on type.
*
* @param message - The raw message from the extension
*/
processMessage(message: ExtensionMessage): void {
if (this.options.debug) {
debugLog("[MessageProcessor] Received message", { type: message.type })
}
try {
switch (message.type) {
case "state":
this.handleStateMessage(message)
break
case "messageUpdated":
this.handleMessageUpdated(message)
break
case "action":
this.handleAction(message)
break
case "invoke":
this.handleInvoke(message)
break
default:
// Other message types are not relevant to state detection
if (this.options.debug) {
debugLog("[MessageProcessor] Ignoring message", { type: message.type })
}
}
} catch (error) {
const err = error instanceof Error ? error : new Error(String(error))
debugLog("[MessageProcessor] Error processing message", { error: err.message })
this.emitter.emit("error", err)
}
}
/**
* Process an array of messages (for batch updates).
*/
processMessages(messages: ExtensionMessage[]): void {
for (const message of messages) {
this.processMessage(message)
}
}
// ===========================================================================
// Message Type Handlers
// ===========================================================================
/**
* Handle a "state" message - full state update from extension.
*
* This is the most important message type for state detection.
* It contains the complete clineMessages array which is the source of truth.
*/
private handleStateMessage(message: ExtensionMessage): void {
if (!message.state) {
if (this.options.debug) {
debugLog("[MessageProcessor] State message missing state payload")
}
return
}
const { clineMessages, mode } = message.state
// Track mode changes.
if (mode && typeof mode === "string") {
const previousMode = this.store.getCurrentMode()
if (previousMode !== mode) {
if (this.options.debug) {
debugLog("[MessageProcessor] Mode changed", { from: previousMode, to: mode })
}
this.store.setCurrentMode(mode)
this.emitter.emit("modeChanged", { previousMode, currentMode: mode })
}
}
if (!clineMessages) {
if (this.options.debug) {
debugLog("[MessageProcessor] State message missing clineMessages")
}
return
}
// Get previous state for comparison.
const previousState = this.store.getAgentState()
// Update the store with new messages
// Note: We only call setMessages, NOT setExtensionState, to avoid
// double processing (setExtensionState would call setMessages again)
this.store.setMessages(clineMessages)
// Get new state after update
const currentState = this.store.getAgentState()
// Debug logging for state message
if (this.options.debug) {
const lastMsg = clineMessages[clineMessages.length - 1]
const lastMsgInfo = lastMsg
? {
msgType: lastMsg.type === "ask" ? `ask:${lastMsg.ask}` : `say:${lastMsg.say}`,
partial: lastMsg.partial,
textPreview: lastMsg.text?.substring(0, 50),
}
: null
debugLog("[MessageProcessor] State update", {
messageCount: clineMessages.length,
lastMessage: lastMsgInfo,
stateTransition: `${previousState.state} → ${currentState.state}`,
currentAsk: currentState.currentAsk,
isWaitingForInput: currentState.isWaitingForInput,
isStreaming: currentState.isStreaming,
isRunning: currentState.isRunning,
})
}
// Emit events based on state changes
this.emitStateChangeEvents(previousState, currentState)
// Emit new message events for any messages we haven't seen
this.emitNewMessageEvents(previousState, currentState, clineMessages)
}
/**
* Handle a "messageUpdated" message - single message update.
*
* This is sent when a message is modified (e.g., partial -> complete).
*/
private handleMessageUpdated(message: ExtensionMessage): void {
if (!message.clineMessage) {
if (this.options.debug) {
debugLog("[MessageProcessor] messageUpdated missing clineMessage")
}
return
}
const clineMessage = message.clineMessage
const previousState = this.store.getAgentState()
// Update the message in the store
this.store.updateMessage(clineMessage)
const currentState = this.store.getAgentState()
// Emit message updated event
this.emitter.emit("messageUpdated", clineMessage)
// Emit state change events
this.emitStateChangeEvents(previousState, currentState)
}
/**
* Handle an "action" message - UI action trigger.
*
* These are typically used to trigger UI behaviors and don't
* directly affect agent state, but we can track them if needed.
*/
private handleAction(message: ExtensionMessage): void {
if (this.options.debug) {
debugLog("[MessageProcessor] Action", { action: message.action })
}
// Actions don't affect agent state, but subclasses could override this
}
/**
* Handle an "invoke" message - command invocation.
*
* These are commands that should trigger specific behaviors.
*/
private handleInvoke(message: ExtensionMessage): void {
if (this.options.debug) {
debugLog("[MessageProcessor] Invoke", { invoke: message.invoke })
}
// Invokes don't directly affect state detection
// But they might trigger state changes through subsequent messages
}
// ===========================================================================
// Event Emission Helpers
// ===========================================================================
/**
* Emit events based on state changes.
*/
private emitStateChangeEvents(previousState: AgentStateInfo, currentState: AgentStateInfo): void {
const isSignificant = isSignificantStateChange(previousState, currentState)
// Emit stateChange event
if (this.options.emitAllStateChanges || isSignificant) {
const changeEvent: AgentStateChangeEvent = {
previousState,
currentState,
isSignificantChange: isSignificant,
}
this.emitter.emit("stateChange", changeEvent)
}
// Emit specific transition events
// Waiting for input
if (transitionedToWaiting(previousState, currentState)) {
if (currentState.currentAsk && currentState.lastMessage) {
if (this.options.debug) {
debugLog("[MessageProcessor] EMIT waitingForInput", {
ask: currentState.currentAsk,
action: currentState.requiredAction,
})
}
const waitingEvent: WaitingForInputEvent = {
ask: currentState.currentAsk,
stateInfo: currentState,
message: currentState.lastMessage,
}
this.emitter.emit("waitingForInput", waitingEvent)
}
}
// Resumed running
if (transitionedToRunning(previousState, currentState)) {
if (this.options.debug) {
debugLog("[MessageProcessor] EMIT resumedRunning")
}
this.emitter.emit("resumedRunning", undefined as void)
}
// Streaming started
if (streamingStarted(previousState, currentState)) {
if (this.options.debug) {
debugLog("[MessageProcessor] EMIT streamingStarted")
}
this.emitter.emit("streamingStarted", undefined as void)
}
// Streaming ended
if (streamingEnded(previousState, currentState)) {
if (this.options.debug) {
debugLog("[MessageProcessor] EMIT streamingEnded")
}
this.emitter.emit("streamingEnded", undefined as void)
}
// Task completed
if (taskCompleted(previousState, currentState)) {
const completedSuccessfully =
currentState.currentAsk === "completion_result" || currentState.currentAsk === "resume_completed_task"
if (this.options.debug) {
debugLog("[MessageProcessor] EMIT taskCompleted", {
success: completedSuccessfully,
})
}
const completedEvent: TaskCompletedEvent = {
success: completedSuccessfully,
stateInfo: currentState,
message: currentState.lastMessage,
}
this.emitter.emit("taskCompleted", completedEvent)
}
}
/**
* Emit events for new messages.
*
* We compare the previous and current message counts to find new messages.
* This is a simple heuristic - for more accuracy, we'd track by timestamp.
*/
private emitNewMessageEvents(
_previousState: AgentStateInfo,
_currentState: AgentStateInfo,
messages: ClineMessage[],
): void {
// For now, just emit the last message as new
// A more sophisticated implementation would track seen message timestamps
const lastMessage = messages[messages.length - 1]
if (lastMessage) {
this.emitter.emit("message", lastMessage)
}
}
// ===========================================================================
// Utility Methods
// ===========================================================================
/**
* Manually trigger a task cleared event.
* Call this when you send a clearTask message to the extension.
*/
notifyTaskCleared(): void {
this.store.clear()
this.emitter.emit("taskCleared", undefined as void)
}
/**
* Enable or disable debug logging.
*/
setDebug(enabled: boolean): void {
this.options.debug = enabled
}
}
// =============================================================================
// Message Validation Helpers
// =============================================================================
/**
* Check if a message is a valid ExtensionMessage.
*/
export function isValidExtensionMessage(message: unknown): message is ExtensionMessage {
if (!message || typeof message !== "object") {
return false
}
const msg = message as Record<string, unknown>
// Must have a type
if (typeof msg.type !== "string") {
return false
}
return true
}
// =============================================================================
// Message Parsing Utilities
// =============================================================================
/**
* Parse a JSON string into an ExtensionMessage.
* Returns undefined if parsing fails.
*/
export function parseExtensionMessage(json: string): ExtensionMessage | undefined {
try {
const parsed = JSON.parse(json)
if (isValidExtensionMessage(parsed)) {
return parsed
}
return undefined
} catch {
return undefined
}
}