-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Angular: Fix wrong detection of standalone components #27353
Angular: Fix wrong detection of standalone components #27353
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thank you so much for fixing this issue. Well done :)
@dario-baumberger Unfortunately, we only patch high-severity security issues back to 7.6. It is doubtful that this can make it back to Storybook v7. |
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 9fa5e39. 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 targetSent with 💌 from NxCloud. |
Closes #26056
What I did
@gionkunz and I had a look at it. We found the issue and a solution.
Issue:
The old implementation checks whether a directive or component in the dependency structure is a standalone component. It does not matter where the standalone component is located in the dependency structure. It is sufficient if only one component is standalone. That goes wrong.
Solution:
reflectionCapabilities.annotations returns an array with decorators of the inheritance hierarchy.
https://github.com/angular/angular/blob/825023801baf8dbd0bd87b7ec46a65e869e08adb/packages/core/src/reflection/reflection_capabilities.ts#L204-L212
Because
parentAnnotations.concat(ownAnnotations);
The actual component to be imported is located somewhere at the end of the array.Example from
storybook/code/frameworks/angular/src/client/angular-beta/utils/PropertyExtractor.ts
Lines 170 to 181 in 122a83f
As we do not know exactly what is returned, we look for the first decorator in the reverse array that is a component or a directive. It is only on this decorator that we need to check whether it is a standalone component or not. This works because the hierarchically lowest component takes care of the imports.
We have encountered the error in version 7.6.6. It would be ideal if the fix would also lead to a new 7.6.x version.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I monkey patched the fix in our project with version 7.6.6 where we encountered this problem. We no longer had this issue. The stories were rendered correctly and there were no errors.
I tried to make it run in the sandbox, but there were too many problems (not from this fix), for example: #26439
If you get it to run, it should be reproducible as follows: #26829 (comment)
yarn task --task sandbox --start-from auto --template angular-cli/default-ts
cd sandoox/angular-cli-default-ts
yarn storybook
Documentation
No changes required
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/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>