feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into from
Jan 14, 2025
Merged

feat(sveltekit): Respect user-provided source map generation settings #14886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a3903df
feat(sveltekit): Enable hidden source maps or keep settings
s1gr1d Jan 2, 2025
55e9775
review suggestions
s1gr1d Jan 7, 2025
afc53f6
updated sourcemap generation settings
s1gr1d Jan 13, 2025
0b141d0
fix tests
s1gr1d Jan 13, 2025
5d6c40e
change comments
s1gr1d Jan 14, 2025
5b0ece0
use globalThis, fix tests, use correct globs
Lms24 Jan 14, 2025
88b4fc9
lint
Lms24 Jan 14, 2025
333e853
fix glob
Lms24 Jan 14, 2025
6759d10
remove unused var
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
2 changes: 1 addition & 1 deletion packages/solidstart/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
// Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
typeof viteConfig.build?.sourcemap === 'undefined'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
// For .output, .vercel, .netlify etc.
updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

consoleSandbox(() => {
Expand Down
167 changes: 141 additions & 26 deletions packages/sveltekit/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
_sentry_sourceMapSetting?: {
updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
previousSourceMapSetting?: UserSourceMapSetting;
};
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
const svelteConfig = await loadSvelteConfig();

const usedAdapter = options?.adapter || 'other';
const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

const defaultPluginOptions: SentryVitePluginOptions = {
release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
},
};

// Including all hidden (`.*`) directories by default so that folders like .vercel,
// .netlify, etc are also cleaned up. Additionally, we include the adapter output
// dir which could be a non-hidden directory, like `build` for the Node adapter.
const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

if (configFile) {
globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
} else {
if (options?.debug) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
'[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
);
});
}
}

