Webpack: Fix sourcemap generation in webpack react-docgen-loader #26676
Conversation
This file contains 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
☁️ Nx Cloud ReportCI is running/has finished running commands for commit fec5def. 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 targetsSent with 💌 from NxCloud. |
yannbf
reviewed
Mar 28, 2024
| @@ -114,7 +114,10 @@ export default async function reactDocgenLoader( | |||
| } | |||
| }); | |||
|
|
|||
| const map = magicString.generateMap({ hires: true }); | |||
| const map = magicString.generateMap({ | |||
There was a problem hiding this comment.
Why did you remove the high resolution setting?
There was a problem hiding this comment.
I don't think it's that crucial. It now behaves like react-docgen in the vite builder. Usually, when using sourcemaps, it's enough to point to the line instead of the exact char position when the original files are in place. And since this was never working, I would start with the more performant variant and improve the source map detail level on request.
There was a problem hiding this comment.
Sure thing, let's just not forget that this setting was there in the first place!
yannbf
approved these changes
Mar 28, 2024
valentinpalkovic
added
the
patch:yes
valentinpalkovic
deleted the
valentin/fix-webpack-react-docgen-sourcemap-generation
branch
storybook-bot
pushed a commit
that referenced
this pull request
Mar 28, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
This was referenced Mar 28, 2024
Merged
storybook-bot
pushed a commit
that referenced
this pull request
Apr 1, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 1, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 2, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 2, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 2, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 3, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 3, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 3, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 4, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 4, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 4, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 4, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 5, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
storybook-bot
pushed a commit
that referenced
this pull request
Apr 5, 2024
…-docgen-sourcemap-generation Webpack: Fix sourcemap generation in webpack react-docgen-loader (cherry picked from commit eba6ed9)
github-actions
bot
added
the
patch:done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #26047
What I did
When
@storybook/addon-controlswas used (also part of@storybook/addon-essentials), the sourcemaps weren't generated properly for Webpack5-based projects. This should be fixed now. The issue was that the react-docgen-loader wasn't configured properly to output proper sourcemaps.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
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/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>