Skip to content

fix(sveltekit): Avoid data invalidation in wrapped client-side load functions #9071

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

Merged
merged 1 commit into from
Oct 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

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

const routeId = event.route.id;
// Accessing any member of `event.route` causes SvelteKit to invalidate the
// client-side universal `load` function's data prefetched data, causing another reload on the actual navigation.
// To work around this, we use `Object.getOwnPropertyDescriptor` which doesn't invoke the proxy.
const routeIdDescriptor = event.route && Object.getOwnPropertyDescriptor(event.route, 'id');
// First, we try to access the route id from the property descriptor.
// This will only work for @sveltejs/kit >= 1.24.0
const routeIdFromDescriptor = routeIdDescriptor && (routeIdDescriptor.value as string | undefined);
// If routeIdFromDescriptor is undefined, we fall back to the old behavior of accessing
// `event.route.id` directly. This will still cause invalidations but we get a route name.
const routeId = routeIdFromDescriptor || event.route.id;

return trace(
{
op: 'function.sveltekit.load',
Expand Down