File size: 23,064 Bytes
f56a29b | 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 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 | import type { DirectorState } from '@/lib/types/chat';
/**
* StreamBuffer β unified presentation pacing layer.
*
* Sits between data sources (SSE stream / PlaybackEngine) and React state.
* Events are pushed into an ordered queue; a fixed-rate tick loop reveals
* text character-by-character and fires typed callbacks so both the Chat
* area and the Roundtable bubble consume identically-paced content.
*
* Key invariants:
* - ONE source of pacing (this tick loop) β no double typewriter.
* - pause() is O(1) instant β tick returns immediately.
* - Actions fire only when the tick cursor reaches them (after preceding text).
* - Roundtable sees only the current speech segment (resets on action / agent switch).
*/
// βββ Buffer Item Types βββββββββββββββββββββββββββββββββββββββββββββββ
export interface AgentStartItem {
kind: 'agent_start';
messageId: string;
agentId: string;
agentName: string;
avatar?: string;
color?: string;
}
export interface AgentEndItem {
kind: 'agent_end';
messageId: string;
agentId: string;
}
export interface TextItem {
kind: 'text';
messageId: string;
agentId: string;
/** Unique ID for this text part β distinguishes multiple text items within one message (e.g. lecture). */
partId: string;
/** Growable β SSE deltas append here. */
text: string;
/** When true, no more text will be appended. Tick can advance past once fully revealed. */
sealed: boolean;
}
export interface ActionItem {
kind: 'action';
messageId: string;
actionId: string;
actionName: string;
params: Record<string, unknown>;
agentId: string;
}
export interface ThinkingItem {
kind: 'thinking';
stage: string;
agentId?: string;
}
export interface CueUserItem {
kind: 'cue_user';
fromAgentId?: string;
prompt?: string;
}
export interface DoneItem {
kind: 'done';
totalActions: number;
totalAgents: number;
agentHadContent?: boolean;
directorState?: DirectorState;
}
export interface ErrorItem {
kind: 'error';
message: string;
}
export type BufferItem =
| AgentStartItem
| AgentEndItem
| TextItem
| ActionItem
| ThinkingItem
| CueUserItem
| DoneItem
| ErrorItem;
// βββ Callbacks βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export interface StreamBufferCallbacks {
onAgentStart(data: AgentStartItem): void;
onAgentEnd(data: AgentEndItem): void;
/**
* Fired each tick while a text item is being revealed.
* @param messageId β which message to update
* @param partId β unique ID for this text part (stable across ticks)
* @param revealedText β text visible so far (slice of full text)
* @param isComplete β true when this text item is fully revealed AND sealed
*/
onTextReveal(messageId: string, partId: string, revealedText: string, isComplete: boolean): void;
/** Fired when tick reaches an action item. Callers should execute the effect + add badge. */
onActionReady(messageId: string, data: ActionItem): void;
/**
* Unified speech feed for the Roundtable bubble.
* Reports only the CURRENT segment text (resets on action / agent switch).
* Called with (null, null) when buffer completes or is disposed.
*/
onLiveSpeech(text: string | null, agentId: string | null): void;
/**
* Speech progress ratio for the Roundtable bubble auto-scroll.
* Fired each tick during text reveal: ratio = charCursor / totalTextLength.
* Called with null when buffer completes or is disposed.
*/
onSpeechProgress(ratio: number | null): void;
onThinking(data: { stage: string; agentId?: string } | null): void;
onCueUser(fromAgentId?: string, prompt?: string): void;
onDone(data: {
totalActions: number;
totalAgents: number;
agentHadContent?: boolean;
directorState?: DirectorState;
}): void;
onError(message: string): void;
onSegmentSealed?: (
messageId: string,
partId: string,
fullText: string,
agentId: string | null,
) => void;
/**
* When provided, called after a text item is fully revealed and sealed.
* If it returns true, the tick loop will NOT advance to the next item β
* the bubble stays on the current text (e.g. waiting for TTS playback to finish).
*/
shouldHoldAfterReveal?: () => { holding: boolean; segmentDone: number } | boolean;
}
// βββ Options βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export interface StreamBufferOptions {
/** Milliseconds between ticks. Default: 30 */
tickMs?: number;
/** Characters revealed per tick. Default: 1 (β33 chars/s) */
charsPerTick?: number;
/**
* Fixed delay (ms) after a text segment is fully revealed before advancing
* to the next item. Gives the reader a breathing pause after each speech
* block. Default: 0 (no delay).
*/
postTextDelayMs?: number;
/**
* Delay (ms) after firing an action callback before advancing to the next
* item. Gives action animations time to play out. Default: 0.
*/
actionDelayMs?: number;
}
// βββ StreamBuffer Class ββββββββββββββββββββββββββββββββββββββββββββββ
export class StreamBuffer {
// Queue
private items: BufferItem[] = [];
private readIndex = 0;
private charCursor = 0;
// Roundtable segment tracking
private currentSegmentText = '';
private currentAgentId: string | null = null;
// Control
private _paused = false;
private _disposed = false;
private timer: ReturnType<typeof setInterval> | null = null;
// Dwell / delay counters (in ticks)
private _dwellTicksRemaining = 0;
/** True when a text item's post-delay has elapsed and we're waiting for TTS to finish. */
private _holdingForTTS = false;
private _holdSegmentSnapshot = -1;
// Config
private readonly tickMs: number;
private readonly charsPerTick: number;
private readonly postTextDelayTicks: number;
private readonly actionDelayTicks: number;
private readonly cb: StreamBufferCallbacks;
private partCounter = 0;
private _drainResolve: (() => void) | null = null;
private _drainReject: ((err: Error) => void) | null = null;
constructor(callbacks: StreamBufferCallbacks, options?: StreamBufferOptions) {
this.cb = callbacks;
this.tickMs = options?.tickMs ?? 30;
this.charsPerTick = options?.charsPerTick ?? 1;
this.postTextDelayTicks = Math.ceil((options?.postTextDelayMs ?? 0) / this.tickMs);
this.actionDelayTicks = Math.ceil((options?.actionDelayMs ?? 0) / this.tickMs);
}
// βββ Push Methods ββββββββββββββββββββββββββββββββββββββββββββββββ
pushAgentStart(data: Omit<AgentStartItem, 'kind'>): void {
if (this._disposed) return;
this.sealLastText();
this.items.push({ kind: 'agent_start', ...data });
}
pushAgentEnd(data: Omit<AgentEndItem, 'kind'>): void {
if (this._disposed) return;
this.sealLastText();
this.items.push({ kind: 'agent_end', ...data });
}
/**
* Append text for a message.
* If the last queue item is an unsealed text item for the same messageId,
* the delta is appended in-place. Otherwise a new text item is created.
*/
pushText(messageId: string, delta: string, agentId?: string): void {
if (this._disposed) return;
const last = this.items[this.items.length - 1];
if (last && last.kind === 'text' && last.messageId === messageId && !last.sealed) {
last.text += delta;
} else {
this.items.push({
kind: 'text',
messageId,
agentId: agentId ?? this.currentAgentId ?? '',
partId: `p${this.partCounter++}`,
text: delta,
sealed: false,
});
}
}
/** Mark the current (last) text item as complete β no more appends expected. */
sealText(messageId: string): void {
if (this._disposed) return;
for (let i = this.items.length - 1; i >= 0; i--) {
const item = this.items[i];
if (item.kind === 'text' && item.messageId === messageId && !item.sealed) {
item.sealed = true;
break;
}
}
}
pushAction(data: Omit<ActionItem, 'kind'>): void {
if (this._disposed) return;
this.sealLastText();
this.items.push({ kind: 'action', ...data });
}
pushThinking(data: { stage: string; agentId?: string }): void {
if (this._disposed) return;
this.items.push({ kind: 'thinking', ...data });
}
pushCueUser(data: { fromAgentId?: string; prompt?: string }): void {
if (this._disposed) return;
this.items.push({ kind: 'cue_user', ...data });
}
pushDone(data: {
totalActions: number;
totalAgents: number;
agentHadContent?: boolean;
directorState?: DirectorState;
}): void {
if (this._disposed) return;
this.sealLastText();
this.items.push({ kind: 'done', ...data });
}
pushError(message: string): void {
if (this._disposed) return;
this.items.push({ kind: 'error', message });
}
// βββ Control βββββββββββββββββββββββββββββββββββββββββββββββββββββ
/** Start the tick loop. Idempotent β calling twice is safe. */
start(): void {
if (this._disposed || this.timer) return;
this.timer = setInterval(() => this.tick(), this.tickMs);
}
/** Instantly pause β tick becomes a no-op. */
pause(): void {
this._paused = true;
}
/** Resume from exactly where we left off. */
resume(): void {
this._paused = false;
}
/**
* Returns a Promise that resolves when the buffer has processed all items
* including the final `done` item. Rejects if the buffer is disposed/shutdown
* before draining completes.
*
* NOTE: This will block indefinitely while the buffer is paused, by design.
* Buffer-level pause (see `livePausedRef` in use-chat-sessions) freezes ALL
* forward progress β the tick loop is a no-op while `_paused` is true, so
* no items are processed and drain never fires until resumed.
*/
waitUntilDrained(): Promise<void> {
if (this._disposed) {
return Promise.reject(new Error('Buffer already disposed'));
}
return new Promise<void>((resolve, reject) => {
this._drainResolve = resolve;
this._drainReject = reject;
});
}
get paused(): boolean {
return this._paused;
}
get disposed(): boolean {
return this._disposed;
}
/**
* Flush: instantly reveal everything remaining.
* Used when restoring persisted sessions or force-completing.
*/
flush(): void {
if (this._disposed) return;
while (this.readIndex < this.items.length) {
const item = this.items[this.readIndex];
switch (item.kind) {
case 'text':
this.cb.onTextReveal(item.messageId, item.partId, item.text, true);
this.currentSegmentText = item.text;
this.cb.onLiveSpeech(this.currentSegmentText, this.currentAgentId);
this.cb.onSpeechProgress(1);
break;
case 'action':
this.currentSegmentText = '';
this.cb.onActionReady(item.messageId, item);
this.cb.onLiveSpeech(null, this.currentAgentId);
break;
case 'agent_start':
this.currentAgentId = item.agentId;
this.currentSegmentText = '';
this.cb.onThinking(null); // Agent selected β clear thinking indicator
this.cb.onAgentStart(item);
this.cb.onLiveSpeech(null, item.agentId);
break;
case 'agent_end':
this.cb.onAgentEnd(item);
break;
case 'thinking':
this.cb.onThinking(item);
break;
case 'cue_user':
this.cb.onCueUser(item.fromAgentId, item.prompt);
break;
case 'done':
this.cb.onLiveSpeech(null, null);
this.cb.onSpeechProgress(null);
this.cb.onThinking(null);
this.cb.onDone(item);
// Resolve drain promise
this._drainResolve?.();
this._drainResolve = null;
this._drainReject = null;
break;
case 'error':
this.cb.onError(item.message);
break;
}
this.readIndex++;
this.charCursor = 0;
}
}
/** Stop tick loop, release resources. No more callbacks after this. */
dispose(): void {
if (this._disposed) return;
this._disposed = true;
if (this.timer) {
clearInterval(this.timer);
this.timer = null;
}
// Reject waiting drain promise
this._drainReject?.(new Error('Buffer disposed'));
this._drainResolve = null;
this._drainReject = null;
// Final cleanup signal
this.cb.onLiveSpeech(null, null);
this.cb.onSpeechProgress(null);
}
/**
* Stop the tick timer and mark disposed WITHOUT firing final onLiveSpeech.
* Used when replacing a buffer (e.g. resume after soft-pause) to avoid
* the dispose callback clearing roundtable state via a stale microtask.
*/
shutdown(): void {
if (this._disposed) return;
this._disposed = true;
if (this.timer) {
clearInterval(this.timer);
this.timer = null;
}
// Reject waiting drain promise
this._drainReject?.(new Error('Buffer shutdown'));
this._drainResolve = null;
this._drainReject = null;
}
// βββ Internals βββββββββββββββββββββββββββββββββββββββββββββββββββ
/** Seal the last text item in the queue (if any). */
private sealLastText(): void {
for (let i = this.items.length - 1; i >= 0; i--) {
const item = this.items[i];
if (item.kind === 'text' && !item.sealed) {
item.sealed = true;
// Ordering invariant: sealLastText() is called BEFORE pushAgentEnd/pushAgentStart,
// so this.currentAgentId still refers to the agent whose text is being sealed.
this.cb.onSegmentSealed?.(item.messageId, item.partId, item.text, this.currentAgentId);
break;
}
// Stop searching once we hit a non-text item
if (item.kind !== 'text') break;
}
}
private tick(): void {
if (this._paused || this._disposed) return;
// Honour dwell / action-delay countdown before advancing
if (this._dwellTicksRemaining > 0) {
this._dwellTicksRemaining--;
if (this._dwellTicksRemaining === 0 && this._holdingForTTS) {
// Post-text delay just finished β fall through to the TTS hold check below
} else {
return;
}
}
// TTS hold: after post-text delay, keep the bubble on screen while audio plays
if (this._holdingForTTS) {
const result = this.cb.shouldHoldAfterReveal?.();
if (result) {
if (typeof result === 'object') {
if (!result.holding) {
// TTS queue empty β release
this._holdingForTTS = false;
this._holdSegmentSnapshot = -1;
this.advanceNonText();
return;
}
if (result.segmentDone !== this._holdSegmentSnapshot) {
// A segment just finished β release even if next segment is starting
this._holdingForTTS = false;
this._holdSegmentSnapshot = -1;
this.advanceNonText();
return;
}
return; // Same segment still playing β stay on current item
}
// Boolean form (legacy): hold as long as true
return;
}
this._holdingForTTS = false;
this._holdSegmentSnapshot = -1;
// TTS done β continue to process next item
this.advanceNonText();
return;
}
const item = this.items[this.readIndex];
if (!item) return; // Queue empty or caught up β wait
switch (item.kind) {
case 'text': {
// Advance character cursor
this.charCursor = Math.min(this.charCursor + this.charsPerTick, item.text.length);
const revealed = item.text.slice(0, this.charCursor);
const fullyRevealed = this.charCursor >= item.text.length;
const isComplete = fullyRevealed && item.sealed;
// Update chat area
this.cb.onTextReveal(item.messageId, item.partId, revealed, isComplete);
// Update roundtable (current segment only).
// Use this.currentAgentId (set when tick processes agent_start) rather than
// item.agentId β push-time race means item.agentId can carry a stale value
// from the previous agent when SSE pushes outpace the tick loop.
this.currentSegmentText = revealed;
this.cb.onLiveSpeech(this.currentSegmentText, this.currentAgentId);
this.cb.onSpeechProgress(item.text.length > 0 ? this.charCursor / item.text.length : 1);
// Advance to next item if fully revealed and sealed
if (isComplete) {
this.readIndex++;
this.charCursor = 0;
// Fixed pause after text finishes β gives the reader a breathing gap
// before the next action or agent turn fires.
if (this.postTextDelayTicks > 0) {
this._dwellTicksRemaining = this.postTextDelayTicks;
// If TTS hold callback exists, mark that we need to check it after delay
if (this.cb.shouldHoldAfterReveal) {
this._holdingForTTS = true;
const snap = this.cb.shouldHoldAfterReveal();
this._holdSegmentSnapshot = typeof snap === 'object' ? snap.segmentDone : -1;
}
return; // next tick will count down, then advanceNonText
}
// No post-text delay β check TTS hold immediately
{
const result = this.cb.shouldHoldAfterReveal?.();
if (result) {
this._holdingForTTS = true;
this._holdSegmentSnapshot = typeof result === 'object' ? result.segmentDone : -1;
return; // TTS still playing β hold here
}
}
// Process any immediately-advanceable items in the same tick
// (e.g. action badges right after text)
this.advanceNonText();
}
// If fullyRevealed but !sealed: wait for more SSE deltas
break;
}
// Non-text items are processed immediately
case 'agent_start':
this.currentAgentId = item.agentId;
this.currentSegmentText = '';
this.cb.onThinking(null); // Agent selected β clear thinking indicator
this.cb.onAgentStart(item);
this.cb.onLiveSpeech(null, item.agentId);
this.readIndex++;
this.charCursor = 0;
this.advanceNonText();
break;
case 'agent_end':
this.cb.onAgentEnd(item);
this.readIndex++;
this.charCursor = 0;
this.advanceNonText();
break;
case 'action':
this.currentSegmentText = '';
this.cb.onActionReady(item.messageId, item);
this.cb.onLiveSpeech(null, this.currentAgentId);
this.readIndex++;
this.charCursor = 0;
// Delay after action so animations have time to play out
if (this.actionDelayTicks > 0) {
this._dwellTicksRemaining = this.actionDelayTicks;
return;
}
this.advanceNonText();
break;
case 'thinking':
this.cb.onThinking(item);
this.readIndex++;
this.charCursor = 0;
this.advanceNonText();
break;
case 'cue_user':
this.cb.onCueUser(item.fromAgentId, item.prompt);
this.readIndex++;
this.charCursor = 0;
this.advanceNonText();
break;
case 'done':
this.cb.onLiveSpeech(null, null);
this.cb.onSpeechProgress(null);
this.cb.onThinking(null);
this.cb.onDone(item);
this.readIndex++;
this.charCursor = 0;
// Stop the timer β nothing more to process
if (this.timer) {
clearInterval(this.timer);
this.timer = null;
}
// Resolve drain promise
this._drainResolve?.();
this._drainResolve = null;
this._drainReject = null;
break;
case 'error':
this.cb.onError(item.message);
this.readIndex++;
this.charCursor = 0;
this.advanceNonText();
break;
}
}
/**
* After processing a non-text item, keep advancing through consecutive
* non-text items in the same tick. Stop when we hit a text item or
* the end of the queue β the next tick will handle the text item
* (so we don't skip the character-by-character reveal).
*
* Also stops when an action triggers a delay so its animation can play.
*/
private advanceNonText(): void {
while (this.readIndex < this.items.length) {
const next = this.items[this.readIndex];
if (next.kind === 'text') break; // Let the next tick handle text
switch (next.kind) {
case 'agent_start':
this.currentAgentId = next.agentId;
this.currentSegmentText = '';
this.cb.onThinking(null); // Agent selected β clear thinking indicator
this.cb.onAgentStart(next);
this.cb.onLiveSpeech(null, next.agentId);
break;
case 'agent_end':
this.cb.onAgentEnd(next);
break;
case 'action':
this.currentSegmentText = '';
this.cb.onActionReady(next.messageId, next);
this.cb.onLiveSpeech(null, this.currentAgentId);
this.readIndex++;
this.charCursor = 0;
// Pause after action to let animation play
if (this.actionDelayTicks > 0) {
this._dwellTicksRemaining = this.actionDelayTicks;
return; // resume on next tick after countdown
}
continue; // no delay β keep advancing
case 'thinking':
this.cb.onThinking(next);
break;
case 'cue_user':
this.cb.onCueUser(next.fromAgentId, next.prompt);
break;
case 'done':
this.cb.onLiveSpeech(null, null);
this.cb.onSpeechProgress(null);
this.cb.onThinking(null);
this.cb.onDone(next);
this.readIndex++;
this.charCursor = 0;
if (this.timer) {
clearInterval(this.timer);
this.timer = null;
}
// Resolve drain promise
this._drainResolve?.();
this._drainResolve = null;
this._drainReject = null;
return; // done β stop advancing
case 'error':
this.cb.onError(next.message);
break;
}
this.readIndex++;
this.charCursor = 0;
}
}
}
|