add tests and support new options

s1gr1d · s1gr1d · commit 398351e9bf3a · 2025-07-31T14:04:46.000+02:00
diff --git a/packages/nuxt/src/vite/sourceMaps.ts b/packages/nuxt/src/vite/sourceMaps.ts
@@ -17,10 +17,20 @@ export type SourceMapSetting = boolean | 'hidden' | 'inline';
  *  Setup source maps for Sentry inside the Nuxt module during build time (in Vite for Nuxt and Rollup for Nitro).
  */
 export function setupSourceMaps(moduleOptions: SentryNuxtModuleOptions, nuxt: Nuxt): void {
+  // TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)
+
   const isDebug = moduleOptions.debug;
 
+  // eslint-disable-next-line deprecation/deprecation
   const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};
-  const sourceMapsEnabled = sourceMapsUploadOptions.enabled ?? true;
+
+  // Check new 'sourcemaps.disable' option first, then fall back to deprecated 'enabled' option
+  // Note: 'disable' is the inverse of 'enabled'
+  const sourceMapsEnabled =
+    moduleOptions.sourcemaps?.disable === true
+      ? false
+      : // eslint-disable-next-line deprecation/deprecation
+        sourceMapsUploadOptions.enabled ?? true;
 
   // In case we overwrite the source map settings, we default to deleting the files
   let shouldDeleteFilesFallback = { client: true, server: true };
