feat(sveltekit): Streamline build logs

mydea · mydea · commit 7000bdf31e8b · 2025-08-06T13:17:33.000+02:00
diff --git a/packages/sveltekit/src/vite/sourceMaps.ts b/packages/sveltekit/src/vite/sourceMaps.ts
@@ -60,9 +60,6 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
     },
   };
 
-  const { promise: filesToDeleteAfterUpload, resolve: resolveFilesToDeleteAfterUpload } =
-    createFilesToDeleteAfterUploadPromise();
-
   const mergedOptions = {
     ...defaultPluginOptions,
     ...options,
@@ -72,7 +69,6 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
     },
     sourcemaps: {
       ...options?.sourcemaps,
-      filesToDeleteAfterUpload,
     },
   };
 
@@ -99,9 +95,6 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
         'sentry-vite-debug-id-upload-plugin not found in sentryPlugins! Cannot modify plugin - returning default Sentry Vite plugins',
       );
 
-    // resolving filesToDeleteAfterUpload here, because we return the original deletion plugin which awaits the promise
-    resolveFilesToDeleteAfterUpload(undefined);
-
     return sentryPlugins;
   }
 
@@ -112,9 +105,6 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
         'sentry-file-deletion-plugin not found in sentryPlugins! Cannot modify plugin - returning default Sentry Vite plugins',
       );
 
-    // resolving filesToDeleteAfterUpload here, because we return the original deletion plugin which awaits the promise
-    resolveFilesToDeleteAfterUpload(undefined);
-
     return sentryPlugins;
   }
 
@@ -125,9 +115,6 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
         'sentry-release-management-plugin not found in sentryPlugins! Cannot modify plugin - returning default Sentry Vite plugins',
       );
 
-    // resolving filesToDeleteAfterUpload here, because we return the original deletion plugin which awaits the promise
-    resolveFilesToDeleteAfterUpload(undefined);
-
     return sentryPlugins;
   }
 
@@ -153,65 +140,51 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
     name: 'sentry-sveltekit-update-source-map-setting-plugin',
     apply: 'build', // only apply this plugin at build time
     config: async (config: UserConfig) => {
-      const settingKey = 'build.sourcemap';
-
-      const { updatedSourceMapSetting, previousSourceMapSetting } = getUpdatedSourceMapSetting(config);
+      return {
+        ...config,
+        build: {
+          ...config.build,
+          sourcemap: _getUpdatedSourceMapSettings(config, options),
+        },
+      };
+    },
+  };
 
