open-design/apps/web/tests/components/FileViewer.manual-edit-history.test.tsx
chaoxiaoche 831208b823
Refine Studio preview interactions (#3000)
* Refine studio preview interactions

* Fix deck toolbar navigation for transform tracks

* Fix manual edit preview close

* Fix Simple Deck toolbar scrolling

* Fix preview screenshot capture

* Fix deck preview progress sync

* Refine edit target selection for grouped elements (#3068)

* Prefer child edit targets over grouped parents

* Keep edit inspector header and footer fixed

* Shorten floating edit inspector

* Show readable edit target names

* Allow dragging the floating edit inspector

* Add explicit edit inspector actions

* Show preview comment count in toolbar

* Separate annotation and comment toolbar groups

* Remove annotation toolbar divider

* Close edit inspector from footer actions

* Hide edit inspector until target hover

---------

Co-authored-by: chaoxiaoche <chaoxiaoche@chaoxiaochedeMacBook-Pro.local>

* Fix manual edit iframe regression test

* Fix Studio interaction review feedback

Generated-By: looper 0.9.2 (runner=fixer, agent=codex)

* Fix saved comment link classification

Generated-By: looper 0.9.2 (runner=fixer, agent=codex)

---------

Co-authored-by: chaoxiaoche <chaoxiaoche@chaoxiaochedeMacBook-Pro.local>
Co-authored-by: Siri-Ray <2667192167@qq.com>
2026-05-28 12:52:37 +00:00

373 lines
14 KiB
TypeScript

// @vitest-environment jsdom
import { act, cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';
import type { ComponentProps } from 'react';
import { emptyManualEditStyles, type ManualEditTarget } from '../../src/edit-mode/types';
import type { ProjectFile } from '../../src/types';
const panelState = vi.hoisted(() => ({
props: null as ComponentProps<typeof import('../../src/components/ManualEditPanel').ManualEditPanel> | null,
}));
vi.mock('../../src/components/ManualEditPanel', async (importOriginal) => {
const actual = await importOriginal<typeof import('../../src/components/ManualEditPanel')>();
return {
...actual,
ManualEditPanel: (props: ComponentProps<typeof actual.ManualEditPanel>) => {
panelState.props = props;
return <div data-testid="mock-manual-edit-panel" />;
},
};
});
import { FileViewer } from '../../src/components/FileViewer';
function openManualTools() {
// Manual tools now live directly in the primary toolbar.
}
function clickManualTool(testId: string) {
openManualTools();
fireEvent.click(screen.getByTestId(testId));
}
function clickAgentTool(testId: string) {
fireEvent.click(screen.getByTestId(testId));
}
async function hoverManualEditTarget(target = heroTarget()) {
const frame = await waitFor(() => {
const node = screen.getByTestId('artifact-preview-frame') as HTMLIFrameElement;
if (!node.contentWindow) throw new Error('Preview frame not ready');
return node;
});
act(() => {
window.dispatchEvent(new MessageEvent('message', {
data: { type: 'od-edit-hover', target },
source: frame.contentWindow,
}));
});
await waitFor(() => expect(panelState.props).not.toBeNull());
}
afterEach(() => {
cleanup();
panelState.props = null;
vi.restoreAllMocks();
vi.unstubAllGlobals();
});
describe('FileViewer manual edit history regressions', () => {
it('flushes pending style edits before activating draw mode from manual edit', async () => {
const initialSource = '<!doctype html><html><body><h1 data-od-id="hero" style="color: #111111">Hero</h1></body></html>';
let saveResolve!: (value: Response) => void;
const saveResponse = new Promise<Response>((resolve) => {
saveResolve = resolve;
});
const savedSources: string[] = [];
const fetchMock = vi.fn(async (input: string | URL | Request, init?: RequestInit) => {
const url = typeof input === 'string' ? input : input instanceof Request ? input.url : String(input);
if (url.includes('/api/projects/project-1/deployments')) {
return new Response(JSON.stringify({ deployments: [] }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/files') && init?.method === 'POST') {
const payload = JSON.parse(String(init.body)) as { content: string };
savedSources.push(payload.content);
return saveResponse;
}
if (url.includes('/api/projects/project-1/raw/preview.html')) {
return new Response(initialSource, { status: 200 });
}
return new Response('{}', { status: 200, headers: { 'Content-Type': 'application/json' } });
});
vi.stubGlobal('fetch', fetchMock);
render(
<FileViewer projectId="project-1" projectKind="prototype" file={htmlPreviewFile()}
liveHtml={initialSource}
/>,
);
clickManualTool('manual-edit-mode-toggle');
await hoverManualEditTarget();
act(() => {
panelState.props?.onStyleChange?.('hero', { color: '#ef4444' }, 'Style: Hero');
});
clickAgentTool('draw-overlay-toggle');
await waitFor(() => expect(savedSources).toHaveLength(1));
expect(savedSources[0]).toContain('rgb(239, 68, 68)');
openManualTools();
expect(screen.getByTestId('manual-edit-mode-toggle').getAttribute('aria-pressed')).toBe('true');
expect(screen.getByTestId('draw-overlay-toggle').getAttribute('aria-pressed')).toBe('false');
await act(async () => {
saveResolve(new Response(JSON.stringify({ file: htmlPreviewFile() }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
}));
await saveResponse;
});
await waitFor(() => {
openManualTools();
expect(screen.getByTestId('manual-edit-mode-toggle').getAttribute('aria-pressed')).toBe('false');
});
expect(screen.getByTestId('draw-overlay-toggle').getAttribute('aria-pressed')).toBe('true');
});
it('remounts the srcDoc iframe when closing manual edit on a srcDoc-only preview', async () => {
const source = '<!doctype html><html><body><script>localStorage.getItem("od");</script><main data-od-id="hero">Hero</main></body></html>';
render(
<FileViewer projectId="project-1" projectKind="prototype" file={htmlPreviewFile()}
liveHtml={source}
/>,
);
clickManualTool('manual-edit-mode-toggle');
await hoverManualEditTarget();
const editFrame = screen.getByTestId('artifact-preview-frame') as HTMLIFrameElement;
expect(editFrame.getAttribute('data-od-render-mode')).toBe('srcdoc');
expect(editFrame.srcdoc).toContain('data-od-edit-bridge');
act(() => {
panelState.props?.onExit?.();
});
await waitFor(() => {
const previewFrame = screen.getByTestId('artifact-preview-frame') as HTMLIFrameElement;
expect(previewFrame).not.toBe(editFrame);
expect(previewFrame.getAttribute('data-od-render-mode')).toBe('srcdoc');
expect(previewFrame.srcdoc).toContain('Hero');
expect(previewFrame.srcdoc).not.toContain('data-od-edit-bridge');
});
});
it('uses the undone source snapshot for a follow-up edit after undo', async () => {
const initialSource = '<!doctype html><html><body><h1 data-od-id="hero" style="color: #111111">Hero</h1></body></html>';
let persistedSource = initialSource;
const savedSources: string[] = [];
const fetchMock = vi.fn(async (input: string | URL | Request, init?: RequestInit) => {
const url = typeof input === 'string' ? input : input instanceof Request ? input.url : String(input);
if (url.includes('/api/projects/project-1/deployments')) {
return new Response(JSON.stringify({ deployments: [] }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/files') && init?.method === 'POST') {
const payload = JSON.parse(String(init.body)) as { content: string };
persistedSource = payload.content;
savedSources.push(payload.content);
return new Response(JSON.stringify({ file: htmlPreviewFile() }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/raw/preview.html')) {
return new Response(persistedSource, { status: 200 });
}
return new Response('{}', { status: 200, headers: { 'Content-Type': 'application/json' } });
});
vi.stubGlobal('fetch', fetchMock);
render(
<FileViewer projectId="project-1" projectKind="prototype" file={htmlPreviewFile()}
liveHtml={initialSource}
/>,
);
clickManualTool('manual-edit-mode-toggle');
await hoverManualEditTarget();
act(() => {
panelState.props?.onApplyPatch(
{ kind: 'set-style', id: 'hero', styles: { color: '#ef4444' } },
'Style: Hero',
);
});
await waitFor(() => expect(savedSources).toHaveLength(1));
expect(savedSources[0]).toContain('rgb(239, 68, 68)');
act(() => {
panelState.props?.onUndo();
});
await waitFor(() => expect(savedSources).toHaveLength(2));
expect(savedSources[1]).toBe(initialSource);
act(() => {
panelState.props?.onApplyPatch(
{ kind: 'set-style', id: 'hero', styles: { backgroundColor: '#f97316' } },
'Style: Hero',
);
});
await waitFor(() => expect(savedSources).toHaveLength(3));
expect(savedSources[2]).toContain('background-color: rgb(249, 115, 22)');
expect(savedSources[2]).not.toContain('rgb(239, 68, 68)');
});
it('refreshes the manual edit canvas after non-style source patches', async () => {
const initialSource = '<!doctype html><html><body><h1 data-od-id="hero">Hero</h1></body></html>';
const savedSources: string[] = [];
const fetchMock = vi.fn(async (input: string | URL | Request, init?: RequestInit) => {
const url = typeof input === 'string' ? input : input instanceof Request ? input.url : String(input);
if (url.includes('/api/projects/project-1/deployments')) {
return new Response(JSON.stringify({ deployments: [] }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/files') && init?.method === 'POST') {
const payload = JSON.parse(String(init.body)) as { content: string };
savedSources.push(payload.content);
return new Response(JSON.stringify({ file: htmlPreviewFile() }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/raw/preview.html')) {
return new Response(initialSource, { status: 200 });
}
return new Response('{}', { status: 200, headers: { 'Content-Type': 'application/json' } });
});
vi.stubGlobal('fetch', fetchMock);
render(
<FileViewer projectId="project-1" projectKind="prototype" file={htmlPreviewFile()}
liveHtml={initialSource}
/>,
);
fireEvent.click(screen.getByTestId('manual-edit-mode-toggle'));
await hoverManualEditTarget();
const getActivePreviewFrame = () => screen.getByTestId('artifact-preview-frame') as HTMLIFrameElement;
await waitFor(() => {
const frame = getActivePreviewFrame();
expect(frame.getAttribute('data-od-active')).toBe('true');
expect(frame.getAttribute('data-od-render-mode')).toBe('srcdoc');
expect(panelState.props?.draft.fullSource).toContain('Hero');
});
act(() => {
panelState.props?.onApplyPatch(
{ id: 'hero', kind: 'set-text', value: 'Updated hero' },
'Content: Hero',
);
});
await waitFor(() => expect(savedSources).toHaveLength(1));
await waitFor(() => expect(panelState.props?.draft.fullSource).toContain('Updated hero'));
await waitFor(() => {
expect(getActivePreviewFrame().srcdoc).toContain('Updated hero');
});
});
it('clears the selected target after deleting an element', async () => {
const initialSource = '<!doctype html><html><body><h1 data-od-id="hero">Hero</h1><p data-od-id="body">Body</p></body></html>';
let persistedSource = initialSource;
const savedSources: string[] = [];
const fetchMock = vi.fn(async (input: string | URL | Request, init?: RequestInit) => {
const url = typeof input === 'string' ? input : input instanceof Request ? input.url : String(input);
if (url.includes('/api/projects/project-1/deployments')) {
return new Response(JSON.stringify({ deployments: [] }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/files') && init?.method === 'POST') {
const payload = JSON.parse(String(init.body)) as { content: string };
persistedSource = payload.content;
savedSources.push(payload.content);
return new Response(JSON.stringify({ file: htmlPreviewFile() }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
});
}
if (url.includes('/api/projects/project-1/raw/preview.html')) {
return new Response(persistedSource, { status: 200 });
}
return new Response('{}', { status: 200, headers: { 'Content-Type': 'application/json' } });
});
vi.stubGlobal('fetch', fetchMock);
render(
<FileViewer projectId="project-1" projectKind="prototype" file={htmlPreviewFile()}
liveHtml={initialSource}
/>,
);
fireEvent.click(screen.getByTestId('manual-edit-mode-toggle'));
await hoverManualEditTarget();
const frame = screen.getByTestId('artifact-preview-frame') as HTMLIFrameElement;
const postMessageSpy = vi.spyOn(frame.contentWindow!, 'postMessage');
await waitFor(() => expect(panelState.props?.selectedTarget?.id).toBe('hero'));
expect(panelState.props?.draft.text).toBe('Hero');
act(() => {
panelState.props?.onApplyPatch(
{ id: 'hero', kind: 'remove-element' },
'Delete element',
);
});
await waitFor(() => expect(savedSources).toHaveLength(1));
expect(savedSources[0]).not.toContain('data-od-id="hero"');
expect(savedSources[0]).toContain('data-od-id="body"');
await waitFor(() => expect(panelState.props?.selectedTarget).toBeNull());
expect(screen.getByTestId('mock-manual-edit-panel')).toBeTruthy();
expect(postMessageSpy).toHaveBeenCalledWith(
expect.objectContaining({ type: 'od-edit-selected-target', id: null }),
'*',
);
await waitFor(() => {
expect((screen.getByTestId('artifact-preview-frame') as HTMLIFrameElement).srcdoc)
.not.toContain('data-od-id="hero"');
});
});
});
function htmlPreviewFile(): ProjectFile {
return {
name: 'preview.html',
path: 'preview.html',
type: 'file',
size: 1024,
mtime: 1710000000,
mime: 'text/html',
kind: 'html',
artifactManifest: {
version: 1,
kind: 'html',
title: 'Preview',
entry: 'preview.html',
renderer: 'html',
exports: ['html'],
},
};
}
function heroTarget(): ManualEditTarget {
return {
id: 'hero',
kind: 'text',
label: 'Hero',
tagName: 'h1',
className: '',
text: 'Hero',
rect: { x: 0, y: 0, width: 120, height: 40 },
fields: { text: 'Hero' },
attributes: { 'data-od-id': 'hero' },
styles: emptyManualEditStyles(),
isLayoutContainer: false,
outerHtml: '<h1 data-od-id="hero">Hero</h1>',
};
}