Skip to content

feat(tanstackstart-react): Initialize the SDK when the Nitro server starts - #26224

Merged
chargome merged 5 commits into
developfrom
fix/tanstackstart-nitro-startup-init
Nov 10, 2026
Merged

chargome merged 5 commits into
developfrom
fix/tanstackstart-nitro-startup-init

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Why: Nitro imports the server entry lazily, in the first request. Without node --import, an import './instrument.server' in server.ts runs Sentry.init() only after that request started, so every cold start loses its http.server span. This follows what @sentry/nuxt does since #24094: the Vite plugin finds instrument.server.{ts,mts,js,mjs} (project root, then src/), bundles it into the Nitro build and loads it from a Nitro plugin, which runs when the server starts. Like Nuxt, this is always on and has no option. Orchestrion already instruments the drivers at build time, so --import is no longer needed in production. In vite dev you still need it.

Existing setups keep working. A --import preload or an import in server.ts now runs init() a second time. The first client wins, and the SDK logs that the preload or import can be removed (Nuxt logs the same). init() is also skipped while TanStack Start prerenders (TSS_PRERENDERING), which Nuxt does too. Otherwise the bundled config would send events from the build.

The tanstackstart-react e2e app now starts without --import. The whole suite passes locally that way, including the ioredis and mysql spans. tanstackstart-react-static keeps --import, so it covers existing start commands.

How to review: Start with src/vite/serverInstrumentation.ts, then init() in src/server/sdk.ts.

Unsure about: The docs still tell people to copy instrument.server.mjs and preload it, or to import it in server.ts. They need a follow-up in sentry-docs, like the Nuxt migration note.

Closes JS-4051

via Francesco Gringl-Novy.

--

View Session [Sentry]

…arts

Nitro imports the server entry lazily in the first request, so a Sentry.init()
imported from server.ts misses the http.server span of the first request of
each server instance when the app runs without node --import.

The Vite plugin now loads instrument.server.{ts,mts,js,mjs} from a Nitro
plugin, which runs at server startup, and the server init() keeps the first
client so an existing --import or server entry import doesn't replace it.

Co-Authored-By: Claude <noreply@anthropic.com>
@linear-code

linear-code Bot commented Nov 10, 2026

Copy link
Copy Markdown

JS-4051

@github-actions

github-actions Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Optional E2E tests

Some optional checks were not successful. They do not block the merge. 6 not successful, 51 successful. See the run.

