Skip to content

Complete editor presentation capture from expected identities #2428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chubes4 merged 1 commit into from
Aug 30, 2026
Merged

Complete editor presentation capture from expected identities #2428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions packages/runtime-playground/src/editor-command-runners.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,9 +648,9 @@ export async function runEditorOpenCommand({

if (editorReadiness) {
await dismissWordPressOnboardingDialogs(page)
editorPresentation = await captureEditorPresentation(page, waitTimeoutMs)
const expected = await captureExpectedEditorPresentationIdentities(target, runPlaygroundCommand, runtimeSpec, server)
editorPresentation = await captureEditorPresentation(page, waitTimeoutMs, expected?.complete ? expected.identities : [])
if (editorPresentation) {
const expected = await captureExpectedEditorPresentationIdentities(target, runPlaygroundCommand, runtimeSpec, server)
await dismissWordPressOnboardingDialogs(page)
const idleCanvas = await captureEditorIdleCanvas(page)
editorPresentation = {
Expand Down Expand Up @@ -861,7 +861,7 @@ export function summarizeEditorPresentation(capture: EditorPresentationCapture):
}
}

export async function captureEditorPresentation(page: import("playwright").Page, timeoutMs: number): Promise<BrowserEditorPresentationSummary | undefined> {
export async function captureEditorPresentation(page: import("playwright").Page, timeoutMs: number, expectedIdentities: string[] = []): Promise<BrowserEditorPresentationSummary | undefined> {
const startedAtMs = Date.now()
const deadlineMs = startedAtMs + Math.min(timeoutMs, EDITOR_PRESENTATION_MAX_CAPTURE_MS)
let previousFingerprint: string | undefined
Expand Down Expand Up @@ -902,21 +902,25 @@ export async function captureEditorPresentation(page: import("playwright").Page,
const summary = summarizeEditorPresentation(capture)
const fingerprint = `${capture.documentIdentity}\n${JSON.stringify(summary)}`
const observedAtMs = Date.now()
if (fingerprint === previousFingerprint) {
const expectedIdentitiesObserved = expectedIdentities.length > 0
&& expectedIdentities.every((identity) => summary.generatedPresentationIdentities.includes(identity))
const summarySettled = fingerprint === previousFingerprint
&& stableSinceMs !== undefined
&& observedAtMs - stableSinceMs >= EDITOR_PRESENTATION_SETTLE_MS
if ((expectedIdentitiesObserved || summarySettled)
&& capture.documentAgeMs >= EDITOR_PRESENTATION_MIN_OBSERVATION_MS) {
const currentDocumentIdentity = capture.canvasDocumentType === "iframe"
? await resolveEditorCanvasFrame(page, EDITOR_CANVAS_DEFAULT_IFRAME_SELECTOR)
.then(async (currentFrame) => currentFrame && currentFrame === frame ? await currentFrame.evaluate(() => `${location.href}\n${performance.timeOrigin}`) : undefined)
.catch(() => undefined)
: await resolveEditorCanvasFrame(page, EDITOR_CANVAS_DEFAULT_IFRAME_SELECTOR)
.then(async (currentFrame) => currentFrame ? undefined : await page.evaluate(() => `${location.href}\n${performance.timeOrigin}`))
.catch(() => undefined)
if (stableSinceMs !== undefined
&& observedAtMs - stableSinceMs >= EDITOR_PRESENTATION_SETTLE_MS
&& capture.documentAgeMs >= EDITOR_PRESENTATION_MIN_OBSERVATION_MS
&& currentDocumentIdentity === capture.documentIdentity) {
if (currentDocumentIdentity === capture.documentIdentity) {
return summary
}
} else {
}
if (fingerprint !== previousFingerprint) {
previousFingerprint = fingerprint
stableSinceMs = observedAtMs
}
Expand Down
27 changes: 25 additions & 2 deletions tests/browser-routed-command-security.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ const DELAYED_CANVAS_PRESENTATION_IDENTITY = "e".repeat(64)
const PARENT_CANVAS_PRESENTATION_IDENTITY = "f".repeat(64)
const SLOW_PRESENTATION_IDENTITY = "1".repeat(64)
const PENDING_STYLES_PRESENTATION_IDENTITY = "2".repeat(64)
const GROWING_PRESENTATION_IDENTITIES = ["3".repeat(64), "4".repeat(64)]
const matchedPresentationMarkup = `<style>html,body{margin:0}.block-editor-block-list__layout{box-sizing:border-box;width:200px;height:400px;background:linear-gradient(#123,#abc);color:white;padding:12px}</style><div class="block-editor-block-list__layout">Matched presentation</div>`
const editorShell = `<!doctype html><script>
globalThis.__name = (value) => value
Expand All @@ -48,11 +49,14 @@ const replacingCanvasEditorHtml = `${editorShell}<iframe name="editor-canvas" sr
const delayedCanvasEditorHtml = `${editorShell}<div class="block-editor-block-list__layout"><div class="block-editor-block-list__block" data-block="transition">Transition</div></div><script>setTimeout(() => { const iframe = document.createElement('iframe'); iframe.name = 'editor-canvas'; iframe.srcdoc = '<style>/* blocks-engine-presentation:${DELAYED_CANVAS_PRESENTATION_IDENTITY} */<\\/style>'; document.body.append(iframe) }, 300)</script>`
const slowPresentationEditorHtml = `${editorShell}<iframe name="editor-canvas" srcdoc="<script>setTimeout(() => { const style = document.createElement('style'); style.textContent = '/* blocks-engine-presentation:${SLOW_PRESENTATION_IDENTITY} */'; document.head.append(style) }, 3500)<\/script><div class='block-editor-block-list__layout'><div class='block-editor-block-list__block' data-block='slow'>Slow</div></div>"></iframe>`
const pendingStylesEditorHtml = `${editorShell}<iframe name="editor-canvas" srcdoc="<link rel='stylesheet' href='http://127.0.0.1:9/unavailable.css'><style>/* blocks-engine-presentation:${PENDING_STYLES_PRESENTATION_IDENTITY} */<\/style><div class='block-editor-block-list__layout'><div class='block-editor-block-list__block' data-block='pending'>Pending</div></div>"></iframe>`
const growingPresentationEditorHtml = `${editorShell}<iframe name="editor-canvas" srcdoc="<style>/* blocks-engine-presentation:${GROWING_PRESENTATION_IDENTITIES[0]} */<\/style><script>let identity = 0; setInterval(() => { const style = document.createElement('style'); style.textContent = '/* blocks-engine-presentation:' + (identity++).toString(16).padStart(64, '9') + ' */'; document.head.append(style) }, 100); setTimeout(() => { const style = document.createElement('style'); style.textContent = '/* blocks-engine-presentation:${GROWING_PRESENTATION_IDENTITIES[1]} */'; document.head.append(style) }, 4100)<\/script><div class='block-editor-block-list__layout'><div class='block-editor-block-list__block' data-block='growing'>Growing</div></div>"></iframe>`

test("real browser commands sanitize console, artifacts, stdout, and failure stderr", async () => {
const httpServer = createServer((request, response) => {
response.setHeader("content-type", "text/html")
response.end(request.url?.startsWith("/broken")
response.end(request.url?.startsWith("/wp-admin/post.php")
? growingPresentationEditorHtml
: request.url?.startsWith("/broken")
? "<main>Broken editor fixture</main>"
: request.url?.startsWith("/presentation")
? "<main>Deliberately different frontend fixture</main>"
Expand Down Expand Up @@ -88,7 +92,12 @@ test("real browser commands sanitize console, artifacts, stdout, and failure std
},
},
} as RuntimeCreateSpec
const runPlaygroundCommand = async () => ({ text: "[]", exitCode: 0 })
const runPlaygroundCommand = async (command: string) => ({
text: command === "wordpress.editor-open.capture-presentation-contract"
? JSON.stringify({ identities: GROWING_PRESENTATION_IDENTITIES, complete: true })
: "[]",
exitCode: 0,
})

try {
await withTempDir("wp-codebox-real-browser-actions-security-", async (artifactRoot) => {
Expand Down Expand Up @@ -239,6 +248,20 @@ test("real browser commands sanitize console, artifacts, stdout, and failure std
assert.deepEqual(output.summary.editorPresentation.generatedPresentationIdentities, [PENDING_STYLES_PRESENTATION_IDENTITY])
})

await withTempDir("wp-codebox-real-editor-growing-presentation-security-", async (artifactRoot) => {
const result = await runEditorOpenCommand({
artifactRoot,
runPlaygroundCommand,
runtimeSpec,
server,
spec: { command: "wordpress.editor-open", args: ["post-id=1", "capture=steps", "wait-timeout=5s"] },
})
const output = JSON.parse(result.output) as { summary: { editorPresentation: { generatedPresentationIdentities: string[]; expectedGeneratedPresentationIdentities: string[]; expectedGeneratedPresentationIdentitiesComplete: boolean } } }
assert.deepEqual(output.summary.editorPresentation.expectedGeneratedPresentationIdentities, GROWING_PRESENTATION_IDENTITIES)
assert.equal(output.summary.editorPresentation.expectedGeneratedPresentationIdentitiesComplete, true)
assert.equal(GROWING_PRESENTATION_IDENTITIES.every((identity) => output.summary.editorPresentation.generatedPresentationIdentities.includes(identity)), true)
})

await withTempDir("wp-codebox-real-editor-canvas-security-", async (artifactRoot) => {
const result = await runEditorCanvasProbeCommand({
artifactRoot,
Expand Down
Loading