|
| 1 | +/** |
| 2 | + * Regression test for Bugfix #584: afx send multi-line messages (>3 lines) |
| 3 | + * treated as paste, final Enter swallowed. |
| 4 | + * |
| 5 | + * Verifies that writeMessageToSession paces multi-line output line-by-line |
| 6 | + * with delays to prevent paste detection, while short messages are still |
| 7 | + * written in a single call. Also tests delayOffset serialization to prevent |
| 8 | + * interleaved writes when multiple messages flush to the same session. |
| 9 | + */ |
| 10 | + |
| 11 | +import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; |
| 12 | +import { writeMessageToSession } from '../servers/message-write.js'; |
| 13 | +import type { PtySession } from '../../terminal/pty-session.js'; |
| 14 | + |
| 15 | +function makeSession(): PtySession & { writeCalls: string[] } { |
| 16 | + const writeCalls: string[] = []; |
| 17 | + return { |
| 18 | + write: vi.fn((data: string) => writeCalls.push(data)), |
| 19 | + writeCalls, |
| 20 | + } as unknown as PtySession & { writeCalls: string[] }; |
| 21 | +} |
| 22 | + |
| 23 | +describe('writeMessageToSession (Bugfix #584)', () => { |
| 24 | + beforeEach(() => { |
| 25 | + vi.useFakeTimers(); |
| 26 | + }); |
| 27 | + |
| 28 | + afterEach(() => { |
| 29 | + vi.useRealTimers(); |
| 30 | + }); |
| 31 | + |
| 32 | + it('writes short messages (≤3 lines) in a single call', () => { |
| 33 | + const session = makeSession(); |
| 34 | + const msg = 'line1\nline2\nline3'; |
| 35 | + |
| 36 | + const endTime = writeMessageToSession(session, msg, false); |
| 37 | + |
| 38 | + // Message written in one shot |
| 39 | + expect(session.writeCalls).toEqual([msg]); |
| 40 | + |
| 41 | + // Enter arrives after 50ms |
| 42 | + vi.advanceTimersByTime(50); |
| 43 | + expect(session.writeCalls).toEqual([msg, '\r']); |
| 44 | + expect(endTime).toBe(50); |
| 45 | + }); |
| 46 | + |
| 47 | + it('paces multi-line messages (>3 lines) line-by-line with delays', () => { |
| 48 | + const session = makeSession(); |
| 49 | + const msg = 'line1\nline2\nline3\nline4'; |
| 50 | + |
| 51 | + const endTime = writeMessageToSession(session, msg, false); |
| 52 | + |
| 53 | + // First line written immediately |
| 54 | + expect(session.writeCalls).toEqual(['line1\n']); |
| 55 | + |
| 56 | + // Lines 2-4 arrive with 10ms, 20ms, 30ms delays |
| 57 | + vi.advanceTimersByTime(10); |
| 58 | + expect(session.writeCalls).toEqual(['line1\n', 'line2\n']); |
| 59 | + |
| 60 | + vi.advanceTimersByTime(10); |
| 61 | + expect(session.writeCalls).toEqual(['line1\n', 'line2\n', 'line3\n']); |
| 62 | + |
| 63 | + vi.advanceTimersByTime(10); |
| 64 | + expect(session.writeCalls).toEqual(['line1\n', 'line2\n', 'line3\n', 'line4']); |
| 65 | + |
| 66 | + // Enter arrives after totalPacing (30ms) + 80ms = 110ms from start |
| 67 | + vi.advanceTimersByTime(80); |
| 68 | + expect(session.writeCalls).toEqual(['line1\n', 'line2\n', 'line3\n', 'line4', '\r']); |
| 69 | + expect(endTime).toBe(110); |
| 70 | + }); |
| 71 | + |
| 72 | + it('respects noEnter=true for short messages', () => { |
| 73 | + const session = makeSession(); |
| 74 | + const endTime = writeMessageToSession(session, 'short', true); |
| 75 | + |
| 76 | + vi.advanceTimersByTime(200); |
| 77 | + expect(session.writeCalls).toEqual(['short']); |
| 78 | + expect(endTime).toBe(50); // duration still reported |
| 79 | + }); |
| 80 | + |
| 81 | + it('respects noEnter=true for multi-line messages', () => { |
| 82 | + const session = makeSession(); |
| 83 | + const msg = 'l1\nl2\nl3\nl4\nl5'; |
| 84 | + |
| 85 | + const endTime = writeMessageToSession(session, msg, true); |
| 86 | + vi.advanceTimersByTime(500); |
| 87 | + |
| 88 | + // All lines written, but no \r |
| 89 | + expect(session.writeCalls).toEqual(['l1\n', 'l2\n', 'l3\n', 'l4\n', 'l5']); |
| 90 | + expect(endTime).toBe(40); // (5-1) * 10 = 40ms for last line |
| 91 | + }); |
| 92 | + |
| 93 | + it('handles formatted architect message (realistic multi-line)', () => { |
| 94 | + const session = makeSession(); |
| 95 | + // Realistic formatted message: header + 2 content lines + footer = 4 lines |
| 96 | + const msg = '### [ARCHITECT INSTRUCTION | 2026-04-04T00:00:00.000Z] ###\nDo this thing\nAnd that thing\n###############################'; |
| 97 | + |
| 98 | + const endTime = writeMessageToSession(session, msg, false); |
| 99 | + |
| 100 | + // First line immediately |
| 101 | + expect(session.writeCalls[0]).toBe('### [ARCHITECT INSTRUCTION | 2026-04-04T00:00:00.000Z] ###\n'); |
| 102 | + |
| 103 | + // All lines delivered after enough time |
| 104 | + vi.advanceTimersByTime(30); |
| 105 | + expect(session.writeCalls).toHaveLength(4); |
| 106 | + |
| 107 | + // Enter delivered after pacing + 80ms |
| 108 | + vi.advanceTimersByTime(80); |
| 109 | + expect(session.writeCalls[session.writeCalls.length - 1]).toBe('\r'); |
| 110 | + expect(endTime).toBe(110); // 30ms pacing + 80ms enter |
| 111 | + }); |
| 112 | + |
| 113 | + it('single-line message written in one shot without pacing', () => { |
| 114 | + const session = makeSession(); |
| 115 | + const endTime = writeMessageToSession(session, 'hello', false); |
| 116 | + |
| 117 | + expect(session.writeCalls).toEqual(['hello']); |
| 118 | + vi.advanceTimersByTime(50); |
| 119 | + expect(session.writeCalls).toEqual(['hello', '\r']); |
| 120 | + expect(endTime).toBe(50); |
| 121 | + }); |
| 122 | + |
| 123 | + describe('delayOffset serialization (prevents interleaving)', () => { |
| 124 | + it('short message with delayOffset defers the initial write', () => { |
| 125 | + const session = makeSession(); |
| 126 | + const endTime = writeMessageToSession(session, 'hello', false, 100); |
| 127 | + |
| 128 | + // Nothing written yet |
| 129 | + expect(session.writeCalls).toEqual([]); |
| 130 | + |
| 131 | + // Message arrives at offset |
| 132 | + vi.advanceTimersByTime(100); |
| 133 | + expect(session.writeCalls).toEqual(['hello']); |
| 134 | + |
| 135 | + // Enter arrives at offset + 50ms |
| 136 | + vi.advanceTimersByTime(50); |
| 137 | + expect(session.writeCalls).toEqual(['hello', '\r']); |
| 138 | + expect(endTime).toBe(150); |
| 139 | + }); |
| 140 | + |
| 141 | + it('multi-line message with delayOffset defers all lines', () => { |
| 142 | + const session = makeSession(); |
| 143 | + const msg = 'a\nb\nc\nd'; |
| 144 | + const endTime = writeMessageToSession(session, msg, false, 200); |
| 145 | + |
| 146 | + // Nothing written before offset |
| 147 | + expect(session.writeCalls).toEqual([]); |
| 148 | + |
| 149 | + // First line at 200ms |
| 150 | + vi.advanceTimersByTime(200); |
| 151 | + expect(session.writeCalls).toEqual(['a\n']); |
| 152 | + |
| 153 | + // Remaining lines at 210, 220, 230ms |
| 154 | + vi.advanceTimersByTime(30); |
| 155 | + expect(session.writeCalls).toEqual(['a\n', 'b\n', 'c\n', 'd']); |
| 156 | + |
| 157 | + // Enter at 230 + 80 = 310ms from start |
| 158 | + vi.advanceTimersByTime(80); |
| 159 | + expect(session.writeCalls).toEqual(['a\n', 'b\n', 'c\n', 'd', '\r']); |
| 160 | + expect(endTime).toBe(310); |
| 161 | + }); |
| 162 | + |
| 163 | + it('two multi-line messages in sequence do not interleave', () => { |
| 164 | + const session = makeSession(); |
| 165 | + const msg1 = 'A1\nA2\nA3\nA4'; |
| 166 | + const msg2 = 'B1\nB2\nB3\nB4'; |
| 167 | + |
| 168 | + // Simulate what SendBuffer.flush does: chain offsets |
| 169 | + const end1 = writeMessageToSession(session, msg1, false, 0); |
| 170 | + const end2 = writeMessageToSession(session, msg2, false, end1); |
| 171 | + |
| 172 | + // Advance through all timers |
| 173 | + vi.advanceTimersByTime(end2 + 100); |
| 174 | + |
| 175 | + // Verify message 1 lines come before message 2 lines |
| 176 | + const writes = session.writeCalls; |
| 177 | + const a4Idx = writes.indexOf('A4'); |
| 178 | + const enterAfterA = writes.indexOf('\r'); |
| 179 | + const b1Idx = writes.indexOf('B1\n'); |
| 180 | + |
| 181 | + expect(a4Idx).toBeLessThan(enterAfterA); |
| 182 | + expect(enterAfterA).toBeLessThan(b1Idx); |
| 183 | + |
| 184 | + // Both messages fully delivered with their own Enters |
| 185 | + const enterCount = writes.filter(w => w === '\r').length; |
| 186 | + expect(enterCount).toBe(2); |
| 187 | + }); |
| 188 | + }); |
| 189 | +}); |
0 commit comments