@sentry/wizard 4.0.0 → 4.0.1

package/src/sourcemaps/tools/types.ts

@@ -1,11 +0,0 @@
-export type SourceMapUploadToolConfigurationOptions = {
-  selfHosted: boolean;
-  url: string;
-  authToken: string;
-  orgSlug: string;
-  projectSlug: string;
-};
-
-export type SourceMapUploadToolConfigurationFunction = (
-  options: SourceMapUploadToolConfigurationOptions,
-) => Promise<void>;

package/src/sourcemaps/tools/vite.ts

@@ -1,300 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-// @ts-ignore - magicast is ESM and TS complains about that. It works though
-import { generateCode, parseModule } from 'magicast';
-// @ts-ignore - magicast is ESM and TS complains about that. It works though
-import { addVitePlugin } from 'magicast/helpers';
-
-import type { namedTypes as t } from 'ast-types';
-
-import * as recast from 'recast';
-
-import * as Sentry from '@sentry/node';
-
-import chalk from 'chalk';
-import {
-  abortIfCancelled,
-  addDotEnvSentryBuildPluginFile,
-  askForToolConfigPath,
-  createNewConfigFile,
-  getPackageDotJson,
-  installPackage,
-  makeCodeSnippet,
-  showCopyPasteInstructions,
-} from '../../utils/clack-utils';
-import { hasPackageInstalled } from '../../utils/package-json';
-
-import {
-  SourceMapUploadToolConfigurationFunction,
-  SourceMapUploadToolConfigurationOptions,
-} from './types';
-import { findFile, hasSentryContent } from '../../utils/ast-utils';
-
-import * as path from 'path';
-import * as fs from 'fs';
-import { debug } from '../../utils/debug';
-
-const getViteConfigSnippet = (
-  options: SourceMapUploadToolConfigurationOptions,
-  colors: boolean,
-) =>
-  makeCodeSnippet(colors, (unchanged, plus, _) =>
-    unchanged(`import { defineConfig } from "vite";
-${plus('import { sentryVitePlugin } from "@sentry/vite-plugin";')}
-
-export default defineConfig({
-  build: {
-    ${plus('sourcemap: true, // Source map generation must be turned on')}
-  },
-  plugins: [
-    // Put the Sentry vite plugin after all other plugins
-    ${plus(`sentryVitePlugin({
-      authToken: process.env.SENTRY_AUTH_TOKEN,
-      org: "${options.orgSlug}",
-      project: "${options.projectSlug}",${
-      options.selfHosted ? `\n      url: "${options.url}",` : ''
-    }
-    }),`)}
-  ],
-});`),
-  );
-
-export const configureVitePlugin: SourceMapUploadToolConfigurationFunction =
-  async (options) => {
-    await installPackage({
-      packageName: '@sentry/vite-plugin',
-      alreadyInstalled: hasPackageInstalled(
-        '@sentry/vite-plugin',
-        await getPackageDotJson(),
-      ),
-    });
-
-    const viteConfigPath =
-      findFile(path.resolve(process.cwd(), 'vite.config')) ??
-      (await askForToolConfigPath('Vite', 'vite.config.js'));
-
-    let successfullyAdded = false;
-    if (viteConfigPath) {
-      successfullyAdded = await addVitePluginToConfig(viteConfigPath, options);
-    } else {
-      successfullyAdded = await createNewConfigFile(
-        path.join(process.cwd(), 'vite.config.js'),
-        getViteConfigSnippet(options, false),
-        'More information about vite configs: https://vitejs.dev/config/',
-      );
-      Sentry.setTag(
-        'created-new-config',
-        successfullyAdded ? 'success' : 'fail',
-      );
-    }
-
-    if (successfullyAdded) {
-      clack.log.info(
-        `We recommend checking the ${
-          viteConfigPath ? 'modified' : 'added'
-        } file after the wizard finished to ensure it works with your build setup.`,
-      );
-
-      Sentry.setTag('ast-mod', 'success');
-    } else {
-      Sentry.setTag('ast-mod', 'fail');
-      await showCopyPasteInstructions(
-        path.basename(viteConfigPath || 'vite.config.js'),
-        getViteConfigSnippet(options, true),
-      );
-    }
-
-    await addDotEnvSentryBuildPluginFile(options.authToken);
-  };
-
-export async function addVitePluginToConfig(
-  viteConfigPath: string,
-  options: SourceMapUploadToolConfigurationOptions,
-): Promise<boolean> {
-  try {
-    const prettyViteConfigFilename = chalk.cyan(path.basename(viteConfigPath));
-
-    const viteConfigContent = (
-      await fs.promises.readFile(viteConfigPath)
-    ).toString();
-
-    const mod = parseModule(viteConfigContent);
-
-    if (hasSentryContent(mod.$ast as t.Program)) {
-      const shouldContinue = await abortIfCancelled(
-        clack.select({
-          message: `${prettyViteConfigFilename} already contains Sentry-related code. Should the wizard modify it anyway?`,
-          options: [
-            {
-              label: 'Yes, add the Sentry Vite plugin',
-              value: true,
-            },
-            {
-              label: 'No, show me instructions to manually add the plugin',
-              value: false,
-            },
-          ],
-          initialValue: true,
-        }),
-      );
-
-      if (!shouldContinue) {
-        Sentry.setTag('ast-mod-fail-reason', 'has-sentry-content');
-        return false;
-      }
-    }
-
-    const enabledSourcemaps = enableSourcemapGeneration(mod.$ast as t.Program);
-    if (!enabledSourcemaps) {
-      Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
-      return false;
-    }
-
-    const { orgSlug: org, projectSlug: project, selfHosted, url } = options;
-
-    addVitePlugin(mod, {
-      imported: 'sentryVitePlugin',
-      from: '@sentry/vite-plugin',
-      constructor: 'sentryVitePlugin',
-      options: {
-        org,
-        project,
-        ...(selfHosted && { url }),
-      },
-    });
-
-    const code = generateCode(mod.$ast).code;
-
-    await fs.promises.writeFile(viteConfigPath, code);
-
-    clack.log.success(
-      `Added the Sentry Vite plugin to ${prettyViteConfigFilename} and enabled source maps`,
-    );
-
-    return true;
-  } catch (e) {
-    debug(e);
-    Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
-    return false;
-  }
-}
-
-function enableSourcemapGeneration(program: t.Program): boolean {
-  const configObj = getViteConfigObject(program);
-
-  if (!configObj) {
-    return false;
-  }
-
-  const b = recast.types.builders;
-
-  const buildProp = configObj.properties.find(
-    (p: t.ObjectProperty) =>
-      p.key.type === 'Identifier' && p.key.name === 'build',
-  );
-
-  // case 1: build property doesn't exist yet, so we can just add it
-  if (!buildProp) {
-    configObj.properties.push(
-      b.objectProperty(
-        b.identifier('build'),
-        b.objectExpression([
-          b.objectProperty(b.identifier('sourcemap'), b.booleanLiteral(true)),
-        ]),
-      ),
-    );
-    return true;
-  }
-
-  const isValidBuildProp =
-    buildProp.type === 'ObjectProperty' &&
-    buildProp.value.type === 'ObjectExpression';
-
-  if (!isValidBuildProp) {
-    return false;
-  }
-
-  const sourceMapsProp =
-    buildProp.value.type === 'ObjectExpression' &&
-    buildProp.value.properties.find(
-      (p: t.ObjectProperty) =>
-        p.key.type === 'Identifier' && p.key.name === 'sourcemap',
-    );
-
-  // case 2: build.sourcemap property doesn't exist yet, so we just add it
-  if (!sourceMapsProp && buildProp.value.type === 'ObjectExpression') {
-    buildProp.value.properties.push(
-      b.objectProperty(b.identifier('sourcemap'), b.booleanLiteral(true)),
-    );
-    return true;
-  }
-
-  if (!sourceMapsProp || sourceMapsProp.type !== 'ObjectProperty') {
-    return false;
-  }
-
-  // case 3: build.sourcemap property exists, and it's set to 'hidden'
-  if (
-    sourceMapsProp.value.type === 'StringLiteral' &&
-    sourceMapsProp.value.value === 'hidden'
-  ) {
-    // nothing to do for us
-    return true;
-  }
-
-  // case 4: build.sourcemap property exists, but it's not enabled, so we set it to true
-  //         or it is already true in which case this is a noop
-  sourceMapsProp.value = b.booleanLiteral(true);
-  return true;
-}
-
-function getViteConfigObject(
-  program: t.Program,
-): t.ObjectExpression | undefined {
-  const defaultExport = program.body.find(
-    (s) => s.type === 'ExportDefaultDeclaration',
-  ) as t.ExportDefaultDeclaration;
-
-  if (!defaultExport) {
-    return undefined;
-  }
-
-  if (defaultExport.declaration.type === 'ObjectExpression') {
-    return defaultExport.declaration;
-  }
-
-  if (
-    defaultExport.declaration.type === 'CallExpression' &&
-    defaultExport.declaration.arguments[0].type === 'ObjectExpression'
-  ) {
-    return defaultExport.declaration.arguments[0];
-  }
-
-  if (defaultExport.declaration.type === 'Identifier') {
-    const configId = defaultExport.declaration.name;
-    return findConfigNode(configId, program);
-  }
-
-  return undefined;
-}
-
-function findConfigNode(
-  configId: string,
-  program: t.Program,
-): t.ObjectExpression | undefined {
-  for (const node of program.body) {
-    if (node.type === 'VariableDeclaration') {
-      for (const declaration of node.declarations) {
-        if (
-          declaration.type === 'VariableDeclarator' &&
-          declaration.id.type === 'Identifier' &&
-          declaration.id.name === configId &&
-          declaration.init?.type === 'ObjectExpression'
-        ) {
-          return declaration.init;
-        }
-      }
-    }
-  }
-  return undefined;
-}

package/src/sourcemaps/tools/webpack.ts

@@ -1,383 +0,0 @@
-import * as path from 'node:path';
-import * as fs from 'node:fs';
-
-// @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 recast from 'recast';
-import x = recast.types;
-import t = x.namedTypes;
-
-import * as Sentry from '@sentry/node';
-
-import {
-  abortIfCancelled,
-  addDotEnvSentryBuildPluginFile,
-  askForToolConfigPath,
-  createNewConfigFile,
-  getPackageDotJson,
-  installPackage,
-  makeCodeSnippet,
-  showCopyPasteInstructions,
-} from '../../utils/clack-utils';
-import { hasPackageInstalled } from '../../utils/package-json';
-
-import type {
-  SourceMapUploadToolConfigurationFunction,
-  SourceMapUploadToolConfigurationOptions,
-} from './types';
-
-import { findFile, hasSentryContent } from '../../utils/ast-utils';
-import { debug } from '../../utils/debug';
-
-const getCodeSnippet = (
-  options: SourceMapUploadToolConfigurationOptions,
-  colors: boolean,
-) =>
-  makeCodeSnippet(colors, (unchanged, plus) =>
-    unchanged(`${plus(
-      'const { sentryWebpackPlugin } = require("@sentry/webpack-plugin");',
-    )}
-
-module.exports = {
-  // ... other options
-  ${plus('devtool: "source-map", // Source map generation must be turned on')}
-  plugins: [
-    // Put the Sentry Webpack plugin after all other plugins
-    ${plus(`sentryWebpackPlugin({
-      authToken: process.env.SENTRY_AUTH_TOKEN,
-      org: "${options.orgSlug}",
-      project: "${options.projectSlug}",${
-      options.selfHosted ? `\n      url: "${options.url}",` : ''
-    }
-    }),`)}
-  ],
-}`),
-  );
-
-export const configureWebPackPlugin: SourceMapUploadToolConfigurationFunction =
-  async (options) => {
-    await installPackage({
-      packageName: '@sentry/webpack-plugin',
-      alreadyInstalled: hasPackageInstalled(
-        '@sentry/webpack-plugin',
-        await getPackageDotJson(),
-      ),
-    });
-
-    const webpackConfigPath =
-      findFile(path.resolve(process.cwd(), 'webpack.config')) ??
-      (await askForToolConfigPath('Webpack', 'webpack.config.js'));
-
-    let successfullyAdded = false;
-    if (webpackConfigPath) {
-      successfullyAdded = await modifyWebpackConfig(webpackConfigPath, options);
-    } else {
-      successfullyAdded = await createNewConfigFile(
-        path.join(process.cwd(), 'webpack.config.js'),
-        getCodeSnippet(options, false),
-        'More information about Webpack configs: https://vitejs.dev/config/',
-      );
-      Sentry.setTag(
-        'created-new-config',
-        successfullyAdded ? 'success' : 'fail',
-      );
-    }
-
-    if (successfullyAdded) {
-      clack.log.info(
-        `We recommend checking the ${
-          webpackConfigPath ? 'modified' : 'added'
-        } file after the wizard finished to ensure it works with your build setup.`,
-      );
-
-      Sentry.setTag('ast-mod', 'success');
-    } else {
-      Sentry.setTag('ast-mod', 'fail');
-      await showCopyPasteInstructions(
-        path.basename(webpackConfigPath || 'webpack.config.js'),
-        getCodeSnippet(options, true),
-      );
-    }
-
-    await addDotEnvSentryBuildPluginFile(options.authToken);
-  };
-
-/**
- * Modifies a webpack config file to enable source map generation and add the Sentry webpack plugin
- * exported only for testing
- */
-export async function modifyWebpackConfig(
-  webpackConfigPath: string,
-  options: SourceMapUploadToolConfigurationOptions,
-): Promise<boolean> {
-  try {
-    const webpackConfig = await fs.promises.readFile(webpackConfigPath, {
-      encoding: 'utf-8',
-    });
-
-    const prettyConfigFilename = chalk.cyan(path.basename(webpackConfigPath));
-
-    // no idea why recast returns any here, this is dumb :/
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const program = recast.parse(webpackConfig.toString()).program as t.Program;
-
-    if (!(await shouldModifyWebpackConfig(program, prettyConfigFilename))) {
-      // Sentry tag is set in shouldModifyWebpackConfig
-      return false;
-    }
-
-    const exportStmt = getCjsModuleExports(program);
-    if (!exportStmt) {
-      // We only care about CJS at the moment since it's probably the most widely used format for webpack configs.
-      debug(`Could not find module.exports = {...} in ${webpackConfigPath}.`);
-      Sentry.setTag('ast-mod-fail-reason', 'config-object-not-found');
-      return false;
-    }
-
-    const configObject = getWebpackConfigObject(exportStmt, program);
-
-    if (!configObject) {
-      debug(`Couldn't find config object in ${webpackConfigPath}`);
-      Sentry.setTag('ast-mod-fail-reason', 'config-object-not-found');
-      return false;
-    }
-
-    const enabledSourcemaps = enableSourcemapsGeneration(configObject);
-
-    if (enabledSourcemaps) {
-      clack.log.success(
-        `Enabled source map generation in ${prettyConfigFilename}.`,
-      );
-    } else {
-      clack.log.warn(
-        `Couldn't enable source maps generation in ${prettyConfigFilename} Please follow the instructions below.`,
-      );
-      Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
-      return false;
-    }
-
-    const addedPlugin = addSentryWebpackPlugin(program, configObject, options);
-    if (addedPlugin) {
-      clack.log.success(
-        `Added Sentry webpack plugin to ${prettyConfigFilename}.`,
-      );
-    } else {
-      clack.log.warn(
-        `Couldn't add Sentry webpack plugin to ${prettyConfigFilename}. Please follow the instructions below.`,
-      );
-      Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
-      return false;
-    }
-
-    const code = recast.print(program).code;
-    await fs.promises.writeFile(webpackConfigPath, code);
-
-    return true;
-  } catch (e) {
-    Sentry.setTag('ast-mod-fail-reason', 'insertion-fail');
-    debug(e);
-    return false;
-  }
-}
-
-async function shouldModifyWebpackConfig(
-  program: t.Program,
-  prettyConfigFilename: string,
-) {
-  if (hasSentryContent(program)) {
-    const shouldContinue = await abortIfCancelled(
-      clack.select({
-        message: `Seems like ${prettyConfigFilename} already contains Sentry-related code. Should the wizard modify it anyway?`,
-        options: [
-          {
-            label: 'Yes, add the Sentry Webpack plugin',
-            value: true,
-          },
-          {
-            label: 'No, show me instructions to manually add the plugin',
-            value: false,
-          },
-        ],
-        initialValue: true,
-      }),
-    );
-
-    if (!shouldContinue) {
-      Sentry.setTag('ast-mod-fail-reason', 'has-sentry-content');
-      return false;
-    }
-  }
-
-  return true;
-}
-
-function addSentryWebpackPlugin(
-  program: t.Program,
-  configObj: t.ObjectExpression,
-  options: SourceMapUploadToolConfigurationOptions,
-) {
-  const b = addSentryWebpackPluginImport(program);
-
-  const sentryPluginCall = b.callExpression(
-    b.identifier('sentryWebpackPlugin'),
-    [
-      b.objectExpression([
-        b.objectProperty(
-          b.identifier('authToken'),
-          b.identifier('process.env.SENTRY_AUTH_TOKEN'),
-        ),
-        b.objectProperty(b.identifier('org'), b.stringLiteral(options.orgSlug)),
-        b.objectProperty(
-          b.identifier('project'),
-          b.stringLiteral(options.projectSlug),
-        ),
-        ...(options.selfHosted
-          ? [
-              b.objectProperty(
-                b.identifier('url'),
-                b.stringLiteral(options.url),
-              ),
-            ]
-          : []),
-      ]),
-    ],
-  );
-
-  const pluginsProp = configObj.properties.find(
-    (p): p is t.Property =>
-      p.type === 'Property' &&
-      p.key.type === 'Identifier' &&
-      p.key.name === 'plugins',
-  );
-
-  if (pluginsProp) {
-    if (pluginsProp.value.type === 'ArrayExpression') {
-      pluginsProp.value.elements.push(sentryPluginCall);
-    } else {
-      pluginsProp.value = b.arrayExpression([sentryPluginCall]);
-    }
-    return true;
-  }
-
-  configObj.properties.push(
-    b.objectProperty(
-      b.identifier('plugins'),
-      b.arrayExpression([sentryPluginCall]),
-    ),
-  );
-
-  return true;
-}
-
-function addSentryWebpackPluginImport(program: t.Program) {
-  const b = recast.types.builders;
-
-  const sentryPluginRequireStmt = b.variableDeclaration('const', [
-    b.variableDeclarator(
-      b.objectPattern([
-        b.objectProperty.from({
-          key: b.identifier('sentryWebpackPlugin'),
-          value: b.identifier('sentryWebpackPlugin'),
-          shorthand: true,
-        }),
-      ]),
-      b.callExpression(b.identifier('require'), [
-        b.stringLiteral('@sentry/webpack-plugin'),
-      ]),
-    ),
-  ]);
-
-  program.body.unshift(sentryPluginRequireStmt);
-  return b;
-}
-
-function enableSourcemapsGeneration(configObj: t.ObjectExpression): boolean {
-  const b = recast.types.builders;
-
-  const devtoolProp = configObj.properties.find(
-    (p): p is t.Property =>
-      p.type === 'Property' &&
-      p.key.type === 'Identifier' &&
-      p.key.name === 'devtool',
-  );
-
-  if (devtoolProp) {
-    // devtool can have quite a lot of source maps values.
-    // see: https://webpack.js.org/configuration/devtool/#devtool
-    // For Sentry to work best, we should set it to "source-map" or "hidden-source-map"
-    // Heuristic:
-    // - all values that contain "hidden" will be set to "hidden-source-map"
-    // - all other values will be set to "source-map"
-    if (
-      (devtoolProp.value.type === 'Literal' ||
-        devtoolProp.value.type === 'StringLiteral') &&
-      devtoolProp.value.value?.toString().startsWith('hidden-')
-    ) {
-      devtoolProp.value = b.stringLiteral('hidden-source-map');
-    } else {
-      devtoolProp.value = b.stringLiteral('source-map');
-    }
-    return true;
-  }
-
-  configObj.properties.push(
-    b.objectProperty(b.identifier('devtool'), b.stringLiteral('source-map')),
-  );
-
-  return true;
-}
-
-function getWebpackConfigObject(
-  moduleExports: t.AssignmentExpression,
-  program: t.Program,
-): t.ObjectExpression | undefined {
-  const rhs = moduleExports.right;
-  if (rhs.type === 'ObjectExpression') {
-    return rhs;
-  }
-  if (rhs.type === 'Identifier') {
-    const configId = rhs.name;
-
-    const configDeclaration = program.body.find(
-      (s): s is t.VariableDeclaration =>
-        s.type === 'VariableDeclaration' &&
-        !!s.declarations.find(
-          (d) =>
-            d.type === 'VariableDeclarator' &&
-            d.id.type === 'Identifier' &&
-            d.id.name === configId,
-        ),
-    );
-
-    const declarator = configDeclaration?.declarations.find(
-      (d): d is t.VariableDeclarator =>
-        d.type === 'VariableDeclarator' &&
-        d.id.type === 'Identifier' &&
-        d.id.name === configId,
-    );
-
-    return declarator?.init?.type === 'ObjectExpression'
-      ? declarator.init
-      : undefined;
-  }
-
-  return undefined;
-}
-
-function getCjsModuleExports(
-  program: t.Program,
-): t.AssignmentExpression | undefined {
-  const moduleExports = program.body.find(
-    (s): s is t.ExpressionStatement =>
-      s.type === 'ExpressionStatement' &&
-      s.expression.type === 'AssignmentExpression' &&
-      s.expression.left.type === 'MemberExpression' &&
-      s.expression.left.object.type === 'Identifier' &&
-      s.expression.left.object.name === 'module' &&
-      s.expression.left.property.type === 'Identifier' &&
-      s.expression.left.property.name === 'exports',
-  );
-  return moduleExports?.expression as t.AssignmentExpression;
-}