@recursica/adapter-tester 5.1.2 → 5.1.4

package/dist/testing.js

@@ -1,15 +1,15 @@
 import { expect as D } from "@playwright/test";
-import { existsSync as v, unlinkSync as H, readFileSync as E, mkdirSync as b, writeFileSync as A, closeSync as Y, openSync as Q, renameSync as Z, rmSync as ee } from "node:fs";
-import te from "pixelmatch";
+import { existsSync as y, unlinkSync as Y, readFileSync as E, mkdirSync as k, writeFileSync as A, closeSync as Q, openSync as Z, renameSync as ee, rmSync as te } from "node:fs";
+import re from "pixelmatch";
 import { PNG as j } from "pngjs";
 import { join as M } from "node:path";
-import { a as re, i as oe } from "./index-DqQzFSAH.js";
-function J(e, t) {
+import { a as oe, i as ne } from "./index-DqQzFSAH.js";
+function R(e, t) {
   const o = j.sync.read(e), r = j.sync.read(t);
   if (o.width !== r.width || o.height !== r.height)
     return { diffPixels: 1 / 0, diffImage: null };
   const s = new j({ width: o.width, height: o.height });
-  return { diffPixels: te(
+  return { diffPixels: re(
     o.data,
     r.data,
     s.data,
@@ -18,21 +18,21 @@ function J(e, t) {
     { threshold: 0.1 }
   ), diffImage: j.sync.write(s) };
 }
-const ne = "http://json-schema.org/draft-07/schema#", se = "https://github.com/borderux/recursica/tree/main/packages/adapter-tester/src/golden/manifest.schema.json", ie = "test/golden/manifest.json", ae = "Tracks golden (baseline) image metadata for @recursica/adapter-tester's golden-image visual regression checks. One manifest lives alongside its adapter's test/golden/<story-id>.png files, keyed by story id.", ce = "object", de = { type: "object", additionalProperties: !1, required: ["createdAt"], properties: { createdAt: { type: "string", format: "date-time", description: "When this story's own golden PNG was last captured, via --update-golden, --approve-divergence, or first-run auto-create." }, sourceOfTruthCreatedAt: { type: "string", format: "date-time", description: "The source-of-truth adapter's (mantine) manifest `createdAt` for this story at the time this adapter's divergence from it was last reviewed via --approve-divergence. Omitted on the source-of-truth adapter's own manifest, and omitted here until the first approval. If mantine's current `createdAt` for this story is newer than this value, the divergence is flagged again for re-review." } } }, he = {
-  $schema: ne,
-  $id: se,
-  title: ie,
-  description: ae,
-  type: ce,
-  additionalProperties: de
-}, ue = oe, K = new re.Ajv({ allErrors: !0, strict: !0 });
-ue(K);
-const R = K.compile(he);
-function L(e, t) {
-  if (R(e)) return;
-  const o = (R.errors ?? []).map((r) => {
-    var i;
-    const s = (i = r.params) != null && i.additionalProperty ? ` '${r.params.additionalProperty}'` : "";
+const se = "http://json-schema.org/draft-07/schema#", ie = "https://github.com/borderux/recursica/tree/main/packages/adapter-tester/src/golden/manifest.schema.json", ae = "test/golden/manifest.json", ce = "Tracks golden (baseline) image metadata for @recursica/adapter-tester's golden-image visual regression checks. One manifest lives alongside its adapter's test/golden/<story-id>.png files, keyed by story id.", de = "object", he = { type: "object", additionalProperties: !1, required: ["createdAt"], properties: { createdAt: { type: "string", format: "date-time", description: "When this story's own golden PNG was last captured, via --update-golden, --approve-divergence, or first-run auto-create." }, sourceOfTruthCreatedAt: { type: "string", format: "date-time", description: "The source-of-truth adapter's (mantine) manifest `createdAt` for this story at the time this adapter's divergence from it was last reviewed via --approve-divergence. Omitted on the source-of-truth adapter's own manifest, and omitted here until the first approval. If mantine's current `createdAt` for this story is newer than this value, the divergence is flagged again for re-review." } } }, ue = {
+  $schema: se,
+  $id: ie,
+  title: ae,
+  description: ce,
+  type: de,
+  additionalProperties: he
+}, fe = ne, q = new oe.Ajv({ allErrors: !0, strict: !0 });
+fe(q);
+const U = q.compile(ue);
+function N(e, t) {
+  if (U(e)) return;
+  const o = (U.errors ?? []).map((r) => {
+    var a;
+    const s = (a = r.params) != null && a.additionalProperty ? ` '${r.params.additionalProperty}'` : "";
     return `  - ${r.instancePath || "root"} ${r.message}${s}`;
   }).join(`
 `);
@@ -42,7 +42,7 @@ ${o}`);
 function G(e) {
   return M(e, "manifest.json");
 }
-function q(e) {
+function V(e) {
   return M(e, "manifest.json.lock");
 }
 function S(e, t) {
@@ -50,31 +50,31 @@ function S(e, t) {
 }
 function P(e) {
   const t = G(e);
-  if (!v(t)) return {};
+  if (!y(t)) return {};
   const o = JSON.parse(E(t, "utf8"));
-  return L(o, t), o;
+  return N(o, t), o;
 }
 function le(e, t) {
   const o = G(e);
-  L(t, o);
+  N(t, o);
   const r = {};
-  for (const i of Object.keys(t).sort())
-    r[i] = t[i];
-  b(e, { recursive: !0 });
+  for (const a of Object.keys(t).sort())
+    r[a] = t[a];
+  k(e, { recursive: !0 });
   const s = `${o}.tmp-${process.pid}-${Math.random().toString(36).slice(2)}`;
   A(s, JSON.stringify(r, null, 2) + `
-`), Z(s, o);
+`), ee(s, o);
 }
-const fe = 25, pe = 15e3;
-function me(e) {
+const pe = 25, me = 15e3;
+function ge(e) {
   return new Promise((t) => setTimeout(t, e));
 }
-async function ge(e) {
-  b(e, { recursive: !0 });
-  const t = q(e), o = Date.now() + pe;
+async function we(e) {
+  k(e, { recursive: !0 });
+  const t = V(e), o = Date.now() + me;
   for (; ; )
     try {
-      Y(Q(t, "wx"));
+      Q(Z(t, "wx"));
       return;
     } catch (r) {
       if (r.code !== "EEXIST") throw r;
@@ -82,44 +82,44 @@ async function ge(e) {
         throw new Error(
           `Timed out waiting for the manifest lock at "${t}" — delete it if a previous run crashed while holding it.`
         );
-      await me(fe);
+      await ge(pe);
     }
 }
-function we(e) {
-  ee(q(e), { force: !0 });
+function ye(e) {
+  te(V(e), { force: !0 });
 }
-async function V(e, t, o) {
-  await ge(e);
+async function W(e, t, o) {
+  await we(e);
   try {
     const r = P(e), s = o(r[t]);
     return s === void 0 ? delete r[t] : r[t] = s, le(e, r), s;
   } finally {
-    we(e);
+    ye(e);
   }
 }
-function ye(e, t, o) {
-  b(e, { recursive: !0 }), A(S(e, t), o);
+function ve(e, t, o) {
+  k(e, { recursive: !0 }), A(S(e, t), o);
 }
-async function ve(e, t) {
+async function Te(e, t) {
   const o = P(e), r = Object.keys(o).filter(
     (s) => !t.has(s)
   );
   for (const s of r) {
-    const i = S(e, s);
-    v(i) && H(i), await V(e, s, () => {
+    const a = S(e, s);
+    y(a) && Y(a), await W(e, s, () => {
     });
   }
   return r;
 }
-const Te = "borderux/recursica-adapter-mantine-v8";
+const J = "borderux/recursica-adapter-mantine-v8";
 async function $e(e, t) {
-  var i, d;
+  var a, d;
   const o = await fetch(`https://registry.npmjs.org/${e}`);
   if (!o.ok)
     throw new Error(
       `Could not reach npm registry for ${e}: ${o.statusText}`
     );
-  const r = await o.json(), s = ((i = r["dist-tags"]) == null ? void 0 : i[t]) ?? ((d = r.versions) != null && d[t] ? t : void 0);
+  const r = await o.json(), s = ((a = r["dist-tags"]) == null ? void 0 : a[t]) ?? ((d = r.versions) != null && d[t] ? t : void 0);
   if (!s)
     throw new Error(
       `${e} has no version or dist-tag "${t}" on the npm registry.`
@@ -127,67 +127,70 @@ async function $e(e, t) {
   return s;
 }
 async function Oe(e) {
-  if (e.type === "local")
-    return v(G(e.dir)) ? {
+  if (e.type === "local") {
+    if (!y(G(e.dir)))
+      throw new Error(
+        `No golden baseline found at ${e.dir} — the source-of-truth divergence check has nothing to compare against. Capture one there first (--update-golden), or fix sourceOfTruth.dir if it's pointing at the wrong checkout.`
+      );
+    return {
       manifest: P(e.dir),
       async readImage(h) {
         const c = S(e.dir, h);
-        return v(c) ? E(c) : null;
+        return y(c) ? E(c) : null;
       }
-    } : (console.warn(
-      `No golden baseline found yet at ${e.dir} — source-of-truth divergence check skipped for this run.`
-    ), null);
+    };
+  }
   let t;
   try {
     t = await $e(
       e.packageName,
       e.versionSpec
     );
-  } catch (a) {
-    return console.warn(
-      `Could not resolve ${e.packageName}@${e.versionSpec} — source-of-truth divergence check skipped for this run.`,
-      a
-    ), null;
+  } catch (i) {
+    throw new Error(
+      `Could not resolve ${e.packageName}@${e.versionSpec} on the npm registry — the source-of-truth divergence check has nothing to compare against.`,
+      { cause: i }
+    );
   }
-  const o = M(e.cacheDir, t), r = `${e.packageName}@${t}`, s = `https://raw.githubusercontent.com/${Te}/${r}/test/golden`;
-  let i;
+  const o = M(e.cacheDir, t), r = `v${t}`, s = `https://raw.githubusercontent.com/${J}/${r}/test/golden`;
+  let a;
   const d = G(o);
-  if (v(d))
-    i = P(o);
+  if (y(d))
+    a = P(o);
   else {
-    let a;
+    let i;
     try {
-      a = await fetch(`${s}/manifest.json`);
+      i = await fetch(`${s}/manifest.json`);
     } catch (m) {
-      return console.warn(
-        `Could not reach GitHub to fetch ${r}'s golden baseline — source-of-truth divergence check skipped for this run.`,
-        m
-      ), null;
+      throw new Error(
+        `Could not reach GitHub to fetch ${r}'s golden baseline (${s}/manifest.json) — the source-of-truth divergence check has nothing to compare against.`,
+        { cause: m }
+      );
     }
-    if (!a.ok)
-      return console.warn(
-        `No golden baseline published for ${r} — source-of-truth divergence check skipped for this run.`
-      ), null;
-    const h = await a.text(), c = JSON.parse(h);
-    L(c, `${s}/manifest.json`), b(o, { recursive: !0 }), A(d, h), i = c;
+    if (!i.ok)
+      throw new Error(
+        `No golden baseline published for tag "${r}" in ${J} (${s}/manifest.json returned ${i.status}) — the source-of-truth divergence check has nothing to compare against. Confirm that tag exists and its release actually published test/golden/.`
+      );
+    const h = await i.text(), c = JSON.parse(h);
+    N(c, `${s}/manifest.json`), k(o, { recursive: !0 }), A(d, h), a = c;
   }
   return {
-    manifest: i,
-    async readImage(a) {
-      const h = S(o, a);
-      if (v(h)) return E(h);
-      const c = await fetch(`${s}/${a}.png`);
+    manifest: a,
+    async readImage(i) {
+      const h = S(o, i);
+      if (y(h)) return E(h);
+      const c = await fetch(`${s}/${i}.png`);
       if (!c.ok) return null;
       const m = Buffer.from(await c.arrayBuffer());
-      return b(o, { recursive: !0 }), A(h, m), m;
+      return k(o, { recursive: !0 }), A(h, m), m;
     }
   };
 }
-const ke = ["Theme", "Tokens", "Introduction"];
-function N(e, t) {
+const xe = ["Theme", "Tokens", "Introduction"];
+function L(e, t) {
   return e === t || e.startsWith(t);
 }
-async function xe(e, t) {
+async function be(e, t) {
   let o;
   try {
     const r = await fetch(`${e.url}/index.json`);
@@ -195,12 +198,12 @@ async function xe(e, t) {
       throw new Error(
         `Failed to fetch Storybook index: ${r.statusText}`
       );
-    const i = (await r.json()).entries || {};
-    o = Object.values(i).filter(
+    const a = (await r.json()).entries || {};
+    o = Object.values(a).filter(
       (d) => d.type === "story" && !t.some(
-        (a) => d.title === a || d.title.startsWith(`${a}/`)
+        (i) => d.title === i || d.title.startsWith(`${i}/`)
       )
-    ), o.sort((d, a) => d.id.localeCompare(a.id));
+    ), o.sort((d, i) => d.id.localeCompare(i.id));
   } catch (r) {
     throw console.error(
       "Failed to load Storybook index from",
@@ -212,10 +215,10 @@ async function xe(e, t) {
   }
   return o;
 }
-function U(e, t, o) {
+function K(e, t, o) {
   let r;
   for (const s of Object.keys(t))
-    N(e, s) && (!r || s.length > r.length) && (r = s);
+    L(e, s) && (!r || s.length > r.length) && (r = s);
   return r !== void 0 ? t[r] : o;
 }
 async function Ge(e) {
@@ -224,26 +227,26 @@ async function Ge(e) {
     throw new Error(
       "adapter-tester config has no non-sourceOfTruth target to run the golden check against."
     );
-  const o = e.excludeTitlePrefixes ?? ke, r = e.stories ?? {}, s = Object.keys(r).filter(
+  const o = e.excludeTitlePrefixes ?? xe, r = e.stories ?? {}, s = Object.keys(r).filter(
     (n) => r[n].exclude
-  ), i = Object.fromEntries(
+  ), a = Object.fromEntries(
     Object.entries(r).filter(([, n]) => n.goldenThreshold !== void 0).map(([n, u]) => [n, u.goldenThreshold])
   ), d = Object.fromEntries(
     Object.entries(r).filter(([, n]) => n.sourceOfTruthThreshold !== void 0).map(([n, u]) => [n, u.sourceOfTruthThreshold])
-  ), a = e.goldenDir, h = e.goldenMode, c = e.checkMode, m = await xe(t, o), I = m.filter(
-    (n) => !s.some((u) => N(n.id, u))
+  ), i = e.goldenDir, h = e.goldenMode, c = e.checkMode, m = await be(t, o), C = m.filter(
+    (n) => !s.some((u) => L(n.id, u))
   );
   if (h === "update-golden") {
-    const n = await ve(
-      a,
-      new Set(I.map((u) => u.id))
+    const n = await Te(
+      i,
+      new Set(C.map((u) => u.id))
     );
     n.length > 0 && console.warn(
       `Pruned ${n.length} orphaned golden(s) no longer in Storybook: ${n.join(", ")}`
     );
   }
-  const g = c !== "divergence" || e.isSourceOfTruthAdapter || !e.sourceOfTruthGolden ? null : await Oe(e.sourceOfTruthGolden), W = new Set(m.map((n) => n.id)), T = g ? Object.keys(g.manifest).filter(
-    (n) => !W.has(n) && !s.some((u) => N(n, u))
+  const v = c !== "divergence" || e.isSourceOfTruthAdapter || !e.sourceOfTruthGolden ? null : await Oe(e.sourceOfTruthGolden), X = new Set(m.map((n) => n.id)), T = v ? Object.keys(v.manifest).filter(
+    (n) => !X.has(n) && !s.some((u) => L(n, u))
   ).sort() : [];
   T.length > 0 && console.error(
     `[adapter-tester] ${T.length} stor(y/ies) exist in the source of truth but are missing here: ${T.join(", ")}. Add the missing story, or mark it \`exclude: true\` under \`stories\` in adapter-tester.config.json if intentional.`
@@ -254,111 +257,116 @@ async function Ge(e) {
       `[adapter-tester] goldenMode: "${h}"`,
       `[adapter-tester] goldenThresholdPixels: ${e.goldenThresholdPixels}`,
       `[adapter-tester] sourceOfTruthThresholdPixels: ${e.sourceOfTruthThresholdPixels}`,
-      c === "divergence" ? e.isSourceOfTruthAdapter ? "[adapter-tester] sourceOfTruthGolden: skipped — this is the source-of-truth adapter, nothing to diverge from" : e.sourceOfTruthGolden ? g ? `[adapter-tester] sourceOfTruthGolden: resolved, ${Object.keys(g.manifest).length} golden(s) available (config: ${JSON.stringify(e.sourceOfTruthGolden)})` : `[adapter-tester] sourceOfTruthGolden: unavailable — no baseline found or unreachable (config: ${JSON.stringify(e.sourceOfTruthGolden)}); divergence check will skip every story` : "[adapter-tester] sourceOfTruthGolden: skipped — no sourceOfTruthGolden configured" : '[adapter-tester] sourceOfTruthGolden: not used in "own" checkMode',
-      `[adapter-tester] stories: ${I.length} to check (excluded: ${s.length}, title prefixes excluded: ${o.join(", ") || "none"})`,
+      c === "divergence" ? e.isSourceOfTruthAdapter ? "[adapter-tester] sourceOfTruthGolden: skipped — this is the source-of-truth adapter, nothing to diverge from" : e.sourceOfTruthGolden ? (
+        // Unresolvable-baseline case never reaches here — resolveSourceOfTruthGolden
+        // throws instead of returning null, failing the whole run before this
+        // logs, rather than letting the divergence check silently no-op.
+        `[adapter-tester] sourceOfTruthGolden: resolved, ${Object.keys(v.manifest).length} golden(s) available (config: ${JSON.stringify(e.sourceOfTruthGolden)})`
+      ) : "[adapter-tester] sourceOfTruthGolden: skipped — no sourceOfTruthGolden configured" : '[adapter-tester] sourceOfTruthGolden: not used in "own" checkMode',
+      `[adapter-tester] stories: ${C.length} to check (excluded: ${s.length}, title prefixes excluded: ${o.join(", ") || "none"})`,
       `[adapter-tester] story parity with source of truth: ${T.length === 0 ? "OK" : `${T.length} missing (see error above)`}`
     ].join(`
 `)
   );
-  const X = c === "divergence" ? "Source-of-Truth Divergence Check" : "Own-Drift Golden Image Check";
+  const z = c === "divergence" ? "Source-of-Truth Divergence Check" : "Own-Drift Golden Image Check";
   return {
     ownTargetName: t.name,
-    suiteLabel: X,
-    stories: I,
+    suiteLabel: z,
+    stories: C,
     missingFromSourceOfTruth: T,
     checkStory: async (n, u, p) => {
-      const w = await u.newPage();
-      await w.setViewportSize({ width: 800, height: 600 }), await w.goto(
+      const g = await u.newPage();
+      await g.setViewportSize({ width: 800, height: 600 }), await g.goto(
         `${t.url}/iframe.html?id=${n.id}&viewMode=story`,
         { waitUntil: "networkidle" }
-      ), await w.waitForSelector("#storybook-root"), await w.addStyleTag({
+      ), await g.waitForSelector("#storybook-root"), await g.addStyleTag({
         content: "* { -webkit-font-smoothing: antialiased !important; -moz-osx-font-smoothing: grayscale !important; }"
-      }), await w.evaluate(
+      }), await g.evaluate(
         () => Promise.all(
           Array.from(
             document.querySelectorAll(
               'link[rel="stylesheet"]'
             )
           ).map(
-            (l) => l.sheet ? Promise.resolve() : new Promise((f) => {
-              l.addEventListener("load", () => f(), {
+            (f) => f.sheet ? Promise.resolve() : new Promise((l) => {
+              f.addEventListener("load", () => l(), {
                 once: !0
-              }), l.addEventListener("error", () => f(), {
+              }), f.addEventListener("error", () => l(), {
                 once: !0
               });
             })
           )
         ).then(() => document.fonts.ready)
-      ), await w.waitForTimeout(300);
-      const x = await w.screenshot(), B = S(a, n.id), y = P(a)[n.id], z = h !== "check" || !y || !v(B);
+      ), await g.waitForTimeout(300);
+      const b = await g.screenshot(), B = S(i, n.id), w = P(i)[n.id], H = h !== "check" || !w || !y(B);
       let $;
-      if (z)
-        ye(a, n.id, x), $ = y != null && y.sourceOfTruthCreatedAt ? {
+      if (H)
+        ve(i, n.id, b), $ = w != null && w.sourceOfTruthCreatedAt ? {
           createdAt: (/* @__PURE__ */ new Date()).toISOString(),
-          sourceOfTruthCreatedAt: y.sourceOfTruthCreatedAt
-        } : { createdAt: (/* @__PURE__ */ new Date()).toISOString() }, y || p.annotations.push({
+          sourceOfTruthCreatedAt: w.sourceOfTruthCreatedAt
+        } : { createdAt: (/* @__PURE__ */ new Date()).toISOString() }, w || p.annotations.push({
           type: "golden-created",
           description: `No golden existed yet for "${n.id}" — captured one from this run.`
         });
-      else if ($ = y, c === "own") {
-        const l = E(B), { diffPixels: f, diffImage: O } = J(
-          x,
-          l
-        ), k = U(
+      else if ($ = w, c === "own") {
+        const f = E(B), { diffPixels: l, diffImage: O } = R(
+          b,
+          f
+        ), x = K(
           n.id,
-          i,
+          a,
           e.goldenThresholdPixels
         );
-        f >= k && (await p.attach("expected", {
-          body: l,
+        l >= x && (await p.attach("expected", {
+          body: f,
           contentType: "image/png"
         }), await p.attach("actual", {
-          body: x,
+          body: b,
           contentType: "image/png"
         }), O && await p.attach("diff", {
           body: O,
           contentType: "image/png"
         })), D.soft(
-          f,
-          `"${n.id}" has drifted from its own golden image (${f} mismatched pixels, threshold ${k})`
-        ).toBeLessThan(k);
+          l,
+          `"${n.id}" has drifted from its own golden image (${l} mismatched pixels, threshold ${x})`
+        ).toBeLessThan(x);
       }
-      if (g) {
-        const l = g.manifest[n.id], f = l ? await g.readImage(n.id) : null;
-        if (l && f)
+      if (v) {
+        const f = v.manifest[n.id], l = f ? await v.readImage(n.id) : null;
+        if (f && l)
           if (h === "approve-divergence")
             $ = {
               ...$,
-              sourceOfTruthCreatedAt: l.createdAt
+              sourceOfTruthCreatedAt: f.createdAt
             };
           else {
-            const { diffPixels: O, diffImage: k } = J(
-              x,
-              f
-            ), C = U(
+            const { diffPixels: O, diffImage: x } = R(
+              b,
+              l
+            ), I = K(
               n.id,
               d,
               e.sourceOfTruthThresholdPixels
-            ), F = $.sourceOfTruthCreatedAt, _ = O < C || F !== void 0 && F >= l.createdAt;
+            ), F = $.sourceOfTruthCreatedAt, _ = O < I || F !== void 0 && F >= f.createdAt;
             _ || (await p.attach("expected", {
-              body: f,
+              body: l,
               contentType: "image/png"
             }), await p.attach("actual", {
-              body: x,
+              body: b,
               contentType: "image/png"
-            }), k && await p.attach("diff", {
-              body: k,
+            }), x && await p.attach("diff", {
+              body: x,
               contentType: "image/png"
             }), p.annotations.push({
               type: "source-of-truth-divergence",
-              description: `"${n.id}" differs from the source of truth's golden by ${O} mismatched pixels (threshold ${C}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
+              description: `"${n.id}" differs from the source of truth's golden by ${O} mismatched pixels (threshold ${I}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
             })), D.soft(
               _,
-              `"${n.id}" differs from the source of truth's golden by ${O} mismatched pixels (threshold ${C}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
+              `"${n.id}" differs from the source of truth's golden by ${O} mismatched pixels (threshold ${I}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
             ).toBe(!0);
           }
       }
-      await V(a, n.id, () => $);
+      await W(i, n.id, () => $);
     }
   };
 }