feat(tanstackstart-react): Add wrappers for manual instrumentation of servers-side middlewares

[nicohrubec]

This PR adds a middleware wrapper to the tanstackstart SDK that allows users to add tracing to their application middleware. Eventually we will want to patch this automatically, but that is a bit tricky since it requires build-time magic. This API provides a manual alternative for now and can later still act as a fallback for cases where auto-instrumentation doesn't work.

How it works
The wrapper patches the middleware options.server function that gets executed whenever a middleware is run. Each middleware invocation creates a span with:

• op: middleware.tanstackstart
• origin: manual.middleware.tanstackstart
• name: The instrumentation automatically assigns the middleware name based on the variable name assigned to the middleware.

At first I had the issue that if multiple middlewares were used they would be nested (i.e. first middleware is parent of second etc.). This is because the middlewares call next() to move down the middleware chain, so trivially starting a span for the middleware execution would actually create a span that would last for the current middleware and any middlewares that come after in the middleware chain. I fixed that by also proxying next(), where I end the middleware span and then also reattach the middleware spans to the parent request span instead of the previous middleware span.

Usage

import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

  const [wrappedAuth, wrappedLogging] = wrapMiddlewaresWithSentry({
    authMiddleware,
    loggingMiddleware,
  });

Tests

Added E2E tests for:

• if multiple middlewares are executed we get spans for both and they are sibling spans (i.e. children of the same parent)
• global request middleware
• global function middleware
• request middleware

Screenshots from sample app

Using two global request middlewares:

Closes #18666

[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,576	-	11,856	-28%
GET With Sentry	1,632	19%	2,093	-22%
GET With Sentry (error only)	5,920	69%	7,678	-23%
POST Baseline	1,186	-	1,312	-10%
POST With Sentry	547	46%	671	-18%
POST With Sentry (error only)	1,026	87%	1,172	-12%
MYSQL Baseline	3,204	-	3,612	-11%
MYSQL With Sentry	435	14%	549	-21%
MYSQL With Sentry (error only)	2,606	81%	3,059	-15%

View base workflow run