@@ -42,6 +52,8 @@ export function setupSourceMaps(moduleOptions: SentryNuxtModuleOptions, nuxt: Nu
 
       if (
         isDebug &&
+        !moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
+        // eslint-disable-next-line deprecation/deprecation
         !sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload &&
         (shouldDeleteFilesFallback.client || shouldDeleteFilesFallback.server)
       ) {
@@ -134,10 +146,13 @@ function normalizePath(path: string): string {
  *
  *  Only exported for Testing purposes.
  */
+// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
+// eslint-disable-next-line complexity
 export function getPluginOptions(
   moduleOptions: SentryNuxtModuleOptions,
   shouldDeleteFilesFallback?: { client: boolean; server: boolean },
 ): SentryVitePluginOptions | SentryRollupPluginOptions {
+  // eslint-disable-next-line deprecation/deprecation
   const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};
 
   const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
@@ -148,10 +163,17 @@ export function getPluginOptions(
       : []),
   ];
 
-  if (
-    typeof sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
-    shouldDeleteFilesAfterUpload
-  ) {
+  // Check for filesToDeleteAfterUpload in new location first, then deprecated location
+  const sourcemapsOptions = moduleOptions.sourcemaps || {};
+  // eslint-disable-next-line deprecation/deprecation
+  const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};
+
+  const filesToDeleteAfterUpload =
+    sourcemapsOptions.filesToDeleteAfterUpload ??
+    // eslint-disable-next-line deprecation/deprecation
+    deprecatedSourcemapsOptions.filesToDeleteAfterUpload;
+
+  if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload) {
     consoleSandbox(() => {
       // eslint-disable-next-line no-console
       console.log(
@@ -164,16 +186,28 @@ export function getPluginOptions(
   }
 
   return {
-    org: sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
-    project: sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
-    authToken: sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
-    telemetry: sourceMapsUploadOptions.telemetry ?? true,
-    url: sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
+    // eslint-disable-next-line deprecation/deprecation
+    org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
+    // eslint-disable-next-line deprecation/deprecation
+    project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
+    // eslint-disable-next-line deprecation/deprecation
+    authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
+    // eslint-disable-next-line deprecation/deprecation
+    telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
+    // eslint-disable-next-line deprecation/deprecation
+    url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
+    headers: moduleOptions.headers,
     debug: moduleOptions.debug ?? false,
-    silent: sourceMapsUploadOptions.silent ?? false,
-    errorHandler: sourceMapsUploadOptions.errorHandler,
+    // eslint-disable-next-line deprecation/deprecation
+    silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
+    // eslint-disable-next-line deprecation/deprecation
+    errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
+    bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
     release: {
-      name: sourceMapsUploadOptions.release?.name,
+      // eslint-disable-next-line deprecation/deprecation
+      name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
+      // Support all release options from BuildTimeOptionsBase
+      ...moduleOptions.release,
       ...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
     },
     _metaOptions: {
@@ -184,13 +218,14 @@ export function getPluginOptions(
     ...moduleOptions?.unstable_sentryBundlerPluginOptions,
 
     sourcemaps: {
+      disable: moduleOptions.sourcemaps?.disable,
       // The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
       // We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
       // If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
-      assets: sourceMapsUploadOptions.sourcemaps?.assets ?? undefined,
-      ignore: sourceMapsUploadOptions.sourcemaps?.ignore ?? undefined,
-      filesToDeleteAfterUpload: sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
-        ? sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
+      assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
+      ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
+      filesToDeleteAfterUpload: filesToDeleteAfterUpload
+        ? filesToDeleteAfterUpload
         : shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
           ? fallbackFilesToDelete
           : undefined,
diff --git a/packages/nuxt/test/vite/sourceMaps.test.ts b/packages/nuxt/test/vite/sourceMaps.test.ts
@@ -18,16 +18,14 @@ describe('getPluginOptions', () => {
     process.env = {};
   });
 
-  it('uses environment variables when no moduleOptions are provided', () => {
-    const defaultEnv = {
+  it('uses environment variables as fallback when no moduleOptions are provided', () => {
+    process.env = {
       SENTRY_ORG: 'default-org',
       SENTRY_PROJECT: 'default-project',
       SENTRY_AUTH_TOKEN: 'default-token',
       SENTRY_URL: 'https://santry.io',
     };
 
-    process.env = { ...defaultEnv };
-
     const options = getPluginOptions({} as SentryNuxtModuleOptions);
 
     expect(options).toEqual(
@@ -110,46 +108,159 @@ describe('getPluginOptions', () => {
     );
   });
 
-  it('overrides options that were undefined with options from unstable_sentryRollupPluginOptions', () => {
-    const customOptions: SentryNuxtModuleOptions = {
+  it('prioritizes new BuildTimeOptionsBase options over deprecated ones', () => {
+    const options: SentryNuxtModuleOptions = {
+      // New options
+      org: 'new-org',
+      project: 'new-project',
+      authToken: 'new-token',
+      sentryUrl: 'https://new.sentry.io',
+      telemetry: false,
+      silent: true,
+      debug: true,
+      sourcemaps: {
+        assets: ['new-assets/**/*'],
+        ignore: ['new-ignore.js'],
+        filesToDeleteAfterUpload: ['new-delete.js'],
+      },
+      release: {
+        name: 'test-release',
+        create: false,
+        finalize: true,
+        dist: 'build-123',
+        vcsRemote: 'upstream',
+        setCommits: { auto: true },
+        deploy: { env: 'production' },
+      },
+      bundleSizeOptimizations: { excludeTracing: true },
+
+      // Deprecated options (should be ignored)
       sourceMapsUploadOptions: {
-        org: 'custom-org',
-        project: 'custom-project',
+        org: 'old-org',
+        project: 'old-project',
+        authToken: 'old-token',
+        url: 'https://old.sentry.io',
+        telemetry: true,
+        silent: false,
         sourcemaps: {
-          assets: ['custom-assets/**/*'],
-          filesToDeleteAfterUpload: ['delete-this.js'],
+          assets: ['old-assets/**/*'],
+          ignore: ['old-ignore.js'],
+          filesToDeleteAfterUpload: ['old-delete.js'],
         },
-        url: 'https://santry.io',
+        release: { name: 'old-release' },
       },
+    };
+
+    const result = getPluginOptions(options);
+
+    expect(result).toMatchObject({
+      org: 'new-org',
+      project: 'new-project',
+      authToken: 'new-token',
+      url: 'https://new.sentry.io',
+      telemetry: false,
+      silent: true,
       debug: true,
-      unstable_sentryBundlerPluginOptions: {
-        org: 'unstable-org',
+      bundleSizeOptimizations: { excludeTracing: true },
+      release: {
+        name: 'test-release',
+        create: false,
+        finalize: true,
+        dist: 'build-123',
+        vcsRemote: 'upstream',
+        setCommits: { auto: true },
+        deploy: { env: 'production' },
+      },
+      sourcemaps: expect.objectContaining({
+        assets: ['new-assets/**/*'],
+        ignore: ['new-ignore.js'],
+        filesToDeleteAfterUpload: ['new-delete.js'],
+      }),
+    });
+  });
+
+  it('falls back to deprecated options when new ones are undefined', () => {
+    const options: SentryNuxtModuleOptions = {
+      debug: true,
+      sourceMapsUploadOptions: {
+        org: 'deprecated-org',
+        project: 'deprecated-project',
+        authToken: 'deprecated-token',
+        url: 'https://deprecated.sentry.io',
+        telemetry: false,
         sourcemaps: {
-          assets: ['unstable-assets/**/*'],
+          assets: ['deprecated/**/*'],
         },
-        release: {
-          name: 'test-release',
+        release: { name: 'deprecated-release' },
+      },
+    };
+
+    const result = getPluginOptions(options);
+
+    expect(result).toMatchObject({
+      org: 'deprecated-org',
+      project: 'deprecated-project',
+      authToken: 'deprecated-token',
+      url: 'https://deprecated.sentry.io',
+      telemetry: false,
+      debug: true,
+      release: { name: 'deprecated-release' },
+      sourcemaps: expect.objectContaining({
+        assets: ['deprecated/**/*'],
+      }),
+    });
+  });
+
+  it('supports bundleSizeOptimizations', () => {
+    const options: SentryNuxtModuleOptions = {
+      bundleSizeOptimizations: {
+        excludeDebugStatements: true,
+        excludeTracing: true,
+        excludeReplayShadowDom: true,
+        excludeReplayIframe: true,
+        excludeReplayWorker: true,
+      },
+    };
+
+    const result = getPluginOptions(options);
+
+    expect(result.bundleSizeOptimizations).toEqual({
+      excludeDebugStatements: true,
+      excludeTracing: true,
+      excludeReplayShadowDom: true,
+      excludeReplayIframe: true,
+      excludeReplayWorker: true,
+    });
+  });
+
+  it('merges with unstable_sentryBundlerPluginOptions correctly', () => {
+    const options: SentryNuxtModuleOptions = {
+      org: 'base-org',
+      bundleSizeOptimizations: {
+        excludeDebugStatements: false,
+      },
+      unstable_sentryBundlerPluginOptions: {
+        org: 'override-org',
+        release: { name: 'override-release' },
+        sourcemaps: { assets: ['override/**/*'] },
+        bundleSizeOptimizations: {
+          excludeDebugStatements: true,
         },
-        url: 'https://suntry.io',
       },
     };
-    const options = getPluginOptions(customOptions);
-    expect(options).toEqual(
-      expect.objectContaining({
-        debug: true,
-        org: 'unstable-org',
-        project: 'custom-project',
-        sourcemaps: expect.objectContaining({
-          assets: ['unstable-assets/**/*'],
-          filesToDeleteAfterUpload: ['delete-this.js'],
-          rewriteSources: expect.any(Function),
-        }),
-        release: expect.objectContaining({
-          name: 'test-release',
-        }),
-        url: 'https://suntry.io',
+
+    const result = getPluginOptions(options);
+
+    expect(result).toMatchObject({
+      org: 'override-org',
+      release: { name: 'override-release' },
+      sourcemaps: expect.objectContaining({
+        assets: ['override/**/*'],
       }),
-    );
+      bundleSizeOptimizations: {
+        excludeDebugStatements: true,
+      },
+    });
   });
 
   it.each([
@@ -185,12 +296,19 @@ describe('getPluginOptions', () => {
       serverFallback: false,
       customOptions: {
         sourceMapsUploadOptions: {
-          sourcemaps: {
-            filesToDeleteAfterUpload: ['custom/path/**/*.map'],
-          },
+          sourcemaps: { filesToDeleteAfterUpload: ['deprecated/path/**/*.map'] },
         },
       },
-      expectedFilesToDelete: ['custom/path/**/*.map'],
+      expectedFilesToDelete: ['deprecated/path/**/*.map'],
+    },
+    {
+      name: 'no fallback, but custom filesToDeleteAfterUpload is provided',
+      clientFallback: false,
+      serverFallback: false,
+      customOptions: {
+        sourcemaps: { filesToDeleteAfterUpload: ['new-custom/path/**/*.map'] },
+      },
+      expectedFilesToDelete: ['new-custom/path/**/*.map'],
     },
     {
       name: 'no fallback, both source maps explicitly false and no custom filesToDeleteAfterUpload',
