-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Mock: Catch errors when transforming preview files #32216
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
Merged
valentinpalkovic
merged 3 commits into
next
from
valentin/add-error-handling-to-mock-preview-parsing
Aug 7, 2025
Merged
Mock: Catch errors when transforming preview files #32216
valentinpalkovic
merged 3 commits into
next
from
valentin/add-error-handling-to-mock-preview-parsing
Aug 7, 2025
Conversation
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
Contributor
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.
2 files reviewed, 2 comments
code/core/src/core-server/presets/vitePlugins/vite-mock/plugin.ts
Outdated
Show resolved
Hide resolved
code/core/src/core-server/presets/webpack/loaders/storybook-mock-transform-loader.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
yannbf
approved these changes
Aug 7, 2025
|
View your CI Pipeline Execution ↗ for commit 1e2ff7b
☁️ Nx Cloud last updated this comment at |
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 51 | 51 | 0 |
| Self size | 41.75 MB | 41.74 MB | 🎉 -15 KB 🎉 |
| Dependency size | 18.13 MB | 18.13 MB | 0 B |
| Bundle Size Analyzer | Link | Link |
sb
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 52 | 52 | 0 |
| Self size | 1 KB | 1 KB | 0 B |
| Dependency size | 59.89 MB | 59.87 MB | 🎉 -15 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 220 | 220 | 0 |
| Self size | 585 KB | 585 KB | 0 B |
| Dependency size | 104.38 MB | 104.36 MB | 🎉 -15 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 189 | 189 | 0 |
| Self size | 31 KB | 31 KB | 0 B |
| Dependency size | 88.45 MB | 88.44 MB | 🎉 -15 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
14 tasks
This was referenced Aug 18, 2025
Merged
17 tasks
ndelangen
pushed a commit
that referenced
this pull request
Aug 20, 2025
…g-to-mock-preview-parsing Mock: Catch errors when transforming preview files (cherry picked from commit 906ad72)
ndelangen
pushed a commit
that referenced
this pull request
Aug 21, 2025
…g-to-mock-preview-parsing Mock: Catch errors when transforming preview files (cherry picked from commit 906ad72)
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
test utilities
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.
Closes #32192
What I did
I have added error handling when parsing and transforming preview files in the context of module mocking. When a preview file cannot be parsed, Storybook shouldn't crash, but rather log the error (debug loglevel)
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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>Greptile Summary
This PR adds defensive error handling to Storybook's module mocking system when transforming preview files containing
sb.mock()calls. The changes affect two key components: the Vite plugin and Webpack loader responsible for parsing and transforming these files.The implementation wraps the
rewriteSbMockImportCallsfunction in try-catch blocks in both transformation pipelines. When parsing or transformation fails, instead of crashing the build process, the system now logs a debug message and gracefully degrades - the Vite plugin returnsnullwhile the Webpack loader returns the original untransformed source code.This change addresses issue #32192 where overly permissive regex patterns were causing build failures for files with 'preview' in their names (like 'my-orders-preview.ts') that aren't actually Storybook preview configuration files. The error handling follows an existing pattern in the codebase where
extractMockCallsalready has similar defensive error handling, making the mocking system more resilient to edge cases.The changes integrate well with Storybook's existing error handling philosophy of graceful degradation rather than hard failures, ensuring that build processes continue even when individual files cannot be processed by the mocking transformation pipeline.
Confidence score: 4/5