Interactions: Correctly load preset when absolute paths are used #30264
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
Moved the content of
/preset.js
in addon-interactions to/dist/preset.js
(viasrc/preset.ts
), and require that in/preset.js
.This fixes a bug where addon-test postinstall loads all presets to determine if addon-interactions is preset. It does that by looking for a boolean set in addon-interactions'
dist/preset.js
file.However, when addons/presets are absolute paths and not package names - eg when using
getAbsolutePath('@storybook/addon-interactions')
inmain.ts
- the export map of the package is not taken into account, instead the root/preset.js
is loaded. And that file did not contain the boolean. In 99 % of the cases, root/preset.js
just need to re-export/dist/preset.js
to ensure those two are always in sync, so that's what we did here and that's what fixed this.In reality this also fixes a bug where the addon order check would only run when absolute paths were used, and not when the regular package name was used.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/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
Refactored the interactions addon preset handling to fix issues with absolute paths and ensure consistent addon order checking across different import methods.
/code/addons/interactions/preset.js
to properly re-export from/dist/preset.js
/code/addons/interactions/src/preset.ts
to support both absolute and relative config directoriesADDON_INTERACTIONS_IN_USE
boolean is accessible via absolute paths