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

Initial portable stories for Angular #28662

Draft
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

Marklb
Copy link
Member

@Marklb Marklb commented Jul 20, 2024

Closes #

What I did

Adds portable stories support for Angular. This is mostly working, but there are still some minor issues to finish working through, before moving it from a draft.

So far, I have copied tests that seemed relevant, from other frameworks, and converted them to Angular. They are almost all passing, but there are most likely some Angular specific tests to add still.

The functionality is mostly a direct copy from @storybook/testing-angular, but I plan to clean it up and try to make the rendering implementation less independent from the existing rendering.

I probably should also update the docs for this, in this PR, so it doesn't get left behind.

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>

Copy link

nx-cloud bot commented Jul 20, 2024

☁️ Nx Cloud Report

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

import { composeStories, composeStory, setProjectAnnotations } from '../portable-stories';
import { createMountable } from '../angular-beta/StandaloneRenderer';

setProjectAnnotations({ testingLibraryRender: render as any });
Copy link
Member Author

@Marklb Marklb Jul 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type for testingLibraryRender is (...args: never[]) => { unmount: () => void; }, but should that type be changed to something like (...args: never[]) => ({ unmount: () => void; } | Promise<{ unmount: () => void; }>)?

Angular supports things like async factories that have to finish, before the application renders, which is probably why the render function from @testing-library/angular seems to only by async. Setting this to an async function works fine, since mount can be async, but I think the types won't work, I don't think.

The render function also doesn't seem to have an unmount property in it's return, but that is probably something expected to be implemented for other render libraries. So, I don't think this is a problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant