blueprints/scripts/screenshot-blueprints.ts
Adam Zieliński 17bf21e1ab
Fix screenshot CI to only process missing shots (#161)
- Screenshot automation now skips Blueprints that already have a
screenshot (e.g. `blueprints/<slug>/screenshot.jpg`, or a
`meta.screenshot` URL).
- Removes the obsolete `inject` script from `package.json` and drops the
`npm run inject` step from the screenshots workflow.

This prevents the screenshots job from reprocessing every Blueprint on
each run and fixes the broken CI reference to a deleted script.
2025-12-19 00:45:30 +01:00

236 lines
7.5 KiB
TypeScript

// scripts/screenshot-blueprints.ts
import { chromium, devices } from 'playwright';
import { promises as fs } from 'node:fs';
import path from 'node:path';
const REPO = 'WordPress/blueprints';
const BRANCH = 'trunk';
const ROOT = path.resolve(process.cwd());
const BLUEPRINTS_DIR = path.join(ROOT, 'blueprints');
type BlueprintJson = {
meta?: {
title?: string;
screenshot?: string; // may be relative path, repo-absolute, or raw.githubusercontent URL
};
};
async function ensureDir(p: string) {
await fs.mkdir(p, { recursive: true });
}
async function listBlueprintSlugs(): Promise<string[]> {
const entries = await fs.readdir(BLUEPRINTS_DIR, { withFileTypes: true });
const dirs = entries.filter((e) => e.isDirectory());
const slugs: string[] = [];
for (const d of dirs) {
const bpPath = path.join(BLUEPRINTS_DIR, d.name, 'blueprint.json');
try {
await fs.access(bpPath);
slugs.push(d.name);
} catch {}
}
return slugs.sort();
}
async function readBlueprint(slug: string): Promise<BlueprintJson | null> {
try {
const txt = await fs.readFile(
path.join(BLUEPRINTS_DIR, slug, 'blueprint.json'),
'utf8'
);
return JSON.parse(txt) as BlueprintJson;
} catch {
return null;
}
}
function rawBlueprintUrl(slug: string) {
return `https://raw.githubusercontent.com/${REPO}/${BRANCH}/blueprints/${slug}/blueprint.json`;
}
function resolveScreenshotLocalPath(screenshot: string, slug: string): string | null {
// Case 1: http(s) raw link to *this* repo -> map to local file
const m = screenshot.match(
/^https?:\/\/raw\.githubusercontent\.com\/WordPress\/blueprints\/([^/]+)\/(.+)$/i
);
if (m) {
// m[1] = branch (we ignore and use local checkout), m[2] = repo path
return path.resolve(ROOT, m[2]);
}
// Case 2: repo-absolute path like "/docs/foo.png"
if (screenshot.startsWith('/')) {
return path.resolve(ROOT, screenshot.slice(1));
}
// Case 3: relative to blueprint folder
if (!/^[a-z]+:\/\//i.test(screenshot)) {
return path.resolve(ROOT, 'blueprints', slug, screenshot);
}
// External URL → not a repo file; can't resolve to a local path.
return null;
}
async function fileExists(p: string | null): Promise<boolean> {
if (!p) return false;
try {
const st = await fs.stat(p);
return st.isFile();
} catch {
return false;
}
}
async function hasScreenshot(slug: string): Promise<boolean> {
// Default gallery behavior: if meta.screenshot isn't set, it expects `screenshot.jpg`
// next to `blueprint.json`.
const defaultScreenshot = path.join(BLUEPRINTS_DIR, slug, 'screenshot.jpg');
if (await fileExists(defaultScreenshot)) return true;
const bp = await readBlueprint(slug);
const scr = bp?.meta?.screenshot;
if (!scr || typeof scr !== 'string') return false;
// Any URL counts as "has a screenshot" (even if it's not stored in-repo).
if (/^[a-z]+:\/\//i.test(scr)) {
const local = resolveScreenshotLocalPath(scr, slug);
return local ? fileExists(local) : true;
}
const local = resolveScreenshotLocalPath(scr, slug);
return fileExists(local);
}
async function readTitle(slug: string) {
const bp = await readBlueprint(slug);
return bp?.meta?.title ?? slug;
}
async function main() {
const slugs = await listBlueprintSlugs();
// Filter: only those without any screenshot yet
const toShoot: string[] = [];
for (const slug of slugs) {
if (!(await hasScreenshot(slug))) {
toShoot.push(slug);
}
}
if (toShoot.length === 0) {
console.log('All Blueprints already have screenshots. Nothing to do.');
return;
}
const browser = await chromium.launch({ headless: true });
const context = await browser.newContext({
...devices['Desktop Chrome'],
deviceScaleFactor: 1,
viewport: { width: 1920, height: 1080 },
});
for (const slug of toShoot) {
const page = await context.newPage();
const url = `https://playground.wordpress.net/?mode=seamless&blueprint-url=${encodeURIComponent(
rawBlueprintUrl(slug)
)}`;
// Wait for full load, not just domcontentloaded
await page.goto(url, { waitUntil: 'load', timeout: 180_000 });
await page.emulateMedia({ reducedMotion: 'reduce' });
// Wait for the top-level Playground iframe
const playgroundFrame = page.locator('iframe.playground-viewport');
await playgroundFrame.waitFor({ state: 'visible', timeout: 120_000 });
// Get the frame content
const frameElement = await playgroundFrame.elementHandle();
const frame = await frameElement?.contentFrame();
if (!frame) {
console.error(`Failed to get frame content for ${slug}`);
await page.close();
continue;
}
// Wait for the progress bar to NOT exist (not just be hidden) - 5 minute timeout
const progressBar = frame.locator('.progress-bar');
try {
await progressBar.waitFor({ state: 'detached', timeout: 300_000 });
console.log(`Progress bar disappeared for ${slug}`);
} catch (e) {
console.log(`Progress bar wait timed out for ${slug}, continuing anyway`);
}
// Wait for the WordPress iframe inside
const wpFrame = frame.locator('iframe#wp');
await wpFrame.waitFor({ state: 'visible', timeout: 120_000 });
// Get the WordPress iframe's content frame
const wpFrameElement = await wpFrame.elementHandle();
const wpContentFrame = await wpFrameElement?.contentFrame();
if (!wpContentFrame) {
console.error(`Failed to get WordPress frame content for ${slug}`);
await page.close();
continue;
}
// Wait for WordPress content to be loaded by checking for WordPress-specific indicators
// Check for canonical link, wp-content in scripts/styles, or give it time to load
try {
await wpContentFrame.waitForFunction(
() => {
// Check for canonical URL
const canonical = document.querySelector('link[rel="canonical"]');
if (canonical) return true;
// Check for wp-content in any script or link tags
const scripts = Array.from(document.querySelectorAll('script[src], link[href]'));
const hasWpContent = scripts.some(el => {
const src = (el as HTMLScriptElement).src || (el as HTMLLinkElement).href;
return src && src.includes('/wp-content/');
});
if (hasWpContent) return true;
// Check if body has meaningful content
const body = document.body;
return body && body.children.length > 0;
},
{ timeout: 60_000 }
);
console.log(`WordPress content detected for ${slug}`);
} catch (e) {
console.log(`WordPress content detection timed out for ${slug}, taking screenshot anyway`);
}
// Additional wait to ensure visual rendering is complete
await page.waitForTimeout(2000);
// Set zoom to 150% on the WordPress content frame
try {
await wpContentFrame.evaluate(() => {
(document.body.style as any).zoom = '150%';
});
// Wait a bit for zoom to apply
await page.waitForTimeout(500);
} catch (e) {
console.log(`Failed to set zoom for ${slug}, continuing anyway`);
}
// Screenshot the WordPress iframe
const blueprintDir = path.join(BLUEPRINTS_DIR, slug);
const out = path.join(blueprintDir, 'screenshot.jpg');
await wpFrame.screenshot({ path: out, type: 'jpeg', quality: 70 });
console.log(`Shot: ${slug} -> ${path.relative(ROOT, out)}`);
await page.close();
}
await browser.close();
}
main().catch((e) => {
console.error(e);
process.exit(1);
});