@sentry/wizard 4.0.0 → 4.0.1

package/src/sourcemaps/utils/detect-tool.ts

@@ -1,46 +0,0 @@
-import { getPackageDotJson } from '../../utils/clack-utils';
-import { findInstalledPackageFromList } from '../../utils/package-json';
-
-export type SupportedTools =
-  | 'webpack'
-  | 'vite'
-  | 'rollup'
-  | 'esbuild'
-  | 'tsc'
-  | 'sentry-cli'
-  | 'create-react-app'
-  | 'angular'
-  | 'nextjs'
-  | 'remix'
-  | 'no-tool';
-
-// A map of package names pointing to the tool slug.
-// The order is important, because we want to detect the most specific tool first.
-// For instance, webpack needs to come before tsc because typescript c
-// Similarly
-export const TOOL_PACKAGE_MAP: Record<string, SupportedTools> = {
-  '@angular/core': 'angular',
-  'create-react-app': 'create-react-app',
-  next: 'nextjs',
-  webpack: 'webpack',
-  vite: 'vite',
-  esbuild: 'esbuild',
-  rollup: 'rollup',
-  typescript: 'tsc',
-  remix: 'remix',
-};
-
-export async function detectUsedTool(): Promise<SupportedTools> {
-  const packageJson = await getPackageDotJson();
-
-  const foundToolPackage = findInstalledPackageFromList(
-    Object.keys(TOOL_PACKAGE_MAP),
-    packageJson,
-  );
-
-  if (foundToolPackage) {
-    return TOOL_PACKAGE_MAP[foundToolPackage.name];
-  }
-
-  return 'sentry-cli';
-}

package/src/sourcemaps/utils/other-wizards.ts

