Spaces:
Running
Running
File size: 8,637 Bytes
88d2f2a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | // W7-E: Verify SSR/CSR hydration parity for mode-dependent rendering.
// Run: node ui/scripts/w7-e-verify.mjs
//
// What this exercises:
// 1. Cold load `/?mode=mock` headless β capture ALL console messages and
// assert no hydration warnings ("did not match", "hydrating", "Warning:
// Prop", "Hydration failed", "Text content does not match").
// 2. Take a screenshot at first DOM-ready (before the hydration effect has
// had a chance to flip mode), and a second screenshot ~250ms later
// (after the effect commits and switches to mock).
// 3. Verify the post-mount DOM reports `data-mode="mock"` on the header
// and the trigger button label reads "Trigger mock demo".
// 4. Sanity: also do a clean `/` (live) reload to confirm we didn't break
// the live-mode rendering path.
//
// Pass criteria: 0 hydration warnings AND post-mount DOM reflects mock mode
// AND the live-mode reload shows live (cyan / Zap / "Trigger live demo").
import { chromium } from "playwright";
import { mkdirSync, writeFileSync } from "node:fs";
import { dirname, resolve } from "node:path";
import { fileURLToPath } from "node:url";
const BASE_UI = "http://localhost:3001";
const SCRIPT_DIR = dirname(fileURLToPath(import.meta.url));
const SHOT_DIR = resolve(SCRIPT_DIR, "..", "screenshots", "w7-e");
const REPORT = resolve(SHOT_DIR, "report.txt");
mkdirSync(SHOT_DIR, { recursive: true });
const log = (...a) => console.log("[w7-e]", ...a);
// Patterns that flag a real hydration mismatch in React 18 / Next 15. We
// keep these strict so any future regression surfaces immediately.
const HYDRATION_PATTERNS = [
/did not match/i,
/hydration failed/i,
/hydration mismatch/i,
/text content does not match/i,
/server rendered html didn't match the client/i,
/there was an error while hydrating/i,
/warning:\s*prop\s+`[^`]+`\s+did not match/i,
];
const isHydrationWarning = (text) =>
HYDRATION_PATTERNS.some((re) => re.test(text));
const launchTab = async (browser, label) => {
const ctx = await browser.newContext({ viewport: { width: 1440, height: 900 } });
const page = await ctx.newPage();
const messages = [];
page.on("console", (msg) => {
const entry = { type: msg.type(), text: msg.text() };
messages.push(entry);
if (msg.type() === "error" || msg.type() === "warning") {
log(`[${label}:${msg.type()}]`, msg.text());
}
});
page.on("pageerror", (err) => {
messages.push({ type: "pageerror", text: String(err) });
log(`[${label}:pageerror]`, String(err));
});
return { ctx, page, messages };
};
const browser = await chromium.launch({ headless: true });
// βββ Scenario 1a: raw SSR shell for /?mode=mock βββββββββββββββββββββββββββ
// We hit the server with plain fetch (no JS) to assert the HTML payload
// itself reports the safe "live" shell β that's what proves the SSR/CSR
// output match and hydration cannot mismatch. Playwright's DOMContentLoaded
// fires too late to observe this (the hydration effect commits first).
log("=== Scenario 1a: SSR shell (raw fetch /?mode=mock) ===");
const ssrHtml = await (await fetch(`${BASE_UI}/?mode=mock`)).text();
const ssrModeMatch = ssrHtml.match(/data-mode="([^"]+)"/);
const ssrMode = ssrModeMatch ? ssrModeMatch[1] : null;
const ssrHasMockLabel = /Trigger mock demo/.test(ssrHtml);
const ssrHasLiveLabel = /Trigger live demo/.test(ssrHtml);
log(
`SSR shell: data-mode=${ssrMode} hasLiveLabel=${ssrHasLiveLabel} hasMockLabel=${ssrHasMockLabel}`,
);
const ssrShellOk = ssrMode === "live" && ssrHasLiveLabel && !ssrHasMockLabel;
// βββ Scenario 1b: client hydration + post-mount switch ββββββββββββββββββββ
log("=== Scenario 1b: client load /?mode=mock ===");
const mockTab = await launchTab(browser, "mock");
await mockTab.page.goto(`${BASE_UI}/?mode=mock`, {
waitUntil: "domcontentloaded",
timeout: 30000,
});
// Screenshot immediately after DOMContentLoaded. By this point React has
// usually already committed the post-mount mode flip (millisecond budget),
// so this captures the resolved state β useful for visual diffing.
const preMountShot = resolve(SHOT_DIR, "01-pre-mount.png");
await mockTab.page.screenshot({ path: preMountShot, fullPage: false });
const preMountMode = await mockTab.page
.locator("header[data-mode]")
.first()
.getAttribute("data-mode")
.catch(() => null);
const preMountLabel = await mockTab.page
.locator('button[aria-label*="Trigger"]')
.first()
.textContent()
.catch(() => null);
log(
`at-DCL: data-mode=${preMountMode} button="${preMountLabel?.trim() ?? null}"`,
);
// Wait for the hydration effect + mode-switch effect to commit.
await mockTab.page.waitForTimeout(400);
const postMountShot = resolve(SHOT_DIR, "02-post-mount.png");
await mockTab.page.screenshot({ path: postMountShot, fullPage: false });
const postMountMode = await mockTab.page
.locator("header[data-mode]")
.first()
.getAttribute("data-mode")
.catch(() => null);
const postMountLabel = await mockTab.page
.locator('button[aria-label*="Trigger"]')
.first()
.textContent()
.catch(() => null);
log(
`post-mount: data-mode=${postMountMode} button="${postMountLabel?.trim() ?? null}"`,
);
// Let any deferred hydration logs flush before we tally warnings.
await mockTab.page.waitForTimeout(200);
const mockHydrationHits = mockTab.messages.filter((m) =>
isHydrationWarning(m.text),
);
// βββ Scenario 2: clean live load / ββββββββββββββββββββββββββββββββββββββββ
log("=== Scenario 2: clean live load / ===");
const liveTab = await launchTab(browser, "live");
// Use a fresh context (already from launchTab) so no localStorage carryover.
await liveTab.page.goto(`${BASE_UI}/`, {
waitUntil: "domcontentloaded",
timeout: 30000,
});
await liveTab.page.waitForTimeout(400);
const liveShot = resolve(SHOT_DIR, "03-live-mode.png");
await liveTab.page.screenshot({ path: liveShot, fullPage: false });
const liveMode = await liveTab.page
.locator("header[data-mode]")
.first()
.getAttribute("data-mode")
.catch(() => null);
const liveLabel = await liveTab.page
.locator('button[aria-label*="Trigger"]')
.first()
.textContent()
.catch(() => null);
log(`live: data-mode=${liveMode} button="${liveLabel?.trim() ?? null}"`);
await liveTab.page.waitForTimeout(200);
const liveHydrationHits = liveTab.messages.filter((m) =>
isHydrationWarning(m.text),
);
await browser.close();
// βββ Build report βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const postMountOk =
postMountMode === "mock" &&
typeof postMountLabel === "string" &&
postMountLabel.toLowerCase().includes("trigger mock demo");
const liveOk =
liveMode === "live" &&
typeof liveLabel === "string" &&
liveLabel.toLowerCase().includes("trigger live demo");
const noHydrationWarnings =
mockHydrationHits.length === 0 && liveHydrationHits.length === 0;
const allPass = ssrShellOk && postMountOk && liveOk && noHydrationWarnings;
const lines = [
`W7-E hydration-mismatch fix β verify run @ ${new Date().toISOString()}`,
``,
`Scenario 1a: SSR shell (raw fetch /?mode=mock)`,
` data-mode=${ssrMode} hasLiveLabel=${ssrHasLiveLabel} hasMockLabel=${ssrHasMockLabel} ${ssrShellOk ? "PASS (server emits safe live shell)" : "FAIL (expected live shell)"}`,
``,
`Scenario 1b: client load /?mode=mock`,
` at-DCL data-mode=${preMountMode} button="${preMountLabel?.trim() ?? null}"`,
` post-mount data-mode=${postMountMode} button="${postMountLabel?.trim() ?? null}" ${postMountOk ? "PASS (switched to mock)" : "FAIL (expected mock)"}`,
` hydration warnings: ${mockHydrationHits.length} ${mockHydrationHits.length === 0 ? "PASS" : "FAIL"}`,
...mockHydrationHits.map((m) => ` - [${m.type}] ${m.text}`),
``,
`Scenario 2: clean live load /`,
` data-mode=${liveMode} button="${liveLabel?.trim() ?? null}" ${liveOk ? "PASS" : "FAIL"}`,
` hydration warnings: ${liveHydrationHits.length} ${liveHydrationHits.length === 0 ? "PASS" : "FAIL"}`,
...liveHydrationHits.map((m) => ` - [${m.type}] ${m.text}`),
``,
`Screenshots:`,
` ${preMountShot}`,
` ${postMountShot}`,
` ${liveShot}`,
``,
`OVERALL: ${allPass ? "PASS" : "FAIL"}`,
];
const report = lines.join("\n");
writeFileSync(REPORT, report + "\n");
log("\n" + report);
log(`wrote ${REPORT}`);
process.exit(allPass ? 0 : 1);
|