@sentry/wizard 3.10.0 → 3.12.0

package/src/apple/apple-wizard.ts

@@ -7,9 +7,10 @@
 import clack from '@clack/prompts';
 import * as fs from 'fs';
 import * as path from 'path';
-import * as xcManager from './xcode-manager';
+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';
@@ -20,13 +21,12 @@ const xcode = require('xcode');
 /* eslint-enable @typescript-eslint/no-unused-vars */
 
 import {
-  askForProjectSelection,
-  askForSelfHosted,
-  askForWizardLogin,
   askToInstallSentryCLI,
   printWelcome,
   abort,
   askForItemSelection,
+  confirmContinueEvenThoughNoGitRepo,
+  getOrAskForProjectData,
 } from '../utils/clack-utils';
 
 export async function runAppleWizard(options: WizardOptions): Promise<void> {
@@ -47,6 +47,8 @@ async function runAppleWizardWithTelementry(
     promoCode: options.promoCode,
   });
 
+  await confirmContinueEvenThoughNoGitRepo();
+
   const hasCli = bash.hasSentryCLI();
   Sentry.setTag('has-cli', hasCli);
   if (!hasCli) {
@@ -64,7 +66,7 @@ async function runAppleWizardWithTelementry(
   }
 
   const projectDir = process.cwd();
-  const xcodeProjFiles = findFilesWithExtension(projectDir, '.xcodeproj');
+  const xcodeProjFiles = searchXcodeProject(projectDir);
 
   if (!xcodeProjFiles || xcodeProjFiles.length === 0) {
     clack.log.error(
@@ -92,42 +94,79 @@ async function runAppleWizardWithTelementry(
   }
 
   const pbxproj = path.join(projectDir, xcodeProjFile, 'project.pbxproj');
+
   if (!fs.existsSync(pbxproj)) {
-    clack.log.error(`No pbxproj found at ${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 suttable target found in ${xcodeProjFile}`);
     await abort();
     return;
   }
 
-  const { project, apiKey } = await getSentryProjectAndApiKey(
-    options.promoCode,
-    options.url,
+  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.',
   );
 
-  const hasCocoa = cocoapod.usesCocoaPod(projectDir);
+  let 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",
+    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),
       );
+      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, !hasCocoa, true);
+    xcProject.updateXcodeProject(project, target, apiKey, !hasCocoa, true);
   });
 
   Sentry.setTag('package-manager', hasCocoa ? 'cocoapods' : 'SPM');
-  const projSource = path.join(
-    projectDir,
-    xcodeProjFile.replace('.xcodeproj', ''),
-  );
   const codeAdded = traceStep('Add code snippet', () => {
+    const files = xcProject.filesForTarget(target);
+    if (files === undefined || files.length == 0) return false;
+
     return codeTools.addCodeSnippetToProject(
-      projSource,
+      projectDir,
+      files,
       project.keys[0].dsn.public,
     );
   });
@@ -144,35 +183,74 @@ async function runAppleWizardWithTelementry(
         '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', () =>
+      const added = await traceStep('Configure fastlane', () =>
         fastlane.addSentryToFastlane(
           projectDir,
           project.organization.slug,
           project.slug,
-          apiKey.token,
         ),
       );
+      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!');
+  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(
-  promoCode?: string,
-  url?: string,
+  options: WizardOptions,
 ): Promise<{ project: SentryProjectData; apiKey: { token: string } }> {
-  const { url: sentryUrl } = await askForSelfHosted(url);
+  const { selectedProject, authToken } = await getOrAskForProjectData(options);
+  return { project: selectedProject, apiKey: { token: authToken } };
+}
 
-  const { projects, apiKeys } = await askForWizardLogin({
-    promoCode: promoCode,
-    url: sentryUrl,
-    platform: 'apple-ios',
-  });
+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);
 
-  const selectedProject = await askForProjectSelection(projects);
-  return { project: selectedProject, apiKey: apiKeys };
+  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

package/src/apple/cocoapod.ts

@@ -42,14 +42,17 @@ export async function addCocoaPods(projPath: string): Promise<boolean> {
 
   const loginSpinner = clack.spinner();
 
+  clack.log.step('Sentry pod added to the project podFile.');
   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.');
+    loginSpinner.stop('Running "pod install"');
   } catch (e) {
-    clack.log.error("'pod install' failed. You will need to run it manually.");
-    loginSpinner.stop();
+    loginSpinner.stop('Running "pod install"');
+    clack.log.error(
+      'Failed to run "pod install". You can run it manually for more details.',
+    );
     Sentry.captureException('Sentry pod install failed.');
   }
 

package/src/apple/code-tools.ts

@@ -2,12 +2,14 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as templates from './templates';
 import * as Sentry from '@sentry/node';
+// @ts-ignore - clack is ESM and TS complains about that. It works though
+import clack from '@clack/prompts';
 
 const swiftAppLaunchRegex =
