@sentry/wizard 3.7.1 → 3.9.0

package/lib/Helper/__tests__/MergeConfig.ts

@@ -31,7 +31,6 @@ function configFileNames(num: number): {
 }
 
 describe('Merging next.config.js', () => {
-
   afterEach(() => {
     fs.unlinkSync(configPath);
   });
@@ -49,7 +48,9 @@ describe('Merging next.config.js', () => {
 
     mergeConfigFile(configPath, templatePath);
 
-    expect(fs.readFileSync(configPath, 'utf8')).toEqual(fs.readFileSync(mergedPath, 'utf8'));
+    expect(fs.readFileSync(configPath, 'utf8')).toEqual(
+      fs.readFileSync(mergedPath, 'utf8'),
+    );
   });
 
   test('merge invalid javascript config return false', () => {
@@ -72,7 +73,9 @@ describe('Merging next.config.js', () => {
 
     mergeConfigFile(configPath, templatePath);
 
-    expect(fs.readFileSync(configPath, 'utf8')).toEqual(fs.readFileSync(mergedPath, 'utf8'));
+    expect(fs.readFileSync(configPath, 'utf8')).toEqual(
+      fs.readFileSync(mergedPath, 'utf8'),
+    );
   });
 
   test('merge next.config.js with function return true', () => {
@@ -88,6 +91,8 @@ describe('Merging next.config.js', () => {
 
     mergeConfigFile(configPath, templatePath);
 
-    expect(fs.readFileSync(configPath, 'utf8')).toEqual(fs.readFileSync(mergedPath, 'utf8'));
+    expect(fs.readFileSync(configPath, 'utf8')).toEqual(
+      fs.readFileSync(mergedPath, 'utf8'),
+    );
   });
 });

package/lib/Setup.ts

@@ -1,4 +1,5 @@
 import * as _ from 'lodash';
+import { enableDebugLogs } from '../src/utils/debug';
 
 import { readEnvironment } from './Helper/Env';
 import { startWizard } from './Helper/Wizard';
@@ -7,6 +8,10 @@ import * as Step from './Steps';
 export async function run(argv: any): Promise<any> {
   const args = { ...argv, ...readEnvironment() };
 
+  if (argv.debug) {
+    enableDebugLogs();
+  }
+
   if (args.uninstall === undefined) {
     args.uninstall = false;
   }

package/lib/Steps/ChooseIntegration.ts

@@ -1,6 +1,5 @@
 import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
-import * as _ from 'lodash';
 import { dim } from 'picocolors';
 
 import {
@@ -17,6 +16,7 @@ import { ReactNative } from './Integrations/ReactNative';
 import { SourceMapsShim } from './Integrations/SourceMapsShim';
 import { Apple } from './Integrations/Apple';
 import { SvelteKitShim } from './Integrations/SvelteKitShim';
+import { hasPackageInstalled } from '../../src/utils/package-json';
 
 let projectPackage: any = {};
 
@@ -65,12 +65,22 @@ export class ChooseIntegration extends BaseStep {
   }
 
   public tryDetectingIntegration(): Integration | undefined {
-    if (_.has(projectPackage, 'dependencies.react-native')) {
+    if (hasPackageInstalled('react-native', projectPackage)) {
       return Integration.reactNative;
     }
-    if (_.has(projectPackage, 'dependencies.cordova')) {
+    if (hasPackageInstalled('cordova', projectPackage)) {
       return Integration.cordova;
     }
+    if (hasPackageInstalled('electron', projectPackage)) {
+      return Integration.electron;
+    }
+    if (hasPackageInstalled('next', projectPackage)) {
+      return Integration.nextjs;
+    }
+    if (hasPackageInstalled('@sveltejs/kit', projectPackage)) {
+      return Integration.sveltekit;
+    }
+
     return;
   }
 

package/lib/Steps/Integrations/Cordova.ts

@@ -12,6 +12,7 @@ const xcode = require('xcode');
 
 export class Cordova extends BaseIntegration {
   protected _sentryCli: SentryCli;
+
   protected _folderPrefix = 'platforms';
   protected _pluginFolder: string[] = ['.'];
 
@@ -25,9 +26,8 @@ export class Cordova extends BaseIntegration {
       return this.uninstall(answers);
     }
 
-    const sentryCliProperties = this._sentryCli.convertAnswersToProperties(
-      answers,
-    );
+    const sentryCliProperties =
+      this._sentryCli.convertAnswersToProperties(answers);
 
     await patchMatchingFile(
       `${this._folderPrefix}/ios/*.xcodeproj/project.pbxproj`,

package/lib/Steps/Integrations/Electron.ts

@@ -1,5 +1,5 @@
 import * as fs from 'fs';
-import type { Answers} from 'inquirer';
+import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
 import * as _ from 'lodash';
 import * as path from 'path';
@@ -21,7 +21,6 @@ Sentry.init({
   dsn: '___DSN___',
 });`;
 
-
 let appPackage: any = {};
 
 function printExample(example: string, title = ''): void {

package/lib/Steps/Integrations/MobileProject.ts

@@ -1,4 +1,4 @@
-import type { Answers} from 'inquirer';
+import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
 import * as _ from 'lodash';
 

package/lib/Steps/Integrations/ReactNative.ts

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 import { exec } from 'child_process';
 import * as fs from 'fs';
-import type { Answers} from 'inquirer';
+import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
 import * as _ from 'lodash';
 import * as path from 'path';
@@ -44,7 +44,6 @@ export class ReactNative extends MobileProject {
   protected _answers: Answers;
   protected _sentryCli: SentryCli;
 
-
   public constructor(protected _argv: Args) {
     super(_argv);
     this.url = _argv.url;
@@ -71,7 +70,8 @@ export class ReactNative extends MobileProject {
     );
     if (!hasCompatibleReactNativeVersion && !this._argv.quiet) {
       userAnswers = await prompt({
-        message: 'Your version of React Native is not compatible with Sentry\'s React Native SDK. Do you want to continue?',
+        message:
+          "Your version of React Native is not compatible with Sentry's React Native SDK. Do you want to continue?",
         name: 'continue',
         default: false,
         type: 'confirm',
@@ -111,9 +111,8 @@ export class ReactNative extends MobileProject {
       );
     }
 
-    const sentryCliProperties = this._sentryCli.convertAnswersToProperties(
-      answers,
-    );
+    const sentryCliProperties =
+      this._sentryCli.convertAnswersToProperties(answers);
 
     const promises = this.getPlatforms(answers).map(
       async (platform: string) => {
@@ -146,17 +145,18 @@ export class ReactNative extends MobileProject {
 
     await Promise.all(promises);
 
-    let host: string | null = null
+    let host: string | null = null;
     try {
-      host = (new URL(this.url || '')).host;
+      host = new URL(this.url || '').host;
     } catch (_error) {
       // ignore
     }
     const orgSlug = _.get(answers, 'config.organization.slug', null);
     const projectId = _.get(answers, 'config.project.id', null);
-    const projectIssuesUrl = host && orgSlug && projectId
-      ? `https://${orgSlug}.${host}/issues/?project=${projectId}`
-      : null;
+    const projectIssuesUrl =
+      host && orgSlug && projectId
+        ? `https://${orgSlug}.${host}/issues/?project=${projectId}`
+        : null;
 
     l(`
 To make sure everything is set up correctly, put the following code snippet into your application.
@@ -169,7 +169,9 @@ The snippet will create a button that, when tapped, sends a test event to Sentry
       nl();
     }
 
-    l(`<Button title='Try!' onPress={ () => { Sentry.captureException(new Error('First error')) }}/>`);
+    l(
+      `<Button title='Try!' onPress={ () => { Sentry.captureException(new Error('First error')) }}/>`,
+    );
     nl();
 
     if (!this._argv.quiet) {
@@ -337,7 +339,7 @@ The snippet will create a button that, when tapped, sends a test event to Sentry
     return Promise.resolve(
       contents.replace(
         /^([^]*)(import\s+[^;]*?;$)/m,
-        match =>
+        (match) =>
           // eslint-disable-next-line prefer-template
           match +
           "\n\nimport * as Sentry from '@sentry/react-native';\n\n" +
@@ -361,7 +363,7 @@ The snippet will create a button that, when tapped, sends a test event to Sentry
       contents.replace(
         ReactNative._buildGradleAndroidSectionBeginning,
         // eslint-disable-next-line prefer-template
-        match => applyFrom + '\n' + match,
+        (match) => applyFrom + '\n' + match,
       ),
     );
   }
@@ -396,7 +398,7 @@ The snippet will create a button that, when tapped, sends a test event to Sentry
             // eslint-disable-next-line no-useless-escape
             '\\"../node_modules/@sentry/cli/bin/sentry-cli react-native xcode $REACT_NATIVE_XCODE\\"',
         ) +
-        '\n/bin/sh ../node_modules/@sentry/react-native/scripts/collect-modules.sh\n';
+        '\n/bin/sh -c "$WITH_ENVIRONMENT ../node_modules/@sentry/react-native/scripts/collect-modules.sh"\n';
       script.shellScript = JSON.stringify(code);
     }
   }
@@ -420,8 +422,12 @@ The snippet will create a button that, when tapped, sends a test event to Sentry
       {
         shellPath: '/bin/sh',
         shellScript: `
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+if [ -f "$WITH_ENVIRONMENT" ]; then
+    . "$WITH_ENVIRONMENT"
+fi 
 export SENTRY_PROPERTIES=sentry.properties
-[[ $SENTRY_INCLUDE_NATIVE_SOURCES == "true" ]] && INCLUDE_SOURCES_FLAG="--include-sources" || INCLUDE_SOURCES_FLAG=""
+[ "$SENTRY_INCLUDE_NATIVE_SOURCES" = "true" ] && INCLUDE_SOURCES_FLAG="--include-sources" || INCLUDE_SOURCES_FLAG=""
 ../node_modules/@sentry/cli/bin/sentry-cli debug-files upload "$INCLUDE_SOURCES_FLAG" "$DWARF_DSYM_FOLDER_PATH"
 `,
       },
@@ -507,7 +513,7 @@ export SENTRY_PROPERTIES=sentry.properties
           // remove sentry properties export
           .replace(/^export SENTRY_PROPERTIES=sentry.properties\r?\n/m, '')
           .replace(
-            /^\/bin\/sh ..\/node_modules\/@sentry\/react-native\/scripts\/collect-modules.sh\r?\n/m,
+            /^\/bin\/sh .*?..\/node_modules\/@sentry\/react-native\/scripts\/collect-modules.sh"?\r?\n/m,
             '',
           )
           // unwrap react-native-xcode.sh command.  In case someone replaced it

package/lib/Steps/Integrations/__tests__/ReactNative.ts

@@ -7,7 +7,7 @@ import * as path from 'path';
 import * as process from 'process';
 import * as rimraf from 'rimraf';
 
-import type { Args} from '../../../Constants';
+import type { Args } from '../../../Constants';
 import { Integration, Platform } from '../../../Constants';
 import { ReactNative } from '../ReactNative';
 
@@ -18,7 +18,8 @@ const appBuildGradle = 'android/app/build.gradle';
 const yarnLock = 'yarn.lock';
 
 const dummyJsContent = 'import React from "react";\n';
-const dummyAppBuildGradleContent = 'apply plugin: "com.facebook.react"\n\nandroid {\n}\n';
+const dummyAppBuildGradleContent =
+  'apply plugin: "com.facebook.react"\n\nandroid {\n}\n';
 
 const testArgs = {
   debug: false,
@@ -31,7 +32,7 @@ const testArgs = {
 };
 
 const mockIosAnswers: Answers = {
-  shouldConfigurePlatforms: { 'ios': true },
+  shouldConfigurePlatforms: { ios: true },
   config: {
     dsn: {
       public: 'dns.public.com',
@@ -40,7 +41,7 @@ const mockIosAnswers: Answers = {
 };
 
 const mockAndroidAnswers: Answers = {
-  shouldConfigurePlatforms: { 'android': true },
+  shouldConfigurePlatforms: { android: true },
   config: {
     dsn: {
       public: 'dns.public.com',
@@ -52,15 +53,15 @@ const originalExec = child_process.exec;
 
 const restoreExec = (): void => {
   (child_process as any).exec = originalExec;
-}
+};
 
 const mockExec = (): void => {
-  (child_process.exec as unknown as jest.Mock)
-    .mockImplementation((_command, callback) => callback(null, { stdout: '' }));
-}
+  (child_process.exec as unknown as jest.Mock).mockImplementation(
+    (_command, callback) => callback(null, { stdout: '' }),
+  );
+};
 
 describe('ReactNative', () => {
-
   const defaultCwd = process.cwd();
 
   beforeEach(() => {
@@ -88,10 +89,11 @@ describe('ReactNative', () => {
 
     const patchedIosIndexJs = fs.readFileSync(iosIndexJs, 'utf8');
     const patchedAppTsx = fs.readFileSync(appTsx, 'utf8');
-    const expectedPatch = 'import React from "react";\n\n' +
-      'import * as Sentry from \'@sentry/react-native\';\n\n' +
+    const expectedPatch =
+      'import React from "react";\n\n' +
+      "import * as Sentry from '@sentry/react-native';\n\n" +
       'Sentry.init({ \n' +
-      '  dsn: \'dns.public.com\', \n' +
+      "  dsn: 'dns.public.com', \n" +
       '});\n\n';
     expect(patchedIosIndexJs).toEqual(expectedPatch);
     expect(patchedAppTsx).toEqual(expectedPatch);
@@ -103,7 +105,8 @@ describe('ReactNative', () => {
     await project.emit(mockAndroidAnswers);
 
     const patchedAppBuildGradle = fs.readFileSync(appBuildGradle, 'utf8');
-    const expectedPatch = 'apply plugin: "com.facebook.react"\n\n' +
+    const expectedPatch =
+      'apply plugin: "com.facebook.react"\n\n' +
       'apply from: "../../node_modules/@sentry/react-native/sentry.gradle"\n' +
       'android {\n}\n';
     expect(patchedAppBuildGradle).toEqual(expectedPatch);
@@ -114,7 +117,10 @@ describe('ReactNative', () => {
 
     await project.emit(mockIosAnswers);
 
-    expect(child_process.exec).toHaveBeenCalledWith('yarn add @sentry/react-native', expect.anything());
+    expect(child_process.exec).toHaveBeenCalledWith(
+      'yarn add @sentry/react-native',
+      expect.anything(),
+    );
   });
 
   test('executes pod install', async () => {
@@ -122,6 +128,9 @@ describe('ReactNative', () => {
 
     await project.emit(mockIosAnswers);
 
-    expect(child_process.exec).toHaveBeenCalledWith('npx --yes pod-install --non-interactive --quiet', expect.anything());
+    expect(child_process.exec).toHaveBeenCalledWith(
+      'npx --yes pod-install --non-interactive --quiet',
+      expect.anything(),
+    );
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/wizard",
-  "version": "3.7.1",
+  "version": "3.9.0",
   "homepage": "https://github.com/getsentry/sentry-wizard",
   "repository": "https://github.com/getsentry/sentry-wizard",
   "description": "Sentry wizard helping you to configure your project",
@@ -32,7 +32,7 @@
     "glob": "^7.1.3",
     "inquirer": "^6.2.0",
     "lodash": "^4.17.15",
-    "magicast": "^0.2.9",
+    "magicast": "^0.2.10",
     "opn": "^5.4.0",
     "r2": "^2.0.1",
     "read-env": "^1.3.0",
@@ -65,7 +65,7 @@
     "**/xmldom": "^0.6.0"
   },
   "engines": {
-    "node": ">=14.0.0",
+    "node": ">=14.18.0",
     "npm": ">=3.10.7",
     "yarn": ">=1.0.2"
   },
@@ -76,15 +76,15 @@
     "build": "yarn tsc",
     "postbuild": "chmod +x ./dist/bin.js && cp -r scripts/** dist",
     "lint": "yarn lint:prettier && yarn lint:eslint",
-    "lint:prettier": "prettier --check lib/**/*.ts",
+    "lint:prettier": "prettier --check \"{lib,src,test}/**/*.ts\"",
     "lint:eslint": "eslint . --cache --format stylish",
     "fix": "yarn fix:eslint && yarn fix:prettier",
-    "fix:prettier": "prettier --write lib/**/*.ts",
+    "fix:prettier": "prettier --write \"{lib,src,test}/**/*.ts\"",
     "fix:eslint": "eslint . --format stylish --fix",
     "test": "yarn build && jest",
     "try": "ts-node bin.ts",
     "try:uninstall": "ts-node bin.ts --uninstall",
-    "test:watch": "jest --watch --notify"
+    "test:watch": "jest --watch"
   },
   "jest": {
     "collectCoverage": true,
@@ -114,5 +114,9 @@
     "testEnvironment": "node"
   },
   "author": "Sentry",
-  "license": "MIT"
+  "license": "MIT",
+  "volta": {
+    "node": "14.18.3",
+    "yarn": "1.22.19"
+  }
 }

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;
+}