@recursica/adapter-tester 3.0.0 → 4.0.0

package/dist/testing.js

@@ -1,156 +1,209 @@
-import { test as I, expect as M } from "@playwright/test";
-import { existsSync as l, readFileSync as g, mkdirSync as w, writeFileSync as y } from "node:fs";
-import L from "pixelmatch";
-import { PNG as O } from "pngjs";
-import { join as P } from "node:path";
-import { a as R, i as U } from "./index-DqQzFSAH.js";
-function G(e, t) {
-  const r = O.sync.read(e), s = O.sync.read(t);
-  if (r.width !== s.width || r.height !== s.height)
-    return 1 / 0;
-  const o = new O({ width: r.width, height: r.height });
-  return L(r.data, s.data, o.data, r.width, r.height, {
-    threshold: 0.1
-  });
-}
-const V = "http://json-schema.org/draft-07/schema#", _ = "https://github.com/borderux/recursica/tree/main/packages/adapter-tester/src/golden/manifest.schema.json", J = "test/golden/manifest.json", W = "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.", H = "object", K = { 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." } } }, X = {
-  $schema: V,
-  $id: _,
-  title: J,
-  description: W,
-  type: H,
-  additionalProperties: K
-}, q = U, C = new R.Ajv({ allErrors: !0, strict: !0 });
-q(C);
-const N = C.compile(X);
-function S(e, t) {
-  if (N(e)) return;
-  const r = (N.errors ?? []).map((s) => {
-    var c;
-    const o = (c = s.params) != null && c.additionalProperty ? ` '${s.params.additionalProperty}'` : "";
-    return `  - ${s.instancePath || "root"} ${s.message}${o}`;
+import { expect as K } from "@playwright/test";
+import { existsSync as g, unlinkSync as J, readFileSync as $, mkdirSync as x, writeFileSync as P, closeSync as V, openSync as W, renameSync as X, rmSync as q } from "node:fs";
+import H from "pixelmatch";
+import { PNG as S } from "pngjs";
+import { join as E } from "node:path";
+import { a as z, i as Y } from "./index-DqQzFSAH.js";
+function N(e, t) {
+  const n = S.sync.read(e), r = S.sync.read(t);
+  if (n.width !== r.width || n.height !== r.height)
+    return { diffPixels: 1 / 0, diffImage: null };
+  const o = new S({ width: n.width, height: n.height });
+  return { diffPixels: H(
+    n.data,
+    r.data,
+    o.data,
+    n.width,
+    n.height,
+    { threshold: 0.1 }
+  ), diffImage: S.sync.write(o) };
+}
+const Q = "http://json-schema.org/draft-07/schema#", Z = "https://github.com/borderux/recursica/tree/main/packages/adapter-tester/src/golden/manifest.schema.json", ee = "test/golden/manifest.json", te = "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.", re = "object", ne = { 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." } } }, oe = {
+  $schema: Q,
+  $id: Z,
+  title: ee,
+  description: te,
+  type: re,
+  additionalProperties: ne
+}, se = Y, B = new z.Ajv({ allErrors: !0, strict: !0 });
+se(B);
+const L = B.compile(oe);
+function M(e, t) {
+  if (L(e)) return;
+  const n = (L.errors ?? []).map((r) => {
+    var a;
+    const o = (a = r.params) != null && a.additionalProperty ? ` '${r.params.additionalProperty}'` : "";
+    return `  - ${r.instancePath || "root"} ${r.message}${o}`;
   }).join(`
 `);
   throw new Error(`Invalid ${t}:
-${r}`);
+${n}`);
+}
+function j(e) {
+  return E(e, "manifest.json");
 }
-function v(e) {
-  return P(e, "manifest.json");
+function F(e) {
+  return E(e, "manifest.json.lock");
 }
-function $(e, t) {
-  return P(e, `${t}.png`);
+function O(e, t) {
+  return E(e, `${t}.png`);
 }
 function b(e) {
-  const t = v(e);
-  if (!l(t)) return {};
-  const r = JSON.parse(g(t, "utf8"));
-  return S(r, t), r;
-}
-function z(e, t) {
-  const r = v(e);
-  S(t, r);
-  const s = {};
-  for (const o of Object.keys(t).sort())
-    s[o] = t[o];
-  w(e, { recursive: !0 }), y(r, JSON.stringify(s, null, 2) + `
-`);
+  const t = j(e);
+  if (!g(t)) return {};
+  const n = JSON.parse($(t, "utf8"));
+  return M(n, t), n;
+}
+function ie(e, t) {
+  const n = j(e);
+  M(t, n);
+  const r = {};
+  for (const a of Object.keys(t).sort())
+    r[a] = t[a];
+  x(e, { recursive: !0 });
+  const o = `${n}.tmp-${process.pid}-${Math.random().toString(36).slice(2)}`;
+  P(o, JSON.stringify(r, null, 2) + `
+`), X(o, n);
+}
+const ae = 25, ce = 15e3;
+function de(e) {
+  return new Promise((t) => setTimeout(t, e));
+}
+async function ue(e) {
+  x(e, { recursive: !0 });
+  const t = F(e), n = Date.now() + ce;
+  for (; ; )
+    try {
+      V(W(t, "wx"));
+      return;
+    } catch (r) {
+      if (r.code !== "EEXIST") throw r;
+      if (Date.now() >= n)
+        throw new Error(
+          `Timed out waiting for the manifest lock at "${t}" — delete it if a previous run crashed while holding it.`
+        );
+      await de(ae);
+    }
+}
+function fe(e) {
+  q(F(e), { force: !0 });
+}
+async function _(e, t, n) {
+  await ue(e);
+  try {
+    const r = b(e), o = n(r[t]);
+    return o === void 0 ? delete r[t] : r[t] = o, ie(e, r), o;
+  } finally {
+    fe(e);
+  }
+}
+function he(e, t, n) {
+  x(e, { recursive: !0 }), P(O(e, t), n);
 }
-function Q(e, t, r) {
-  w(e, { recursive: !0 }), y($(e, t), r);
+async function le(e, t) {
+  const n = b(e), r = Object.keys(n).filter(
+    (o) => !t.has(o)
+  );
+  for (const o of r) {
+    const a = O(e, o);
+    g(a) && J(a), await _(e, o, () => {
+    });
+  }
+  return r;
 }
-const Y = "borderux/recursica";
-async function Z(e, t) {
-  var c, u;
-  const r = await fetch(`https://registry.npmjs.org/${e}`);
-  if (!r.ok)
+const pe = "borderux/recursica";
+async function me(e, t) {
+  var a, d;
+  const n = await fetch(`https://registry.npmjs.org/${e}`);
+  if (!n.ok)
     throw new Error(
-      `Could not reach npm registry for ${e}: ${r.statusText}`
+      `Could not reach npm registry for ${e}: ${n.statusText}`
     );
-  const s = await r.json(), o = ((c = s["dist-tags"]) == null ? void 0 : c[t]) ?? ((u = s.versions) != null && u[t] ? t : void 0);
+  const r = await n.json(), o = ((a = r["dist-tags"]) == null ? void 0 : a[t]) ?? ((d = r.versions) != null && d[t] ? t : void 0);
   if (!o)
     throw new Error(
       `${e} has no version or dist-tag "${t}" on the npm registry.`
     );
   return o;
 }
-function ee(e) {
+function ge(e) {
   return `packages/${e.split("/").pop()}`;
 }
-async function te(e) {
+async function we(e) {
   if (e.type === "local")
-    return l(v(e.dir)) ? {
+    return g(j(e.dir)) ? {
       manifest: b(e.dir),
-      async readImage(i) {
-        const d = $(e.dir, i);
-        return l(d) ? g(d) : null;
+      async readImage(c) {
+        const u = O(e.dir, c);
+        return g(u) ? $(u) : 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 Z(
+    t = await me(
       e.packageName,
       e.versionSpec
     );
-  } catch (a) {
+  } catch (i) {
     return console.warn(
       `Could not resolve ${e.packageName}@${e.versionSpec} — source-of-truth divergence check skipped for this run.`,
-      a
+      i
     ), null;
   }
-  const r = P(e.cacheDir, t), s = `${e.packageName}@${t}`, o = `https://raw.githubusercontent.com/${Y}/${s}/${ee(e.packageName)}/test/golden`;
-  let c;
-  const u = v(r);
-  if (l(u))
-    c = b(r);
+  const n = E(e.cacheDir, t), r = `${e.packageName}@${t}`, o = `https://raw.githubusercontent.com/${pe}/${r}/${ge(e.packageName)}/test/golden`;
+  let a;
+  const d = j(n);
+  if (g(d))
+    a = b(n);
   else {
-    let a;
+    let i;
     try {
-      a = await fetch(`${o}/manifest.json`);
-    } catch (n) {
+      i = await fetch(`${o}/manifest.json`);
+    } catch (f) {
       return console.warn(
-        `Could not reach GitHub to fetch ${s}'s golden baseline — source-of-truth divergence check skipped for this run.`,
-        n
+        `Could not reach GitHub to fetch ${r}'s golden baseline — source-of-truth divergence check skipped for this run.`,
+        f
       ), null;
     }
-    if (!a.ok)
+    if (!i.ok)
       return console.warn(
-        `No golden baseline published for ${s} — source-of-truth divergence check skipped for this run.`
+        `No golden baseline published for ${r} — source-of-truth divergence check skipped for this run.`
       ), null;
-    const i = await a.text(), d = JSON.parse(i);
-    S(d, `${o}/manifest.json`), w(r, { recursive: !0 }), y(u, i), c = d;
+    const c = await i.text(), u = JSON.parse(c);
+    M(u, `${o}/manifest.json`), x(n, { recursive: !0 }), P(d, c), a = u;
   }
   return {
-    manifest: c,
-    async readImage(a) {
-      const i = $(r, a);
-      if (l(i)) return g(i);
-      const d = await fetch(`${o}/${a}.png`);
-      if (!d.ok) return null;
-      const n = Buffer.from(await d.arrayBuffer());
-      return w(r, { recursive: !0 }), y(i, n), n;
+    manifest: a,
+    async readImage(i) {
+      const c = O(n, i);
+      if (g(c)) return $(c);
+      const u = await fetch(`${o}/${i}.png`);
+      if (!u.ok) return null;
+      const f = Buffer.from(await u.arrayBuffer());
+      return x(n, { recursive: !0 }), P(c, f), f;
     }
   };
 }
-const re = ["Theme", "Tokens", "Introduction"];
+const ye = ["Theme", "Tokens", "Introduction"];
 function D(e, t) {
   return e === t || e.startsWith(t);
 }
-async function se(e, t, r) {
-  let s;
+async function ve(e, t, n) {
+  let r;
   try {
     const o = await fetch(`${e.url}/index.json`);
     if (!o.ok)
       throw new Error(
         `Failed to fetch Storybook index: ${o.statusText}`
       );
-    const u = (await o.json()).entries || {};
-    s = Object.values(u).filter(
-      (a) => a.type === "story" && !t.some(
-        (i) => a.title === i || a.title.startsWith(`${i}/`)
-      ) && !r.some((i) => D(a.id, i))
-    ), s.sort((a, i) => a.id.localeCompare(i.id));
+    const d = (await o.json()).entries || {};
+    r = Object.values(d).filter(
+      (i) => i.type === "story" && !t.some(
+        (c) => i.title === c || i.title.startsWith(`${c}/`)
+      ) && !n.some((c) => D(i.id, c))
+    ), r.sort((i, c) => i.id.localeCompare(c.id));
   } catch (o) {
     throw console.error(
       "Failed to load Storybook index from",
@@ -160,82 +213,115 @@ async function se(e, t, r) {
       `Storybook target "${e.name}" is not responsive or index.json is missing. Please ensure its Storybook is running.`
     );
   }
-  return s;
+  return r;
 }
-function oe(e, t, r) {
-  let s;
+function ke(e, t, n) {
+  let r;
   for (const o of Object.keys(t))
-    D(e, o) && (!s || o.length > s.length) && (s = o);
-  return s !== void 0 ? t[s] : r;
+    D(e, o) && (!r || o.length > r.length) && (r = o);
+  return r !== void 0 ? t[r] : n;
 }
-async function le(e) {
-  const t = e.isSourceOfTruthAdapter ? e.targets[0] : e.targets.find((n) => !n.sourceOfTruth);
+async function je(e) {
+  const t = e.isSourceOfTruthAdapter ? e.targets[0] : e.targets.find((s) => !s.sourceOfTruth);
   if (!t)
     throw new Error(
       "adapter-tester config has no non-sourceOfTruth target to run the golden check against."
     );
-  const r = e.excludeTitlePrefixes ?? re, s = e.excludeStoryIds ?? [], o = e.storyThresholds ?? {}, c = e.goldenDir, u = e.goldenMode, a = await se(
+  const n = e.excludeTitlePrefixes ?? ye, r = e.stories ?? {}, o = Object.keys(r).filter(
+    (s) => r[s].exclude
+  ), a = Object.fromEntries(
+    Object.entries(r).filter(([, s]) => s.threshold !== void 0).map(([s, y]) => [s, y.threshold])
+  ), d = e.goldenDir, i = e.goldenMode, c = e.checkMode, u = await ve(
     t,
-    r,
-    s
-  ), i = b(c), d = e.isSourceOfTruthAdapter || !e.sourceOfTruthGolden ? null : await te(e.sourceOfTruthGolden);
-  I.describe(`${t.name} — Golden Image Visual Regression`, () => {
-    for (const n of a)
-      I(`Golden regression for: ${n.title} - ${n.name} (${n.id})`, async ({
-        browser: B
-      }, T) => {
-        const p = await B.newPage();
-        await p.setViewportSize({ width: 800, height: 600 }), await p.goto(
-          `${t.url}/iframe.html?id=${n.id}&viewMode=story`,
-          { waitUntil: "networkidle" }
-        ), await p.waitForSelector("#storybook-root"), await p.waitForTimeout(300);
-        const j = await p.screenshot(), k = $(c, n.id), f = i[n.id];
-        if (u !== "check" || !f || !l(k))
-          Q(c, n.id, j), i[n.id] = f != null && f.sourceOfTruthCreatedAt ? {
-            createdAt: (/* @__PURE__ */ new Date()).toISOString(),
-            sourceOfTruthCreatedAt: f.sourceOfTruthCreatedAt
-          } : { createdAt: (/* @__PURE__ */ new Date()).toISOString() }, f || T.annotations.push({
-            type: "golden-created",
-            description: `No golden existed yet for "${n.id}" — captured one from this run.`
-          });
-        else {
-          const h = g(k), m = G(j, h);
-          await T.attach("Live vs Golden Diff", {
-            body: `${m} mismatched pixels`,
-            contentType: "text/plain"
-          });
-          const x = oe(
-            n.id,
-            o,
-            e.diffThresholdPixels
-          );
-          M.soft(
-            m,
-            `"${n.id}" has drifted from its own golden image`
-          ).toBeLessThan(x);
-        }
-        const A = i[n.id];
-        if (d) {
-          const h = d.manifest[n.id], m = h ? await d.readImage(n.id) : null;
-          if (h && m)
-            if (u === "approve-divergence")
-              i[n.id] = {
-                ...A,
-                sourceOfTruthCreatedAt: h.createdAt
-              };
-            else {
-              const x = g(k), F = G(x, m), E = A.sourceOfTruthCreatedAt;
-              F === 0 || E !== void 0 && E >= h.createdAt || T.annotations.push({
-                type: "source-of-truth-divergence",
-                description: `"${n.id}" differs from the source of truth's golden and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
-              });
-            }
-        }
-        z(c, i);
-      });
-  });
+    n,
+    o
+  );
+  if (i === "update-golden") {
+    const s = await le(
+      d,
+      new Set(u.map((y) => y.id))
+    );
+    s.length > 0 && console.warn(
+      `Pruned ${s.length} orphaned golden(s) no longer in Storybook: ${s.join(", ")}`
+    );
+  }
+  const f = c !== "divergence" || e.isSourceOfTruthAdapter || !e.sourceOfTruthGolden ? null : await we(e.sourceOfTruthGolden), R = c === "divergence" ? "Source-of-Truth Divergence Check" : "Own-Drift Golden Image Check";
+  return {
+    ownTargetName: t.name,
+    suiteLabel: R,
+    stories: u,
+    checkStory: async (s, y, h) => {
+      const v = await y.newPage();
+      await v.setViewportSize({ width: 800, height: 600 }), await v.goto(
+        `${t.url}/iframe.html?id=${s.id}&viewMode=story`,
+        { waitUntil: "networkidle" }
+      ), await v.waitForSelector("#storybook-root"), await v.waitForTimeout(300);
+      const A = await v.screenshot(), I = O(d, s.id), l = b(d)[s.id], U = i !== "check" || !l || !g(I);
+      let w;
+      if (U)
+        he(d, s.id, A), w = l != null && l.sourceOfTruthCreatedAt ? {
+          createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+          sourceOfTruthCreatedAt: l.sourceOfTruthCreatedAt
+        } : { createdAt: (/* @__PURE__ */ new Date()).toISOString() }, l || h.annotations.push({
+          type: "golden-created",
+          description: `No golden existed yet for "${s.id}" — captured one from this run.`
+        });
+      else if (w = l, c === "own") {
+        const p = $(I), { diffPixels: m, diffImage: k } = N(
+          A,
+          p
+        ), T = ke(
+          s.id,
+          a,
+          e.diffThresholdPixels
+        );
+        m >= T && (await h.attach("expected", {
+          body: p,
+          contentType: "image/png"
+        }), await h.attach("actual", {
+          body: A,
+          contentType: "image/png"
+        }), k && await h.attach("diff", {
+          body: k,
+          contentType: "image/png"
+        })), K.soft(
+          m,
+          `"${s.id}" has drifted from its own golden image (${m} mismatched pixels, threshold ${T})`
+        ).toBeLessThan(T);
+      }
+      if (f) {
+        const p = f.manifest[s.id], m = p ? await f.readImage(s.id) : null;
+        if (p && m)
+          if (i === "approve-divergence")
+            w = {
+              ...w,
+              sourceOfTruthCreatedAt: p.createdAt
+            };
+          else {
+            const k = $(I), { diffPixels: T, diffImage: C } = N(
+              k,
+              m
+            ), G = w.sourceOfTruthCreatedAt;
+            T === 0 || G !== void 0 && G >= p.createdAt || (await h.attach("expected", {
+              body: m,
+              contentType: "image/png"
+            }), await h.attach("actual", {
+              body: k,
+              contentType: "image/png"
+            }), C && await h.attach("diff", {
+              body: C,
+              contentType: "image/png"
+            }), h.annotations.push({
+              type: "source-of-truth-divergence",
+              description: `"${s.id}" differs from the source of truth's golden and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
+            }));
+          }
+      }
+      await _(d, s.id, () => w);
+    }
+  };
 }
 export {
-  le as runVisualRegression
+  je as resolveVisualRegressionPlan
 };
 //# sourceMappingURL=testing.js.map