-  /(func\s+application\s*\(_\sapplication:[^,]+,\s*didFinishLaunchingWithOptions[^,]+:[^)]+\)\s+->\s+Bool\s+{)|(init\s*\([^)]*\)\s*{)/im;
+  /(func\s+application\s*\(_\sapplication:[^,]+,\s*didFinishLaunchingWithOptions[^,]+:[^)]+\)\s+->\s+Bool\s+{)|func\s+applicationDidFinishLaunching\(_\s+aNotification:\s+Notification\)\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;
+const swiftUIRegex = /@main\s+struct[^:]+:\s*App\s*{/im;
 
 function isAppDelegateFile(filePath: string): boolean {
   const appLaunchRegex = filePath.toLowerCase().endsWith('.swift')
@@ -18,34 +20,41 @@ function isAppDelegateFile(filePath: string): boolean {
   return appLaunchRegex.test(fileContent) || swiftUIRegex.test(fileContent);
 }
 
-function findAppDidFinishLaunchingWithOptions(dir: string): string | null {
-  const files = fs.readdirSync(dir);
+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 file of files) {
-    const filePath = path.join(dir, file);
+  for (const filePath of files) {
     if (
-      file.endsWith('.swift') ||
-      file.endsWith('.m') ||
-      file.endsWith('.mm')
+      filePath.endsWith('.swift') ||
+      filePath.endsWith('.m') ||
+      filePath.endsWith('.mm')
     ) {
-      if (isAppDelegateFile(filePath)) {
+      if (fs.existsSync(filePath) && isAppDelegateFile(filePath)) {
         return filePath;
       }
     } else if (
-      !file.startsWith('.') &&
-      !file.endsWith('.xcodeproj') &&
-      !file.endsWith('.xcassets') &&
+      !filePath.startsWith('.') &&
+      !filePath.endsWith('.xcodeproj') &&
+      !filePath.endsWith('.xcassets') &&
+      fs.existsSync(filePath) &&
       fs.lstatSync(filePath).isDirectory()
     ) {
-      dirs.push(file);
+      dirs.push(filePath);
     }
   }
 
   for (const dr of dirs) {
-    const result = findAppDidFinishLaunchingWithOptions(path.join(dir, dr));
+    const result = findAppDidFinishLaunchingWithOptions(dr);
     if (result) return result;
   }
   return null;
@@ -53,9 +62,10 @@ function findAppDidFinishLaunchingWithOptions(dir: string): string | null {
 
 export function addCodeSnippetToProject(
   projPath: string,
+  files: string[],
   dsn: string,
 ): boolean {
-  const appDelegate = findAppDidFinishLaunchingWithOptions(projPath);
+  const appDelegate = findAppDidFinishLaunchingWithOptions(projPath, files);
   if (!appDelegate) {
     return false;
   }
@@ -77,6 +87,9 @@ export function addCodeSnippetToProject(
 
   if (fileContent.includes(checkForSentryInit)) {
     //already initialized
+    clack.log.info(
+      'Sentry is already initialized in your AppDelegate. Skipping adding the code snippet.',
+    );
     return true;
   }
 
@@ -92,13 +105,28 @@ export function addCodeSnippetToProject(
   }
 
   const insertIndex = match.index + match[0].length;
-  const newFileContent =
-    (fileContent.indexOf(importStatement) >= 0 ? '' : importStatement) +
+  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;
 }

package/src/apple/fastlane.ts

@@ -2,6 +2,8 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as templates from './templates';
 import { askForItemSelection } from '../utils/clack-utils';
+// @ts-ignore - clack is ESM and TS complains about that. It works though
+import clack from '@clack/prompts';
 
 export function fastFile(projectPath: string): string | null {
   const fastlanePath = path.join(projectPath, 'fastlane', 'Fastfile');
@@ -75,7 +77,6 @@ function addSentryToLane(
   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);
@@ -83,7 +84,7 @@ function addSentryToLane(
     // Sentry already added to lane. Update it.
     return (
       content.slice(0, sentryCLIMatch.index + lane.index) +
-      templates.getFastlaneSnippet(org, project, token).trim() +
+      templates.getFastlaneSnippet(org, project).trim() +
       content.slice(
         sentryCLIMatch.index + sentryCLIMatch[0].length + lane.index,
       )
@@ -94,7 +95,7 @@ function addSentryToLane(
   return (
     content.slice(0, lane.index + lane.length) +
     '\n' +
-    templates.getFastlaneSnippet(org, project, token) +
+    templates.getFastlaneSnippet(org, project) +
     '\n' +
     content.slice(lane.index + lane.length)
   );
@@ -104,7 +105,6 @@ export async function addSentryToFastlane(
   projectPath: string,
   org: string,
   project: string,
-  token: string,
 ): Promise<boolean> {
   const fastFilePath = fastFile(projectPath);
   if (!fastFilePath) {
@@ -125,18 +125,13 @@ export async function addSentryToFastlane(
   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,
-      token,
-    );
+    newFileContent = addSentryToLane(fileContent, lanes[0], org, project);
   } else {
     const laneNames = lanes.map((l) => l.name);
     const selectedLane = await askForItemSelection(
@@ -151,7 +146,6 @@ export async function addSentryToFastlane(
       lanes[selectedLane.index],
       org,
       project,
-      token,
     );
   }
 

package/src/apple/templates.ts

@@ -1,11 +1,10 @@
 export function getRunScriptTemplate(
   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 ${
+  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}\\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`;
 }
@@ -41,13 +40,8 @@ export function getObjcSnippet(dsn: string): string {
     [SentrySDK captureMessage:@"This app uses Sentry!"];\n`;
 }
 
-export function getFastlaneSnippet(
-  org: string,
-  project: string,
-  token: string,
-): string {
+export function getFastlaneSnippet(org: string, project: string): string {
   return `    sentry_cli(
-      auth_token: '${token}',
       org_slug: '${org}',
       project_slug: '${project}',
       include_sources: true