@sentry/wizard 3.42.1 → 4.0.1

package/src/apple/apple-wizard.ts

@@ -1,269 +0,0 @@
-/* eslint-disable max-lines */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import * as fs from 'fs';
-import * as path from 'path';
-import { XcodeProject } from './xcode-manager';
-import * as codeTools from './code-tools';
-import * as bash from '../utils/bash';
-import * as SentryUtils from '../utils/sentrycli-utils';
-import { SentryProjectData, WizardOptions } from '../utils/types';
-import * as Sentry from '@sentry/node';
-import { traceStep, withTelemetry } from '../telemetry';
-import * as cocoapod from './cocoapod';
-import * as fastlane from './fastlane';
-
-/* eslint-enable @typescript-eslint/no-unused-vars */
-
-import {
-  askToInstallSentryCLI,
-  printWelcome,
-  abort,
-  askForItemSelection,
-  confirmContinueIfNoOrDirtyGitRepo,
-  getOrAskForProjectData,
-} from '../utils/clack-utils';
-
-export async function runAppleWizard(options: WizardOptions): Promise<void> {
-  return withTelemetry(
-    {
-      enabled: options.telemetryEnabled,
-      integration: 'ios',
-      wizardOptions: options,
-    },
-    () => runAppleWizardWithTelementry(options),
-  );
-}
-
-async function runAppleWizardWithTelementry(
-  options: WizardOptions,
-): Promise<void> {
-  printWelcome({
-    wizardName: 'Sentry Apple Wizard',
-    promoCode: options.promoCode,
-  });
-
-  await confirmContinueIfNoOrDirtyGitRepo();
-
-  const hasCli = bash.hasSentryCLI();
-  Sentry.setTag('has-cli', hasCli);
-  if (!hasCli) {
-    if (
-      !(await traceStep('Ask for SentryCLI', () => askToInstallSentryCLI()))
-    ) {
-      clack.log.warn(
-        "Without sentry-cli, you won't be able to upload debug symbols to Sentry. You can install it later by following the instructions at https://docs.sentry.io/cli/",
-      );
-      Sentry.setTag('CLI-Installed', false);
-    } else {
-      await bash.installSentryCLI();
-      Sentry.setTag('CLI-Installed', true);
-    }
-  }
-
-  const projectDir = process.cwd();
-  const xcodeProjFiles = searchXcodeProject(projectDir);
-
-  if (!xcodeProjFiles || xcodeProjFiles.length === 0) {
-    clack.log.error(
-      'No Xcode project found. Please run this command from the root of your project.',
-    );
-    await abort();
-    return;
-  }
-
-  let xcodeProjFile;
-
-  if (xcodeProjFiles.length === 1) {
-    xcodeProjFile = xcodeProjFiles[0];
-    Sentry.setTag('multiple-projects', false);
-  } else {
-    Sentry.setTag('multiple-projects', true);
-    xcodeProjFile = (
-      await traceStep('Choose Xcode project', () =>
-        askForItemSelection(
-          xcodeProjFiles,
-          'Which project do you want to add Sentry to?',
-        ),
-      )
-    ).value;
-  }
-
-  const pbxproj = path.join(projectDir, xcodeProjFile, 'project.pbxproj');
-
-  if (!fs.existsSync(pbxproj)) {
-    clack.log.error(`No pbxproj found at ${xcodeProjFile}`);
-    await abort();
-    return;
-  }
-
-  const { project, apiKey } = await getSentryProjectAndApiKey(options);
-
-  const xcProject = new XcodeProject(pbxproj);
-
-  const availableTargets = xcProject.getAllTargets();
-
-  if (availableTargets.length == 0) {
-    clack.log.error(`No suitable target found in ${xcodeProjFile}`);
-    Sentry.setTag('No-Target', true);
-    await abort();
-    return;
-  }
-
-  const target =
-    availableTargets.length == 1
-      ? availableTargets[0]
-      : (
-          await traceStep('Choose target', () =>
-            askForItemSelection(
-              availableTargets,
-              'Which target do you want to add Sentry to?',
-            ),
-          )
-        ).value;
-
-  SentryUtils.createSentryCLIRC(projectDir, { auth_token: apiKey.token });
-  clack.log.info(
-    'We created a ".sentryclirc" file in your project directory in order to provide an auth token for Sentry CLI.\nIt was also added to your ".gitignore" file.\nAt your CI enviroment, you can set the SENTRY_AUTH_TOKEN environment variable instead. See https://docs.sentry.io/cli/configuration/#auth-token for more information.',
-  );
-
-  let hasCocoa = cocoapod.usesCocoaPod(projectDir);
-  Sentry.setTag('cocoapod-exists', hasCocoa);
-
-  if (hasCocoa) {
-    const pm = (
-      await traceStep('Choose a package manager', () =>
-        askForItemSelection(
-          ['Swift Package Manager', 'CocoaPods'],
-          'Which package manager would you like to use to add Sentry?',
-        ),
-      )
-    ).value;
-
-    hasCocoa = pm === 'CocoaPods';
-    if (hasCocoa) {
-      const podAdded = await traceStep('Add CocoaPods reference', () =>
-        cocoapod.addCocoaPods(projectDir),
-      );
-      Sentry.setTag('cocoapod-added', podAdded);
-      if (!podAdded) {
-        clack.log.warn(
-          "Could not add Sentry pod to your Podfile. You'll have to add it manually.\nPlease follow the instructions at https://docs.sentry.io/platforms/apple/guides/ios/#install",
-        );
-      }
-    }
-  }
-
-  Sentry.setTag('package-manager', hasCocoa ? 'cocoapods' : 'SPM');
-  traceStep('Update Xcode project', () => {
-    xcProject.updateXcodeProject(project, target, !hasCocoa, true);
-  });
-
-  const codeAdded = traceStep('Add code snippet', () => {
-    const files = xcProject.filesForTarget(target);
-    if (files === undefined || files.length == 0) return false;
-
-    return codeTools.addCodeSnippetToProject(
-      projectDir,
-      files,
-      project.keys[0].dsn.public,
-    );
-  });
-
-  Sentry.setTag('Snippet-Added', codeAdded);
-
-  if (!codeAdded) {
-    clack.log.warn(
-      'Added the Sentry dependency to your project but could not add the Sentry code snippet. Please add the code snipped manually by following the docs: https://docs.sentry.io/platforms/apple/guides/ios/#configure',
-    );
-  }
-
-  const hasFastlane = fastlane.fastFile(projectDir);
-  Sentry.setTag('fastlane-exists', hasFastlane);
-  if (hasFastlane) {
-    const addLane = await clack.confirm({
-      message:
-        'Found a Fastfile in your project. Do you want to configure a lane to upload debug symbols to Sentry?',
-    });
-    Sentry.setTag('fastlane-desired', addLane);
-    if (addLane) {
-      const added = await traceStep('Configure fastlane', () =>
-        fastlane.addSentryToFastlane(
-          projectDir,
-          project.organization.slug,
-          project.slug,
-        ),
-      );
-      Sentry.setTag('fastlane-added', added);
-      if (added) {
-        clack.log.step(
-          'A new step was added to your fastlane file. Now and you build your project with fastlane, debug symbols and source context will be uploaded to Sentry.',
-        );
-      } else {
-        clack.log.warn(
-          'Could not edit your fastlane file to upload debug symbols to Sentry. Please follow the instructions at https://docs.sentry.io/platforms/apple/guides/ios/dsym/#fastlane',
-        );
-      }
-    }
-  }
-
-  clack.log.success(
-    'Sentry was successfully added to your project! Run your project to send your first event to Sentry. Go to Sentry.io to see whether everything is working fine.',
-  );
-}
-
-//Prompt for Sentry project and API key
-async function getSentryProjectAndApiKey(
-  options: WizardOptions,
-): Promise<{ project: SentryProjectData; apiKey: { token: string } }> {
-  const { selectedProject, authToken } = await getOrAskForProjectData(options);
-  return { project: selectedProject, apiKey: { token: authToken } };
-}
-
-function searchXcodeProject(at: string): string[] {
-  const projs = findFilesWithExtension(at, '.xcodeproj');
-  if (projs.length > 0) {
-    return projs;
-  }
-
-  const workspace = findFilesWithExtension(at, '.xcworkspace');
-  if (workspace.length == 0) {
-    return [];
-  }
-
-  const xsworkspacedata = path.join(
-    at,
-    workspace[0],
-    'contents.xcworkspacedata',
-  );
-  if (!fs.existsSync(xsworkspacedata)) {
-    return [];
-  }
-  const groupRegex = /location *= *"group:([^"]+)"/gim;
-  const content = fs.readFileSync(xsworkspacedata, 'utf8');
-  let matches = groupRegex.exec(content);
-
-  while (matches) {
-    const group = matches[1];
-    const groupPath = path.join(at, group);
-    if (
-      !group.endsWith('Pods.xcodeproj') &&
-      group.endsWith('.xcodeproj') &&
-      fs.existsSync(groupPath)
-    ) {
-      projs.push(group);
-    }
-    matches = groupRegex.exec(content);
-  }
-  return projs;
-}
-
-//find files with the given extension
-function findFilesWithExtension(dir: string, extension: string): string[] {
-  const files = fs.readdirSync(dir);
-  return files.filter((file) => file.endsWith(extension));
-}

