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: Add a rollup-plugin-webpack-stats to allow stats from preview builds #25923

Merged
merged 3 commits into from
Feb 8, 2024

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Feb 6, 2024

What I did

Integrated https://github.com/IanVS/vite-plugin-turbosnap (thanks @IanVS) so that the --webpack-stats-json flag works for Vite builds also.

One limitation is that it only works in build/production mode, as it is a rollup plugin. However AFAIK the only user of this flag is Chromatic and it only cares about built storybooks.

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>

@tmeasday tmeasday marked this pull request as draft February 6, 2024 10:31
@@ -28,5 +35,18 @@ export async function build(options: Options) {
}).build;

const finalConfig = await presets.apply('viteFinal', config, options);

const turbosnapPlugin = findPlugin(finalConfig, 'rollup-plugin-turbosnap');
if (turbosnapPlugin) {
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure if we should maybe not do this is --webpack-stats-json isn't passed. That would be inconsistent, and maybe confusing.

But it changes the behaviour if we drop the plugin if you don't pass the flag (that still wrote the stats file previously).

@tmeasday tmeasday changed the title Add a rollup-plugin-webpack-stats to allow stats from preview builds Vite: Add a rollup-plugin-webpack-stats to allow stats from preview builds Feb 6, 2024
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

@tmeasday you marked a bunch of the comments as resolved but without code changes, did you perhaps forget to push?

code/builders/builder-vite/src/build.ts Outdated Show resolved Hide resolved
@tmeasday
Copy link
Member Author

tmeasday commented Feb 8, 2024

Right you are @JReinhold

@tmeasday tmeasday marked this pull request as ready for review February 8, 2024 09:58
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

LGTM!

@tmeasday tmeasday merged commit 44ed235 into next Feb 8, 2024
63 checks passed
@tmeasday tmeasday deleted the tom/add-vite-stats-json branch February 8, 2024 10:30
@github-actions github-actions bot mentioned this pull request Feb 8, 2024
17 tasks

const turbosnapPluginName = 'rollup-plugin-turbosnap';
const hasTurbosnapPlugin =
finalConfig.plugins && hasVitePlugins(finalConfig.plugins, [turbosnapPluginName]);

Choose a reason for hiding this comment

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

It seems that this code is causing a behavior that always displays a warning.

Suggested change
finalConfig.plugins && hasVitePlugins(finalConfig.plugins, [turbosnapPluginName]);
finalConfig.plugins && await hasVitePlugins(finalConfig.plugins, [turbosnapPluginName]);

Copy link
Member Author

Choose a reason for hiding this comment

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

Hi @acid-chicken -- that makes sense! But how to reproduce? I'm not seeing the problem on a basic react-vite 8.0.0-beta.2 sandbox project. Any tips?

Copy link
Member Author

Choose a reason for hiding this comment

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

image

Choose a reason for hiding this comment

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

@tmeasday Thank you for the reply!

Digging a little deeper into this issue, I found that this log only appears at build time.
Therefore, you can probably reproduce by executing yarn create vite (w/ react & typescript option), yarn dlx storybook@next init, then yarn build-storybook (not yarn storybook).

I hope this will be of some help.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahh, OK of course. Thank you @acid-chicken

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.

4 participants