Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

6.8 KB
Raw Blame
import { expect, test } from "@playwright/test";
import JSZip from "jszip";

async function illustratedEpub(options?: {
  longPage?: boolean;
}): Promise<Buffer> {
  const zip = new JSZip();
  zip.file("mimetype", "application/epub+zip", { compression: "STORE" });
  zip.file(
    "META-INF/container.xml",
    "<?xml version='1.0'?><container xmlns='urn:oasis:names:tc:opendocument:xmlns:container'><rootfiles><rootfile full-path='OPS/book.opf' media-type='application/oebps-package+xml'/></rootfiles></container>",
  );
  zip.file(
    "OPS/book.opf",
    "<?xml version='1.0'?><package xmlns='http://www.idpf.org/2007/opf' xmlns:dc='http://purl.org/dc/elements/1.1/' version='3.0' unique-identifier='book-id'><metadata><dc:identifier id='book-id'>urn:uuid:deeptutor-reader-test</dc:identifier><dc:title>Faithful reader</dc:title><dc:language>en</dc:language></metadata><manifest><item id='nav' href='nav.xhtml' media-type='application/xhtml+xml' properties='nav'/><item id='one' href='one.xhtml' media-type='application/xhtml+xml'/><item id='two' href='two.xhtml' media-type='application/xhtml+xml'/><item id='dot' href='dot.png' media-type='image/png'/></manifest><spine><itemref idref='one'/><itemref idref='two'/></spine></package>",
  );
  zip.file(
    "OPS/nav.xhtml",
    "<html xmlns='http://www.w3.org/1999/xhtml' xmlns:epub='http://www.idpf.org/2007/ops'><body><nav epub:type='toc'><ol><li><a href='one.xhtml'>Illustrated chapter</a></li><li><a href='two.xhtml'>Second chapter</a></li></ol></nav></body></html>",
  );
  zip.file(
    "OPS/one.xhtml",
    `<html xmlns='http://www.w3.org/1999/xhtml'><head><title>Illustrated chapter</title></head><body><h1 id='publisher-title'>Illustrated chapter</h1><h2>Source layout</h2>${options?.longPage ? "<div style='height: 2500px'></div>" : ""}<h3 id='late-detail'>Late detail</h3><p>This layout comes from the EPUB.</p><img alt='source illustration' src='dot.png'/></body></html>`,
  );
  zip.file(
    "OPS/two.xhtml",
    "<html xmlns='http://www.w3.org/1999/xhtml'><head><title>Second chapter</title></head><body><h1>Second chapter</h1><p>Keyboard navigation reached the second spine item.</p></body></html>",
  );
  zip.file(
    "OPS/dot.png",
    Buffer.from(
      "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
      "base64",
    ),
  );
  return zip.generateAsync({
    type: "nodebuffer",
    mimeType: "application/epub+zip",
  });
}

test("EPUB headings feed and navigate the current-page outline", async ({
  page,
}, testInfo) => {
  const filename = `epub-page-headings-${Date.now()}-${testInfo.project.name}.epub`;
  await page.goto("/chat?capability=immersive_reading");
  const fileInput = page
    .getByRole("button", { name: /Open a document to read/i })
    .locator('input[type="file"]');
  await fileInput.setInputFiles({
    name: filename,
    mimeType: "application/epub+zip",
    buffer: await illustratedEpub({ longPage: true }),
  });

  const readerFrame = page.locator("iframe").contentFrame();
  await expect(
    readerFrame.getByRole("heading", { name: "Illustrated chapter" }),
  ).toBeVisible();
  if (testInfo.project.name === "epub-reader-webkit") {
    await page.getByRole("button", { name: "Contents" }).click();
  }
  await page.getByRole("tab", { name: "On this page" }).click();
  await expect(
    page.getByRole("button", { name: "Source layout" }),
  ).toBeVisible();
  const lateDetail = readerFrame.getByRole("heading", { name: "Late detail" });
  const readerBox = await page.locator("iframe").boundingBox();
  const beforeJump = await lateDetail.boundingBox();
  expect(beforeJump?.y).toBeGreaterThan((readerBox?.y ?? 0) + 100);
  await page.getByRole("button", { name: "Late detail" }).click();
  await expect(lateDetail).toBeVisible();
  await expect
    .poll(
      async () =>
        (await lateDetail.boundingBox())?.x ?? Number.MAX_SAFE_INTEGER,
    )
    .toBeLessThan((beforeJump?.x ?? Number.MAX_SAFE_INTEGER) - 100);
  const afterJump = await lateDetail.boundingBox();
  expect(afterJump?.x).toBeLessThanOrEqual((readerBox?.x ?? 0) + 100);

  await page.getByRole("tab", { name: "Document contents" }).click();
  await page.getByRole("button", { name: "Second chapter" }).click();
  await expect(
    readerFrame.getByRole("heading", { name: "Second chapter" }),
  ).toBeVisible();
  await page.getByRole("button", { name: "Contents" }).click();
  await page.getByRole("tab", { name: "On this page" }).click();
  await expect(
    page.getByRole("button", { name: "Source layout" }),
  ).toBeHidden();
  await expect(
    page.getByRole("button", { name: "Second chapter" }),
  ).toBeVisible();
});

test("faithfully renders EPUB resources, navigates, and restores its CFI", async ({
  page,
}, testInfo) => {
  const filename = `faithful-reader-${Date.now()}-${testInfo.project.name}.epub`;
  await page.goto("/chat?capability=immersive_reading");
  const fileInput = page
    .getByRole("button", { name: /Open a document to read/i })
    .locator('input[type="file"]');
  await expect(fileInput).toBeAttached();
  await fileInput.setInputFiles({
    name: filename,
    mimeType: "application/epub+zip",
    buffer: await illustratedEpub(),
  });
  const readerFrame = page.locator("iframe").contentFrame();
  await expect(
    readerFrame.getByRole("heading", { name: "Illustrated chapter" }),
  ).toBeVisible();
  await expect(readerFrame.getByAltText("source illustration")).toBeVisible();

  const turnForward =
    testInfo.project.name === "epub-reader-webkit"
      ? () => page.getByRole("button", { name: "Next", exact: true }).click()
      : async () => {
          await readerFrame.locator("body").click();
          await page.keyboard.press("ArrowRight");
        };
  for (let attempt = 0; attempt < 4; attempt += 1) {
    await turnForward();
    if (
      await readerFrame
        .getByRole("heading", { name: "Second chapter" })
        .isVisible()
    )
      break;
    await page.waitForTimeout(150);
  }
  await expect(
    readerFrame.getByRole("heading", { name: "Second chapter" }),
  ).toBeVisible();
  await expect
    .poll(async () => {
      const response = await page.request.get("/api/reading/materials");
      const rows = (await response.json()) as Array<{
        material_id: string;
        filename: string;
      }>;
      const material = rows.find((row) => row.filename === filename);
      if (!material) return 0;
      const position = await page.request.get(
        `/api/reading/materials/${material.material_id}/position`,
      );
      return ((await position.json()) as { locator: number }).locator;
    })
    .toBe(2);

  await page.reload();
  await page.getByRole("button", { name: new RegExp(filename, "i") }).click();
  const restoredFrame = page.locator("iframe").contentFrame();
  await expect(
    restoredFrame.getByRole("heading", { name: "Second chapter" }),
  ).toBeVisible();
});