feat(tanstackstart-react): Add file exclude to configure middleware auto-instrumentation #19007

nicohrubec · 2026-01-27T16:27:19Z

Depends on (i.e. do not review until the following PR is merged): #19001

This PR extends the autoInstrumentMiddleware option to support fine-grained control over which files are auto-instrumented. Previously, this option only supported a boolean setting. Now you can pass an object with an exclude array to selectively skip specific files from auto-instrumentation.

// vite.config.ts                                                                                                                                                                     
  import { sentryTanstackStart } from '@sentry/tanstackstart-react';                                                                                                                    
                                                                                                                                                                                        
  export default defineConfig({                                                                                                                                                         
    plugins: [                                                                                                                                                                          
      sentryTanstackStart({                                                                                                                                                             
        autoInstrumentMiddleware: {                                                                                                                                                     
          exclude: [                                                                                                                                                                                       
            /\.test\.tsx?$/,        // Skip test files                                                                                                                                  
          ],                                                                                                                                                                            
        },                                                                                                                                                                              
      }),                                                                                                                                                                               
    ],                                                                                                                                                                                  
  });

Closes #18985

This reverts commit 330d7f8.

…ntation

github-actions · 2026-01-28T10:18:32Z

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,673	-	9,277	-7%
GET With Sentry	1,641	19%	1,793	-8%
GET With Sentry (error only)	6,045	70%	6,303	-4%
POST Baseline	1,173	-	1,199	-2%
POST With Sentry	569	49%	613	-7%
POST With Sentry (error only)	1,045	89%	1,064	-2%
MYSQL Baseline	3,324	-	3,382	-2%
MYSQL With Sentry	455	14%	507	-10%
MYSQL With Sentry (error only)	2,683	81%	2,727	-2%

View base workflow run

…ntation

…uto-instrumentation

github-actions · 2026-01-30T12:22:00Z

Codecov Results 📊

Generated by Codecov Action

nicohrubec · 2026-01-30T12:24:14Z

packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts

 import type { Plugin } from 'vite';

 type AutoInstrumentMiddlewareOptions = {
-  enabled?: boolean;


This was an unnecessary option since we just don't add this plugin if it's not enabled, so I removed it

sentry · 2026-01-30T12:26:40Z

packages/tanstackstart-react/src/vite/sentryTanstackStart.ts

-    plugins.push(makeAutoInstrumentMiddlewarePlugin({ enabled: true, debug: options.debug }));
+  const autoInstrumentConfig = options.autoInstrumentMiddleware;
+  const isDisabled = autoInstrumentConfig === false;
+  const excludePatterns = typeof autoInstrumentConfig === 'object' ? autoInstrumentConfig.exclude : undefined;


Bug: The check typeof autoInstrumentConfig === 'object' is insufficient because typeof null is also 'object', which can cause a crash if autoInstrumentConfig is null.
_{Severity: MEDIUM}

Suggested Fix

Update the conditional check to explicitly handle the null case by adding && autoInstrumentConfig !== null. The corrected line should be: const excludePatterns = typeof autoInstrumentConfig === 'object' && autoInstrumentConfig !== null ? autoInstrumentConfig.exclude : undefined;.

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/sentryTanstackStart.ts#L76 Potential issue: The code checks if `autoInstrumentConfig` is an object using `typeof autoInstrumentConfig === 'object'`. However, in JavaScript, `typeof null` also evaluates to `'object'`. If a user provides `null` for the `autoInstrumentMiddleware` option, for instance through a dynamic JavaScript configuration, this check will pass. The subsequent attempt to access `autoInstrumentConfig.exclude` will result in a `TypeError: Cannot read property 'exclude' of null`, causing the Vite build process to crash. This pattern is inconsistent with other parts of the codebase, which explicitly check for `null` in similar situations.

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

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

cursor · 2026-01-30T12:31:15Z

packages/tanstackstart-react/test/vite/autoInstrumentMiddleware.test.ts

+    }) as PluginWithTransform;
+    const result = plugin.transform(createStartFile, '/app/routes/admin/start.ts');
+    expect(result).toBeNull();
+  });


Missing integration or E2E tests for feat PR

Low Severity · Bugbot Rules

This feat PR adds the file exclude functionality for middleware auto-instrumentation but only includes unit tests. Per the review rules: "When reviewing a feat PR, check if the PR includes at least one integration or E2E test. If neither of the two are present, add a comment, recommending to add one." The existing E2E test suite at dev-packages/e2e-tests/test-applications/tanstackstart-react/ could be extended to verify the exclude patterns work correctly in a real build scenario.

Additional Locations (1)

