Maintenance: Remove sourcemaps generation#23936
Merged
Merged
Conversation
ndelangen
requested review from
JReinhold,
kasperpeulen,
shilman,
tmeasday,
valentinpalkovic and
yannbf
as code owners
yannbf
added
maintenance
yannbf
reviewed
Aug 24, 2023
yannbf
reviewed
Aug 24, 2023
yannbf
reviewed
Aug 24, 2023
yannbf
reviewed
Aug 24, 2023
Member
more like |
15 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What I did
@yannbf & me noticed that around 6-12mb of static-storybook's size is sourcemaps.
When bindling our code (manager and prebuild) we should not generate sourcemaps, because of the size. We have
minifyIdentifiersturned off:storybook/scripts/prepare/bundle.ts
Line 190 in 02e058a
... therefore sourcemaps do not add a lot to the ability to understand and debug the code.
Thus removing it is the best compromise.
Here is an example of before/after removing sourcemaps in the storybook test-runner example storybook statics:
Before:
After:
A drop of 7M! (21%)
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I manually tested this on my local machine, by running
yarn storybook:ui:buildin thecodedirectory.Then I investigated the output of the
static-storybookdirectory, and verified there are no.mapfiles, except the ones that vite generated.(We keep the sourcemaps generated by vite, because they are for the preview, and DO actually help the user debug their OWN code better.
The user can chose to disable sourcemaps themselves to get a faster build/deploy)
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>