Files
AFFiNE-Mirror/tests/blocksuite/e2e/edgeless/presentation.spec.ts
L-Sun c9e14ac0db fix(editor): sync gfx block transform update with RAF to prevent stale transform (#11322)
Close [BS-2866](https://linear.app/affine-design/issue/BS-2866/presentation-mode中的note消失)

## Problem
When using RequestAnimationFrame (RAF) for GFX block updates, there was a timing issue where the transform update would lag behind the RAF callback, causing the block to display with the previous frame's transform state.

## Solution
1. Refactored the block state management to use signals for better reactivity
2. Moved block visibility state management from `viewport-element.ts` to `gfx-block-component.ts`
3. Added `transformState$` signal to track block state
4. Synchronized transform updates with RAF using `effect` to ensure updates happen in the correct frame
5. Added test case to verify note visibility in presentation mode
2025-03-31 12:47:01 +00:00

317 lines
10 KiB
TypeScript

import { expect } from '@playwright/test';
import {
assertEdgelessTool,
createFrame,
createNote,
createShapeElement,
dragBetweenViewCoords,
edgelessCommonSetup,
enterPresentationMode,
getSelectedBound,
locatorPresentationToolbarButton,
resizeElementByHandle,
selectElementInEdgeless,
selectNoteInEdgeless,
setEdgelessTool,
Shape,
switchEditorMode,
toggleFramePanel,
} from '../utils/actions/edgeless.js';
import {
copyByKeyboard,
pasteByKeyboard,
pressEscape,
selectAllBlocksByKeyboard,
} from '../utils/actions/keyboard.js';
import {
enterPlaygroundRoom,
initEmptyEdgelessState,
waitNextFrame,
} from '../utils/actions/misc.js';
import { test } from '../utils/playwright.js';
test.describe('presentation', () => {
test('should render note when enter presentation mode', async ({ page }) => {
await edgelessCommonSetup(page);
await createShapeElement(page, [100, 100], [200, 200], Shape.Square);
await createNote(page, [300, 100], 'hello');
// Frame shape
await setEdgelessTool(page, 'frame');
await dragBetweenViewCoords(page, [80, 80], [220, 220]);
await waitNextFrame(page, 100);
// Frame note
await setEdgelessTool(page, 'frame');
await dragBetweenViewCoords(page, [240, 0], [800, 200]);
expect(await page.locator('affine-frame').count()).toBe(2);
await enterPresentationMode(page);
await waitNextFrame(page, 100);
const nextButton = locatorPresentationToolbarButton(page, 'next');
await nextButton.click();
const edgelessNote = page.locator('affine-edgeless-note');
await expect(edgelessNote).toBeVisible();
const prevButton = locatorPresentationToolbarButton(page, 'previous');
await prevButton.click();
await expect(edgelessNote).toBeHidden();
await waitNextFrame(page, 300);
await nextButton.click();
await expect(edgelessNote).toBeVisible();
});
test('should exit presentation mode when press escape', async ({ page }) => {
await edgelessCommonSetup(page);
await createNote(page, [300, 100], 'hello');
// Frame note
await setEdgelessTool(page, 'frame');
await dragBetweenViewCoords(page, [240, 0], [800, 200]);
expect(await page.locator('affine-frame').count()).toBe(1);
await enterPresentationMode(page);
await waitNextFrame(page, 300);
await assertEdgelessTool(page, 'frameNavigator');
const navigatorBlackBackground = page.locator(
'.edgeless-navigator-black-background'
);
await expect(navigatorBlackBackground).toBeVisible();
await pressEscape(page);
await waitNextFrame(page, 100);
await assertEdgelessTool(page, 'default');
await expect(navigatorBlackBackground).toBeHidden();
});
test('should be able to adjust order of presentation in toolbar', async ({
page,
}) => {
await edgelessCommonSetup(page);
await createFrame(page, [100, 100], [100, 200]);
await createFrame(page, [200, 100], [300, 200]);
await createFrame(page, [300, 100], [400, 200]);
await createFrame(page, [400, 100], [500, 200]);
await enterPresentationMode(page);
await page.locator('.edgeless-frame-order-button').click();
const frameItems = page.locator(
'edgeless-frame-order-menu .item.draggable'
);
const dragIndicators = page.locator(
'edgeless-frame-order-menu .drag-indicator'
);
await expect(frameItems).toHaveCount(4);
await expect(frameItems.nth(0)).toHaveText('Frame 1');
await expect(frameItems.nth(1)).toHaveText('Frame 2');
await expect(frameItems.nth(2)).toHaveText('Frame 3');
await expect(frameItems.nth(3)).toHaveText('Frame 4');
// 1 2 3 4
await frameItems.nth(2).dragTo(dragIndicators.nth(0));
// 3 1 2 4
await frameItems.nth(3).dragTo(dragIndicators.nth(2));
// 3 1 4 2
await frameItems.nth(1).dragTo(dragIndicators.nth(3));
// 3 4 1 2
await expect(frameItems).toHaveCount(4);
await expect(frameItems.nth(0)).toHaveText('Frame 3');
await expect(frameItems.nth(1)).toHaveText('Frame 4');
await expect(frameItems.nth(2)).toHaveText('Frame 1');
await expect(frameItems.nth(3)).toHaveText('Frame 2');
const currentFrame = page.locator('.edgeless-frame-navigator-title');
const nextButton = locatorPresentationToolbarButton(page, 'next');
await expect(currentFrame).toHaveText('Frame 3');
await nextButton.click();
await expect(currentFrame).toHaveText('Frame 4');
await nextButton.click();
await expect(currentFrame).toHaveText('Frame 1');
await nextButton.click();
await expect(currentFrame).toHaveText('Frame 2');
});
test('should be able to adjust order of presentation in frame panel', async ({
page,
}) => {
await edgelessCommonSetup(page);
await createFrame(page, [100, 100], [100, 200]);
await createFrame(page, [200, 100], [300, 200]);
await createFrame(page, [300, 100], [400, 200]);
await createFrame(page, [400, 100], [500, 200]);
// await enterPresentationMode(page);
await toggleFramePanel(page);
// await page.locator('.edgeless-frame-order-button').click();
const frameCards = page.locator('affine-frame-card .frame-card-body');
const frameTitles = page.locator('affine-frame-card-title .card-title');
await expect(frameTitles).toHaveCount(4);
await expect(frameTitles.nth(0)).toHaveText('Frame 1');
await expect(frameTitles.nth(1)).toHaveText('Frame 2');
await expect(frameTitles.nth(2)).toHaveText('Frame 3');
await expect(frameTitles.nth(3)).toHaveText('Frame 4');
const drag = async (from: number, to: number) => {
const startBBox = await frameCards.nth(from).boundingBox();
expect(startBBox).not.toBeNull();
if (startBBox === null) return;
const endBBox = await frameTitles.nth(to).boundingBox();
expect(endBBox).not.toBeNull();
if (endBBox === null) return;
await page.mouse.move(
startBBox.x + startBBox.width / 2,
startBBox.y + startBBox.height / 2
);
await page.mouse.down();
await page.mouse.move(endBBox.x + endBBox.width / 2, endBBox.y, {
steps: 2,
});
await page.mouse.up();
};
// 1 2 3 4
await drag(2, 0);
// 3 1 2 4
await drag(3, 2);
// 3 1 4 2
await drag(1, 3);
// 3 4 1 2
await expect(frameTitles).toHaveCount(4);
await expect(frameTitles.nth(0)).toHaveText('Frame 3');
await expect(frameTitles.nth(1)).toHaveText('Frame 4');
await expect(frameTitles.nth(2)).toHaveText('Frame 1');
await expect(frameTitles.nth(3)).toHaveText('Frame 2');
await enterPresentationMode(page);
await page.locator('.edgeless-frame-order-button').click();
const frameItems = page.locator(
'edgeless-frame-order-menu .item.draggable'
);
await expect(frameItems).toHaveCount(4);
await expect(frameItems.nth(0)).toHaveText('Frame 3');
await expect(frameItems.nth(1)).toHaveText('Frame 4');
await expect(frameItems.nth(2)).toHaveText('Frame 1');
await expect(frameItems.nth(3)).toHaveText('Frame 2');
const currentFrame = page.locator('.edgeless-frame-navigator-title');
const nextButton = locatorPresentationToolbarButton(page, 'next');
await expect(currentFrame).toHaveText('Frame 3');
await nextButton.click();
await expect(currentFrame).toHaveText('Frame 4');
await nextButton.click();
await expect(currentFrame).toHaveText('Frame 1');
await nextButton.click();
await expect(currentFrame).toHaveText('Frame 2');
});
test('duplicate frames should keep the presentation orders', async ({
page,
}) => {
await edgelessCommonSetup(page);
await createFrame(page, [100, 100], [100, 200]);
await createFrame(page, [200, 100], [300, 200]);
await createFrame(page, [300, 100], [400, 200]);
await createFrame(page, [400, 100], [500, 200]);
await selectAllBlocksByKeyboard(page);
await copyByKeyboard(page);
await pasteByKeyboard(page);
await enterPresentationMode(page);
await page.locator('.edgeless-frame-order-button').click();
const frameItems = page.locator(
'edgeless-frame-order-menu .item.draggable'
);
await expect(frameItems).toHaveCount(8);
await expect(frameItems.nth(0)).toHaveText('Frame 1');
await expect(frameItems.nth(1)).toHaveText('Frame 2');
await expect(frameItems.nth(2)).toHaveText('Frame 3');
await expect(frameItems.nth(3)).toHaveText('Frame 4');
await expect(frameItems.nth(4)).toHaveText('Frame 1');
await expect(frameItems.nth(5)).toHaveText('Frame 2');
await expect(frameItems.nth(6)).toHaveText('Frame 3');
await expect(frameItems.nth(7)).toHaveText('Frame 4');
});
test('note should hide the collapse button when enter presentation mode', async ({
page,
}) => {
await enterPlaygroundRoom(page);
const { noteId } = await initEmptyEdgelessState(page);
await switchEditorMode(page);
await selectNoteInEdgeless(page, noteId);
await resizeElementByHandle(page, { x: 0, y: 70 }, 'bottom-right');
await createFrame(page, [100, 100], [100, 200]);
await enterPresentationMode(page);
const collapseButton = page.getByTestId('edgeless-note-collapse-button');
await expect(collapseButton).not.toBeVisible();
});
test('note should be visible when enter presentation mode', async ({
page,
}) => {
await enterPlaygroundRoom(page);
const { noteId } = await initEmptyEdgelessState(page);
await switchEditorMode(page);
await selectNoteInEdgeless(page, noteId);
const noteBound = await getSelectedBound(page);
await pressEscape(page, 3);
const frame1 = await createFrame(
page,
[noteBound[0] - 10, noteBound[1] - 10],
[noteBound[0] + noteBound[2] + 10, noteBound[1] + noteBound[3] + 10]
);
await selectElementInEdgeless(page, [frame1]);
const frame1Bound = await getSelectedBound(page);
await pressEscape(page);
await createFrame(
page,
[frame1Bound[0] + frame1Bound[2] + 10, frame1Bound[1]],
[frame1Bound[0] + 2 * frame1Bound[2], frame1Bound[1] + frame1Bound[3]]
);
await enterPresentationMode(page);
const nextButton = locatorPresentationToolbarButton(page, 'next');
const prevButton = locatorPresentationToolbarButton(page, 'previous');
const note = page.locator('affine-edgeless-note');
await expect(note).toBeVisible();
await nextButton.click();
await expect(note).toBeHidden();
await prevButton.click();
await expect(note).toBeVisible();
});
});