-      const userProvidedFilesToDeleteAfterUpload = await options?.sourcemaps?.filesToDeleteAfterUpload;
+  const filesToDeleteAfterUploadConfigPlugin: Plugin = {
+    name: 'sentry-sveltekit-files-to-delete-after-upload-setting-plugin',
+    apply: 'build', // only apply this plugin at build time
+    config: async (config: UserConfig) => {
+      const filesToDeleteAfterUpload = mergedOptions.sourcemaps?.filesToDeleteAfterUpload;
+
+      if (
+        typeof filesToDeleteAfterUpload === 'undefined' &&
+        // Only if source maps were previously not set, we update the "filesToDeleteAfterUpload" (as we override the setting with "hidden")
+        typeof config.build?.sourcemap === 'undefined'
+      ) {
+        // 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 (previousSourceMapSetting === 'unset') {
         consoleSandbox(() => {
-          //  eslint-disable-next-line no-console
-          console.log(`[Sentry] Enabled source map generation in the build options with \`${settingKey}: "hidden"\`.`);
-        });
-
-        if (userProvidedFilesToDeleteAfterUpload) {
-          resolveFilesToDeleteAfterUpload(userProvidedFilesToDeleteAfterUpload);
-        } else {
-          // 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`];
-
-          consoleSandbox(() => {
+          debug &&
             // eslint-disable-next-line no-console
-            console.warn(
+            console.info(
               `[Sentry] Automatically setting \`sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${defaultFileDeletionGlob
                 .map(file => `"${file}"`)
                 .join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
             );
-          });
-
-          // In case we enabled source maps and users didn't specify a glob patter to delete, we set a default pattern:
-          resolveFilesToDeleteAfterUpload(defaultFileDeletionGlob);
-        }
+        });
 
         return {
           ...config,
-          build: { ...config.build, sourcemap: updatedSourceMapSetting },
+          build: {
+            ...config.build,
+            filesToDeleteAfterUpload: defaultFileDeletionGlob,
+          },
         };
       }
 
-      if (previousSourceMapSetting === 'disabled') {
-        consoleSandbox(() => {
-          //  eslint-disable-next-line no-console
-          console.warn(
-            `[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 (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.`,
-            );
-          });
-        }
-      }
-
-      resolveFilesToDeleteAfterUpload(userProvidedFilesToDeleteAfterUpload);
-
       return config;
     },
   };
@@ -390,18 +363,30 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
   return [
     ...unchangedSentryVitePlugins,
     sourceMapSettingsPlugin,
+    filesToDeleteAfterUploadConfigPlugin,
     customReleaseManagementPlugin,
     customDebugIdUploadPlugin,
     customFileDeletionPlugin,
   ];
 }
 
-/**
- * Whether the user enabled (true, 'hidden', 'inline') or disabled (false) source maps
+/** 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
  */
-type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;
 
-/** There are 3 ways to set up source map generation (https://github.com/getsentry/sentry-javascript/issues/13993)
+/** 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)
@@ -416,30 +401,50 @@ type UserSourceMapSetting = 'enabled' | 'disabled' | 'unset' | undefined;
  *
  * --> only exported for testing
  */
-export function getUpdatedSourceMapSetting(viteConfig: {
-  build?: {
-    sourcemap?: boolean | 'inline' | 'hidden';
-  };
-}): { updatedSourceMapSetting: boolean | 'inline' | 'hidden'; previousSourceMapSetting: UserSourceMapSetting } {
+export function _getUpdatedSourceMapSettings(
+  viteConfig: UserConfig,
+  sentryPluginOptions?: CustomSentryVitePluginOptions,
+): boolean | 'inline' | 'hidden' {
   viteConfig.build = viteConfig.build || {};
 
-  const originalSourcemapSetting = viteConfig.build.sourcemap;
+  const viteSourceMap = viteConfig?.build?.sourcemap;
+  let updatedSourceMapSetting = viteSourceMap;
 
-  if (originalSourcemapSetting === false) {
-    return {
-      previousSourceMapSetting: 'disabled',
-      updatedSourceMapSetting: originalSourcemapSetting,
-    };
-  }
+  const settingKey = 'build.sourcemap';
+  const debug = sentryPluginOptions?.debug;
+
+  if (viteSourceMap === false) {
+    updatedSourceMapSetting = viteSourceMap;
 
-  if (originalSourcemapSetting && ['hidden', 'inline', true].includes(originalSourcemapSetting)) {
-    return { previousSourceMapSetting: 'enabled', updatedSourceMapSetting: originalSourcemapSetting };
+    if (debug) {
+      // Longer debug message with more details
+      // eslint-disable-next-line no-console
+      console.warn(
+        `[Sentry] Source map generation is 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 {
+      // eslint-disable-next-line no-console
+      console.warn('[Sentry] Source map generation is disabled in your Vite configuration.');
+    }
+  } else if (viteSourceMap && ['hidden', 'inline', true].includes(viteSourceMap)) {
+    updatedSourceMapSetting = viteSourceMap;
+
+    debug &&
+      // 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';
+
+    debug &&
+      //  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 {
-    previousSourceMapSetting: 'unset',
-    updatedSourceMapSetting: 'hidden',
-  };
+  return updatedSourceMapSetting;
 }
 
 function getFiles(dir: string): string[] {
@@ -475,22 +480,3 @@ function detectSentryRelease(): string {
 
   return release;
 }
-
-/**
- * Creates a deferred promise that can be resolved/rejected by calling the
- * `resolve` or `reject` function.
- * Inspired by: https://stackoverflow.com/a/69027809
- */
-function createFilesToDeleteAfterUploadPromise(): {
-  promise: Promise<string | string[] | undefined>;
-  resolve: (value: string | string[] | undefined) => void;
-  reject: (reason?: unknown) => void;
-} {
-  let resolve!: (value: string | string[] | undefined) => void;
-  let reject!: (reason?: unknown) => void;
-  const promise = new Promise<string | string[] | undefined>((res, rej) => {
-    resolve = res;
-    reject = rej;
-  });
-  return { resolve, reject, promise };
-}
diff --git a/packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts b/packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts
@@ -42,7 +42,7 @@ describe('sentrySvelteKit()', () => {
 
     expect(plugins).toBeInstanceOf(Array);
     // 1 auto instrument plugin + 5 source maps plugins
-    expect(plugins).toHaveLength(8);
+    expect(plugins).toHaveLength(9);
   });
 
   it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
@@ -56,6 +56,7 @@ describe('sentrySvelteKit()', () => {
       'sentry-vite-release-injection-plugin',
       'sentry-vite-debug-id-injection-plugin',
       'sentry-sveltekit-update-source-map-setting-plugin',
+      'sentry-sveltekit-files-to-delete-after-upload-setting-plugin',
       // custom release plugin:
       'sentry-sveltekit-release-management-plugin',
       // custom source maps plugin:
@@ -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(7);
+    expect(plugins).toHaveLength(8);
     expect(pluginNames).not.toContain('sentry-upload-source-maps');
   });
 
@@ -184,7 +185,7 @@ describe('sentrySvelteKit()', () => {
       // just to ignore the source maps plugin:
       autoUploadSourceMaps: false,
     });
-    const plugin = plugins[0];
+    const plugin = plugins[0]!;
 
     expect(plugin.name).toEqual('sentry-auto-instrumentation');
     expect(makePluginSpy).toHaveBeenCalledWith({
diff --git a/packages/sveltekit/test/vite/sourceMaps.test.ts b/packages/sveltekit/test/vite/sourceMaps.test.ts
