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

Angular: Fix wrong detection of standalone components #27353

Conversation

dario-baumberger
Copy link
Contributor

@dario-baumberger dario-baumberger commented May 24, 2024

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

static analyzeDecorators = (component: any) => {
const decorators = reflectionCapabilities.annotations(component);
const isComponent = decorators.some((d) => this.isDecoratorInstanceOf(d, 'Component'));
const isDirective = decorators.some((d) => this.isDecoratorInstanceOf(d, 'Directive'));
const isPipe = decorators.some((d) => this.isDecoratorInstanceOf(d, 'Pipe'));
const isDeclarable = isComponent || isDirective || isPipe;
const isStandalone = (isComponent || isDirective) && decorators.some((d) => d.standalone);
return { isDeclarable, isStandalone };
};
:
image

  • decorators[0] is the parent, more precisely the superclase
  • decorators[1] is the relevant component

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:

  • stories
  • unit tests
  • integration tests
  • end-to-end 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)

  1. yarn task --task sandbox --start-from auto --template angular-cli/default-ts
  2. cd sandoox/angular-cli-default-ts
  3. yarn storybook
  4. ...

Documentation

No changes required

  • 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>

@valentinpalkovic valentinpalkovic self-assigned this May 24, 2024
@valentinpalkovic valentinpalkovic added bug angular ci:daily Run the CI jobs that normally run in the daily job. labels May 24, 2024
Copy link
Contributor

@valentinpalkovic valentinpalkovic left a 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 :)

@valentinpalkovic
Copy link
Contributor

@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.

@valentinpalkovic valentinpalkovic changed the title fixed wrong detection of standalone component and added tests Angular: Fix wrong detection of standalone components May 24, 2024
Copy link

nx-cloud bot commented May 24, 2024

☁️ Nx Cloud Report

CI 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 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic merged commit 2b3aedd into storybookjs:next May 31, 2024
100 of 101 checks passed
@github-actions github-actions bot mentioned this pull request May 31, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
angular bug ci:daily Run the CI jobs that normally run in the daily job.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Error when trying to create a story for a not standalone component that extends a standalone component
2 participants