Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,13 +4,17 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott

- **feat(tanstackstart-react): Auto-instrument server function middleware ([#19001](https://github.com/getsentry/sentry-javascript/pull/19001))**

The `sentryTanstackStart` Vite plugin now automatically instruments middleware in `createServerFn().middleware([...])` calls. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

## 10.38.0

### Important Changes

- **feat(tanstackstart-react): Auto-instrument request middleware ([#18989](https://github.com/getsentry/sentry-javascript/pull/18989))**

The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.
The `sentryTanstackStart` Vite plugin now automatically instruments `middleware` arrays in `createFileRoute()`. This captures performance data without requiring manual wrapping with `wrapMiddlewaresWithSentry()`.

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.

m: I think these whitespaces got added by accident

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

no actually, this was wrongly formatted (we always have the following paragraphs after the feature title indented with two spaces)


### Other Changes

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
import { createMiddleware } from '@tanstack/react-start';
import { wrapMiddlewaresWithSentry } from '@sentry/tanstackstart-react';

// Global request middleware - runs on every request
// NOTE: This is exported unwrapped to test auto-instrumentation via the Vite plugin
Expand All@@ -15,8 +14,8 @@ export const globalFunctionMiddleware = createMiddleware({ type: 'function' }).s
return next();
});

// Server function middleware
const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
// Server function middleware - exported unwrapped for auto-instrumentation via Vite plugin
export const serverFnMiddleware = createMiddleware({ type: 'function' }).server(async ({ next }) => {
console.log('Server function middleware executed');
return next();
});
Expand All@@ -28,21 +27,15 @@ export const serverRouteRequestMiddleware = createMiddleware().server(async ({ n
});

// Early return middleware - returns without calling next()
const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const earlyReturnMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Early return middleware executed - not calling next()');
return { earlyReturn: true, message: 'Middleware returned early without calling next()' };
});

// Error middleware - throws an exception
const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
// Exported unwrapped for auto-instrumentation via Vite plugin
export const errorMiddleware = createMiddleware({ type: 'function' }).server(async () => {
console.log('Error middleware executed - throwing error');
throw new Error('Middleware Error Test');
});

// Manually wrap middlewares with Sentry (for middlewares that won't be auto-instrumented)
export const [wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware] =
wrapMiddlewaresWithSentry({
serverFnMiddleware,
earlyReturnMiddleware,
errorMiddleware,
});
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { wrappedServerFnMiddleware, wrappedEarlyReturnMiddleware, wrappedErrorMiddleware } from '../middleware';
import { serverFnMiddleware, earlyReturnMiddleware, errorMiddleware } from '../middleware';

// Server function with specific middleware (also gets global function middleware)
const serverFnWithMiddleware = createServerFn()
.middleware([wrappedServerFnMiddleware])
.middleware([serverFnMiddleware])
.handler(async () => {
console.log('Server function with specific middleware executed');
return { message: 'Server function middleware test' };
Expand All@@ -18,15 +18,15 @@ const serverFnWithoutMiddleware = createServerFn().handler(async () => {

// Server function with early return middleware (middleware returns without calling next)
const serverFnWithEarlyReturnMiddleware = createServerFn()
.middleware([wrappedEarlyReturnMiddleware])
.middleware([earlyReturnMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware returned early');
return { message: 'This should not be returned' };
});

// Server function with error middleware (middleware throws an error)
const serverFnWithErrorMiddleware = createServerFn()
.middleware([wrappedErrorMiddleware])
.middleware([errorMiddleware])
.handler(async () => {
console.log('This should not be executed - middleware threw error');
return { message: 'This should not be returned' };
Expand Down
85 changes: 55 additions & 30 deletions packages/tanstackstart-react/src/vite/autoInstrumentMiddleware.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,12 @@ type WrapResult = {
skipped: string[];
};

type FileTransformState = {
code: string;
needsImport: boolean;
skippedMiddlewares: string[];
};

/**
* Core function that wraps middleware arrays matching the given regex.
*/
Expand All@@ -26,6 +32,10 @@ function wrapMiddlewareArrays(code: string, id: string, debug: boolean, regex: R
// eslint-disable-next-line no-console
console.log(`[Sentry] Auto-wrapping ${key} in ${id}`);
}
// Handle method call syntax like `.middleware([...])` vs object property syntax like `middleware: [...]`
if (key.endsWith('(')) {
return `${key}wrapMiddlewaresWithSentry(${objContents}))`;
}
return `${key}: wrapMiddlewaresWithSentry(${objContents})`;
}
// Track middlewares that couldn't be auto-wrapped
Expand DownExpand Up@@ -53,6 +63,30 @@ export function wrapRouteMiddleware(code: string, id: string, debug: boolean): W
return wrapMiddlewareArrays(code, id, debug, /(middleware)\s*:\s*\[([^\]]*)\]/g);
Comment thread
nicohrubec marked this conversation as resolved.
}

/**
* Wraps middleware arrays in createServerFn().middleware([...]) calls.
*/
export function wrapServerFnMiddleware(code: string, id: string, debug: boolean): WrapResult {
return wrapMiddlewareArrays(code, id, debug, /(\.middleware\s*\()\s*\[([^\]]*)\]\s*\)/g);
}

/**
* Applies a wrap function to the current state and returns the updated state.
*/
function applyWrap(
state: FileTransformState,
wrapFn: (code: string, id: string, debug: boolean) => WrapResult,
id: string,
debug: boolean,
): FileTransformState {
const result = wrapFn(state.code, id, debug);
return {
code: result.code,
needsImport: state.needsImport || result.didWrap,
skippedMiddlewares: [...state.skippedMiddlewares, ...result.skipped],
};
}

/**
* A Vite plugin that automatically instruments TanStack Start middlewares:
* - `requestMiddleware` and `functionMiddleware` arrays in `createStart()`
Expand All@@ -78,8 +112,9 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
// Detect file types that should be instrumented
const isStartFile = id.includes('start') && code.includes('createStart(');
const isRouteFile = code.includes('createFileRoute(') && /middleware\s*:\s*\[/.test(code);
const isServerFnFile = code.includes('createServerFn') && /\.middleware\s*\(\s*\[/.test(code);

if (!isStartFile && !isRouteFile) {
if (!isStartFile && !isRouteFile && !isServerFnFile) {
return null;
}

Expand All@@ -88,48 +123,38 @@ export function makeAutoInstrumentMiddlewarePlugin(options: AutoInstrumentMiddle
return null;
Comment thread
nicohrubec marked this conversation as resolved.
}

let transformed = code;
let needsImport = false;
const skippedMiddlewares: string[] = [];

switch (true) {
// global middleware
case isStartFile: {
const result = wrapGlobalMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
// route middleware
case isRouteFile: {
const result = wrapRouteMiddleware(transformed, id, debug);
transformed = result.code;
needsImport = needsImport || result.didWrap;
skippedMiddlewares.push(...result.skipped);
break;
}
default:
break;
let fileTransformState: FileTransformState = {
code,
needsImport: false,
skippedMiddlewares: [],
};

// Wrap middlewares
if (isStartFile) {
fileTransformState = applyWrap(fileTransformState, wrapGlobalMiddleware, id, debug);
}
if (isRouteFile) {
fileTransformState = applyWrap(fileTransformState, wrapRouteMiddleware, id, debug);
}
if (isServerFnFile) {
fileTransformState = applyWrap(fileTransformState, wrapServerFnMiddleware, id, debug);
}

// Warn about middlewares that couldn't be auto-wrapped
if (skippedMiddlewares.length > 0) {
if (fileTransformState.skippedMiddlewares.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Could not auto-instrument ${skippedMiddlewares.join(' and ')} in ${id}. ` +
`[Sentry] Could not auto-instrument ${fileTransformState.skippedMiddlewares.join(' and ')} in ${id}. ` +
'To instrument these middlewares, use wrapMiddlewaresWithSentry() manually. ',
);
}

// We didn't wrap any middlewares, so we don't need to import the wrapMiddlewaresWithSentry function
if (!needsImport) {
if (!fileTransformState.needsImport) {
return null;
}

transformed = addSentryImport(transformed);

return { code: transformed, map: null };
return { code: addSentryImport(fileTransformState.code), map: null };
},
};
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
makeAutoInstrumentMiddlewarePlugin,
wrapGlobalMiddleware,
wrapRouteMiddleware,
wrapServerFnMiddleware,
} from '../../src/vite/autoInstrumentMiddleware';

type PluginWithTransform = Plugin & {
Expand DownExpand Up@@ -329,6 +330,86 @@ export const Route = createFileRoute('/foo')({
});
});

describe('wrapServerFnMiddleware', () => {
it('wraps single middleware in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.skipped).toHaveLength(0);
});

it('wraps multiple middlewares in createServerFn().middleware()', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware, loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware, loggingMiddleware }))');
});

it('does not wrap empty middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toHaveLength(0);
});

it('does not wrap middleware containing function calls', () => {
const code = `
const serverFn = createServerFn()
.middleware([createMiddleware()])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(false);
expect(result.skipped).toContain('.middleware(');
});

it('handles multiple server functions in same file', () => {
const code = `
const serverFn1 = createServerFn()
.middleware([authMiddleware])
.handler(async () => ({}));

const serverFn2 = createServerFn()
.middleware([loggingMiddleware])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ loggingMiddleware }))');
});

it('handles trailing commas in middleware arrays', () => {
const code = `
const serverFn = createServerFn()
.middleware([authMiddleware,])
.handler(async () => ({}));
`;
const result = wrapServerFnMiddleware(code, '/app/routes/foo.ts', false);

expect(result.didWrap).toBe(true);
expect(result.code).toContain('.middleware(wrapMiddlewaresWithSentry({ authMiddleware }))');
});
});

describe('addSentryImport', () => {
it('prepends import to code without directives', () => {
const code = 'const foo = 1;';
Expand Down
Loading