if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
.map(file => `"${file}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
});
}
}

const shouldDeleteDefaultSourceMaps =
globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
!options?.sourcemaps?.filesToDeleteAfterUpload;

const mergedOptions = {
...defaultPluginOptions,
...options,
release: {
...defaultPluginOptions.release,
...options?.release,
},
sourcemaps: {
...options?.sourcemaps,
filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
? defaultFileDeletionGlob
: options?.sourcemaps?.filesToDeleteAfterUpload,
},
};

const { debug } = mergedOptions;

const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
const serverHooksFile = getHooksFileName(svelteConfig, 'server');

const globalSentryValues: GlobalSentryValues = {
__sentry_sveltekit_output_dir: outputDir,
__sentry_sveltekit_output_dir: adapterOutputDir,
};

const customDebugIdUploadPlugin: Plugin = {
name: 'sentry-sveltekit-debug-id-upload-plugin',
const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.
name: 'sentry-sveltekit-update-source-map-setting-plugin',
apply: 'build', // only apply this plugin at build time
enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
config: (config: UserConfig) => {
const settingKey = 'build.sourcemap';

// Modify the config to generate source maps
config: config => {
const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
if (debug && sourceMapsPreviouslyNotEnabled) {
// eslint-disable-next-line no-console
console.log('[Source Maps Plugin] Enabling source map generation');
if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
});

return {
...config,
build: { ...config.build, sourcemap: 'hidden' },
};
} else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
`[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
`[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
);
});
} else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
if (mergedOptions?.debug) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
);
});
}
}
return {
...config,
build: {
...config.build,
sourcemap: true,
},
};

return config;
},
};

const customDebugIdUploadPlugin: Plugin = {
name: 'sentry-sveltekit-debug-id-upload-plugin',
apply: 'build', // only apply this plugin at build time
enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
resolveId: (id, _importer, _ref) => {
if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
return;
}

const outDir = path.resolve(process.cwd(), outputDir);
const outDir = path.resolve(process.cwd(), adapterOutputDir);
// eslint-disable-next-line no-console
debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
if (typeof writeBundleFn === 'function') {
// This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
const outDir = path.resolve(process.cwd(), outputDir);
const outDir = path.resolve(process.cwd(), adapterOutputDir);
try {
// @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

return [
...unchangedSentryVitePlugins,
sourceMapSettingsPlugin,
customReleaseManagementPlugin,
customDebugIdUploadPlugin,
customFileDeletionPlugin,
];
}

/**
* Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
*/
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
*
* 1. User explicitly disabled source maps
* - keep this setting (emit a warning that errors won't be unminified in Sentry)
* - We won't upload anything
*
* 2. Users enabled source map generation (true, 'hidden', 'inline').
* - keep this setting (don't do anything - like deletion - besides uploading)
*
* 3. Users didn't set source maps generation
* - we enable 'hidden' source maps generation
* - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
*
* --> only exported for testing
*/
export function getUpdatedSourceMapSetting(viteConfig: {
build?: {
sourcemap?: boolean | 'inline' | 'hidden';
};
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
let previousSourceMapSetting: UserSourceMapSetting;
let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

viteConfig.build = viteConfig.build || {};

const viteSourceMap = viteConfig.build.sourcemap;

if (viteSourceMap === false) {
previousSourceMapSetting = 'disabled';
updatedSourceMapSetting = viteSourceMap;
} else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
previousSourceMapSetting = 'enabled';
updatedSourceMapSetting = viteSourceMap;
} else {
previousSourceMapSetting = 'unset';
updatedSourceMapSetting = 'hidden';
}

return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
if (!fs.existsSync(dir)) {
return [];
Expand Down
5 changes: 3 additions & 2 deletions packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

expect(plugins).toBeInstanceOf(Array);
// 1 auto instrument plugin + 5 source maps plugins
expect(plugins).toHaveLength(7);
expect(plugins).toHaveLength(8);
});

it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
'sentry-telemetry-plugin',
'sentry-vite-release-injection-plugin',
'sentry-vite-debug-id-injection-plugin',
'sentry-sveltekit-update-source-map-setting-plugin',
// custom release plugin:
'sentry-sveltekit-release-management-plugin',
// custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
const pluginNames = plugins.map(plugin => plugin.name);
expect(plugins).toHaveLength(6);
expect(plugins).toHaveLength(7);
expect(pluginNames).not.toContain('sentry-upload-source-maps');
});

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

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading

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

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading

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

Skip to content
feat(sveltekit): Respect user-provided source map generation settings#14886

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 9 commits into

from

Jan 14, 2025
 Merged


feat(sveltekit): Respect user-provided source map generation settings
#14886
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
a3903df

feat(sveltekit): Enable hidden source maps or keep settings


s1gr1d Jan 2, 2025
55e9775

review suggestions


s1gr1d Jan 7, 2025
afc53f6

updated sourcemap generation settings


s1gr1d Jan 13, 2025
0b141d0

fix tests


s1gr1d Jan 13, 2025
5d6c40e

change comments


s1gr1d Jan 14, 2025
5b0ece0

use globalThis, fix tests, use correct globs


Lms24 Jan 14, 2025
88b4fc9

lint


Lms24 Jan 14, 2025
333e853

fix glob


Lms24 Jan 14, 2025
6759d10

remove unused var


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


2 changes: 1 addition & 1 deletion
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions,
 // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
 typeof viteConfig.build?.sourcemap === 'undefined'
 ) {
 // This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
 // For .output, .vercel, .netlify etc.
 updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];

 consoleSandbox(() => {
Expand Down

167 changes: 141 additions & 26 deletions
packages/sveltekit/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
/* eslint-disable max-lines */
import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { escapeStringForRegex, uuid4 } from '@sentry/core';
import { consoleSandbox, escapeStringForRegex, uuid4 } from '@sentry/core';
import { getSentryRelease } from '@sentry/node';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import { type Plugin, type UserConfig, loadConfigFromFile } from 'vite';

import MagicString from 'magic-string';
import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
Expand All@@ -23,6 +24,13 @@ type Sorcery = {
 load(filepath: string): Promise<Chain>;
};

type GlobalWithSourceMapSetting = typeof globalThis & {
 _sentry_sourceMapSetting?: {
 updatedSourceMapSetting?: boolean | 'inline' | 'hidden';
 previousSourceMapSetting?: UserSourceMapSetting;
 };
};

// storing this in the module scope because `makeCustomSentryVitePlugin` is called multiple times
// and we only want to generate a uuid once in case we have to fall back to it.
const releaseName = detectSentryRelease();
Expand All@@ -47,7 +55,9 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const svelteConfig = await loadSvelteConfig();

 const usedAdapter = options?.adapter || 'other';
 const outputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);
 const adapterOutputDir = await getAdapterOutputDir(svelteConfig, usedAdapter);

 const globalWithSourceMapSetting = globalThis as GlobalWithSourceMapSetting;

 const defaultPluginOptions: SentryVitePluginOptions = {
 release: {
Expand All@@ -60,14 +70,58 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 },
 };

 // Including all hidden (`.*`) directories by default so that folders like .vercel,
 // .netlify, etc are also cleaned up. Additionally, we include the adapter output
 // dir which could be a non-hidden directory, like `build` for the Node adapter.
 const defaultFileDeletionGlob = ['./.*/**/*.map', `./${adapterOutputDir}/**/*.map`];

 if (!globalWithSourceMapSetting._sentry_sourceMapSetting) {
 const configFile = await loadConfigFromFile({ command: 'build', mode: 'production' });

 if (configFile) {
 globalWithSourceMapSetting._sentry_sourceMapSetting = getUpdatedSourceMapSetting(configFile.config);
 } else {
 if (options?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 '[Sentry] Could not load Vite config with Vite "production" mode. This is needed for Sentry to automatically update source map settings.',
 );
 });
 }
 }

 if (options?.debug && globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
 .map(file => `"${file}"`)
 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
 );
 });
 }
 }

 const shouldDeleteDefaultSourceMaps =
 globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset' &&
 !options?.sourcemaps?.filesToDeleteAfterUpload;

 const mergedOptions = {
 ...defaultPluginOptions,
 ...options,
 release: {
 ...defaultPluginOptions.release,
 ...options?.release,
 },
 sourcemaps: {
 ...options?.sourcemaps,
 filesToDeleteAfterUpload: shouldDeleteDefaultSourceMaps
 ? defaultFileDeletionGlob
 : options?.sourcemaps?.filesToDeleteAfterUpload,
 },
 };

 const { debug } = mergedOptions;

 const sentryPlugins: Plugin[] = await sentryVitePlugin(mergedOptions);
Expand DownExpand Up@@ -126,37 +180,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const serverHooksFile = getHooksFileName(svelteConfig, 'server');

 const globalSentryValues: GlobalSentryValues = {
 __sentry_sveltekit_output_dir: outputDir,
 __sentry_sveltekit_output_dir: adapterOutputDir,
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 const sourceMapSettingsPlugin: Plugin = {
Comment thread
Lms24 marked this conversation as resolved.

 name: 'sentry-sveltekit-update-source-map-setting-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 config: (config: UserConfig) => {
 const settingKey = 'build.sourcemap';

 // Modify the config to generate source maps
 config: config => {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Source Maps Plugin] Enabling source map generation');
 if (!mergedOptions.sourcemaps?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'unset') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
 });

 return {
 ...config,
 build: { ...config.build, sourcemap: 'hidden' },
 };
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'disabled') {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Source Maps Plugin] We recommend setting the \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Source Maps Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 `[Sentry] Parts of source map generation are currently disabled in your Vite configuration (\`${settingKey}: false\`). This setting is either a default setting or was explicitly set in your configuration. Sentry won't override this setting. Without source maps, code snippets on the Sentry Issues page will remain minified. To show unminified code, enable source maps in \`${settingKey}\` (e.g. by setting them to \`hidden\`).`,
 );
 });
 } else if (globalWithSourceMapSetting._sentry_sourceMapSetting?.previousSourceMapSetting === 'enabled') {
 if (mergedOptions?.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] We discovered you enabled source map generation in your Vite configuration (\`${settingKey}\`). Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
 );
 });
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };

 return config;
 },
 };

 const customDebugIdUploadPlugin: Plugin = {
 name: 'sentry-sveltekit-debug-id-upload-plugin',
 apply: 'build', // only apply this plugin at build time
 enforce: 'post', // this needs to be set to post, otherwise we don't pick up the output from the SvelteKit adapter
 resolveId: (id, _importer, _ref) => {
 if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
 return {
Expand DownExpand Up@@ -211,7 +279,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 return;
 }

 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 // eslint-disable-next-line no-console
 debug && console.log('[Source Maps Plugin] Looking up source maps in', outDir);

Expand DownExpand Up@@ -297,7 +365,7 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 const writeBundleFn = sentryViteFileDeletionPlugin?.writeBundle;
 if (typeof writeBundleFn === 'function') {
 // This is fine though, because the original method doesn't consume any arguments in its `writeBundle` callback.
 const outDir = path.resolve(process.cwd(), outputDir);
 const outDir = path.resolve(process.cwd(), adapterOutputDir);
 try {
 // @ts-expect-error - the writeBundle hook expects two args we can't pass in here (they're only available in `writeBundle`)
 await writeBundleFn({ dir: outDir });
Expand DownExpand Up@@ -326,12 +394,59 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug

 return [
 ...unchangedSentryVitePlugins,
 sourceMapSettingsPlugin,
 customReleaseManagementPlugin,
 customDebugIdUploadPlugin,
 customFileDeletionPlugin,
 ];
}

/**
 * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
 */
export type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;

/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
 *
 * 1. User explicitly disabled source maps
 * - keep this setting (emit a warning that errors won't be unminified in Sentry)
 * - We won't upload anything
 *
 * 2. Users enabled source map generation (true, 'hidden', 'inline').
 * - keep this setting (don't do anything - like deletion - besides uploading)
 *
 * 3. Users didn't set source maps generation
 * - we enable 'hidden' source maps generation
 * - configure `filesToDeleteAfterUpload` to delete all .map files (we emit a log about this)
 *
 * --> only exported for testing
 */
export function getUpdatedSourceMapSetting(viteConfig: {
 build?: {
 sourcemap?: boolean | 'inline' | 'hidden';
 };
}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
 let previousSourceMapSetting: UserSourceMapSetting;
 let updatedSourceMapSetting: boolean | 'inline' | 'hidden' | undefined;

 viteConfig.build = viteConfig.build || {};

 const viteSourceMap = viteConfig.build.sourcemap;

 if (viteSourceMap === false) {
 previousSourceMapSetting = 'disabled';
 updatedSourceMapSetting = viteSourceMap;
 } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
 previousSourceMapSetting = 'enabled';
 updatedSourceMapSetting = viteSourceMap;
 } else {
 previousSourceMapSetting = 'unset';
 updatedSourceMapSetting = 'hidden';
 }

 return { previousSourceMapSetting, updatedSourceMapSetting };
}

function getFiles(dir: string): string[] {
 if (!fs.existsSync(dir)) {
 return [];
Expand Down

5 changes: 3 additions & 2 deletions
packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ describe('sentrySvelteKit()', () => {

 expect(plugins).toBeInstanceOf(Array);
 // 1 auto instrument plugin + 5 source maps plugins
 expect(plugins).toHaveLength(7);
 expect(plugins).toHaveLength(8);
 });

 it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
Expand All@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
 'sentry-telemetry-plugin',
 'sentry-vite-release-injection-plugin',
 'sentry-vite-debug-id-injection-plugin',
 'sentry-sveltekit-update-source-map-setting-plugin',
 // custom release plugin:
 'sentry-sveltekit-release-management-plugin',
 // custom source maps plugin:
Expand DownExpand Up@@ -86,7 +87,7 @@ describe('sentrySvelteKit()', () => {
 it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
 const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
 const pluginNames = plugins.map(plugin => plugin.name);
 expect(plugins).toHaveLength(6);
 expect(plugins).toHaveLength(7);
 expect(pluginNames).not.toContain('sentry-upload-source-maps');
 });

Expand Down
Loading