@@ -1,167 +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 { runSvelteKitWizard } from '../../sveltekit/sveltekit-wizard';
-
-import {
-  abort,
-  abortIfCancelled,
-  getPackageDotJson,
-} from '../../utils/clack-utils';
-import {
-  findInstalledPackageFromList,
-  hasPackageInstalled,
-} from '../../utils/package-json';
-
-import * as Sentry from '@sentry/node';
-import { WizardOptions } from '../../utils/types';
-
-import * as childProcess from 'child_process';
-
-type WizardFunction = (options: WizardOptions) => Promise<void>;
-
-type FrameworkInfo = {
-  frameworkName: string;
-  frameworkPackage: string;
-  troubleshootingDocsLink: string;
-  sourcemapsDocsLink: string;
-  wizard: WizardFunction;
-};
-
-const sdkMap: Record<string, FrameworkInfo> = {
-  '@sentry/sveltekit': {
-    frameworkName: 'SvelteKit',
-    frameworkPackage: '@sveltejs/kit',
-    sourcemapsDocsLink:
-      'https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/#configure-source-maps-upload',
-    troubleshootingDocsLink:
-      'https://docs.sentry.io/platforms/javascript/guides/sveltekit/sourcemaps/troubleshooting_js/',
-    wizard: runSvelteKitWizard,
-  },
-  '@sentry/react-native': {
-    frameworkName: 'React Native',
-    frameworkPackage: 'react-native',
-    sourcemapsDocsLink:
-      'https://docs.sentry.io/platforms/react-native/sourcemaps/',
-    troubleshootingDocsLink:
-      'https://docs.sentry.io/platforms/react-native/troubleshooting/#source-maps',
-    wizard: runReactNativeWizard,
-  },
-};
-
-export async function checkIfMoreSuitableWizardExistsAndAskForRedirect(): Promise<
-  WizardFunction | undefined
-> {
-  const sdkName = await checkIfMoreSuitableWizardExists();
-
-  if (!sdkName) {
-    return undefined;
-  }
-
-  return await askForRedirect(sdkName);
-}
-
-async function checkIfMoreSuitableWizardExists(): Promise<string | undefined> {
-  Sentry.setTag('using-wrong-wizard', false);
-
-  const packageJson = await getPackageDotJson();
-
-  const installedSdkPackage = findInstalledPackageFromList(
-    Object.keys(sdkMap),
-    packageJson,
-  );
-
-  if (!installedSdkPackage) {
-    return undefined;
-  }
-
-  const sdkPackageName = installedSdkPackage.name;
-
-  const { frameworkPackage } = sdkMap[sdkPackageName];
-
-  if (!hasPackageInstalled(frameworkPackage, packageJson)) {
-    // The user has installed the SDK but not the framework.
-    // Maybe it's a false positive and the user is using a different framework.
-    // Let's not redirect them to the framework wizard in that case.
-    return undefined;
-  }
-
-  Sentry.setTag('using-wrong-wizard', true);
-
-  return sdkPackageName;
-}
-
-async function askForRedirect(
-  sdkName: string,
-): Promise<WizardFunction | undefined> {
-  const { frameworkName, sourcemapsDocsLink, troubleshootingDocsLink, wizard } =
-    sdkMap[sdkName];
-
-  clack.log.warn(
-    `${chalk.yellow(
-      `It seems like you're using this wizard in a ${frameworkName} project.`,
-    )}
-
-We recommend using our dedicated ${frameworkName} wizard instead of this wizard.
-The ${frameworkName} wizard will set up our ${sdkName} SDK and also configure uploading source maps for you.
-
-If you already tried the ${frameworkName} wizard and it didn't work for you, check out the following guides:
-
-Manual source maps configuration for ${frameworkName}:
-${sourcemapsDocsLink}
-
-Troubleshooting Source Maps:
-${troubleshootingDocsLink}
-`,
-  );
-
-  const nextStep: 'redirect' | 'continue' | 'stop' = await abortIfCancelled(
-    clack.select({
-      message: `Do you want to run the ${frameworkName} wizard now?`,
-      options: [
-        {
-          label: 'Yes',
-          value: 'redirect',
-          hint: `${chalk.green('Recommended')}`,
-        },
-        {
-          label: 'No, continue with this wizard',
-          value: 'continue',
-        },
-        {
-          label: "No, I'll check out the guides ",
-          value: 'stop',
-          hint: 'Exit this wizard',
-        },
-      ],
-    }),
-  );
-
-  Sentry.setTag('wrong-wizard-decision', nextStep);
-
-  switch (nextStep) {
-    case 'redirect':
-      return wizard;
-    case 'stop':
-      await abort('Exiting Wizard', 0);
-      break;
-    default:
-      return undefined;
-  }
-}
-
-function runReactNativeWizard(): Promise<void> {
-  const [runner, ...wizardArgs] = [...process.argv];
-  wizardArgs.push('--integration', 'reactNative');
-
-  try {
-    childProcess.spawnSync(runner, wizardArgs, {
-      cwd: process.cwd(),
-      stdio: 'inherit',
-    });
-  } catch {
-    return Promise.reject();
-  }
-
-  return Promise.resolve();
-}

package/src/sourcemaps/utils/sdk-version.ts

@@ -1,266 +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 { minVersion, satisfies } from 'semver';
-import {
-  abortIfCancelled,
-  getPackageDotJson,
-  installPackage,
-} from '../../utils/clack-utils';
-
-import * as Sentry from '@sentry/node';
-import { findInstalledPackageFromList } from '../../utils/package-json';
-
-const MINIMUM_DEBUG_ID_SDK_VERSION = '7.47.0';
-
-// This array is orderd by the SDKs we want to check for first.
-// The reason is that some SDKs depend on others and some users might
-// have added the dependencies to their package.json. We want to make sure
-// that we actually detect the "top-level" SDK first.
-const SENTRY_SDK_PACKAGE_NAMES = [
-  // SDKs using other framework SDKs need to be checked first
-  '@sentry/astro',
-  '@sentry/gatsby',
-  '@sentry/nextjs',
-  '@sentry/nuxt',
-  '@sentry/remix',
-  '@sentry/solidstart',
-  '@sentry/sveltekit',
-
-  // Framework SDKs
-  '@sentry/angular',
-  '@sentry/angular-ivy',
-  '@sentry/aws-serverless',
-  '@sentry/bun',
-  '@sentry/ember',
-  '@sentry/google-cloud-serverless',
-  '@sentry/nestjs',
-  '@sentry/react',
-  '@sentry/solid',
-  '@sentry/svelte',
-  '@sentry/vue',
-  '@sentry/serverless',
-
-  // Base SDKs
-  '@sentry/browser',
-  '@sentry/node',
-  '@sentry/deno',
-];
-
-/**
- * Check for a minimum SDK version and prompt the user to upgrade if necessary.
- * We distinguish between 4 cases here:
- *
- * 1. Users didn't install any SDK yet
- *    -> We tell them to install an SDK and then continue with the wizard
- * 2. Users installed an SDK in the range >=7.47.0
- *    -> All good, no need to do anything!
- * 3. Users installed an SDK in the range >=7.0.0 <= 7.46.0
- *    -> We ask if they want to auto-update to the latest version
- * 4. Users installed an SDK in the range <7.x
- *    -> We tell users to manually upgrade (migrate between majors)
- */
-export async function ensureMinimumSdkVersionIsInstalled(): Promise<void> {
-  const installedSdkPackage = findInstalledPackageFromList(
-    SENTRY_SDK_PACKAGE_NAMES,
-    await getPackageDotJson(),
-  );
-
-  // Case 1:
-  if (!installedSdkPackage) {
-    return await handleNoSdkInstalled();
-  }
-
-  const { name: installedSdkName, version: installedSdkVersionOrRange } =
-    installedSdkPackage;
-
-  Sentry.setTag('installed-sdk', installedSdkName);
-
-  const minInstalledVersion = getMinInstalledVersion(
-    installedSdkVersionOrRange,
-    installedSdkName,
-  );
-
-  if (!minInstalledVersion) {
-    // This is handled in the getMinInstalledVersion function
-    return;
-  }
-
-  const hasDebugIdCompatibleSdkVersion = satisfies(
-    minInstalledVersion,
-    `>=${MINIMUM_DEBUG_ID_SDK_VERSION}`,
-  );
-
-  // Case 2:
-  if (hasDebugIdCompatibleSdkVersion) {
-    Sentry.setTag('initial-sdk-version', '>=7.47.0');
-    return;
-  }
-
-  const hasV7SdkVersion = satisfies(minInstalledVersion, '>=7.0.0');
-
-  clack.log.warn(
-    `${chalk.yellowBright(
-      `It seems like you're using an outdated version (${installedSdkVersionOrRange}) of the ${chalk.bold(
-        installedSdkName,
-      )} SDK.`,
-    )}
-Uploading source maps is easiest with an SDK from version ${chalk.bold(
-      MINIMUM_DEBUG_ID_SDK_VERSION,
-    )} or newer.    
-`,
-  );
-
-  // Case 3:
-  if (hasV7SdkVersion) {
-    await handleAutoUpdateSdk(installedSdkName);
-    return;
-  }
-
-  // Case 4:
-  await handleManuallyUpdateSdk(minInstalledVersion);
-}
-
-async function handleManuallyUpdateSdk(minInstalledVersion: string) {
-  Sentry.setTag(
-    'initial-sdk-version',
-    `${satisfies(minInstalledVersion, '>=6.0.0') ? '6.x' : '<6.0.0'}`,
-  );
-
-  clack.log
-    .info(`When upgrading from a version older than 7.0.0, make sure to follow the migration guide:
-https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#upgrading-from-6x-to-7x
-`);
-
-  const didUpdate = await abortIfCancelled(
-    clack.select({
-      message: 'Did you update your SDK to the latest version?',
-      options: [
-        {
-          label: 'Yes!',
-          value: true,
-        },
-        {
-          label: "No, I'll do it later...",
-          value: false,
-          hint: chalk.yellow(
-            `Remember to update your SDK to at least ${MINIMUM_DEBUG_ID_SDK_VERSION}.`,
-          ),
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  Sentry.setTag(
-    'resolved-sdk-status',
-    didUpdate ? 'updated-manually' : 'update-later',
-  );
-}
-
-async function handleAutoUpdateSdk(packageName: string) {
-  Sentry.setTag('initial-sdk-version', '>=7.0.0 <7.47.0');
-
-  const shouldUpdate = await abortIfCancelled(
-    clack.select({
-      message:
-        'Do you want to automatically update your SDK to the latest version?',
-      options: [
-        {
-          label: 'Yes!',
-          value: true,
-          hint: chalk.green('Recommended'),
-        },
-        {
-          label: "No, I'll do it later...",
-          value: false,
-          hint: chalk.yellow(
-            `Remember to update your SDK to at least ${MINIMUM_DEBUG_ID_SDK_VERSION}.`,
-          ),
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  if (shouldUpdate) {
-    await installPackage({
-      packageName,
-      alreadyInstalled: true,
-      askBeforeUpdating: false, // we already did this above
-    });
-  }
-
-  Sentry.setTag(
-    'resolved-sdk-status',
-    shouldUpdate ? 'updated-automatically' : 'update-later',
-  );
-}
-
-async function handleNoSdkInstalled(): Promise<void> {
-  Sentry.setTag('initial-sdk-version', 'none');
-  Sentry.setTag('installed-sdk', 'none');
-
-  clack.log.warn(
-    `${chalk.yellowBright(
-      `It seems like you didn't yet install a Sentry SDK in your project.`,
-    )}
-We recommend setting up the SDK before continuing with the source maps wizard.
-
-${chalk.dim(`Take a look at our docs to get started:
-https://docs.sentry.io/`)}`,
-  );
-
-  const installedSDK = await abortIfCancelled(
-    clack.select({
-      message: 'Did you set up your Sentry SDK?',
-      options: [
-        { label: 'Yes, continue!', value: true },
-        {
-          label: "I'll do it later...",
-          value: false,
-          hint: chalk.yellow(
-            'You need to set up an SDK before you can use Sentry',
-          ),
-        },
-      ],
-      initialValue: true,
-    }),
-  );
-
-  Sentry.setTag(
-    'resolved-sdk-status',
-    installedSDK ? 'installed-manually' : 'install-later',
-  );
-}
-
-function getMinInstalledVersion(
-  installedSdkVersionOrRange: string,
-  installedSdkName: string,
-): string | undefined {
-  try {
-    // If `minVersion` is unable to parse the version it will throw an error
-    // However, it will also return `null` if the parameter is undefined, which
-    // we explicitly checked before but the typing doesn't know that.
-    const minInstalledVersion = minVersion(installedSdkVersionOrRange)?.version;
-    if (minInstalledVersion) {
-      return minInstalledVersion;
-    }
-  } catch {
-    // handling this, along with the `null` case below
-  }
-
-  Sentry.setTag('initial-sdk-version', 'unknown');
-  clack.log.warn(
-    `${chalk.yellow(
-      `Could not parse the version of your installed SDK ("${installedSdkName}": "${installedSdkVersionOrRange}")`,
-    )}
-
-Please make sure that your Sentry SDK is updated to version ${chalk.bold(
-      MINIMUM_DEBUG_ID_SDK_VERSION,
-    )} or newer.
-    `,
-  );
-
-  return undefined;
-}

package/src/sveltekit/sdk-example.ts

@@ -1,56 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-
-import { PartialSvelteConfig } from './sdk-setup';
-import {
-  getSentryExampleApiRoute,
-  getSentryExampleSveltePage,
-} from './templates';
-
-/**
- * Creates example page and API route to test Sentry
- */
-export async function createExamplePage(
-  svelteConfig: PartialSvelteConfig,
-  projectProps: {
-    selfHosted: boolean;
-    url: string;
-    orgSlug: string;
-    projectId: string;
-  },
-): Promise<void> {
-  const routesDirectory = svelteConfig.kit?.files?.routes || 'src/routes';
-  const exampleRoutePath = path.resolve(
-    path.join(routesDirectory, 'sentry-example'),
-  );
-
-  if (!fs.existsSync(routesDirectory)) {
-    clack.log.warn(
-      `Couldn't find your routes directory. Creating it now: ${routesDirectory}`,
-    );
-    fs.mkdirSync(routesDirectory, { recursive: true });
-  }
-
-  if (!fs.existsSync(exampleRoutePath)) {
-    fs.mkdirSync(exampleRoutePath);
-  } else {
-    clack.log.warn(
-      `It seems like a sentry example page already exists (${path.basename(
-        exampleRoutePath,
-      )}). Skipping creation of example route.`,
-    );
-    return;
-  }
-
-  await fs.promises.writeFile(
-    path.join(exampleRoutePath, '+page.svelte'),
-    getSentryExampleSveltePage(projectProps),
-  );
-
-  await fs.promises.writeFile(
-    path.join(exampleRoutePath, '+server.js'),
-    getSentryExampleApiRoute(),
-  );
-}