Skip to content

fix(remix): Avoid rewrapping root loader. #16136

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
merged 4 commits into from
Apr 28, 2025
Merged

fix(remix): Avoid rewrapping root loader. #16136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7c9372
fix(remix): Avoid rewrapping root loader.
onurtemizkan Apr 25, 2025
c0a0312
Bump `remix` to `2.16.5` in e2e test app.
onurtemizkan Apr 25, 2025
f9fced8
Match previous wrapper usage
onurtemizkan Apr 25, 2025
9df73ea
Align tests
onurtemizkan Apr 25, 2025
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
12 changes: 6 additions & 6 deletions dev-packages/e2e-tests/test-applications/create-remix-app-v2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@
},
"dependencies": {
"@sentry/remix": "latest || *",
"@remix-run/css-bundle": "2.7.2",
"@remix-run/node": "2.7.2",
"@remix-run/react": "2.7.2",
"@remix-run/serve": "2.7.2",
"@remix-run/css-bundle": "2.16.5",
"@remix-run/node": "2.16.5",
"@remix-run/react": "2.16.5",
"@remix-run/serve": "2.16.5",
"isbot": "^3.6.8",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@playwright/test": "~1.50.0",
"@sentry-internal/test-utils": "link:../../../test-utils",
"@remix-run/dev": "2.7.2",
"@remix-run/eslint-config": "2.7.2",
"@remix-run/dev": "2.16.5",
"@remix-run/eslint-config": "2.16.5",
"@sentry/core": "latest || *",
"@types/react": "^18.0.35",
"@types/react-dom": "^18.0.11",
Expand Down
2 changes: 0 additions & 2 deletions dev-packages/e2e-tests/test-applications/remix-hydrogen/tests/server-transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ test('Sends two linked transactions (server & client) to Sentry', async ({ page

const httpServerTraceId = httpServerTransaction.contexts?.trace?.trace_id;
const httpServerSpanId = httpServerTransaction.contexts?.trace?.span_id;
const loaderSpanId = httpServerTransaction?.spans?.find(span => span.op === 'function.remix.loader')?.span_id;
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There was a loader span here, and not anymore. This was probably a result of unnecessary rewrapping. And that span didn't contribute to the span linking on Hydrogen.


const pageLoadTraceId = pageloadTransaction.contexts?.trace?.trace_id;
const pageLoadSpanId = pageloadTransaction.contexts?.trace?.span_id;
Expand All @@ -50,7 +49,6 @@ test('Sends two linked transactions (server & client) to Sentry', async ({ page

expect(httpServerTraceId).toBeDefined();
expect(httpServerSpanId).toBeDefined();
expect(loaderSpanId).toBeDefined();

expect(pageLoadTraceId).toEqual(httpServerTraceId);
expect(pageLoadSpanId).not.toEqual(httpServerSpanId);
Expand Down
23 changes: 12 additions & 11 deletions packages/remix/src/server/instrumentServer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,18 @@ function instrumentBuildCallback(
for (const [id, route] of Object.entries(build.routes)) {
const wrappedRoute = { ...route, module: { ...route.module } };

// Entry module should have a loader function to provide `sentry-trace` and `baggage`
// They will be available for the root `meta` function as `data.sentryTrace` and `data.sentryBaggage`
if (!wrappedRoute.parentId) {
if (!wrappedRoute.module.loader) {
wrappedRoute.module.loader = () => ({});
}

if (!(wrappedRoute.module.loader as WrappedFunction).__sentry_original__) {
fill(wrappedRoute.module, 'loader', makeWrappedRootLoader());
}
}

const routeAction = wrappedRoute.module.action as undefined | WrappedFunction;
if (routeAction && !routeAction.__sentry_original__) {
fill(wrappedRoute.module, 'action', makeWrappedAction(id, options?.instrumentTracing));
Expand All @@ -374,17 +386,6 @@ function instrumentBuildCallback(
fill(wrappedRoute.module, 'loader', makeWrappedLoader(id, options?.instrumentTracing));
}

// Entry module should have a loader function to provide `sentry-trace` and `baggage`
// They will be available for the root `meta` function as `data.sentryTrace` and `data.sentryBaggage`
if (!wrappedRoute.parentId) {
if (!wrappedRoute.module.loader) {
wrappedRoute.module.loader = () => ({});
}

// We want to wrap the root loader regardless of whether it's already wrapped before.
fill(wrappedRoute.module, 'loader', makeWrappedRootLoader());
}

routes[id] = wrappedRoute;
}

Expand Down
4 changes: 2 additions & 2 deletions packages/remix/test/integration/test/server/instrumentation/action.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ describe('Remix API Actions', () => {
data: {
'code.function': 'loader',
'sentry.op': 'loader.remix',
'match.route.id': 'routes/action-json-response.$id',
'match.route.id': 'root',
'match.params.id': '123123',
},
},
{
data: {
'code.function': 'loader',
'sentry.op': 'loader.remix',
'match.route.id': 'root',
'match.route.id': 'routes/action-json-response.$id',
'match.params.id': '123123',
},
},
Expand Down
4 changes: 2 additions & 2 deletions packages/remix/test/integration/test/server/instrumentation/loader.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,14 +242,14 @@ describe('Remix API Loaders', () => {
data: {
'code.function': 'loader',
'sentry.op': 'loader.remix',
'match.route.id': 'routes/loader-defer-response.$id',
'match.route.id': 'root',
},
},
{
data: {
'code.function': 'loader',
'sentry.op': 'loader.remix',
'match.route.id': 'root',
'match.route.id': 'routes/loader-defer-response.$id',
},
},
],
Expand Down
Loading