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

Vite: Fix stats-plugin to normalize file names with posix paths #27218

Conversation

AlexAtVista
Copy link
Contributor

Closes #27172

What I did

Updates the normalize function within the webpack-stats-plugin for builder-vite to always normalize file names with posix path separators (/).

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. On a window environment, create a storybook sandbox using react vite
  2. Build storybook using storybook build --stats-json
  3. Confirm the name and id fields in the preview-stats.json file are using posix path separators (/) and not windows separators (\\)

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>

@shilman shilman changed the title Fix builder-vite webpack-stats-plugin to normalize file names with posix paths (#27172) Vite: Fix stats-plugin to normalize file names with posix paths May 25, 2024
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.

🙌

@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label May 25, 2024
Copy link

nx-cloud bot commented May 25, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 0f899a9. 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 1 target

Sent with 💌 from NxCloud.

@@ -58,7 +59,7 @@ export function pluginWebpackStats({ workingDir }: WebpackStatsPluginOptions): W
else {
const relativePath = path.relative(workingDir, stripQueryParams(filename));
Copy link
Contributor

Choose a reason for hiding this comment

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

Couldn't we just use path.posix.relative here to use forward slashes, independently of the OS?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@valentinpalkovic that is how I originally submitted this PR, until @shilman suggested using slash to be consistent with how windows paths are already converted elsewhere. I don't mind either way, if you're able to decide between you which option is preferable?

Copy link
Contributor

Choose a reason for hiding this comment

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

I see. Sorry that I haven’t followed the whole conversation! It’s fine then how it is!

@valentinpalkovic valentinpalkovic merged commit abfcc9f into storybookjs:next Jun 2, 2024
50 of 51 checks passed
storybook-bot pushed a commit that referenced this pull request Jun 2, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 2, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 3, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 3, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 4, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 5, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 5, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
storybook-bot pushed a commit that referenced this pull request Jun 5, 2024
…ts-json-posix-paths

Vite: Fix stats-plugin to normalize file names with posix paths
(cherry picked from commit abfcc9f)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 5, 2024
@valentinpalkovic valentinpalkovic added needs qa Indicates that this needs manual QA during the upcoming minor/major release and removed needs qa Indicates that this needs manual QA during the upcoming minor/major release labels Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug builder-vite ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch windows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Chromatic TurboSnap incompatible with preview-stats.json generated from builder-vite
3 participants