Skip to content

Core: Remove deprecated parts of test provider API #30962

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

Merged
merged 5 commits into from
Mar 31, 2025

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Mar 28, 2025

Closes #30746

Depends on chromaui/addon-visual-tests#367

What I did

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-storybook/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>

Greptile Summary

This PR fully removes deprecated test provider API parts and legacy UI components to align with the new test provider architecture.

• Removed the entire experimental API in /code/core/src/manager-api/modules/experimental_testmodule.ts and its dependent state references in /code/core/src/manager-api/root.tsx.
• Cleared deprecated test events from /code/core/src/core-events/index.ts and global exports in /code/core/src/manager/globals/exports.ts.
• Eliminated legacy UI components like LegacyRender from /code/core/src/manager/components/sidebar/LegacyRender.tsx and updated related stories in TestingModule.stories.tsx and SidebarBottom.stories.tsx.
• Adjusted addon registration in /code/addons/test/src/manager.tsx and updated type usage in /code/core/src/types/modules/addons.ts.
• Updated event listeners and test provider store calls in Sidebar and Tree stories to reference the new API via useStorybookApi().

Copy link
Contributor

github-actions bot commented Mar 28, 2025

Fails
🚫 PR is marked with "BREAKING CHANGE" label.

Generated by 🚫 dangerJS against f4af0af

@JReinhold JReinhold self-assigned this Mar 28, 2025
@JReinhold JReinhold marked this pull request as ready for review March 28, 2025 10:19
Copy link

nx-cloud bot commented Mar 28, 2025

View your CI Pipeline Execution ↗ for commit f4af0af.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 41s View ↗

☁️ Nx Cloud last updated this comment at 2025-03-31 13:10:49 UTC

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

18 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

return (
<TestProvider key={state.id} data-module-id={state.id}>
{Render ? <Render {...state} /> : <LegacyRender {...state} />}
<TestProvider key={id} data-module-id={id}>
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to add an error boundary here? I'm wondering whether an addon can break the entire testing module if it has some buggy code there

Copy link
Contributor Author

Choose a reason for hiding this comment

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

so I introduced some slight defence by ensuring that we only render if there actually is a render method.

But having an error boundaries should be a single pattern that we introduce across all the places where we render addons, I don't want to introduce that in this PR.

@JReinhold JReinhold merged commit 5fdb23a into next Mar 31, 2025
43 of 55 checks passed
@JReinhold JReinhold deleted the jeppe/remove-deprecated-test-provider-api branch March 31, 2025 13:32
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.

[Tracking]: Test Polish 💅
2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy