storybookjs/storybook

[Bug]: Story docs block does not recover from errors thrown in React

Open

#22,213 opened on Apr 21, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
addon: docsbughelp wantedsev:S3

Description

If you add a throw new Error('bla') to a component rendered in a docs block, it will error but once you fix the issue, it won't recover:

https://user-images.githubusercontent.com/1671563/233017345-63c314cb-f951-49a6-8990-95bc3286f794.mov

Originally posted by @yannbf in https://github.com/storybookjs/storybook/issues/21440#issuecomment-1514347004

Contributor guide

Tech stack
typescriptreacthtmlcss
Domain
frontenddocumentationtesting
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React error boundariesStorybook docs addon
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the error recovery mechanism in Storybook's docs block for React components. Check the error boundary implementation in the docs addon (likely in packages/docs/...). The issue was originally reported in #21440. Consider implementing a retry mechanism or resetting error state when source code changes.