@sentry/wizard 3.31.0 → 3.33.0

package/src/run.ts

@@ -4,7 +4,7 @@ import { abortIfCancelled } from './utils/clack-utils';
 import { runReactNativeWizard } from './react-native/react-native-wizard';
 
 import { run as legacyRun } from '../lib/Setup';
-import { WizardOptions } from './utils/types';
+import type { PreselectedProject, WizardOptions } from './utils/types';
 import { runAndroidWizard } from './android/android-wizard';
 import { runAppleWizard } from './apple/apple-wizard';
 import { runNextjsWizard } from './nextjs/nextjs-wizard';
@@ -12,8 +12,8 @@ import { runRemixWizard } from './remix/remix-wizard';
 import { runSvelteKitWizard } from './sveltekit/sveltekit-wizard';
 import { runSourcemapsWizard } from './sourcemaps/sourcemaps-wizard';
 import { readEnvironment } from '../lib/Helper/Env';
-import { Platform } from '../lib/Constants';
-import { PackageDotJson } from './utils/package-json';
+import type { Platform } from '../lib/Constants';
+import type { PackageDotJson } from './utils/package-json';
 
 type WizardIntegration =
   | 'reactNative'
@@ -36,13 +36,53 @@ type Args = {
   quiet: boolean;
   disableTelemetry: boolean;
   promoCode?: string;
-
+  preSelectedProject?: {
+    authToken: string;
+    selfHosted: boolean;
+    dsn: string;
+    projectId: string;
+    projectSlug: string;
+    projectName: string;
+    orgId: string;
+    orgName: string;
+    orgSlug: string;
+  };
   url?: string;
   platform?: Platform[];
   org?: string;
   project?: string;
+  saas?: boolean;
 };
 
+function preSelectedProjectArgsToObject(
+  args: Args,
+): PreselectedProject | undefined {
+  if (!args.preSelectedProject) {
+    return undefined;
+  }
+
+  return {
+    authToken: args.preSelectedProject.authToken,
+    selfHosted: args.preSelectedProject.selfHosted,
+    project: {
+      id: args.preSelectedProject.projectId,
+      keys: [
+        {
+          dsn: {
+            public: args.preSelectedProject.dsn,
+          },
+        },
+      ],
+      organization: {
+        id: args.preSelectedProject.orgId,
+        name: args.preSelectedProject.orgName,
+        slug: args.preSelectedProject.orgSlug,
+      },
+      slug: args.preSelectedProject.projectSlug,
+    },
+  };
+}
+
 export async function run(argv: Args) {
   const finalArgs = {
     ...argv,
@@ -79,18 +119,20 @@ export async function run(argv: Args) {
   }
 
   const wizardOptions: WizardOptions = {
-    telemetryEnabled: !argv.disableTelemetry,
-    promoCode: argv.promoCode,
-    url: argv.url,
-    orgSlug: argv.org,
-    projectSlug: argv.project,
+    telemetryEnabled: !finalArgs.disableTelemetry,
+    promoCode: finalArgs.promoCode,
+    url: finalArgs.url,
+    orgSlug: finalArgs.org,
+    projectSlug: finalArgs.project,
+    saas: finalArgs.saas,
+    preSelectedProject: preSelectedProjectArgsToObject(finalArgs),
   };
 
   switch (integration) {
     case 'reactNative':
       await runReactNativeWizard({
         ...wizardOptions,
-        uninstall: argv.uninstall,
+        uninstall: finalArgs.uninstall,
       });
       break;
 
@@ -129,7 +171,7 @@ export async function run(argv: Args) {
       break;
 
     default:
-      clack.log.error(`No setup wizard selected!`);
+      clack.log.error('No setup wizard selected!');
   }
 }
 

package/src/sourcemaps/sourcemaps-wizard.ts

@@ -13,20 +13,21 @@ import {
   getOrAskForProjectData,
 } from '../utils/clack-utils';
 import { isUnicodeSupported } from '../utils/vendor/is-unicorn-supported';
-import { SourceMapUploadToolConfigurationOptions } from './tools/types';
+import type { SourceMapUploadToolConfigurationOptions } from './tools/types';
 import { configureVitePlugin } from './tools/vite';
 import { setupNpmScriptInCI, configureSentryCLI } from './tools/sentry-cli';
 import { configureWebPackPlugin } from './tools/webpack';
 import { configureTscSourcemapGenerationFlow } from './tools/tsc';
 import { configureRollupPlugin } from './tools/rollup';
 import { configureEsbuildPlugin } from './tools/esbuild';
-import { WizardOptions } from '../utils/types';
+import type { WizardOptions } from '../utils/types';
 import { configureCRASourcemapGenerationFlow } from './tools/create-react-app';
 import { ensureMinimumSdkVersionIsInstalled } from './utils/sdk-version';
 import { traceStep, withTelemetry } from '../telemetry';
 import { checkIfMoreSuitableWizardExistsAndAskForRedirect } from './utils/other-wizards';
 import { configureAngularSourcemapGenerationFlow } from './tools/angular';
-import { detectUsedTool, SupportedTools } from './utils/detect-tool';
+import type { SupportedTools } from './utils/detect-tool';
+import { detectUsedTool } from './utils/detect-tool';
 import { configureNextJsSourceMapsUpload } from './tools/nextjs';
 import { configureRemixSourceMapsUpload } from './tools/remix';
 import { detectPackageManger } from '../utils/package-manager';

package/src/sourcemaps/tools/remix.ts

@@ -4,8 +4,8 @@ import chalk from 'chalk';
 import { runRemixWizard } from '../../remix/remix-wizard';
 import { traceStep } from '../../telemetry';
 import { abortIfCancelled } from '../../utils/clack-utils';
-import { WizardOptions } from '../../utils/types';
-import { SourceMapUploadToolConfigurationOptions } from './types';
+import type { WizardOptions } from '../../utils/types';
+import type { SourceMapUploadToolConfigurationOptions } from './types';
 
 import * as Sentry from '@sentry/node';
 

package/src/telemetry.ts

@@ -34,6 +34,7 @@ export async function withTelemetry<F>(
   // Set tag for passed CLI args
   sentryHub.setTag('args.project', !!options.wizardOptions.projectSlug);
   sentryHub.setTag('args.org', !!options.wizardOptions.orgSlug);
+  sentryHub.setTag('args.saas', !!options.wizardOptions.saas);
 
   try {
     return await startSpan(

package/src/utils/clack-utils.ts

@@ -691,20 +691,29 @@ export async function runPrettierIfInstalled(): Promise<void> {
       return;
     }
 
+    const changedOrUntrackedFiles = getUncommittedOrUntrackedFiles()
+      .map((filename) => {
+        return filename.startsWith('- ') ? filename.slice(2) : filename;
+      })
+      .join(' ');
+
     const prettierSpinner = clack.spinner();
     prettierSpinner.start('Running Prettier on your files.');
 
     try {
       await new Promise<void>((resolve, reject) => {
-        childProcess.exec('npx prettier --write .', (err) => {
-          if (err) {
-            reject(err);
-          } else {
-            resolve();
-          }
-        });
+        childProcess.exec(
+          `npx prettier --ignore-unknown --write ${changedOrUntrackedFiles}`,
+          (err) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve();
+            }
+          },
+        );
       });
-    } catch {
+    } catch (e) {
       prettierSpinner.stop('Prettier failed to run.');
       clack.log.error(
         'Prettier failed to run. There may be formatting issues in your updated files.',
@@ -847,7 +856,7 @@ export async function getOrAskForProjectData(
   }
   const { url: sentryUrl, selfHosted } = await traceStep(
     'ask-self-hosted',
-    () => askForSelfHosted(options.url),
+    () => askForSelfHosted(options.url, options.saas),
   );
 
   const { projects, apiKeys } = await traceStep('login', () =>
@@ -908,10 +917,19 @@ ${chalk.cyan(
  *
  * @param urlFromArgs the url passed via the --url arg
  */
-async function askForSelfHosted(urlFromArgs?: string): Promise<{
+async function askForSelfHosted(
+  urlFromArgs?: string,
+  saas?: boolean,
+): Promise<{
   url: string;
   selfHosted: boolean;
 }> {
+  if (saas) {
+    Sentry.setTag('url', SAAS_URL);
+    Sentry.setTag('self-hosted', false);
+    return { url: SAAS_URL, selfHosted: false };
+  }
+
   if (!urlFromArgs) {
     const choice: 'saas' | 'self-hosted' | symbol = await abortIfCancelled(
       clack.select({

package/src/utils/types.ts

@@ -1,20 +1,20 @@
 export interface SentryProjectData {
   id: string;
   slug: string;
-  status: string;
   organization: {
     id: string;
     name: string;
     slug: string;
-    region: string;
-    status: {
-      id: string;
-      name: string;
-    };
   };
-  keys: [{ dsn: { public: string }; isActive: boolean }];
+  keys: [{ dsn: { public: string } }];
 }
 
+export type PreselectedProject = {
+  project: SentryProjectData;
+  authToken: string;
+  selfHosted: boolean;
+};
+
 export type WizardOptions = {
   /**
    * Controls whether the wizard should send telemetry data to Sentry.
@@ -47,16 +47,16 @@ export type WizardOptions = {
    */
   projectSlug?: string;
 
+  /**
+   * If this option is set, the wizard will skip the self-hosted or SaaS
+   * selection step and directly assume that the wizard is used for Sentry SaaS.
+   */
+  saas?: boolean;
+
   /**
    * If this is set, the wizard will skip the login and project selection step.
-   * (This can not yet be set externally but for example when redirecting from
-   * one wizard to another when the project was already selected)
    */
-  preSelectedProject?: {
-    project: SentryProjectData;
-    authToken: string;
-    selfHosted: boolean;
-  };
+  preSelectedProject?: PreselectedProject;
 };
 
 export interface Feature {