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

Builder-Vite: Add null character prefix to virtual file IDs in code generator plugin #28867

Closed
wants to merge 2 commits into from

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Aug 12, 2024

Closes #

What I did

Cleaned up the code for resolving and loading virtual files in the Vite builder.

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!

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>

Greptile Summary

This PR modifies the virtual file handling in the Vite builder for Storybook, improving compatibility with Vite's virtual module system.

  • Added resolvedVirtualPath function in code-generator-plugin.ts to prefix virtual file IDs with a null byte
  • Updated virtual file ID resolution throughout the plugin to use the new resolvedVirtualPath function
  • Removed leading forward slashes from virtual file paths in virtual-file-names.ts
  • These changes ensure better alignment with Vite's expected format for virtual modules

Copy link

nx-cloud bot commented Aug 12, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8066f72. 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.

@IanVS
Copy link
Member

IanVS commented Aug 12, 2024

Thanks for doing this, but it looks like I was wrong. I found a guide to virtual modules which I'm pretty sure must be new, or at least I don't remember seeing it before, but it's very helpful: https://vitejs.dev/guide/api-plugin.html#virtual-modules-convention. Looks like you did it the right way, though I guess maybe a slightly cleaner approach is to create another constant for the ID used in resolving.

@valentinpalkovic
Copy link
Contributor Author

@IanVS Can you take another look?

@valentinpalkovic valentinpalkovic marked this pull request as ready for review August 13, 2024 07:17
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

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link
Member

@IanVS IanVS left a comment

Choose a reason for hiding this comment

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

Seems like a nice cleanup.

@valentinpalkovic
Copy link
Contributor Author

Superseded by #28984

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

Successfully merging this pull request may close these issues.

2 participants