← Recipes

阅读中文版本

Recover from Render Errors with an Error Boundary

Add an error boundary that shows a fallback and a retry button so a null pointer in one widget does not blank the whole page.

~20 minfrontendreacterror-boundary

Task

Add <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> so the interface remains usable and accessible under the edge cases that manual testing skips.

When to use this

A screen reader user reports the page is unusable because <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> was never implemented, flagged in a support ticket.

Prerequisites

  • A frontend component or page in the codebase
  • A build with the relevant framework configured

Steps

1. Configure <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> in the project configuration file with the recommended defaults.

<ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary>

Expected output: The configuration is accepted and <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> runs without errors on the first invocation.

2. Run the check locally to verify <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> blocks merge on failure.

- name: Run add error boundary recovery
  run: pnpm test

Expected output: Pull requests with failing <ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary> are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Handle the edge case

Start by measuring the problem. Add an error boundary that shows a fallback and a retry button so a null pointer in one widget does not blank the whole page. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run <ErrorBoundary fallback={}> against the current codebase and inspect the output before wiring it into CI.

<ErrorBoundary fallback={<ErrorFallback onRetry={refetch} />}> <Widget /> </ErrorBoundary>

Test with real tools

Once the gate is in place, make failures actionable. A failing <ErrorBoundary fallback={}> should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.