Check Status
❌ CI: Optional E2E Tests / E2E nextjs-16-cacheComponents (cloudflare) Test (optional) Failing after 10m Details
❌ CI: Optional E2E Tests / E2E node-eve (orchestrion) Test (optional) Failing after 2m Details
❌ CI: Optional E2E Tests / E2E node-eve Test (optional) Failing after 2m Details
❌ CI: Optional E2E Tests / E2E node-flue (latest) Test (optional) Failing after 27s Details
❌ CI: Optional E2E Tests / E2E solidstart-2 Test (optional) Failing after 55s Details
❌ CI: Optional E2E Tests / E2E node-eve (latest) Test (optional) Failing after 55s Details
Successful checks
Check Status
✅ CI: Optional E2E Tests / E2E astro-7 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think (ai v6) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries Test (optional) Successful in 54s Details
✅ CI: Optional E2E Tests / E2E node-pi-durable (latest) Test (optional) Successful in 51s Details
✅ CI: Optional E2E Tests / E2E cloudflare-workers-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (latest) Test (optional) Successful in 46s Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-mastra Test (optional) Successful in 44s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable (latest) Test (optional) Successful in 49s Details
✅ CI: Optional E2E Tests / E2E deno (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E astro-7-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps Test (optional) Successful in 40s Details
✅ CI: Optional E2E Tests / E2E node-pi-durable Test (optional) Successful in 43s Details
✅ CI: Optional E2E Tests / E2E nextjs-orpc Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E debug-id-sourcemaps Test (optional) Successful in 34s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions (latest) Test (optional) Successful in 41s Details
✅ CI: Optional E2E Tests / E2E cloudflare-agent Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E react-router-7-framework-instrumentation Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (latest) Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E nextjs-16-tunnel (cloudflare) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-mastra Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (deno) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-flue-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (latest) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E react-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (cloudflare) Test (optional) Successful in 41s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (tunnel-dev) Test (optional) Successful in 57s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable Test (optional) Successful in 43s Details
✅ CI: Optional E2E Tests / E2E vue-3 (no Options API) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-flue Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-cloudflare Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (turbo) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v1 Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (cloudflare, latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nuxt-5 Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 Test (optional) Successful in 43s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-sourcemaps Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E node-mastra (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-cloudflare Test (optional) Successful in 28s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (static / nuxt generate) Test (optional) Successful in 41s Details
✅ CI: Optional E2E Tests / E2E supabase-nextjs Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext, bun) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (client source maps kept) Test (optional) Successful in 37s Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 (tracer provider) Test (optional) Successful in 42s Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v2 Test (optional) Successful in 36s Details

@github-actions

github-actions Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

Compared: 4d19c73 (PR test merge using develop at 2f3c8a9)

Against: 2f3c8a9 (develop) · base run #65503

✅ Baseline matches: this diff contains only this PR's changes.

Path Size % Change Change
@sentry/browser 29.92 kB - -
@sentry/browser - with treeshaking flags 28.08 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 27.97 kB - -
@sentry/browser (incl. Tracing) 52.29 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.3 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.27 kB - -
@sentry/browser (incl. Tracing, Replay) 92.61 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 81.29 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 97.34 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 110.34 kB - -
@sentry/browser (incl. Feedback) 47.52 kB - -
@sentry/browser (incl. sendFeedback) 35.02 kB - -
@sentry/browser (incl. FeedbackAsync) 40.13 kB - -
@sentry/browser (incl. Metrics) 31.48 kB - -
@sentry/browser (incl. Logs) 31.77 kB - -
@sentry/browser (incl. Metrics & Logs) 32.45 kB - -
@sentry/react 31.78 kB - -
@sentry/react (incl. Tracing) 54.76 kB - -
@sentry/vue 38.33 kB - -
@sentry/vue (incl. Tracing) 55.33 kB - -
@sentry/svelte 29.95 kB - -
@sentry/remix (Remix 3 client bundle) 57.92 kB - -
CDN Bundle 31.72 kB - -
CDN Bundle (incl. Tracing) 52.89 kB - -
CDN Bundle (incl. Logs, Metrics) 34.52 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 55.39 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 75.9 kB - -
CDN Bundle (incl. Tracing, Replay) 91.06 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 93.62 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 97.19 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 99.8 kB - -
CDN Bundle - uncompressed 92.76 kB - -
CDN Bundle (incl. Tracing) - uncompressed 156.02 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 101.29 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 163.79 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 232.85 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 277.71 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 285.47 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 291.41 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 299.17 kB - -
@sentry/nextjs (client) 57.73 kB - -
@sentry/sveltekit (client) 52.82 kB - -
@sentry/core/server 44.29 kB - -
@sentry/core/browser 14.02 kB - -
@sentry/node 157.13 kB +0.02% +18 B 🔺
@sentry/node/import (ESM hook with diagnostics-channel injection) 82.28 kB - -
@sentry/node - without tracing 96.91 kB +0.03% +21 B 🔺
@sentry/node - without channel injection 137.41 kB +0.02% +21 B 🔺
@sentry/aws-serverless 105.58 kB +0.02% +21 B 🔺
@sentry/cloudflare (withSentry) - minified 203.34 kB - -
@sentry/cloudflare (withSentry) 505.12 kB - -
@sentry/nextjs/cloudflare (withSentry) - minified 225.19 kB - -

View base workflow run

@mydea mydea self-assigned this Nov 10, 2026
Drop the serverInstrumentationFile option: like Nuxt, the server config is
found by name and always bundled into the Nitro build. Skip Sentry.init()
while TanStack Start prerenders, and tell users that a --import preload or an
import in the server entry is no longer needed when a second init is skipped.

The tanstackstart-react e2e app now starts without --import.
tanstackstart-react-static keeps it, which covers existing start commands.

Co-Authored-By: Francesco Gringl-Novy <francesco.novy@sentry.io>
@mydea mydea changed the title fix(tanstackstart-react): Initialize the SDK when the Nitro server starts feat(tanstackstart-react): Initialize the SDK when the Nitro server starts Nov 10, 2026
@mydea
mydea requested review from nicohrubec and s1gr1d November 10, 2026 10:39
@mydea
mydea marked this pull request as ready for review November 10, 2026 10:39
@mydea
mydea requested a review from a team November 10, 2026 10:39
@mydea
mydea requested review from a team as code owners November 10, 2026 10:39
@mydea
mydea requested review from JPeer264, Lms24, msonnb and mydea and removed request for a team November 10, 2026 10:39

@chargome chargome left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this should be handled in #26088

…erver

Co-Authored-By: Francesco Gringl-Novy <francesco.novy@sentry.io>

@cursor cursor Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Stale Bugbot comment from a previous run.

…hout Node.js

Nitro marks worker presets, such as Vercel Edge and Netlify Edge, and Deno
Deploy with `node: false`. The Node SDK must not end up in those builds, not
only on Cloudflare. Also logs with debug enabled when no instrument.server
file is found or the preset is skipped, and uses the convention constants
in the first request e2e test.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chargome

Copy link
Copy Markdown
Member

bugbot run

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 2dc2627. Configure here.

@chargome chargome assigned chargome and unassigned mydea Nov 10, 2026
…are presets

Nitro's Cloudflare presets extend base-worker, which sets `node: false`, so
the copy of the Nuxt preset name check is not needed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chargome
chargome marked this pull request as ready for review November 10, 2026 15:05
@chargome
chargome merged commit 6b42ee7 into develop Nov 10, 2026
796 of 804 checks passed
@chargome
chargome deleted the fix/tanstackstart-nitro-startup-init branch November 10, 2026 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants