feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

Closed
Lms24 wants to merge 3 commits into from
Closed

feat(sveltekit)!: Remove fetch proxy script injection and options #15012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69e5a3b
feat(sveltekit)!: Remove fetch proxy script injection and options
Lms24 Jan 14, 2025
682a818
add migration note
Lms24 Jan 14, 2025
315ffe3
remove more unused code
Lms24 Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/migration/v8-to-v9.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down
53 changes: 6 additions & 47 deletions packages/sveltekit/src/server/handle.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
* @default false
*/
handleUnknownRoutes?: boolean;

/**
* Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
* of `fetch` calls in `load` functions.
*
* @default true
*/
injectFetchProxyScript?: boolean;

/**
* If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
* tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
* in `load` functions.
*
* Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
*/
fetchProxyScriptNonce?: string;
};

/**
* Exported only for testing
*/
export const FETCH_PROXY_SCRIPT = `
const f = window.fetch;
if(f){
window._sentryFetchProxy = function(...a){return f(...a)}
window.fetch = function(...a){return window._sentryFetchProxy(...a)}
}
`;

/**
* Adds Sentry tracing <meta> tags to the returned html page.
* Adds Sentry fetch proxy script to the returned html page if enabled in options.
* Also adds a nonce attribute to the script tag if users specified one for CSP.
*
* Exported only for testing
*/
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
// if injectFetchProxyScript is not set, we default to true
const shouldInjectScript = injectFetchProxyScript !== false;
const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

