@sentry/wizard 4.0.0 → 4.0.1

package/src/react-native/expo.ts

@@ -1,175 +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 fs from 'fs';
-import { EOL } from 'os';
-
-import { isPlainObject } from '@sentry/utils';
-import * as Sentry from '@sentry/node';
-import {
-  makeCodeSnippet,
-  showCopyPasteInstructions,
-} from '../utils/clack-utils';
-import { RNCliSetupConfigContent } from './react-native-wizard';
-import { traceStep } from '../telemetry';
-
-export const SENTRY_EXPO_PLUGIN_NAME = '@sentry/react-native/expo';
-export const DEPRECATED_SENTRY_EXPO_PLUGIN_NAME = 'sentry-expo';
-
-export const SENTRY_PLUGIN_FUNCTION_NAME = 'withSentry';
-
-const APP_CONFIG_JSON = `app.json`;
-
-export interface AppConfigJson {
-  expo?: {
-    plugins?: Array<[string, undefined | Record<string, unknown>]>;
-  };
-}
-
-export function printSentryExpoMigrationOutro(): void {
-  clack.outro(
-    `Deprecated ${chalk.cyan(
-      'sentry-expo',
-    )} package installed in your dependencies. Please follow the migration guide at ${chalk.cyan(
-      'https://docs.sentry.io/platforms/react-native/migration/sentry-expo/',
-    )}`,
-  );
-}
-
-/**
- * Finds app.json in the project root and add Sentry Expo `withSentry` plugin.
- */
-export async function patchExpoAppConfig(options: RNCliSetupConfigContent) {
-  function showInstructions() {
-    return showCopyPasteInstructions(
-      APP_CONFIG_JSON,
-      getSentryAppConfigJsonCodeSnippet(options),
-      'This ensures auto upload of source maps during native app build.',
-    );
-  }
-
-  const appConfigJsonExists = fs.existsSync(APP_CONFIG_JSON);
-
-  Sentry.setTag(
-    'app-config-file-status',
-    appConfigJsonExists ? 'found' : 'not-found',
-  );
-  if (!appConfigJsonExists) {
-    return await showInstructions();
-  }
-
-  const patched = await patchAppConfigJson(APP_CONFIG_JSON, options);
-  if (!patched) {
-    return await showInstructions();
-  }
-}
-
-async function patchAppConfigJson(
-  path: string,
-  options: RNCliSetupConfigContent,
-): Promise<boolean> {
-  const appConfigContent = (
-    await fs.promises.readFile(path, { encoding: 'utf-8' })
-  ).toString();
-  const patchedContent = traceStep('app-config-json-patch', () =>
-    addWithSentryToAppConfigJson(appConfigContent, options),
-  );
-  if (patchedContent === null) {
-    return false;
-  }
-
-  try {
-    await fs.promises.writeFile(path, patchedContent);
-  } catch (error) {
-    Sentry.setTag('app-config-file-status', 'json-write-error');
-    clack.log.error(`Unable to write ${chalk.cyan('app.config.json')}.`);
-    return false;
-  }
-  Sentry.setTag('app-config-file-status', 'json-write-success');
-  clack.log.success(
-    `Added Sentry Expo plugin to ${chalk.cyan('app.config.json')}.`,
-  );
-  return true;
-}
-
-export function addWithSentryToAppConfigJson(
-  appConfigContent: string,
-  options: RNCliSetupConfigContent,
-): string | null {
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const parsedAppConfig: AppConfigJson = JSON.parse(appConfigContent);
-    const includesWithSentry =
-      appConfigContent.includes(SENTRY_EXPO_PLUGIN_NAME) ||
-      appConfigContent.includes(DEPRECATED_SENTRY_EXPO_PLUGIN_NAME);
-
-    if (includesWithSentry) {
-      Sentry.setTag('app-config-file-status', 'already-patched');
-      clack.log.warn(
-        `Your ${chalk.cyan(
-          'app.config.json',
-        )} already includes the Sentry Expo plugin.`,
-      );
-      return null;
-    }
-
-    if (
-      parsedAppConfig.expo !== undefined &&
-      !isPlainObject(parsedAppConfig.expo)
-    ) {
-      Sentry.setTag('app-config-file-status', 'invalid-json');
-      return null;
-    }
-    if (
-      parsedAppConfig.expo &&
-      parsedAppConfig.expo.plugins !== undefined &&
-      !Array.isArray(parsedAppConfig.expo.plugins)
-    ) {
-      Sentry.setTag('app-config-file-status', 'invalid-json');
-      return null;
-    }
-
-    parsedAppConfig.expo = parsedAppConfig.expo ?? {};
-    parsedAppConfig.expo.plugins = parsedAppConfig.expo.plugins ?? [];
-    parsedAppConfig.expo.plugins.push([
-      SENTRY_EXPO_PLUGIN_NAME,
-      {
-        url: options.url,
-        project: options.project,
-        organization: options.org,
-      },
-    ]);
-
-    return JSON.stringify(parsedAppConfig, null, 2) + EOL;
-  } catch (error) {
-    Sentry.setTag('app-config-file-status', 'invalid-json');
-    clack.log.error(
-      `Unable to parse your ${chalk.cyan(
-        'app.config.json',
-      )}. Make sure it has a valid format!`,
-    );
-    return null;
-  }
-}
-
-export function getSentryAppConfigJsonCodeSnippet({
-  url,
-  project,
-  org,
-}: Omit<RNCliSetupConfigContent, 'authToken'>) {
-  return makeCodeSnippet(true, (unchanged, plus, _minus) => {
-    return unchanged(`{
-  "name": "my app",
-  "plugins": [
-    ${plus(`[
-      "@sentry/react-native/expo",
-      {
-        "url": "${url}",
-        "project": "${project}",
-        "organization": "${org}"
-      }
-    ]`)}
-  ],
-}`);
-  });
-}

