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

Addon Test: Register as experimental_TEST_PROVIDER addon type #29116

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Sep 13, 2024

Closes #29094

What I did

This registers the Test addon as a test provider using the new experimental_TEST_PROVIDER addon type.

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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.3 MB 77.4 MB 32.4 kB Infinity 0%
initSize 162 MB 162 MB 77.1 kB Infinity 0%
diffSize 84.9 MB 85 MB 44.7 kB Infinity 0.1%
buildSize 7.52 MB 7.52 MB 9 B Infinity 0%
buildSbAddonsSize 1.62 MB 1.62 MB 0 B - 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.34 MB 2.34 MB 0 B - 0%
buildSbPreviewSize 352 kB 352 kB 0 B - 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.51 MB 4.51 MB 0 B - 0%
buildPreviewSize 3.01 MB 3.01 MB 9 B Infinity 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 11.5s 22.6s 11s Infinity 🔺48.9%
generateTime 33.5s 20.1s -13s -342ms -Infinity 🔰-66.1%
initTime 29.9s 17.9s -12s -14ms -Infinity 🔰-66.9%
buildTime 14.7s 12.2s -2s -471ms -Infinity 🔰-20.2%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 8.3s 8s -243ms -Infinity -3%
devManagerResponsive 5.5s 4.6s -914ms -Infinity 🔰-19.8%
devManagerHeaderVisible 1s 721ms -280ms -Infinity 🔰-38.8%
devManagerIndexVisible 1s 753ms -293ms -Infinity 🔰-38.9%
devStoryVisibleUncached 1.7s 1.4s -309ms -Infinity 🔰-21.9%
devStoryVisible 1s 751ms -297ms -Infinity 🔰-39.5%
devAutodocsVisible 916ms 680ms -236ms -Infinity 🔰-34.7%
devMDXVisible 959ms 719ms -240ms -Infinity 🔰-33.4%
buildManagerHeaderVisible 939ms 687ms -252ms -Infinity 🔰-36.7%
buildManagerIndexVisible 941ms 721ms -220ms -Infinity 🔰-30.5%
buildStoryVisible 1s 722ms -306ms -Infinity 🔰-42.4%
buildAutodocsVisible 835ms 652ms -183ms -Infinity 🔰-28.1%
buildMDXVisible 841ms 646ms -195ms -Infinity 🔰-30.2%

Greptile Summary

This pull request implements the Test addon as an experimental test provider in Storybook, addressing issue #29094.

  • Updated code/addons/test/src/manager.tsx to register the addon with experimental_TEST_PROVIDER type, icon, title, and description
  • Modified code/addons/test/src/constants.ts to change ADDON_ID to 'storybook/test' and add TEST_PROVIDER_ID
  • Added '@storybook/icons' as a dependency in code/addons/test/package.json for the new icon implementation
  • Aligned the Test addon with Storybook's new Test Provider API, improving integration and functionality

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.

3 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings

type: Addon_TypesEnum.experimental_TEST_PROVIDER,
icon: <PointerHandIcon />,
title: 'Component tests',
description: () => 'Not yet run',
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider making the description dynamic based on test status

Copy link

nx-cloud bot commented Sep 13, 2024

☁️ Nx Cloud Report

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

Base automatically changed from test-provider-api to unified-ui-testing September 26, 2024 07:12
@ghengeveld ghengeveld merged commit cea8021 into unified-ui-testing Sep 26, 2024
55 of 58 checks passed
@ghengeveld ghengeveld deleted the register-test-provider branch September 26, 2024 07:12
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.

2 participants