feat: Add forceInstall option to NPM-based wizards (#791)

* feat: Add `forceInstall` option to NPM-based wizards * fix args passing, changelog * changelog pr link * tests * lint
getsentry · Feb 14, 2025 · a7bdc07 · a7bdc07
1 parent e16056a
commit a7bdc07
Show file tree

Hide file tree

Showing 14 changed files with 166 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- feat: Add `forceInstall` option to NPM-based wizards ([#791](https://github.com/getsentry/sentry-wizard/pull/791))
 - fix(apple): Fix null-handling in apple-wizard with typings ([#775](https://github.com/getsentry/sentry-wizard/pull/775))
 - feat(apple): add extended whitespace support to AppDelegate detection; add tests for code-tools (#785)
 - test(apple): Add unit tests for Fastfile injection ([#786](https://github.com/getsentry/sentry-wizard/pull/786))

diff --git a/README.md b/README.md
@@ -54,22 +54,23 @@ At the current moment, the wizard can be used for Next.js, react-native, iOS, Fl
 
 The following CLI arguments are available:
 
-| Option                | Description                                                       | Type    | Default                                 | Choices                                                                                              | Environment Variable         |
-| --------------------- | ----------------------------------------------------------------- | ------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------- |
-| `--help`              | Show help                                                         | boolean |                                         |                                                                                                      |                              |
-| `--version`           | Show version number                                               | boolean |                                         |                                                                                                      |                              |
-| `--debug`             | Enable verbose logging                                            | boolean | `false`                                 |                                                                                                      | `SENTRY_WIZARD_DEBUG`        |
-| `--uninstall`         | Revert project setup process. Not available for all integrations. | boolean | `false`                                 |                                                                                                      | `SENTRY_WIZARD_UNINSTALL`    |
-| `--skip-connect`      | Skips the connection to the server                                | boolean | `false`                                 |                                                                                                      | `SENTRY_WIZARD_SKIP_CONNECT` |
-| `--quiet`             | Do not fallback to prompting user asking questions                | boolean | `false`                                 |                                                                                                      | `SENTRY_WIZARD_QUIET`        |
+| Option                | Description                                                       | Type    | Default                                 | Choices                                                                                                                | Environment Variable         |
+| --------------------- | ----------------------------------------------------------------- | ------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
+| `--help`              | Show help                                                         | boolean |                                         |                                                                                                                        |                              |
+| `--version`           | Show version number                                               | boolean |                                         |                                                                                                                        |                              |
+| `--debug`             | Enable verbose logging                                            | boolean | `false`                                 |                                                                                                                        | `SENTRY_WIZARD_DEBUG`        |
+| `--uninstall`         | Revert project setup process. Not available for all integrations. | boolean | `false`                                 |                                                                                                                        | `SENTRY_WIZARD_UNINSTALL`    |
+| `--skip-connect`      | Skips the connection to the server                                | boolean | `false`                                 |                                                                                                                        | `SENTRY_WIZARD_SKIP_CONNECT` |
+| `--quiet`             | Do not fallback to prompting user asking questions                | boolean | `false`                                 |                                                                                                                        | `SENTRY_WIZARD_QUIET`        |
 | `-i, --integration`   | Choose the integration to setup                                   | choices | Select integration during setup         | "reactNative", "flutter", ios", "android", "cordova", "electron", "nextjs", "nuxt", "remix", "sveltekit", "sourcemaps" | `SENTRY_WIZARD_INTEGRATION`  |
-| `-p, --platform`      | Choose platform(s)                                                | array   | Select platform(s) during setup         | "ios", "android"                                                                                     | `SENTRY_WIZARD_PLATFORM`     |
-| `-u, --url`           | The URL to your Sentry installation                               | string  | `https://sentry.io`                     |                                                                                                      | `SENTRY_WIZARD_URL`          |
-| `--project`           | The Sentry project slug to use                                    | string  | Select project during setup             |                                                                                                      |                              |
-| `--org`               | The Sentry org slug to use                                        | string  | Select org during setup                 |                                                                                                      |                              |
-| `--saas`              | Skip the self-hosted or SaaS URL selection process                | boolean | Select self-hosted or SaaS during setup |                                                                                                      |                              |
-| `-s, --signup`        | Redirect to signup page if not logged in                          | boolean | `false`                                 |                                                                                                      |                              |
-| `--disable-telemetry` | Don't send telemetry data to Sentry                               | boolean | `false`                                 |                                                                                                      |                              |
+| `-p, --platform`      | Choose platform(s)                                                | array   | Select platform(s) during setup         | "ios", "android"                                                                                                       | `SENTRY_WIZARD_PLATFORM`     |
+| `-u, --url`           | The URL to your Sentry installation                               | string  | `https://sentry.io`                     |                                                                                                                        | `SENTRY_WIZARD_URL`          |
+| `--project`           | The Sentry project slug to use                                    | string  | Select project during setup             |                                                                                                                        |                              |
+| `--org`               | The Sentry org slug to use                                        | string  | Select org during setup                 |                                                                                                                        |                              |
+| `--saas`              | Skip the self-hosted or SaaS URL selection process                | boolean | Select self-hosted or SaaS during setup |                                                                                                                        |                              |
+| `-s, --signup`        | Redirect to signup page if not logged in                          | boolean | `false`                                 |                                                                                                                        |                              |
+| `--disable-telemetry` | Don't send telemetry data to Sentry                               | boolean | `false`                                 |                                                                                                                        |                              |
+| `--force-install`     | Force install the SDK NPM package (use with caution!)             | boolean | `false`                                 |                                                                                                                        |                              |
 
 ## Resources
 

diff --git a/bin.ts b/bin.ts
@@ -124,6 +124,11 @@ const argv = yargs(hideBin(process.argv)).options({
     describe: 'A promo code that will be applied during signup',
     type: 'string',
   },
+  'force-install': {
+    default: false,
+    describe: 'Force install the SDK NPM package',
+    type: 'boolean',
+  },
   ...PRESELECTED_PROJECT_OPTIONS,
 }).argv;
 

diff --git a/src/nextjs/nextjs-wizard.ts b/src/nextjs/nextjs-wizard.ts
@@ -65,10 +65,12 @@ export function runNextjsWizard(options: WizardOptions) {
 export async function runNextjsWizardWithTelemetry(
   options: WizardOptions,
 ): Promise<void> {
+  const { promoCode, telemetryEnabled, forceInstall } = options;
+
   printWelcome({
     wizardName: 'Sentry Next.js Wizard',
-    promoCode: options.promoCode,
-    telemetryEnabled: options.telemetryEnabled,
+    promoCode,
+    telemetryEnabled,
   });
 
   const typeScriptDetected = isUsingTypeScript();
@@ -96,6 +98,7 @@ export async function runNextjsWizardWithTelemetry(
       packageName: '@sentry/nextjs@^8',
       packageNameDisplayLabel: '@sentry/nextjs',
       alreadyInstalled: !!packageJson?.dependencies?.['@sentry/nextjs'],
+      forceInstall,
     });
 
   await traceStep('configure-sdk', async () => {

diff --git a/src/nuxt/nuxt-wizard.ts b/src/nuxt/nuxt-wizard.ts
@@ -50,10 +50,12 @@ export function runNuxtWizard(options: WizardOptions) {
 export async function runNuxtWizardWithTelemetry(
   options: WizardOptions,
 ): Promise<void> {
+  const { promoCode, telemetryEnabled, forceInstall } = options;
+
   printWelcome({
     wizardName: 'Sentry Nuxt Wizard',
-    promoCode: options.promoCode,
-    telemetryEnabled: options.telemetryEnabled,
+    promoCode,
+    telemetryEnabled,
   });
 
   await confirmContinueIfNoOrDirtyGitRepo();
@@ -95,7 +97,7 @@ export async function runNuxtWizardWithTelemetry(
 
   const packageManager = await getPackageManager();
 
-  await addNuxtOverrides(packageJson, packageManager, minVer);
+  await addNuxtOverrides(packageJson, packageManager, minVer, forceInstall);
 
   const sdkAlreadyInstalled = hasPackageInstalled('@sentry/nuxt', packageJson);
   Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);
@@ -104,6 +106,7 @@ export async function runNuxtWizardWithTelemetry(
     packageName: '@sentry/nuxt',
     alreadyInstalled: sdkAlreadyInstalled,
     packageManager,
+    forceInstall,
   });
 
   await addDotEnvSentryBuildPluginFile(authToken);

diff --git a/src/nuxt/sdk-setup.ts b/src/nuxt/sdk-setup.ts
@@ -250,6 +250,7 @@ export async function addNuxtOverrides(
   packageJson: PackageDotJson,
   packageManager: PackageManager,
   nuxtMinVer: SemVer | null,
+  forceInstall?: boolean,
 ) {
   const isPNPM = PNPM.detect();
 
@@ -306,6 +307,7 @@ export async function addNuxtOverrides(
         packageName: 'import-in-the-middle',
         alreadyInstalled: iitmAlreadyInstalled,
         packageManager,
+        forceInstall,
       });
     }
   }

diff --git a/src/react-native/react-native-wizard.ts b/src/react-native/react-native-wizard.ts
@@ -111,10 +111,12 @@ export async function runReactNativeWizardWithTelemetry(
     return runReactNativeUninstall(options);
   }
 
+  const { promoCode, telemetryEnabled, forceInstall } = options;
+
   printWelcome({
     wizardName: 'Sentry React Native Wizard',
-    promoCode: options.promoCode,
-    telemetryEnabled: options.telemetryEnabled,
+    promoCode,
+    telemetryEnabled,
   });
 
   await confirmContinueIfNoOrDirtyGitRepo();
@@ -147,6 +149,7 @@ Or setup using ${chalk.cyan(
   await installPackage({
     packageName: RN_SDK_PACKAGE,
     alreadyInstalled: hasPackageInstalled(RN_SDK_PACKAGE, packageJson),
+    forceInstall,
   });
   const sdkVersion = getPackageVersion(
     RN_SDK_PACKAGE,

diff --git a/src/remix/remix-wizard.ts b/src/remix/remix-wizard.ts
@@ -52,10 +52,12 @@ export async function runRemixWizard(options: WizardOptions): Promise<void> {
 async function runRemixWizardWithTelemetry(
   options: WizardOptions,
 ): Promise<void> {
+  const { promoCode, telemetryEnabled, forceInstall } = options;
+
   printWelcome({
     wizardName: 'Sentry Remix Wizard',
-    promoCode: options.promoCode,
-    telemetryEnabled: options.telemetryEnabled,
+    promoCode,
+    telemetryEnabled,
   });
 
   await confirmContinueIfNoOrDirtyGitRepo();
@@ -73,6 +75,7 @@ async function runRemixWizardWithTelemetry(
     packageName: '@sentry/remix@^8',
     packageNameDisplayLabel: '@sentry/remix',
     alreadyInstalled: hasPackageInstalled('@sentry/remix', packageJson),
+    forceInstall,
   });
 
   const dsn = selectedProject.keys[0].dsn.public;

diff --git a/src/run.ts b/src/run.ts
@@ -56,6 +56,7 @@ type Args = {
   org?: string;
   project?: string;
   saas?: boolean;
+  forceInstall?: boolean;
 };
 
 function preSelectedProjectArgsToObject(
@@ -132,6 +133,7 @@ export async function run(argv: Args) {
     projectSlug: finalArgs.project,
     saas: finalArgs.saas,
     preSelectedProject: preSelectedProjectArgsToObject(finalArgs),
+    forceInstall: finalArgs.forceInstall,
   };
 
   switch (integration) {

diff --git a/src/sveltekit/sveltekit-wizard.ts b/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);

diff --git a/src/utils/clack-utils.ts b/src/utils/clack-utils.ts
@@ -356,6 +356,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 +365,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 +396,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

diff --git a/src/utils/package-manager.ts b/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();

diff --git a/src/utils/types.ts b/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 {