Telemetry: Add metadata distinguishing "apps" from "design systems" #30070
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 2a5a855. 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. |
tmeasday
force-pushed
the
tom/metadata-tweaks
branch
from
d19abf0 to
766645f
Compare
tmeasday
changed the title
metadata.hasRouterPackage
| }); | ||
|
|
||
| // If the process errors, this will throw | ||
| await process; |
There was a problem hiding this comment.
i assume we're guaranteed to get all the lines before this exits?
There was a problem hiding this comment.
Yes, the "promise" doesn't resolve until the command is done. I guess theorectically the final on('line') might fire after that but I've never observed it in practice. I say theorectically just because I don't know for sure either way.
| * @param packageJson The package JSON of the project | ||
| * @returns Boolean Does this project use a routing package? | ||
| */ | ||
| export function getHasRouterPackage(packageJson: PackageJson) { |
There was a problem hiding this comment.
Well the metadata field is called that, I though maybe the helper that gets it should be named differently.
| const cache = createFileSystemCache({ | ||
| basePath: resolvePathInStorybookCache('telemetry'), | ||
| ns: 'storybook', | ||
| ttl: 24 * 60 * 60 * 1000, // 24h |
There was a problem hiding this comment.
🤷 I figured we'd thought about it before :)
|
|
||
| // We are looking for files with the word "page" or "screen" somewhere in them with these exts | ||
| const nameMatches = ['page', 'screen']; | ||
| const extensions = ['js', 'jsx', 'ts', 'tsx']; |
There was a problem hiding this comment.
Are mjsx and cjsx a thing?
There was a problem hiding this comment.
I guess the answer is kinda no: https://www.reddit.com/r/webdev/comments/15mern2/is_there_such_a_thing_as_cjsxmjsx_in_javascript/
And that might be a good reason to not include mjs and cjs in this script -- they are sort of guaranteed to be node files rather than browser files, right? Or is that an incorrect assumption?
Package BenchmarksCommit: No significant changes detected, all good. 👏 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
14 file(s) reviewed, 15 comment(s)
Edit PR Review Bot Settings | Greptile
| type ExecaStreamer = typeof Promise & { | ||
| stdout: Transform; | ||
| kill: () => void; | ||
| }; |
There was a problem hiding this comment.
logic: ExecaStreamer type extends Promise incorrectly - should extend Promise
There was a problem hiding this comment.
I'm not sure what is being suggested here.
There was a problem hiding this comment.
14 file(s) reviewed, 6 comment(s)
Edit PR Review Bot Settings | Greptile
|
|
||
| function createExecaStreamer() { | ||
| let resolver: () => void; | ||
| const promiseLike: ExecaStreamer = new Promise<void>((aResolver, aRejecter) => { |
There was a problem hiding this comment.
logic: Unused aRejecter parameter in Promise constructor - error cases not being tested
shilman
added
the
needs qa
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Create a project with a router and some pages and install Storybook with STORYBOOK_TELEMETRY_DEBUG=1. Bonus points if it's in a monorepo.
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 pull request has been released as version
0.0.0-pr-30070-sha-0b45cb37. Try it out in a new sandbox by runningnpx storybook@0.0.0-pr-30070-sha-0b45cb37 sandboxor in an existing project withnpx storybook@0.0.0-pr-30070-sha-0b45cb37 upgrade.More information
0.0.0-pr-30070-sha-0b45cb37tom/metadata-tweaks0b45cb371734328370)To request a new release of this pull request, mention the
@storybookjs/coreteam.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=30070Greptile Summary
Enhanced Storybook's telemetry system to distinguish between applications and design systems by adding metrics for router package detection and application file counting.
getApplicationFileCount.tsto detect files with 'page' or 'screen' patterns using git ls-filesgetHasRouterPackage.tsto identify routing dependencies across major frameworksrunTelemetryOperation.tswith 24-hour TTL for expensive operationsStorybookMetadatatype with newhasRouterPackageandapplicationFileCountfields💡 (3/5) Reply to the bot's comments like "Can you suggest a fix for this @greptileai?" or ask follow-up questions!