-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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
Telemetry: CSF feature usage #28622
Telemetry: CSF feature usage #28622
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 631bafd. 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 targetSent with 💌 from NxCloud. |
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.
LGTM generally, might need an extra test
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.
PR Summary
- Updated
code/core/package.json
to use@storybook/[email protected]
- Enhanced
StoryIndexGenerator.ts
to track CSF features in telemetry - Added
summarizeStats.ts
and corresponding tests for aggregating CSF stats - Modified
doTelemetry.ts
to capture detailed CSF feature usage - Introduced mock stories in
Features.stories.jsx
for telemetry testing
13 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings
Object.entries(stat).forEach(([key, value]) => { | ||
const statsKey = key as keyof IndexInputStats; | ||
if (!acc[statsKey]) acc[statsKey] = 0; | ||
acc[statsKey] += value ? 1 : 0; |
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.
Logic: The increment logic acc[statsKey] += value ? 1 : 0
only increments by 1 if value
is truthy. Ensure this is the intended behavior.
Closes N/A
What I did
Add the ability to track CSF language features in telemetry without touching the index. This PR tracks stories that use custom
render
function and CSF1/2storyFn
-style stories. Will telescope PRs to add new CSF constructs includingbeforeEach
,mount
,moduleMocking
, etc.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Run a sandbox with
STORYBOOK_TELEMETRY_DEBUG=1
and observe the payload with the number ofrender
/storyFn
counts.🦋 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>