packages/tanstackstart-react/test/vite/sentryTanstackStart.test.ts#L135-L147

JPeer264 · 2026-01-30T14:40:13Z

packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts

    transform(code, id) {
-      if (!enabled) {
+      // Skip if not a TS/JS file
+      if (!/\.(ts|tsx|js|jsx|mjs|mts)$/.test(id)) {


l: This was here before - still, maybe it makes more sense to have a path.extname(id) instead and check against this, it might be faster than regex or simply an endsWith (might be more effort, since this one only takes a string)

JPeer264 · 2026-01-30T14:44:34Z

packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts

+  // file matches exclude patterns, skip
+  if (debug) {
+    // eslint-disable-next-line no-console
+    console.log(`[Sentry] Skipping auto-instrumentation for excluded file: ${id}`);


l: I think this should be rather debug.log, where debug comes from @sentry/core

nicohrubec added 12 commits January 27, 2026 11:44

feat(tanstackstart-react): Auto-instrument request middleware

b877f51

refactor

40a7ba4

update e2e tests

3660c72

refactor

9a8026b

yarn fix

e985b3e

refactor

f7f4c22

isStartFile XOR isRouteFile

092858f

guard for double import

ce8dbc7

add double wrapping test

330d7f8

Revert "add double wrapping test"

b262eaa

This reverts commit 330d7f8.

feat(tanstackstart-react): Auto-instrument server function middleware

14873c3

yarn fix

a910011

nicohrubec force-pushed the nh/ignore-files-from-auto-instrument branch from 2ca2145 to e0df795 Compare January 27, 2026 16:35

Merge branch 'develop' into nh/automatic-function-middleware-instrume…

c122987

…ntation

nicohrubec force-pushed the nh/ignore-files-from-auto-instrument branch from e0df795 to e1276d9 Compare January 28, 2026 08:43

refactor + simplify

25e86bc

nicohrubec force-pushed the nh/ignore-files-from-auto-instrument branch from e1276d9 to 864d5b0 Compare January 28, 2026 09:38

nicohrubec marked this pull request as ready for review January 28, 2026 10:08

Add changelog entry

1b2c92f

nicohrubec self-assigned this Jan 30, 2026

nicohrubec added 8 commits January 30, 2026 09:30

update changelog

b94322a

.

e7f8e23

Merge branch 'develop' into nh/automatic-function-middleware-instrume…

df42f71

…ntation

feat(tanstackstart-react): Add file exclude to configure middleware a…

40ba4ec

…uto-instrumentation

shouldSkipFile

9912468

.

fc0632a

remove enabled option

478e1a2

update tests

07f4f30

nicohrubec force-pushed the nh/ignore-files-from-auto-instrument branch from 86f5879 to 07f4f30 Compare January 30, 2026 12:14

Merge branch 'develop' into nh/ignore-files-from-auto-instrument

d41a450

nicohrubec commented Jan 30, 2026

View reviewed changes

nicohrubec requested review from JPeer264 and andreiborza January 30, 2026 12:25

sentry bot reviewed Jan 30, 2026

View reviewed changes

cursor bot reviewed Jan 30, 2026

View reviewed changes

nicohrubec requested a review from s1gr1d January 30, 2026 14:06

JPeer264 approved these changes Jan 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(tanstackstart-react): Add file exclude to configure middleware auto-instrumentation #19007

feat(tanstackstart-react): Add file exclude to configure middleware auto-instrumentation #19007

nicohrubec commented Jan 27, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 28, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 30, 2026 •

edited

Loading

Uh oh!

nicohrubec Jan 30, 2026 •

edited

Loading

Uh oh!

sentry bot Jan 30, 2026

Uh oh!

cursor bot left a comment

Uh oh!

cursor bot Jan 30, 2026

Uh oh!

JPeer264 Jan 30, 2026

Uh oh!

JPeer264 Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat(tanstackstart-react): Add file exclude to configure middleware auto-instrumentation #19007

Are you sure you want to change the base?

feat(tanstackstart-react): Add file exclude to configure middleware auto-instrumentation #19007

Conversation

nicohrubec commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

node-overhead report 🧳

Uh oh!

github-actions bot commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Results 📊

Uh oh!

nicohrubec Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sentry bot Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Jan 30, 2026

Choose a reason for hiding this comment

Missing integration or E2E tests for feat PR

Uh oh!

JPeer264 Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

JPeer264 Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nicohrubec commented Jan 27, 2026 •

edited

Loading

github-actions bot commented Jan 28, 2026 •

edited

Loading

github-actions bot commented Jan 30, 2026 •

edited

Loading

nicohrubec Jan 30, 2026 •

edited

Loading