feat(react-router): Align options with shared build time options type (#18014)

closes #17066

Also updates the shared `BuildTimeOptionsBase` type a bit to align with
the latest changes.

Author: s1gr1d

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

@@ -243,6 +243,37 @@ interface SourceMapsOptions {
   filesToDeleteAfterUpload?: string | Array<string>;
 }
 
+type AutoSetCommitsOptions = {
+  /**
+   * Automatically sets `commit` and `previousCommit`. Sets `commit` to `HEAD`
+   * and `previousCommit` as described in the option's documentation.
+   *
+   * If you set this to `true`, manually specified `commit` and `previousCommit`
+   * options will be overridden. It is best to not specify them at all if you
+   * set this option to `true`.
+   */
+  auto: true;
+  repo?: undefined;
+  commit?: undefined;
+};
+
+type ManualSetCommitsOptions = {
+  auto?: false | undefined;
+  /**
+   * The full repo name as defined in Sentry.
+   *
+   * Required if the `auto` option is not set to `true`.
+   */
+  repo: string;
+
+  /**
+   * The current (last) commit in the release.
+   *
+   * Required if the `auto` option is not set to `true`.
+   */
+  commit: string;
+};
+
 interface ReleaseOptions {
   /**
    * Unique identifier for the release you want to create.
@@ -299,101 +330,81 @@ interface ReleaseOptions {
 
   /**
    * Configuration for associating the release with its commits in Sentry.
+   *
+   * Set to `false` to disable commit association.
+   *
+   * @default { auto: true }
    */
-  setCommits?: (
-    | {
+  setCommits?:
+    | false
+    | ((AutoSetCommitsOptions | ManualSetCommitsOptions) & {
         /**
-         * Automatically sets `commit` and `previousCommit`. Sets `commit` to `HEAD`
-         * and `previousCommit` as described in the option's documentation.
+         * The commit before the beginning of this release (in other words,
+         * the last commit of the previous release).
+         *
+         * Defaults to the last commit of the previous release in Sentry.
          *
-         * If you set this to `true`, manually specified `commit` and `previousCommit`
-         * options will be overridden. It is best to not specify them at all if you
-         * set this option to `true`.
+         * If there was no previous release, the last 10 commits will be used.
          */
-        auto: true;
-        repo?: undefined;
-        commit?: undefined;
-      }
-    | {
-        auto?: false | undefined;
+        previousCommit?: string;
+
         /**
-         * The full repo name as defined in Sentry.
+         * If the flag is to `true` and the previous release commit was not found
+         * in the repository, the plugin creates a release with the default commits
+         * count instead of failing the command.
          *
-         * Required if the `auto` option is not set to `true`.
+         * @default false
          */
-        repo: string;
+        ignoreMissing?: boolean;
 
         /**
-         * The current (last) commit in the release.
+         * If this flag is set, the setCommits step will not fail and just exit
+         * silently if no new commits for a given release have been found.
          *
-         * Required if the `auto` option is not set to `true`.
+         * @default false
          */
-        commit: string;
-      }
-  ) & {
-    /**
-     * The commit before the beginning of this release (in other words,
-     * the last commit of the previous release).
-     *
-     * Defaults to the last commit of the previous release in Sentry.
-     *
-     * If there was no previous release, the last 10 commits will be used.
-     */
-    previousCommit?: string;
-
-    /**
-     * If the flag is to `true` and the previous release commit was not found
-     * in the repository, the plugin creates a release with the default commits
-     * count instead of failing the command.
-     *
-     * @default false
-     */
-    ignoreMissing?: boolean;
-
-    /**
-     * If this flag is set, the setCommits step will not fail and just exit
-     * silently if no new commits for a given release have been found.
-     *
-     * @default false
-     */
-    ignoreEmpty?: boolean;
-  };
+        ignoreEmpty?: boolean;
+      });
 
   /**
    * Configuration for adding deployment information to the release in Sentry.
+   *
+   * Set to `false` to disable automatic deployment detection and creation.
    */
-  deploy?: {
-    /**
-     * Environment for this release. Values that make sense here would
-     * be `production` or `staging`.
-     */
-    env: string;
-
-    /**
-     * Deployment start time in Unix timestamp (in seconds) or ISO 8601 format.
-     */
-    started?: number | string;
-
-    /**
-     * Deployment finish time in Unix timestamp (in seconds) or ISO 8601 format.
-     */
-    finished?: number | string;
-
-    /**
-     * Deployment duration (in seconds). Can be used instead of started and finished.
-     */
-    time?: number;
-
-    /**
-     * Human-readable name for the deployment.
-     */
-    name?: string;
-
-    /**
-     * URL that points to the deployment.
-     */
-    url?: string;
-  };
+  deploy?:
+    | false
+    | {
+        /**
+         * Environment for this release. Values that make sense here would
+         * be `production` or `staging`.
+         */
+        env: string;
+
+        /**
+         * Deployment start time in Unix timestamp (in seconds) or ISO 8601 format.
+         */
+        started?: number | string;
+
+        /**
+         * Deployment finish time in Unix timestamp (in seconds) or ISO 8601 format.
+         */
+        finished?: number | string;
+
+        /**
+         * Deployment duration (in seconds). Can be used instead of started and finished.
+         */
+        time?: number;
+
+        /**
+         * Human-readable name for the deployment.
+         */
+        name?: string;
+
+        /**
+         * URL that points to the deployment.
+         */
+        url?: string;
+      };
 }
 
 interface BundleSizeOptimizationsOptions {

packages/react-router/.eslintrc.js

@@ -7,7 +7,7 @@ module.exports = {
     {
       files: ['vite.config.ts'],
       parserOptions: {
-        project: ['tsconfig.test.json'],
+        project: ['tsconfig.vite.json'],
       },
     },
   ],

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

@@ -1,6 +1,7 @@
 import { rm } from 'node:fs/promises';
 import type { Config } from '@react-router/dev/config';
 import SentryCli from '@sentry/cli';
+import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
 import { glob } from 'glob';
 import type { SentryReactRouterBuildOptions } from '../types';
 
@@ -23,17 +24,31 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
   const sentryConfig = getSentryConfig(viteConfig);
 
+  // todo(v11): Remove deprecated sourceMapsUploadOptions support (no need for spread/pick anymore)
+  const {
+    sourceMapsUploadOptions, // extract to exclude from rest config
+    ...sentryConfigWithoutDeprecatedSourceMapOption
+  } = sentryConfig;
+
   const {
     authToken,
     org,
     project,
     release,
-    sourceMapsUploadOptions = { enabled: true },
+    sourcemaps = { disable: false },
     debug = false,
-    unstable_sentryVitePluginOptions,
-  }: SentryReactRouterBuildOptions = {
+  }: Omit<SentryReactRouterBuildOptions, 'sourcemaps' | 'sourceMapsUploadOptions'> &
+    // Pick 'sourcemaps' from Vite plugin options as the types allow more (e.g. Promise values for `deleteFilesAfterUpload`)
+    Pick<SentryVitePluginOptions, 'sourcemaps'> = {
     ...sentryConfig.unstable_sentryVitePluginOptions,
-    ...sentryConfig,
+    ...sentryConfigWithoutDeprecatedSourceMapOption, // spread in the config without the deprecated sourceMapsUploadOptions
+    sourcemaps: {
+      ...sentryConfig.unstable_sentryVitePluginOptions?.sourcemaps,
+      ...sentryConfig.sourcemaps,
+      ...sourceMapsUploadOptions,
+      // eslint-disable-next-line deprecation/deprecation
+      disable: sourceMapsUploadOptions?.enabled === false ? true : sentryConfig.sourcemaps?.disable,
+    },
     release: {
       ...sentryConfig.unstable_sentryVitePluginOptions?.release,
       ...sentryConfig.release,
@@ -44,8 +59,9 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
     authToken,
     org,
     project,
-    ...unstable_sentryVitePluginOptions,
+    ...sentryConfig.unstable_sentryVitePluginOptions,
   });
+
   // check if release should be created
   if (release?.name) {
     try {
@@ -56,7 +72,7 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
     }
   }
 
-  if (sourceMapsUploadOptions?.enabled ?? (true && viteConfig.build.sourcemap !== false)) {
+  if (!sourcemaps?.disable && viteConfig.build.sourcemap !== false) {
     // inject debugIds
     try {
       await cliInstance.execute(
@@ -84,9 +100,10 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
     }
   }
   // delete sourcemaps after upload
-  let updatedFilesToDeleteAfterUpload = sourceMapsUploadOptions?.filesToDeleteAfterUpload;
+  let updatedFilesToDeleteAfterUpload = await sourcemaps?.filesToDeleteAfterUpload;
+
   // set a default value no option was set
-  if (typeof sourceMapsUploadOptions?.filesToDeleteAfterUpload === 'undefined') {
+  if (typeof updatedFilesToDeleteAfterUpload === 'undefined') {
     updatedFilesToDeleteAfterUpload = [`${reactRouterConfig.buildDirectory}/**/*.map`];
     debug &&
       // eslint-disable-next-line no-console

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

@@ -14,13 +14,13 @@ import type { SentryReactRouterBuildOptions } from './types';
  */
 export async function sentryReactRouter(
   options: SentryReactRouterBuildOptions = {},
-  config: ConfigEnv,
+  viteConfig: ConfigEnv,
 ): Promise<Plugin[]> {
   const plugins: Plugin[] = [];
 
   plugins.push(makeConfigInjectorPlugin(options));
 
-  if (process.env.NODE_ENV !== 'development' && config.command === 'build' && config.mode !== 'development') {
+  if (process.env.NODE_ENV !== 'development' && viteConfig.command === 'build' && viteConfig.mode !== 'development') {
     plugins.push(makeEnableSourceMapsPlugin(options));
     plugins.push(...(await makeCustomSentryVitePlugins(options)));
   }