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 Angular sandbox startup errors #26524

Merged
merged 6 commits into from
Mar 16, 2024
Merged

Conversation

kroeder
Copy link
Member

@kroeder kroeder commented Mar 15, 2024

What I did

In main, you cannot bootstrap a startable Angular Sandbox app. The Angular app type-checker complains that many ts-expect-errors are unnecessary and must be removed. Angular is wrong here, but I don't know how to tell Angular that these @ts-expect-errors were right. But I also think all the ts-expect-errors were unnecessary and solvable in non-invasive ways.

This PR aims to make the Angular Sandbox startable again without any workarounds.

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!

  1. Create an Angular sandbox app
  2. Start it
  3. It should start without errors

Sanity check:

  1. Use main
  2. Create an Angular sandbox app
  3. Start it
  4. It should fail to start because of 5 @ts-expect-errors

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>

@kroeder kroeder added cleanup Minor cleanup style change that won't show up in release changelog angular labels Mar 15, 2024
@kroeder kroeder self-assigned this Mar 15, 2024
@kroeder
Copy link
Member Author

kroeder commented Mar 15, 2024

@valentinpalkovic are these the "hick ups" you mentioned when running a sandbox for Angular?

Copy link

nx-cloud bot commented Mar 15, 2024

☁️ Nx Cloud Report

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

@kroeder kroeder changed the title WIP: Make sandbox angular runnable without any workarounds Make sandbox angular runnable without any workarounds Mar 16, 2024
@kroeder kroeder requested review from ndelangen and valentinpalkovic and removed request for ndelangen March 16, 2024 09:29
@kroeder kroeder changed the title Make sandbox angular runnable without any workarounds Angular: Fix Angular sandbox startup errors Mar 16, 2024
@kroeder kroeder force-pushed the fix-ts-expect-errors branch from 6daa191 to 5dc3d92 Compare March 16, 2024 10:38
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! Thanks for finally making the Angular sandbox experience great again! :)

@kroeder
Copy link
Member Author

kroeder commented Mar 16, 2024

@valentinpalkovic my last pr was ages ago.. Do I merge myself after approve or do core maintainers usually do it?

@valentinpalkovic
Copy link
Contributor

Usually the core maintainers will merge the PRs :)

@valentinpalkovic valentinpalkovic merged commit a105385 into next Mar 16, 2024
54 of 57 checks passed
@valentinpalkovic valentinpalkovic deleted the fix-ts-expect-errors branch March 16, 2024 13:30
@github-actions github-actions bot mentioned this pull request Mar 16, 2024
18 tasks
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Mar 16, 2024
storybook-bot pushed a commit that referenced this pull request Mar 17, 2024
Angular: Fix Angular sandbox startup errors
(cherry picked from commit a105385)
@github-actions github-actions bot mentioned this pull request Mar 17, 2024
11 tasks
storybook-bot pushed a commit that referenced this pull request Mar 17, 2024
Angular: Fix Angular sandbox startup errors
(cherry picked from commit a105385)
storybook-bot pushed a commit that referenced this pull request Mar 17, 2024
Angular: Fix Angular sandbox startup errors
(cherry picked from commit a105385)
@shilman shilman added build Internal-facing build tooling & test updates and removed cleanup Minor cleanup style change that won't show up in release changelog labels Mar 17, 2024
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
angular build Internal-facing build tooling & test updates ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants