@sentry/wizard 3.42.1 → 4.0.1

package/src/sourcemaps/tools/nextjs.ts

@@ -1,114 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-import chalk from 'chalk';
-import { runNextjsWizard } from '../../nextjs/nextjs-wizard';
-import { traceStep } from '../../telemetry';
-import {
-  abortIfCancelled,
-  addDotEnvSentryBuildPluginFile,
-} from '../../utils/clack-utils';
-import { WizardOptions } from '../../utils/types';
-
-import { SourceMapUploadToolConfigurationOptions } from './types';
-
-import * as Sentry from '@sentry/node';
-
-const getCodeSnippet = (options: SourceMapUploadToolConfigurationOptions) =>
-  chalk.grey(`
-  ${chalk.greenBright(
-    'const { withSentryConfig } = require("@sentry/nextjs");',
-  )}
-
-  const nextConfig = {
-    // your existing next config
-  };
-
-  ${chalk.greenBright(`const sentryWebpackPluginOptions = {
-    org: "${options.orgSlug}",
-    project: "${options.projectSlug}",${
-    options.selfHosted ? `\n    url: "${options.url}",` : ''
-  }
-  };`)}
-
-  ${chalk.greenBright(`const sentryOptions = {
-    // Upload additional client files (increases upload size)
-    widenClientFileUpload: true,
-  };`)}
-
-  ${chalk.greenBright(`module.exports = withSentryConfig(
-    nextConfig,
-    sentryWebpackPluginOptions,
-    sentryOptions
-  );`)}
-`);
-
-export const configureNextJsSourceMapsUpload = async (
-  options: SourceMapUploadToolConfigurationOptions,
-  wizardOptions: WizardOptions,
-) => {
-  clack.log
-    .info(`Source Maps upload for Next.js is configured automatically by default if you run the Sentry Wizard for Next.JS.
-But don't worry, we can redirect you to the wizard now!
-
-In case you already tried the wizard, we can also show you how to configure your ${chalk.cyan(
-    'next.config.js',
-  )} file manually instead.`);
-
-  const shouldRedirect: boolean = await abortIfCancelled(
-    clack.select({
-      message: 'Do you want to run the Sentry Wizard for Next.JS now?',
-      options: [
-        {
-          label: 'Yes, run the wizard!',
-          value: true,
-          hint: 'The wizard can also configure your SDK setup',
-        },
-        {
-          label: 'No, show me how to configure it manually',
-          value: false,
-        },
-      ],
-    }),
-  );
-
-  Sentry.setTag('redirect-nextjs-wizard', shouldRedirect);
-
-  if (shouldRedirect) {
-    await traceStep('run-nextjs-wizard', () => runNextjsWizard(wizardOptions));
-    clack.intro('Sentry Source Maps Upload Configuration Wizard');
-    clack.log.info(
-      "Welcome back to the Source Maps wizard - we're almost done ;)",
-    );
-  } else {
-    clack.log.info(
-      `Add the following code to your ${chalk.cyan('next.config.js')}:`,
-    );
-
-    // Intentionally logging directly to console here
-    // eslint-disable-next-line no-console
-    console.log(getCodeSnippet(options));
-
-    await traceStep('nextjs-manual-nextconfigjs', () =>
-      abortIfCancelled(
-        clack.select({
-          message: 'Did you copy the code above?',
-          options: [{ label: 'Yes, continue!', value: true }],
-          initialValue: true,
-        }),
-      ),
-    );
-
-    await traceStep('nextjs-manual-sentryclirc', () =>
-      addDotEnvSentryBuildPluginFile(options.authToken),
-    );
-  }
-
-  clack.log
-    .info(`In case you still run into problems, check out our docs to further debug your setup:
-
-Uploading Source Maps:
-https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-source-maps
-
-Troubleshooting Source Maps:
-https://docs.sentry.io/platforms/javascript/guides/nextjs/troubleshooting/`);
-};

package/src/sourcemaps/tools/remix.ts

@@ -1,90 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-import chalk from 'chalk';
-import { runRemixWizard } from '../../remix/remix-wizard';
-import { traceStep } from '../../telemetry';
-import { abortIfCancelled } from '../../utils/clack-utils';
-import type { WizardOptions } from '../../utils/types';
-import type { SourceMapUploadToolConfigurationOptions } from './types';
-
-import * as Sentry from '@sentry/node';
-
-export const configureRemixSourceMapsUpload = async (
-  options: SourceMapUploadToolConfigurationOptions,
-  wizardOptions: WizardOptions,
-) => {
-  clack.log
-    .info(`Source Maps upload for Remix is configured automatically by default if you run the Sentry Wizard for Remix.
-But don't worry, we can redirect you to the wizard now!
-In case you already tried the wizard, we can also show you how to configure your ${chalk.cyan(
-    'remix.config.js',
-  )} file manually instead.`);
-
-  const shouldRedirect: boolean = await abortIfCancelled(
-    clack.select({
-      message: 'Do you want to run the Sentry Wizard for Remix now?',
-      options: [
-        {
-          label: 'Yes, run the wizard!',
-          value: true,
-          hint: 'The wizard can also configure your SDK setup',
-        },
-        {
-          label: 'No, show me how to configure it manually',
-          value: false,
-        },
-      ],
-    }),
-  );
-
-  Sentry.setTag('redirect-remix-wizard', shouldRedirect);
-
-  if (shouldRedirect) {
-    await traceStep('run-remix-wizard', () => runRemixWizard(wizardOptions));
-    clack.intro('Sentry Source Maps Upload Configuration Wizard');
-    clack.log.info(
-      "Welcome back to the Source Maps wizard - we're almost done ;)",
-    );
-  } else {
-    clack.log.step(
-      `Build your app with ${chalk.cyan(
-        'remix build --sourcemap',
-      )}, then upload your source maps using ${chalk.cyan(
-        'sentry-upload-sourcemaps',
-      )} cli tool.`,
-    );
-
-    clack.log.step(
-      `You can add ${chalk.cyan(
-        'sentry-upload-sourcemaps',
-      )} to your build script in ${chalk.cyan('package.json')} like this:`,
-    );
-
-    // Intentially logging directly to console here so that the code can be copied/pasted directly
-    // eslint-disable-next-line no-console
-    console.log(codeSnippet);
-
-    clack.log.step(`or run it manually after building your app.
-
-To see all available options for ${chalk.cyan(
-      'sentry-upload-sourcemaps',
-    )}, run ${chalk.cyan('sentry-upload-sourcemaps --help')}
-`);
-
-    await abortIfCancelled(
-      clack.select({
-        message: 'Did you finish configuring your build and prod scripts?',
-        options: [{ label: 'Yes, continue!', value: true }],
-        initialValue: true,
-      }),
-    );
-  }
-};
-
-const codeSnippet = chalk.gray(`
-"scripts": {
-  ${chalk.greenBright(
-    '"build": "remix build --sourcemap && sentry-upload-sourcemaps"',
-  )};
-}
-`);

package/src/sourcemaps/tools/rollup.ts

@@ -1,67 +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(
-  'import { sentryRollupPlugin } from "@sentry/rollup-plugin";',
-)}
-
-export default {
-  output: {
-    ${chalk.greenBright(
-      'sourcemap: true, // Source map generation must be turned on',
-    )}
-  },
-  plugins: [
-    // Put the Sentry rollup plugin after all other plugins
-    ${chalk.greenBright(`sentryRollupPlugin({
-      authToken: process.env.SENTRY_AUTH_TOKEN,
-      org: "${options.orgSlug}",
-      project: "${options.projectSlug}",${
-      options.selfHosted ? `\n      url: "${options.url}",` : ''
-    }
-    }),`)}
-  ],
-};
-`);
-
-export const configureRollupPlugin: SourceMapUploadToolConfigurationFunction =
-  async (options) => {
-    await installPackage({
-      packageName: '@sentry/rollup-plugin',
-      alreadyInstalled: hasPackageInstalled(
-        '@sentry/rollup-plugin',
-        await getPackageDotJson(),
-      ),
-    });
-
-    clack.log.step(`Add the following code to your rollup config:`);
-
-    // Intentionally 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);
-  };

package/src/sourcemaps/tools/sentry-cli.ts

@@ -1,287 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-import chalk from 'chalk';
-import * as Sentry from '@sentry/node';
-import * as path from 'path';
-import * as fs from 'fs';
-import {
-  abortIfCancelled,
-  addSentryCliConfig,
-  getPackageDotJson,
-  installPackage,
-} from '../../utils/clack-utils';
-
-import { SourceMapUploadToolConfigurationOptions } from './types';
-import { hasPackageInstalled } from '../../utils/package-json';
-import { traceStep } from '../../telemetry';
-import { detectPackageManger, NPM } from '../../utils/package-manager';
-
-const SENTRY_NPM_SCRIPT_NAME = 'sentry:sourcemaps';
-
-let addedToBuildCommand = false;
-
-export async function configureSentryCLI(
-  options: SourceMapUploadToolConfigurationOptions,
-  configureSourcemapGenerationFlow: () => Promise<void> = defaultConfigureSourcemapGenerationFlow,
-): Promise<void> {
-  const packageDotJson = await getPackageDotJson();
-
-  await installPackage({
-    packageName: '@sentry/cli',
-    alreadyInstalled: hasPackageInstalled('@sentry/cli', packageDotJson),
-  });
-
-  let validPath = false;
-  let relativeArtifactPath;
-  do {
-    const rawArtifactPath = await abortIfCancelled(
-      clack.text({
-        message: 'Where are your build artifacts located?',
-        placeholder: `.${path.sep}out`,
-        validate(value) {
-          if (!value) {
-            return 'Please enter a path.';
-          }
-        },
-      }),
-    );
-
-    if (path.isAbsolute(rawArtifactPath)) {
-      relativeArtifactPath = path.relative(process.cwd(), rawArtifactPath);
-    } else {
-      relativeArtifactPath = rawArtifactPath;
-    }
-
-    try {
-      await fs.promises.access(path.join(process.cwd(), relativeArtifactPath));
-      validPath = true;
-    } catch {
-      validPath = await abortIfCancelled(
-        clack.select({
-          message: `We couldn't find artifacts at ${relativeArtifactPath}. Are you sure that this is the location that contains your build artifacts?`,
-          options: [
-            {
-              label: 'No, let me verify.',
-              value: false,
-            },
-            { label: 'Yes, I am sure!', value: true },
-          ],
-          initialValue: false,
-        }),
-      );
-    }
-  } while (!validPath);
-
-  const relativePosixArtifactPath = relativeArtifactPath
-    .split(path.sep)
-    .join(path.posix.sep);
-
-  await configureSourcemapGenerationFlow();
-
-  await createAndAddNpmScript(options, relativePosixArtifactPath);
-
-  if (await askShouldAddToBuildCommand()) {
-    await traceStep('sentry-cli-add-to-build-cmd', () =>
-      addSentryCommandToBuildCommand(),
-    );
-  } else {
-    clack.log.info(
-      `No problem, just make sure to run this script ${chalk.bold(
-        'after',
-      )} building your application but ${chalk.bold('before')} deploying!`,
-    );
-  }
-
-  await addSentryCliConfig({ authToken: options.authToken });
-}
-
-export async function setupNpmScriptInCI(): Promise<void> {
-  if (addedToBuildCommand) {
-    // No need to tell users to add it manually to their CI
-    // if the script is already added to the build command
-    return;
-  }
-
-  const addedToCI = await abortIfCancelled(
-    clack.select({
-      message: `Add a step to your CI pipeline that runs the ${chalk.cyan(
-        SENTRY_NPM_SCRIPT_NAME,
-      )} script ${chalk.bold('right after')} building your application.`,
-      options: [
-        { label: 'I did, continue!', value: true },
-        {
-          label: "I'll do it later...",
-          value: false,
-          hint: chalk.yellow(
-            `You need to run ${chalk.cyan(
-              SENTRY_NPM_SCRIPT_NAME,
-            )} after each build for source maps to work properly.`,
-          ),
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  Sentry.setTag('added-ci-script', addedToCI);
-
-  if (!addedToCI) {
-    clack.log.info("Don't forget! :)");
-  }
-}
-
-async function createAndAddNpmScript(
-  options: SourceMapUploadToolConfigurationOptions,
-  relativePosixArtifactPath: string,
-): Promise<void> {
-  const sentryCliNpmScript = `sentry-cli sourcemaps inject --org ${
-    options.orgSlug
-  } --project ${
-    options.projectSlug
-  } ${relativePosixArtifactPath} && sentry-cli${
-    options.selfHosted ? ` --url ${options.url}` : ''
-  } sourcemaps upload --org ${options.orgSlug} --project ${
-    options.projectSlug
-  } ${relativePosixArtifactPath}`;
-
-  const packageDotJson = await getPackageDotJson();
-
-  packageDotJson.scripts = packageDotJson.scripts || {};
-  packageDotJson.scripts[SENTRY_NPM_SCRIPT_NAME] = sentryCliNpmScript;
-
-  await fs.promises.writeFile(
-    path.join(process.cwd(), 'package.json'),
-    JSON.stringify(packageDotJson, null, 2),
-  );
-
-  clack.log.info(
-    `Added a ${chalk.cyan(SENTRY_NPM_SCRIPT_NAME)} script to your ${chalk.cyan(
-      'package.json',
-    )}.`,
-  );
-}
-
-async function askShouldAddToBuildCommand(): Promise<boolean> {
-  const shouldAddToBuildCommand = await abortIfCancelled(
-    clack.select({
-      message: `Do you want to automatically run the ${chalk.cyan(
-        SENTRY_NPM_SCRIPT_NAME,
-      )} script after each production build?`,
-      options: [
-        {
-          label: 'Yes',
-          value: true,
-          hint: 'This will modify your prod build command',
-        },
-        { label: 'No', value: false },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  Sentry.setTag('modify-build-command', shouldAddToBuildCommand);
-
-  return shouldAddToBuildCommand;
-}
-
-/**
- * Add the sentry:sourcemaps command to the prod build command in the package.json
- * - Detect the user's build command
- * - Append the sentry:sourcemaps command to it
- *
- * @param packageDotJson The package.json which will be modified.
- */
-export async function addSentryCommandToBuildCommand(): Promise<void> {
-  const packageDotJson = await getPackageDotJson();
-  // This usually shouldn't happen because earlier we added the
-  // SENTRY_NPM_SCRIPT_NAME script but just to be sure
-  packageDotJson.scripts = packageDotJson.scripts || {};
-
-  const allNpmScripts = Object.keys(packageDotJson.scripts).filter(
-    (s) => s !== SENTRY_NPM_SCRIPT_NAME,
-  );
-
-  const packageManager = detectPackageManger() ?? NPM;
-
-  // Heuristic to pre-select the build command:
-  // Often, 'build' is the prod build command, so we favour it.
-  // If it's not there, commands that include 'build' might be the prod build command.
-  let buildCommand =
-    typeof packageDotJson.scripts.build === 'string'
-      ? 'build'
-      : allNpmScripts.find((s) => s.toLocaleLowerCase().includes('build'));
-
-  const isProdBuildCommand =
-    !!buildCommand &&
-    (await abortIfCancelled(
-      clack.confirm({
-        message: `Is ${chalk.cyan(
-          `${packageManager.runScriptCommand} ${buildCommand}`,
-        )} your production build command?`,
-      }),
-    ));
-
-  if (allNpmScripts.length && (!buildCommand || !isProdBuildCommand)) {
-    buildCommand = await abortIfCancelled(
-      clack.select({
-        message: `Which ${packageManager.name} command in your ${chalk.cyan(
-          'package.json',
-        )} builds your application for production?`,
-        options: allNpmScripts
-          .map((script) => ({
-            label: script,
-            value: script,
-          }))
-          .concat({ label: 'None of the above', value: 'none' }),
-      }),
-    );
-  }
-
-  if (!buildCommand || buildCommand === 'none') {
-    clack.log.warn(
-      `We can only add the ${chalk.cyan(
-        SENTRY_NPM_SCRIPT_NAME,
-      )} script to another \`script\` in your ${chalk.cyan('package.json')}.
-Please add it manually to your prod build command.`,
-    );
-    return;
-  }
-
-  const oldCommand = packageDotJson.scripts[buildCommand];
-  if (!oldCommand) {
-    // very unlikely to happen but nevertheless
-    clack.log.warn(
-      `\`${buildCommand}\` doesn't seem to be part of your package.json scripts`,
-    );
-    return;
-  }
-
-  packageDotJson.scripts[
-    buildCommand
-  ] = `${oldCommand} && ${packageManager.runScriptCommand} ${SENTRY_NPM_SCRIPT_NAME}`;
-
-  await fs.promises.writeFile(
-    path.join(process.cwd(), 'package.json'),
-    JSON.stringify(packageDotJson, null, 2),
-  );
-
-  addedToBuildCommand = true;
-
-  clack.log.info(
-    `Added ${chalk.cyan(SENTRY_NPM_SCRIPT_NAME)} script to your ${chalk.cyan(
-      buildCommand,
-    )} command.`,
-  );
-}
-
-async function defaultConfigureSourcemapGenerationFlow(): Promise<void> {
-  await abortIfCancelled(
-    clack.select({
-      message: `Verify that your build tool is generating source maps. ${chalk.dim(
-        '(Your build output folder should contain .js.map files after a build)',
-      )}`,
-      options: [{ label: 'I checked. Continue!', value: true }],
-      initialValue: true,
-    }),
-  );
-}

package/src/sourcemaps/tools/tsc.ts

@@ -1,144 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-
-import * as recast from 'recast';
-
-import * as Sentry from '@sentry/node';
-
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-import chalk from 'chalk';
-
-import {
-  askForToolConfigPath,
-  createNewConfigFile,
-  makeCodeSnippet,
-  showCopyPasteInstructions,
-} from '../../utils/clack-utils';
-import {
-  findFile,
-  getOrSetObjectProperty,
-  parseJsonC,
-  printJsonC,
-  setOrUpdateObjectProperty,
-} from '../../utils/ast-utils';
-import { debug } from '../../utils/debug';
-
-const b = recast.types.builders;
-
-const getCodeSnippet = (colors: boolean) =>
-  makeCodeSnippet(colors, (unchanged, plus, _) =>
-    unchanged(
-      `{
-  "compilerOptions": {
-    ${plus('"sourceMap": true,')}
-    ${plus('"inlineSources": true,')}
-
-    // Set \`sourceRoot\` to  "/" to strip the build path prefix from
-    // generated source code references. This will improve issue grouping in Sentry.
-    ${plus('"sourceRoot": "/"')}
-  }
-}`,
-    ),
-  );
-
-export async function configureTscSourcemapGenerationFlow(): Promise<void> {
-  const tsConfigPath =
-    findFile(path.join(process.cwd(), 'tsconfig'), ['.json']) ??
-    (await askForToolConfigPath('TypeScript', 'tsconfig.json'));
-
-  let successfullyAdded = false;
-  if (tsConfigPath) {
-    successfullyAdded = await enableSourcemaps(tsConfigPath);
-  } else {
-    successfullyAdded = await createNewConfigFile(
-      path.join(process.cwd(), 'tsconfig.json'),
-      getCodeSnippet(false),
-    );
-    Sentry.setTag('created-new-config', successfullyAdded ? 'success' : 'fail');
-  }
-
-  if (successfullyAdded) {
-    Sentry.setTag('ast-mod', 'success');
-    clack.log.info(
-      `We recommend checking the ${
-        tsConfigPath ? 'modified' : 'added'
-      } file after the wizard finished to ensure it works with your build setup.`,
-    );
-  } else {
-    Sentry.setTag('ast-mod', 'fail');
-    await showCopyPasteInstructions(
-      'tsconfig.json',
-      getCodeSnippet(true),
-      'This ensures that source maps are generated correctly',
-    );
-  }
-}
-
-/**
- * Modifies tsconfig.json (@param tsConfigPath) to enable source maps generation.
- *
- * Exported only for testing
- */
-export async function enableSourcemaps(tsConfigPath: string): Promise<boolean> {
-  try {
-    const tsConfig = await fs.promises.readFile(tsConfigPath, 'utf-8');
-
-    const { ast, jsonObject } = parseJsonC(tsConfig.toString());
-
-    if (!jsonObject || !ast) {
-      // this will only happen if the input file isn't valid JSON-C
-      Sentry.setTag('ast-mod-fail-reason', 'original-file-invalid');
-      return false;
-    }
-
-    const compilerOptionsProp = getOrSetObjectProperty(
-      jsonObject,
-      'compilerOptions',
-      b.objectExpression([]),
-    );
-
-    const compilerOptionsObj = compilerOptionsProp.value;
-
-    if (!compilerOptionsObj || compilerOptionsObj.type !== 'ObjectExpression') {
-      // a valid compilerOptions prop should always be an object expression
-      Sentry.setTag('ast-mod-fail-reason', 'original-file-invalid');
-      return false;
-    }
-
-    setOrUpdateObjectProperty(
-      compilerOptionsObj,
-      'sourceMap',
-      b.booleanLiteral(true),
-    );
-
-    setOrUpdateObjectProperty(
-      compilerOptionsObj,
-      'inlineSources',
-      b.booleanLiteral(true),
-    );
-
-    setOrUpdateObjectProperty(
-      compilerOptionsObj,
-      'sourceRoot',
-      b.stringLiteral('/'),
-      'Set `sourceRoot` to  "/" to strip the build path prefix\nfrom generated source code references.\nThis improves issue grouping in Sentry.',
-    );
-
-    const code = printJsonC(ast);
-
-    await fs.promises.writeFile(tsConfigPath, code);
-
-    clack.log.success(
-      `Enabled source maps generation in ${chalk.cyan(
-        path.basename(tsConfigPath || 'tsconfig.json'),
-      )}.`,
-    );
-
-    return true;
-  } catch (e) {
-    debug(e);
-    Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
-    return false;
-  }
-}