feat(solidstart): Respect user-provided source map setting (#14979)

s1gr1d · web-flow · commit 957878a10366 · 2025-01-13T10:07:08.000+01:00
Closes #13994
diff --git a/docs/migration/v8-to-v9.md b/docs/migration/v8-to-v9.md
@@ -104,7 +104,7 @@ In v9, an `undefined` value will be treated the same as if the value is not defi
 
 - By default, source maps will now be automatically deleted after being uploaded to Sentry for client-side builds. You can opt out of this behavior by explicitly setting `sourcemaps.deleteSourcemapsAfterUpload` to `false` in your Sentry config.
 
-### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`)
+### All Meta-Framework SDKs (`@sentry/astro`, `@sentry/nuxt`, `@sentry/solidstart`)
 
 - Updated source map generation to respect the user-provided value of your build config, such as `vite.build.sourcemap`:
 
diff --git a/packages/astro/src/integration/index.ts b/packages/astro/src/integration/index.ts
@@ -49,7 +49,7 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
             consoleSandbox(() => {
               // eslint-disable-next-line no-console
               console.log(
-                `[Sentry] Setting \`sourceMapsUploadOptions.filesToDeleteAfterUpload: ${JSON.stringify(
+                `[Sentry] Automatically setting \`sourceMapsUploadOptions.filesToDeleteAfterUpload: ${JSON.stringify(
                   updatedFilesToDeleteAfterUpload,
                 )}\` to delete generated source maps after they were uploaded to Sentry.`,
               );
@@ -226,7 +226,7 @@ export function getUpdatedSourceMapSettings(
     consoleSandbox(() => {
       //  eslint-disable-next-line no-console
       console.warn(
-        `[Sentry] Source map generation are currently disabled in your Astro 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\`).`,
+        `[Sentry] Source map generation is currently disabled in your Astro 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 (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
diff --git a/packages/astro/test/integration/index.test.ts b/packages/astro/test/integration/index.test.ts
@@ -456,9 +456,7 @@ describe('getUpdatedSourceMapSettings', () => {
 
     astroConfig.vite.build.sourcemap = false;
     getUpdatedSourceMapSettings(astroConfig, sentryOptions);
-    expect(consoleWarnSpy).toHaveBeenCalledWith(
-      expect.stringContaining('Source map generation are currently disabled'),
-    );
+    expect(consoleWarnSpy).toHaveBeenCalledWith(expect.stringContaining('Source map generation is currently disabled'));
 
     astroConfig.vite.build.sourcemap = 'hidden';
     getUpdatedSourceMapSettings(astroConfig, sentryOptions);
diff --git a/packages/solidstart/src/vite/sentrySolidStartVite.ts b/packages/solidstart/src/vite/sentrySolidStartVite.ts
@@ -1,12 +1,12 @@
 import type { Plugin, UserConfig } from 'vite';
 import { makeBuildInstrumentationFilePlugin } from './buildInstrumentationFile';
-import { makeSourceMapsVitePlugin } from './sourceMaps';
+import { makeAddSentryVitePlugin, makeEnableSourceMapsVitePlugin } from './sourceMaps';
 import type { SentrySolidStartPluginOptions } from './types';
 
 /**
  * Various Sentry vite plugins to be used for SolidStart.
  */
-export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions = {}): Plugin[] => {
+export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions = {}, viteConfig: UserConfig): Plugin[] => {
   const sentryPlugins: Plugin[] = [];
 
   if (options.autoInjectServerSentry !== 'experimental_dynamic-import') {
@@ -15,7 +15,10 @@ export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions = {}
 
   if (process.env.NODE_ENV !== 'development') {
     if (options.sourceMapsUploadOptions?.enabled ?? true) {
-      sentryPlugins.push(...makeSourceMapsVitePlugin(options));
+      const sourceMapsPlugin = makeAddSentryVitePlugin(options, viteConfig);
+      const enableSourceMapsPlugin = makeEnableSourceMapsVitePlugin(options);
+
+      sentryPlugins.push(...sourceMapsPlugin, ...enableSourceMapsPlugin);
     }
   }
 
@@ -27,7 +30,7 @@ export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions = {}
  */
 export const addSentryPluginToVite = (config: UserConfig = {}, options: SentrySolidStartPluginOptions): UserConfig => {
   const plugins = Array.isArray(config.plugins) ? [...config.plugins] : [];
-  plugins.unshift(sentrySolidStartVite(options));
+  plugins.unshift(sentrySolidStartVite(options, config));
 
   return {
     ...config,
diff --git a/packages/solidstart/src/vite/sourceMaps.ts b/packages/solidstart/src/vite/sourceMaps.ts
@@ -1,53 +1,48 @@
+import { consoleSandbox } from '@sentry/core';
 import { sentryVitePlugin } from '@sentry/vite-plugin';
-import type { Plugin } from 'vite';
+import type { Plugin, UserConfig } from 'vite';
 import type { SentrySolidStartPluginOptions } from './types';
 
 /**
- * A Sentry plugin for SolidStart to enable source maps and use
- * @sentry/vite-plugin to automatically upload source maps to Sentry.
- * @param {SourceMapsOptions} options
+ * A Sentry plugin for adding the @sentry/vite-plugin to automatically upload source maps to Sentry.
  */
-export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
+export function makeAddSentryVitePlugin(options: SentrySolidStartPluginOptions, viteConfig: UserConfig): Plugin[] {
   const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
-  return [
-    {
-      name: 'sentry-solidstart-source-maps',
-      apply: 'build',
-      enforce: 'post',
-      config(config) {
-        // TODO(v9): Remove this warning
-        if (config.build?.sourcemap === false) {
-          // eslint-disable-next-line no-console
-          console.warn(
-            "[Sentry SolidStart Plugin] You disabled sourcemaps with the `build.sourcemap` option. Currently, the Sentry SDK will override this option to generate sourcemaps. In future versions, the Sentry SDK will not override the `build.sourcemap` option if you explicitly disable it. If you want to generate and upload sourcemaps please set the `build.sourcemap` option to 'hidden' or undefined.",
-          );
-        }
-
-        // TODO(v9): Remove this warning and print warning in case source map deletion is auto configured
-        if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
-          // eslint-disable-next-line no-console
-          console.warn(
-            "[Sentry SolidStart Plugin] The Sentry SDK has enabled source map generation for your SolidStart app. If you don't want to serve Source Maps to your users, either configure the `filesToDeleteAfterUpload` option with a glob to remove source maps after uploading them, or manually delete the source maps after the build. In future Sentry SDK versions source maps will be deleted automatically after uploading them.",
-          );
-        }
 
-        return {
-          ...config,
-          build: {
-            ...config.build,
-            sourcemap: true,
-          },
-        };
-      },
-    },
+  let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;
+
+  if (
+    typeof sourceMapsUploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
+    typeof sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps?.filesToDeleteAfterUpload ===
+      'undefined' &&
+    // 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
+    updatedFilesToDeleteAfterUpload = ['.*/**/*.map'];
+
+    consoleSandbox(() => {
+      // eslint-disable-next-line no-console
+      console.log(
+        `[Sentry] Automatically setting \`sourceMapsUploadOptions.filesToDeleteAfterUpload: ${JSON.stringify(
+          updatedFilesToDeleteAfterUpload,
+        )}\` to delete generated source maps after they were uploaded to Sentry.`,
+      );
+    });
+  }
+
+  return [
     ...sentryVitePlugin({
       authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
       bundleSizeOptimizations: options.bundleSizeOptimizations,
       debug: debug ?? false,
       org: org ?? process.env.SENTRY_ORG,
       project: project ?? process.env.SENTRY_PROJECT,
       sourcemaps: {
-        filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
+        filesToDeleteAfterUpload:
+          (sourceMapsUploadOptions?.filesToDeleteAfterUpload ||
+            sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps?.filesToDeleteAfterUpload) ??
+          updatedFilesToDeleteAfterUpload,
         ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
       },
       telemetry: sourceMapsUploadOptions?.telemetry ?? true,
@@ -60,3 +55,85 @@ export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions)
     }),
   ];
 }
+
+/**
+ * A Sentry plugin for SolidStart to enable "hidden" source maps if they are unset.
+ */
+export function makeEnableSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
+  return [
+    {
+      name: 'sentry-solidstart-update-source-map-setting',
+      apply: 'build',
+      enforce: 'post',
+      config(viteConfig) {
+        return {
+          ...viteConfig,
+          build: {
+            ...viteConfig.build,
+            sourcemap: getUpdatedSourceMapSettings(viteConfig, options),
+          },
+        };
+      },
+    },
+  ];
+}
+
+/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-j avascript/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 getUpdatedSourceMapSettings(
+  viteConfig: UserConfig,
+  sentryPluginOptions?: SentrySolidStartPluginOptions,
+): boolean | 'inline' | 'hidden' {
+  viteConfig.build = viteConfig.build || {};
+
+  const viteSourceMap = viteConfig?.build?.sourcemap;
+  let updatedSourceMapSetting = viteSourceMap;
+
+  const settingKey = 'vite.build.sourcemap';
+
+  if (viteSourceMap === false) {
+    updatedSourceMapSetting = viteSourceMap;
+
+    consoleSandbox(() => {
+      //  eslint-disable-next-line no-console
+      console.warn(
+        `[Sentry] Source map generation is currently disabled in your SolidStart 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 (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
+    updatedSourceMapSetting = viteSourceMap;
+
+    if (sentryPluginOptions?.debug) {
+      consoleSandbox(() => {
+        // eslint-disable-next-line no-console
+        console.log(
+          `[Sentry] We discovered \`${settingKey}\` is set to \`${viteSourceMap.toString()}\`. Sentry will keep this source map setting. This will un-minify the code snippet on the Sentry Issue page.`,
+        );
+      });
+    }
+  } else {
+    updatedSourceMapSetting = 'hidden';
+
+    consoleSandbox(() => {
+      //  eslint-disable-next-line no-console
+      console.log(
+        `[Sentry] Enabled source map generation in the build options with \`${settingKey}: 'hidden'\`. The source maps  will be deleted after they were uploaded to Sentry.`,
+      );
+    });
+  }
+
+  return updatedSourceMapSetting;
+}
diff --git a/packages/solidstart/test/config/withSentry.test.ts b/packages/solidstart/test/config/withSentry.test.ts
@@ -79,13 +79,13 @@ describe('withSentry()', () => {
     const names = config?.vite.plugins.flat().map((plugin: Plugin) => plugin.name);
     expect(names).toEqual([
       'sentry-solidstart-build-instrumentation-file',
-      'sentry-solidstart-source-maps',
       'sentry-telemetry-plugin',
       'sentry-vite-release-injection-plugin',
       'sentry-debug-id-upload-plugin',
       'sentry-vite-debug-id-injection-plugin',
       'sentry-vite-debug-id-upload-plugin',
       'sentry-file-deletion-plugin',
+      'sentry-solidstart-update-source-map-setting',
     ]);
   });
 
