Files
Genarrative/src/components/image-editor/useImageCanvasLayerCommands.test.tsx
T
kdletters 5468bb3212 修复画布生成器恢复串台
区分生成结果归属与派生输入关系,避免角色动作和快速编辑面板串台
补全角色动作、视频、音效、背景音乐与宣发素材的生成器恢复类型
统一清理剪切和素材删除后的关联生成状态,避免孤立占位
补充生成器恢复、宣发类型和删除清理回归测试并同步编辑器文档
2026-07-17 21:23:12 +08:00

582 lines
20 KiB
TypeScript

/* @vitest-environment jsdom */
import { fireEvent, render, screen, waitFor } from '@testing-library/react';
import { useState } from 'react';
import { afterEach, describe, expect, it, vi } from 'vitest';
import type {
CanvasContextMenuState,
CanvasGenerationDialogState,
CanvasLayer,
} from './ImageCanvasEditorTypes';
import { readLayerImageBlob } from './ImageCanvasExportModel';
import { useImageCanvasLayerCommands } from './useImageCanvasLayerCommands';
vi.mock('./ImageCanvasExportModel', () => ({
readLayerImageBlob: vi.fn(async (layer: CanvasLayer) => {
const blob = new Blob([layer.id], { type: 'image/png' });
Object.defineProperty(blob, 'layerId', {
configurable: true,
value: layer.id,
});
return blob;
}),
}));
function createLayer(id: string, x: number, zIndex: number): CanvasLayer {
return {
id,
resourceId: `resource-${id}`,
title: id,
src: `data:image/png,${encodeURIComponent(id)}`,
x,
y: 20,
width: 100,
height: 80,
originalWidth: 100,
originalHeight: 80,
zIndex,
sourceType: 'uploaded',
};
}
const originalClipboard = navigator.clipboard;
const originalClipboardItem = globalThis.ClipboardItem;
const originalCreateImageBitmap = globalThis.createImageBitmap;
type ClipboardImageItems = Record<string, Blob | Promise<Blob>>;
function installImageClipboardMock() {
class ClipboardItemMock {
readonly items: ClipboardImageItems;
constructor(items: ClipboardImageItems) {
this.items = items;
}
}
const write = vi.fn(
async (_items: Array<{ items: ClipboardImageItems }>) => undefined,
);
Object.defineProperty(globalThis, 'ClipboardItem', {
configurable: true,
value: ClipboardItemMock,
});
Object.defineProperty(navigator, 'clipboard', {
configurable: true,
value: { write },
});
return write;
}
function LayerCommandsHarness({
exportLayerImage = vi.fn(),
onDeleteLayerSideEffects = vi.fn(),
onDeleteGenerationDialogSideEffects = vi.fn(),
initialLayers,
}: {
exportLayerImage?: (
layer: CanvasLayer | null,
options?: { mode?: 'spine-json' | 'sequence-with-preview' },
) => void;
onDeleteLayerSideEffects?: (layerId: string) => void;
onDeleteGenerationDialogSideEffects?: (dialogId: string) => void;
initialLayers?: CanvasLayer[];
}) {
const [layers, setLayers] = useState<CanvasLayer[]>(
initialLayers ?? [
createLayer('first', 10, 1),
createLayer('second', 160, 2),
createLayer('third', 310, 3),
],
);
const [selectedLayerId, setSelectedLayerId] = useState<string | null>(
'first',
);
const [selectedLayerIds, setSelectedLayerIds] = useState<string[]>([
'first',
'second',
]);
const [canvasGenerationDialogs] = useState<CanvasGenerationDialogState[]>([
{
id: 'dialog-1',
mode: 'generate',
prompt: '生成',
status: 'idle',
placeholder: {
x: 20,
y: 20,
width: 100,
height: 80,
originalWidth: 100,
originalHeight: 80,
},
},
]);
const [metadataLayer, setMetadataLayer] = useState<CanvasLayer | null>(
layers[0] ?? null,
);
const [hoveredLayerId, setHoveredLayerId] = useState<string | null>('first');
const [contextMenu, setContextMenu] = useState<CanvasContextMenuState | null>(
{
kind: 'layer',
layerId: 'first',
x: 0,
y: 0,
canvasPoint: { x: 0, y: 0 },
},
);
const [historyCount, setHistoryCount] = useState(0);
const [imageContextClosedCount, setImageContextClosedCount] = useState(0);
const [activeTool, setActiveTool] = useState('select');
const selectSingleLayer = (layerId: string | null) => {
setSelectedLayerId(layerId);
setSelectedLayerIds(layerId ? [layerId] : []);
};
const commands = useImageCanvasLayerCommands({
layers,
contextMenu,
selectedLayerId,
selectedLayerIds,
canvasGenerationDialogs,
setLayers,
setSelectedLayerId,
setSelectedLayerIds,
setHoveredLayerId,
setMetadataLayer,
setContextMenu,
setImageContextMenu: () =>
setImageContextClosedCount((currentCount) => currentCount + 1),
setActiveTool,
captureCanvasHistory: () =>
setHistoryCount((currentCount) => currentCount + 1),
selectSingleLayer,
onDeleteLayerSideEffects,
onDeleteGenerationDialogSideEffects,
exportLayerImage,
});
return (
<div>
<span data-testid="layers">
{layers
.map(
(layer) =>
`${layer.id}:${layer.title}:${layer.x}:${layer.zIndex}:${layer.groupId ?? '-'}:${layer.hidden ? 'hidden' : 'shown'}:${layer.locked ? 'locked' : 'open'}:${layer.flipX ? 'flipX' : '-'}:${layer.flipY ? 'flipY' : '-'}`,
)
.join('|')}
</span>
<span data-testid="selection">
{selectedLayerId ?? '-'}:{selectedLayerIds.join(',')}
</span>
<span data-testid="metadata">{metadataLayer?.id ?? '-'}</span>
<span data-testid="hovered">{hoveredLayerId ?? '-'}</span>
<span data-testid="context">{contextMenu ? 'open' : 'closed'}</span>
<span data-testid="history">{historyCount}</span>
<span data-testid="image-context-closed">
{imageContextClosedCount}
</span>
<span data-testid="tool">{activeTool}</span>
<span data-testid="clipboard">
{commands.canvasClipboard
? `${commands.canvasClipboard.mode}:${commands.canvasClipboard.layers.length}`
: '-'}
</span>
<button type="button" onClick={() => commands.copyContextLayers()}>
复制
</button>
<button type="button" onClick={() => commands.copySelectedLayers()}>
复制选中
</button>
<button
type="button"
onClick={() => commands.copyContextLayers({ cut: true })}
>
剪切
</button>
<button
type="button"
onClick={() => commands.copySelectedLayers({ cut: true })}
>
剪切选中
</button>
<button
type="button"
onClick={() => commands.pasteCanvasClipboard({ x: 500, y: 600 })}
>
粘贴
</button>
<button type="button" onClick={() => commands.duplicateContextLayers()}>
创建副本
</button>
<button type="button" onClick={() => commands.duplicateSelectedLayers()}>
创建选中副本
</button>
<button type="button" onClick={() => commands.moveContextLayers('top')}>
置顶
</button>
<button type="button" onClick={() => commands.moveSelectedLayers('top')}>
选中置顶
</button>
<button type="button" onClick={() => commands.groupContextLayers()}>
创建组
</button>
<button type="button" onClick={() => commands.ungroupContextLayers()}>
解除组
</button>
<button
type="button"
onClick={() => commands.toggleContextLayerVisibility()}
>
显隐
</button>
<button type="button" onClick={() => commands.toggleContextLayerLock()}>
锁定
</button>
<button type="button" onClick={() => commands.flipContextLayers('x')}>
翻转
</button>
<button type="button" onClick={() => commands.deleteContextLayers()}>
删除右键目标
</button>
<button type="button" onClick={() => commands.deleteSelectedLayer()}>
删除选中
</button>
<button type="button" onClick={() => commands.deleteLayerById('first')}>
删除单图
</button>
<button type="button" onClick={() => commands.groupSelectedLayers()}>
选中打组
</button>
<button type="button" onClick={() => commands.exportContextLayer()}>
导出
</button>
<button
type="button"
onClick={() =>
setContextMenu({
kind: 'layer',
layerId: 'third',
x: 0,
y: 0,
canvasPoint: { x: 0, y: 0 },
})
}
>
右键第三层
</button>
<button
type="button"
onClick={() => {
setSelectedLayerId('third');
setSelectedLayerIds(['third']);
}}
>
只选第三层
</button>
<button
type="button"
onClick={() => {
setSelectedLayerId('first');
setSelectedLayerIds(['first', 'generation-dialog:dialog-1']);
}}
>
混合选择
</button>
</div>
);
}
afterEach(() => {
vi.restoreAllMocks();
Object.defineProperty(navigator, 'clipboard', {
configurable: true,
value: originalClipboard,
});
Object.defineProperty(globalThis, 'ClipboardItem', {
configurable: true,
value: originalClipboardItem,
});
Object.defineProperty(globalThis, 'createImageBitmap', {
configurable: true,
value: originalCreateImageBitmap,
});
});
describe('useImageCanvasLayerCommands', () => {
it('writes the last copied image layer to the system clipboard', async () => {
const write = installImageClipboardMock();
render(<LayerCommandsHarness />);
fireEvent.click(screen.getByRole('button', { name: '复制选中' }));
await waitFor(() => expect(write).toHaveBeenCalledTimes(1));
const clipboardItems = write.mock.calls[0]?.[0] as
| Array<{ items: ClipboardImageItems }>
| undefined;
await expect(
clipboardItems?.[0]?.items['image/png'],
).resolves.toBeInstanceOf(Blob);
expect(readLayerImageBlob).toHaveBeenCalledWith(
expect.objectContaining({ id: 'second' }),
);
expect(screen.getByTestId('clipboard').textContent).toBe('copy:2');
});
it('starts system clipboard write before image bytes finish loading', async () => {
const write = installImageClipboardMock();
let resolveBlob: (blob: Blob) => void = () => undefined;
vi.mocked(readLayerImageBlob).mockReturnValueOnce(
new Promise<Blob>((resolve) => {
resolveBlob = resolve;
}),
);
render(<LayerCommandsHarness />);
fireEvent.click(screen.getByRole('button', { name: '复制选中' }));
await waitFor(() => expect(write).toHaveBeenCalledTimes(1));
const clipboardItems = write.mock.calls[0]?.[0] as
| Array<{ items: ClipboardImageItems }>
| undefined;
const pngBlobPromise = clipboardItems?.[0]?.items['image/png'];
expect(pngBlobPromise).toBeInstanceOf(Promise);
resolveBlob(new Blob(['late-png'], { type: 'image/png' }));
await expect(pngBlobPromise).resolves.toBeInstanceOf(Blob);
});
it('normalizes copied images to png for the system clipboard', async () => {
const write = installImageClipboardMock();
const drawImage = vi.fn();
const toBlob = vi.fn((resolve: (blob: Blob) => void) =>
resolve(new Blob(['png'], { type: 'image/png' })),
);
vi.mocked(readLayerImageBlob).mockResolvedValueOnce(
new Blob(['webp'], { type: 'image/webp' }),
);
Object.defineProperty(globalThis, 'createImageBitmap', {
configurable: true,
value: vi.fn(async () => ({ width: 16, height: 12 })),
});
const originalCreateElement = document.createElement.bind(document);
vi.spyOn(document, 'createElement').mockImplementation((tagName) => {
if (tagName === 'canvas') {
return {
width: 0,
height: 0,
getContext: () => ({ drawImage }),
toBlob,
} as unknown as HTMLCanvasElement;
}
return originalCreateElement(tagName);
});
render(<LayerCommandsHarness />);
fireEvent.click(screen.getByRole('button', { name: '复制选中' }));
await waitFor(() => expect(write).toHaveBeenCalledTimes(1));
const clipboardItems = write.mock.calls[0]?.[0] as
| Array<{ items: ClipboardImageItems }>
| undefined;
await expect(
Promise.resolve(clipboardItems?.[0]?.items['image/png']).then(
(blob) => blob?.type,
),
).resolves.toBe('image/png');
expect(drawImage).toHaveBeenCalledTimes(1);
});
it('keeps canvas copy when system image clipboard is unavailable', () => {
Object.defineProperty(navigator, 'clipboard', {
configurable: true,
value: {},
});
Object.defineProperty(globalThis, 'ClipboardItem', {
configurable: true,
value: undefined,
});
render(<LayerCommandsHarness />);
fireEvent.click(screen.getByRole('button', { name: '复制选中' }));
expect(screen.getByTestId('clipboard').textContent).toBe('copy:2');
});
it('skips non-image layers when choosing the system clipboard image', async () => {
const write = installImageClipboardMock();
render(
<LayerCommandsHarness
initialLayers={[
{ ...createLayer('first', 10, 1), mediaType: 'video' },
createLayer('second', 160, 2),
createLayer('third', 310, 3),
]}
/>,
);
fireEvent.click(screen.getByRole('button', { name: '复制选中' }));
await waitFor(() => expect(write).toHaveBeenCalledTimes(1));
expect(readLayerImageBlob).toHaveBeenCalledWith(
expect.objectContaining({ id: 'second' }),
);
expect(screen.getByTestId('clipboard').textContent).toBe('copy:2');
});
it('copies, cuts, and pastes context layers with history and selection updates', async () => {
const write = installImageClipboardMock();
const onDeleteLayerSideEffects = vi.fn();
render(
<LayerCommandsHarness
onDeleteLayerSideEffects={onDeleteLayerSideEffects}
/>,
);
fireEvent.click(screen.getByRole('button', { name: '复制' }));
await waitFor(() => expect(write).toHaveBeenCalledTimes(1));
expect(readLayerImageBlob).toHaveBeenCalledWith(
expect.objectContaining({ id: 'second' }),
);
expect(screen.getByTestId('clipboard').textContent).toBe('copy:2');
expect(screen.getByTestId('context').textContent).toBe('closed');
expect(screen.getByTestId('image-context-closed').textContent).toBe('1');
fireEvent.click(screen.getByRole('button', { name: '粘贴' }));
expect(screen.getByTestId('layers').textContent).toContain(
'first 副本:500:4',
);
expect(screen.getByTestId('layers').textContent).toContain(
'second 副本:650:5',
);
expect(screen.getByTestId('selection').textContent).toContain(
'layer-copy-',
);
expect(screen.getByTestId('tool').textContent).toBe('select');
expect(screen.getByTestId('image-context-closed').textContent).toBe('2');
fireEvent.click(screen.getByRole('button', { name: '右键第三层' }));
fireEvent.click(screen.getByRole('button', { name: '只选第三层' }));
fireEvent.click(screen.getByRole('button', { name: '剪切' }));
expect(screen.getByTestId('clipboard').textContent).toBe('cut:1');
expect(screen.getByTestId('layers').textContent).not.toContain('third');
expect(screen.getByTestId('selection').textContent).toBe('-:');
expect(screen.getByTestId('image-context-closed').textContent).toBe('3');
expect(onDeleteLayerSideEffects).toHaveBeenCalledWith('third');
expect(Number(screen.getByTestId('history').textContent)).toBeGreaterThan(
1,
);
});
it('copies, cuts, duplicates, and moves selected layers for keyboard shortcuts', () => {
const onDeleteLayerSideEffects = vi.fn();
render(
<LayerCommandsHarness
onDeleteLayerSideEffects={onDeleteLayerSideEffects}
/>,
);
fireEvent.click(screen.getByRole('button', { name: '复制选中' }));
expect(screen.getByTestId('clipboard').textContent).toBe('copy:2');
expect(screen.getByTestId('image-context-closed').textContent).toBe('1');
fireEvent.click(screen.getByRole('button', { name: '创建选中副本' }));
expect(screen.getByTestId('layers').textContent).toContain(
'first 副本:42:4',
);
expect(screen.getByTestId('layers').textContent).toContain(
'second 副本:192:5',
);
expect(screen.getByTestId('selection').textContent).toContain(
'layer-copy-',
);
fireEvent.click(screen.getByRole('button', { name: '只选第三层' }));
fireEvent.click(screen.getByRole('button', { name: '选中置顶' }));
expect(screen.getByTestId('layers').textContent).toContain('third:third');
fireEvent.click(screen.getByRole('button', { name: '剪切选中' }));
expect(screen.getByTestId('clipboard').textContent).toBe('cut:1');
expect(screen.getByTestId('layers').textContent).not.toContain('third');
expect(screen.getByTestId('selection').textContent).toBe('-:');
expect(onDeleteLayerSideEffects).toHaveBeenCalledWith('third');
});
it('applies layer commands and clears menus without owning menu positioning', () => {
const exportLayerImage = vi.fn();
render(<LayerCommandsHarness exportLayerImage={exportLayerImage} />);
fireEvent.click(screen.getByRole('button', { name: '创建组' }));
expect(screen.getByTestId('layers').textContent).toContain('layer-group-');
fireEvent.click(screen.getByRole('button', { name: '右键第三层' }));
fireEvent.click(screen.getByRole('button', { name: '显隐' }));
expect(screen.getByTestId('layers').textContent).toContain(':hidden:');
fireEvent.click(screen.getByRole('button', { name: '右键第三层' }));
fireEvent.click(screen.getByRole('button', { name: '锁定' }));
expect(screen.getByTestId('layers').textContent).toContain(':locked:');
fireEvent.click(screen.getByRole('button', { name: '右键第三层' }));
fireEvent.click(screen.getByRole('button', { name: '翻转' }));
expect(screen.getByTestId('layers').textContent).toContain(':flipX:');
fireEvent.click(screen.getByRole('button', { name: '右键第三层' }));
fireEvent.click(screen.getByRole('button', { name: '导出' }));
expect(exportLayerImage).toHaveBeenCalledWith(
expect.objectContaining({ id: 'third' }),
expect.any(Object),
);
expect(screen.getByTestId('context').textContent).toBe('closed');
expect(Number(screen.getByTestId('image-context-closed').textContent)).toBe(
5,
);
});
it('deletes selected and direct layers while running delete side effects', () => {
const onDeleteLayerSideEffects = vi.fn();
render(
<LayerCommandsHarness
onDeleteLayerSideEffects={onDeleteLayerSideEffects}
/>,
);
fireEvent.click(screen.getByRole('button', { name: '删除选中' }));
expect(screen.getByTestId('layers').textContent).not.toContain('first');
expect(screen.getByTestId('layers').textContent).not.toContain('second');
expect(screen.getByTestId('selection').textContent).toBe('third:third');
expect(screen.getByTestId('metadata').textContent).toBe('-');
expect(screen.getByTestId('image-context-closed').textContent).toBe('1');
expect(onDeleteLayerSideEffects).toHaveBeenCalledWith('first');
expect(onDeleteLayerSideEffects).toHaveBeenCalledWith('second');
fireEvent.click(screen.getByRole('button', { name: '删除单图' }));
expect(screen.getByTestId('image-context-closed').textContent).toBe('2');
});
it('deletes selected generation dialogs together with layer targets', () => {
const onDeleteLayerSideEffects = vi.fn();
const onDeleteGenerationDialogSideEffects = vi.fn();
render(
<LayerCommandsHarness
onDeleteLayerSideEffects={onDeleteLayerSideEffects}
onDeleteGenerationDialogSideEffects={onDeleteGenerationDialogSideEffects}
/>,
);
fireEvent.click(screen.getByRole('button', { name: '混合选择' }));
fireEvent.click(screen.getByRole('button', { name: '删除选中' }));
expect(screen.getByTestId('layers').textContent).not.toContain('first');
expect(screen.getByTestId('layers').textContent).toContain('second');
expect(screen.getByTestId('selection').textContent).toBe('-:');
expect(onDeleteLayerSideEffects).toHaveBeenCalledWith('first');
expect(onDeleteGenerationDialogSideEffects).toHaveBeenCalledWith(
'dialog-1',
);
});
});