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

import { render, waitFor } from "@testing-library/react";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { TerminalPane, terminalWsUrl } from "./TerminalPane";

const { terminalInstances, TerminalMock, FitAddonMock } = vi.hoisted(() => {
	class TerminalStub {
		cols = 80;
		rows = 24;
		opened: HTMLElement | null = null;
		written: unknown[] = [];
		disposed = false;
		dataHandler: ((data: string) => void) | null = null;

		loadAddon() {}
		open(element: HTMLElement) {
			this.opened = element;
		}
		write(data: unknown) {
			this.written.push(data);
		}
		onData(handler: (data: string) => void) {
			this.dataHandler = handler;
			return { dispose: () => {} };
		}
		onResize() {
			return { dispose: () => {} };
		}
		dispose() {
			this.disposed = true;
		}
	}
	const instances: TerminalStub[] = [];
	return {
		terminalInstances: instances,
		TerminalMock: class extends TerminalStub {
			constructor() {
				super();
				instances.push(this);
			}
		},
		FitAddonMock: class {
			fit() {}
		},
	};
});

vi.mock("@xterm/xterm", () => ({ Terminal: TerminalMock }));
vi.mock("@xterm/addon-fit", () => ({ FitAddon: FitAddonMock }));
vi.mock("@xterm/xterm/css/xterm.css", () => ({}));

class FakeWebSocket {
	static OPEN = 1;
	static instances: FakeWebSocket[] = [];
	url: string;
	readyState = FakeWebSocket.OPEN;
	binaryType = "";
	sent: string[] = [];
	onmessage: ((event: { data: ArrayBuffer }) => void) | null = null;
	onopen: (() => void) | null = null;
	onclose: (() => void) | null = null;

	constructor(url: string) {
		this.url = url;
		FakeWebSocket.instances.push(this);
	}
	send(data: string) {
		this.sent.push(data);
	}
	close() {}
}

describe("TerminalPane", () => {
	beforeEach(() => {
		terminalInstances.length = 0;
		FakeWebSocket.instances.length = 0;
		vi.stubGlobal("WebSocket", FakeWebSocket);
		vi.stubGlobal(
			"ResizeObserver",
			class {
				observe() {}
				disconnect() {}
			},
		);
	});

	afterEach(() => {
		vi.unstubAllGlobals();
	});

	it("opens xterm in the pane and connects to /ws/terminal", async () => {
		render(<TerminalPane />);

		await waitFor(() => expect(terminalInstances).toHaveLength(1));
		expect(terminalInstances[0].opened).not.toBeNull();

		await waitFor(() => expect(FakeWebSocket.instances).toHaveLength(1));
		expect(FakeWebSocket.instances[0].url).toBe(terminalWsUrl());
		expect(FakeWebSocket.instances[0].binaryType).toBe("arraybuffer");
	});

	it("announces its size on open and forwards keystrokes as input frames", async () => {
		render(<TerminalPane />);
		await waitFor(() => expect(FakeWebSocket.instances).toHaveLength(1));
		const socket = FakeWebSocket.instances[0];

		socket.onopen?.();
		expect(socket.sent[0]).toBe(
			JSON.stringify({ type: "resize", cols: 80, rows: 24 }),
		);

		terminalInstances[0].dataHandler?.("ls\r");
		expect(socket.sent[1]).toBe(
			JSON.stringify({ type: "input", data: "ls\r" }),
		);
	});

	it("writes incoming binary frames to the terminal", async () => {
		render(<TerminalPane />);
		await waitFor(() => expect(FakeWebSocket.instances).toHaveLength(1));

		FakeWebSocket.instances[0].onmessage?.({
			data: new TextEncoder().encode("hello").buffer as ArrayBuffer,
		});
		expect(terminalInstances[0].written).toHaveLength(1);
	});

	it("disposes the terminal on unmount", async () => {
		const { unmount } = render(<TerminalPane />);
		await waitFor(() => expect(terminalInstances).toHaveLength(1));

		unmount();
		await waitFor(() => expect(terminalInstances[0].disposed).toBe(true));
	});
});