read options from vite config

Author: chargome

packages/react-router/package.json

@@ -38,7 +38,8 @@
     "@sentry/core": "9.1.0",
     "@sentry/node": "9.1.0",
     "@sentry/vite-plugin": "^3.2.0",
-    "@sentry/cli": "^2.42.1"
+    "@sentry/cli": "^2.42.1",
+    "glob": "11.0.1"
   },
   "devDependencies": {
     "@react-router/node": "^7.1.5",

packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

@@ -1,39 +1,40 @@
 import type { Config } from '@react-router/dev/dist/config';
 import SentryCli from '@sentry/cli';
-import glob from 'glob';
-import * as fs from 'fs';
+import { glob } from 'glob';
+import { rm } from 'node:fs/promises';
+import type { SentryReactRouterBuildOptions } from '../types';
 
-type ExtendedBuildEndArgs = Parameters<NonNullable<Config['buildEnd']>>[0] & {
-  sentryConfig: {
-    authToken?: string;
-    org?: string;
-    project?: string;
-    sourceMapsUploadOptions?: {
-      enabled?: boolean;
-      filesToDeleteAfterUpload?: string | string[] | false;
-    };
-    release?: {
-      name?: string;
-    };
-    debug?: boolean;
-  };
-};
+type BuildEndHook = NonNullable<Config['buildEnd']>;
+
+function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
+  if (!viteConfig || typeof viteConfig !== 'object' || !('sentryConfig' in viteConfig)) {
+    // eslint-disable-next-line no-console
+    console.error('[Sentry] sentryConfig not found - it needs to be passed to vite.config.ts');
+  }
 
-type ExtendedBuildEndHook = (args: ExtendedBuildEndArgs) => void | Promise<void>;
+  return (viteConfig as { sentryConfig: SentryReactRouterBuildOptions }).sentryConfig;
+}
 
 /**
  * A build end hook that handles Sentry release creation and source map uploads.
  * It creates a new Sentry release if configured, uploads source maps to Sentry,
  * and optionally deletes the source map files after upload.
  */
