fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Lms24 merged 2 commits into from
Jun 22, 2023
Merged

fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid #8381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b79777
fix(sveltekit): Only instrument fetch if the client is valid
Lms24 Jun 22, 2023
38c32ee
linter
Lms24 Jun 22, 2023
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
25 changes: 19 additions & 6 deletions packages/sveltekit/src/client/load.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
addExceptionMechanism,
addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
* @returns a proxy of SvelteKit's fetch implementation
*/
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
const client = getCurrentHub().getClient();

const browserTracingIntegration =
client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
const breadcrumbsIntegration =
client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
if (!isValidClient(client)) {
return originalFetch;
}

const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
},
);
}

type MaybeClientWithGetIntegrationsById =
| (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
| undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
return !!client && typeof client.getIntegrationById === 'function';

@lforstlforstJun 22, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?

@Lms24Lms24Jun 22, 2023•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.
(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)

@lforstlforstJun 22, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Got it. Sounds good!

}
34 changes: 29 additions & 5 deletions packages/sveltekit/test/client/load.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
return undefined;
});

const mockedGetClient = vi.fn(() => {
return {
getIntegrationById: mockedGetIntegrationById,
};
});

vi.mock('@sentry/core', async () => {
const original = (await vi.importActual('@sentry/core')) as any;
return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
},
getCurrentHub: () => {
return {
getClient: () => {
return {
getIntegrationById: mockedGetIntegrationById,
};
},
getClient: mockedGetClient,
getScope: () => {
return {
getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
});
});

it.each([
['is undefined', undefined],
["doesn't have a `getClientById` method", {}],
])("doesn't instrument fetch if the client %s", async (_, client) => {
// @ts-expect-error: we're mocking the client
mockedGetClient.mockImplementationOnce(() => client);

async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
return {
msg: 'hi',
};
}
const wrappedLoad = wrapLoadWithSentry(load);

const originalFetch = MOCK_LOAD_ARGS.fetch;
await wrappedLoad(MOCK_LOAD_ARGS);

expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

it('adds an exception mechanism', async () => {
const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
void callback({}, { event_id: 'fake-event-id' });
Expand Down
, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down

, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down

, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down

, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down

, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down

, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down

, '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
fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid#8381

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 2 commits into

from

Jun 22, 2023
 Merged


fix(sveltekit): Only instrument SvelteKit fetch if the SDK client is valid
#8381
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
0b79777

fix(sveltekit): Only instrument fetch if the client is valid


Lms24 Jun 22, 2023
38c32ee

linter


Lms24 Jun 22, 2023

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


25 changes: 19 additions & 6 deletions
packages/sveltekit/src/client/load.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type { BaseClient } from '@sentry/core';
import { getCurrentHub, trace } from '@sentry/core';
import type { Breadcrumbs, BrowserTracing } from '@sentry/svelte';
import { captureException } from '@sentry/svelte';
import type { ClientOptions, SanitizedRequestData } from '@sentry/types';
import type { Client, ClientOptions, SanitizedRequestData } from '@sentry/types';
import {
 addExceptionMechanism,
 addNonEnumerableProperty,
Expand DownExpand Up@@ -122,12 +122,14 @@ type SvelteKitFetch = LoadEvent['fetch'];
 * @returns a proxy of SvelteKit's fetch implementation
 */
function instrumentSvelteKitFetch(originalFetch: SvelteKitFetch): SvelteKitFetch {
 const client = getCurrentHub().getClient() as BaseClient<ClientOptions>;
 const client = getCurrentHub().getClient();

 const browserTracingIntegration =
 client.getIntegrationById && (client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined);
 const breadcrumbsIntegration =
 client.getIntegrationById && (client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined);
 if (!isValidClient(client)) {
 return originalFetch;
 }

 const browserTracingIntegration = client.getIntegrationById('BrowserTracing') as BrowserTracing | undefined;
 const breadcrumbsIntegration = client.getIntegrationById('Breadcrumbs') as Breadcrumbs | undefined;

 const browserTracingOptions = browserTracingIntegration && browserTracingIntegration.options;

Expand DownExpand Up@@ -270,3 +272,14 @@ function addFetchBreadcrumb(
 },
 );
}

type MaybeClientWithGetIntegrationsById =
 | (Client & { getIntegrationById?: BaseClient<ClientOptions>['getIntegrationById'] })
 | undefined;

type ClientWithGetIntegrationById = Required<MaybeClientWithGetIntegrationsById> &
 Exclude<MaybeClientWithGetIntegrationsById, undefined>;

function isValidClient(client: MaybeClientWithGetIntegrationsById): client is ClientWithGetIntegrationById {
 return !!client && typeof client.getIntegrationById === 'function';
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

m: Why are we additionally making sure getIntegrationById is there? That method is on the BaseClient so I think we can be pretty sure it's there. I think a check if the client exists at all is enough no?
@Lms24Lms24Jun 22, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

For the unlikely case that anyone would use a custom client that doesn't extend BaseClient. I'm aware that this is unlikely but then again, the check doesn't hurt us too much.

(iirc I initially did this also because getClient returns the Client interface on which this method isn't defined. So I needed to type-cast to BaseClient but decided to guard for the method)
@lforstlforstJun 22, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Got it. Sounds good!
}

34 changes: 29 additions & 5 deletions
packages/sveltekit/test/client/load.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,12 @@ const mockedGetIntegrationById = vi.fn(id => {
 return undefined;
});

const mockedGetClient = vi.fn(() => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
});

vi.mock('@sentry/core', async () => {
 const original = (await vi.importActual('@sentry/core')) as any;
 return {
Expand All@@ -62,11 +68,7 @@ vi.mock('@sentry/core', async () => {
 },
 getCurrentHub: () => {
 return {
 getClient: () => {
 return {
 getIntegrationById: mockedGetIntegrationById,
 };
 },
 getClient: mockedGetClient,
 getScope: () => {
 return {
 getSpan: () => {
Expand DownExpand Up@@ -427,6 +429,28 @@ describe('wrapLoadWithSentry', () => {
 });
 });

 it.each([
 ['is undefined', undefined],
 ["doesn't have a `getClientById` method", {}],
 ])("doesn't instrument fetch if the client %s", async (_, client) => {
 // @ts-expect-error: we're mocking the client
 mockedGetClient.mockImplementationOnce(() => client);

 async function load(_event: Parameters<Load>[0]): Promise<ReturnType<Load>> {
 return {
 msg: 'hi',
 };
 }
 const wrappedLoad = wrapLoadWithSentry(load);

 const originalFetch = MOCK_LOAD_ARGS.fetch;
 await wrappedLoad(MOCK_LOAD_ARGS);

 expect(MOCK_LOAD_ARGS.fetch).toStrictEqual(originalFetch);

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

 it('adds an exception mechanism', async () => {
 const addEventProcessorSpy = vi.spyOn(mockScope, 'addEventProcessor').mockImplementationOnce(callback => {
 void callback({}, { event_id: 'fake-event-id' });
Expand Down