Files
nexu-io-open-design/apps/web/tests/components/markdown-scroll-sync.test.ts
Tom Huang 6be4e56544 feat(workspace): add plan mode and Excalidraw sketch flows (#4862)
* feat(daemon): add 'plan' session mode and update related functionality

- Introduced a new session mode 'plan' alongside existing 'design' and 'chat' modes, allowing for editable document creation.
- Updated various functions and interfaces to accommodate the new session mode, including normalization and usage in commands.
- Enhanced markdown rendering capabilities by integrating micromark and its GFM extension for improved markdown processing.
- Added new input types for question forms, expanding the range of user interactions.
- Updated UI components to reflect changes in session modes and ensure proper handling of next steps based on the current mode.

* feat(chat): integrate SessionModeToggle into ChatComposer and HomeHero

- Added SessionModeToggle component to both ChatComposer and HomeHero for improved session management.
- Updated HomeHero styles to accommodate the new mode switcher layout.
- Adjusted countdown timer in QuestionsPanel to extend the skip countdown from 120 seconds to 10 minutes, enhancing user experience.
- Added tests to ensure the countdown functionality works as expected.

* feat(FileViewer): implement synchronized scrolling for Markdown editor and preview

- Added functionality to synchronize scrolling between the Markdown editor and preview panes.
- Introduced new types and utility functions for managing scroll behavior.
- Enhanced the MarkdownViewer component to handle scroll events and maintain scroll position across different modes.
- Updated the component's state management to accommodate the new scrolling features.

* feat(excalidraw): integrate Excalidraw into the project

- Added @excalidraw/excalidraw as a dependency in package.json.
- Updated vitest configuration to include an alias for Excalidraw.
- Imported Excalidraw CSS in the layout component for styling.
- Modified AssistantMessage component to handle optional projectId.
- Enhanced FileOpsSummary to display delete operations.
- Implemented new Excalidraw scene management in SketchEditor and FileWorkspace components.
- Updated MarkdownViewer to support file mentions and improved file handling.
- Refactored various components to accommodate Excalidraw integration and ensure compatibility with existing features.

* feat(files): improve sketch and file handoff flows

* test: align post-merge expectations

* chore(nix): refresh pnpm deps hash

* fix(workspace): stabilize sketch persistence and ci checks

* fix(workspace): address review blockers in editable files

* fix(workspace): persist cleared sketch scenes

* test(workspace): type sketch editor mock scene

* fix(workspace): serialize sketch autosaves

* fix(workspace): keep sketch save revisions current

* test(e2e): stabilize project workspace smoke flows

* fix(analytics): preserve plan mode for BYOK runs

* test(e2e): stabilize new project rail interactions

* fix(files): stop bash delete parsing at shell operators

* test(e2e): stabilize ui cold-start suites

* fix(viewer): preserve absolute markdown image sources

* feat(workspace): preload sketches and enhance markdown save options

- Added functionality to preload persisted sketches before opening the tab.
- Introduced new MarkdownSaveOptions type to manage save behavior.
- Updated saveMarkdownText to handle options for refreshing files and showing saving state.
- Enhanced FileViewer to maintain focus and selection during metadata refresh.
- Implemented a Toast component for user feedback on save and export actions.

* fix(web): stabilize markdown and sketch editor polish

* fix(web): finish sketch editor merge resolution

* chore(nix): refresh pnpm deps hash

* fix(plan): bypass discovery and stabilize markdown sync

* fix(web): simplify scene retrieval in SketchEditor component

* feat(web): enhance markdown viewer with auto-save functionality

- Implemented passive auto-save status in the MarkdownViewer component, replacing the manual Save button with an auto-save indicator.
- Introduced new hooks and state management for tracking auto-save events and displaying the last saved time.
- Added support for synchronized scrolling between the markdown editor and preview.
- Created a new markdown-scroll-sync module to handle scroll synchronization logic.
- Updated localization files to include new strings for auto-save messages.
- Added a SketchEnginePrewarm component to optimize Excalidraw loading times.

* feat(web): enhance session mode toggle with cost indicators

- Added cost tiers for each session mode in the SessionModeToggle component, providing users with a visual representation of usage costs.
- Introduced a new ModeCostTag component to display cost information alongside session mode labels.
- Updated localization files to include new keys for cost labels and notes.
- Enhanced styling for cost indicators to improve user experience and clarity.
- Refactored EntryShell to open the new project modal instead of creating a blank project directly from the rail.
- Implemented a utility function in markdown-scroll-sync to check for vertical progression in block offsets.

* feat(web): add max height adjustment for session mode description card

- Introduced maxHeight prop to the ModeDescriptionCard component to control the height of the description card based on available space.
- Implemented useLayoutEffect in SessionModeToggle to dynamically calculate and set the maximum height of the description card, ensuring it does not overlap with the project tab bar.
- Updated tests to verify that session modes display their expected usage/cost correctly in the UI.
- Enhanced localization files to include new cost-related strings for various languages.

* feat(web): implement goBack function for improved navigation and update auto-open logic

- Added a new `goBack` function to handle in-app navigation, allowing users to return to the previous route instead of a hardcoded destination.
- Updated the `navigate` function to maintain history state for better back navigation.
- Refactored auto-open logic to prioritize produced artifacts, allowing markdown files to be opened alongside HTML files.
- Updated tests to cover new navigation behavior and artifact selection logic.
- Enhanced localization files to include new descriptions for workspace actions.

* refactor(web): remove create design system functionality and update design files panel actions

- Removed the `onCreateDesignSystem` prop and associated button from the DesignFilesPanel component.
- Updated the empty state actions to include a button for creating a new document via the `onPaste` function.
- Adjusted tests to reflect the removal of the design system creation action and ensure the new document button is functional.
- Enhanced the MarkdownViewer component by adding a placeholder for the text area and removing the header bar for a cleaner interface.
- Updated localization files to include a new placeholder string for the markdown editor.

* fix(web): restore markdown placeholder translations

* refactor(web): streamline MarkdownViewer and enhance localization

- Removed unnecessary state management and reload functionality from the MarkdownViewer component for improved performance.
- Added a placeholder text for the markdown editor in multiple localization files to enhance user guidance.
- Updated styles for the save state indicator in the viewer to improve visual clarity and alignment.
- Adjusted tests to reflect changes in the MarkdownViewer and ensure proper functionality.

* fix(web): adjust SketchEditor button size and remove shortcut hints

- Reduced the icon size in the SketchEditor component from 13 to 12 for better alignment.
- Updated the removeSketchMermaidShortcutHints function to also remove the submit shortcut hints from the dialog, enhancing the user interface by decluttering unnecessary elements.
- Adjusted tests to verify the absence of shortcut hints in the modal after updates.

* fix(web): address plan mode follow-up polish

* fix(web): align ci expectations after merge

* test(e2e): stabilize project workspace helpers

* test(e2e): scale settings visual timeout

* fix(prompts): lock ElevenLabs voice picker choices

* test(e2e): pin project workspace P0 worker

* test(e2e): use rail new project entry

* test(e2e): relax app restoration startup waits

* fix(web): limit markdown pipe escaping to tables

---------

Co-authored-by: open-design-bot[bot] <282769551+open-design-bot[bot]@users.noreply.github.com>
Co-authored-by: Amy <1184569493@qq.com>
2026-07-01 04:38:31 +00:00

130 lines
4.9 KiB
TypeScript

// @vitest-environment jsdom
import { describe, expect, it } from 'vitest';
import { renderMarkdownToSafeHtml } from '../../src/artifacts/markdown';
import {
buildScrollAnchors,
extractMarkdownBlockLines,
mapScrollPosition,
measurePreviewBlockOffsets,
} from '../../src/components/markdown-scroll-sync';
function topLevelElementCount(markdown: string): number {
const host = document.createElement('div');
host.innerHTML = renderMarkdownToSafeHtml(markdown);
return Array.from(host.children).filter((child) => child instanceof HTMLElement).length;
}
describe('extractMarkdownBlockLines', () => {
it('returns one source line per top-level block in document order', () => {
const markdown = [
'# Title', // 1
'', // 2
'Intro paragraph that is long enough to wrap somewhere.', // 3
'', // 4
'## Section A', // 5
'', // 6
'- item one', // 7
'- item two', // 8
'', // 9
'Another paragraph.', // 10
'', // 11
'```bash', // 12
'# not a heading inside a fence', // 13
'echo hi', // 14
'```', // 15
'', // 16
'> a quote', // 17
'', // 18
'### Section B', // 19
'', // 20
'Final paragraph.', // 21
].join('\n');
expect(extractMarkdownBlockLines(markdown)).toEqual([1, 3, 5, 7, 10, 12, 17, 19, 21]);
});
it('collapses nested list items into their top-level list', () => {
const markdown = ['- top', ' - nested a', ' - nested b', '- top two', '', 'after'].join('\n');
// The whole list is a single top-level block starting on line 1.
expect(extractMarkdownBlockLines(markdown)).toEqual([1, 6]);
});
it('treats a setext heading as a single block (no double count)', () => {
const markdown = ['Heading', '=======', '', 'body'].join('\n');
expect(extractMarkdownBlockLines(markdown)).toEqual([1, 4]);
});
it('returns an empty array for empty input', () => {
expect(extractMarkdownBlockLines('')).toEqual([]);
});
});
describe('block count invariant (extraction matches rendered DOM)', () => {
// Split-view alignment maps block N's source line to the Nth rendered
// top-level element, so the two counts MUST agree for every block shape we
// render. If they ever diverge the preview-side measurement bails to ratio
// sync, but these common shapes should always line up exactly.
const cases: Array<[string, string]> = [
['headings + paragraphs', ['# A', '', 'one', '', '## B', '', 'two'].join('\n')],
['lists', ['- a', '- b', '', '1. c', '2. d'].join('\n')],
['fenced code', ['intro', '', '```js', 'const x = 1;', '```', '', 'outro'].join('\n')],
['blockquote', ['> quote line one', '> quote line two', '', 'after'].join('\n')],
['gfm table', ['| a | b |', '| - | - |', '| 1 | 2 |', '', 'tail'].join('\n')],
['thematic break', ['above', '', '---', '', 'below'].join('\n')],
['setext heading', ['Title', '=====', '', 'body'].join('\n')],
];
for (const [name, markdown] of cases) {
it(`${name}: extracted block count equals rendered top-level element count`, () => {
expect(extractMarkdownBlockLines(markdown).length).toBe(topLevelElementCount(markdown));
});
}
});
describe('buildScrollAnchors', () => {
it('brackets block offsets with a top (0) and bottom (scrollHeight) anchor', () => {
expect(buildScrollAnchors([40, 120, 260], 600)).toEqual([0, 40, 120, 260, 600]);
});
it('clamps to the scroll range and enforces monotonicity', () => {
expect(buildScrollAnchors([120, 80, 9999], 500)).toEqual([0, 120, 120, 500, 500]);
});
});
describe('measurePreviewBlockOffsets', () => {
it('returns null when the browser cannot report distinct block geometry', () => {
const pane = document.createElement('div');
pane.innerHTML = '<article class="markdown-rendered"><p>one</p><p>two</p></article>';
expect(measurePreviewBlockOffsets(pane, 2)).toBeNull();
});
});
describe('mapScrollPosition', () => {
const source = [0, 100, 300, 600];
const target = [0, 250, 400, 900];
it('maps each anchor exactly onto its paired anchor (blocks stay aligned)', () => {
source.forEach((value, index) => {
expect(mapScrollPosition(value, source, target)).toBeCloseTo(target[index] ?? -1);
});
});
it('linearly interpolates between bracketing anchors', () => {
// Halfway between source[1]=100 and source[2]=300 -> halfway in target.
expect(mapScrollPosition(200, source, target)).toBeCloseTo(325);
});
it('clamps below the first and above the last anchor', () => {
expect(mapScrollPosition(-50, source, target)).toBe(0);
expect(mapScrollPosition(9999, source, target)).toBe(900);
});
it('handles degenerate (zero-length) segments without dividing by zero', () => {
const result = mapScrollPosition(100, [0, 100, 100, 200], [0, 50, 80, 120]);
expect(Number.isFinite(result)).toBe(true);
expect(result).toBeGreaterThanOrEqual(50);
expect(result).toBeLessThanOrEqual(80);
});
});