feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lms24 merged 6 commits into from
Mar 18, 2026
Merged

feat(remix): Server Timing Headers Trace Propagation #18653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a068848
feat(remix): Add Server-Timing header trace propagation
onurtemizkan Feb 20, 2026
3fdd111
Prevent duplicate Server-Timing header entries in Cloudflare
onurtemizkan Feb 23, 2026
15fface
fix incorrect getTraceData usage as well as fix a bug in propagator
Lms24 Mar 18, 2026
aa83a81
lint fix
Lms24 Mar 18, 2026
cab0799
the simpler, the better
Lms24 Mar 18, 2026
9aa98ee
fix unit tests
Lms24 Mar 18, 2026
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
10 changes: 9 additions & 1 deletion dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
// This is required for Sentry's profiling integration
responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
headers: responseHeaders,
status: responseStatusCode,
});

const serverTimingValue = generateSentryServerTimingHeader();
if (serverTimingValue) {
response.headers.append('Server-Timing', serverTimingValue);
}

return response;
}
17 changes: 17 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
const responsePromise = page.waitForResponse(
response =>
response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
);

await page.goto('/');

const response = await responsePromise;
const serverTimingHeader = response.headers()['server-timing'];

expect(serverTimingHeader).toBeDefined();
expect(serverTimingHeader).toContain('sentry-trace');
expect(serverTimingHeader).toContain('baggage');
});
4 changes: 4 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env
2 changes: 2 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873
44 changes: 44 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
* By default, Remix will handle hydrating your app on the client for you.
* You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
* For more information, see https://remix.run/file-conventions/entry.client
*/

// Extend the Window interface to include ENV
declare global {
interface Window {
ENV: {
SENTRY_DSN: string;
[key: string]: unknown;
};
}
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: window.ENV.SENTRY_DSN,
integrations: [
Sentry.browserTracingIntegration({
useEffect,
useLocation,
useMatches,
}),
],
// Performance Monitoring
tracesSampleRate: 1.0, // Capture 100% of the transactions
tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
hydrateRoot(
document,
<StrictMode>
<RemixBrowser />
</StrictMode>,
);
});
115 changes: 115 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
loadContext: AppLoadContext,
) {
return isbot(request.headers.get('user-agent'))
? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
: handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
) {
return new Promise((resolve, reject) => {
let shellRendered = false;
const { pipe, abort } = renderToPipeableStream(
<RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
{
onAllReady() {
shellRendered = true;
const body = new PassThrough();
const stream = createReadableStreamFromReadable(body);

responseHeaders.set('Content-Type', 'text/html');

resolve(
new Response(stream, {
headers: responseHeaders,
status: responseStatusCode,
}),
);

pipe(body);
},
onShellError(error: unknown) {
reject(error);
},
onError(error: unknown) {
responseStatusCode = 500;
if (shellRendered) {
console.error(error);
}
},
},
);

setTimeout(abort, ABORT_DELAY);
});
}

function handleBrowserRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
) {
return new Promise((resolve, reject) => {
let shellRendered = false;
const { pipe, abort } = renderToPipeableStream(
<RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
{
onShellReady() {
shellRendered = true;
const body = new PassThrough();
const stream = createReadableStreamFromReadable(body);

responseHeaders.set('Content-Type', 'text/html');

resolve(
new Response(stream, {
headers: responseHeaders,
status: responseStatusCode,
}),
);

pipe(body);
},
onShellError(error: unknown) {
reject(error);
},
onError(error: unknown) {
responseStatusCode = 500;
if (shellRendered) {
console.error(error);
}
},
},
);

setTimeout(abort, ABORT_DELAY);
});
}
63 changes: 63 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
Links,
LiveReload,
Meta,
Outlet,
Scripts,
ScrollRestoration,
useLoaderData,
useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
return json({
ENV: {
SENTRY_DSN: process.env.E2E_TEST_DSN,
},
});
};

export function ErrorBoundary() {
const error = useRouteError();
const eventId = captureRemixErrorBoundaryError(error);

return (
<div>
<span>ErrorBoundary Error</span>
<span id="event-id">{eventId}</span>
</div>
);
}

function App() {
const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

return (
<html lang="en">
<head>
<meta charSet="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<script
dangerouslySetInnerHTML={{
__html: `window.ENV = ${JSON.stringify(ENV)}`,
}}
/>
<Meta />
<Links />
</head>
<body>
<Outlet />
<ScrollRestoration />
<Scripts />
<LiveReload />
</body>
</html>
);
}

export default withSentry(App);
28 changes: 28 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
return json({});
};

export default function Index() {
const [searchParams] = useSearchParams();

if (searchParams.get('tag')) {
Sentry.setTag('sentry_test', searchParams.get('tag'));
}

return (
<div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
<h1>Server-Timing Trace Propagation Test</h1>
<ul>
<li>
<Link id="navigation" to="/user/123">
Navigate to User 123
</Link>
</li>
</ul>
</div>
);
}
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
return redirect('/user/redirected');
};
19 changes: 19 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
await new Promise(resolve => setTimeout(resolve, 10));
return json({ userId: params.id });
};

export default function User() {
const { userId } = useLoaderData<typeof loader>();

return (
<div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
<h1>User {userId}</h1>
<p>This is a parameterized route for user {userId}.</p>
<Link to="/">Back to Home</Link>
</div>
);
}
2 changes: 2 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />
8 changes: 8 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.E2E_TEST_DSN,
tunnel: 'http://localhost:3031/', // proxy server
});
42 changes: 42 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
"private": true,
"sideEffects": false,
"scripts": {
"build": "remix vite:build && pnpm typecheck",
"dev": "remix vite:dev",
"start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
"typecheck": "tsc",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm playwright test"
},
"dependencies": {
"@sentry/remix": "latest || *",
"@remix-run/css-bundle": "2.17.4",
"@remix-run/node": "2.17.4",
"@remix-run/react": "2.17.4",
"@remix-run/serve": "2.17.4",
"isbot": "^3.6.8",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@playwright/test": "~1.56.0",
"@sentry-internal/test-utils": "link:../../../test-utils",
"@remix-run/dev": "2.17.4",
"@remix-run/eslint-config": "2.17.4",
"@types/react": "^18.2.64",
"@types/react-dom": "^18.2.34",
"@types/prop-types": "15.7.7",
"eslint": "^8.38.0",
"typescript": "^5.1.6",
"vite": "^5.4.11",
"vite-tsconfig-paths": "^4.2.1"
},
"resolutions": {
"@types/react": "18.2.22"
},
"volta": {
"extends": "../../package.json"
}
}
8 changes: 8 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
startCommand: 'pnpm start',
port: 3030,
});

export default config;
2 changes: 2 additions & 0 deletions dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
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
feat(remix): Server Timing Headers Trace Propagation#18653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 6 commits into

from

Mar 18, 2026
 Merged


feat(remix): Server Timing Headers Trace Propagation
#18653
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
a068848

feat(remix): Add Server-Timing header trace propagation


onurtemizkan Feb 20, 2026
3fdd111

Prevent duplicate Server-Timing header entries in Cloudflare


onurtemizkan Feb 23, 2026
15fface

fix incorrect getTraceData usage as well as fix a bug in propagator


Lms24 Mar 18, 2026
aa83a81

lint fix


Lms24 Mar 18, 2026
cab0799

the simpler, the better


Lms24 Mar 18, 2026
9aa98ee

fix unit tests


Lms24 Mar 18, 2026

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


10 changes: 9 additions & 1 deletion
dev-packages/e2e-tests/test-applications/remix-hydrogen/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { RemixServer } from '@remix-run/react';
import { generateSentryServerTimingHeader } from '@sentry/remix/cloudflare';
import { createContentSecurityPolicy } from '@shopify/hydrogen';
import type { EntryContext } from '@shopify/remix-oxygen';
import isbot from 'isbot';
Expand DownExpand Up@@ -43,8 +44,15 @@ export default async function handleRequest(
 // This is required for Sentry's profiling integration
 responseHeaders.set('Document-Policy', 'js-profiling');

return new Response(body, {
const response = new Response(body, {
 headers: responseHeaders,
 status: responseStatusCode,
 });

 const serverTimingValue = generateSentryServerTimingHeader();
 if (serverTimingValue) {
 response.headers.append('Server-Timing', serverTimingValue);
 }

 return response;
}

17 changes: 17 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-timing-header.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect, test } from '@playwright/test';

test('Server-Timing header contains sentry-trace on page load', async ({ page }) => {
 const responsePromise = page.waitForResponse(
 response =>
 response.url().endsWith('/') && response.status() === 200 && response.request().resourceType() === 'document',
 );

 await page.goto('/');

 const response = await responsePromise;
 const serverTimingHeader = response.headers()['server-timing'];

 expect(serverTimingHeader).toBeDefined();
 expect(serverTimingHeader).toContain('sentry-trace');
 expect(serverTimingHeader).toContain('baggage');
});

4 changes: 4 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
 extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
};

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
node_modules
build
.env

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

44 changes: 44 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.client.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
/**
 * By default, Remix will handle hydrating your app on the client for you.
 * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal`
 * For more information, see https://remix.run/file-conventions/entry.client
 */

// Extend the Window interface to include ENV
declare global {
 interface Window {
 ENV: {
 SENTRY_DSN: string;
 [key: string]: unknown;
 };
 }
}

import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
import * as Sentry from '@sentry/remix';
import { StrictMode, startTransition, useEffect } from 'react';
import { hydrateRoot } from 'react-dom/client';

Sentry.init({
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: window.ENV.SENTRY_DSN,
 integrations: [
 Sentry.browserTracingIntegration({
 useEffect,
 useLocation,
 useMatches,
 }),
 ],
 // Performance Monitoring
 tracesSampleRate: 1.0, // Capture 100% of the transactions
 tunnel: 'http://localhost:3031/', // proxy server
});

startTransition(() => {
 hydrateRoot(
 document,
 <StrictMode>
 <RemixBrowser />
 </StrictMode>,
 );
});

115 changes: 115 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/entry.server.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
import * as Sentry from '@sentry/remix';

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { installGlobals } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

installGlobals();

const ABORT_DELAY = 5_000;

export const handleError = Sentry.sentryHandleError;

export default function handleRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 loadContext: AppLoadContext,
) {
 return isbot(request.headers.get('user-agent'))
 ? handleBotRequest(request, responseStatusCode, responseHeaders, remixContext)
 : handleBrowserRequest(request, responseStatusCode, responseHeaders, remixContext);
}

function handleBotRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onAllReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

function handleBrowserRequest(
 request: Request,
 responseStatusCode: number,
 responseHeaders: Headers,
 remixContext: EntryContext,
) {
 return new Promise((resolve, reject) => {
 let shellRendered = false;
 const { pipe, abort } = renderToPipeableStream(
 <RemixServer context={remixContext} url={request.url} abortDelay={ABORT_DELAY} />,
 {
 onShellReady() {
 shellRendered = true;
 const body = new PassThrough();
 const stream = createReadableStreamFromReadable(body);

 responseHeaders.set('Content-Type', 'text/html');

 resolve(
 new Response(stream, {
 headers: responseHeaders,
 status: responseStatusCode,
 }),
 );

 pipe(body);
 },
 onShellError(error: unknown) {
 reject(error);
 },
 onError(error: unknown) {
 responseStatusCode = 500;
 if (shellRendered) {
 console.error(error);
 }
 },
 },
 );

 setTimeout(abort, ABORT_DELAY);
 });
}

63 changes: 63 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import { LinksFunction, json } from '@remix-run/node';
import {
 Links,
 LiveReload,
 Meta,
 Outlet,
 Scripts,
 ScrollRestoration,
 useLoaderData,
 useRouteError,
} from '@remix-run/react';
import { captureRemixErrorBoundaryError, withSentry } from '@sentry/remix';

export const links: LinksFunction = () => [...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : [])];

export const loader = () => {
 return json({
 ENV: {
 SENTRY_DSN: process.env.E2E_TEST_DSN,
 },
 });
};

export function ErrorBoundary() {
 const error = useRouteError();
 const eventId = captureRemixErrorBoundaryError(error);

 return (
 <div>
 <span>ErrorBoundary Error</span>
 <span id="event-id">{eventId}</span>
 </div>
 );
}

