Flatten and simplify options

Author: andreiborza

packages/solidstart/src/vite/sentrySolidStartVite.ts

@@ -10,7 +10,7 @@ export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Pl
 
   if (process.env.NODE_ENV !== 'development') {
     if (options.sourceMapsUploadOptions?.enabled ?? true) {
-      sentryPlugins.push(...makeSourceMapsVitePlugin({ ...options.sourceMapsUploadOptions, debug: options.debug }));
+      sentryPlugins.push(...makeSourceMapsVitePlugin(options));
     }
   }
 

packages/solidstart/src/vite/sourceMaps.ts

@@ -1,24 +1,25 @@
 import { sentryVitePlugin } from '@sentry/vite-plugin';
 import type { Plugin } from 'vite';
-import type { SourceMapsOptions } from './types';
+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
  */
-export function makeSourceMapsVitePlugin(options: SourceMapsOptions): Plugin[] {
+export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
+  const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
   return [
     {
       name: 'sentry-solidstart-source-maps',
       apply: 'build',
       enforce: 'post',
       config(config) {
         const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
-        if (options.debug && sourceMapsPreviouslyNotEnabled) {
+        if (debug && sourceMapsPreviouslyNotEnabled) {
           // eslint-disable-next-line no-console
           console.log('[Sentry SolidStart Plugin] Enabling source map generation');
-          if (!options.filesToDeleteAfterUpload) {
+          if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
             // eslint-disable-next-line no-console
             console.warn(
               `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
@@ -36,21 +37,21 @@ export function makeSourceMapsVitePlugin(options: SourceMapsOptions): Plugin[] {
       },
     },
     ...sentryVitePlugin({
-      org: options.org ?? process.env.SENTRY_ORG,
-      project: options.project ?? process.env.SENTRY_PROJECT,
-      authToken: options.authToken ?? process.env.SENTRY_AUTH_TOKEN,
-      telemetry: options.telemetry ?? true,
+      org: org ?? process.env.SENTRY_ORG,
+      project: project ?? process.env.SENTRY_PROJECT,
+      authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
+      telemetry: sourceMapsUploadOptions?.telemetry ?? true,
       sourcemaps: {
-        filesToDeleteAfterUpload: options.filesToDeleteAfterUpload ?? undefined,
-        ...options.unstable_sentryVitePluginOptions?.sourcemaps,
+        filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
+        ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
       },
       _metaOptions: {
         telemetry: {
           metaFramework: 'solidstart',
         },
       },
-      debug: options.debug ?? false,
-      ...options.unstable_sentryVitePluginOptions,
+      debug: debug ?? false,
+      ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
     }),
   ];
 }

packages/solidstart/src/vite/types.ts

@@ -9,28 +9,6 @@ export type SourceMapsOptions = {
    */
   enabled?: boolean;
 
-  /**
-   * The auth token to use when uploading source maps to Sentry.
-   *
-   * Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
-   *
-   * To create an auth token, follow this guide:
-   * @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
-   */
-  authToken?: string;
-
-  /**
-   * The organization slug of your Sentry organization.
-   * Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
-   */
-  org?: string;
-
-  /**
-   * The project slug of your Sentry project.
-   * Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
-   */
-  project?: string;
-
   /**
    * If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
    * It will not collect any sensitive or user-specific data.
@@ -63,18 +41,34 @@ export type SourceMapsOptions = {
    * Furthermore, some options are untested with SvelteKit specifically. Use with caution.
    */
   unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
-
-  /**
-   * Enable debug functionality of the SDK during build-time.
-   * Enabling this will give you logs about source maps.
-   */
-  debug?: boolean;
 };
 
 /**
  *  Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
  */
 export type SentrySolidStartPluginOptions = {
+  /**
+   * The auth token to use when uploading source maps to Sentry.
+   *
+   * Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
+   *
+   * To create an auth token, follow this guide:
+   * @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
+   */
+  authToken?: string;
+
+  /**
+   * The organization slug of your Sentry organization.
+   * Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
+   */
+  org?: string;
+
+  /**
+   * The project slug of your Sentry project.
+   * Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
+   */
+  project?: string;
+
   /**
    * Options for the Sentry Vite plugin to customize the source maps upload process.
    */

packages/solidstart/test/vite/sentrySolidStartVite.test.ts

@@ -11,12 +11,9 @@ vi.spyOn(console, 'warn').mockImplementation(() => {
 
 function getSentrySolidStartVitePlugins(options?: Parameters<typeof sentrySolidStartVite>[0]): Plugin[] {
   return sentrySolidStartVite({
-    sourceMapsUploadOptions: {
-      authToken: 'token',
-      org: 'org',
-      project: 'project',
-      ...options?.sourceMapsUploadOptions,
-    },
+    project: 'project',
+    org: 'org',
+    authToken: 'token',
     ...options,
   });
 }

packages/solidstart/test/vite/sourceMaps.test.ts

@@ -38,7 +38,9 @@ describe('makeSourceMapsVitePlugin()', () => {
     makeSourceMapsVitePlugin({
       org: 'my-org',
       authToken: 'my-token',
-      filesToDeleteAfterUpload: ['baz/*.js'],
+      sourceMapsUploadOptions: {
+        filesToDeleteAfterUpload: ['baz/*.js'],
+      },
     });
 
     expect(sentryVitePluginSpy).toHaveBeenCalledWith(
@@ -56,10 +58,12 @@ describe('makeSourceMapsVitePlugin()', () => {
     makeSourceMapsVitePlugin({
       org: 'my-org',
       authToken: 'my-token',
-      unstable_sentryVitePluginOptions: {
-        org: 'unstable-org',
-        sourcemaps: {
-          assets: ['unstable/*.js'],
+      sourceMapsUploadOptions: {
+        unstable_sentryVitePluginOptions: {
+          org: 'unstable-org',
+          sourcemaps: {
+            assets: ['unstable/*.js'],
+          },
         },
       },
     });