Core: Introduce Reporting API and STORY_COMPLETED Event #29608
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit d8c2c7e. 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 2 targetsSent with 💌 from NxCloud. |
valentinpalkovic
force-pushed
the
valentin/implement-reporting-api
branch
from
06f7d0f to
239c066
Compare
valentinpalkovic
changed the title
valentinpalkovic
changed the title
| status: !ignoreUnhandledErrors && unhandledErrors.size > 0 ? 'error' : 'success', | ||
| reporters: context.reporting.reports, | ||
| }) | ||
| ); | ||
| } catch (err) { | ||
| this.phase = 'errored'; |
There was a problem hiding this comment.
where phase errored handled
| unhandledExceptions: !ignoreUnhandledErrors | ||
| ? Array.from(unhandledErrors).map(serializeError) | ||
| : [], | ||
| status: !ignoreUnhandledErrors && unhandledErrors.size > 0 ? 'error' : 'success', |
There was a problem hiding this comment.
// if one of the status is error -> error
// if no error but at least one warning -> warning
// otherwise -> passed
|
Merged into |
|
Merged into valentin/unified-a11y-testing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #
What I did
This PR introduces the Reporting API and a new
STORY_COMPLETEDevent:Key Changes
STORY_COMPLETEDevent to signal when a story has completed all phases, including handling unhandled exceptions. Updated StoryRender to emit this event with relevant status (success or error) and details on unhandled exceptions, allowing for comprehensive reporting at the story level.Integrated ReporterAPI within the story context, allowing each story to accumulate and report on its interactions, particularly for test and reporting purposes.
Updated test utilities to manage the story’s reports metadata, ensuring that each story’s test results can be accessed and verified.
Working on top of this csf canary:
ComponentDriven/csf#110
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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>