import {
ASSISTANT_CITATION_MAX_COMMENT_LENGTH,
EnvironmentId,
MessageId,
ThreadId,
} from "@t3tools/contracts";
import { useState, type ReactNode } from "react";
import { describe, expect, it, vi } from "vite-plus/test";
import { userEvent } from "vite-plus/test/browser";
import type { AssistantCitationSourceAnchor } from "~/lib/assistantTextSelection";
import "~/index.css";
import { act, render } from "../../../test/render";
const mocks = vi.hoisted(() => ({ observeSource: vi.fn(), dispose: vi.fn() }));
vi.mock(import("./AssistantCitationSource"), async (importOriginal) => ({
...(await importOriginal()),
observeAssistantCitationCommentSource: mocks.observeSource,
}));
vi.mock(import("@tanstack/react-router"), async (importOriginal) => ({
...(await importOriginal()),
useNavigate: () => vi.fn(),
Link: (({ children }: { children: ReactNode }) => <a>{children}</a>) as never,
}));
import { AssistantCitationChip } from "./AssistantCitationChip";
const citation = {
version: 1 as const,
environmentId: EnvironmentId.make("environment"),
threadId: ThreadId.make("thread"),
messageId: MessageId.make("source"),
text: "hello",
start: 0,
end: 5,
prefix: "",
suffix: "",
};
// The mocked source observer is shared, so every test starts by resetting it.
function setup() {
mocks.observeSource.mockReset().mockReturnValue(mocks.dispose);
mocks.dispose.mockClear();
const source = document.createElement("p");
source.textContent = "hello";
document.body.append(source);
const range = document.createRange();
range.selectNodeContents(source);
const sourceAnchor = { source, range, viewport: document.body } as AssistantCitationSourceAnchor;
return { sourceAnchor, [Symbol.dispose]: () => source.remove() };
}
function mount(sourceAnchor: AssistantCitationSourceAnchor, onSave: () => boolean) {
function Composer() {
const [open, setOpen] = useState(true);
return (
<AssistantCitationChip
citation={citation}
composer
commentEditor={{ open, sourceAnchor, onOpenChange: setOpen, onSave }}
/>
);
}
return render(<Composer />);
}
const textarea = () =>
document.querySelector<HTMLTextAreaElement>('textarea[aria-label="Comment on selected text"]');
async function typeComment(value: string) {
const input = textarea()!;
await act(async () => {
Object.getOwnPropertyDescriptor(HTMLTextAreaElement.prototype, "value")!.set!.call(
input,
value,
);
input.dispatchEvent(new Event("input", { bubbles: true }));
});
}
async function removeSource() {
const { onUnavailable } = mocks.observeSource.mock.lastCall![0];
await act(async () => onUnavailable());
}
async function clickButton(label: string) {
const button = [...document.querySelectorAll("button")].find(
(element) => element.textContent?.trim() === label,
);
expect(button, `button ${label}`).toBeDefined();
await act(async () => button!.click());
}
describe("citation comment source disappearance", () => {
it("preserves an over-length draft at the composer until it can be shortened and saved", async () => {
using source = setup();
const onSave = vi.fn(() => true);
await using _screen = await mount(source.sourceAnchor, onSave);
const draft = "x".repeat(ASSISTANT_CITATION_MAX_COMMENT_LENGTH + 1);
await typeComment(draft);
await removeSource();
expect(textarea()?.value).toBe(draft);
expect(textarea()?.getAttribute("aria-invalid")).toBe("true");
expect(onSave).not.toHaveBeenCalled();
expect(mocks.dispose).toHaveBeenCalled();
expect(mocks.observeSource).toHaveBeenCalledTimes(1);
await typeComment("shortened comment");
await clickButton("Save");
expect(onSave).toHaveBeenCalledWith("shortened comment");
expect(textarea()).toBeNull();
});
it("preserves a rejected save and allows a later retry", async () => {
using source = setup();
const onSave = vi.fn(() => false);
await using _screen = await mount(source.sourceAnchor, onSave);
await typeComment("keep this draft");
await removeSource();
expect(onSave).toHaveBeenCalledWith("keep this draft");
expect(textarea()?.value).toBe("keep this draft");
onSave.mockReturnValue(true);
await clickButton("Save");
expect(onSave).toHaveBeenLastCalledWith("keep this draft");
expect(textarea()).toBeNull();
});
});
describe("citation comment popup position", () => {
it("opens at its anchor instead of sliding in from the window corner", async () => {
using source = setup();
await using _screen = await mount(
source.sourceAnchor,
vi.fn(() => true),
);
const positioner = () =>
document.querySelector<HTMLElement>('[data-slot="popover-positioner"]');
await vi.waitFor(() => expect(positioner()?.style.opacity).not.toBe("0"));
const moves = positioner()!
.getAnimations()
.filter(
(animation) =>
animation instanceof CSSTransition &&
["transform", "top", "left"].includes(animation.transitionProperty),
);
expect(moves).toEqual([]);
});
it("stays on screen when the cited text ends in a code block's hidden overflow", async () => {
using _source = setup();
const message = document.createElement("div");
message.className = "chat-markdown";
message.style.width = "240px";
const pre = document.createElement("pre");
const code = document.createElement("code");
// Highlighted code is split into token spans, so the range's last client rect
// covers only the final token, wholly inside the hidden overflow.
for (let index = 0; index < 40; index += 1) {
const token = document.createElement("span");
token.textContent = `token${index} `;
code.append(token);
}
pre.append(code);
message.append(pre);
document.body.prepend(message);
using _message = { [Symbol.dispose]: () => message.remove() };
const range = document.createRange();
range.selectNodeContents(code);
const rects = range.getClientRects();
expect(rects.item(rects.length - 1)!.left).toBeGreaterThan(window.innerWidth);
const sourceAnchor = {
source: message,
range,
viewport: document.body,
} as AssistantCitationSourceAnchor;
await using _screen = await mount(
sourceAnchor,
vi.fn(() => true),
);
const popup = () => document.querySelector<HTMLElement>('[data-slot="popover-popup"]');
await vi.waitFor(() => expect(popup()?.getBoundingClientRect().width).toBeGreaterThan(0));
// Typing scrolls ancestors to reveal the caret, which shifts the whole app
// sideways when the box is off screen.
await userEvent.keyboard("note");
expect(textarea()?.value).toBe("note");
expect(document.scrollingElement?.scrollLeft).toBe(0);
expect(document.body.scrollLeft).toBe(0);
const rect = popup()!.getBoundingClientRect();
expect(rect.left).toBeGreaterThanOrEqual(0);
expect(rect.right).toBeLessThanOrEqual(window.innerWidth);
});
});