Skip to content

Conversation

@shilman
Copy link
Member

@shilman shilman commented Oct 2, 2025

Closes N/A

What I did

Get numbers on tanstack / react-router

🦋 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>

Summary by CodeRabbit

  • Enhancements
    • Improved framework detection for Storybook metadata to recognize TanStack React Router, React Router Dev, and Remix, increasing accuracy of environment reporting and telemetry.

@shilman shilman added maintenance User-facing maintenance tasks patch:yes Bugfix & documentation PR that need to be picked to main branch telemetry labels Oct 2, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

Walkthrough

The exported metaFrameworks mapping in code/core/src/telemetry/storybook-metadata.ts was updated to include three additional entries for framework detection:

  • @tanstack/react-routertanstack-react
  • @react-router/devreact-router
  • @remix-run/devremix

No other files, logic, error handling, or control-flow were changed.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly indicates that telemetry metadata for React routers is being added, which directly matches the changes to the metaFrameworks object. It is clear, concise, and specifies the domain and purpose of the update.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch shilman/add-router-frameworks

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aabeab0 and 68c0f14.

📒 Files selected for processing (1)
  • code/core/src/telemetry/storybook-metadata.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Adhere to ESLint and Prettier rules across all JS/TS source files

Files:

  • code/core/src/telemetry/storybook-metadata.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Fix type errors and prefer precise typings instead of using any or suppressions, consistent with strict mode

Files:

  • code/core/src/telemetry/storybook-metadata.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Core Unit Tests, windows-latest
  • GitHub Check: Danger JS
  • GitHub Check: normal
🔇 Additional comments (1)
code/core/src/telemetry/storybook-metadata.ts (1)

37-39: Clarify and extend metaFrameworks router mappings

  • Rename the value for @tanstack/react-router to tanstack-react-router to distinguish it from TanStack Query
  • Add mappings for @tanstack/react-router-ssr-query and @tanstack/react-start for full TanStack router coverage
  • Verify that including both @react-router/dev and @remix-run/dev is acceptable given the code only records the first matched framework

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Oct 2, 2025

View your CI Pipeline Execution ↗ for commit 68c0f14

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 48s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-02 13:23:04 UTC

'@nrwl/storybook': 'nx',
'@vue/cli-service': 'vue-cli',
'@sveltejs/kit': 'sveltekit',
'@tanstack/react-router': 'tanstack-react',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

other packages that might make sense to check
@tanstack/react-router-ssr-query, @tanstack/react-start
@remix-run/dev <-- it's the precursor to @react-router/dev

@storybook-app-bot
Copy link

storybook-app-bot bot commented Oct 2, 2025

Package Benchmarks

Commit: 68c0f14, ran on 2 October 2025 at 13:12:42 UTC

The following packages have significant changes to their size or dependencies:

@storybook/builder-webpack5

Before After Difference
Dependency count 187 187 0
Self size 68 KB 68 KB 🎉 -36 B 🎉
Dependency size 31.77 MB 31.78 MB 🚨 +11 KB 🚨
Bundle Size Analyzer Link Link

@storybook/react-webpack5

Before After Difference
Dependency count 272 272 0
Self size 25 KB 25 KB 🎉 -36 B 🎉
Dependency size 43.43 MB 43.44 MB 🚨 +11 KB 🚨
Bundle Size Analyzer Link Link

@storybook/server-webpack5

Before After Difference
Dependency count 199 199 0
Self size 17 KB 17 KB 🎉 -18 B 🎉
Dependency size 33.02 MB 33.03 MB 🚨 +11 KB 🚨
Bundle Size Analyzer Link Link

@shilman shilman force-pushed the shilman/add-router-frameworks branch from aabeab0 to 68c0f14 Compare October 2, 2025 13:00
@shilman shilman merged commit 391bbc6 into next Oct 2, 2025
55 of 57 checks passed
@shilman shilman deleted the shilman/add-router-frameworks branch October 2, 2025 13:21
ndelangen pushed a commit that referenced this pull request Oct 15, 2025
Telemetry: Add metadata for react routers
(cherry picked from commit 391bbc6)
@github-actions github-actions bot mentioned this pull request Oct 15, 2025
13 tasks
@ndelangen ndelangen mentioned this pull request Oct 16, 2025
13 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 16, 2025
@ndelangen ndelangen mentioned this pull request Oct 16, 2025
3 tasks
@vanessayuenn vanessayuenn removed the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 17, 2025
@github-actions github-actions bot mentioned this pull request Oct 17, 2025
3 tasks
@vanessayuenn vanessayuenn added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 17, 2025
valentinpalkovic pushed a commit that referenced this pull request Oct 17, 2025
Telemetry: Add metadata for react routers
(cherry picked from commit 391bbc6)
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:normal maintenance User-facing maintenance tasks patch:done Patch/release PRs already cherry-picked to main/release branch telemetry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants