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

Build: Replace last 'src', not 1st 'src' in entry file paths #30404

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

boylec
Copy link

@boylec boylec commented Jan 28, 2025

Closes #30403

What I did

Updated core build scripts to replace last occurrence of 'src' with 'dist' instead of first occurrence.

Otherwise, if someone clones the storybook repo (for the purposes of contributing) in a path like /Users/theperson/src/storybook then the core build/prep scripts fail due to some pathing issues on the esbuild compile steps.

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. Clone the repo to a root in a path on your local hard drive that contains 'src' above the root.
  2. Run yarn start and confirm everything builds and runs correctly.

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-storybook/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

@storybookjs/core can we do a canary release of this?

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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 78 MB 78 MB 0 B 1.74 0%
initSize 131 MB 131 MB -72.3 kB 0.32 -0.1%
diffSize 53 MB 53 MB -72.3 kB -0.98 -0.1%
buildSize 7.17 MB 7.17 MB -1.15 kB -1.92 0%
buildSbAddonsSize 1.85 MB 1.85 MB -273 B -1.53 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.86 MB 1.86 MB 12 B 1 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.91 MB 3.91 MB -261 B -1.53 0%
buildPreviewSize 3.26 MB 3.26 MB -887 B -1.88 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 19.9s 17s -2s -964ms -0.58 -17.4%
generateTime 19.7s 20.5s 766ms 0.41 3.7%
initTime 17.4s 13.9s -3s -535ms 0.42 -25.3%
buildTime 8.5s 11.5s 3s 2.39 🔺25.9%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 5.9s 5.1s -819ms -0.27 -15.9%
devManagerResponsive 4.2s 3.7s -533ms -0.32 -14.2%
devManagerHeaderVisible 801ms 778ms -23ms 0.14 -3%
devManagerIndexVisible 812ms 863ms 51ms 0.37 5.9%
devStoryVisibleUncached 4.1s 3.9s -125ms 0.63 -3.1%
devStoryVisible 830ms 863ms 33ms 0.34 3.8%
devAutodocsVisible 774ms 714ms -60ms -0.01 -8.4%
devMDXVisible 739ms 679ms -60ms -0.03 -8.8%
buildManagerHeaderVisible 776ms 796ms 20ms 0.02 2.5%
buildManagerIndexVisible 908ms 883ms -25ms -0.03 -2.8%
buildStoryVisible 758ms 732ms -26ms -0.12 -3.6%
buildAutodocsVisible 669ms 629ms -40ms -0.22 -6.4%
buildMDXVisible 683ms 564ms -119ms -0.24 -21.1%

Greptile Summary

Fixed critical path resolution issue in Storybook's core build process by modifying how 'src' to 'dist' path transformations are handled to prevent build failures when Storybook is installed in paths containing 'src'.

  • Added new replaceSrcWithDist utility in scripts/utils/paths.ts to replace only last occurrence of 'src'
  • Updated path handling in code/core/scripts/prep.ts to use new utility for correct path transformations
  • Modified path resolution in generateTypesMapperFiles.ts and generatePackageJsonFile.ts for consistent handling
  • Fixed build failures when Storybook repo is in directories containing 'src' (e.g. /Users/person/src/storybook)

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

scripts/utils/paths.ts Outdated Show resolved Hide resolved
scripts/utils/paths.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

scripts/prepare/tools.ts Show resolved Hide resolved
scripts/utils/paths.ts Outdated Show resolved Hide resolved
Copy link

nx-cloud bot commented Jan 28, 2025

View your CI Pipeline Execution ↗ for commit 5705ef1.

Command Status Duration Result
nx run-many -t build -c production --parallel=3 ✅ Succeeded 8s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-06 03:40:54 UTC

@boylec boylec changed the title replace last 'src' for core build core prep.ts bug fix: replace last 'src', not 1st 'src' in entry file paths Jan 29, 2025
@boylec boylec changed the title core prep.ts bug fix: replace last 'src', not 1st 'src' in entry file paths core prep script bug fix: replace last 'src', not 1st 'src' in entry file paths Jan 29, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

5 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@shilman shilman changed the title core prep script bug fix: replace last 'src', not 1st 'src' in entry file paths Build: Replace last 'src', not 1st 'src' in entry file paths Feb 1, 2025
@shilman shilman added build Internal-facing build tooling & test updates ci:normal labels Feb 1, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

scripts/prepare/tools.ts Show resolved Hide resolved
@valentinpalkovic valentinpalkovic self-assigned this Feb 3, 2025
@storybook-pr-benchmarking
Copy link

Package Benchmarks

Commit: 5705ef1, ran on 4 February 2025 at 04:13:33 UTC

The following packages have significant changes to their size or dependencies:

@storybook/addon-docs

Before After Difference
Dependency count 17 17 0
Self size 2.26 MB 2.20 MB 🎉 -61 KB 🎉
Dependency size 7.92 MB 7.92 MB 0 B
Bundle Size Analyzer Link Link

@storybook/addon-essentials

Before After Difference
Dependency count 36 36 0
Self size 12 KB 12 KB 0 B
Dependency size 13.93 MB 13.87 MB 🎉 -61 KB 🎉
Bundle Size Analyzer Link Link

@storybook/preact-vite

Before After Difference
Dependency count 13 13 0
Self size 5 KB 6 KB 🚨 +743 B 🚨
Dependency size 1.31 MB 1.31 MB 🎉 -1 KB 🎉
Bundle Size Analyzer Link Link

@storybook/cli

Before After Difference
Dependency count 388 388 0
Self size 503 KB 503 KB 🚨 +310 B 🚨
Dependency size 75.37 MB 75.35 MB 🎉 -13 KB 🎉
Bundle Size Analyzer Link Link

@boylec
Copy link
Author

boylec commented Feb 6, 2025

@valentinpalkovic just a heads up: I resolved your comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: If 'src' is in the path above the storybook repo core does not build
3 participants