Skip to content
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.

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

fix(sveltekit): Avoid invalidating data on route changes in wrapServerLoadWithSentry #8801

Merged
merged 3 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/sveltekit/src/server/load.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,12 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe

addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

const routeId = event.route && event.route.id;
// Accessing any member of `event.route` causes SvelteKit to invalidate the
// server `load` function's data on every route change.
// To work around this, we use `Object.getOwnPropertyDescriptor` which doesn't invoke the proxy.
// https://github.com/sveltejs/kit/blob/e133aba479fa9ba0e7f9e71512f5f937f0247e2c/packages/kit/src/runtime/server/page/load_data.js#L111C3-L124
const routeId = event.route && (Object.getOwnPropertyDescriptor(event.route, 'id')?.value as string | undefined);
// const routeId = event.route.id;
Lms24 marked this conversation as resolved.
Show resolved Hide resolved

const { dynamicSamplingContext, traceparentData, propagationContext } = getTracePropagationData(event);
getCurrentHub().getScope().setPropagationContext(propagationContext);
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/server/load.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -400,4 +400,33 @@ describe('wrapServerLoadWithSentry calls trace', () => {

expect(mockTrace).toHaveBeenCalledTimes(1);
});

it("doesn't invoke the proxy set on `event.route`", async () => {
const event = getServerOnlyArgs();

// simulates SvelteKit adding a proxy to `event.route`
// https://github.com/sveltejs/kit/blob/e133aba479fa9ba0e7f9e71512f5f937f0247e2c/packages/kit/src/runtime/server/page/load_data.js#L111C3-L124
const proxyFn = vi.fn((target: { id: string }, key: string | symbol): any => {
return target[key];
});

event.route = new Proxy(event.route, {
get: proxyFn,
});

const wrappedLoad = wrapServerLoadWithSentry(serverLoad);
await wrappedLoad(event);

expect(mockTrace).toHaveBeenCalledTimes(1);
expect(mockTrace).toHaveBeenCalledWith(
expect.objectContaining({
op: 'function.sveltekit.server.load',
name: '/users/[id]', // <-- this shows that the route was still accessed
}),
expect.any(Function),
expect.any(Function),
);

expect(proxyFn).not.toHaveBeenCalled();
});
});
Loading