wand-kit 0.2.0 → 0.3.1

package/lib/runtime_check.js

@@ -0,0 +1,108 @@
+/**
+ * lib/runtime_check.js — the one-file HTML, driven the way a presenter drives it.
+ *
+ * The gates in engine.js read the static render, which is all the PDF, the
+ * PNGs and the .pptx ever see. A talk or a board also has a runtime, and a
+ * runtime can break where no still frame shows it. This opens the exported
+ * file in Chromium and uses it: every slide and step by keyboard, the
+ * overview, the notes, the presenter view kept in step both ways, every demo
+ * mounted; or, for a board, play, scrub and the frames on their cues.
+ * Ported from the BofA talk's qa.mjs feature checks.
+ */
+import { pathToFileURL } from "node:url";
+import { browser } from "./engine.js";
+
+const watch = (page, errors) => {
+  page.on("pageerror", (e) => errors.push(String(e).split("\n")[0]));
+  page.on("console", (m) => { if (m.type() === "error") errors.push(m.text()); });
+};
+
+export async function checkTalk(file, { total }) {
+  const b = await browser();
+  const ctx = await b.newContext({ viewport: { width: 1440, height: 810 } });
+  const page = await ctx.newPage();
+  const errors = [], fail = [];
+  watch(page, errors);
+  try {
+    await page.goto(pathToFileURL(file).href, { waitUntil: "load" });
+    await page.waitForFunction(() => window.wandTalk, null, { timeout: 8000 });
+    const st = (p = page) => p.evaluate(() => ({ cur: wandTalk.cur, shown: wandTalk.shown, total: wandTalk.total, on: document.querySelectorAll(".stage > .page.is-current").length }));
+    const s0 = await st();
+    if (s0.total !== total) fail.push(`the runtime sees ${s0.total} slides, the build ${total}`);
+    if (s0.on !== 1) fail.push(`${s0.on} slides on screen at once`);
+
+    // every slide and every step, forward, by keyboard
+    let presses = 0, steps = 0;
+    for (;;) {
+      const a = await st(); await page.keyboard.press("ArrowRight"); const z = await st();
+      if (z.cur === a.cur && z.shown === a.shown) break;
+      presses++; if (z.cur === a.cur) steps++;
+      if (presses > 600) { fail.push("ArrowRight never reaches the end"); break; }
+    }
+    if ((await st()).cur !== total - 1) fail.push("the keyboard does not reach the last slide");
+    await page.keyboard.press("Home");
+
+    await page.keyboard.press("g");
+    const thumbs = await page.$$eval(".overview:not([hidden]) .thumb", (t) => t.length);
+    if (thumbs !== total) fail.push(`the overview shows ${thumbs} of ${total}`);
+    await page.keyboard.press("Escape");
+    await page.keyboard.press("n");
+    if (!(await page.$eval(".notes-panel", (e) => !e.hidden))) fail.push("N does not open the notes");
+    await page.keyboard.press("Escape");
+
+    // the presenter's window, kept in step from either side
+    const [pop] = await Promise.all([ctx.waitForEvent("page", { timeout: 8000 }), page.keyboard.press("p")]);
+    watch(pop, errors);
+    await pop.waitForLoadState("load");
+    await pop.waitForFunction(() => window.wandTalk, null, { timeout: 8000 });
+    await page.keyboard.press("ArrowRight"); await page.waitForTimeout(250);
+    let r = await st(), q = await st(pop);
+    if (r.cur !== q.cur || r.shown !== q.shown) fail.push(`room ${r.cur + 1}/${r.shown} and presenter ${q.cur + 1}/${q.shown} disagree`);
+    await pop.keyboard.press("ArrowRight"); await page.waitForTimeout(250);
+    r = await st(); q = await st(pop);
+    if (r.cur !== q.cur || r.shown !== q.shown) fail.push("the presenter's keys do not move the room");
+    await pop.close();
+
+    // every demo mounts and loads
+    const demoSlides = await page.$$eval(".stage > .page", (ps) => ps.map((p, i) => (p.querySelector(".media.demo") ? i : -1)).filter((i) => i >= 0));
+    for (const i of demoSlides) {
+      await page.evaluate((n) => wandTalk.go(n), i);
+      try { await page.waitForSelector(".stage > .page.is-current .media.demo.is-ready", { timeout: 10000 }); }
+      catch { fail.push(`the demo on slide ${i + 1} never loaded`); }
+    }
+    const facts = `${total} slides${steps ? ` and ${steps} steps` : ""} by keyboard, overview, notes, presenter in step both ways${demoSlides.length ? `, ${demoSlides.length} demo${demoSlides.length === 1 ? "" : "s"} mounted` : ""}`;
+    const all = [...fail, ...errors.map((e) => `console: ${e}`)];
+    return { ok: !all.length, msg: all.length ? all.slice(0, 3).join("; ") : facts };
+  } catch (e) {
+    return { ok: false, msg: `${String(e.message || e).split("\n")[0]}` };
+  } finally { await ctx.close(); }
+}
+
+export async function checkBoard(file, { shots, total }) {
+  const b = await browser();
+  const ctx = await b.newContext({ viewport: { width: 1440, height: 900 } });
+  const page = await ctx.newPage();
+  const errors = [], fail = [];
+  watch(page, errors);
+  try {
+    await page.goto(pathToFileURL(file).href, { waitUntil: "load" });
+    await page.waitForFunction(() => window.wandBoard, null, { timeout: 8000 });
+    await page.click('[data-ui="play-board"]');
+    await page.waitForTimeout(1200);
+    const a = await page.evaluate(() => ({ t: wandBoard.t, playing: wandBoard.playing, on: document.querySelectorAll(".pl-frames .pf.on").length, art: !!document.querySelector(".pl-frames .pf.on .frame-art") }));
+    if (!a.playing || a.t < 0.6) fail.push(`the player did not run (t=${a.t.toFixed(1)})`);
+    if (a.on !== 1 || !a.art) fail.push("no frame on the player's screen");
+    // scrub to the last shot: its frame and its words come up
+    const last = shots[shots.length - 1];
+    await page.evaluate((t) => { wandBoard.pause(); wandBoard.seek(t); }, last.in + 0.05);
+    const z = await page.evaluate(() => ({ id: document.querySelector(".pl-frames .pf.on")?.dataset.id, vo: document.querySelector(".pl-vo").dataset.n }));
+    if (z.vo !== String(last.n)) fail.push(`seeking to shot ${last.n} shows shot ${z.vo}`);
+    if (!z.id || !z.id.startsWith(String(last.n).padStart(2, "0"))) fail.push(`seeking to shot ${last.n} shows frame ${z.id}`);
+    await page.keyboard.press("Escape");
+    const all = [...fail, ...errors.map((e) => `console: ${e}`)];
+    const frames = shots.reduce((s, x) => s + x.frames.length, 0);
+    return { ok: !all.length, msg: all.length ? all.slice(0, 3).join("; ") : `the player runs ${frames} frames over ${Math.floor(total / 60)}:${String(Math.round(total % 60)).padStart(2, "0")}, scrubs to the last shot, captions follow` };
+  } catch (e) {
+    return { ok: false, msg: `${String(e.message || e).split("\n")[0]}` };
+  } finally { await ctx.close(); }
+}