Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
import { MarkdownManager, sharedExtensions, stripFrontmatter } from '@inkeep/open-knowledge-core';
import { cleanup, fireEvent, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { type Editor, getSchema } from '@tiptap/core';
import type { Node as PmNode } from '@tiptap/pm/model';
import { afterEach, beforeEach, describe, expect, test } from 'vitest';
import * as Y from 'yjs';
import { TooltipProvider } from '@/components/ui/tooltip';
import { setEditorDocName } from '../extensions/doc-context.ts';
import {
clearPendingSourceNavigationsForTest,
peekPendingSourceNavigation,
} from '../source-editor-navigation.ts';
import { VIEW_IN_SOURCE_EVENT, type ViewInSourceDetail } from '../view-in-source-event.ts';
import { ViewInSourceBubbleButton } from './ViewInSourceBubbleButton.tsx';
const md = new MarkdownManager({ extensions: sharedExtensions });
const schema = getSchema(sharedExtensions);
const DOC = '# Title\n\nfirst\n\ntarget paragraph';
function pmPosOfBlock(doc: PmNode, index: number): number {
let pos = 0;
for (let i = 0; i < index; i++) pos += doc.child(i).nodeSize;
return pos + 1;
}
function makeEditor(
markdown: string,
caretBlock: number,
docName: string | null = 'doc-view',
): { editor: Editor; ydoc: Y.Doc } {
const { body } = stripFrontmatter(markdown);
const doc = schema.nodeFromJSON(md.parse(body));
const ydoc = new Y.Doc();
ydoc.getText('source').insert(0, markdown);
const editor = {
isDestroyed: false,
editorView: { state: { doc, selection: { from: pmPosOfBlock(doc, caretBlock) } } },
extensionManager: { extensions: [{ name: 'collaboration', options: { document: ydoc } }] },
} as unknown as Editor;
setEditorDocName(editor, docName);
return { editor, ydoc };
}
function renderButton(editor: Editor, getTargetPosition?: () => number | undefined) {
return render(
<TooltipProvider>
<ViewInSourceBubbleButton editor={editor} getTargetPosition={getTargetPosition} />
</TooltipProvider>,
);
}
let flipped: string[] = [];
let unsubscribe: (() => void) | null = null;
beforeEach(() => {
clearPendingSourceNavigationsForTest();
flipped = [];
const onFlip = (e: Event) => {
flipped.push((e as CustomEvent<ViewInSourceDetail>).detail.docName);
};
window.addEventListener(VIEW_IN_SOURCE_EVENT, onFlip);
unsubscribe = () => window.removeEventListener(VIEW_IN_SOURCE_EVENT, onFlip);
});
afterEach(() => {
unsubscribe?.();
unsubscribe = null;
cleanup();
});
describe('ViewInSourceBubbleButton', () => {
test('a node target at a non-first block boundary lands in that block', async () => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2);
const doc = (editor as unknown as { editorView: { state: { doc: PmNode } } }).editorView.state
.doc;
renderButton(editor, () => doc.child(0).nodeSize);
await user.click(screen.getByTestId('view-in-source-bubble-button'));
const nav = peekPendingSourceNavigation('doc-view');
if (nav?.kind !== 'selection-offset') throw new Error('expected a selection-offset nav');
expect(nav.anchor.blockIndex).toBe(1);
});
test.each(['click', 'keyboard'] as const)(
'a node-bound %s action targets its node instead of an unrelated caret',
async (activation) => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2);
renderButton(editor, () => 0);
const button = screen.getByTestId('view-in-source-bubble-button');
if (activation === 'click') await user.click(button);
else {
button.focus();
await user.keyboard('{Enter}');
}
expect(flipped).toEqual(['doc-view']);
const nav = peekPendingSourceNavigation('doc-view');
if (nav?.kind !== 'selection-offset') throw new Error('expected a selection-offset nav');
expect(nav.anchor.blockIndex).toBe(0);
},
);
test('does not jump to an old caret when a node target is no longer present', async () => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2);
renderButton(editor, () => undefined);
await user.click(screen.getByTestId('view-in-source-bubble-button'));
expect(flipped).toEqual([]);
expect(peekPendingSourceNavigation('doc-view')).toBeNull();
});
test('renders a labelled, native-button entry', () => {
const { editor } = makeEditor(DOC, 2);
renderButton(editor);
const button = screen.getByTestId('view-in-source-bubble-button');
expect(button.tagName).toBe('BUTTON');
expect(button.getAttribute('aria-label')).toBe('View in source markdown');
});
test('clicking jumps to the selection block and asks the pane to flip', async () => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2);
renderButton(editor);
await user.click(screen.getByTestId('view-in-source-bubble-button'));
expect(flipped).toEqual(['doc-view']);
const nav = peekPendingSourceNavigation('doc-view');
if (nav?.kind !== 'selection-offset') throw new Error('expected a selection-offset nav');
expect(nav.intent).toBe('jump');
expect(nav.anchor.blockIndex).toBe(2);
});
test('activates from a keyboard Enter press', async () => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2);
renderButton(editor);
screen.getByTestId('view-in-source-bubble-button').focus();
await user.keyboard('{Enter}');
expect(flipped).toEqual(['doc-view']);
expect(peekPendingSourceNavigation('doc-view')?.kind).toBe('selection-offset');
});
test('activates from a keyboard Space press', async () => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2);
renderButton(editor);
screen.getByTestId('view-in-source-bubble-button').focus();
await user.keyboard('[Space]');
expect(flipped).toEqual(['doc-view']);
expect(peekPendingSourceNavigation('doc-view')?.kind).toBe('selection-offset');
});
test('the action is not bound to mousedown alone, so it never fires from mousedown', () => {
const { editor } = makeEditor(DOC, 2);
renderButton(editor);
fireEvent.mouseDown(screen.getByTestId('view-in-source-bubble-button'));
expect(flipped).toEqual([]);
expect(peekPendingSourceNavigation('doc-view')).toBeNull();
});
test('no-ops when the editor has no registered doc name', async () => {
const user = userEvent.setup();
const { editor } = makeEditor(DOC, 2, null);
renderButton(editor);
await user.click(screen.getByTestId('view-in-source-bubble-button'));
expect(flipped).toEqual([]);
});
});