: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 '@testing-library/jest-dom'
import { cleanup, render, screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { Provider } from 'kea'
import posthog from 'posthog-js'
import { initKeaTests } from '~/test/init'
import { ErrorBoundary } from './ErrorBoundary'
const REMOVE_CHILD_MESSAGE =
"Failed to execute 'removeChild' on 'Node': The node to be removed is not a child of this node."
let renderAttempts = 0
let throwUntilAttempt = 0
let thrownMessage = REMOVE_CHILD_MESSAGE
let thrownValue: unknown = undefined
/**
* Throws on every render attempt up to `throwUntilAttempt`. React retries a failed render twice
* before it gives the error to a boundary, so three throws is the smallest count that reaches one.
*/
function Unstable(): JSX.Element {
renderAttempts += 1
if (renderAttempts <= throwUntilAttempt) {
throw thrownValue !== undefined ? thrownValue : new Error(thrownMessage)
}
return <div>recovered content</div>
}
describe('ErrorBoundary', () => {
let consoleErrorSpy: jest.SpyInstance
beforeEach(() => {
initKeaTests()
renderAttempts = 0
throwUntilAttempt = 0
thrownMessage = REMOVE_CHILD_MESSAGE
thrownValue = undefined
consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {})
})
afterEach(() => {
cleanup()
consoleErrorSpy.mockRestore()
})
function renderBoundary(exceptionProps?: Record<string, string>): void {
render(
<Provider>
<ErrorBoundary exceptionProps={exceptionProps}>
<Unstable />
</ErrorBoundary>
</Provider>
)
}
// A translated page throws on the commit that touches a replaced text node, and a fresh render
// of the same subtree succeeds. Before the remount, that one commit cost the user the scene.
it('remounts its children after a DOM mutation error, with no crash screen', async () => {
throwUntilAttempt = 3
renderBoundary()
expect(await screen.findByText('recovered content')).toBeInTheDocument()
expect(screen.queryByText('An error has occurred')).not.toBeInTheDocument()
})
it('stops remounting and shows the fallback when the DOM mutation error repeats', async () => {
throwUntilAttempt = Number.POSITIVE_INFINITY
renderBoundary()
expect(await screen.findByText('An error has occurred')).toBeInTheDocument()
expect(screen.getByText(/translation/i)).toBeInTheDocument()
// A remount loop against a subtree that always throws would never reach that fallback.
expect(renderAttempts).toBeLessThan(20)
})
it('shows the fallback at once for an error that is not a DOM mutation', () => {
thrownMessage = 'something else broke'
throwUntilAttempt = 3
renderBoundary()
expect(screen.getByText('An error has occurred')).toBeInTheDocument()
expect(screen.queryByText(/translation/i)).not.toBeInTheDocument()
})
it.each([
{ value: null, described: 'null' },
{ value: 'oops', described: 'string oops' },
])('names the scene and records a thrown $value', ({ value, described }) => {
const captureSpy = jest.spyOn(posthog, 'captureException')
thrownValue = value
throwUntilAttempt = 3
renderBoundary({ feature: 'Insight' })
expect(
screen.getByText(`Non-Error value thrown in scene Insight: ${described}`, { exact: false })
).toBeInTheDocument()
expect(captureSpy).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({ feature: 'Insight', thrown_value: described })
)
captureSpy.mockRestore()
})
// The app-root boundary in scenes/App.tsx has no key to remount it, so without an in-fallback
// reset a crash outside a scene (nav, command palette) can only be cleared by a reload.
it('re-renders its children when the user clicks Try again', async () => {
thrownMessage = 'something else broke'
throwUntilAttempt = 3
renderBoundary()
expect(screen.getByText('An error has occurred')).toBeInTheDocument()
await userEvent.click(screen.getByText('Try again'))
expect(screen.getByText('recovered content')).toBeInTheDocument()
expect(screen.queryByText('An error has occurred')).not.toBeInTheDocument()
})
})