-export const sentryOnBuildEnd: ExtendedBuildEndHook = async ({ reactRouterConfig, viteConfig, sentryConfig }) => {
-  const { authToken, org, project, release, sourceMapsUploadOptions, debug } = sentryConfig;
+export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
+  const {
+    authToken = 'test-token',
+    org = 'test-org',
+    project = 'test-project',
+    release = { name: 'test-release' },
+    sourceMapsUploadOptions = { enabled: true },
+    debug = false,
+  } = getSentryConfig(viteConfig);
+
   const cliInstance = new SentryCli(null, {
     authToken,
     org,
     project,
   });
-
   // check if release should be created
   if (release?.name) {
     try {
@@ -43,7 +44,6 @@ export const sentryOnBuildEnd: ExtendedBuildEndHook = async ({ reactRouterConfig
       console.error('[Sentry] Could not create release', error);
     }
   }
-
   // upload sourcemaps
   if (sourceMapsUploadOptions?.enabled ?? (true && viteConfig.build.sourcemap !== false)) {
     try {
@@ -59,14 +59,11 @@ export const sentryOnBuildEnd: ExtendedBuildEndHook = async ({ reactRouterConfig
       console.error('[Sentry] Could not upload sourcemaps', error);
     }
   }
-
   // delete sourcemaps after upload
   let updatedFilesToDeleteAfterUpload = sourceMapsUploadOptions?.filesToDeleteAfterUpload;
-
   // set a default value no option was set
   if (typeof sourceMapsUploadOptions?.filesToDeleteAfterUpload === 'undefined') {
     updatedFilesToDeleteAfterUpload = [`${reactRouterConfig.buildDirectory}/**/*.map`];
-
     if (debug) {
       // eslint-disable-next-line no-console
       console.info(
@@ -76,24 +73,21 @@ export const sentryOnBuildEnd: ExtendedBuildEndHook = async ({ reactRouterConfig
       );
     }
   }
-
   if (updatedFilesToDeleteAfterUpload) {
     try {
       const filePathsToDelete = await glob(updatedFilesToDeleteAfterUpload, {
         absolute: true,
         nodir: true,
       });
-
       if (debug) {
         filePathsToDelete.forEach(filePathToDelete => {
           // eslint-disable-next-line no-console
           console.info(`Deleting asset after upload: ${filePathToDelete}`);
         });
       }
-
       await Promise.all(
         filePathsToDelete.map(filePathToDelete =>
-          fs.promises.rm(filePathToDelete, { force: true }).catch((e: unknown) => {
+          rm(filePathToDelete, { force: true }).catch((e: unknown) => {
             if (debug) {
               // This is allowed to fail - we just don't do anything
               // eslint-disable-next-line no-console

packages/react-router/src/vite/index.ts

@@ -1,2 +1,3 @@
 export { sentryReactRouter } from './plugin';
 export { sentryOnBuildEnd } from './buildEnd/handleOnBuildEnd';
+export type { SentryReactRouterBuildOptions } from './types';

packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

@@ -1,11 +1,11 @@
 import { sentryVitePlugin } from '@sentry/vite-plugin';
 import { type Plugin } from 'vite';
-import type { SentryReactRouterPluginOptions } from './types';
+import type { SentryReactRouterBuildOptions } from './types';
 
 /**
  * Create a custom subset of sentry's vite plugins
  */
-export async function makeCustomSentryVitePlugins(options: SentryReactRouterPluginOptions): Promise<Plugin[]> {
+export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
   const {
     debug,
     sourceMapsUploadOptions,

packages/react-router/src/vite/makeEnableSourceMapsPlugin.ts

@@ -1,11 +1,11 @@
 import { consoleSandbox } from '@sentry/core';
 import type { Plugin, UserConfig } from 'vite';
-import type { SentryReactRouterPluginOptions } from './types';
+import type { SentryReactRouterBuildOptions } from './types';
 
 /**
  * A Sentry plugin for React Router to enable "hidden" source maps if they are unset.
  */
-export function makeEnableSourceMapsPlugin(options: SentryReactRouterPluginOptions): Plugin {
+export function makeEnableSourceMapsPlugin(options: SentryReactRouterBuildOptions): Plugin {
   return {
     name: 'sentry-react-router-update-source-map-setting',
     apply: 'build',
@@ -39,7 +39,7 @@ export function makeEnableSourceMapsPlugin(options: SentryReactRouterPluginOptio
  */
 export function getUpdatedSourceMapSettings(
   viteConfig: UserConfig,
-  sentryPluginOptions?: SentryReactRouterPluginOptions,
+  sentryPluginOptions?: SentryReactRouterBuildOptions,
 ): boolean | 'inline' | 'hidden' {
   viteConfig.build = viteConfig.build || {};
 

packages/react-router/src/vite/plugin.ts

@@ -2,7 +2,7 @@ import type { ConfigEnv } from 'vite';
 import { type Plugin } from 'vite';
 import { makeCustomSentryVitePlugins } from './makeCustomSentryVitePlugins';
 import { makeEnableSourceMapsPlugin } from './makeEnableSourceMapsPlugin';
-import type { SentryReactRouterPluginOptions } from './types';
+import type { SentryReactRouterBuildOptions } from './types';
 
 /**
  * A Vite plugin for Sentry that handles source map uploads and bundle size optimizations.
@@ -12,7 +12,7 @@ import type { SentryReactRouterPluginOptions } from './types';
  * @returns An array of Vite plugins
  */
 export async function sentryReactRouter(
-  options: SentryReactRouterPluginOptions = {},
+  options: SentryReactRouterBuildOptions = {},
   config: ConfigEnv,
 ): Promise<Plugin[]> {
   const plugins: Plugin[] = [];

packages/react-router/src/vite/types.ts

@@ -89,7 +89,17 @@ type BundleSizeOptimizationOptions = {
   excludeReplayWorker?: boolean;
 };
 
-export type SentryReactRouterPluginOptions = {
+export type SentryReactRouterBuildOptions = {
+  /**
+   * Options for configuring the Sentry release.
+   */
+  release?: {
+    /**
+     * The name of the release to create in Sentry
+     */
+    name?: string;
+  };
+
   /**
    * The auth token to use when uploading source maps to Sentry.
    *

yarn.lock

@@ -17404,6 +17404,18 @@ glob-to-regexp@^0.4.1:
   resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e"
   integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==
 
+[email protected]:
+  version "11.0.1"
+  resolved "https://registry.yarnpkg.com/glob/-/glob-11.0.1.tgz#1c3aef9a59d680e611b53dcd24bb8639cef064d9"
+  integrity sha512-zrQDm8XPnYEKawJScsnM0QzobJxlT/kHOOlRTio8IH/GrmxRE5fjllkzdaHclIuNjUQTJYH2xHNIGfdpJkDJUw==
+  dependencies:
+    foreground-child "^3.1.0"
+    jackspeak "^4.0.1"
+    minimatch "^10.0.0"
+    minipass "^7.1.2"
+    package-json-from-dist "^1.0.0"
+    path-scurry "^2.0.0"
+
 [email protected]:
   version "7.1.4"
   resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.4.tgz#aa608a2f6c577ad357e1ae5a5c26d9a8d1969255"
@@ -19558,6 +19570,13 @@ jackspeak@^3.1.2:
   optionalDependencies:
     "@pkgjs/parseargs" "^0.11.0"
 
+jackspeak@^4.0.1:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/jackspeak/-/jackspeak-4.1.0.tgz#c489c079f2b636dc4cbe9b0312a13ff1282e561b"
+  integrity sha512-9DDdhb5j6cpeitCbvLO7n7J4IxnbM6hoF6O1g4HQ5TfhvvKN8ywDM7668ZhMHRqVmxqhps/F6syWK2KcPxYlkw==
+  dependencies:
+    "@isaacs/cliui" "^8.0.2"
+
 jake@^10.8.5:
   version "10.8.5"
   resolved "https://registry.yarnpkg.com/jake/-/jake-10.8.5.tgz#f2183d2c59382cb274226034543b9c03b8164c46"
@@ -21192,6 +21211,11 @@ lru-cache@^10.2.0, lru-cache@^10.4.3:
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.4.3.tgz#410fc8a17b70e598013df257c2446b7f3383f119"
   integrity sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==
 
+lru-cache@^11.0.0:
+  version "11.0.2"
+  resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-11.0.2.tgz#fbd8e7cf8211f5e7e5d91905c415a3f55755ca39"
+  integrity sha512-123qHRfJBmo2jXDbo/a5YOQrJoHF/GNQTLzQ5+IdK5pWpceK17yRc6ozlWd25FxvGKQbIUs91fDFkXmDHTKcyA==
+
 lru-cache@^5.1.1:
   version "5.1.1"
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920"
@@ -22198,6 +22222,13 @@ [email protected], minimatch@^5.0.1, minimatch@^5.1.0:
   dependencies:
     brace-expansion "^2.0.1"
 
+minimatch@^10.0.0:
+  version "10.0.1"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-10.0.1.tgz#ce0521856b453c86e25f2c4c0d03e6ff7ddc440b"
+  integrity sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==
+  dependencies:
+    brace-expansion "^2.0.1"
+
 minimatch@^7.4.1:
   version "7.4.6"
   resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.6.tgz#845d6f254d8f4a5e4fd6baf44d5f10c8448365fb"
@@ -24422,6 +24453,14 @@ path-scurry@^1.11.1, path-scurry@^1.6.1:
     lru-cache "^10.2.0"
     minipass "^5.0.0 || ^6.0.2 || ^7.0.0"
 
+path-scurry@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/path-scurry/-/path-scurry-2.0.0.tgz#9f052289f23ad8bf9397a2a0425e7b8615c58580"
+  integrity sha512-ypGJsmGtdXUOeM5u93TyeIEfEhM6s+ljAhrk5vAvSx8uyY/02OvrZnA0YNGUrPXfpJMgI1ODd3nwz8Npx4O4cg==
+  dependencies:
+    lru-cache "^11.0.0"
+    minipass "^7.1.2"
+
 [email protected]:
   version "0.1.10"
   resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-0.1.10.tgz#67e9108c5c0551b9e5326064387de4763c4d5f8b"