package/src/react-native/git.ts

@@ -1,25 +0,0 @@
-import * as fs from 'fs';
-
-const GITIGNORE_FILENAME = '.gitignore';
-
-export async function addToGitignore(filepath: string): Promise<boolean> {
-  /**
-   * Don't check whether the given file is ignored because:
-   * 1. It's tricky to check it without git.
-   * 2. Git might not be installed or accessible.
-   * 3. It's convenient to use a module to interact with git, but it would
-   *    increase the size x2 approximately. Docs say to run the Wizard without
-   *    installing it, and duplicating the size would slow the set-up down.
-   * 4. The Wizard is meant to be run once.
-   * 5. A message is logged informing users it's been added to the gitignore.
-   * 6. It will be added to the gitignore as many times as it runs - not a big
-   *    deal.
-   * 7. It's straightforward to remove it from the gitignore.
-   */
-  try {
-    await fs.promises.appendFile(GITIGNORE_FILENAME, `\n${filepath}\n`);
-    return true;
-  } catch {
-    return false;
-  }
-}

package/src/react-native/glob.ts

@@ -1,13 +0,0 @@
-import * as glob from 'glob';
-
-export const XCODE_PROJECT = 'ios/*.xcodeproj/project.pbxproj';
-export const APP_BUILD_GRADLE = '**/app/build.gradle';
-
-const IGNORE_PATTERNS = ['node_modules/**', 'ios/Pods/**', '**/Pods/**'];
-export function getFirstMatchedPath(pattern: string): string | undefined {
-  const matches = glob.sync(pattern, {
-    ignore: IGNORE_PATTERNS,
-  });
-
-  return matches[0];
-}

package/src/react-native/gradle.ts

