@sentry/wizard 3.7.1 → 3.8.0

package/src/apple/apple-wizard.ts

@@ -10,9 +10,11 @@ import * as path from 'path';
 import * as xcManager from './xcode-manager';
 import * as codeTools from './code-tools';
 import * as bash from '../utils/bash';
-import { WizardOptions } from '../utils/types';
+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';
 
 const xcode = require('xcode');
 /* eslint-enable @typescript-eslint/no-unused-vars */
@@ -22,7 +24,6 @@ import {
   askForSelfHosted,
   askForWizardLogin,
   askToInstallSentryCLI,
-  SentryProjectData,
   printWelcome,
   abort,
   askForItemSelection,
@@ -102,10 +103,24 @@ async function runAppleWizardWithTelementry(
     options.url,
   );
 
+  const hasCocoa = cocoapod.usesCocoaPod(projectDir);
+
+  if (hasCocoa) {
+    const podAdded = await traceStep('Add CocoaPods reference', () =>
+      cocoapod.addCocoaPods(projectDir),
+    );
+    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",
+      );
+    }
+  }
+
   traceStep('Update Xcode project', () => {
-    xcManager.updateXcodeProject(pbxproj, project, apiKey, true, true);
+    xcManager.updateXcodeProject(pbxproj, project, apiKey, !hasCocoa, true);
   });
 
+  Sentry.setTag('package-manager', hasCocoa ? 'cocoapods' : 'SPM');
   const projSource = path.join(
     projectDir,
     xcodeProjFile.replace('.xcodeproj', ''),
@@ -123,6 +138,23 @@ async function runAppleWizardWithTelementry(
     return;
   }
 
+  if (fastlane.fastFile(projectDir)) {
+    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?',
+    });
+    if (addLane) {
+      await traceStep('Configure fastlane', () =>
+        fastlane.addSentryToFastlane(
+          projectDir,
+          project.organization.slug,
+          project.slug,
+          apiKey.token,
+        ),
+      );
+    }
+  }
+
   clack.log.success('Sentry was successfully added to your project!');
 }
 

package/src/apple/cocoapod.ts

@@ -0,0 +1,57 @@
+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';
+
+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');
+
+  const loginSpinner = clack.spinner();
+
+  loginSpinner.start("Running 'pod install'. This may take a few minutes...");
+
+  try {
+    await bash.execute('pod install --silent');
+    loginSpinner.stop('Sentry pod added to the project.');
+  } catch (e) {
+    clack.log.error("'pod install' failed. You will need to run it manually.");
+    loginSpinner.stop();
+    Sentry.captureException('Sentry pod install failed.');
+  }
+
+  return true;
+}

package/src/apple/code-tools.ts

@@ -3,79 +3,102 @@ import * as path from 'path';
 import * as templates from './templates';
 import * as Sentry from '@sentry/node';
 
-const swiftAppLaunchRegex = /(func\s+application\s*\(_\sapplication:[^,]+,\s*didFinishLaunchingWithOptions[^,]+:[^)]+\)\s+->\s+Bool\s+{)|(init\s*\([^)]*\)\s*{)/im;
-const objcAppLaunchRegex = /-\s*\(BOOL\)\s*application:\s*\(UIApplication\s*\*\)\s*application\s+didFinishLaunchingWithOptions:\s*\(NSDictionary\s*\*\)\s*launchOptions\s*{/im;
+const swiftAppLaunchRegex =
+  /(func\s+application\s*\(_\sapplication:[^,]+,\s*didFinishLaunchingWithOptions[^,]+:[^)]+\)\s+->\s+Bool\s+{)|(init\s*\([^)]*\)\s*{)/im;
+const objcAppLaunchRegex =
+  /-\s*\(BOOL\)\s*application:\s*\(UIApplication\s*\*\)\s*application\s+didFinishLaunchingWithOptions:\s*\(NSDictionary\s*\*\)\s*launchOptions\s*{/im;
 const swiftUIRegex = /struct[^:]+:\s*App\s*{/im;
 
 function isAppDelegateFile(filePath: string): boolean {
-    const appLaunchRegex = filePath.toLowerCase().endsWith(".swift") ? swiftAppLaunchRegex : objcAppLaunchRegex;
+  const appLaunchRegex = filePath.toLowerCase().endsWith('.swift')
+    ? swiftAppLaunchRegex
+    : objcAppLaunchRegex;
 
-    const fileContent = fs.readFileSync(filePath, 'utf8');
-    return appLaunchRegex.test(fileContent) || swiftUIRegex.test(fileContent);
+  const fileContent = fs.readFileSync(filePath, 'utf8');
+  return appLaunchRegex.test(fileContent) || swiftUIRegex.test(fileContent);
 }
 
 function findAppDidFinishLaunchingWithOptions(dir: string): string | null {
-    const files = fs.readdirSync(dir);
-    //iterate over subdirectories later, 
-    //the appdelegate usually is in the top level
-    const dirs: string[] = [];
+  const files = fs.readdirSync(dir);
+  //iterate over subdirectories later,
+  //the appdelegate usually is in the top level
+  const dirs: string[] = [];
 
-    for (const file of files) {
-        const filePath = path.join(dir, file);
-        if (file.endsWith(".swift") || file.endsWith(".m") || file.endsWith(".mm")) {
-            if (isAppDelegateFile(filePath)) {
-                return filePath;
-            }
-        } else if (!file.startsWith(".") && !file.endsWith(".xcodeproj") && !file.endsWith(".xcassets") && fs.lstatSync(filePath).isDirectory()) {
-            dirs.push(file);
-        }
+  for (const file of files) {
+    const filePath = path.join(dir, file);
+    if (
+      file.endsWith('.swift') ||
+      file.endsWith('.m') ||
+      file.endsWith('.mm')
+    ) {
+      if (isAppDelegateFile(filePath)) {
+        return filePath;
+      }
+    } else if (
+      !file.startsWith('.') &&
+      !file.endsWith('.xcodeproj') &&
+      !file.endsWith('.xcassets') &&
+      fs.lstatSync(filePath).isDirectory()
+    ) {
+      dirs.push(file);
     }
+  }
 
-    for (const dr of dirs) {
-        const result = findAppDidFinishLaunchingWithOptions(path.join(dir, dr));
-        if (result) return result;
-    }
-    return null;
+  for (const dr of dirs) {
+    const result = findAppDidFinishLaunchingWithOptions(path.join(dir, dr));
+    if (result) return result;
+  }
+  return null;
 }
 
-export function addCodeSnippetToProject(projPath: string, dsn: string): boolean {
-    const appDelegate = findAppDidFinishLaunchingWithOptions(projPath);
-    if (!appDelegate) {
-        return false;
-    }
+export function addCodeSnippetToProject(
+  projPath: string,
+  dsn: string,
+): boolean {
+  const appDelegate = findAppDidFinishLaunchingWithOptions(projPath);
+  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);
+  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");
+  Sentry.setTag('code-language', isSwift ? 'swift' : 'objc');
+  Sentry.setTag(
+    'ui-engine',
+    swiftUIRegex.test(fileContent) ? 'swiftui' : 'uikit',
+  );
 
-    if (fileContent.includes(checkForSentryInit)) {
-        //already initialized
-        return true;
-    }
+  if (fileContent.includes(checkForSentryInit)) {
+    //already initialized
+    return true;
+  }
 
-    let match = appLaunchRegex.exec(fileContent);
-    if (!match) {
-        const swiftUIMatch = swiftUIRegex.exec(fileContent)
-        if (!swiftUIMatch) {
-            return false;
-        }
-        //Is SwiftUI with no init
-        match = swiftUIMatch;
-        codeSnippet = `    init() {\n${codeSnippet}    }`;
+  let match = appLaunchRegex.exec(fileContent);
+  if (!match) {
+    const swiftUIMatch = swiftUIRegex.exec(fileContent);
+    if (!swiftUIMatch) {
+      return false;
     }
+    //Is SwiftUI with no init
+    match = swiftUIMatch;
+    codeSnippet = `    init() {\n${codeSnippet}    }`;
+  }
 
-    const insertIndex = match.index + match[0].length;
-    const newFileContent = (fileContent.indexOf(importStatement) >= 0 ? "" : importStatement) +
-        fileContent.slice(0, insertIndex) + "\n" +
-        codeSnippet +
-        fileContent.slice(insertIndex);
-    fs.writeFileSync(appDelegate, newFileContent, 'utf8');
+  const insertIndex = match.index + match[0].length;
+  const newFileContent =
+    (fileContent.indexOf(importStatement) >= 0 ? '' : importStatement) +
+    fileContent.slice(0, insertIndex) +
+    '\n' +
+    codeSnippet +
+    fileContent.slice(insertIndex);
+  fs.writeFileSync(appDelegate, newFileContent, 'utf8');
 
-    return true;
-}
+  return true;
+}

package/src/apple/fastlane.ts

@@ -0,0 +1,160 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import * as templates from './templates';
+import { askForItemSelection } from '../utils/clack-utils';
+
+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,
+  token: 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, token).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, token) +
+    '\n' +
+    content.slice(lane.index + lane.length)
+  );
+}
+
+export async function addSentryToFastlane(
+  projectPath: string,
+  org: string,
+  project: string,
+  token: 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) {
+    return false;
+  }
+
+  let newFileContent: string | undefined;
+  if (lanes.length === 1) {
+    newFileContent = addSentryToLane(
+      fileContent,
+      lanes[0],
+      org,
+      project,
+      token,
+    );
+  } 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,
+      token,
+    );
+  }
+
+  fs.writeFileSync(fastFilePath, newFileContent, 'utf8');
+  return true;
+}

