feat(nuxt): Align build-time options to follow bundler plugins structure

Author: s1gr1d

packages/core/src/build-time-plugins/buildTimeOptionsBase.ts

@@ -84,6 +84,23 @@ export interface BuildTimeOptionsBase {
    */
   silent?: boolean;
 
+  /**
+   * When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
+   *
+   * By default, the plugin will simply throw an error, thereby stopping the bundling process.
+   * If an `errorHandler` callback is provided, compilation will continue unless an error is
+   * thrown in the provided callback.
+   *
+   * To allow compilation to continue but still emit a warning, set this option to the following:
+   *
+   * ```js
+   * (err) => {
+   *   console.warn(err);
+   * }
+   * ```
+   */
+  errorHandler?: (err: Error) => void;
+
   /**
    * Enable debug information logs about the SDK during build-time.
    * Enabling this will give you, for example, logs about source maps.
@@ -184,7 +201,9 @@ export type UnstableRollupPluginOptions<PluginOptionsType> = {
 
 interface SourceMapsOptions {
   /**
-   * If this flag is `true`, any functionality related to source maps will be disabled.
+   * If this flag is `true`, any functionality related to source maps will be disabled. This includes the automatic upload of source maps.
+   *
+   * By default (`false`), the plugin automatically uploads source maps during a production build if a Sentry auth token is detected.
    *
    * @default false
    */

packages/nuxt/src/common/types.ts

@@ -1,3 +1,4 @@
+import type { BuildTimeOptionsBase } from '@sentry/core';
 import type { init as initNode } from '@sentry/node';
 import type { SentryRollupPluginOptions } from '@sentry/rollup-plugin';
 import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
@@ -26,6 +27,7 @@ type SourceMapsOptions = {
    * Suppresses all logs.
    *
    * @default false
+   * @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
    */
   silent?: boolean;
 
@@ -43,13 +45,17 @@ type SourceMapsOptions = {
    *   console.warn(err);
    * }
    * ```
+   *
+   * @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
    */
   errorHandler?: (err: Error) => void;
 
   /**
    * Options related to managing the Sentry releases for a build.
    *
    * More info: https://docs.sentry.io/product/releases/
+   *
+   * @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
    */
   release?: {
     /**
@@ -62,6 +68,8 @@ type SourceMapsOptions = {
      * (the latter requires access to git CLI and for the root directory to be a valid repository)
      *
      * If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
+     *
+     * @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
      */
     name?: string;
   };
@@ -71,6 +79,7 @@ type SourceMapsOptions = {
    * automatically generate and upload source maps to Sentry during a production build.
    *
    * @default true
+   * @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
    */
   enabled?: boolean;
 
@@ -81,25 +90,30 @@ type SourceMapsOptions = {
    *
    * To create an auth token, follow this guide:
    * @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
+   * @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
    */
   authToken?: string;
 
   /**
    * The organization slug of your Sentry organization.
    * Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
+   * @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
    */
   org?: string;
 
   /**
    * The URL of your Sentry instance if you're using self-hosted Sentry.
    *
    * @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
+   * @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
    */
   url?: string;
 
   /**
    * The project slug of your Sentry project.
    * Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
+   *
+   * @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
    */
   project?: string;
 
@@ -108,11 +122,14 @@ type SourceMapsOptions = {
    * It will not collect any sensitive or user-specific data.
    *
    * @default true
+   * @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
    */
   telemetry?: boolean;
 
   /**
    * Options related to sourcemaps
+   *
+   * @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
    */
   sourcemaps?: {
     /**
@@ -124,6 +141,8 @@ type SourceMapsOptions = {
      *
      * The globbing patterns must follow the implementation of the `glob` package.
      * @see https://www.npmjs.com/package/glob#glob-primer
+     *
+     * @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
      */
     assets?: string | Array<string>;
 
@@ -134,6 +153,8 @@ type SourceMapsOptions = {
      * or the default value for `assets` are uploaded.
      *
      * The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
+     *
+     * @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
      */
     ignore?: string | Array<string>;
 
@@ -144,6 +165,8 @@ type SourceMapsOptions = {
      * @default [] - By default no files are deleted.
      *
      * The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
+     *
+     * @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
      */
     filesToDeleteAfterUpload?: string | Array<string>;
   };
@@ -152,7 +175,7 @@ type SourceMapsOptions = {
 /**
  *  Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
  */
-export type SentryNuxtModuleOptions = {
+export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
   /**
    * Enable the Sentry Nuxt Module.
    *
@@ -165,15 +188,12 @@ export type SentryNuxtModuleOptions = {
    *
    * These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
    * Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
+   *
+   * @deprecated  This option was deprecated as it adds unnecessary nesting.
+   *              Put the options one level higher to the root-level of the `sentry` module options.
    */
   sourceMapsUploadOptions?: SourceMapsOptions;
 
-  /**
-   * Enable debug functionality of the SDK during build-time.
-   * Enabling this will give you, for example, logs about source maps.
-   */
-  debug?: boolean;
-
   /**
    *
    * Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.

packages/nuxt/test/vite/buildOptions.test-d.ts

@@ -0,0 +1,129 @@
+import { describe, expectTypeOf, it } from 'vitest';
+import type { SentryNuxtModuleOptions } from '../../src/common/types';
+
+describe('Sentry Nuxt build-time options type', () => {
+  it('includes all options based on type BuildTimeOptionsBase', () => {
+    const completeOptions: SentryNuxtModuleOptions = {
+      // --- BuildTimeOptionsBase options ---
+      org: 'test-org',
+      project: 'test-project',
+      authToken: 'test-auth-token',
+      sentryUrl: 'https://sentry.io',
+      headers: { Authorization: ' Bearer test-auth-token' },
+      telemetry: true,
+      silent: false,
+      // eslint-disable-next-line no-console
+      errorHandler: (err: Error) => console.warn(err),
+      debug: false,
+      sourcemaps: {
+        disable: false,
+        assets: ['./dist/**/*'],
+        ignore: ['./dist/*.map'],
+        filesToDeleteAfterUpload: ['./dist/*.map'],
+      },
+      release: {
+        name: 'test-release-1.0.0',
+        create: true,
+        finalize: true,
+        dist: 'test-dist',
+        vcsRemote: 'origin',
+        setCommits: {
+          auto: false,
+          repo: 'test/repo',
+          commit: 'abc123',
+          previousCommit: 'def456',
+          ignoreMissing: false,
+          ignoreEmpty: false,
+        },
+        deploy: {
+          env: 'production',
+          started: 1234567890,
+          finished: 1234567900,
+          time: 10,
+          name: 'deployment-name',
+          url: 'https://example.com',
+        },
+      },
+      bundleSizeOptimizations: {
+        excludeDebugStatements: true,
+        excludeTracing: false,
+        excludeReplayShadowDom: true,
+        excludeReplayIframe: true,
+        excludeReplayWorker: true,
+      },
+
+      // --- SentryNuxtModuleOptions specific options ---
+      enabled: true,
+      autoInjectServerSentry: 'experimental_dynamic-import',
+      experimental_entrypointWrappedFunctions: ['default', 'handler', 'server', 'customExport'],
+      unstable_sentryBundlerPluginOptions: {
+        // Rollup plugin options
+        bundleSizeOptimizations: {
+          excludeDebugStatements: true,
+        },
+        // Vite plugin options
+        sourcemaps: {
+          assets: './dist/**/*',
+        },
+      },
+    };
+
+    expectTypeOf(completeOptions).toEqualTypeOf<SentryNuxtModuleOptions>();
+  });
+
+  it('includes all deprecated options', () => {
+    const completeOptions: SentryNuxtModuleOptions = {
+      // SentryNuxtModuleOptions specific options
+      enabled: true,
+      debug: true,
+      autoInjectServerSentry: 'experimental_dynamic-import', // No need for 'as const' with type assertion
+      experimental_entrypointWrappedFunctions: ['default', 'handler', 'server', 'customExport'],
+      unstable_sentryBundlerPluginOptions: {
+        // Rollup plugin options
+        bundleSizeOptimizations: {
+          excludeDebugStatements: true,
+        },
+        // Vite plugin options
+        sourcemaps: {
+          assets: './dist/**/*',
+        },
+      },
+
+      // Deprecated sourceMapsUploadOptions
+      sourceMapsUploadOptions: {
+        silent: false,
+        // eslint-disable-next-line no-console
+        errorHandler: (err: Error) => console.warn(err),
+        release: {
+          name: 'deprecated-release',
+        },
+        enabled: true,
+        authToken: 'deprecated-token',
+        org: 'deprecated-org',
+        url: 'https://deprecated.sentry.io',
+        project: 'deprecated-project',
+        telemetry: false,
+        sourcemaps: {
+          assets: './build/**/*',
+          ignore: ['./build/*.spec.js'],
+          filesToDeleteAfterUpload: ['./build/*.map'],
+        },
+      },
+    };
+
+    expectTypeOf(completeOptions).toEqualTypeOf<SentryNuxtModuleOptions>();
+  });
+
+  it('allows partial configuration', () => {
+    const minimalOptions: SentryNuxtModuleOptions = { enabled: true };
+
+    expectTypeOf(minimalOptions).toEqualTypeOf<SentryNuxtModuleOptions>();
+
+    const partialOptions: SentryNuxtModuleOptions = {
+      enabled: true,
+      debug: false,
+    };
+
+    expectTypeOf(partialOptions).toEqualTypeOf<SentryNuxtModuleOptions>();
+  });
+});

packages/nuxt/test/vite/utils.test.ts

@@ -26,7 +26,7 @@ describe('findDefaultSdkInitFile', () => {
     'should return the server file path with .%s extension if it exists',
     ext => {
       vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
-        return !(filePath instanceof URL) && filePath.includes(`sentry.server.config.${ext}`);
+        return !(filePath instanceof URL) && filePath.toString().includes(`sentry.server.config.${ext}`);
       });
 
       const result = findDefaultSdkInitFile('server');
@@ -38,7 +38,7 @@ describe('findDefaultSdkInitFile', () => {
     'should return the client file path with .%s extension if it exists',
     ext => {
       vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
-        return !(filePath instanceof URL) && filePath.includes(`sentry.client.config.${ext}`);
+        return !(filePath instanceof URL) && filePath.toString().includes(`sentry.client.config.${ext}`);
       });
 
       const result = findDefaultSdkInitFile('client');
@@ -64,7 +64,8 @@ describe('findDefaultSdkInitFile', () => {
     vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
       return (
         !(filePath instanceof URL) &&
-        (filePath.includes('sentry.server.config.js') || filePath.includes('instrument.server.js'))
+        (filePath.toString().includes('sentry.server.config.js') ||
+          filePath.toString().includes('instrument.server.js'))
       );
     });
 
@@ -74,7 +75,7 @@ describe('findDefaultSdkInitFile', () => {
 
   it('should return the latest layer config file path if client config exists', () => {
     vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
-      return !(filePath instanceof URL) && filePath.includes('sentry.client.config.ts');
+      return !(filePath instanceof URL) && filePath.toString().includes('sentry.client.config.ts');
     });
 
     const nuxtMock = {
@@ -98,7 +99,8 @@ describe('findDefaultSdkInitFile', () => {
     vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
       return (
         !(filePath instanceof URL) &&
-        (filePath.includes('sentry.server.config.ts') || filePath.includes('instrument.server.ts'))
+        (filePath.toString().includes('sentry.server.config.ts') ||
+          filePath.toString().includes('instrument.server.ts'))
       );
     });
 
@@ -121,7 +123,7 @@ describe('findDefaultSdkInitFile', () => {
 
   it('should return the latest layer config file path if client config exists in former layer', () => {
     vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
-      return !(filePath instanceof URL) && filePath.includes('nuxt/sentry.client.config.ts');
+      return !(filePath instanceof URL) && filePath.toString().includes('nuxt/sentry.client.config.ts');
     });
 
     const nuxtMock = {

packages/nuxt/tsconfig.test.json

@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig.json",
 
-  "include": ["test/**/*", "vite.config.ts"],
+  "include": ["test/**/*"],
 
   "compilerOptions": {
     // should include all types from `./tsconfig.json` plus types for all test frameworks used

packages/nuxt/vite.config.ts

@@ -5,5 +5,9 @@ export default {
   test: {
     environment: 'jsdom',
     setupFiles: ['./test/vitest.setup.ts'],
+    typecheck: {
+      enabled: true,
+      tsconfig: './tsconfig.test.json',
+    },
   },
 };