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.

Sign up for GitHub

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

Jump to bottom

Core: Add experimental_TEST_PROVIDER addon type #29114

Open
wants to merge 2 commits into
base: unified-ui-testing
Choose a base branch
from
Open

Core: Add experimental_TEST_PROVIDER addon type #29114

wants to merge 2 commits into from
+30 −5

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Sep 13, 2024 •
edited
Loading

Closes #29092

What I did

This adds a new addon type experimental_TEST_PROVIDER. It takes a title, icon and description which will eventually (in another PR) be displayed in the Testing Module in the sidebar.

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.3 MB 76 B 0.95 0%
initSize 162 MB 162 MB -4.51 kB 1.02 0%
diffSize 84.9 MB 84.9 MB -4.58 kB 0.91 0%
buildSize 7.53 MB 7.52 MB -12.7 kB 0.38 -0.2%
buildSbAddonsSize 1.62 MB 1.62 MB -102 B 0.53 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.34 MB 2.34 MB 49 B 0.58 0%
buildSbPreviewSize 352 kB 352 kB -18 B 1.34 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.51 MB 4.51 MB -71 B 0.58 0%
buildPreviewSize 3.02 MB 3.01 MB -12.7 kB -0.17 -0.4%
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 7.1s 11.5s 4.4s -0.38 38.4%
generateTime 21.5s 33.5s 11.9s 8.29 🔺35.8%
initTime 17.2s 29.9s 12.7s 9.06 🔺42.4%
buildTime 11.7s 14.7s 2.9s 1.36 🔺19.9%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 6.5s 8.3s 1.8s 1.75 🔺21.9%
devManagerResponsive 4s 5.5s 1.4s 2.1 🔺25.9%
devManagerHeaderVisible 786ms 1s 215ms 1.65 🔺21.5%
devManagerIndexVisible 837ms 1s 209ms 1.63 🔺20%
devStoryVisibleUncached 1.4s 1.7s 268ms 1.15 15.6%
devStoryVisible 838ms 1s 210ms 1.64 🔺20%
devAutodocsVisible 634ms 916ms 282ms 1.83 🔺30.8%
devMDXVisible 663ms 959ms 296ms 2.39 🔺30.9%
buildManagerHeaderVisible 645ms 939ms 294ms 2.28 🔺31.3%
buildManagerIndexVisible 652ms 941ms 289ms 1.73 🔺30.7%
buildStoryVisible 708ms 1s 320ms 2.45 🔺31.1%
buildAutodocsVisible 629ms 835ms 206ms 1.25 🔺24.7%
buildMDXVisible 608ms 841ms 233ms 2.31 🔺27.7%

Greptile Summary

This PR introduces a new experimental addon type called TEST_PROVIDER to Storybook, aimed at implementing a Test Provider API for displaying test-related information in the sidebar.

  • Added experimental_TEST_PROVIDER to Addon_TypesEnum in code/core/src/types/modules/addons.ts
  • Introduced Addon_TestProviderType interface defining structure for test provider addons
  • Updated AddonStore class in code/core/src/manager-api/lib/addons.ts to support the new addon type
  • Extended getElements and add methods in AddonStore to accommodate TEST_PROVIDER
  • Prepared groundwork for future implementation of test information display in the sidebar

@ghengeveld ghengeveld added feature request ci:merged Run the CI jobs that normally run when merged. labels Sep 13, 2024
greptile-apps[bot]
greptile-apps bot reviewed Sep 13, 2024
View reviewed changes
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

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Sep 13, 2024 •
edited
Loading

☁️ Nx Cloud Report

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

@ghengeveld ghengeveld changed the base branch from next to unified-ui-testing September 13, 2024 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greptile-apps Greptile Apps greptile-apps left review comments

@yannbf yannbf yannbf approved these changes

@kasperpeulen kasperpeulen Awaiting requested review from kasperpeulen

@valentinpalkovic valentinpalkovic Awaiting requested review from valentinpalkovic

Assignees
No one assigned
Labels
ci:merged Run the CI jobs that normally run when merged. feature request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Spec and implement Test Provider API
2 participants
@ghengeveld @yannbf