@sentry/wizard 3.39.0 → 3.41.0

package/src/run.ts

@@ -5,6 +5,7 @@ import { runReactNativeWizard } from './react-native/react-native-wizard';
 
 import { run as legacyRun } from '../lib/Setup';
 import type { PreselectedProject, WizardOptions } from './utils/types';
+import { runFlutterWizard } from './flutter/flutter-wizard';
 import { runAndroidWizard } from './android/android-wizard';
 import { runAppleWizard } from './apple/apple-wizard';
 import { runNextjsWizard } from './nextjs/nextjs-wizard';
@@ -18,6 +19,7 @@ import type { PackageDotJson } from './utils/package-json';
 
 type WizardIntegration =
   | 'reactNative'
+  | 'flutter'
   | 'ios'
   | 'android'
   | 'cordova'
@@ -54,6 +56,7 @@ type Args = {
   org?: string;
   project?: string;
   saas?: boolean;
+  forceInstall?: boolean;
 };
 
 function preSelectedProjectArgsToObject(
@@ -100,6 +103,7 @@ export async function run(argv: Args) {
         message: 'What do you want to set up?',
         options: [
           { value: 'reactNative', label: 'React Native' },
+          { value: 'flutter', label: 'Flutter' },
           { value: 'ios', label: 'iOS' },
           { value: 'android', label: 'Android' },
           { value: 'cordova', label: 'Cordova' },
@@ -129,6 +133,7 @@ export async function run(argv: Args) {
     projectSlug: finalArgs.project,
     saas: finalArgs.saas,
     preSelectedProject: preSelectedProjectArgsToObject(finalArgs),
+    forceInstall: finalArgs.forceInstall,
   };
 
   switch (integration) {
@@ -139,6 +144,10 @@ export async function run(argv: Args) {
       });
       break;
 
+    case 'flutter':
+      await runFlutterWizard(wizardOptions);
+      break;
+
     case 'ios':
       await runAppleWizard(wizardOptions);
       break;

package/src/sveltekit/sveltekit-wizard.ts

@@ -41,10 +41,12 @@ export async function runSvelteKitWizard(
 export async function runSvelteKitWizardWithTelemetry(
   options: WizardOptions,
 ): Promise<void> {
+  const { promoCode, telemetryEnabled, forceInstall } = options;
+
   printWelcome({
     wizardName: 'Sentry SvelteKit Wizard',
-    promoCode: options.promoCode,
-    telemetryEnabled: options.telemetryEnabled,
+    promoCode,
+    telemetryEnabled,
   });
 
   await confirmContinueIfNoOrDirtyGitRepo();
@@ -98,6 +100,7 @@ export async function runSvelteKitWizardWithTelemetry(
     packageName: '@sentry/sveltekit@^8',
     packageNameDisplayLabel: '@sentry/sveltekit',
     alreadyInstalled: sdkAlreadyInstalled,
+    forceInstall,
   });
 
   await addDotEnvSentryBuildPluginFile(authToken);

package/src/utils/clack-utils.ts

@@ -207,6 +207,8 @@ export async function confirmContinueIfNoOrDirtyGitRepo(): Promise<void> {
       if (!continueWithoutGit) {
         await abort(undefined, 0);
       }
+      // return early to avoid checking for uncommitted files
+      return;
     }
 
     const uncommittedOrUntrackedFiles = getUncommittedOrUntrackedFiles();
@@ -247,7 +249,10 @@ export function isInGitRepo() {
 export function getUncommittedOrUntrackedFiles(): string[] {
   try {
     const gitStatus = childProcess
-      .execSync('git status --porcelain=v1')
+      .execSync('git status --porcelain=v1', {
+        // we only care about stdout
+        stdio: ['ignore', 'pipe', 'ignore'],
+      })
       .toString();
 
     const files = gitStatus
@@ -356,6 +361,7 @@ export async function installPackage({
   askBeforeUpdating = true,
   packageNameDisplayLabel,
   packageManager,
+  forceInstall = false,
 }: {
   /** The string that is passed to the package manager CLI as identifier to install (e.g. `@sentry/nextjs`, or `@sentry/nextjs@^8`) */
   packageName: string;
@@ -364,6 +370,8 @@ export async function installPackage({
   /** Overrides what is shown in the installation logs in place of the `packageName` option. Useful if the `packageName` is ugly (e.g. `@sentry/nextjs@^8`) */
   packageNameDisplayLabel?: string;
   packageManager?: PackageManager;
+  /** Add force install flag to command to skip install precondition fails */
+  forceInstall?: boolean;
 }): Promise<{ packageManager?: PackageManager }> {
   return traceStep('install-package', async () => {
     if (alreadyInstalled && askBeforeUpdating) {
@@ -393,7 +401,9 @@ export async function installPackage({
     try {
       await new Promise<void>((resolve, reject) => {
         childProcess.exec(
-          `${pkgManager.installCommand} ${packageName} ${pkgManager.flags}`,
+          `${pkgManager.installCommand} ${packageName} ${pkgManager.flags} ${
+            forceInstall ? pkgManager.forceInstallFlag : ''
+          }`,
           (err, stdout, stderr) => {
             if (err) {
               // Write a log file so we can better troubleshoot issues
@@ -881,7 +891,8 @@ export async function getOrAskForProjectData(
     | 'javascript-sveltekit'
     | 'apple-ios'
     | 'android'
-    | 'react-native',
+    | 'react-native'
+    | 'flutter',
 ): Promise<{
   sentryUrl: string;
   selfHosted: boolean;
@@ -1043,7 +1054,8 @@ async function askForWizardLogin(options: {
     | 'javascript-sveltekit'
     | 'apple-ios'
     | 'android'
-    | 'react-native';
+    | 'react-native'
+    | 'flutter';
   orgSlug?: string;
   projectSlug?: string;
 }): Promise<WizardProjectData> {

package/src/utils/package-manager.ts

@@ -14,6 +14,7 @@ export interface PackageManager {
   /* The command that the package manager uses to run a script from package.json */
   runScriptCommand: string;
   flags: string;
+  forceInstallFlag: string;
   detect: () => boolean;
   addOverride: (pkgName: string, pkgVersion: string) => Promise<void>;
 }
@@ -25,6 +26,7 @@ export const BUN: PackageManager = {
   buildCommand: 'bun run build',
   runScriptCommand: 'bun run',
   flags: '',
+  forceInstallFlag: '--force',
   detect: () =>
     ['bun.lockb', 'bun.lock'].some((lockFile) =>
       fs.existsSync(path.join(process.cwd(), lockFile)),
@@ -49,6 +51,7 @@ export const YARN_V1: PackageManager = {
   buildCommand: 'yarn build',
   runScriptCommand: 'yarn',
   flags: '--ignore-workspace-root-check',
+  forceInstallFlag: '--force',
   detect: () => {
     try {
       return fs
@@ -80,6 +83,7 @@ export const YARN_V2: PackageManager = {
   buildCommand: 'yarn build',
   runScriptCommand: 'yarn',
   flags: '',
+  forceInstallFlag: '--force',
   detect: () => {
     try {
       return fs
@@ -110,6 +114,7 @@ export const PNPM: PackageManager = {
   buildCommand: 'pnpm build',
   runScriptCommand: 'pnpm',
   flags: '--ignore-workspace-root-check',
+  forceInstallFlag: '--force',
   detect: () => fs.existsSync(path.join(process.cwd(), 'pnpm-lock.yaml')),
   addOverride: async (pkgName, pkgVersion): Promise<void> => {
     const packageDotJson = await getPackageDotJson();
@@ -135,6 +140,7 @@ export const NPM: PackageManager = {
   buildCommand: 'npm run build',
   runScriptCommand: 'npm run',
   flags: '',
+  forceInstallFlag: '--force',
   detect: () => fs.existsSync(path.join(process.cwd(), 'package-lock.json')),
   addOverride: async (pkgName, pkgVersion): Promise<void> => {
     const packageDotJson = await getPackageDotJson();

package/src/utils/types.ts

@@ -57,6 +57,16 @@ export type WizardOptions = {
    * If this is set, the wizard will skip the login and project selection step.
    */
   preSelectedProject?: PreselectedProject;
+
+  /**
+   * Force-install the SDK package to continue with the installation in case
+   * any package manager checks are failing (e.g. peer dependency versions).
+   *
+   * Use with caution and only if you know what you're doing.
+   *
+   * Does not apply to all wizard flows (currently NPM only)
+   */
+  forceInstall?: boolean;
 };
 
 export interface Feature {

package/test/apple/cocoapod.test.ts

@@ -0,0 +1,306 @@
+import * as Sentry from '@sentry/node';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import {
+  addCocoaPods,
+  podInstall,
+  usesCocoaPod,
+} from '../../src/apple/cocoapod';
+import * as bash from '../../src/utils/bash';
+// @ts-ignore - clack is ESM and TS complains about that. It works though
+import * as clack from '@clack/prompts';
+
+jest.mock('../../src/utils/bash');
+jest.spyOn(Sentry, 'setTag').mockImplementation();
+jest.spyOn(Sentry, 'captureException').mockImplementation();
+
+const clackSpinnerMock = {
+  start: jest.fn(),
+  stop: jest.fn(),
+  message: jest.fn(),
+};
+
+describe('cocoapod', () => {
+  beforeEach(() => {
+    jest.spyOn(clack, 'spinner').mockReturnValue(clackSpinnerMock);
+    jest.spyOn(clack.log, 'error').mockImplementation();
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('usesCocoaPod', () => {
+    describe('Podfile exists', () => {
+      it('should return true', () => {
+        // -- Arrange --
+        const projPath = path.join(os.tmpdir(), 'test-project-with-podfile');
+        const tempDir = fs.mkdtempSync(projPath);
+
+        const podfile = path.join(tempDir, 'Podfile');
+        fs.writeFileSync(podfile, '');
+
+        // -- Act --
+        const result = usesCocoaPod(tempDir);
+
+        // -- Assert --
+        expect(result).toBeTruthy();
+      });
+    });
+
+    describe('Podfile does not exist', () => {
+      it('should return false', () => {
+        // -- Arrange --
+        const projPath = path.join(os.tmpdir(), 'test-project-without-podfile');
+        const tempDir = fs.mkdtempSync(projPath);
+
+        // -- Act --
+        const result = usesCocoaPod(tempDir);
+
+        // -- Assert --
+        expect(result).toBeFalsy();
+      });
+    });
+  });
+
+  describe('addCocoaPods', () => {
+    describe('Podfile does not exist', () => {
+      it('should throw an error', async () => {
+        // -- Arrange --
+        const projPath = path.join(os.tmpdir(), 'test-project-without-podfile');
+        const tempDir = fs.mkdtempSync(projPath);
+
+        // -- Act & Assert --
+        await expect(addCocoaPods(tempDir)).rejects.toThrow(
+          'ENOENT: no such file or directory, open',
+        );
+      });
+    });
+
+    describe('Podfile exists', () => {
+      describe('Podfile includes Sentry pod', () => {
+        const variations = [
+          {
+            case: 'simple',
+            content: 'pod "Sentry"',
+          },
+          {
+            case: 'with-swiftui',
+            content: 'pod "SentrySwiftUI"',
+          },
+          {
+            case: 'leading-space',
+            content: '  pod "Sentry"',
+          },
+          {
+            case: 'leading-space-and-swiftui',
+            content: '  pod "SentrySwiftUI"',
+          },
+          {
+            case: 'trailing-space',
+            content: 'pod "Sentry" ',
+          },
+          {
+            case: 'trailing-space-and-swiftui',
+            content: 'pod "SentrySwiftUI" ',
+          },
+          {
+            case: 'single-quotes',
+            content: "pod 'Sentry'",
+          },
+          {
+            case: 'double-quotes',
+            content: 'pod "Sentry"',
+          },
+        ];
+        for (const variation of variations) {
+          it(`should not change the Podfile for ${variation.case}`, async () => {
+            // -- Arrange --
+            const projPath = fs.mkdtempSync(path.join(os.tmpdir(), 'project'));
+            fs.mkdirSync(projPath, {
+              recursive: true,
+            });
+
+            const podfile = path.join(projPath, 'Podfile');
+            fs.writeFileSync(podfile, variation.content, 'utf8');
+
+            // -- Act --
+            const result = await addCocoaPods(projPath);
+
+            // -- Assert --
+            expect(result).toBeTruthy();
+            expect(fs.readFileSync(podfile, 'utf8')).toBe(variation.content);
+          });
+        }
+      });
+
+      describe('Podfile includes no other pods', () => {
+        describe('Podfile does not include use_frameworks!', () => {
+          it('should not change the Podfile', async () => {
+            // -- Arrange --
+            const projPath = fs.mkdtempSync(path.join(os.tmpdir(), 'project'));
+            fs.mkdirSync(projPath, {
+              recursive: true,
+            });
+
+            const podfile = path.join(projPath, 'Podfile');
+            fs.writeFileSync(podfile, '', 'utf8');
+
+            // -- Act --
+            const result = await addCocoaPods(projPath);
+
+            // -- Assert --
+            expect(result).toBeFalsy();
+            expect(fs.readFileSync(podfile, 'utf8')).toBe('');
+          });
+        });
+
+        describe('Podfile includes use_frameworks!', () => {
+          it('should change the Podfile', async () => {
+            // -- Arrange --
+            const projPath = fs.mkdtempSync(path.join(os.tmpdir(), 'project'));
+            fs.mkdirSync(projPath, {
+              recursive: true,
+            });
+
+            const podfile = path.join(projPath, 'Podfile');
+            fs.writeFileSync(podfile, `use_frameworks!`, 'utf8');
+
+            // -- Act --
+            const result = await addCocoaPods(projPath);
+
+            // -- Assert --
+            expect(result).toBeTruthy();
+            expect(fs.readFileSync(podfile, 'utf8')).toBe(
+              `use_frameworks!\npod 'Sentry'\n`,
+            );
+          });
+        });
+      });
+
+      describe('Podfile includes other pods', () => {
+        it('should append Sentry pod after last pod', async () => {
+          // -- Arrange --
+          const projPath = fs.mkdtempSync(path.join(os.tmpdir(), 'project'));
+          fs.mkdirSync(projPath, {
+            recursive: true,
+          });
+
+          const podfile = path.join(projPath, 'Podfile');
+          fs.writeFileSync(podfile, 'pod "OtherPod"', 'utf8');
+
+          // -- Act --
+          const result = await addCocoaPods(projPath);
+
+          // -- Assert --
+          expect(result).toBeTruthy();
+          expect(fs.readFileSync(podfile, 'utf8')).toBe(
+            `pod "OtherPod"\npod 'Sentry'\n`,
+          );
+        });
+      });
+    });
+  });
+
+  describe('podInstall', () => {
+    let workDir: string;
+
+    beforeEach(() => {
+      workDir = path.join(os.tmpdir(), 'test-project');
+    });
+
+    describe('any bash scripts fail', () => {
+      beforeEach(() => {
+        jest.spyOn(bash, 'execute').mockRejectedValue(new Error('test error'));
+      });
+
+      it('should not throw an error', async () => {
+        // -- Act & Assert --
+        await expect(podInstall(workDir)).resolves.not.toThrow();
+      });
+
+      it('should set tag', async () => {
+        // -- Act --
+        await podInstall(workDir);
+
+        // -- Assert --
+        expect(Sentry.setTag).toHaveBeenCalledWith('pods-installed', false);
+      });
+
+      it('should capture exception', async () => {
+        // -- Act --
+        await podInstall(workDir);
+
+        // -- Assert --
+        expect(Sentry.captureException).toHaveBeenCalledWith(
+          'Sentry pod install failed.',
+        );
+      });
+
+      it('should start and stop spinner', async () => {
+        // -- Act --
+        await podInstall(workDir);
+
+        // -- Assert --
+        expect(clackSpinnerMock.start).toHaveBeenCalledWith(
+          "Running 'pod install'. This may take a few minutes...",
+        );
+        expect(clackSpinnerMock.stop).toHaveBeenCalledWith(
+          'Failed to install pods.',
+        );
+      });
+    });
+
+    describe('all bash scripts work', () => {
+      beforeEach(() => {
+        jest.spyOn(bash, 'execute').mockResolvedValue('');
+      });
+
+      it('should call pod update and install', async () => {
+        // -- Act --
+        await podInstall(workDir);
+
+        // -- Assert --
+        expect(bash.execute).toHaveBeenCalledWith(
+          `cd ${workDir} && pod repo update`,
+        );
+        expect(bash.execute).toHaveBeenCalledWith(
+          `cd ${workDir} && pod install --silent`,
+        );
+      });
+
+      it('should set tag', async () => {
+        // -- Act --
+        await podInstall(workDir);
+
+        // -- Assert --
+        expect(Sentry.setTag).toHaveBeenCalledWith('pods-installed', true);
+      });
+
+      it('should start and stop spinner', async () => {
+        // -- Act --
+        await podInstall(workDir);
+
+        // -- Assert --
+        expect(clackSpinnerMock.start).toHaveBeenCalledWith(
+          "Running 'pod install'. This may take a few minutes...",
+        );
+        expect(clackSpinnerMock.stop).toHaveBeenCalledWith('Pods installed.');
+      });
+    });
+
+    describe('dir not given', () => {
+      it('should use current directory', async () => {
+        // -- Act --
+        await podInstall();
+
+        // -- Assert --
+        expect(bash.execute).toHaveBeenCalledWith(`cd . && pod repo update`);
+        expect(bash.execute).toHaveBeenCalledWith(
+          `cd . && pod install --silent`,
+        );
+      });
+    });
+  });
+});