@@ -107,13 +107,13 @@ describe('withSentry()', () => {
     const names = config?.vite.plugins.flat().map((plugin: Plugin) => plugin.name);
     expect(names).toEqual([
       'sentry-solidstart-build-instrumentation-file',
-      'sentry-solidstart-source-maps',
       'sentry-telemetry-plugin',
       'sentry-vite-release-injection-plugin',
       'sentry-debug-id-upload-plugin',
       'sentry-vite-debug-id-injection-plugin',
       'sentry-vite-debug-id-upload-plugin',
       'sentry-file-deletion-plugin',
+      'sentry-solidstart-update-source-map-setting',
       'my-test-plugin',
     ]);
   });
@@ -139,13 +139,13 @@ describe('withSentry()', () => {
       .map((plugin: Plugin) => plugin.name);
     expect(names).toEqual([
       'sentry-solidstart-build-instrumentation-file',
-      'sentry-solidstart-source-maps',
       'sentry-telemetry-plugin',
       'sentry-vite-release-injection-plugin',
       'sentry-debug-id-upload-plugin',
       'sentry-vite-debug-id-injection-plugin',
       'sentry-vite-debug-id-upload-plugin',
       'sentry-file-deletion-plugin',
+      'sentry-solidstart-update-source-map-setting',
       'my-test-plugin',
     ]);
   });
