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

Core: Gracefully handle error when parsing preview.js file #24858

Merged
merged 2 commits into from
Nov 16, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Nov 15, 2023

Closes #23604

What I did

When parsing Storybook metadata, there's a chance the preview file breaks in the CSF AST parsing step.
That's because users might have unconventional code in their preview.js file which is not parseable:

// .storybook/preview.js
import { baseStorybookPreviewConfig } from './some-config'

export default baseStorybookPreviewConfig;

This PR handles the error in case it happens, and also improves the error message when it comes to AST parsing errors.

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

  1. Create a sandbox
  2. Edit the preview.js file to be:
// .storybook/preview.js
import { baseStorybookPreviewConfig } from './some-config'

export default baseStorybookPreviewConfig;
  1. Build the Storybook. It should not break.

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>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch telemetry labels Nov 15, 2023
@yannbf yannbf self-assigned this Nov 15, 2023
@yannbf yannbf merged commit c4eac36 into next Nov 16, 2023
59 of 60 checks passed
@yannbf yannbf deleted the yann/handle-ast-parsing-error branch November 16, 2023 13:10
storybook-bot pushed a commit that referenced this pull request Nov 16, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 16, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 16, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 17, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 17, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 17, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 20, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 21, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 21, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 22, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 23, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 24, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 24, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 24, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 24, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 24, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 24, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 27, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 27, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 27, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 27, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 28, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 28, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 28, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
storybook-bot pushed a commit that referenced this pull request Nov 28, 2023
Core: Gracefully handle error when parsing preview.js file
(cherry picked from commit c4eac36)
@JReinhold JReinhold added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal 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 telemetry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: storybook dev works, storybook build fails error TypeError: Converting circular structure to JSON
3 participants