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.

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

Controls: Fix crashing when docgen extraction partially fails #26862

Merged
merged 2 commits into from Apr 18, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Apr 17, 2024

Closes #

What I did

Followup work for #26774, where the controls (and docs) won't crash anymore if there's a failure when extracting prop data in docgen.

The error message is also updated to be clearer and provides a link to the docgen limitations umbrella GH issue.
As a result, there will be no failure, the type will still be displayed, but in a simpler form. The error will still be displayed, but in the dev tools instead.

Before:
image

After:
image

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Use react-docgen in a project.
  2. Have a button like so:
type ReproType = {
  innerProperty: { [k: string]: string };
  innerProperty2: { string: string };
  innerProperty3: Record<string, string>;
};

type ButtonProps = JSX.IntrinsicElements['button'] & {
  repro1?: ReproType['innerProperty'];
  repro2?: ReproType['innerProperty2'];
  repro3?: ReproType['innerProperty3'];
};

export function Button({ ...rest }: ButtonProps) {
  return <button {...rest} />;
}
  1. See it not crash

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link

nx-cloud bot commented Apr 17, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2fb5ed5. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

@yannbf yannbf added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Apr 17, 2024
@yannbf yannbf added ci:merged Run the CI jobs that normally run when merged. and removed ci:normal labels Apr 18, 2024
@yannbf yannbf merged commit 67a2111 into next Apr 18, 2024
65 of 80 checks passed
@yannbf yannbf deleted the yann/fix-docgen-convert-crash branch April 18, 2024 12:39
@github-actions github-actions bot mentioned this pull request Apr 19, 2024
21 tasks
yannbf added a commit that referenced this pull request Apr 19, 2024
Controls: Fix crashing when docgen extraction partially fails
(cherry picked from commit 67a2111)
@github-actions github-actions bot mentioned this pull request Apr 21, 2024
44 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:merged Run the CI jobs that normally run when merged. docgen patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants