@codeyam-editor/codeyam-editor 0.1.0 → 0.1.2

package/npm/scenario-check.js

@@ -1,322 +1,344 @@
 #!/usr/bin/env node
 
+// Render environment (colorScheme, deviceScaleFactor, userAgent, locale,
+// timezoneId, reduceMotion, forcedColors) is read from config when present
+// and passed to browser.newContext(). This is what makes screenshots match
+// the Live Preview iframe's host browser — see docs/rendering.md.
+//
+// iframeBackground is forwarded to buildIframeHarness so the capture paints
+// the user's editor-shell background (or whatever the UI detected) behind
+// the iframe instead of a hardcoded white.
+
 const fs = require("fs");
 const path = require("path");
+const { execSync } = require("child_process");
 const { chromium } = require("playwright");
 
-const LOADING_MARKERS = [
-  "Loading scenario...",
-  "Loading tests...",
-  "Loading scenarios...",
-  "disconnected",
-];
-
-function hasLoadingMarkers(text) {
-  return LOADING_MARKERS.some((marker) => text.includes(marker));
-}
-
-function hasRenderableContent(state) {
-  return Boolean(
-    state &&
-      (state.rootChildCount > 0 ||
-        state.rootTextLength > 0 ||
-        state.bodyTextLength > 0),
-  );
+// Substring Playwright has emitted across every 1.x release when the
+// browser cache is empty. Match the substring (not the full string)
+// because Playwright includes the offending path inline.
+const PLAYWRIGHT_MISSING_BROWSER_PATTERN = "Executable doesn't exist";
+const PLAYWRIGHT_INSTALL_COMMAND = "npx playwright install chromium";
+
+// One-shot self-heal around `chromium.launch()`. If the first launch
+// throws the "missing browser" error, run `npx playwright install
+// chromium` synchronously (with `stdio: "inherit"` so the user sees
+// progress) and retry the launch exactly once. If the install or the
+// retry fails, rethrow the ORIGINAL Playwright error so the existing
+// `Scenario check failed: <stderr>` path keeps showing the actionable
+// message — looping would hide a real ops failure under a slow timeout.
+async function launchChromiumWithSelfHeal({
+  launch = () => chromium.launch(),
+  install = () => execSync(PLAYWRIGHT_INSTALL_COMMAND, { stdio: "inherit" }),
+  stderr = process.stderr,
+} = {}) {
+  try {
+    return await launch();
+  } catch (error) {
+    const isMissingBrowser =
+      error &&
+      typeof error.message === "string" &&
+      error.message.includes(PLAYWRIGHT_MISSING_BROWSER_PATTERN);
+    if (!isMissingBrowser) throw error;
+    stderr.write(
+      "Playwright's Chromium browser is missing — installing it now (one-time ~150 MB download). Subsequent runs will be instant.\n",
+    );
+    try {
+      install();
+    } catch (_installError) {
+      throw error;
+    }
+    try {
+      return await launch();
+    } catch (_retryError) {
+      throw error;
+    }
+  }
 }
 
-const ERROR_PATTERNS = [
-  "not found in registry",
-  "Component not found",
-  "Scenario Error",
-];
+const {
+  findErrorPattern,
+  buildErrorContextSnippet,
+  hasRenderableContent,
+  describeBlankReason,
+} = require("./scenario-metrics");
 
-function hasErrorPatterns(text) {
-  return ERROR_PATTERNS.some((pattern) => text.includes(pattern));
-}
+const {
+  createIssue,
+  pushIssue,
+  buildResult,
+} = require("./scenario-issues");
 
-function createIssue(kind, message, extra = {}) {
-  return {
-    kind,
-    message,
-    url: extra.url ?? null,
-    status: extra.status ?? null,
-  };
-}
+const {
+  attachHttpMocks,
+} = require("./scenario-mocks");
 
-function pushIssue(issues, issue) {
-  const key = JSON.stringify(issue);
-  if (!issues.some((existing) => JSON.stringify(existing) === key)) {
-    issues.push(issue);
+const {
+  assertAppPortReachable,
+  loadScenarioInIframe,
+  loadScenarioTopLevel,
+  waitForStablePage,
+  collectContentState,
+} = require("./scenario-playwright");
+
+const {
+  getInitScript,
+  handleConsoleMessage,
+  handlePageError,
+  handleRequestFailed,
+} = require("./scenario-handlers");
+
+const {
+  probeInteractivity,
+} = require("./scenario-interactivity");
+
+// Read project-specific loading markers from `.codeyam/stack.json`
+// (`capture.loadingMarkers`). The capture script runs with cwd = project dir
+// (scenario_check.rs sets `.current_dir(project_dir)`), so this relative path
+// resolves to the project's own config. An app's loading copy ("Loading…",
+// "Please wait") is app-specific, so it lives in stack.json rather than being
+// hardcoded into the shared harness; the codeyam-harness defaults in
+// scenario-metrics.js always apply on top. Never throws — a missing or
+// malformed stack.json just yields no extra markers.
+function readStackLoadingMarkers() {
+  try {
+    const raw = fs.readFileSync(path.join(".codeyam", "stack.json"), "utf8");
+    const stack = JSON.parse(raw);
+    const markers = stack && stack.capture && stack.capture.loadingMarkers;
+    return Array.isArray(markers)
+      ? markers.filter((m) => typeof m === "string" && m.length > 0)
+      : [];
+  } catch (_) {
+    return [];
   }
 }
 
-function escapeHtmlAttribute(value) {
-  return String(value)
-    .replaceAll("&", "&amp;")
-    .replaceAll('"', "&quot;");
-}
-
-function buildIframeHarness(url) {
-  const escapedUrl = escapeHtmlAttribute(url);
-  return `<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <style>
-      html, body {
-        margin: 0;
-        width: 100%;
-        height: 100%;
-        overflow: hidden;
-        background: #fff;
-      }
-
-      iframe {
-        display: block;
-        width: 100%;
-        height: 100%;
-        border: 0;
-        background: #fff;
-      }
-    </style>
-  </head>
-  <body>
-    <iframe id="scenario-frame" title="Scenario Preview" src="${escapedUrl}"></iframe>
-  </body>
-</html>`;
-}
-
-function buildResult({ loaded, hasContent, issues, outputPath, url }) {
-  return {
-    ok: loaded && hasContent && issues.length === 0,
-    loaded,
-    hasContent,
-    url,
-    outputPath: outputPath ?? null,
-    issues,
-  };
-}
-
-function normalizeMockCandidates(url) {
+// Cold-start retry pause. waitForStablePage settles as soon as the page is
+// HTML-stable, which for a lazy/Suspense app is the empty `<div id="root">`
+// shell — stable for the ~3s the dynamic chunk takes to load (longer when the
+// scenario's mocks slow the boot). 500ms re-checked before the chunk resolved
+// and reported a false blank; this pause must comfortably exceed that window
+// while staying under the test runner's default per-case timeout.
+const BLANK_RETRY_DELAY_MS = 3000;
+
+// True when `url` targets a different origin than `appOrigin`. Used to decide
+// whether the codeyam capture markers must be stripped before the request
+// leaves (cross-origin) or may ride along (same-origin, the app's own dev
+// server). A malformed URL counts as same-origin (false) so we never strip
+// markers from a request we can't classify — the conservative default keeps
+// same-origin behavior unchanged. `url` may be a string or a URL-like object.
+function isCrossOriginRequest(url, appOrigin) {
   try {
-    const parsed = new URL(url);
-    return [url, `${parsed.pathname}${parsed.search}`, parsed.pathname];
-  } catch {
-    return [url];
+    const href = typeof url === "string" ? url : url.href;
+    return new URL(href).origin !== appOrigin;
+  } catch (_) {
+    return false;
   }
 }
 
-function findHttpMock(httpMocks, request) {
-  const method = request.method().toUpperCase();
-  const candidates = normalizeMockCandidates(request.url());
-  for (const candidate of candidates) {
-    const key = `${method} ${candidate}`;
-    if (httpMocks[key]) {
-      return httpMocks[key];
-    }
+// Return a copy of `headers` with every name in `markerNames` removed.
+// Names are matched case-insensitively against the (lowercased) header keys
+// Playwright reports. Pure — never mutates its input — so unrelated headers
+// (Accept, User-Agent, a scenario's own requestHeaders) survive untouched.
+function stripMarkerHeaders(headers, markerNames) {
+  const out = { ...headers };
+  for (const name of markerNames) {
+    delete out[name.toLowerCase()];
   }
-  return null;
+  return out;
 }
 
-async function attachHttpMocks(page, httpMocks) {
-  if (!httpMocks || Object.keys(httpMocks).length === 0) return;
-
-  await page.route("**/*", async (route) => {
-    const mock = findHttpMock(httpMocks, route.request());
-    if (!mock) {
-      await route.continue();
-      return;
-    }
-
-    const headers = { ...(mock.headers || {}) };
-    let body;
-    if (mock.body !== undefined) {
-      body =
-        typeof mock.body === "string" ? mock.body : JSON.stringify(mock.body);
-      const hasContentType = Object.keys(headers).some(
-        (key) => key.toLowerCase() === "content-type",
-      );
-      if (!hasContentType) {
-        headers["content-type"] = "application/json";
-      }
+// Apply the scenario's merged `browserState` to a Playwright context and
+// stamp the codeyam capture markers on every request the context makes.
+//
+// Cookies need a concrete URL to bind to (Playwright requires either
+// `url` or `domain`+`path`); we derive domain/path from the requested
+// capture URL when the scenario didn't pin them. Request headers go
+// through `setExtraHTTPHeaders` so every navigation and resource
+// request in the context carries them.
+//
+// Every capture-originated request carries `X-Codeyam-Capture: 1` (and
+// `X-Codeyam-Scenario: <slug>` when a scenario is active) so a dev-server
+// log can tell the headless capture apart from the operator's own browser
+// hitting the same route — they are otherwise indistinguishable. These are
+// defaults: a scenario's own `requestHeaders` are merged on top and win,
+// so a user can override or clear them.
+async function applyBrowserState(context, config) {
+  const state = (config && config.browserState) || {};
+  const cookies = state.cookies || {};
+  const cookieEntries = Object.entries(cookies);
+  if (cookieEntries.length > 0) {
+    let host = "127.0.0.1";
+    try {
+      host = new URL(config.url).hostname || host;
+    } catch (_) {
+      /* fall back to localhost if config.url is malformed */
     }
-
-    await route.fulfill({
-      status: mock.status || 200,
-      headers,
-      body,
-    });
-  });
-
-  // Disable the in-page fetch mock by returning an empty active-mocks.json.
-  // The HTML injects a script that synchronously loads this file and
-  // monkey-patches window.fetch, which would bypass Playwright's route
-  // interception. This route is registered AFTER **/* so it takes priority
-  // (Playwright uses LIFO ordering for route handlers).
-  await page.route("**/active-mocks.json", async (route) => {
-    await route.fulfill({
-      status: 200,
-      headers: { "content-type": "application/json" },
-      body: "[]",
+    const playwrightCookies = cookieEntries.map(([name, raw]) => {
+      const descriptor =
+        raw && typeof raw === "object" && !Array.isArray(raw) ? raw : {};
+      const value = typeof raw === "string" ? raw : descriptor.value || "";
+      return {
+        name,
+        value,
+        domain: descriptor.domain || host,
+        path: descriptor.path || "/",
+        sameSite: descriptor.sameSite || "Lax",
+        httpOnly: descriptor.httpOnly === true,
+        secure: descriptor.secure === true,
+      };
     });
-  });
-}
-
-async function collectContentState(target) {
-  return target.evaluate(() => {
-    const root = document.getElementById("root");
-    return {
-      bodyTextLength: document.body.innerText.trim().length,
-      rootChildCount: root ? root.childElementCount : 0,
-      rootTextLength: root ? (root.textContent || "").trim().length : 0,
-    };
-  });
-}
-
-async function waitForStablePage(page, target, timeoutMs = 10000) {
-  const started = Date.now();
-  let lastHtml = "";
-  let stableCount = 0;
-
-  while (Date.now() - started < timeoutMs) {
-    await page.waitForTimeout(500);
-
-    const pageState = await target.evaluate(() => ({
-      bodyText: document.body.innerText,
-      html: document.body.innerHTML,
-    }));
-
-    if (
-      !hasLoadingMarkers(pageState.bodyText) &&
-      pageState.html === lastHtml
-    ) {
-      stableCount += 1;
-      if (stableCount >= 2) return;
-    } else {
-      stableCount = 0;
-    }
+    await context.addCookies(playwrightCookies);
+  }
+  const codeyamHeaders = {
+    "X-Codeyam-Capture": "1",
+    ...(config && config.scenarioId
+      ? { "X-Codeyam-Scenario": config.scenarioId }
+      : {}),
+  };
+  // Scenario `requestHeaders` are merged last so a user value overrides
+  // the codeyam default (e.g. setting `X-Codeyam-Capture: "0"` as an
+  // escape hatch). `codeyamHeaders` always has at least the capture marker,
+  // so this fires on every capture — including ones with no browserState.
+  const headers = { ...codeyamHeaders, ...(state.requestHeaders || {}) };
+  if (Object.keys(headers).length > 0) {
+    await context.setExtraHTTPHeaders(headers);
+  }
 
-    lastHtml = pageState.html;
+  // Strip the codeyam capture markers (and any scenario request headers) from
+  // CROSS-ORIGIN requests. setExtraHTTPHeaders applies context-wide, so the
+  // custom `X-Codeyam-*` headers ride along on third-party subresource
+  // requests (Google Fonts, CDNs, external APIs) too — and a non-safelisted
+  // request header forces a CORS preflight those hosts reject
+  // (`Request header field x-codeyam-capture is not allowed`), which fails the
+  // whole capture. The markers are only meaningful to the app's OWN dev server
+  // (same-origin), so re-send cross-origin requests without them. Same-origin
+  // requests are never matched here, so dev-module/HMR loading is untouched.
+  let appOrigin = null;
+  try {
+    appOrigin = new URL(config.url).origin;
+  } catch (_) {
+    /* malformed capture URL — skip the cross-origin guard entirely */
+  }
+  if (appOrigin && typeof context.route === "function") {
+    // Only the codeyam markers are stripped — a scenario's own requestHeaders
+    // are the author's deliberate choice and left intact.
+    const markerNames = Object.keys(codeyamHeaders);
+    await context.route(
+      (url) => isCrossOriginRequest(url, appOrigin),
+      async (route) => {
+        const reqHeaders = stripMarkerHeaders(route.request().headers(), markerNames);
+        await route.continue({ headers: reqHeaders });
+      },
+    );
   }
 }
 
-async function loadScenarioInIframe(page, url) {
-  const responsePromise = page
-    .waitForResponse(
-      (response) =>
-        response.request().resourceType() === "document" &&
-        response.url() === url,
-      { timeout: 30000 },
-    )
-    .catch(() => null);
-
-  await page.setContent(buildIframeHarness(url), { waitUntil: "domcontentloaded" });
-
-  const frameHandle = await page.waitForSelector("#scenario-frame", {
-    state: "attached",
-    timeout: 30000,
-  });
-  const frame = await frameHandle.contentFrame();
-  if (!frame) {
-    throw new Error("Scenario iframe did not attach");
+// Emit a `redirect-mismatch` issue when the final iframe URL's path
+// differs from the requested path. This converts the silent
+// screenshot-of-/login failure (auth lost in the capture context) into
+// a typed, actionable diagnostic the agent can route to.
+function pushRedirectMismatchIssue(issues, requestedUrl, frame, response, config) {
+  let requestedPath;
+  try {
+    requestedPath = new URL(requestedUrl).pathname;
+  } catch (_) {
+    return;
   }
-
-  await frame.waitForLoadState("load", { timeout: 30000 });
-  const response = await responsePromise;
-  return { frame, response };
+  const finalUrl = (frame && frame.url && frame.url()) || requestedUrl;
+  let finalPath;
+  try {
+    finalPath = new URL(finalUrl).pathname;
+  } catch (_) {
+    return;
+  }
+  if (requestedPath === finalPath) return;
+  const cookies =
+    (config && config.browserState && config.browserState.cookies) || {};
+  const hasCookies = Object.keys(cookies).length > 0;
+  const hint = hasCookies
+    ? " — scenario carries browserState.cookies; auth likely lost in the capture context (run `codeyam-editor editor scenario-explain <slug>` to verify)"
+    : "";
+  pushIssue(
+    issues,
+    createIssue(
+      "redirect-mismatch",
+      `Capture URL redirected from ${requestedPath} to ${finalPath}${hint}`,
+      {
+        url: finalUrl,
+        status: response && response.status ? response.status() : null,
+      },
+    ),
+  );
 }
 
-async function runScenarioCheck(config) {
+// `preflight` is injectable (defaulting to the real app-port reachability
+// check) so unit tests that mock the browser can stay network-free.
+async function runScenarioCheck(config, { preflight = assertAppPortReachable } = {}) {
   const { url, outputPath, width, height, httpMocks = {} } = config;
   const issues = [];
-  const browser = await chromium.launch();
-  const context = await browser.newContext({
+  const browser = await launchChromiumWithSelfHeal();
+  const contextOptions = {
     viewport: { width: width || 1440, height: height || 900 },
-  });
+  };
+  if (config.colorScheme) contextOptions.colorScheme = config.colorScheme;
+  if (config.deviceScaleFactor)
+    contextOptions.deviceScaleFactor = config.deviceScaleFactor;
+  if (config.userAgent) contextOptions.userAgent = config.userAgent;
+  if (config.locale) contextOptions.locale = config.locale;
+  if (config.timezoneId) contextOptions.timezoneId = config.timezoneId;
+  if (config.reduceMotion) contextOptions.reducedMotion = config.reduceMotion;
+  if (config.forcedColors) contextOptions.forcedColors = config.forcedColors;
+  const context = await browser.newContext(contextOptions);
+
+  // Apply the scenario's merged `browserState` (cookies + request
+  // headers) to the capture context BEFORE the first navigation.
+  // Belt-and-suspenders with the proxy's `Set-Cookie` injection: the
+  // proxy handles upstream-bound forwards, this branch handles the
+  // capture context's own request headers so an auth-gated route does
+  // not redirect to `/login` when the proxy is bypassed.
+  await applyBrowserState(context, config);
 
   // Context-level init script runs in ALL frames (including cross-origin iframes)
-  await context.addInitScript(() => {
-    window.__codeyamUnhandledRejections = [];
-    window.addEventListener("unhandledrejection", (event) => {
-      const reason = event.reason;
-      const message =
-        reason instanceof Error ? reason.message : String(reason);
-      window.__codeyamUnhandledRejections.push(message);
-    });
-
-    // Stub WebSocket during capture to prevent terminal reconnection spam.
-    // Returns an object that behaves like a closed WebSocket — the terminal
-    // will attempt to reconnect a few times then give up silently.
-    window.WebSocket = class StubWebSocket {
-      static CONNECTING = 0;
-      static OPEN = 1;
-      static CLOSING = 2;
-      static CLOSED = 3;
-      readyState = 3;
-      onopen = null;
-      onclose = null;
-      onerror = null;
-      onmessage = null;
-      send() {}
-      close() {}
-      addEventListener() {}
-      removeEventListener() {}
-      dispatchEvent() { return false; }
-      constructor() {
-        // Fire onerror then onclose on next tick so the terminal sees a failed connection
-        setTimeout(() => {
-          if (this.onerror) this.onerror(new Event("error"));
-          if (this.onclose) this.onclose(new CloseEvent("close"));
-        }, 0);
-      }
-    };
-  });
+  await context.addInitScript(getInitScript());
 
   const page = await context.newPage();
   await attachHttpMocks(page, httpMocks);
 
   page.on("pageerror", (error) => {
-    pushIssue(
-      issues,
-      createIssue("pageerror", error.message || String(error), {
-        url: page.url() || url,
-      }),
-    );
+    pushIssue(issues, handlePageError(error));
   });
 
   page.on("console", (message) => {
-    if (message.type() !== "error") return;
-    const text = message.text();
-    // Ignore known dev-server WebSocket/HMR errors from Vite proxy
-    if (
-      text.includes("WebSocket connection to") ||
-      text.includes("Unsupported Media Type")
-    ) {
-      return;
+    const issue = handleConsoleMessage(message);
+    if (issue) {
+      pushIssue(issues, issue);
     }
-    pushIssue(
-      issues,
-      createIssue("console", text, {
-        url: page.url() || url,
-      }),
-    );
   });
 
   page.on("requestfailed", (request) => {
-    pushIssue(
-      issues,
-      createIssue(
-        "requestfailed",
-        request.failure()?.errorText || "Request failed",
-        { url: request.url() },
-      ),
-    );
+    const issue = handleRequestFailed(request);
+    if (issue) {
+      pushIssue(issues, issue);
+    }
   });
 
   let loaded = false;
 
   try {
-    const { frame, response } = await loadScenarioInIframe(page, url);
+    // Application/route captures navigate at the top level so the
+    // first-party session cookie is sent (auth-gated routes render the
+    // authenticated page instead of /login); component captures keep the
+    // iframe harness for its background/sizing control. The backend signals
+    // the choice via `config.navigation` ("topLevel"); absent (the default)
+    // means the iframe harness, so existing callers are unchanged.
+    const { frame, response } =
+      config.navigation === "topLevel"
+        ? await loadScenarioTopLevel(page, url, { preflight })
+        : await loadScenarioInIframe(page, url, {
+            background: config.iframeBackground,
+            preflight,
+          });
     loaded = true;
 
     if (response && response.status() >= 400) {
@@ -329,7 +351,15 @@ async function runScenarioCheck(config) {
       );
     }
 
-    await waitForStablePage(page, frame);
+    pushRedirectMismatchIssue(issues, url, frame, response, config);
+
+    // Project loading markers come from config when a caller injects them
+    // (unit tests), otherwise from stack.json — so a stable-but-loading app
+    // screen is not mistaken for settled content and captured mid-hydration.
+    const loadingMarkers = Array.isArray(config.loadingMarkers)
+      ? config.loadingMarkers
+      : readStackLoadingMarkers();
+    await waitForStablePage(page, frame, 10000, loadingMarkers);
 
     const rejectionMessages = await frame.evaluate(
       () => window.__codeyamUnhandledRejections || [],
@@ -343,29 +373,63 @@ async function runScenarioCheck(config) {
       );
     }
 
-    const contentState = await collectContentState(frame);
-    const hasContent = hasRenderableContent(contentState);
+    // Cold-start retry: a single re-collect after BLANK_RETRY_DELAY_MS covers
+    // the React.lazy / Suspense-fallback race where waitForStablePage settles
+    // on the still-empty `<div id="root">` shell before the dynamic chunk
+    // resolves. One retry is enough — the pause is sized to outlast the
+    // chunk-load window; only a genuinely blank page falls through to the
+    // blank issue below.
+    let contentState = await collectContentState(frame);
+    let hasContent = hasRenderableContent(contentState);
+    if (!hasContent) {
+      await new Promise((r) => setTimeout(r, BLANK_RETRY_DELAY_MS));
+      contentState = await collectContentState(frame);
+      hasContent = hasRenderableContent(contentState);
+    }
 
     if (!hasContent) {
       pushIssue(
         issues,
-        createIssue("blank", "Page rendered no visible content", {
-          url: page.url() || url,
-        }),
+        createIssue(
+          "blank",
+          `Page rendered no visible content (${describeBlankReason(contentState)})`,
+          { url: page.url() || url },
+        ),
       );
     }
 
     // Check for known error states in the rendered content
-    const bodyText = await frame.evaluate(() => document.body.innerText || "");
-    if (hasErrorPatterns(bodyText)) {
+    const bodyText = await frame.evaluate(() => document.body?.innerText || "");
+    const matchedPattern = findErrorPattern(bodyText);
+    if (matchedPattern) {
+      const contextSnippet = buildErrorContextSnippet(bodyText, matchedPattern);
       pushIssue(
         issues,
-        createIssue("error-state", `Page contains error content: ${bodyText.slice(0, 200)}`, {
-          url: page.url() || url,
-        }),
+        createIssue(
+          "error-state",
+          `Page contains error content (matched "${matchedPattern}"): ${contextSnippet ?? bodyText.slice(0, 200)}`,
+          {
+            url: page.url() || url,
+            matchedPattern,
+            contextSnippet,
+          },
+        ),
       );
     }
 
+    // Hydration / interactivity gate: a page can render content and log no
+    // errors yet never have hydrated, leaving every control dead. Read-only
+    // (it inspects framework-attachment markers, never clicks), so it is safe
+    // to run before the screenshot. Stack-gated and fail-safe — see
+    // scenario-interactivity.js — so backend / static / unknown-framework
+    // captures are an automatic pass.
+    const hydrationIssue = await probeInteractivity(frame, {
+      url: page.url() || url,
+    });
+    if (hydrationIssue) {
+      pushIssue(issues, hydrationIssue);
+    }
+
     if (outputPath && loaded) {
       fs.mkdirSync(path.dirname(outputPath), { recursive: true });
       await page.screenshot({ path: outputPath, fullPage: false });
@@ -396,6 +460,11 @@ async function runScenarioCheck(config) {
   }
 }
 
+/**
+ * npm wrapper entry point for the scenario-check binary: parses the
+ * JSON config from argv, drives Playwright to capture the configured
+ * URL, and writes the resulting screenshot.
+ */
 async function main() {
   const config = JSON.parse(process.argv[2] || "{}");
 
@@ -411,19 +480,15 @@ async function main() {
 }
 
 module.exports = {
-  attachHttpMocks,
-  buildResult,
-  buildIframeHarness,
-  createIssue,
-  findHttpMock,
-  hasErrorPatterns,
-  hasLoadingMarkers,
-  hasRenderableContent,
-  loadScenarioInIframe,
-  normalizeMockCandidates,
-  pushIssue,
   runScenarioCheck,
-  waitForStablePage,
+  readStackLoadingMarkers,
+  applyBrowserState,
+  isCrossOriginRequest,
+  stripMarkerHeaders,
+  main,
+  launchChromiumWithSelfHeal,
+  PLAYWRIGHT_INSTALL_COMMAND,
+  PLAYWRIGHT_MISSING_BROWSER_PATTERN,
 };
 
 if (require.main === module) {