package/src/apple/templates.ts

@@ -1,17 +1,20 @@
 export function getRunScriptTemplate(
-    orgSlug: string,
-    projectSlug: string,
-    apiKey: string,
-    uploadSource = true,
+  orgSlug: string,
+  projectSlug: string,
+  apiKey: string,
+  uploadSource = true,
 ): string {
-    // eslint-disable-next-line no-useless-escape
-    return `# This script is responsable to upload debug symbols and source context for Sentry.\\nif which sentry-cli >/dev/null; then\\nexport SENTRY_ORG=${orgSlug}\\nexport SENTRY_PROJECT=${projectSlug}\\nexport SENTRY_AUTH_TOKEN=${apiKey}\\nERROR=$(sentry-cli debug-files upload ${uploadSource ? "--include-sources " : ""}\"$DWARF_DSYM_FOLDER_PATH\" 2>&1 >/dev/null)\\nif [ ! $? -eq 0 ]; then\\necho \"warning: sentry-cli - $ERROR\"\\nfi\\nelse\\necho \"warning: sentry-cli not installed, download from https://github.com/getsentry/sentry-cli/releases\"\\nfi\\n`;
+  // eslint-disable-next-line no-useless-escape
+  return `# This script is responsable to upload debug symbols and source context for Sentry.\\nif which sentry-cli >/dev/null; then\\nexport SENTRY_ORG=${orgSlug}\\nexport SENTRY_PROJECT=${projectSlug}\\nexport SENTRY_AUTH_TOKEN=${apiKey}\\nERROR=$(sentry-cli debug-files upload ${
+    uploadSource ? '--include-sources ' : ''
+  }"$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null)\\nif [ ! $? -eq 0 ]; then\\necho "warning: sentry-cli - $ERROR"\\nfi\\nelse\\necho "warning: sentry-cli not installed, download from https://github.com/getsentry/sentry-cli/releases"\\nfi\\n`;
 }
 
-export const scriptInputPath = "\"${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}\"";
+export const scriptInputPath =
+  '"${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}"';
 
 export function getSwiftSnippet(dsn: string): string {
-    return `        SentrySDK.start { options in
+  return `        SentrySDK.start { options in
             options.dsn = "${dsn}"
             options.debug = true // Enabled debug when first installing is always helpful
             options.enableTracing = true 
@@ -25,7 +28,7 @@ export function getSwiftSnippet(dsn: string): string {
 }
 
 export function getObjcSnippet(dsn: string): string {
-    return `    [SentrySDK startWithConfigureOptions:^(SentryOptions * options) {
+  return `    [SentrySDK startWithConfigureOptions:^(SentryOptions * options) {
         options.dsn = @"${dsn}";
         options.debug = YES; // Enabled debug when first installing is always helpful
         options.enableTracing = YES;
@@ -36,4 +39,17 @@ export function getObjcSnippet(dsn: string): string {
     }];
     //Remove the next line after confirming that your Sentry integration is working.
     [SentrySDK captureMessage:@"This app uses Sentry!"];\n`;
-}
+}
+
+export function getFastlaneSnippet(
+  org: string,
+  project: string,
+  token: string,
+): string {
+  return `    sentry_cli(
+      auth_token: '${token}',
+      org_slug: '${org}',
+      project_slug: '${project}',
+      include_sources: true
+    )`;
+}