return ({ html }) => {
const metaTags = getTraceMetaTags();
const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

return html.replace('<head>', modifiedHead);
};
}
export const addSentryCodeToPage = (({ html }) => {
const metaTags = getTraceMetaTags();
const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
* A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
const options = {
handleUnknownRoutes: false,
injectFetchProxyScript: true,
...handlerOptions,
};

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
});
const res = await resolve(event, {
transformPageChunk: addSentryCodeToPage(options),
transformPageChunk: addSentryCodeToPage,
});
if (span) {
setHttpStatus(span, res.status);
Expand Down
35 changes: 5 additions & 30 deletions packages/sveltekit/test/server/handle.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
</body>
</html>`;

it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
const transformPageChunk = addSentryCodeToPage({});
const transformed = transformPageChunk({ html, done: true });
it("Adds add meta tags if there's no active transaction", () => {
const transformed = addSentryCodeToPage({ html, done: true });

expect(transformed).toContain('<meta name="sentry-trace"');
expect(transformed).toContain('<meta name="baggage"');
expect(transformed).not.toContain('sentry-transaction=');
expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
});

it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
const transformPageChunk = addSentryCodeToPage({});
it('adds meta tags if there is an active transaction', () => {
SentryNode.startSpan({ name: 'test' }, () => {
const transformed = transformPageChunk({ html, done: true }) as string;
const transformed = addSentryCodeToPage({ html, done: true });

expect(transformed).toContain('<meta name="sentry-trace"');
expect(transformed).toContain('<meta name="baggage"');
expect(transformed).toContain('sentry-transaction=test');
expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
});
});

it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
SentryNode.startSpan({ name: 'test' }, () => {
const transformed = transformPageChunk({ html, done: true }) as string;

expect(transformed).toContain('<meta name="sentry-trace"');
expect(transformed).toContain('<meta name="baggage"');
expect(transformed).toContain('sentry-transaction=test');
expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
});
});

it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
const transformed = transformPageChunk({ html, done: true }) as string;

expect(transformed).toContain('<meta name="sentry-trace"');
expect(transformed).toContain('<meta name="baggage"');
expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
});
});
, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});

, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});

, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});

, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});

, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});

, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});

, '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
feat(sveltekit)!: Remove fetch proxy script injection and options#15012

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

 Closed

Lms24
wants to merge
3
commits into

from

 Closed


feat(sveltekit)!: Remove fetch proxy script injection and options
#15012
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
69e5a3b

feat(sveltekit)!: Remove fetch proxy script injection and options


Lms24 Jan 14, 2025
682a818

add migration note


Lms24 Jan 14, 2025
315ffe3

remove more unused code


Lms24 Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
docs/migration/v8-to-v9.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,11 @@ Older Typescript versions _may_ still work, but we will not test them anymore an

- By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.

### `@sentry/sveltekit`

- SvelteKit 1 is no longer supported, due to some features missing in the first version of the framework. This allows the SDK to remove some brittle workarounds that were necessary for proper 1.x support.
- In v8, the Sentry SvelteKit SDK would inject a small `<script>` into your rendered HTML server response to correctly instrument client-side `fetch` calls. This no longer is necessary with SvelteKit 2.x. Therefore, SDK no longer injects this script. Likewise, the `fetchProxyScriptNonce` and `injectFetchProxyScript` were removed from the `sentryHandle` options. Besides removing the removed options if you set them, we recommend reviewing your CSP settings to remove any nonce or hash entries for the no longer injected script.

### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)

- Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
Expand Down

53 changes: 6 additions & 47 deletions
packages/sveltekit/src/server/handle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,60 +35,20 @@ export type SentryHandleOptions = {
 * @default false
 */
 handleUnknownRoutes?: boolean;

 /**
 * Controls if `sentryHandle` should inject a script tag into the page that enables instrumentation
 * of `fetch` calls in `load` functions.
 *
 * @default true
 */
 injectFetchProxyScript?: boolean;

 /**
 * If this option is set, the `sentryHandle` handler will add a nonce attribute to the script
 * tag it injects into the page. This script is used to enable instrumentation of `fetch` calls
 * in `load` functions.
 *
 * Use this if your CSP policy blocks the fetch proxy script injected by `sentryHandle`.
 */
 fetchProxyScriptNonce?: string;
};

/**
 * Exported only for testing
 */
export const FETCH_PROXY_SCRIPT = `
 const f = window.fetch;
 if(f){
 window._sentryFetchProxy = function(...a){return f(...a)}
 window.fetch = function(...a){return window._sentryFetchProxy(...a)}
 }
`;

/**
 * Adds Sentry tracing <meta> tags to the returned html page.
 * Adds Sentry fetch proxy script to the returned html page if enabled in options.
 * Also adds a nonce attribute to the script tag if users specified one for CSP.
 *
 * Exported only for testing
 */
export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<ResolveOptions['transformPageChunk']> {
 const { fetchProxyScriptNonce, injectFetchProxyScript } = options;
 // if injectFetchProxyScript is not set, we default to true
 const shouldInjectScript = injectFetchProxyScript !== false;
 const nonce = fetchProxyScriptNonce ? `nonce="${fetchProxyScriptNonce}"` : '';

 return ({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';

 const headWithFetchScript = shouldInjectScript ? `\n<script ${nonce}>${FETCH_PROXY_SCRIPT}</script>` : '';

 const modifiedHead = `${headWithMetaTags}${headWithFetchScript}`;

 return html.replace('<head>', modifiedHead);
 };
}
export const addSentryCodeToPage = (({ html }) => {
 const metaTags = getTraceMetaTags();
 const headWithMetaTags = metaTags ? `<head>\n${metaTags}` : '<head>';
 return html.replace('<head>', headWithMetaTags);
}) satisfies NonNullable<ResolveOptions['transformPageChunk']>;

/**
 * A SvelteKit handle function that wraps the request for Sentry error and
Expand All@@ -108,7 +68,6 @@ export function addSentryCodeToPage(options: SentryHandleOptions): NonNullable<R
export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
 const options = {
 handleUnknownRoutes: false,
 injectFetchProxyScript: true,
 ...handlerOptions,
 };

Expand DownExpand Up@@ -174,7 +133,7 @@ async function instrumentHandle(
 normalizedRequest: winterCGRequestToRequestData(event.request.clone()),
 });
 const res = await resolve(event, {
 transformPageChunk: addSentryCodeToPage(options),
 transformPageChunk: addSentryCodeToPage,
 });
 if (span) {
 setHttpStatus(span, res.status);
Expand Down

35 changes: 5 additions & 30 deletions
packages/sveltekit/test/server/handle.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ import type { Handle } from '@sveltejs/kit';
import { redirect } from '@sveltejs/kit';
import { vi } from 'vitest';

import { FETCH_PROXY_SCRIPT, addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { addSentryCodeToPage, sentryHandle } from '../../src/server/handle';
import { getDefaultNodeClientOptions } from '../utils';

const mockCaptureException = vi.spyOn(SentryNode, 'captureException').mockImplementation(() => 'xx');
Expand DownExpand Up@@ -429,46 +429,21 @@ describe('addSentryCodeToPage', () => {
 </body>
 </html>`;

 it("Adds add meta tags and fetch proxy script if there's no active transaction", () => {
 const transformPageChunk = addSentryCodeToPage({});
 const transformed = transformPageChunk({ html, done: true });
 it("Adds add meta tags if there's no active transaction", () => {
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain('sentry-transaction=');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });

 it('adds meta tags and the fetch proxy script if there is an active transaction', () => {
 const transformPageChunk = addSentryCodeToPage({});
 it('adds meta tags if there is an active transaction', () => {
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;
 const transformed = addSentryCodeToPage({ html, done: true });

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('adds a nonce attribute to the script if the `fetchProxyScriptNonce` option is specified', () => {
 const transformPageChunk = addSentryCodeToPage({ fetchProxyScriptNonce: '123abc' });
 SentryNode.startSpan({ name: 'test' }, () => {
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).toContain('sentry-transaction=test');
 expect(transformed).toContain(`<script nonce="123abc">${FETCH_PROXY_SCRIPT}</script>`);
 });
 });

 it('does not add the fetch proxy script if the `injectFetchProxyScript` option is false', () => {
 const transformPageChunk = addSentryCodeToPage({ injectFetchProxyScript: false });
 const transformed = transformPageChunk({ html, done: true }) as string;

 expect(transformed).toContain('<meta name="sentry-trace"');
 expect(transformed).toContain('<meta name="baggage"');
 expect(transformed).not.toContain(`<script >${FETCH_PROXY_SCRIPT}</script>`);
 });
});