@vertesia/ui 1.5.0-dev.20260717.131047Z → 1.5.0-dev.20260725.083715Z

package/src/widgets/markdown/CollaborativeMarkdownRenderer.test.tsx

@@ -0,0 +1,484 @@
+/** @vitest-environment jsdom */
+
+import { cleanup, fireEvent, render, screen, waitFor, within } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import type { Element } from 'hast';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { I18nProvider } from '../../i18n/index.js';
+import {
+    applyMarkdownEditingChange,
+    CollaborativeMarkdownRenderer,
+    createMarkdownBlockAnchor,
+    formatMarkdownEditingAction,
+    type MarkdownEditingAction,
+} from './CollaborativeMarkdownRenderer.js';
+
+afterEach(() => {
+    cleanup();
+});
+
+function elementAt(start: number, end: number): Element {
+    return {
+        type: 'element',
+        tagName: 'p',
+        properties: {},
+        children: [],
+        position: {
+            start: { line: 1, column: start + 1, offset: start },
+            end: { line: 1, column: end + 1, offset: end },
+        },
+    };
+}
+
+describe('collaborative Markdown actions', () => {
+    it('anchors a block with its range and surrounding source context', () => {
+        const markdown = 'Before\n\nSelected paragraph\n\nAfter';
+        const start = markdown.indexOf('Selected');
+        const end = start + 'Selected paragraph'.length;
+
+        expect(createMarkdownBlockAnchor(markdown, elementAt(start, end), 'paragraph')).toEqual({
+            block_id: `paragraph:${start}:${end}`,
+            block_type: 'paragraph',
+            source_range: { start, end },
+            exact_text: 'Selected paragraph',
+            prefix: 'Before\n\n',
+            suffix: '\n\nAfter',
+            occurrence_index: 0,
+        });
+    });
+
+    it('disambiguates repeated blocks under the same heading', () => {
+        const markdown = '# Section\n\nRepeated\n\nRepeated';
+        const start = markdown.lastIndexOf('Repeated');
+        const end = start + 'Repeated'.length;
+
+        expect(createMarkdownBlockAnchor(markdown, elementAt(start, end), 'paragraph')).toEqual(
+            expect.objectContaining({
+                heading_path: ['Section'],
+                exact_text: 'Repeated',
+                occurrence_index: 1,
+            }),
+        );
+    });
+
+    it('formats a direct artifact edit as an actionable agent message', () => {
+        const action: MarkdownEditingAction = {
+            operation_id: 'operation-1',
+            resource: { kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' },
+            base_version: 'etag-1',
+            action: 'edit',
+            anchor: {
+                block_id: 'paragraph:0:3',
+                block_type: 'paragraph',
+                exact_text: 'Old',
+            },
+            user_change: { before: 'Old', after: 'New' },
+        };
+
+        expect(formatMarkdownEditingAction(action)).toContain('artifact:draft.md (run run-1)');
+        expect(formatMarkdownEditingAction(action)).toContain('Before:\n```markdown\nOld');
+        expect(formatMarkdownEditingAction(action)).toContain('After:\n```markdown\nNew');
+    });
+
+    it('uses a longer message fence when selected source contains a fenced code block', () => {
+        const action: MarkdownEditingAction = {
+            operation_id: 'operation-1',
+            resource: { kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' },
+            action: 'comment',
+            anchor: {
+                block_id: 'code_block:0:21',
+                block_type: 'code_block',
+                exact_text: '```ts\nconst n = 1;\n```',
+            },
+            comment: 'Rename this variable.',
+        };
+
+        expect(formatMarkdownEditingAction(action)).toContain(
+            'Selected content:\n````markdown\n```ts\nconst n = 1;\n```\n````',
+        );
+    });
+
+    it('submits a comment with the selected source block and version', async () => {
+        const onAction = vi.fn();
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-1' }}
+                    baseVersion="etag-1"
+                    onAction={onAction}
+                >
+                    {'First paragraph.\n\nSecond paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        const selectedBlock = screen.getByText('Second paragraph.').parentElement;
+        if (!selectedBlock) throw new Error('Expected the paragraph to have a collaborative block parent');
+        fireEvent.click(within(selectedBlock).getByRole('button', { name: 'Comment on selection' }));
+        fireEvent.change(within(selectedBlock).getByRole('textbox'), {
+            target: { value: 'Make this more specific.' },
+        });
+        fireEvent.click(screen.getByRole('button', { name: 'Send' }));
+
+        await waitFor(() => expect(onAction).toHaveBeenCalledTimes(1));
+        expect(onAction).toHaveBeenCalledWith(
+            expect.objectContaining({
+                resource: { kind: 'store_document', document_id: 'document-1' },
+                base_version: 'etag-1',
+                action: 'comment',
+                comment: 'Make this more specific.',
+                anchor: expect.objectContaining({
+                    block_type: 'paragraph',
+                    exact_text: 'Second paragraph.',
+                }),
+            }),
+        );
+    });
+
+    it('briefly highlights blocks that changed between document revisions', async () => {
+        const onAction = vi.fn();
+        const { rerender } = render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-1' }}
+                    onAction={onAction}
+                >
+                    {'Original paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        rerender(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-2' }}
+                    highlightChangesFrom="Original paragraph."
+                    highlightVersion={1}
+                    onAction={onAction}
+                >
+                    {'Updated paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        await waitFor(() => {
+            expect(screen.getByText('Updated paragraph.').parentElement?.className).toContain('bg-mixer-success/15');
+        });
+    });
+
+    it('preserves a typed draft when a document refresh invalidates its block anchor', async () => {
+        const onAction = vi.fn();
+        const { rerender } = render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-1' }}
+                    onAction={onAction}
+                >
+                    {'Original paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        const selectedBlock = screen.getByText('Original paragraph.').parentElement;
+        if (!selectedBlock) throw new Error('Expected a collaborative block parent');
+        fireEvent.click(within(selectedBlock).getByRole('button', { name: 'Comment on selection' }));
+        fireEvent.change(within(selectedBlock).getByRole('textbox'), {
+            target: { value: 'Keep this draft recoverable.' },
+        });
+
+        rerender(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-2' }}
+                    onAction={onAction}
+                >
+                    {'Inserted paragraph.\n\nOriginal paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        await waitFor(() => {
+            expect(screen.getByText('Your draft was preserved')).not.toBeNull();
+            expect(screen.getByDisplayValue('Keep this draft recoverable.')).not.toBeNull();
+        });
+    });
+
+    it('keeps source anchors aligned when normal rendering would rewrite earlier Markdown', async () => {
+        const onAction = vi.fn();
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-1' }}
+                    onAction={onAction}
+                >
+                    {'Revenue was between $100M and $500M.\n\nKeep this exact.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        const selectedBlock = screen.getByText('Keep this exact.').parentElement;
+        if (!selectedBlock) throw new Error('Expected the paragraph to have a collaborative block parent');
+        fireEvent.click(within(selectedBlock).getByRole('button', { name: 'Comment on selection' }));
+        fireEvent.change(within(selectedBlock).getByRole('textbox'), {
+            target: { value: 'Add evidence.' },
+        });
+        fireEvent.click(screen.getByRole('button', { name: 'Send' }));
+
+        await waitFor(() => expect(onAction).toHaveBeenCalledTimes(1));
+        expect(onAction).toHaveBeenCalledWith(
+            expect.objectContaining({
+                anchor: expect.objectContaining({
+                    exact_text: 'Keep this exact.',
+                    source_range: {
+                        start: 'Revenue was between $100M and $500M.\n\n'.length,
+                        end: 'Revenue was between $100M and $500M.\n\nKeep this exact.'.length,
+                    },
+                }),
+            }),
+        );
+    });
+
+    it('hides editing controls on a read-only surface', () => {
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' }}
+                    readOnly
+                    onAction={vi.fn()}
+                >
+                    {'Read only paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        expect(screen.queryByRole('button', { name: 'Comment on selection' })).toBeNull();
+        expect(screen.queryByRole('button', { name: 'Edit selection' })).toBeNull();
+    });
+
+    it('keeps comments enabled while content mutations are locked', async () => {
+        const onAction = vi.fn();
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' }}
+                    readOnly
+                    allowComments
+                    onAction={onAction}
+                >
+                    {'Locked paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        expect(screen.queryByRole('button', { name: 'Edit selection' })).toBeNull();
+        fireEvent.click(screen.getByRole('button', { name: 'Comment on selection' }));
+        fireEvent.change(screen.getByRole('textbox'), { target: { value: 'Add supporting evidence.' } });
+        fireEvent.click(screen.getByRole('button', { name: 'Send' }));
+
+        await waitFor(() => expect(onAction).toHaveBeenCalledTimes(1));
+        expect(onAction).toHaveBeenCalledWith(
+            expect.objectContaining({
+                action: 'comment',
+                comment: 'Add supporting evidence.',
+                anchor: expect.objectContaining({ exact_text: 'Locked paragraph.' }),
+            }),
+        );
+    });
+
+    it('prevents an open component editor from submitting after the surface becomes read-only', () => {
+        const onAction = vi.fn();
+        const view = render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' }}
+                    onAction={onAction}
+                >
+                    {'Editable paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        fireEvent.click(screen.getByRole('button', { name: 'Comment on selection' }));
+        fireEvent.change(screen.getByRole('textbox'), { target: { value: 'Keep this draft.' } });
+
+        view.rerender(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' }}
+                    readOnly
+                    onAction={onAction}
+                >
+                    {'Editable paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        expect(screen.getByRole('textbox')).toHaveProperty('disabled', true);
+        const sendButton = screen.getByRole('button', { name: 'Send' });
+        expect(sendButton).toHaveProperty('disabled', true);
+        fireEvent.click(sendButton);
+        expect(onAction).not.toHaveBeenCalled();
+    });
+
+    it('selects a list as one group instead of individual bullets', async () => {
+        const onAction = vi.fn();
+        const markdown = '- First bullet\n- Second bullet';
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-1' }}
+                    onAction={onAction}
+                >
+                    {markdown}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        // One control set for the whole list, none per bullet.
+        expect(screen.getAllByRole('button', { name: 'Comment on selection' })).toHaveLength(1);
+
+        fireEvent.click(screen.getByRole('button', { name: 'Edit selection' }));
+        fireEvent.change(screen.getByRole('textbox'), {
+            target: { value: '- First bullet\n- Second bullet\n- Third bullet' },
+        });
+        fireEvent.click(screen.getByRole('button', { name: 'Send' }));
+
+        await waitFor(() => expect(onAction).toHaveBeenCalledTimes(1));
+        expect(onAction).toHaveBeenCalledWith(
+            expect.objectContaining({
+                action: 'edit',
+                anchor: expect.objectContaining({
+                    block_type: 'list',
+                    exact_text: '- First bullet\n- Second bullet',
+                }),
+                user_change: {
+                    before: '- First bullet\n- Second bullet',
+                    after: '- First bullet\n- Second bullet\n- Third bullet',
+                },
+            }),
+        );
+    });
+
+    it('uses the rich component editor for a selected block', async () => {
+        // delay:null types synchronously so ProseMirror doesn't drop characters between renders.
+        const user = userEvent.setup({ delay: null });
+        const onAction = vi.fn();
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'store_document', document_id: 'document-1' }}
+                    onAction={onAction}
+                >
+                    {'Original paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        fireEvent.click(screen.getByRole('button', { name: 'Edit selection' }));
+        const editor = await screen.findByRole('textbox');
+        // Wait for the draft to hydrate, then select the whole paragraph and paste the replacement
+        // in one operation — char-by-char typing races ProseMirror in jsdom and drops chars.
+        await waitFor(() => expect(editor.textContent ?? '').toContain('Original paragraph.'));
+        await user.tripleClick(editor);
+        await user.paste('Revised paragraph.');
+        fireEvent.click(screen.getByRole('button', { name: 'Send' }));
+
+        await waitFor(() => expect(onAction).toHaveBeenCalledTimes(1));
+        expect(onAction).toHaveBeenCalledWith(
+            expect.objectContaining({
+                action: 'edit',
+                user_change: {
+                    before: 'Original paragraph.',
+                    after: expect.stringContaining('Revised paragraph.'),
+                },
+            }),
+        );
+    });
+
+    it('inserts a new component after a selected block as an already-applicable edit', async () => {
+        const user = userEvent.setup({ delay: null });
+        const onAction = vi.fn();
+        render(
+            <I18nProvider lng="en">
+                <CollaborativeMarkdownRenderer
+                    resource={{ kind: 'agent_artifact', run_id: 'run-1', path: 'draft.md' }}
+                    onAction={onAction}
+                >
+                    {'Original paragraph.'}
+                </CollaborativeMarkdownRenderer>
+            </I18nProvider>,
+        );
+
+        await user.click(screen.getByRole('button', { name: 'Insert component after this block' }));
+        await user.click(await screen.findByRole('menuitem', { name: 'Paragraph' }));
+
+        const editor = await screen.findByRole('textbox');
+        await user.click(editor);
+        // Paste in one operation — char-by-char typing races ProseMirror in jsdom and drops chars.
+        await user.paste('Inserted paragraph.');
+        await waitFor(() => expect(editor.textContent ?? '').toContain('Inserted paragraph.'));
+        fireEvent.click(screen.getByRole('button', { name: 'Send' }));
+
+        await waitFor(() => expect(onAction).toHaveBeenCalledTimes(1));
+        expect(onAction).toHaveBeenCalledWith(
+            expect.objectContaining({
+                action: 'edit',
+                user_change: {
+                    before: 'Original paragraph.',
+                    after: expect.stringMatching(/^Original paragraph\.\n\n.*Inserted paragraph\.$/),
+                },
+            }),
+        );
+    });
+
+    it('applies an anchored edit to the markdown source', () => {
+        const markdown = '# Title\n\n- First bullet\n- Second bullet\n\nTail paragraph.';
+        const start = markdown.indexOf('- First');
+        const end = markdown.indexOf('\n\nTail');
+        const action: MarkdownEditingAction = {
+            operation_id: 'operation-1',
+            resource: { kind: 'store_document', document_id: 'document-1' },
+            action: 'edit',
+            anchor: {
+                block_id: `list:${start}:${end}`,
+                block_type: 'list',
+                source_range: { start, end },
+                exact_text: markdown.slice(start, end),
+            },
+            user_change: {
+                before: markdown.slice(start, end),
+                after: '- First bullet\n- Second bullet\n- Third bullet',
+            },
+        };
+
+        expect(applyMarkdownEditingChange(markdown, action)).toBe(
+            '# Title\n\n- First bullet\n- Second bullet\n- Third bullet\n\nTail paragraph.',
+        );
+    });
+
+    it('recovers a shifted anchor through its prefix context and rejects ambiguity', () => {
+        const shifted: MarkdownEditingAction = {
+            operation_id: 'operation-2',
+            resource: { kind: 'store_document', document_id: 'document-1' },
+            action: 'edit',
+            anchor: {
+                block_id: 'paragraph:0:0',
+                block_type: 'paragraph',
+                source_range: { start: 0, end: 6 },
+                exact_text: 'Target',
+                prefix: 'Intro.\n\n',
+            },
+            user_change: { before: 'Target', after: 'Changed' },
+        };
+
+        // The range no longer matches, but the prefix disambiguates the occurrence.
+        expect(applyMarkdownEditingChange('Header.\n\nIntro.\n\nTarget', shifted)).toBe('Header.\n\nIntro.\n\nChanged');
+        // Range mismatch, two occurrences, and no usable prefix: refuse to guess.
+        expect(
+            applyMarkdownEditingChange('Intro.\n\nTarget\n\nTarget', {
+                ...shifted,
+                anchor: { ...shifted.anchor, prefix: undefined },
+            }),
+        ).toBeUndefined();
+    });
+});