Core: Ensure /project.json route is up before builders serve local FS #33303

Sidnioulz · 2025-12-08T15:43:27Z

What I did

I noticed that the /project.json route has started serving our new NX monorepo project.json file. Jeppe correctly identified that this is caused by Vite Dev Server's serving of local files. The route handler was set up after Vite's server was started, allowing the route to be intercepted.

Switching up the route order fixes the issue.

Manual testing

Visit http://localhost:6006/project.json and inspect the content on the monorepo next vs on this branch.

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

Refactor
- Optimized server initialization by reorganizing when project metadata is loaded. Project information endpoints now initialize earlier during the startup sequence, enhancing initialization timing. This optimization can be disabled through configuration settings if needed.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

…art to serve local FS

nx-cloud · 2025-12-08T15:44:17Z

View your CI Pipeline Execution ↗ for commit fada00e

Command	Status	Duration	Result
`nx run-many -t compile,check,knip,test,pretty-d...`	✅ Succeeded	11m 41s	View ↗

☁️ Nx Cloud last updated this comment at 2025-12-09 08:54:01 UTC

coderabbitai · 2025-12-08T15:47:02Z

📝 Walkthrough

Walkthrough

The changes relocate the metadata initialization logic from the doTelemetry phase to an earlier bootstrap stage in the dev server. The useStorybookMetadata function is now called before the Vite Dev Server starts, ensuring the /project.json route is available immediately unless explicitly disabled via core.disableProjectJson.

Changes

Cohort / File(s)	Summary
Metadata initialization relocation `code/core/src/core-server/dev-server.ts`	Added import of `useStorybookMetadata` from `./utils/metadata` and introduced an early bootstrap block that conditionally invokes `useStorybookMetadata(app, options.configDir)` prior to Vite Dev Server initialization, guarded by `!core?.disableProjectJson` check.
Metadata cleanup `code/core/src/core-server/utils/doTelemetry.ts`	Removed import of `useStorybookMetadata` and deleted the corresponding conditional invocation that was previously executed within the doTelemetry phase.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Straightforward code relocation with identical logic moved between two files
Consistent pattern of removal and addition with no functional logic changes
Single conditional guard maintained across the change

✨ Finishing touches

📝 Generate docstrings

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

code/core/src/core-server/dev-server.ts (1)
84-88: Early /project.json bootstrap correctly precedes builder/Vite middleware; Biome “hook” error is a false positive

Registering useStorybookMetadata(app, options.configDir) before managerBuilder.start / previewBuilder.start should ensure the /project.json route is mounted before any Vite/local‑FS middleware, which aligns with the PR’s goal and preserves the core.disableProjectJson flag semantics. The Biome useHookAtTopLevel warning here is a false positive: this is server code and useStorybookMetadata is not a React hook constrained by render order. If that lint is blocking, consider either scoping the rule away from server files or adding an inline ignore just above this call.

Example (only if you decide to suppress locally):
// biome-ignore lint/correctness/useHookAtTopLevel: server-side util, not a React hook
if (!core?.disableProjectJson) {
  useStorybookMetadata(app, options.configDir);
}

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9548e92 and 16f2887.

📒 Files selected for processing (2)

code/core/src/core-server/dev-server.ts (2 hunks)
code/core/src/core-server/utils/doTelemetry.ts (0 hunks)

💤 Files with no reviewable changes (1)

code/core/src/core-server/utils/doTelemetry.ts

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{js,jsx,json,html,ts,tsx,mjs}