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

Test: Fix vitest patch to work with portable stories and upgrade testing-library/jest-dom #25840

Merged
merged 4 commits into from
Jan 31, 2024

Conversation

kasperpeulen
Copy link
Contributor

@kasperpeulen kasperpeulen commented Jan 31, 2024

Fixes #25750
Fixes #25794

What I did

Fix vitest patch to work with portable stories
And upgrade testing-library/jest-dom

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
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

LGTM! How do we make sure issues with the patch won't happen again (so the patch needs to be revisited when vitest deps are upgraded)?

@kasperpeulen
Copy link
Contributor Author

@yannbf Added a test now for using storybook/test in vitest

@kasperpeulen kasperpeulen changed the title Test: Fix vitest patch to work with portable stories Test: Fix vitest patch to work with portable stories and upgrade testing-library/jest-dom Jan 31, 2024
@kasperpeulen kasperpeulen merged commit 58316ad into next Jan 31, 2024
56 of 60 checks passed
@kasperpeulen kasperpeulen deleted the kaper/fix-vitest-patch branch January 31, 2024 16:32
@github-actions github-actions bot mentioned this pull request Jan 31, 2024
14 tasks
@@ -16,9 +16,10 @@ import {
} from '@vitest/expect';
import * as matchers from '@testing-library/jest-dom/matchers';
import type { PromisifyObject } from './utils';
import type { TestingLibraryMatchers } from '@testing-library/jest-dom/types/matchers';
Copy link
Contributor

Choose a reason for hiding this comment

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

This line seems to be translated as
import { TestingLibraryMatchers } from '@testing-library/jest-dom/types/matchers';
in dist/index.d.ts, which typescript can't parse right and causes it to be typed as any.

Can you replace this with
import type { TestingLibraryMatchers } from '@testing-library/jest-dom/matchers'
by any chance?

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