Babel: Ensure story files not transpiled earlier than ES2017 #28469

kasperpeulen · 2024-07-05T20:50:30Z

What I did

Make sure that stories files get not transpiled by babel further than the browser we support.

The purpose of this is to preserve the play: async ({ mount }) => { destructure code, which we dynamically test at runtime. It's important that we be able to do this at runtime (instead of during compilation) because it will allow us to support Playwright-style fixtures in the future -- an option that we want to keep open.

We believe it is a safe, nonbreaking change, because we are scoping the restriction to story files only and not to the user's components. Plus we already apply the same browser targets to the manager & preview-api code, so it is consistent with existing constraints!

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>

… the browser we support

greptile-apps

PR Summary

Updated code/core/src/core-server/presets/common-preset.ts to prevent story files from being transpiled beyond supported browsers.
Added Babel configuration override in code/core/src/core-server/presets/common-preset.ts to target specific browser versions.
Re-applied default Storybook Babel override in code/frameworks/nextjs/src/preset.ts to ensure compatibility with supported browsers.
Included specific browser targets for Chrome, Safari, and Firefox in code/frameworks/nextjs/src/preset.ts.

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

nx-cloud · 2024-07-05T20:55:14Z

☁️ Nx Cloud Report

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

nx run-many -t build --parallel=3

Sent with 💌 from NxCloud.

…bel-fixes

code/core/src/core-server/presets/common-preset.ts

valentinpalkovic · 2024-07-06T15:05:59Z

code/frameworks/nextjs/src/preset.ts

@@ -108,6 +108,29 @@ export const babel: PresetProperty<'babel'> = async (baseConfig: TransformOption
    presets,
    babelrc: false,
    configFile: false,
+    overrides: [


Shouldn’t we load babelDefault instead from the presets and apply it?

I'm not sure what you mean with this, do you mean to somehow reuse the babel preset override loaded in:
code/core/src/core-server/presets/common-preset.ts?

So in theory options.overrides should actually contain that preset/override, but it gets ignored as the include regex doesn't match the filename in line 62.

That is why I need to copy the override again.
I think we should solve it in:
#28467

But won't be easy I imagine.

code/core/src/core-server/presets/common-preset.ts

JReinhold · 2024-07-06T16:59:08Z

code/core/src/core-server/presets/common-preset.ts

+    // https://storybook.js.org/docs/writing-tests/interaction-testing#run-code-before-each-test
+    overrides: [
+      {
+        include: /(story|stories)\.[cm]?[jt]sx?$/,


If you want to be really exact you probably want to:

Add a dot at the beginning, to not match the-cool-stories.js

Don't match on story, Storybook doesn't support that even if a user's glob pattern would match it. (Unless something changes recently in the default CSF Indexer that I'm unaware of)

Good point!

Regarding 2, do you know @shilman ?

Looks like we do support both suffixes in our indexer and the "." bug exists there too:

https://github.com/storybookjs/storybook/blob/next/code/core/src/core-server/presets/common-preset.ts#L191-L194

code/frameworks/nextjs/src/preset.ts

Co-authored-by: Valentin Palkovic <valentin@chromatic.com>

* Update storybook monorepo to v8.2.9 * Add a bunch of `storybook` deps everywhere. When Storybook decided to do storybookjs/storybook#27039, they seem to have neglected the use case where monorepos might only need a few add-ons for stories in various packages, with all of the storybook stuff in a separate dummy package. So now we need to bring in all of storybook as a dev-dep in every package that has stories. * Fix babel config. Broken by storybookjs/storybook#28469. --------- Co-authored-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: Brad Jorsch <brad.jorsch@automattic.com> Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/10406793290 Upstream-Ref: Automattic/jetpack@ee09161

* Update storybook monorepo to v8.2.9 * Add a bunch of `storybook` deps everywhere. When Storybook decided to do storybookjs/storybook#27039, they seem to have neglected the use case where monorepos might only need a few add-ons for stories in various packages, with all of the storybook stuff in a separate dummy package. So now we need to bring in all of storybook as a dev-dep in every package that has stories. * Fix babel config. Broken by storybookjs/storybook#28469. --------- Co-authored-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: Brad Jorsch <brad.jorsch@automattic.com>

Make sure that stories files get not transpiled by babel further than…

37169b7

… the browser we support

kasperpeulen added maintenance User-facing maintenance tasks ci:normal labels Jul 5, 2024

greptile-apps bot reviewed Jul 5, 2024

View reviewed changes

Merge branch 'refs/heads/kasper/improve-error-message' into kasper/ba…

8d1bca5

…bel-fixes

kasperpeulen changed the base branch from next to kasper/improve-error-message July 5, 2024 21:43

kasperpeulen changed the title ~~Babel: Make sure that stories files get not transpiled by babel further than the browser we support~~ Babel: Make sure that stories files get not transpiled by babel further than the browsers we support Jul 5, 2024

kasperpeulen added 4 commits July 6, 2024 00:22

Merge branch 'kasper/improve-error-message' into kasper/babel-fixes

4cfc77e

Merge branch 'kasper/improve-error-message' into kasper/babel-fixes

f61df60

Merge branch 'kasper/improve-error-message' into kasper/babel-fixes

c237511

Merge branch 'kasper/improve-error-message' into kasper/babel-fixes

109b3b7

kasperpeulen added ci:daily Run the CI jobs that normally run in the daily job. and removed ci:normal labels Jul 5, 2024

shilman changed the title ~~Babel: Make sure that stories files get not transpiled by babel further than the browsers we support~~ Babel: Ensure story files not transpiled earlier than ES2017 Jul 6, 2024

shilman approved these changes Jul 6, 2024

View reviewed changes

shilman changed the title ~~Babel: Ensure story files not transpiled earlier than ES2017~~ Babel: Ensure story files get transpiled no earlier than ES2017 Jul 6, 2024

shilman changed the title ~~Babel: Ensure story files get transpiled no earlier than ES2017~~ Babel: Ensure story files not transpiled earlier than ES2017 Jul 6, 2024

valentinpalkovic reviewed Jul 6, 2024

View reviewed changes

code/core/src/core-server/presets/common-preset.ts Outdated Show resolved Hide resolved

valentinpalkovic reviewed Jul 6, 2024

View reviewed changes

code/core/src/core-server/presets/common-preset.ts Show resolved Hide resolved

valentinpalkovic reviewed Jul 6, 2024

View reviewed changes

valentinpalkovic approved these changes Jul 6, 2024

View reviewed changes

JReinhold reviewed Jul 6, 2024

View reviewed changes

kasperpeulen added 2 commits July 6, 2024 20:07

Improve babel override

93cd45f

Merge branch 'kasper/improve-error-message' into kasper/babel-fixes

7ed7ea4

Base automatically changed from kasper/improve-error-message to next July 7, 2024 13:43

Fix

286d84c

valentinpalkovic reviewed Jul 8, 2024

View reviewed changes

code/frameworks/nextjs/src/preset.ts Outdated Show resolved Hide resolved

Update code/frameworks/nextjs/src/preset.ts

5b884b6

Co-authored-by: Valentin Palkovic <valentin@chromatic.com>

valentinpalkovic merged commit dd1f7f0 into next Jul 8, 2024
103 of 104 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Babel: Ensure story files not transpiled earlier than ES2017 #28469

Babel: Ensure story files not transpiled earlier than ES2017 #28469

kasperpeulen commented Jul 5, 2024 •

edited by shilman

Loading

greptile-apps bot left a comment

nx-cloud bot commented Jul 5, 2024 •

edited

Loading

valentinpalkovic Jul 6, 2024

kasperpeulen Jul 6, 2024 •

edited

Loading

JReinhold Jul 6, 2024

kasperpeulen Jul 6, 2024

shilman Jul 7, 2024

Babel: Ensure story files not transpiled earlier than ES2017 #28469

Babel: Ensure story files not transpiled earlier than ES2017 #28469

Conversation

kasperpeulen commented Jul 5, 2024 • edited by shilman Loading

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

nx-cloud bot commented Jul 5, 2024 • edited Loading

☁️ Nx Cloud Report

valentinpalkovic Jul 6, 2024

Choose a reason for hiding this comment

kasperpeulen Jul 6, 2024 • edited Loading

Choose a reason for hiding this comment

JReinhold Jul 6, 2024

Choose a reason for hiding this comment

kasperpeulen Jul 6, 2024

Choose a reason for hiding this comment

shilman Jul 7, 2024

Choose a reason for hiding this comment

kasperpeulen commented Jul 5, 2024 •

edited by shilman

Loading

nx-cloud bot commented Jul 5, 2024 •

edited

Loading

kasperpeulen Jul 6, 2024 •

edited

Loading