oh-my-pi/packages/tui/test/markdown-stream-prefix-cache.test.ts

import { describe, expect, it } from "bun:test";
import { stripVTControlCharacters } from "node:util";
import { clearRenderCache, Markdown, type MarkdownTheme } from "@oh-my-pi/pi-tui/components/markdown";
import { defaultMarkdownTheme } from "./test-themes.js";

const WIDTH = 72;
const FROZEN_CODE_PREFIX = "```ts\nconst frozen = 1;\n```\n\n";

function renderCold(text: string, theme: MarkdownTheme): readonly string[] {
	clearRenderCache();
	const md = new Markdown(text, 0, 0, theme);
	return md.render(WIDTH);
}

describe("Markdown streaming prefix render cache", () => {
	it("reuses rendered frozen prefix lines during transient append renders", () => {
		let codeBlockCalls = 0;
		let codeBlockBorderCalls = 0;
		const theme: MarkdownTheme = {
			...defaultMarkdownTheme,
			codeBlock: text => {
				codeBlockCalls++;
				return defaultMarkdownTheme.codeBlock(text);
			},
			codeBlockBorder: text => {
				codeBlockBorderCalls++;
				return defaultMarkdownTheme.codeBlockBorder(text);
			},
		};

		const firstText = `${FROZEN_CODE_PREFIX}tail one`;
		const secondText = `${FROZEN_CODE_PREFIX}tail one plus more streamed words`;
		const md = new Markdown(firstText, 0, 0, theme);
		md.transientRenderCache = true;
		md.render(WIDTH);

		codeBlockCalls = 0;
		codeBlockBorderCalls = 0;
		md.setText(secondText);
		const streamingLines = md.render(WIDTH);

		expect(codeBlockCalls).toBe(0);
		expect(codeBlockBorderCalls).toBe(0);
		expect(streamingLines).toEqual(renderCold(secondText, theme));
	});

	it("advances the rendered prefix cache when a new stable block freezes", () => {
		let codeBlockCalls = 0;
		let codeBlockBorderCalls = 0;
		const theme: MarkdownTheme = {
			...defaultMarkdownTheme,
			codeBlock: text => {
				codeBlockCalls++;
				return defaultMarkdownTheme.codeBlock(text);
			},
			codeBlockBorder: text => {
				codeBlockBorderCalls++;
				return defaultMarkdownTheme.codeBlockBorder(text);
			},
		};
		const firstBlock = "```ts\nconst first = 1;\n```\n\n";
		const secondBlock = "```ts\nconst second = 2;\n```\n\n";
		const firstText = `${firstBlock}first tail`;
		const secondText = `${firstBlock}${secondBlock}second tail`;
		const thirdText = `${firstBlock}${secondBlock}second tail plus more words`;
		const md = new Markdown(firstText, 0, 0, theme);
		md.transientRenderCache = true;
		md.render(WIDTH);

		md.setText(secondText);
		md.render(WIDTH);

		codeBlockCalls = 0;
		codeBlockBorderCalls = 0;
		md.setText(thirdText);
		const streamingLines = md.render(WIDTH);

		expect(codeBlockCalls).toBe(0);
		expect(codeBlockBorderCalls).toBe(0);
		expect(streamingLines).toEqual(renderCold(thirdText, theme));
	});

	it("drops cached prefix lines after truncating to a previously frozen prefix", () => {
		const prefix = "---\n\n";
		const md = new Markdown(`${prefix}body`, 0, 0, defaultMarkdownTheme);
		md.transientRenderCache = true;
		md.render(WIDTH);

		md.setText(prefix);
		const streamingLines = md.render(WIDTH);

		expect(streamingLines).toEqual(renderCold(prefix, defaultMarkdownTheme));
	});

	it("keeps table layout keys stable when rendering after a cached prefix", () => {
		const prefix = `| Archived entry | Code |
| --- | --- |
| prefix-column-is-deliberately-wide | P000 |

`;
		const initialText = `${prefix}| Live entry | Value |
| --- | --- |
| short | R000 |`;
		const expandedText = `${initialText}
| tail-column-is-even-longer-than-before | R001 |`;
		const md = new Markdown(initialText, 0, 0, defaultMarkdownTheme);
		md.transientRenderCache = true;

		const tableAt = (lines: readonly string[], marker: string): { startRow: number; border: string } => {
			const plain = lines.map(line => stripVTControlCharacters(line).trimEnd());
			const headerRow = plain.findIndex(line => line.includes(marker));
			expect(headerRow).toBeGreaterThan(0);
			return { startRow: headerRow - 1, border: plain[headerRow - 1]! };
		};

		const initialLines = md.render(WIDTH);
		const prefixTable = tableAt(initialLines, "Archived entry");
		const tailTable = tableAt(initialLines, "Live entry");
		expect(prefixTable.border).not.toBe(tailTable.border);
		md.setNativeScrollbackCommittedRows(tailTable.startRow + 1);

		md.setText(expandedText);
		const expandedLines = md.render(WIDTH);
		const expandedPrefix = tableAt(expandedLines, "Archived entry");
		const expandedTail = tableAt(expandedLines, "Live entry");
		expect(expandedPrefix.border).toBe(prefixTable.border);
		expect(expandedTail.border).toBe(tailTable.border);
		expect(expandedTail.border).not.toBe(expandedPrefix.border);
		expect(expandedLines.some(line => stripVTControlCharacters(line).includes("R001"))).toBe(true);
	});
});