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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: '/users/[id]',
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: '/users/[id]',
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: '/users/[id]',
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions packages/sveltekit/src/client/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
import { captureException } from '@sentry/svelte';
import type { LoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { isHttpError, isRedirect } from '../common/utils';
import { getRouteId, isHttpError, isRedirect } from '../common/utils';

type PatchedLoadEvent = LoadEvent & Partial<SentryWrappedFlag>;

Expand DownExpand Up@@ -72,16 +72,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

// 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;
const routeId = getRouteId(event);

return startSpan(
{
Expand Down
32 changes: 32 additions & 0 deletions packages/sveltekit/src/common/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,38 @@ export type SentryWrappedFlag = {
__sentry_wrapped__?: true;
};

interface EventLike {
route?: {
id?: string | null;
};
untrack<T>(fn: () => T): T;
}

/**
* Get route.id from a load event without triggering SvelteKit's route proxy
* (which would cause unwanted invalidations). Uses `untrack` when available (SvelteKit 2+),
* otherwise falls back to getOwnPropertyDescriptor for SvelteKit 1.x.
*/
export function getRouteId(event: EventLike): string | void {
if (typeof event.untrack === 'function') {
return event.untrack(() => event.route?.id ?? undefined);
}

const route = event.route;
if (!route) {
return;
}

const descriptor = Object.getOwnPropertyDescriptor(route, 'id');
const fromDescriptor = descriptor?.value as string | null | undefined;

if (fromDescriptor !== undefined && fromDescriptor !== null) {
return fromDescriptor;
}

return;
}

/**
* Determines if a thrown "error" is a Redirect object which SvelteKit users can throw to redirect to another route
* see: https://kit.svelte.dev/docs/modules#sveltejs-kit-redirect
Expand Down
10 changes: 5 additions & 5 deletions packages/sveltekit/src/server-common/load.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
} from '@sentry/core';
import type { LoadEvent, ServerLoadEvent } from '@sveltejs/kit';
import type { SentryWrappedFlag } from '../common/utils';
import { getRouteId } from '../common/utils';
import { sendErrorToSentry } from './utils';

type PatchedLoadEvent = LoadEvent & SentryWrappedFlag;
Expand All@@ -33,7 +34,7 @@ export function wrapLoadWithSentry<T extends (...args: any) => any>(origLoad: T)

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

const routeId = event.route?.id;
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand DownExpand Up@@ -94,10 +95,9 @@ export function wrapServerLoadWithSentry<T extends (...args: any) => any>(origSe
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true);

// 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);
// server `load` function's data on every route change. We use `getRouteId` which uses
// SvelteKit 2's `untrack` when available, otherwise getOwnPropertyDescriptor for 1.x.
const routeId = getRouteId(event);

try {
// We need to await before returning, otherwise we won't catch any errors thrown by the load function
Expand Down
29 changes: 29 additions & 0 deletions packages/sveltekit/test/client/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,35 @@ describe('wrapLoadWithSentry', () => {
expect.any(Function),
);
});

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const routeIdFromUntrack = '/users/[id]';
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
params: MOCK_LOAD_ARGS.params,
route: { id: routeIdFromUntrack },
url: MOCK_LOAD_ARGS.url,
untrack,
};

async function load({ params }: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return { post: params.id };
}

const wrappedLoad = wrapLoadWithSentry(load);
await wrappedLoad(eventWithUntrack);

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: routeIdFromUntrack,
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});

it('adds an exception mechanism', async () => {
Expand Down
66 changes: 64 additions & 2 deletions packages/sveltekit/test/common/utils.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest';
import { isHttpError, isRedirect } from '../../src/common/utils';
import { describe, expect, it, vi } from 'vitest';
import { getRouteId, isHttpError, isRedirect } from '../../src/common/utils';

describe('isRedirect', () => {
it.each([
Expand DownExpand Up@@ -40,3 +40,65 @@ describe('isHttpError', () => {
},
);
});

describe('getRouteId', () => {
it('returns route.id when event has untrack (SvelteKit 2+)', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: '/blog/[slug]' },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe('/blog/[slug]');

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('returns undefined when event has untrack but route.id is null', () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const event = {
route: { id: null },
untrack,
};

// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBeUndefined();

expect(untrack).toHaveBeenCalledTimes(1);
expect(untrack).toHaveBeenCalledWith(expect.any(Function));
});

it('falls back to getOwnPropertyDescriptor and avoids triggering the proxy', () => {
const routeId = '/users/[id]';

let routeIdAccessed = false;
const route = { id: routeId };

// taken from https://github.com/sveltejs/kit/blob/159aece0654db020f95bc414f6a21f25fbc5f22f/packages/kit/src/runtime/client/client.js#L783-L790
const proxiedRoute = new Proxy(route, {
get: (target, key) => {
routeIdAccessed = true;
// @ts-expect-error - this is fine for the test
return target[key];
},
});

const event = { route: proxiedRoute };
// @ts-expect-error - only passing a partial load event here
expect(getRouteId(event)).toBe(routeId);
expect(routeIdAccessed).toBe(false);

// sanity check that the proxying mechanism works
expect(event.route.id).toBe(routeId);
expect(routeIdAccessed).toBe(true);
});

it('returns undefined when event has no route', () => {
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({})).toBeUndefined();
// @ts-expect-error - only passing a partial load event here
expect(getRouteId({ route: null })).toBeUndefined();
});
});
22 changes: 22 additions & 0 deletions packages/sveltekit/test/server-common/load.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -304,4 +304,26 @@ describe('wrapServerLoadWithSentry calls `startSpan`', () => {

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

it('uses untrack when present (SvelteKit 2+) to get route id without triggering invalidation', async () => {
const untrack = vi.fn(<T>(fn: () => T) => fn());
const eventWithUntrack = {
...getServerOnlyArgs(),
untrack,
};

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

expect(untrack).toHaveBeenCalledTimes(1);
expect(mockStartSpan).toHaveBeenCalledWith(
expect.objectContaining({
name: '/users/[id]',
attributes: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
}),
expect.any(Function),
);
});
});
Loading