diff --git a/packages/solidstart/test/vite/sentrySolidStartVite.test.ts b/packages/solidstart/test/vite/sentrySolidStartVite.test.ts
@@ -10,12 +10,15 @@ vi.spyOn(console, 'warn').mockImplementation(() => {
 });
 
 function getSentrySolidStartVitePlugins(options?: Parameters<typeof sentrySolidStartVite>[0]): Plugin[] {
-  return sentrySolidStartVite({
-    project: 'project',
-    org: 'org',
-    authToken: 'token',
-    ...options,
-  });
+  return sentrySolidStartVite(
+    {
+      project: 'project',
+      org: 'org',
+      authToken: 'token',
+      ...options,
+    },
+    {},
+  );
 }
 
 describe('sentrySolidStartVite()', () => {
@@ -24,13 +27,13 @@ describe('sentrySolidStartVite()', () => {
     const names = plugins.map(plugin => plugin.name);
     expect(names).toEqual([
       'sentry-solidstart-build-instrumentation-file',
-      'sentry-solidstart-source-maps',
       'sentry-telemetry-plugin',
       'sentry-vite-release-injection-plugin',
       'sentry-debug-id-upload-plugin',
       'sentry-vite-debug-id-injection-plugin',
       'sentry-vite-debug-id-upload-plugin',
       'sentry-file-deletion-plugin',
+      'sentry-solidstart-update-source-map-setting',
     ]);
   });
 
diff --git a/packages/solidstart/test/vite/sourceMaps.test.ts b/packages/solidstart/test/vite/sourceMaps.test.ts