function App() {
 const { ENV } = useLoaderData() as { ENV: { SENTRY_DSN: string } };

 return (
 <html lang="en">
 <head>
 <meta charSet="utf-8" />
 <meta name="viewport" content="width=device-width,initial-scale=1" />
 <script
 dangerouslySetInnerHTML={{
 __html: `window.ENV = ${JSON.stringify(ENV)}`,
 }}
 />
 <Meta />
 <Links />
 </head>
 <body>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
 <LiveReload />
 </body>
 </html>
 );
}

export default withSentry(App);

28 changes: 28 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/_index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useSearchParams } from '@remix-run/react';
import * as Sentry from '@sentry/remix';

export const loader = async ({ request }: LoaderFunctionArgs) => {
 return json({});
};

export default function Index() {
 const [searchParams] = useSearchParams();

 if (searchParams.get('tag')) {
 Sentry.setTag('sentry_test', searchParams.get('tag'));
 }

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>Server-Timing Trace Propagation Test</h1>
 <ul>
 <li>
 <Link id="navigation" to="/user/123">
 Navigate to User 123
 </Link>
 </li>
 </ul>
 </div>
 );
}

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/redirect-test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
import { redirect } from '@remix-run/node';

export const loader = async () => {
 return redirect('/user/redirected');
};

19 changes: 19 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/app/routes/user.$id.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
import { json, LoaderFunctionArgs } from '@remix-run/node';
import { Link, useLoaderData } from '@remix-run/react';

export const loader = async ({ params }: LoaderFunctionArgs) => {
 await new Promise(resolve => setTimeout(resolve, 10));
 return json({ userId: params.id });
};

export default function User() {
 const { userId } = useLoaderData<typeof loader>();

 return (
 <div style={{ fontFamily: 'system-ui, sans-serif', lineHeight: '1.8' }}>
 <h1>User {userId}</h1>
 <p>This is a parameterized route for user {userId}.</p>
 <Link to="/">Back to Home</Link>
 </div>
 );
}

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/globals.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/node" />
/// <reference types="vite/client" />

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/instrument.server.cjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
const Sentry = require('@sentry/remix');

Sentry.init({
 tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
 environment: 'qa', // dynamic sampling bias to keep transactions
 dsn: process.env.E2E_TEST_DSN,
 tunnel: 'http://localhost:3031/', // proxy server
});

42 changes: 42 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
{
 "private": true,
 "sideEffects": false,
 "scripts": {
 "build": "remix vite:build && pnpm typecheck",
 "dev": "remix vite:dev",
 "start": "NODE_OPTIONS='--require=./instrument.server.cjs' remix-serve build/server/index.js",
 "typecheck": "tsc",
 "clean": "npx rimraf node_modules pnpm-lock.yaml",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm playwright test"
 },
 "dependencies": {
 "@sentry/remix": "latest || *",
 "@remix-run/css-bundle": "2.17.4",
 "@remix-run/node": "2.17.4",
 "@remix-run/react": "2.17.4",
 "@remix-run/serve": "2.17.4",
 "isbot": "^3.6.8",
 "react": "^18.2.0",
 "react-dom": "^18.2.0"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@remix-run/dev": "2.17.4",
 "@remix-run/eslint-config": "2.17.4",
 "@types/react": "^18.2.64",
 "@types/react-dom": "^18.2.34",
 "@types/prop-types": "15.7.7",
 "eslint": "^8.38.0",
 "typescript": "^5.1.6",
 "vite": "^5.4.11",
 "vite-tsconfig-paths": "^4.2.1"
 },
 "resolutions": {
 "@types/react": "18.2.22"
 },
 "volta": {
 "extends": "../../package.json"
 }
}

8 changes: 8 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
 startCommand: 'pnpm start',
 port: 3030,
});

export default config;

2 changes: 2 additions & 0 deletions
dev-packages/e2e-tests/test-applications/remix-server-timing/remix.env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
/// <reference types="@remix-run/dev" />
/// <reference types="@remix-run/node" />
Loading
Loading