Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use error boundary to capture useEffect errors #539

Merged
merged 1 commit into from
Jan 13, 2021
Merged

feat: use error boundary to capture useEffect errors #539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@
"@babel/runtime": "^7.12.5",
"@types/react": ">=16.9.0",
"@types/react-dom": ">=16.9.0",
"@types/react-test-renderer": ">=16.9.0"
"@types/react-test-renderer": ">=16.9.0",
"filter-console": "^0.1.1",
"react-error-boundary": "^3.1.0"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^4.9.1",
Expand Down
8 changes: 1 addition & 7 deletions src/dom/__tests__/errorHook.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,7 @@ describe('error hook tests', () => {
})
})

/*
These tests capture error cases that are not currently being caught successfully.
Refer to https://github.com/testing-library/react-hooks-testing-library/issues/308
for more details.
*/
// eslint-disable-next-line jest/no-disabled-tests
describe.skip('effect', () => {
describe('effect', () => {
test('should raise effect error', () => {
const { result } = renderHook(() => useEffectError(true))

Expand Down
23 changes: 14 additions & 9 deletions src/dom/__tests__/resultHistory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,39 @@
import { renderHook } from '..'

describe('result history tests', () => {
let count = 0
function useCounter() {
const result = count++
if (result === 2) {
function useValue(value: number) {
if (value === 2) {
throw Error('expected')
}
return result
return value
}

test('should capture all renders states of hook', () => {
const { result, rerender } = renderHook(() => useCounter())
const { result, rerender } = renderHook((value) => useValue(value), {
initialProps: 0
})

expect(result.current).toEqual(0)
expect(result.all).toEqual([0])

rerender()
rerender(1)

expect(result.current).toBe(1)
expect(result.all).toEqual([0, 1])

rerender()
rerender(2)

expect(result.error).toEqual(Error('expected'))
expect(result.all).toEqual([0, 1, Error('expected')])

rerender()
rerender(3)

expect(result.current).toBe(3)
expect(result.all).toEqual([0, 1, Error('expected'), 3])

rerender()

expect(result.current).toBe(3)
expect(result.all).toEqual([0, 1, Error('expected'), 3, 3])
})
})
65 changes: 44 additions & 21 deletions src/helpers/createTestHarness.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,65 @@
import React, { Suspense } from 'react'
import { ErrorBoundary, FallbackProps } from 'react-error-boundary'
import filterConsole from 'filter-console'

import { RendererProps, WrapperComponent } from '../types/react'
import { addCleanup } from '../core'

import { isPromise } from './promises'
import { RendererProps, WrapperComponent } from '../types/react'

function TestComponent<TProps, TResult>({
hookProps,
callback,
setError,
setValue
}: RendererProps<TProps, TResult> & { hookProps?: TProps }) {
try {
// coerce undefined into TProps, so it maintains the previous behaviour
setValue(callback(hookProps as TProps))
} catch (err: unknown) {
if (isPromise(err)) {
throw err
} else {
setError(err as Error)
function suppressErrorOutput() {
// The error output from error boundaries is notoriously difficult to suppress. To save
// out users from having to work it out, we crudely suppress the output matching the patterns
// below. For more information, see these issues:
// - https://github.com/testing-library/react-hooks-testing-library/issues/50
// - https://github.com/facebook/react/issues/11098#issuecomment-412682721
// - https://github.com/facebook/react/issues/15520
// - https://github.com/facebook/react/issues/18841
joshuaellis marked this conversation as resolved.
Show resolved Hide resolved
const removeConsoleFilter = filterConsole(
[
/^The above error occurred in the <TestComponent> component:/, // error boundary output
/^Error: Uncaught .+/ // jsdom output
joshuaellis marked this conversation as resolved.
Show resolved Hide resolved
],
{
methods: ['error']
}
}
return null
)
addCleanup(removeConsoleFilter)
}

function createTestHarness<TProps, TResult>(
rendererProps: RendererProps<TProps, TResult>,
{ callback, setValue, setError }: RendererProps<TProps, TResult>,
Wrapper?: WrapperComponent<TProps>,
suspense: boolean = true
) {
const TestComponent = ({ hookProps }: { hookProps?: TProps }) => {
// coerce undefined into TProps, so it maintains the previous behaviour
setValue(callback(hookProps as TProps))
return null
}
Comment on lines +34 to +38
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I brought this into createTestHarness because:

  1. ErrorFallback needed to be inside and I like consistency
  2. It simplified the props of TestComponent as the rendererProps are already available in the outer scope

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I originally moved it out before we moved out testHarness so It makes sense to put it back in since TestComponent isn't required on it's own.


let resetErrorBoundary = () => {}
const ErrorFallback = ({ error, resetErrorBoundary: reset }: FallbackProps) => {
resetErrorBoundary = () => {
resetErrorBoundary = () => {}
reset()
}
joshuaellis marked this conversation as resolved.
Show resolved Hide resolved
setError(error)
return null
}

suppressErrorOutput()

const testHarness = (props?: TProps) => {
let component = <TestComponent hookProps={props} {...rendererProps} />
resetErrorBoundary()

let component = <TestComponent hookProps={props} />
if (Wrapper) {
component = <Wrapper {...(props as TProps)}>{component}</Wrapper>
}
if (suspense) {
component = <Suspense fallback={null}>{component}</Suspense>
}
return component
return <ErrorBoundary FallbackComponent={ErrorFallback}>{component}</ErrorBoundary>
}

return testHarness
Expand Down
8 changes: 2 additions & 6 deletions src/helpers/promises.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@ function resolveAfter(ms: number) {
return new Promise<void>((resolve) => setTimeout(resolve, ms))
}

export async function callAfter(callback: () => void, ms: number) {
async function callAfter(callback: () => void, ms: number) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved the the export at the end of the file

await resolveAfter(ms)
callback()
}

function isPromise<T>(value: unknown): boolean {
return typeof (value as PromiseLike<T>).then === 'function'
}

export { isPromise, resolveAfter }
export { resolveAfter, callAfter }
8 changes: 1 addition & 7 deletions src/native/__tests__/errorHook.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,7 @@ describe('error hook tests', () => {
})
})

/*
These tests capture error cases that are not currently being caught successfully.
Refer to https://github.com/testing-library/react-hooks-testing-library/issues/308
for more details.
*/
// eslint-disable-next-line jest/no-disabled-tests
describe.skip('effect', () => {
describe('effect', () => {
test('should raise effect error', () => {
const { result } = renderHook(() => useEffectError(true))

Expand Down
23 changes: 14 additions & 9 deletions src/native/__tests__/resultHistory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,39 @@
import { renderHook } from '..'

describe('result history tests', () => {
let count = 0
function useCounter() {
const result = count++
if (result === 2) {
function useValue(value: number) {
if (value === 2) {
throw Error('expected')
}
return result
return value
}

test('should capture all renders states of hook', () => {
const { result, rerender } = renderHook(() => useCounter())
const { result, rerender } = renderHook((value) => useValue(value), {
initialProps: 0
})

expect(result.current).toEqual(0)
expect(result.all).toEqual([0])

rerender()
rerender(1)

expect(result.current).toBe(1)
expect(result.all).toEqual([0, 1])

rerender()
rerender(2)

expect(result.error).toEqual(Error('expected'))
expect(result.all).toEqual([0, 1, Error('expected')])

rerender()
rerender(3)

expect(result.current).toBe(3)
expect(result.all).toEqual([0, 1, Error('expected'), 3])

rerender()

expect(result.current).toBe(3)
expect(result.all).toEqual([0, 1, Error('expected'), 3, 3])
})
})
8 changes: 1 addition & 7 deletions src/server/__tests__/errorHook.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,7 @@ describe('error hook tests', () => {
})
})

/*
These tests capture error cases that are not currently being caught successfully.
Refer to https://github.com/testing-library/react-hooks-testing-library/issues/308
for more details.
*/
// eslint-disable-next-line jest/no-disabled-tests
describe.skip('effect', () => {
describe('effect', () => {
test('should raise effect error', () => {
const { result, hydrate } = renderHook(() => useEffectError(true))

Expand Down
44 changes: 44 additions & 0 deletions src/server/__tests__/resultHistory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { renderHook } from '..'

describe('result history tests', () => {
function useValue(value: number) {
if (value === 2) {
throw Error('expected')
}
return value
}

test('should capture all renders states of hook', () => {
const { result, hydrate, rerender } = renderHook((value) => useValue(value), {
initialProps: 0
})

expect(result.current).toEqual(0)
expect(result.all).toEqual([0])

hydrate()

expect(result.current).toEqual(0)
expect(result.all).toEqual([0, 0])

rerender(1)

expect(result.current).toBe(1)
expect(result.all).toEqual([0, 0, 1])

rerender(2)

expect(result.error).toEqual(Error('expected'))
expect(result.all).toEqual([0, 0, 1, Error('expected')])

rerender(3)

expect(result.current).toBe(3)
expect(result.all).toEqual([0, 0, 1, Error('expected'), 3])

rerender()

expect(result.current).toBe(3)
expect(result.all).toEqual([0, 0, 1, Error('expected'), 3, 3])
})
})
8 changes: 6 additions & 2 deletions src/server/pure.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ function createServerRenderer<TProps, TResult>(
render(props?: TProps) {
renderProps = props
act(() => {
const serverOutput = ReactDOMServer.renderToString(testHarness(props))
container.innerHTML = serverOutput
try {
const serverOutput = ReactDOMServer.renderToString(testHarness(props))
container.innerHTML = serverOutput
} catch (e: unknown) {
rendererProps.setError(e as Error)
}
Comment on lines +23 to +28
Copy link
Member Author

@mpeyper mpeyper Jan 13, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out error boundaries throw synchronously when server rendering. This is the only renderer that has any special treatment for error handling and only in the initial render function. The error boundary behaves normally once it has been hydrated.

})
},
hydrate() {
Expand Down