Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

refactor(ok): load html previews from a bundled frame page (#6533)

Dimitri POSTOLOVb4b27b18e1d3
diff --git a/packages/app/public/assets/preview-frame.html b/packages/app/public/assets/preview-frame.html
new file mode 100644
index 000000000..721b67901
--- /dev/null
+++ b/packages/app/public/assets/preview-frame.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8" />
+</head>
+<body>
+ <script>addEventListener('message', (e) => { if (e.source !== parent) return; if (location.protocol !== 'file:' && e.origin !== location.origin) return; const html = e.data?.okPreviewDocument; if (typeof html !== 'string') return; document.open(); document.write(`<!doctype html>${html}`); document.close(); });</script>
+</body>
+</html>
diff --git a/packages/app/src/editor/clipboard/codeblock-preview-clipboard.test.ts b/packages/app/src/editor/clipboard/codeblock-preview-clipboard.test.ts
index 74987dbeb..379f74a61 100644
--- a/packages/app/src/editor/clipboard/codeblock-preview-clipboard.test.ts
+++ b/packages/app/src/editor/clipboard/codeblock-preview-clipboard.test.ts
@@ -2,7 +2,7 @@ import { getSchema } from '@tiptap/core';
import type { Node as PmNode } from '@tiptap/pm/model';
import { JSDOM } from 'jsdom';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
-import { buildPreviewIframeHeader } from '../extensions/preview-iframe-header.ts';
+import { PREVIEW_FRAME_URL } from '../extensions/preview-iframe-header.ts';
import { sharedExtensions } from '../extensions/shared.ts';
import { OPT_OUT_ATTR } from './clipboard-sanitize.ts';
import { type WalkerEnv, walkLiveDomToInlineStyledFragment } from './clipboard-walker.ts';
@@ -72,7 +72,7 @@ function buildCodeBlockPreviewDom(): HTMLElement {
iframe.setAttribute('title', 'HTML preview');
iframe.setAttribute('sandbox', 'allow-scripts');
iframe.setAttribute('referrerpolicy', 'no-referrer');
- iframe.setAttribute('srcdoc', buildPreviewIframeHeader('light') + CODE);
+ iframe.setAttribute('src', PREVIEW_FRAME_URL);
iframe.className = 'ok-codeblock-preview-frame';
preview.appendChild(iframe);
@@ -148,11 +148,10 @@ function emitFragmentHtml(): { holder: HTMLElement; html: string } {
}
describe('preview-active codeBlock clipboard emission (text/html tier)', () => {
- test('emits no iframe / srcdoc render-header into the payload', () => {
+ test('emits no iframe or preview frame page URL into the payload', () => {
const { holder, html } = emitFragmentHtml();
expect(holder.querySelector('iframe')).toBeNull();
- expect(html).not.toContain('srcdoc');
- expect(html).not.toContain('Content-Security-Policy');
+ expect(html).not.toContain('preview-frame');
});
test('emits no preview render chrome (resize handles) into the payload', () => {
@@ -194,9 +193,9 @@ describe('preview-active codeBlock clipboard emission — Activity-hidden (unmou
expect(pre?.textContent ?? '').toContain('html preview');
});
- test('emits no iframe / srcdoc render internals via the palette path', () => {
+ test('emits no iframe or preview frame page URL via the palette path', () => {
const { holder, html } = emitFromUnmounted();
expect(holder.querySelector('iframe')).toBeNull();
- expect(html).not.toContain('srcdoc');
+ expect(html).not.toContain('preview-frame');
});
});
diff --git a/packages/app/src/editor/extensions/CodeBlockView.dom.test.tsx b/packages/app/src/editor/extensions/CodeBlockView.dom.test.tsx
index 788b16800..cb0da5ad5 100644
--- a/packages/app/src/editor/extensions/CodeBlockView.dom.test.tsx
+++ b/packages/app/src/editor/extensions/CodeBlockView.dom.test.tsx
@@ -1,7 +1,7 @@
import type { Config } from '@inkeep/open-knowledge-core';
import { act, cleanup, fireEvent, render, waitFor } from '@testing-library/react';
import type { NodeViewProps } from '@tiptap/core';
-import { afterEach, describe, expect, test } from 'vitest';
+import { afterEach, describe, expect, test, vi } from 'vitest';
import { subscribeStartComment } from '@/comments/store';
import { ConfigContext, type ConfigContextValue } from '@/lib/config-context';
import { CodeBlockView } from './CodeBlockView';
@@ -49,15 +49,21 @@ function makeProps(): NodeViewProps {
} as unknown as NodeViewProps;
}
-function renderSrcdoc(): string {
+function renderPostedPreviewDocument(): string {
const { container } = render(
<ConfigContext value={makeConfigValue(null)}>
<CodeBlockView {...makeProps()} />
</ConfigContext>,
);
const iframe = container.querySelector('iframe');
- expect(iframe).toBeTruthy();
- return iframe?.getAttribute('srcdoc') ?? '';
+ if (!iframe?.contentWindow) throw new Error('Expected a rendered preview iframe');
+ expect(iframe.getAttribute('src')).toMatch(/assets\/preview-frame\.html$/);
+ expect(iframe.hasAttribute('srcdoc')).toBe(false);
+ const postMessage = vi.spyOn(iframe.contentWindow, 'postMessage');
+ fireEvent.load(iframe);
+ const posted = postMessage.mock.calls[0]?.[0] as { okPreviewDocument?: unknown } | undefined;
+ expect(typeof posted?.okPreviewDocument).toBe('string');
+ return posted?.okPreviewDocument as string;
}
describe('CodeBlockView preview-CSP wiring', () => {
@@ -65,14 +71,14 @@ describe('CodeBlockView preview-CSP wiring', () => {
cleanup();
});
- test('renders the fixed open-network CSP in the iframe srcdoc', () => {
- const srcdoc = renderSrcdoc();
- expect(srcdoc).toContain("script-src 'unsafe-inline' https:");
- expect(srcdoc).toContain('connect-src https:');
- expect(srcdoc).toContain('img-src https:');
- expect(srcdoc).not.toContain("connect-src 'none'");
- expect(srcdoc).not.toContain("'unsafe-eval'");
- expect(srcdoc).toContain('<div id="probe">hello</div>');
+ test('posts the fixed open-network CSP and the block content to the preview frame page', () => {
+ const previewDocument = renderPostedPreviewDocument();
+ expect(previewDocument).toContain("script-src 'unsafe-inline' https:");
+ expect(previewDocument).toContain('connect-src https:');
+ expect(previewDocument).toContain('img-src https:');
+ expect(previewDocument).not.toContain("connect-src 'none'");
+ expect(previewDocument).not.toContain("'unsafe-eval'");
+ expect(previewDocument).toContain('<div id="probe">hello</div>');
});
});
diff --git a/packages/app/src/editor/extensions/CodeBlockView.tsx b/packages/app/src/editor/extensions/CodeBlockView.tsx
index 292625f36..70bfb213d 100644
--- a/packages/app/src/editor/extensions/CodeBlockView.tsx
+++ b/packages/app/src/editor/extensions/CodeBlockView.tsx
@@ -50,6 +50,7 @@ import {
setMetaTitle,
shouldShowPreview,
} from './code-block-meta';
+import { PreviewFrame } from './PreviewFrame';
import {
buildPreviewIframeHeader,
buildPreviewThemeMessage,
@@ -267,12 +268,10 @@ export function CodeBlockView({ node, updateAttributes, editor, getPos, selected
}}
onMouseDown={(e) => e.stopPropagation()}
>
- <iframe
+ <PreviewFrame
title={t`HTML preview`}
- ref={previewFrameRef}
- sandbox="allow-scripts"
- referrerPolicy="no-referrer"
- srcDoc={buildPreviewIframeHeader(bakedTheme) + node.textContent}
+ frameRef={previewFrameRef}
+ html={buildPreviewIframeHeader(bakedTheme) + node.textContent}
className="ok-codeblock-preview-frame"
onLoad={() => {
setBlockedRequests(null);
@@ -524,11 +523,10 @@ export function CodeBlockView({ node, updateAttributes, editor, getPos, selected
language={normalized === 'xml' ? 'html' : 'plain'}
title={t`Edit source`}
renderPreview={(value) => (
- <iframe
+ <PreviewFrame
title={t`HTML preview`}
- sandbox="allow-scripts"
className="size-full border-0"
- srcDoc={buildPreviewIframeHeader(bakedTheme) + value}
+ html={buildPreviewIframeHeader(bakedTheme) + value}
/>
)}
onSave={handleEditSave}
diff --git a/packages/app/src/editor/extensions/PreviewFrame.tsx b/packages/app/src/editor/extensions/PreviewFrame.tsx
new file mode 100644
index 000000000..23e47679d
--- /dev/null
+++ b/packages/app/src/editor/extensions/PreviewFrame.tsx
@@ -0,0 +1,28 @@
+import type { RefObject } from 'react';
+import { buildPreviewDocumentMessage, PREVIEW_FRAME_URL } from './preview-iframe-header';
+
+interface PreviewFrameProps {
+ html: string;
+ title: string;
+ className?: string;
+ frameRef?: RefObject<HTMLIFrameElement | null>;
+ onLoad?: () => void;
+}
+
+export function PreviewFrame({ html, title, className, frameRef, onLoad }: PreviewFrameProps) {
+ return (
+ <iframe
+ key={html}
+ ref={frameRef}
+ title={title}
+ src={PREVIEW_FRAME_URL}
+ sandbox="allow-scripts"
+ referrerPolicy="no-referrer"
+ className={className}
+ onLoad={(event) => {
+ event.currentTarget.contentWindow?.postMessage(buildPreviewDocumentMessage(html), '*');
+ onLoad?.();
+ }}
+ />
+ );
+}
diff --git a/packages/app/src/editor/extensions/preview-iframe-header.ts b/packages/app/src/editor/extensions/preview-iframe-header.ts
index 019e77a05..b66167f57 100644
--- a/packages/app/src/editor/extensions/preview-iframe-header.ts
+++ b/packages/app/src/editor/extensions/preview-iframe-header.ts
@@ -27,6 +27,18 @@ export function buildPreviewThemeMessage(
: { [PREVIEW_THEME_MESSAGE_KEY]: theme };
}
+const PREVIEW_DOCUMENT_MESSAGE_KEY = 'okPreviewDocument';
+
+export interface PreviewDocumentMessage {
+ [PREVIEW_DOCUMENT_MESSAGE_KEY]: string;
+}
+
+export const PREVIEW_FRAME_URL = `${import.meta.env.BASE_URL}assets/preview-frame.html`;
+
+export function buildPreviewDocumentMessage(html: string): PreviewDocumentMessage {
+ return { [PREVIEW_DOCUMENT_MESSAGE_KEY]: html };
+}
+
const PREVIEW_HEIGHT_MESSAGE_KEY = 'okPreviewHeight';
export function parsePreviewHeightMessage(data: unknown): number | null {
diff --git a/packages/app/src/server/asset-routing.ts b/packages/app/src/server/asset-routing.ts
index c9b2038c1..6a6fade5b 100644
--- a/packages/app/src/server/asset-routing.ts
+++ b/packages/app/src/server/asset-routing.ts
@@ -18,6 +18,7 @@ function servedByViteDevServer(url: string): boolean {
path.startsWith('/node_modules/') ||
path.startsWith('/src/') ||
path === '/favicon.svg' ||
+ path === '/assets/preview-frame.html' ||
params?.has('import') === true ||
params?.has('html-proxy') === true
);
diff --git a/packages/app/tests/stress/html-preview-frame.e2e.ts b/packages/app/tests/stress/html-preview-frame.e2e.ts
new file mode 100644
index 000000000..bff652cae
--- /dev/null
+++ b/packages/app/tests/stress/html-preview-frame.e2e.ts
@@ -0,0 +1,111 @@
+import { randomUUID } from 'node:crypto';
+import { mkdirSync, rmSync, writeFileSync } from 'node:fs';
+import { createServer } from 'node:http';
+import type { AddressInfo } from 'node:net';
+import { join } from 'node:path';
+import { expect, test, waitForActiveProviderSynced } from './_helpers';
+
+type MessageCounter = Window & { messagesSeen?: number };
+
+function previewMarkdown(probeText: string): string {
+ return [
+ '# Preview',
+ '',
+ '```html preview',
+ '<div id="probe" style="height: 300px">before</div>',
+ '<img src="http://example.invalid/blocked.png" alt="">',
+ `<script>document.getElementById('probe').textContent = '${probeText}';</script>`,
+ '```',
+ '',
+ ].join('\n');
+}
+
+test('html preview code blocks run scripts, size the frame, report blocked requests and show edits', async ({
+ page,
+ api,
+}) => {
+ const docName = `html-preview-${randomUUID().slice(0, 8)}`;
+ await api.seedDocs([{ name: docName, markdown: previewMarkdown('ran') }]);
+
+ await page.goto(`/#/${docName}`);
+ await waitForActiveProviderSynced(page);
+
+ const frame = page.frameLocator('iframe[title="HTML preview"]');
+ await expect(frame.locator('#probe')).toHaveText('ran');
+
+ const preview = page.locator('.ok-codeblock-preview');
+ const previewHeight = async () => (await preview.boundingBox())?.height ?? 0;
+ await expect.poll(previewHeight, { timeout: 10_000 }).toBeGreaterThan(290);
+ await expect.poll(previewHeight, { timeout: 10_000 }).toBeLessThan(400);
+
+ await expect(
+ page.getByRole('status').filter({ hasText: 'http://example.invalid/blocked.png' }),
+ ).toBeVisible();
+
+ await api.replaceDoc(docName, previewMarkdown('edited'));
+ await expect(frame.locator('#probe')).toHaveText('edited');
+});
+
+test('a content file at the frame page path does not replace the bundled frame page', async ({
+ page,
+ api,
+ workerServer,
+}) => {
+ const docName = `html-preview-shadow-${randomUUID().slice(0, 8)}`;
+ await api.seedDocs([{ name: docName, markdown: previewMarkdown('ran') }]);
+ const contentAssets = join(workerServer.contentDir, 'assets');
+ mkdirSync(contentAssets, { recursive: true });
+ writeFileSync(join(contentAssets, 'preview-frame.html'), '<!doctype html><p>content file</p>');
+ try {
+ await page.goto(`/#/${docName}`);
+ await waitForActiveProviderSynced(page);
+ await expect(page.frameLocator('iframe[title="HTML preview"]').locator('#probe')).toHaveText(
+ 'ran',
+ );
+ } finally {
+ rmSync(contentAssets, { recursive: true, force: true });
+ }
+});
+
+test('the preview frame page ignores documents posted by a parent on another origin', async ({
+ page,
+ baseURL,
+}) => {
+ const framePage = `${baseURL}/assets/preview-frame.html`;
+ const otherOrigin = createServer((_request, response) => {
+ response.writeHead(200, { 'content-type': 'text/html' });
+ response.end(`<!doctype html><iframe id="frame" src="${framePage}"></iframe>`);
+ });
+ const listening = Promise.withResolvers<void>();
+ otherOrigin.listen(0, '127.0.0.1', listening.resolve);
+ await listening.promise;
+ try {
+ const { port } = otherOrigin.address() as AddressInfo;
+ await page.goto(`http://127.0.0.1:${port}/`);
+ const frame = page.frameLocator('#frame');
+ await expect(frame.locator('script')).toHaveCount(1);
+ const child = page.frames().find((candidate) => candidate.url() === framePage);
+ if (!child) throw new Error('Expected the preview frame page to load');
+ await child.evaluate(() => {
+ addEventListener('message', () => {
+ const counter = window as MessageCounter;
+ counter.messagesSeen = (counter.messagesSeen ?? 0) + 1;
+ });
+ });
+
+ await page.evaluate(() => {
+ document
+ .querySelector('iframe')
+ ?.contentWindow?.postMessage({ okPreviewDocument: '<p id="written">written</p>' }, '*');
+ });
+
+ await expect
+ .poll(() => child.evaluate(() => (window as MessageCounter).messagesSeen ?? 0))
+ .toBe(1);
+ await expect(frame.locator('#written')).toHaveCount(0);
+ } finally {
+ const closed = Promise.withResolvers<void>();
+ otherOrigin.close(() => closed.resolve());
+ await closed.promise;
+ }
+});