-
-
Notifications
You must be signed in to change notification settings - Fork 9.7k
Telemetry: Add automigration errors #32103
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
Conversation
…results - Updated the upgrade.ts and multi-project.ts files to replace FixId and FixStatus with the new AutomigrationResult type. - Enhanced the structure of project results to include automigration statuses and errors. - Adjusted related functions to accommodate the new data structure for improved clarity and maintainability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 files reviewed, no comments
View your CI Pipeline Execution ↗ for commit 4345344
☁️ Nx Cloud last updated this comment at |
const { dryRun, skipInstall, automigrations } = options; | ||
const projectResults: Record<ConfigDir, Record<FixId, FixStatus>> = {}; | ||
const projectResults: Record<ConfigDir, AutomigrationResult> = {}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we do it differently so that we have projectResults
and projectErrors
as peers? That way it's not a breaking change to the telemetry. Otherwise the new data won't be compatible with the old data and will be a pain in the neck.
Closes #
What I did
This PR attaches (sanitized, anonymized errors) to automigrations in the telemetry data, so we can detect patterns and use them to improve the Storybook upgrade experience.
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:merged
orci:daily
GH 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.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 enhances Storybook's telemetry system by adding detailed error tracking for automigrations. The changes modify how error data is collected, stored, and transmitted during the upgrade process, specifically:
AutomigrationResult
type that tracks both success statuses and error messagessanitizeError
to ensure privacy when collecting error dataConfidence score: 5/5