feat(tanstackstart-react): Add sentryTanstackStart Vite plugin for Source Map Uploads

[nicohrubec]

Adds sentryTanstackStart Vite plugin to enable automatic source map uploads in TanStack Start applications.

What it does
I tried to align with what we do in other SDKs (e.g. SvelteKit). On a high-level it:

• Uploads source maps to Sentry using @sentry/vite-plugin if configured, passing through all options set by the user (including release, sourcemaps, headers, etc.)
• If the source maps option is not defined and also the files to delete option is not defined, we enable cleaning up all .map files after the source map upload
• If the source map configuration is undefined, we additionally enable hidden source map generation

Usage

// vite.config.ts
  import { defineConfig } from 'vite';
  import { sentryTanstackStart } from '@sentry/tanstackstart-react';
  import { tanstackStart } from '@tanstack/react-start/plugin/vite';

  export default defineConfig({
    plugins: [
      sentryTanstackStart({
        org: 'my-org',
        project: 'my-project',
        // authToken via SENTRY_AUTH_TOKEN env var
      }),
      tanstackStart(),
    ],
  });

Tests

• Added unit tests for sourceMaps.ts and sentryTanstackStart.ts covering plugin composition, options passing, and source map settings logic
• Updated the E2E test to use the new plugin pattern

Closes #18664

[github-actions]

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario	Requests/s	% of Baseline	Prev. Requests/s	Change %
GET Baseline	8,984	-	9,365	-4%
GET With Sentry	1,714	19%	1,732	-1%
GET With Sentry (error only)	6,027	67%	6,087	-1%
POST Baseline	1,166	-	1,172	-1%
POST With Sentry	585	50%	592	-1%
POST With Sentry (error only)	1,022	88%	1,059	-3%
MYSQL Baseline	3,274	-	3,300	-1%
MYSQL With Sentry	441	13%	493	-11%
MYSQL With Sentry (error only)	2,668	81%	2,710	-2%

View base workflow run

[s1gr1d]

You can/should extend from this type, so we can make sure that all build-time options are aligned:

sentry-javascript/packages/core/src/build-time-plugins/buildTimeOptionsBase.ts

Line 27 in 2c6e710

export interface BuildTimeOptionsBase {

[nicohrubec]

ah nice thanks I did not know that existed, updated

[s1gr1d]

You probably want to use options.sourcemaps.disable here. Also make sure people can still create a release, even if they don't want to upload source maps.

[nicohrubec]

updated to use disable

[nicohrubec]

also always adding the sentry vite plugin down passing down the source maps disable option so that release creation works also if people do not use source maps

[s1gr1d]

A general thought I had on this: Are the sources included in Nitro source maps? In the Nuxt SDK, we have to disable this setting:

sentry-javascript/packages/nuxt/src/vite/sourceMaps.ts

Line 361 in cc93c68

nitroConfig.rollupConfig.output.sourcemapExcludeSources = false;

[Lms24]

Naive question for now: What's the advantage over this wrapper that we can't achieve with just exporting a plugin? If we need to modify the vite config, Vite offers plugin hooks to do so from within a plugin.

I'd personally prefer the plugin approach because this is a pattern that users are more used to than wrapping their config. If you or anyone else has different opinions, let's hear it :D

[nicohrubec]

@Lms24 good call, changed the approach from a wrapper to a simple plugin that users can add

[nicohrubec]

@s1gr1d judging from here and here that option seems to default to false in the vite rollup build options, so seems fine I think?

[sentry]

Bug: Source maps are deleted unexpectedly because filesToDeleteAfterUpload is defaulted even when uploads are disabled or when build.sourcemap is explicitly configured by the user.
_{Severity: HIGH}

Suggested Fix

Before defaulting filesToDeleteAfterUpload to ['.*/**/*.map'], add a condition to check that source map uploads are not disabled and that the user has not already configured config.build.sourcemap. This will prevent file deletion when uploads are disabled or when the user has explicitly enabled source maps, aligning the behavior with other Sentry SDKs.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: packages/tanstackstart-react/src/vite/sourceMaps.ts#L43-L46

Potential issue: The logic to add the Sentry Vite plugin unconditionally sets a default
value for `filesToDeleteAfterUpload`. This causes two incorrect behaviors. First, if a
user disables source map uploads via `sourcemaps: { disable: true }`, their source map
files will still be deleted from the build output. Second, if a user explicitly enables
source maps in their Vite config (e.g., `build: { sourcemap: true }`), their source maps
will also be deleted, which contradicts the documented intention to preserve user
settings and avoid default actions like deletion in this case. This behavior is
inconsistent with other Sentry SDKs like SolidStart, which correctly check if source
maps are enabled before applying a default deletion configuration.

_{Did we get this right? 👍 / 👎 to inform future reviews.}