@@ -1,26 +0,0 @@
-import * as fs from 'fs';
-
-const applyFrom = `apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")`;
-
-export function doesAppBuildGradleIncludeRNSentryGradlePlugin(
-  content: string,
-): boolean {
-  return content.includes('sentry.gradle');
-}
-
-export function addRNSentryGradlePlugin(content: string): string {
-  return content.replace(/^android {/m, (match) => `${applyFrom}\n${match}`);
-}
-
-export function removeRNSentryGradlePlugin(content: string): string {
-  return content.replace(/^\s*apply from:.*sentry\.gradle.*;?\s*?\r?\n/m, '');
-}
-
-export function writeAppBuildGradle(path: string, newContent: string): void {
-  const currentContent = fs.readFileSync(path, 'utf-8');
-  if (newContent === currentContent) {
-    return;
-  }
-
-  fs.writeFileSync(path, newContent, 'utf-8');
-}

package/src/react-native/javascript.ts

@@ -1,103 +0,0 @@
-/* eslint-disable max-lines */
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-import * as path from 'path';
-import * as process from 'process';
-import * as fs from 'fs';
-import * as Sentry from '@sentry/node';
-
-import { traceStep } from '../telemetry';
-import {
-  makeCodeSnippet,
-  showCopyPasteInstructions,
-} from '../utils/clack-utils';
-import { getFirstMatchedPath } from './glob';
-import { RN_SDK_PACKAGE } from './react-native-wizard';
-
-export async function addSentryInit({ dsn }: { dsn: string }) {
-  const prefixGlob = '{.,./src,./app}';
-  const suffixGlob = '@(j|t|cj|mj)s?(x)';
-  const universalGlob = `@(App|_layout).${suffixGlob}`;
-  const jsFileGlob = `${prefixGlob}/+(${universalGlob})`;
-  const jsPath = traceStep('find-app-js-file', () =>
-    getFirstMatchedPath(jsFileGlob),
-  );
-  Sentry.setTag('app-js-file-status', jsPath ? 'found' : 'not-found');
-  if (!jsPath) {
-    clack.log.warn(
-      `Could not find main App file. Place the following code snippet close to the Apps Root component.`,
-    );
-    await showCopyPasteInstructions(
-      'App.js or _layout.tsx',
-      getSentryInitColoredCodeSnippet(dsn),
-      'This ensures the Sentry SDK is ready to capture errors.',
-    );
-    return;
-  }
-  const jsRelativePath = path.relative(process.cwd(), jsPath);
-
-  const js = fs.readFileSync(jsPath, 'utf-8');
-  const includesSentry = doesJsCodeIncludeSdkSentryImport(js, {
-    sdkPackageName: RN_SDK_PACKAGE,
-  });
-  if (includesSentry) {
-    Sentry.setTag('app-js-file-status', 'already-includes-sentry');
-    clack.log.warn(
-      `${chalk.cyan(
-        jsRelativePath,
-      )} already includes Sentry. We wont't add it again.`,
-    );
-    return;
-  }
-
-  traceStep('add-sentry-init', () => {
-    const newContent = addSentryInitWithSdkImport(js, { dsn });
-
-    clack.log.success(
-      `Added ${chalk.cyan('Sentry.init')} to ${chalk.cyan(jsRelativePath)}.`,
-    );
-
-    fs.writeFileSync(jsPath, newContent, 'utf-8');
-  });
-
-  Sentry.setTag('app-js-file-status', 'added-sentry-init');
-  clack.log.success(
-    chalk.green(`${chalk.cyan(jsRelativePath)} changes saved.`),
-  );
-}
-
-export function addSentryInitWithSdkImport(
-  js: string,
-  { dsn }: { dsn: string },
-): string {
-  return js.replace(
-    /^([^]*)(import\s+[^;]*?;$)/m,
-    (match: string) => `${match}
-${getSentryInitPlainTextSnippet(dsn)}`,
-  );
-}
-
-export function doesJsCodeIncludeSdkSentryImport(
-  js: string,
-  { sdkPackageName }: { sdkPackageName: string },
-): boolean {
-  return !!js.match(sdkPackageName);
-}
-
-export function getSentryInitColoredCodeSnippet(dsn: string) {
-  return makeCodeSnippet(true, (_unchanged, plus, _minus) => {
-    return plus(getSentryInitPlainTextSnippet(dsn));
-  });
-}
-
-export function getSentryInitPlainTextSnippet(dsn: string) {
-  return `import * as Sentry from '@sentry/react-native';
-
-Sentry.init({
-  dsn: '${dsn}',
-
-  // uncomment the line below to enable Spotlight (https://spotlightjs.com)
-  // spotlight: __DEV__,
-});`;
-}