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: Unique outputDir/cacheDir for each configDir #25264

Merged
merged 8 commits into from
Dec 21, 2023

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Dec 19, 2023

Closes #24082

I think this will also fix this issue: #21510

What I did

I ensured that storybook when using a cache directory as an output directory, will use a unique sub-dir per storybook configDir.

I also cleaned up a bit of terminal output, there were absolute paths in there, which feels noisy.
It also printed out a message about copying over things from node_modules, which I doubt is useful information to the user, as it was storybook's internal pre-bundled stuff that was getting copied)

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

  • Making a static build of any storybook, and check if it work.

  • Provide a manual outputDir via a CLI flag and see if it works

  • Start a dev sandbox

  • check the node_modules/.cache directory. It's contents should include:
    Screenshot 2023-12-19 at 12 06 09

The long hash is unique per storybook configDir. It does not leak anything personally identifiable.
Here's the code creating it:

const cacheKey = oneWayHash(relative(rootDir, configDir));

  • check if the dev version works as expected.

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>

@ndelangen ndelangen changed the title add uniqueness to cacheDir Core: Unique outputDir/cacheDir for every unique configDir. Dec 19, 2023
@ndelangen ndelangen self-assigned this Dec 19, 2023
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Looks good!!! Minor changes

const targetPath = path.join(outputDir, targetDir);
logger.info(chalk`=> Copying static files: {cyan ${staticDir}} => {cyan ${targetDir}}`);
const targetPath = join(outputDir, targetDir);
if (!staticDir.includes('node_modules')) {
Copy link
Member

Choose a reason for hiding this comment

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

This line could use a comment explaining why

chalk`=> Copying static files: {cyan ${print(from)}} at {cyan ${print(targetPath)}}`
);
}
// logger.info(chalk`=> Copying static files: {cyan ${from}} at {cyan ${targetPath}}`);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// logger.info(chalk`=> Copying static files: {cyan ${from}} at {cyan ${targetPath}}`);

@shilman shilman changed the title Core: Unique outputDir/cacheDir for every unique configDir. Core: Unique outputDir/cacheDir for each configDir Dec 21, 2023
@ndelangen ndelangen merged commit aa37ebd into next Dec 21, 2023
59 checks passed
@ndelangen ndelangen deleted the norbert/no-conflicting-cache-dir-in-builders branch December 21, 2023 13:12
@github-actions github-actions bot mentioned this pull request Dec 21, 2023
12 tasks
@domneo
Copy link

domneo commented Dec 26, 2023

Will this be patched in V7 as well?

@shilman
Copy link
Member

shilman commented Dec 26, 2023

@domneo Nope. Please upgrade to the latest prerelease to use it. We're expecting a stable release in early 2024:

npx storybook@next upgrade --prerelease

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants