Files
spoon/apps/next/tests/component/xterm-session.test.tsx
T

197 lines
4.7 KiB
TypeScript

import { render, screen, waitFor } from '@testing-library/react';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { XtermSession } from '../../src/components/agent-workspace/xterm-session';
const { openSpy, wsInstances, fetchSpy, fitSpy } = vi.hoisted(() => ({
openSpy: vi.fn(),
wsInstances: [] as Array<{
url: string;
send: ReturnType<typeof vi.fn>;
close: ReturnType<typeof vi.fn>;
}>,
fetchSpy: vi.fn(),
fitSpy: vi.fn(),
}));
class FakeTerminal {
cols = 80;
rows = 24;
options: Record<string, unknown> = {};
open = openSpy;
loadAddon = vi.fn();
onData = vi.fn();
onResize = vi.fn();
onSelectionChange = vi.fn();
dispose = vi.fn();
refresh = vi.fn();
write = vi.fn();
focus = vi.fn();
constructor(opts: Record<string, unknown>) {
this.options = opts ?? {};
}
}
vi.mock('@xterm/xterm', () => ({ Terminal: FakeTerminal }));
vi.mock('@xterm/addon-fit', () => ({
FitAddon: class {
fit = fitSpy;
},
}));
vi.mock('@xterm/addon-web-links', () => ({
WebLinksAddon: class {},
}));
vi.mock('next-themes', () => ({
useTheme: () => ({ resolvedTheme: 'dark' }),
}));
class FakeWebSocket {
static OPEN = 1;
url: string;
readyState = 1;
binaryType = '';
onopen: (() => void) | null = null;
onmessage: ((event: unknown) => void) | null = null;
onclose: (() => void) | null = null;
onerror: (() => void) | null = null;
send = vi.fn();
close = vi.fn();
constructor(url: string) {
this.url = url;
wsInstances.push(this);
}
}
beforeEach(() => {
wsInstances.length = 0;
openSpy.mockClear();
fitSpy.mockClear();
fetchSpy.mockReset();
fetchSpy.mockResolvedValue({
ok: true,
status: 200,
json: async () => ({ url: 'ws://x' }),
text: async () => '',
});
vi.stubGlobal('WebSocket', FakeWebSocket);
vi.stubGlobal('fetch', fetchSpy);
vi.stubGlobal(
'ResizeObserver',
class {
observe() {}
disconnect() {}
unobserve() {}
},
);
Object.defineProperty(document, 'fonts', {
configurable: true,
value: {
ready: Promise.resolve(),
load: () => Promise.resolve([]),
},
});
});
afterEach(() => {
vi.unstubAllGlobals();
});
describe('XtermSession', () => {
it('shows the waiting label and does not open a WebSocket while inactive', async () => {
render(
<XtermSession
active={false}
tokenUrl='/api/box/terminal-token'
sessionKey='box-1'
waitingLabel='Workspace is asleep.'
/>,
);
expect(screen.getByText('Workspace is asleep.')).toBeInTheDocument();
// Give any (unexpected) async connect a chance to run.
await Promise.resolve();
expect(fetchSpy).not.toHaveBeenCalled();
expect(wsInstances).toHaveLength(0);
});
it('fetches the token URL and opens a WebSocket to the returned url when active', async () => {
render(
<XtermSession
active
tokenUrl='/api/box/terminal-token'
sessionKey='box-1'
/>,
);
await waitFor(() =>
expect(fetchSpy).toHaveBeenCalledWith(
'/api/box/terminal-token',
expect.objectContaining({ signal: expect.anything() }),
),
);
await waitFor(() => expect(wsInstances).toHaveLength(1));
expect(wsInstances[0]?.url).toBe('ws://x');
expect(openSpy).toHaveBeenCalled();
});
it('refits and sends a resize frame when it becomes visible', async () => {
const { rerender } = render(
<XtermSession
active
visible={false}
tokenUrl='/api/box/terminal-token'
sessionKey='box-1'
/>,
);
await waitFor(() => expect(wsInstances).toHaveLength(1));
const ws = wsInstances[0]!;
// Ignore fits/sends from the initial connect; only the visible toggle matters.
fitSpy.mockClear();
ws.send.mockClear();
rerender(
<XtermSession
active
visible
tokenUrl='/api/box/terminal-token'
sessionKey='box-1'
/>,
);
await waitFor(() => expect(fitSpy).toHaveBeenCalled());
await waitFor(() =>
expect(ws.send).toHaveBeenCalledWith(
expect.stringContaining('"type":"resize"'),
),
);
});
it('keeps the WebSocket open when hidden while still active', async () => {
const { rerender } = render(
<XtermSession
active
visible
tokenUrl='/api/box/terminal-token'
sessionKey='box-1'
/>,
);
await waitFor(() => expect(wsInstances).toHaveLength(1));
const ws = wsInstances[0]!;
rerender(
<XtermSession
active
visible={false}
tokenUrl='/api/box/terminal-token'
sessionKey='box-1'
/>,
);
await Promise.resolve();
expect(ws.close).not.toHaveBeenCalled();
expect(wsInstances).toHaveLength(1);
});
});