package/src/apple/cocoapod.ts

@@ -1,73 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import * as bash from '../utils/bash';
-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';
-
-export function usesCocoaPod(projPath: string): boolean {
-  return fs.existsSync(path.join(projPath, 'Podfile'));
-}
-
-export async function addCocoaPods(projPath: string): Promise<boolean> {
-  const podfile = path.join(projPath, 'Podfile');
-
-  const podContent = fs.readFileSync(podfile, 'utf8');
-
-  if (
-    /^\s*pod\s+(['"]Sentry['"]|['"]SentrySwiftUI['"])\s*$/im.test(podContent)
-  ) {
-    // Already have Sentry pod
-    return true;
-  }
-
-  let podMatch = /^( *)pod\s+['"](\w+)['"] *$/im.exec(podContent);
-  if (!podMatch) {
-    // No Podfile is empty, will try to add Sentry pod after "use_frameworks!"
-    const frameworkMatch = /^( *)use_frameworks![^\n]* *$/im.exec(podContent);
-    if (!frameworkMatch) {
-      return false;
-    }
-    podMatch = frameworkMatch;
-  }
-
-  const insertIndex = podMatch.index + podMatch[0].length;
-  const newFileContent =
-    podContent.slice(0, insertIndex) +
-    '\n' +
-    podMatch[1] +
-    "pod 'Sentry'\n" +
-    podContent.slice(insertIndex);
-  fs.writeFileSync(podfile, newFileContent, 'utf8');
-
-  clack.log.step('Sentry pod added to the project podFile.');
-
-  await podInstall();
-
-  return true;
-}
-
-export async function podInstall(dir = '.') {
-  const installSpinner = clack.spinner();
-  installSpinner.start("Running 'pod install'. This may take a few minutes...");
-
-  try {
-    await bash.execute(`cd ${dir} && pod repo update`);
-    await bash.execute(`cd ${dir} && pod install --silent`);
-    installSpinner.stop('Pods installed.');
-    Sentry.setTag('pods-installed', true);
-  } catch (e) {
-    installSpinner.stop('Failed to install pods.');
-    Sentry.setTag('pods-installed', false);
-    clack.log.error(
-      `${chalk.red(
-        'Encountered the following error during pods installation:',
-        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      )}\n\n${e}\n\n${chalk.dim(
-        'If you think this issue is caused by the Sentry wizard, let us know here:\nhttps://github.com/getsentry/sentry-wizard/issues',
-      )}`,
-    );
-    Sentry.captureException('Sentry pod install failed.');
-  }
-}

package/src/apple/code-tools.ts

@@ -1,147 +0,0 @@
-import * as Sentry from '@sentry/node';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as templates from './templates';
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-
-const swiftAppLaunchRegex =
-  /(func\s+application\s*\(\s*_\s+application:\s*[^,]+,\s*didFinishLaunchingWithOptions[^,]+:\s*[^)]+\s*\)\s+->\s+Bool\s+{)|func\s+applicationDidFinishLaunching\s*\(\s*_\s+aNotification:\s+Notification\s*\)\s*{/im;
-const objcAppLaunchRegex =
-  /-\s*\(\s*BOOL\s*\)\s*application:\s*\(\s*UIApplication\s*\*\s*\)\s*application\s+didFinishLaunchingWithOptions:\s*\(\s*NSDictionary\s*\*\s*\)\s*launchOptions\s*{/im;
-const swiftUIRegex = /@main\s+struct[^:]+:\s*(SwiftUI\.)?App\s*{/im;
-
-function isAppDelegateFile(filePath: string): boolean {
-  const appLaunchRegex = filePath.toLowerCase().endsWith('.swift')
-    ? swiftAppLaunchRegex
-    : objcAppLaunchRegex;
-
-  const fileContent = fs.readFileSync(filePath, 'utf8');
-  return appLaunchRegex.test(fileContent) || swiftUIRegex.test(fileContent);
-}
-
-function findAppDidFinishLaunchingWithOptions(
-  dir: string,
-  files: string[] | undefined = undefined,
-): string | null {
-  if (!files) {
-    files = fs.readdirSync(dir);
-    files = files.map((f) => path.join(dir, f));
-  }
-
-  //iterate over subdirectories later,
-  //the appdelegate usually is in the top level
-  const dirs: string[] = [];
-
-  for (const filePath of files) {
-    if (
-      filePath.endsWith('.swift') ||
-      filePath.endsWith('.m') ||
-      filePath.endsWith('.mm')
-    ) {
-      if (fs.existsSync(filePath) && isAppDelegateFile(filePath)) {
-        return filePath;
-      }
-    } else if (
-      !path.basename(filePath).startsWith('.') &&
-      !filePath.endsWith('.xcodeproj') &&
-      !filePath.endsWith('.xcassets') &&
-      fs.existsSync(filePath) &&
-      fs.lstatSync(filePath).isDirectory()
-    ) {
-      dirs.push(filePath);
-    }
-  }
-
-  for (const dr of dirs) {
-    const result = findAppDidFinishLaunchingWithOptions(dr);
-    if (result) return result;
-  }
-  return null;
-}
-
-export function addCodeSnippetToProject(
-  projPath: string,
-  files: string[],
-  dsn: string,
-): boolean {
-  const appDelegate = findAppDidFinishLaunchingWithOptions(projPath, files);
-  if (!appDelegate) {
-    return false;
-  }
-
-  const fileContent = fs.readFileSync(appDelegate, 'utf8');
-  const isSwift = appDelegate.toLowerCase().endsWith('.swift');
-  const appLaunchRegex = isSwift ? swiftAppLaunchRegex : objcAppLaunchRegex;
-  const importStatement = isSwift ? 'import Sentry\n' : '@import Sentry;\n';
-  const checkForSentryInit = isSwift ? 'SentrySDK.start' : '[SentrySDK start';
-  let codeSnippet = isSwift
-    ? templates.getSwiftSnippet(dsn)
-    : templates.getObjcSnippet(dsn);
-
-  Sentry.setTag('code-language', isSwift ? 'swift' : 'objc');
-  Sentry.setTag(
-    'ui-engine',
-    swiftUIRegex.test(fileContent) ? 'swiftui' : 'uikit',
-  );
-
-  if (fileContent.includes(checkForSentryInit)) {
-    //already initialized
-    clack.log.info(
-      'Sentry is already initialized in your AppDelegate. Skipping adding the code snippet.',
-    );
-    return true;
-  }
-
-  let match = appLaunchRegex.exec(fileContent);
-  if (!match) {
-    const swiftUIMatch = swiftUIRegex.exec(fileContent);
-    if (!swiftUIMatch) {
-      // This branch is not reached, because we already checked for SwiftUI in isAppDelegateFile
-      return false;
-    }
-    //Is SwiftUI with no init
-    match = swiftUIMatch;
-    codeSnippet = `    init() {\n${codeSnippet}    }`;
-  }
-
-  const insertIndex = match.index + match[0].length;
-  let newFileContent =
-    fileContent.slice(0, insertIndex) +
-    '\n' +
-    codeSnippet +
-    fileContent.slice(insertIndex);
-
-  if (newFileContent.indexOf(importStatement) < 0) {
-    const firstImport = /^[ \t]*import +\w+.*$/m.exec(newFileContent);
-    if (firstImport) {
-      const importIndex = firstImport.index + firstImport[0].length;
-      newFileContent =
-        newFileContent.slice(0, importIndex) +
-        '\n' +
-        importStatement +
-        newFileContent.slice(importIndex);
-    } else {
-      newFileContent = importStatement + newFileContent;
-    }
-  }
-
-  fs.writeFileSync(appDelegate, newFileContent, 'utf8');
-
-  clack.log.step('Added Sentry initialization code snippet to ' + appDelegate);
-  return true;
-}
-
-/**
- * Exported for testing purposes, but should not be used in other modules.
- */
-export let exportForTesting: {
-  isAppDelegateFile: typeof isAppDelegateFile;
-  findAppDidFinishLaunchingWithOptions: typeof findAppDidFinishLaunchingWithOptions;
-};
-if (process.env.NODE_ENV === 'test') {
-  exportForTesting = {
-    isAppDelegateFile,
-    findAppDidFinishLaunchingWithOptions,
-  };
-}

package/src/apple/fastlane.ts

@@ -1,170 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { askForItemSelection } from '../utils/clack-utils';
-import * as templates from './templates';
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-
-export function fastFile(projectPath: string): string | null {
-  const fastlanePath = path.join(projectPath, 'fastlane', 'Fastfile');
-  return fs.existsSync(fastlanePath) ? fastlanePath : null;
-}
-
-function findIOSPlatform(
-  content: string,
-): { index: number; length: number } | null {
-  const platformRegex = /^ *platform\s+:([^ ]+)[^\n]*\n/gim;
-  let match = platformRegex.exec(content);
-  if (!match) {
-    // No platform found, treat whole file as one platform.
-    return { index: 0, length: content.length };
-  }
-
-  let index = -1;
-  while (match) {
-    if (match[1] === 'ios') {
-      index = match.index + match[0].length;
-      break;
-    }
-    match = platformRegex.exec(content);
-  }
-
-  if (index === -1) {
-    return null;
-  }
-
-  //After finding the platform, we need to find the end of the platform block.
-  //This solution has the assumption that the file is well formed,
-  //which is not a perfect solution, but it's good enough assumption.
-  const platformEndRegex = /^end[^\n]*/gim;
-  match = platformEndRegex.exec(content.slice(index));
-  if (!match) {
-    return null;
-  }
-
-  return { index, length: match.index };
-}
-
-function findLanes(
-  content: string,
-): { index: number; length: number; name: string }[] | null {
-  const laneRegex = /^ {2}lane\s+:([^ ]+)[^\n]*\n/gim;
-  let match = laneRegex.exec(content);
-  if (!match) {
-    return null;
-  }
-
-  const lanes: { index: number; length: number; name: string }[] = [];
-  while (match) {
-    const laneEnd = /^ {2}end/m.exec(
-      content.slice(match.index + match[0].length),
-    );
-    if (laneEnd === null) {
-      return null;
-    }
-    lanes.push({
-      index: match.index + match[0].length,
-      length: laneEnd.index,
-      name: match[1],
-    });
-    match = laneRegex.exec(content);
-  }
-  return lanes;
-}
-
-function addSentryToLane(
-  content: string,
-  lane: { index: number; length: number; name: string },
-  org: string,
-  project: string,
-): string {
-  const laneContent = content.slice(lane.index, lane.index + lane.length);
-  const sentryCLIMatch = /sentry_cli\s*\([^)]+\)/gim.exec(laneContent);
-  if (sentryCLIMatch) {
-    // Sentry already added to lane. Update it.
-    return (
-      content.slice(0, sentryCLIMatch.index + lane.index) +
-      templates.getFastlaneSnippet(org, project).trim() +
-      content.slice(
-        sentryCLIMatch.index + sentryCLIMatch[0].length + lane.index,
-      )
-    );
-  }
-
-  // Sentry not added to lane. Add it.
-  return (
-    content.slice(0, lane.index + lane.length) +
-    '\n' +
-    templates.getFastlaneSnippet(org, project) +
-    '\n' +
-    content.slice(lane.index + lane.length)
-  );
-}
-
-export async function addSentryToFastlane(
-  projectPath: string,
-  org: string,
-  project: string,
-): Promise<boolean> {
-  const fastFilePath = fastFile(projectPath);
-  if (!fastFilePath) {
-    return false;
-  }
-
-  const fileContent = fs.readFileSync(fastFilePath, 'utf8');
-  const platform = findIOSPlatform(fileContent);
-  if (!platform) {
-    return false;
-  }
-
-  const platformContent = fileContent.slice(
-    platform.index,
-    platform.index + platform.length,
-  );
-  const lanes = findLanes(platformContent);
-  lanes?.forEach((l) => (l.index += platform.index));
-
-  if (!lanes || lanes.length === 0) {
-    clack.log.warn('No suitable lanes in your Fastfile.');
-    return false;
-  }
-
-  let newFileContent: string | undefined;
-  if (lanes.length === 1) {
-    newFileContent = addSentryToLane(fileContent, lanes[0], org, project);
-  } else {
-    const laneNames = lanes.map((l) => l.name);
-    const selectedLane = await askForItemSelection(
-      laneNames,
-      'Select lane to add Sentry to:',
-    );
-    if (selectedLane === undefined) {
-      return false;
-    }
-    newFileContent = addSentryToLane(
-      fileContent,
-      lanes[selectedLane.index],
-      org,
-      project,
-    );
-  }
-
-  fs.writeFileSync(fastFilePath, newFileContent, 'utf8');
-  return true;
-}
-
-/**
- * Exported for testing purposes, but should not be used in other modules.
- */
-export let exportForTesting: {
-  findIOSPlatform: typeof findIOSPlatform;
-  findLanes: typeof findLanes;
-  addSentryToLane: typeof addSentryToLane;
-};
-if (process.env.NODE_ENV === 'test') {
-  exportForTesting = {
-    findIOSPlatform,
-    findLanes,
-    addSentryToLane,
-  };
-}