:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { act, fireEvent, render, waitFor, within } from '@testing-library/react'
import { createElement, useCallback } from 'react'
import { useComponentPanelState } from './componentPanelContext'
import { usePublishNotebookComponentRunHandler } from './componentRunHandlers'
import { MarkdownNotebookJupyterModeConfig, NotebookJupyterCommands, useNotebookJupyterCommands } from './jupyterMode'
import { MarkdownNotebook } from './MarkdownNotebook'
import { createMarkdownNotebookRegistry } from './registry'
import type { NotebookComponentRenderProps, NotebookComponentToolbarProps } from './types'
const runs: string[] = []
function RunPublisher({ node }: NotebookComponentToolbarProps): null {
const code = String(node.props.code)
const run = useCallback(() => runs.push(code), [code])
usePublishNotebookComponentRunHandler({ run })
return null
}
// Monaco cannot run in jsdom; a textarea inside `.monaco-editor` is what the cell treats as its editor.
function CodeEditorStandIn({ node }: NotebookComponentRenderProps): JSX.Element {
return createElement(
'div',
{ className: 'monaco-editor' },
createElement('textarea', { 'data-attr': 'cell-editor', defaultValue: String(node.props.code ?? '') })
)
}
const registry = createMarkdownNotebookRegistry([
{
tagName: 'Comment',
label: 'Comment',
category: 'Text',
ViewComponent: () => createElement('div', null, 'A discussion'),
},
{
tagName: 'Py',
label: 'Python',
category: 'Code',
defaultProps: { code: '' },
insertCommand: {},
ViewComponent: () =>
createElement('div', null, 'output', useComponentPanelState()?.jupyterOutputPrompt?.(false)),
EditComponent: CodeEditorStandIn,
ToolbarComponent: RunPublisher,
},
{
tagName: 'Sql',
label: 'SQL',
category: 'Code',
defaultProps: { code: '' },
insertCommand: {},
ViewComponent: () =>
createElement('div', null, 'output', useComponentPanelState()?.jupyterOutputPrompt?.(false)),
EditComponent: CodeEditorStandIn,
},
])
const jupyterMode: MarkdownNotebookJupyterModeConfig = {
cellTagNames: ['Py', 'Sql'],
newCellTagName: 'Py',
getCellSource: (node) => String(node.props.code ?? ''),
withCellSource: (node, source) => ({ ...node, props: { ...node.props, code: source } }),
}
let commands: NotebookJupyterCommands | null = null
function CommandsProbe(): null {
commands = useNotebookJupyterCommands()
return null
}
function renderJupyterNotebook(markdown: string): {
container: HTMLElement
latest: () => string
cell: (index: number) => HTMLElement
editor: (index: number) => HTMLTextAreaElement
sink: () => HTMLElement
unmount: () => void
} {
runs.length = 0
const onChange = jest.fn()
const { container, unmount } = render(
createElement(MarkdownNotebook, {
value: markdown,
onChange,
registry,
jupyterMode,
canvasHeader: createElement(CommandsProbe),
})
)
const cell = (index: number): HTMLElement =>
container.querySelectorAll<HTMLElement>('[data-attr="notebook-jupyter-cell"]')[index]
return {
container,
unmount,
latest: () => (onChange.mock.calls.at(-1)?.[0] as string | undefined) ?? markdown,
cell,
editor: (index) => cell(index).querySelector('[data-attr="cell-editor"]') as HTMLTextAreaElement,
sink: () => container.querySelector('[data-attr="notebook-jupyter-command-sink"]') as HTMLElement,
}
}
function press(element: HTMLElement, key: string, modifiers: Partial<KeyboardEventInit> = {}): void {
act(() => {
fireEvent.keyDown(element, { key, ...modifiers })
})
}
// requestAnimationFrame-deferred focus moves run before the next assertion.
async function flushFrames(): Promise<void> {
await act(async () => {
await new Promise((resolve) => setTimeout(resolve, 50))
})
}
const TWO_CELLS = '# Title\n\nIntro\n\n<Py code="a = 1" />\n\n<Py code="b = 2" />'
describe('MarkdownNotebook in Jupyter mode', () => {
it.each([
['text to output', false, false],
['output to text', true, false],
['text to output backwards', false, true],
['output to text backwards', true, true],
])('extends a drag across cell boundaries: %s', (_label, startsInOutput, backwards) => {
jest.useFakeTimers()
const notebook = renderJupyterNotebook(
'# Title\n\nBefore text here\n\n<Py code="a = 1" />\n\n<Sql code="select 1" />\n\nAfter text here'
)
const textBlocks = notebook.container.querySelectorAll('.MarkdownNotebook__text-block')
const outputs = notebook.container.querySelectorAll('.MarkdownNotebook__jupyter-output')
const first = (startsInOutput ? outputs[0].firstChild! : textBlocks[1]) as HTMLElement
const last = (startsInOutput ? textBlocks[2] : outputs[1].firstChild!) as HTMLElement
const start = backwards ? last : first
const end = backwards ? first : last
const startOffset = backwards ? (startsInOutput ? 5 : 3) : startsInOutput ? 2 : 7
const endOffset = backwards ? (startsInOutput ? 2 : 7) : startsInOutput ? 5 : 3
const caret = document.createRange()
caret.setStart(end.firstChild!, endOffset)
caret.collapse(true)
const caretDocument = document as Document & { caretRangeFromPoint?: () => Range }
const originalCaretRangeFromPoint = caretDocument.caretRangeFromPoint
caretDocument.caretRangeFromPoint = () => caret
try {
fireEvent.mouseDown(start, { button: 0 })
act(() => window.getSelection()!.collapse(start.firstChild!, startOffset))
fireEvent.mouseMove(document, { buttons: 1, clientX: 10, clientY: 20 })
if (!backwards) {
act(() => jest.advanceTimersByTime(16))
}
fireEvent.mouseUp(document)
fireEvent(document, new Event('selectionchange'))
expect(notebook.container.querySelectorAll('.MarkdownNotebook__component-shell--selected')).toHaveLength(2)
const clipboardData = { setData: jest.fn() }
fireEvent.copy(notebook.container.querySelector('.MarkdownNotebook')!, { clipboardData })
expect(clipboardData.setData).toHaveBeenCalledWith(
'text/markdown',
startsInOutput
? '<Py code="a = 1" />\n\n<Sql code="select 1" />\n\nAfter'
: 'text here\n\n<Py code="a = 1" />\n\n<Sql code="select 1" />'
)
} finally {
caretDocument.caretRangeFromPoint = originalCaretRangeFromPoint
jest.useRealTimers()
}
})
it.each(['Backspace', 'Delete'])('deletes only the focused discussion thread with %s', (key) => {
const notebook = renderJupyterNotebook(
'# Title\n\n<Comment ref="note" replies={[]} />\n\nA <ref id="note">useful</ref> paragraph.\n\nAnother paragraph.'
)
const thread = notebook.container.querySelector<HTMLElement>('.MarkdownNotebook__component-shell')!
act(() => thread.focus())
press(thread, key)
expect(notebook.latest()).toEqual('# Title\n\nA useful paragraph.\n\nAnother paragraph.')
})
it.each([
['Add Python', 'Py'],
['Add SQL', 'Sql'],
])('%s appends the requested code cell and focuses its editor', async (label, tagName) => {
const notebook = renderJupyterNotebook(TWO_CELLS)
fireEvent.click(within(notebook.container).getByText(label))
await waitFor(() => expect(document.activeElement).toBe(notebook.editor(2)))
expect(notebook.latest()).toEqual(`${TWO_CELLS}\n\n<${tagName} code="" />`)
})
it('Add text starts a separate markdown cell ready for typing', async () => {
const notebook = renderJupyterNotebook('# Title\n\nExisting text')
fireEvent.click(within(notebook.container).getByText('Add text'))
const newParagraph = notebook.container.querySelectorAll<HTMLElement>('.MarkdownNotebook__text-block')[2]
await waitFor(() => expect(document.activeElement).toBe(newParagraph))
expect(newParagraph.textContent).toBe('')
newParagraph.textContent = 'More text'
fireEvent.input(newParagraph)
expect(notebook.latest()).toEqual('# Title\n\nExisting text\n\n\nMore text')
})
it('the footer slash button opens the insert menu at the end', async () => {
const notebook = renderJupyterNotebook(TWO_CELLS)
fireEvent.click(within(notebook.container).getByLabelText('Add a cell'))
const menu = await within(notebook.container).findByRole('listbox')
fireEvent.click(within(menu).getByText('Python'))
expect(notebook.latest()).toEqual(`${TWO_CELLS}\n\n\n<Py code="" />`)
})
it.each([
[
'A inserts a cell above',
['a'],
'# Title\n\nIntro\n\n<Py code="" />\n\n<Py code="a = 1" />\n\n<Py code="b = 2" />',
],
[
'B inserts a cell below',
['b'],
'# Title\n\nIntro\n\n<Py code="a = 1" />\n\n<Py code="" />\n\n<Py code="b = 2" />',
],
['D, D deletes the cell', ['d', 'd'], '# Title\n\nIntro\n\n<Py code="b = 2" />'],
['Delete deletes the cell', ['Delete'], '# Title\n\nIntro\n\n<Py code="b = 2" />'],
['D, D then Z restores the cell', ['d', 'd', 'z'], TWO_CELLS],
[
'C then V pastes a copy below',
['c', 'v'],
'# Title\n\nIntro\n\n<Py code="a = 1" />\n\n<Py code="a = 1" />\n\n<Py code="b = 2" />',
],
['M turns the code into markdown', ['m'], '# Title\n\nIntro\n\n\na = 1\n\n<Py code="b = 2" />'],
['Shift+M merges with the cell below', ['M+shift'], '# Title\n\nIntro\n\n<Py code="a = 1\\n\\nb = 2" />'],
[
'Cmd+Shift+Down moves the cell down',
['ArrowDown+meta+shift'],
'# Title\n\nIntro\n\n<Py code="b = 2" />\n\n<Py code="a = 1" />',
],
])('%s', async (_, keys, expected) => {
const notebook = renderJupyterNotebook(TWO_CELLS)
act(() => notebook.cell(0).focus())
for (const combo of keys) {
const [key, ...modifiers] = combo.split('+')
press(document.activeElement as HTMLElement, key, {
shiftKey: modifiers.includes('shift'),
metaKey: modifiers.includes('meta'),
})
await flushFrames()
}
expect(notebook.latest()).toEqual(expected)
})
it.each([
['code', false],
['markdown', false],
['multiple', false],
['code', true],
['markdown', true],
['multiple', true],
])('copies or cuts selected %s cells through the system clipboard (cut: %s)', async (kind, cut) => {
const notebook = renderJupyterNotebook(
'# Title\n\n<Py nodeId="original" code="a = 1" />\n\nOne\n\nTwo\n\n<Sql code="select 1" />'
)
act(() => notebook.cell(0).focus())
if (kind === 'markdown') {
press(notebook.cell(0), 'ArrowDown')
} else if (kind === 'multiple') {
press(notebook.cell(0), 'ArrowDown', { shiftKey: true })
}
const target = document.activeElement as HTMLElement
const clipboard = new Map<string, string>()
const clipboardData = {
setData: (type: string, value: string) => clipboard.set(type, value),
getData: (type: string) => clipboard.get(type) ?? '',
}
for (const modifier of [{ metaKey: true }, { ctrlKey: true }]) {
expect(fireEvent.keyDown(target, { key: cut ? 'x' : 'c', ...modifier })).toBe(true)
}
expect(fireEvent[cut ? 'cut' : 'copy'](target, { clipboardData })).toBe(false)
const copied = clipboard.get('text/markdown')!
expect(clipboard.get('text/plain')).toEqual(copied)
expect(copied).not.toContain('# Title')
expect(copied).not.toContain('select 1')
expect(copied.includes('a = 1')).toBe(kind !== 'markdown')
expect(copied.includes('One\n\nTwo')).toBe(kind !== 'code')
if (cut) {
expect(notebook.latest().includes('a = 1')).toBe(kind === 'markdown')
expect(notebook.latest().includes('One\n\nTwo')).toBe(kind === 'code')
expect(notebook.latest()).toContain('# Title')
}
const destination = renderJupyterNotebook('# Destination\n\n<Py code="target" />\n\nAfter')
act(() => destination.cell(0).focus())
if (kind !== 'code') {
press(destination.cell(0), 'ArrowDown')
}
const pasteTarget = document.activeElement as HTMLElement
for (const modifier of [{ metaKey: true }, { ctrlKey: true }]) {
expect(fireEvent.keyDown(pasteTarget, { key: 'v', ...modifier })).toBe(true)
}
expect(fireEvent.paste(pasteTarget, { clipboardData })).toBe(false)
await waitFor(() => {
expect(destination.latest()).toContain(kind === 'code' ? 'a = 1' : 'One\n\nTwo')
})
expect(destination.latest()).not.toContain('nodeId="original"')
if (kind === 'code') {
expect(destination.latest().indexOf('a = 1')).toBeLessThan(destination.latest().indexOf('After'))
} else {
expect(destination.latest().indexOf('After')).toBeLessThan(
destination.latest().indexOf(kind === 'markdown' ? 'One' : 'a = 1')
)
}
if (kind === 'markdown') {
expect(destination.latest()).toContain('\n\n\nOne\n\nTwo')
}
})
it.each(['copy', 'cut', 'paste'] as const)('leaves native %s inside a code editor alone', (eventType) => {
const notebook = renderJupyterNotebook(TWO_CELLS)
act(() => notebook.editor(0).focus())
const clipboardData = { setData: jest.fn(), getData: () => 'ordinary text' }
expect(fireEvent[eventType](notebook.editor(0), { clipboardData })).toBe(true)
expect(clipboardData.setData).not.toHaveBeenCalled()
expect(notebook.latest()).toEqual(TWO_CELLS)
})
it('keeps a markdown cell whole when a code cell moves up past it', async () => {
const notebook = renderJupyterNotebook(
'# Title\n\nIntro\n\n<Py code="a = 1" />\n\n\nOne\n\nTwo\n\n<Py code="b = 2" />'
)
act(() => notebook.cell(1).focus())
press(notebook.cell(1), 'ArrowUp', { shiftKey: true, metaKey: true })
await flushFrames()
expect(notebook.latest()).toEqual(
'# Title\n\nIntro\n\n<Py code="a = 1" />\n\n<Py code="b = 2" />\n\n\nOne\n\nTwo'
)
})
it.each(['previous', 'next'] as const)('focuses hidden input when moving to the %s cell', async (direction) => {
const notebook = renderJupyterNotebook(TWO_CELLS)
const targetIndex = direction === 'previous' ? 0 : 1
const sourceIndex = 1 - targetIndex
fireEvent.click(within(notebook.cell(targetIndex)).getByLabelText('Hide input'))
act(() => notebook.editor(sourceIndex).focus())
act(() => commands!.moveEditFocus(commands!.store.getState().activeCellId!, direction))
await waitFor(() => expect(document.activeElement).toBe(notebook.editor(targetIndex)))
})
it.each([
['Py', false],
['Sql', false],
['Py', true],
])('keeps one %s section visible and restores hidden sections (legacy collapse: %s)', async (tag, bothHidden) => {
const toggleVisibility = (cell: HTMLElement, label: string): void => {
const prompt = within(cell).getByLabelText(label)
act(() => prompt.focus())
fireEvent.click(prompt)
expect(document.activeElement).toBe(cell)
}
const notebook = renderJupyterNotebook(
`# Title\n\n<${tag} code="original source"${bothHidden ? ' hideInput hideResults' : ''} />`
)
if (bothHidden) {
expect(notebook.editor(0).value).toBe('original source')
toggleVisibility(notebook.cell(0), 'Show output')
expect(notebook.editor(0).value).toBe('original source')
}
toggleVisibility(notebook.cell(0), 'Hide input')
expect(notebook.editor(0)).toBeNull()
expect(within(notebook.cell(0)).getByText('output')).toBeTruthy()
expect(within(notebook.cell(0)).getByLabelText('Show input').classList.contains('line-through')).toBe(true)
fireEvent.click(within(notebook.cell(0)).getByLabelText('Hide output'))
press(document.activeElement as HTMLElement, 'o')
expect(within(notebook.cell(0)).getByText('output')).toBeTruthy()
expect(notebook.editor(0)).toBeNull()
const saved = notebook.latest()
notebook.unmount()
const reopened = renderJupyterNotebook(saved)
expect(reopened.editor(0)).toBeNull()
expect(within(reopened.cell(0)).getByText('output')).toBeTruthy()
toggleVisibility(reopened.cell(0), 'Show input')
expect(reopened.editor(0).value).toBe('original source')
toggleVisibility(reopened.cell(0), 'Hide output')
expect(within(reopened.cell(0)).queryByText('output')).toBeNull()
expect(within(reopened.cell(0)).getByLabelText('Show output').classList.contains('line-through')).toBe(true)
fireEvent.click(within(reopened.cell(0)).getByLabelText('Hide input'))
expect(reopened.editor(0).value).toBe('original source')
expect(within(reopened.cell(0)).queryByText('output')).toBeNull()
toggleVisibility(reopened.cell(0), 'Show output')
toggleVisibility(reopened.cell(0), 'Hide input')
press(document.activeElement as HTMLElement, 'Enter')
await waitFor(() => expect(document.activeElement).toBe(reopened.editor(0)))
expect(reopened.editor(0).value).toBe('original source')
})
it('never turns keys typed in a code editor into cell commands', () => {
const notebook = renderJupyterNotebook(TWO_CELLS)
for (const key of ['a', 'b', 'd', 'd', 'm', 'Delete', 'Backspace']) {
press(notebook.editor(0), key)
}
expect(notebook.latest()).toEqual(TWO_CELLS)
})
it.each([null, 'Hide input', 'Hide output'])(
'runs with Shift+Enter, selects the next cell, and appends a cell (visibility action: %s)',
async (visibilityAction) => {
const notebook = renderJupyterNotebook(TWO_CELLS)
if (visibilityAction) {
const prompt = within(notebook.cell(0)).getByLabelText(visibilityAction)
act(() => prompt.focus())
fireEvent.click(prompt)
} else {
act(() => notebook.editor(0).focus())
}
const beforeAppend = notebook.latest()
press(document.activeElement as HTMLElement, 'Enter', { shiftKey: true })
await flushFrames()
expect(runs).toEqual(['a = 1'])
expect(document.activeElement).toBe(notebook.cell(1))
press(notebook.cell(1), 'Enter', { shiftKey: true })
await flushFrames()
expect(runs).toEqual(['a = 1', 'b = 2'])
expect(notebook.latest()).toEqual(`${beforeAppend}\n\n<Py code="" />`)
}
)
it('selects a markdown cell in command mode, where letter keys act on it instead of typing', async () => {
const notebook = renderJupyterNotebook(TWO_CELLS)
act(() => notebook.cell(0).focus())
press(notebook.cell(0), 'k')
await flushFrames()
expect(document.activeElement).toBe(notebook.sink())
// Y turns the markdown cell into code; the title row stays text.
press(notebook.sink(), 'y')
await flushFrames()
expect(notebook.latest()).toEqual(
'# Title\n\n<Py code="Intro" />\n\n<Py code="a = 1" />\n\n<Py code="b = 2" />'
)
})
it('keeps Shift+Enter as text input until Escape switches to cell commands', async () => {
const markdown = '# Title\n\nIntro'
const notebook = renderJupyterNotebook(markdown)
const intro = [...notebook.container.querySelectorAll<HTMLElement>('[data-markdown-notebook-node-id]')].find(
(element) => element.textContent === 'Intro'
)!
act(() => {
intro.focus()
const range = document.createRange()
range.setStart(intro.firstChild ?? intro, 0)
window.getSelection()?.removeAllRanges()
window.getSelection()?.addRange(range)
})
const canvas = notebook.container.querySelector('.MarkdownNotebook__canvas') as HTMLElement
expect(fireEvent.keyDown(canvas, { key: 'Enter', shiftKey: true })).toBe(true)
expect(notebook.latest()).toEqual(markdown)
press(canvas, 'Escape')
await flushFrames()
expect(document.activeElement).toBe(notebook.sink())
press(notebook.sink(), 'Enter', { shiftKey: true })
await flushFrames()
expect(notebook.latest()).toEqual('# Title\n\nIntro\n\n<Py code="" />')
})
it('deletes every cell picked with Shift+Down', async () => {
const notebook = renderJupyterNotebook(`${TWO_CELLS}\n\n<Py code="c = 3" />`)
act(() => notebook.cell(0).focus())
press(notebook.cell(0), 'ArrowDown', { shiftKey: true })
press(document.activeElement as HTMLElement, 'd')
press(document.activeElement as HTMLElement, 'd')
await flushFrames()
expect(notebook.latest()).toEqual('# Title\n\nIntro\n\n<Py code="c = 3" />')
})
it('splits a code cell at an offset into two cells, keeping the cell type', () => {
const notebook = renderJupyterNotebook(TWO_CELLS)
act(() => notebook.cell(0).focus())
act(() => commands!.splitCell(commands!.store.getState().activeCellId!, 'a = 1'.length))
expect(notebook.latest()).toEqual(
'# Title\n\nIntro\n\n<Py code="a = 1" />\n\n<Py code="" />\n\n<Py code="b = 2" />'
)
})
it('removes a cell emptied in its editor and edits the end of the cell above', async () => {
const notebook = renderJupyterNotebook('# Title\n\nIntro\n\n<Py code="a = 1" />\n\n<Py code="" />')
act(() => notebook.cell(1).focus())
act(() => commands!.deleteEmptyCell(commands!.store.getState().activeCellId!))
await flushFrames()
expect(notebook.latest()).toEqual('# Title\n\nIntro\n\n<Py code="a = 1" />')
})
})