ui: add root and tab error boundaries with retry fallback #173
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import React, { Component, ErrorInfo, ReactNode } from 'react'; | ||
|
|
||
| type ErrorBoundaryProps = { | ||
| children: ReactNode; | ||
| fallbackTitle: string; | ||
| fallbackMessage: string; | ||
| resetLabel: string; | ||
| onReset?: () => void; | ||
| resetKeys?: ReadonlyArray<unknown>; | ||
| }; | ||
|
|
||
| type ErrorBoundaryState = { | ||
| hasError: boolean; | ||
| }; | ||
|
|
||
| const haveResetKeysChanged = ( | ||
| previousKeys: ReadonlyArray<unknown> = [], | ||
| nextKeys: ReadonlyArray<unknown> = [] | ||
| ) => { | ||
| if (previousKeys.length !== nextKeys.length) { | ||
| return true; | ||
| } | ||
|
|
||
| for (let index = 0; index < previousKeys.length; index += 1) { | ||
| if (!Object.is(previousKeys[index], nextKeys[index])) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| }; | ||
|
|
||
| class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> { | ||
| state: ErrorBoundaryState = { | ||
| hasError: false, | ||
| }; | ||
|
|
||
| static getDerivedStateFromError() { | ||
| return { hasError: true }; | ||
| } | ||
|
|
||
| componentDidCatch(error: Error, errorInfo: ErrorInfo) { | ||
| console.error('Renderer ErrorBoundary captured an error:', error, errorInfo); | ||
| } | ||
|
|
||
| componentDidUpdate(previousProps: ErrorBoundaryProps) { | ||
| if (!this.state.hasError) { | ||
| return; | ||
| } | ||
|
|
||
| if (haveResetKeysChanged(previousProps.resetKeys, this.props.resetKeys)) { | ||
| this.setState({ hasError: false }); | ||
| } | ||
| } | ||
|
Comment on lines
+46
to
+54
There was a problem hiding this comment. 2. Componentdidupdate missing previousstate guard The componentDidUpdate override only accepts previousProps, omitting previousState. After getDerivedStateFromError transitions hasError to true, React commits the fallback UI and then calls componentDidUpdate with previousState.hasError === false. Without checking previousState.hasError, if any resetKey also changed in the same render cycle, the just-caught error is immediately cleared, the broken child re-renders, throws again, and the cycle repeats. Agent Prompt
|
||
|
|
||
| private readonly handleReset = () => { | ||
| this.props.onReset?.(); | ||
| this.setState({ hasError: false }); | ||
| }; | ||
|
|
||
| render() { | ||
| if (!this.state.hasError) { | ||
| return this.props.children; | ||
| } | ||
|
|
||
| return ( | ||
| <div | ||
| role='alert' | ||
| className='m-4 rounded-md border border-red-200 bg-red-50 p-4 text-sm text-red-900 dark:border-red-800 dark:bg-red-900/30 dark:text-red-100' | ||
| > | ||
| <h2 className='text-base font-semibold'>{this.props.fallbackTitle}</h2> | ||
| <p className='mt-2'>{this.props.fallbackMessage}</p> | ||
| <button | ||
| type='button' | ||
| onClick={this.handleReset} | ||
| className='mt-3 rounded border border-red-300 bg-white px-3 py-1 text-xs font-medium text-red-700 hover:bg-red-100 dark:border-red-700 dark:bg-red-900/40 dark:text-red-100 dark:hover:bg-red-900/60' | ||
| > | ||
| {this.props.resetLabel} | ||
| </button> | ||
| </div> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| export default ErrorBoundary; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| import React, { useState } from 'react'; | ||
| import { fireEvent, render, screen } from '@testing-library/react'; | ||
|
|
||
| import ErrorBoundary from '../../../src/renderer/components/ErrorBoundary'; | ||
|
|
||
| const ProblemChild = ({ shouldThrow }: { shouldThrow: boolean }) => { | ||
| if (shouldThrow) { | ||
| throw new Error('render boom'); | ||
| } | ||
| return <div>child rendered</div>; | ||
| }; | ||
|
|
||
| describe('ErrorBoundary', () => { | ||
| let consoleErrorSpy: jest.SpyInstance; | ||
|
|
||
| beforeEach(() => { | ||
| consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {}); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| consoleErrorSpy.mockRestore(); | ||
| }); | ||
|
|
||
| it('renders children when no error is thrown', () => { | ||
| render( | ||
| <ErrorBoundary | ||
| fallbackTitle='Fallback title' | ||
| fallbackMessage='Fallback message' | ||
| resetLabel='Retry' | ||
| > | ||
| <ProblemChild shouldThrow={false} /> | ||
| </ErrorBoundary> | ||
| ); | ||
|
|
||
| expect(screen.getByText('child rendered')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('shows fallback UI when a child throws', () => { | ||
| render( | ||
| <ErrorBoundary | ||
| fallbackTitle='Fallback title' | ||
| fallbackMessage='Fallback message' | ||
| resetLabel='Retry' | ||
| > | ||
| <ProblemChild shouldThrow /> | ||
| </ErrorBoundary> | ||
| ); | ||
|
|
||
| expect(screen.getByRole('alert')).toHaveTextContent('Fallback title'); | ||
| expect(screen.getByRole('alert')).toHaveTextContent('Fallback message'); | ||
| }); | ||
|
|
||
| it('resets and renders children again when reset keys change', () => { | ||
| const Harness = () => { | ||
| const [shouldThrow, setShouldThrow] = useState(true); | ||
| return ( | ||
| <> | ||
| <button type='button' onClick={() => setShouldThrow(false)}> | ||
| recover | ||
| </button> | ||
| <ErrorBoundary | ||
| fallbackTitle='Fallback title' | ||
| fallbackMessage='Fallback message' | ||
| resetLabel='Retry' | ||
| resetKeys={[shouldThrow]} | ||
| > | ||
| <ProblemChild shouldThrow={shouldThrow} /> | ||
| </ErrorBoundary> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| render(<Harness />); | ||
| expect(screen.getByRole('alert')).toBeInTheDocument(); | ||
|
|
||
| fireEvent.click(screen.getByText('recover')); | ||
| expect(screen.getByText('child rendered')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('calls onReset when retry button is clicked', () => { | ||
| const onReset = jest.fn(); | ||
|
|
||
| render( | ||
| <ErrorBoundary | ||
| fallbackTitle='Fallback title' | ||
| fallbackMessage='Fallback message' | ||
| resetLabel='Retry' | ||
| onReset={onReset} | ||
| > | ||
| <ProblemChild shouldThrow /> | ||
| </ErrorBoundary> | ||
| ); | ||
|
|
||
| fireEvent.click(screen.getByRole('button', { name: 'Retry' })); | ||
| expect(onReset).toHaveBeenCalledTimes(1); | ||
| }); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Activetab in resetkeys auto-retries crashed tabs
🐞 Bug✓ CorrectnessAgent Prompt
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools