@sentry/wizard 4.0.0 → 4.0.1

package/src/run.ts

@@ -1,211 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-import { abortIfCancelled } from './utils/clack-utils';
-import { runReactNativeWizard } from './react-native/react-native-wizard';
-
-import { run as legacyRun } from '../lib/Setup';
-import type { PreselectedProject, WizardOptions } from './utils/types';
-import { runFlutterWizard } from './flutter/flutter-wizard';
-import { runAndroidWizard } from './android/android-wizard';
-import { runAppleWizard } from './apple/apple-wizard';
-import { runNextjsWizard } from './nextjs/nextjs-wizard';
-import { runNuxtWizard } from './nuxt/nuxt-wizard';
-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 type { Platform } from '../lib/Constants';
-import type { PackageDotJson } from './utils/package-json';
-import { readFileSync } from 'node:fs';
-
-type WizardIntegration =
-  | 'reactNative'
-  | 'flutter'
-  | 'ios'
-  | 'android'
-  | 'cordova'
-  | 'electron'
-  | 'nextjs'
-  | 'nuxt'
-  | 'remix'
-  | 'sveltekit'
-  | 'sourcemaps';
-
-type Args = {
-  integration?: WizardIntegration;
-
-  uninstall: boolean;
-  signup: boolean;
-  skipConnect: boolean;
-  debug: boolean;
-  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;
-  forceInstall?: 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,
-    ...readEnvironment(),
-  };
-
-  let integration = finalArgs.integration;
-  if (!integration) {
-    clack.intro(`Sentry Wizard ${tryGetWizardVersion()}`);
-
-    integration = await abortIfCancelled(
-      clack.select({
-        message: 'What do you want to set up?',
-        options: [
-          { value: 'reactNative', label: 'React Native' },
-          { value: 'flutter', label: 'Flutter' },
-          { value: 'ios', label: 'iOS' },
-          { value: 'android', label: 'Android' },
-          { value: 'cordova', label: 'Cordova' },
-          { value: 'electron', label: 'Electron' },
-          { value: 'nextjs', label: 'Next.js' },
-          { value: 'nuxt', label: 'Nuxt' },
-          { value: 'remix', label: 'Remix' },
-          { value: 'sveltekit', label: 'SvelteKit' },
-          { value: 'sourcemaps', label: 'Configure Source Maps Upload' },
-        ],
-      }),
-    );
-
-    if (!integration) {
-      clack.log.error('No integration selected. Exiting.');
-      return;
-    }
-
-    clack.outro(`Starting ${integration} setup`);
-  }
-
-  const wizardOptions: WizardOptions = {
-    telemetryEnabled: !finalArgs.disableTelemetry,
-    promoCode: finalArgs.promoCode,
-    url: finalArgs.url,
-    orgSlug: finalArgs.org,
-    projectSlug: finalArgs.project,
-    saas: finalArgs.saas,
-    preSelectedProject: preSelectedProjectArgsToObject(finalArgs),
-    forceInstall: finalArgs.forceInstall,
-  };
-
-  switch (integration) {
-    case 'reactNative':
-      await runReactNativeWizard({
-        ...wizardOptions,
-        uninstall: finalArgs.uninstall,
-      });
-      break;
-
-    case 'flutter':
-      await runFlutterWizard(wizardOptions);
-      break;
-
-    case 'ios':
-      await runAppleWizard(wizardOptions);
-      break;
-
-    case 'android':
-      await runAndroidWizard(wizardOptions);
-      break;
-
-    case 'nextjs':
-      await runNextjsWizard(wizardOptions);
-      break;
-
-    case 'nuxt':
-      await runNuxtWizard(wizardOptions);
-      break;
-
-    case 'remix':
-      await runRemixWizard(wizardOptions);
-      break;
-
-    case 'sveltekit':
-      await runSvelteKitWizard(wizardOptions);
-      break;
-
-    case 'sourcemaps':
-      await runSourcemapsWizard(wizardOptions);
-      break;
-
-    case 'cordova':
-      argv.integration = 'cordova';
-      void legacyRun(argv);
-      break;
-
-    case 'electron':
-      argv.integration = 'electron';
-      void legacyRun(argv);
-      break;
-
-    default:
-      clack.log.error('No setup wizard selected!');
-  }
-}
-
-/**
- * TODO: replace with rollup replace whenever we switch to rollup
- */
-function tryGetWizardVersion(): string {
-  let version = process.env.npm_package_version;
-  if (!version) {
-    try {
-      const wizardPkgJson = JSON.parse(
-        readFileSync('../package.json', 'utf-8'),
-      ) as PackageDotJson;
-      version = wizardPkgJson.version;
-    } catch {
-      // ignore
-    }
-  }
-  return version ?? '';
-}

package/src/sourcemaps/sourcemaps-wizard.ts

@@ -1,364 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-import * as Sentry from '@sentry/node';
-
-import {
-  abort,
-  abortIfCancelled,
-  confirmContinueIfNoOrDirtyGitRepo,
-  SENTRY_DOT_ENV_FILE,
-  printWelcome,
-  SENTRY_CLI_RC_FILE,
-  getOrAskForProjectData,
-} from '../utils/clack-utils';
-import { isUnicodeSupported } from '../utils/vendor/is-unicorn-supported';
-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 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 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';
-import { getIssueStreamUrl } from '../utils/url';
-
-export async function runSourcemapsWizard(
-  options: WizardOptions,
-): Promise<void> {
-  return withTelemetry(
-    {
-      enabled: options.telemetryEnabled,
-      integration: 'sourcemaps',
-      wizardOptions: options,
-    },
-    () => runSourcemapsWizardWithTelemetry(options),
-  );
-}
-
-async function runSourcemapsWizardWithTelemetry(
-  options: WizardOptions,
-): Promise<void> {
-  printWelcome({
-    wizardName: 'Sentry Source Maps Upload Configuration Wizard',
-    message: `This wizard will help you upload source maps to Sentry as part of your build.
-Thank you for using Sentry :)${
-      options.telemetryEnabled
-        ? `
-
-(This setup wizard sends telemetry data and crash reports to Sentry.
-You can turn this off by running the wizard with the '--disable-telemetry' flag.)`
-        : ''
-    }`,
-    promoCode: options.promoCode,
-  });
-
-  const moreSuitableWizard = await traceStep(
-    'check-framework-wizard',
-    checkIfMoreSuitableWizardExistsAndAskForRedirect,
-  );
-  if (moreSuitableWizard) {
-    await traceStep('run-framework-wizard', () => moreSuitableWizard(options));
-    return;
-  }
-
-  await confirmContinueIfNoOrDirtyGitRepo();
-
-  await traceStep('check-sdk-version', ensureMinimumSdkVersionIsInstalled);
-
-  const { selfHosted, selectedProject, sentryUrl, authToken } =
-    await getOrAskForProjectData(options);
-
-  const wizardOptionsWithPreSelectedProject = {
-    ...options,
-    preSelectedProject: {
-      project: selectedProject,
-      authToken,
-      selfHosted,
-    },
-  };
-
-  const selectedTool = await traceStep('select-tool', askForUsedBundlerTool);
-
-  Sentry.setTag('selected-tool', selectedTool);
-
-  if (selectedTool === 'no-tool') {
-    clack.log.info(
-      "No Problem! But in this case, there's nothing to configure :)",
-    );
-    await abort('Exiting, have a great day!', 0);
-    return;
-  }
-
-  await traceStep('tool-setup', () =>
-    startToolSetupFlow(
-      selectedTool,
-      {
-        orgSlug: selectedProject.organization.slug,
-        projectSlug: selectedProject.slug,
-        selfHosted,
-        url: sentryUrl,
-        authToken,
-      },
-      wizardOptionsWithPreSelectedProject,
-    ),
-  );
-
-  await traceStep('ci-setup', () => configureCI(selectedTool, authToken));
-
-  traceStep('outro', () =>
-    printOutro(
-      sentryUrl,
-      selectedProject.organization.slug,
-      selectedProject.id,
-    ),
-  );
-}
-
-async function askForUsedBundlerTool(): Promise<SupportedTools> {
-  const selectedTool = await abortIfCancelled(
-    clack.select({
-      message: 'Which framework, bundler or build tool are you using?',
-      options: [
-        {
-          label: 'Angular',
-          value: 'angular',
-          hint: 'Select this option if you are using Angular.',
-        },
-        {
-          label: 'Create React App',
-          value: 'create-react-app',
-          hint: 'Select this option if you set up your app with Create React App.',
-        },
-        {
-          label: 'Next.js',
-          value: 'nextjs',
-          hint: 'Select this option if you want to set up source maps in a Next.js project.',
-        },
-        {
-          label: 'Remix',
-          value: 'remix',
-          hint: 'Select this option if you want to set up source maps in a Remix project.',
-        },
-        {
-          label: 'Webpack',
-          value: 'webpack',
-          hint: 'Select this if you are using Webpack and you have access to your Webpack config.',
-        },
-        {
-          label: 'Vite',
-          value: 'vite',
-          hint: 'Select this if you are using Vite and you have access to your Vite config.',
-        },
-        {
-          label: 'esbuild',
-          value: 'esbuild',
-          hint: 'Select this if you are using esbuild and you have access to your esbuild config.',
-        },
-        {
-          label: 'Rollup',
-          value: 'rollup',
-          hint: 'Select this if you are using Rollup and you have access to your Rollup config.',
-        },
-        {
-          label: 'tsc',
-          value: 'tsc',
-          hint: 'Configure source maps when using tsc as build tool',
-        },
-        {
-          label: 'I use another tool',
-          value: 'sentry-cli',
-          hint: 'This will configure source maps upload for you using sentry-cli',
-        },
-        {
-          label: "I don't minify, transpile or bundle my code",
-          value: 'no-tool',
-          hint: 'This will exit the wizard',
-        },
-      ],
-      initialValue: await detectUsedTool(),
-    }),
-  );
-
-  return selectedTool;
-}
-
-async function startToolSetupFlow(
-  selctedTool: SupportedTools,
-  options: SourceMapUploadToolConfigurationOptions,
-  wizardOptions: WizardOptions,
-): Promise<void> {
-  switch (selctedTool) {
-    case 'webpack':
-      await configureWebPackPlugin(options);
-      break;
-    case 'vite':
-      await configureVitePlugin(options);
-      break;
-    case 'esbuild':
-      await configureEsbuildPlugin(options);
-      break;
-    case 'rollup':
-      await configureRollupPlugin(options);
-      break;
-    case 'tsc':
-      await configureSentryCLI(options, configureTscSourcemapGenerationFlow);
-      break;
-    case 'create-react-app':
-      await configureSentryCLI(options, configureCRASourcemapGenerationFlow);
-      break;
-    case 'angular':
-      await configureSentryCLI(
-        options,
-        configureAngularSourcemapGenerationFlow,
-      );
-      break;
-    case 'nextjs':
-      await configureNextJsSourceMapsUpload(options, wizardOptions);
-      break;
-    case 'remix':
-      await configureRemixSourceMapsUpload(options, wizardOptions);
-      break;
-    default:
-      await configureSentryCLI(options);
-      break;
-  }
-}
-
-export async function configureCI(
-  selectedTool: SupportedTools,
-  authToken: string,
-): Promise<void> {
-  const isUsingCI = await abortIfCancelled(
-    clack.select({
-      message: `Are you using a CI/CD tool to build and deploy your application?`,
-      options: [
-        {
-          label: 'Yes',
-          hint: 'I use a tool like GitHub Actions, GitLab, CircleCI, TravisCI, Jenkins, Vercel, ...',
-          value: true,
-        },
-        {
-          label: 'No',
-          hint: 'I build and deploy my application manually',
-          value: false,
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  Sentry.setTag('using-ci', isUsingCI);
-
-  const isCliBasedFlowTool = [
-    'sentry-cli',
-    'tsc',
-    'angular',
-    'create-react-app',
-  ].includes(selectedTool);
-
-  const authTokenFile = isCliBasedFlowTool
-    ? SENTRY_CLI_RC_FILE
-    : SENTRY_DOT_ENV_FILE;
-
-  if (!isUsingCI) {
-    clack.log.info(
-      `No Problem! Just make sure that the Sentry auth token from ${chalk.cyan(
-        authTokenFile,
-      )} is available whenever you build and deploy your app.`,
-    );
-    return;
-  }
-
-  if (isCliBasedFlowTool) {
-    await traceStep('ci-npm-script-setup', setupNpmScriptInCI);
-  }
-
-  await traceStep('ci-auth-token-setup', () => setupAuthTokenInCI(authToken));
-}
-
-async function setupAuthTokenInCI(authToken: string) {
-  clack.log.step(
-    'Add the Sentry authentication token as an environment variable to your CI setup:',
-  );
-
-  // Intentially logging directly to console here so that the code can be copied/pasted directly
-  // eslint-disable-next-line no-console
-  console.log(
-    chalk.greenBright(`
-SENTRY_AUTH_TOKEN=${authToken}
-`),
-  );
-
-  clack.log.warn(
-    chalk.yellow('DO NOT commit this auth token to your repository!'),
-  );
-
-  const addedEnvVarToCI = await abortIfCancelled(
-    clack.select({
-      message: 'Did you configure CI as shown above?',
-      options: [
-        { label: 'Yes, continue!', value: true },
-        {
-          label: "I'll do it later...",
-          value: false,
-          hint: chalk.yellow(
-            'You need to set the auth token to upload source maps in CI',
-          ),
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  Sentry.setTag('added-env-var-to-ci', addedEnvVarToCI);
-
-  if (!addedEnvVarToCI) {
-    clack.log.info("Don't forget! :)");
-  }
-}
-
-function printOutro(url: string, orgSlug: string, projectId: string) {
-  const packageManager = detectPackageManger();
-  const buildCommand = packageManager?.buildCommand ?? 'npm run build';
-
-  const issueStreamUrl = getIssueStreamUrl({ url, orgSlug, projectId });
-
-  const arrow = isUnicodeSupported() ? '→' : '->';
-
-  clack.outro(`${chalk.green("That's it - everything is set up!")}
-
-   ${chalk.cyan(`Test and validate your setup locally with the following Steps:
-
-   1. Build your application in ${chalk.bold('production mode')}.
-      ${chalk.gray(`${arrow} For example, run ${chalk.bold(buildCommand)}.`)}
-      ${chalk.gray(
-        `${arrow} You should see source map upload logs in your console.`,
-      )}
-   2. Run your application and throw a test error.
-      ${chalk.gray(`${arrow} The error should appear in Sentry:`)}
-      ${chalk.gray(`${arrow} ${issueStreamUrl}`)}
-   3. Open the error in Sentry and verify that it's source-mapped.
-      ${chalk.gray(
-        `${arrow} The stack trace should show your original source code.`,
-      )}
-   `)}
-   ${chalk.dim(
-     `If you encounter any issues, please refer to the Troubleshooting Guide:
-   https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js
-
-   If the guide doesn't help or you encounter a bug, please let us know:
-   https://github.com/getsentry/sentry-javascript/issues`,
-   )}
-`);
-}

package/src/sourcemaps/tools/angular.ts

@@ -1,42 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-import { abortIfCancelled } from '../../utils/clack-utils';
-
-const angularJsonTemplate = chalk.gray(`{
-  "projects": {
-    "your-project": {
-      "architect": {
-        "build": {
-          "options": {
-            ${chalk.greenBright(`"sourceMap": true`)}
-          },
-        },
-      }
-    }
-  }
-}`);
-
-export async function configureAngularSourcemapGenerationFlow(): Promise<void> {
-  clack.log.info(
-    `Enable generating source maps in your ${chalk.bold('angular.json')} file:`,
-  );
-
-  // Intentially logging directly to console here so that the code can be copied/pasted directly
-  // eslint-disable-next-line no-console
-  console.log(angularJsonTemplate);
-
-  await abortIfCancelled(
-    clack.select({
-      message: `Verify that you are generating source maps when building your Angular app.`,
-      options: [
-        {
-          label: 'I checked!',
-          hint: 'My build output folder contains .js.map files after a build.',
-          value: true,
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-}

package/src/sourcemaps/tools/create-react-app.ts

@@ -1,19 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import { abortIfCancelled } from '../../utils/clack-utils';
-
-export async function configureCRASourcemapGenerationFlow(): Promise<void> {
-  await abortIfCancelled(
-    clack.select({
-      message: `Verify that you are generating source maps when building your React app.\nGenerally this should already happen unless you set the GENERATE_SOURCEMAPS environment variable to false.`,
-      options: [
-        {
-          label: 'I checked!',
-          hint: 'My build output folder contains .js.map files after a build.',
-          value: true,
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-}

package/src/sourcemaps/tools/esbuild.ts

@@ -1,65 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack, { select } from '@clack/prompts';
-import chalk from 'chalk';
-import {
-  abortIfCancelled,
-  addDotEnvSentryBuildPluginFile,
-  getPackageDotJson,
-  installPackage,
-} from '../../utils/clack-utils';
-import { hasPackageInstalled } from '../../utils/package-json';
-
-import {
-  SourceMapUploadToolConfigurationFunction,
-  SourceMapUploadToolConfigurationOptions,
-} from './types';
-
-const getCodeSnippet = (options: SourceMapUploadToolConfigurationOptions) =>
-  chalk.gray(`
-${chalk.greenBright(
-  'const { sentryEsbuildPlugin } = require("@sentry/esbuild-plugin");',
-)}
-
-require("esbuild").build({
-  ${chalk.greenBright(
-    'sourcemap: true, // Source map generation must be turned on',
-  )}
-  plugins: [
-    // Put the Sentry esbuild plugin after all other plugins
-    ${chalk.greenBright(`sentryEsbuildPlugin({
-      authToken: process.env.SENTRY_AUTH_TOKEN,
-      org: "${options.orgSlug}",
-      project: "${options.projectSlug}",${
-      options.selfHosted ? `\n      url: "${options.url}",` : ''
-    }
-    }),`)}
-  ],
-});
-`);
-
-export const configureEsbuildPlugin: SourceMapUploadToolConfigurationFunction =
-  async (options) => {
-    await installPackage({
-      packageName: '@sentry/esbuild-plugin',
-      alreadyInstalled: hasPackageInstalled(
-        '@sentry/esbuild-plugin',
-        await getPackageDotJson(),
-      ),
-    });
-
-    clack.log.step(`Add the following code to your esbuild config:`);
-
-    // Intentially logging directly to console here so that the code can be copied/pasted directly
-    // eslint-disable-next-line no-console
-    console.log(getCodeSnippet(options));
-
-    await abortIfCancelled(
-      select({
-        message: 'Did you copy the snippet above?',
-        options: [{ label: 'Yes, continue!', value: true }],
-        initialValue: true,
-      }),
-    );
-
-    await addDotEnvSentryBuildPluginFile(options.authToken);
-  };